1/*
2  This file is provided under a dual BSD/GPLv2 license.  When using or
3  redistributing this file, you may do so under either license.
4
5  GPL LICENSE SUMMARY
6  Copyright(c) 2014 Intel Corporation.
7  This program is free software; you can redistribute it and/or modify
8  it under the terms of version 2 of the GNU General Public License as
9  published by the Free Software Foundation.
10
11  This program is distributed in the hope that it will be useful, but
12  WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  General Public License for more details.
15
16  Contact Information:
17  qat-linux@intel.com
18
19  BSD LICENSE
20  Copyright(c) 2014 Intel Corporation.
21  Redistribution and use in source and binary forms, with or without
22  modification, are permitted provided that the following conditions
23  are met:
24
25    * Redistributions of source code must retain the above copyright
26      notice, this list of conditions and the following disclaimer.
27    * Redistributions in binary form must reproduce the above copyright
28      notice, this list of conditions and the following disclaimer in
29      the documentation and/or other materials provided with the
30      distribution.
31    * Neither the name of Intel Corporation nor the names of its
32      contributors may be used to endorse or promote products derived
33      from this software without specific prior written permission.
34
35  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
38  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
39  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
42  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
43  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
45  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46*/
47#ifndef ADF_TRANSPORT_INTRN_H
48#define ADF_TRANSPORT_INTRN_H
49
50#include <linux/interrupt.h>
51#include <linux/atomic.h>
52#include <linux/spinlock_types.h>
53#include "adf_transport.h"
54
55struct adf_etr_ring_debug_entry {
56	char ring_name[ADF_CFG_MAX_KEY_LEN_IN_BYTES];
57	struct dentry *debug;
58};
59
60struct adf_etr_ring_data {
61	void *base_addr;
62	atomic_t *inflights;
63	spinlock_t lock;	/* protects ring data struct */
64	adf_callback_fn callback;
65	struct adf_etr_bank_data *bank;
66	dma_addr_t dma_addr;
67	uint16_t head;
68	uint16_t tail;
69	uint8_t ring_number;
70	uint8_t ring_size;
71	uint8_t msg_size;
72	uint8_t reserved;
73	struct adf_etr_ring_debug_entry *ring_debug;
74} __packed;
75
76struct adf_etr_bank_data {
77	struct adf_etr_ring_data rings[ADF_ETR_MAX_RINGS_PER_BANK];
78	struct tasklet_struct resp_handler;
79	void __iomem *csr_addr;
80	struct adf_accel_dev *accel_dev;
81	uint32_t irq_coalesc_timer;
82	uint16_t ring_mask;
83	uint16_t irq_mask;
84	spinlock_t lock;	/* protects bank data struct */
85	struct dentry *bank_debug_dir;
86	struct dentry *bank_debug_cfg;
87	uint32_t bank_number;
88} __packed;
89
90struct adf_etr_data {
91	struct adf_etr_bank_data *banks;
92	struct dentry *debug;
93};
94
95void adf_response_handler(unsigned long bank_addr);
96#ifdef CONFIG_DEBUG_FS
97#include <linux/debugfs.h>
98int adf_bank_debugfs_add(struct adf_etr_bank_data *bank);
99void adf_bank_debugfs_rm(struct adf_etr_bank_data *bank);
100int adf_ring_debugfs_add(struct adf_etr_ring_data *ring, const char *name);
101void adf_ring_debugfs_rm(struct adf_etr_ring_data *ring);
102#else
103static inline int adf_bank_debugfs_add(struct adf_etr_bank_data *bank)
104{
105	return 0;
106}
107
108#define adf_bank_debugfs_rm(bank) do {} while (0)
109
110static inline int adf_ring_debugfs_add(struct adf_etr_ring_data *ring,
111				       const char *name)
112{
113	return 0;
114}
115
116#define adf_ring_debugfs_rm(ring) do {} while (0)
117#endif
118#endif
119