1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0-only) */
2 /* Copyright(c) 2014 - 2020 Intel Corporation */
3 #ifndef ADF_ACCEL_DEVICES_H_
4 #define ADF_ACCEL_DEVICES_H_
5 #include <linux/interrupt.h>
6 #include <linux/module.h>
7 #include <linux/list.h>
9 #include <linux/ratelimit.h>
10 #include "adf_cfg_common.h"
12 #define ADF_DH895XCC_DEVICE_NAME "dh895xcc"
13 #define ADF_DH895XCCVF_DEVICE_NAME "dh895xccvf"
14 #define ADF_C62X_DEVICE_NAME "c6xx"
15 #define ADF_C62XVF_DEVICE_NAME "c6xxvf"
16 #define ADF_C3XXX_DEVICE_NAME "c3xxx"
17 #define ADF_C3XXXVF_DEVICE_NAME "c3xxxvf"
18 #define ADF_4XXX_DEVICE_NAME "4xxx"
19 #define ADF_4XXX_PCI_DEVICE_ID 0x4940
20 #define ADF_4XXXIOV_PCI_DEVICE_ID 0x4941
21 #define ADF_DEVICE_FUSECTL_OFFSET 0x40
22 #define ADF_DEVICE_LEGFUSE_OFFSET 0x4C
23 #define ADF_DEVICE_FUSECTL_MASK 0x80000000
24 #define ADF_PCI_MAX_BARS 3
25 #define ADF_DEVICE_NAME_LENGTH 32
26 #define ADF_ETR_MAX_RINGS_PER_BANK 16
27 #define ADF_MAX_MSIX_VECTOR_NAME 16
28 #define ADF_DEVICE_NAME_PREFIX "qat_"
30 enum adf_accel_capabilities {
31 ADF_ACCEL_CAPABILITIES_NULL = 0,
32 ADF_ACCEL_CAPABILITIES_CRYPTO_SYMMETRIC = 1,
33 ADF_ACCEL_CAPABILITIES_CRYPTO_ASYMMETRIC = 2,
34 ADF_ACCEL_CAPABILITIES_CIPHER = 4,
35 ADF_ACCEL_CAPABILITIES_AUTHENTICATION = 8,
36 ADF_ACCEL_CAPABILITIES_COMPRESSION = 32,
37 ADF_ACCEL_CAPABILITIES_LZS_COMPRESSION = 64,
38 ADF_ACCEL_CAPABILITIES_RANDOM_NUMBER = 128
42 resource_size_t base_addr;
43 void __iomem *virt_addr;
47 struct adf_accel_msix {
48 struct msix_entry *entries;
53 struct adf_accel_pci {
54 struct pci_dev *pci_dev;
55 struct adf_accel_msix msix_entries;
56 struct adf_bar pci_bars[ADF_PCI_MAX_BARS];
75 static inline const char *get_sku_info(enum dev_sku_info info)
95 struct adf_hw_device_class {
97 const enum adf_device_type type;
113 struct adf_hw_csr_ops {
114 u64 (*build_csr_ring_base_addr)(dma_addr_t addr, u32 size);
115 u32 (*read_csr_ring_head)(void __iomem *csr_base_addr, u32 bank,
117 void (*write_csr_ring_head)(void __iomem *csr_base_addr, u32 bank,
118 u32 ring, u32 value);
119 u32 (*read_csr_ring_tail)(void __iomem *csr_base_addr, u32 bank,
121 void (*write_csr_ring_tail)(void __iomem *csr_base_addr, u32 bank,
122 u32 ring, u32 value);
123 u32 (*read_csr_e_stat)(void __iomem *csr_base_addr, u32 bank);
124 void (*write_csr_ring_config)(void __iomem *csr_base_addr, u32 bank,
125 u32 ring, u32 value);
126 void (*write_csr_ring_base)(void __iomem *csr_base_addr, u32 bank,
127 u32 ring, dma_addr_t addr);
128 void (*write_csr_int_flag)(void __iomem *csr_base_addr, u32 bank,
130 void (*write_csr_int_srcsel)(void __iomem *csr_base_addr, u32 bank);
131 void (*write_csr_int_col_en)(void __iomem *csr_base_addr, u32 bank,
133 void (*write_csr_int_col_ctl)(void __iomem *csr_base_addr, u32 bank,
135 void (*write_csr_int_flag_and_col)(void __iomem *csr_base_addr,
136 u32 bank, u32 value);
137 void (*write_csr_ring_srv_arb_en)(void __iomem *csr_base_addr, u32 bank,
141 struct adf_cfg_device_data;
142 struct adf_accel_dev;
144 struct adf_etr_ring_data;
146 struct adf_hw_device_data {
147 struct adf_hw_device_class *dev_class;
148 u32 (*get_accel_mask)(struct adf_hw_device_data *self);
149 u32 (*get_ae_mask)(struct adf_hw_device_data *self);
150 u32 (*get_accel_cap)(struct adf_accel_dev *accel_dev);
151 u32 (*get_sram_bar_id)(struct adf_hw_device_data *self);
152 u32 (*get_misc_bar_id)(struct adf_hw_device_data *self);
153 u32 (*get_etr_bar_id)(struct adf_hw_device_data *self);
154 u32 (*get_num_aes)(struct adf_hw_device_data *self);
155 u32 (*get_num_accels)(struct adf_hw_device_data *self);
156 u32 (*get_pf2vf_offset)(u32 i);
157 u32 (*get_vintmsk_offset)(u32 i);
158 void (*get_arb_info)(struct arb_info *arb_csrs_info);
159 void (*get_admin_info)(struct admin_info *admin_csrs_info);
160 enum dev_sku_info (*get_sku)(struct adf_hw_device_data *self);
161 int (*alloc_irq)(struct adf_accel_dev *accel_dev);
162 void (*free_irq)(struct adf_accel_dev *accel_dev);
163 void (*enable_error_correction)(struct adf_accel_dev *accel_dev);
164 int (*init_admin_comms)(struct adf_accel_dev *accel_dev);
165 void (*exit_admin_comms)(struct adf_accel_dev *accel_dev);
166 int (*send_admin_init)(struct adf_accel_dev *accel_dev);
167 int (*init_arb)(struct adf_accel_dev *accel_dev);
168 void (*exit_arb)(struct adf_accel_dev *accel_dev);
169 const u32 *(*get_arb_mapping)(void);
170 void (*disable_iov)(struct adf_accel_dev *accel_dev);
171 void (*configure_iov_threads)(struct adf_accel_dev *accel_dev,
173 void (*enable_ints)(struct adf_accel_dev *accel_dev);
174 void (*set_ssm_wdtimer)(struct adf_accel_dev *accel_dev);
175 int (*enable_vf2pf_comms)(struct adf_accel_dev *accel_dev);
176 void (*reset_device)(struct adf_accel_dev *accel_dev);
177 void (*set_msix_rttable)(struct adf_accel_dev *accel_dev);
178 char *(*uof_get_name)(u32 obj_num);
179 u32 (*uof_get_num_objs)(void);
180 u32 (*uof_get_ae_mask)(u32 obj_num);
181 struct adf_hw_csr_ops csr_ops;
183 const char *fw_mmp_name;
186 u32 accel_capabilities_mask;
194 u8 num_rings_per_bank;
196 u8 num_logical_accel;
198 u8 min_iov_compat_ver;
201 /* CSR write macro */
202 #define ADF_CSR_WR(csr_base, csr_offset, val) \
203 __raw_writel(val, csr_base + csr_offset)
206 #define ADF_CSR_RD(csr_base, csr_offset) __raw_readl(csr_base + csr_offset)
208 #define GET_DEV(accel_dev) ((accel_dev)->accel_pci_dev.pci_dev->dev)
209 #define GET_BARS(accel_dev) ((accel_dev)->accel_pci_dev.pci_bars)
210 #define GET_HW_DATA(accel_dev) (accel_dev->hw_device)
211 #define GET_MAX_BANKS(accel_dev) (GET_HW_DATA(accel_dev)->num_banks)
212 #define GET_NUM_RINGS_PER_BANK(accel_dev) \
213 GET_HW_DATA(accel_dev)->num_rings_per_bank
214 #define GET_MAX_ACCELENGINES(accel_dev) (GET_HW_DATA(accel_dev)->num_engines)
215 #define GET_CSR_OPS(accel_dev) (&(accel_dev)->hw_device->csr_ops)
216 #define accel_to_pci_dev(accel_ptr) accel_ptr->accel_pci_dev.pci_dev
218 struct adf_admin_comms;
219 struct icp_qat_fw_loader_handle;
220 struct adf_fw_loader_data {
221 struct icp_qat_fw_loader_handle *fw_loader;
222 const struct firmware *uof_fw;
223 const struct firmware *mmp_fw;
226 struct adf_accel_vf_info {
227 struct adf_accel_dev *accel_dev;
228 struct tasklet_struct vf2pf_bh_tasklet;
229 struct mutex pf2vf_lock; /* protect CSR access for PF2VF messages */
230 struct ratelimit_state vf2pf_ratelimit;
235 struct adf_accel_dev {
236 struct adf_etr_data *transport;
237 struct adf_hw_device_data *hw_device;
238 struct adf_cfg_device_data *cfg;
239 struct adf_fw_loader_data *fw_loader;
240 struct adf_admin_comms *admin;
241 struct list_head crypto_list;
242 unsigned long status;
244 struct dentry *debugfs_dir;
245 struct list_head list;
246 struct module *owner;
247 struct adf_accel_pci accel_pci_dev;
250 /* vf_info is non-zero when SR-IOV is init'ed */
251 struct adf_accel_vf_info *vf_info;
255 struct tasklet_struct pf2vf_bh_tasklet;
256 struct mutex vf2pf_lock; /* protect CSR access */
257 struct completion iov_msg_completion;