1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0-only) */
2 /* Copyright(c) 2014 - 2021 Intel Corporation */
3 #ifndef ADF_DRV_H
4 #define ADF_DRV_H
5
6 #include <linux/list.h>
7 #include <linux/pci.h>
8 #include "adf_accel_devices.h"
9 #include "icp_qat_fw_loader_handle.h"
10 #include "icp_qat_hal.h"
11
12 #define ADF_MAJOR_VERSION 0
13 #define ADF_MINOR_VERSION 6
14 #define ADF_BUILD_VERSION 0
15 #define ADF_DRV_VERSION __stringify(ADF_MAJOR_VERSION) "." \
16 __stringify(ADF_MINOR_VERSION) "." \
17 __stringify(ADF_BUILD_VERSION)
18
19 #define ADF_STATUS_RESTARTING 0
20 #define ADF_STATUS_STARTING 1
21 #define ADF_STATUS_CONFIGURED 2
22 #define ADF_STATUS_STARTED 3
23 #define ADF_STATUS_AE_INITIALISED 4
24 #define ADF_STATUS_AE_UCODE_LOADED 5
25 #define ADF_STATUS_AE_STARTED 6
26 #define ADF_STATUS_PF_RUNNING 7
27 #define ADF_STATUS_IRQ_ALLOCATED 8
28 #define ADF_STATUS_CRYPTO_ALGS_REGISTERED 9
29 #define ADF_STATUS_COMP_ALGS_REGISTERED 10
30
31 enum adf_dev_reset_mode {
32 ADF_DEV_RESET_ASYNC = 0,
33 ADF_DEV_RESET_SYNC
34 };
35
36 enum adf_event {
37 ADF_EVENT_INIT = 0,
38 ADF_EVENT_START,
39 ADF_EVENT_STOP,
40 ADF_EVENT_SHUTDOWN,
41 ADF_EVENT_RESTARTING,
42 ADF_EVENT_RESTARTED,
43 ADF_EVENT_FATAL_ERROR,
44 };
45
46 struct service_hndl {
47 int (*event_hld)(struct adf_accel_dev *accel_dev,
48 enum adf_event event);
49 unsigned long init_status[ADF_DEVS_ARRAY_SIZE];
50 unsigned long start_status[ADF_DEVS_ARRAY_SIZE];
51 char *name;
52 struct list_head list;
53 };
54
55 int adf_service_register(struct service_hndl *service);
56 int adf_service_unregister(struct service_hndl *service);
57
58 int adf_dev_up(struct adf_accel_dev *accel_dev, bool init_config);
59 int adf_dev_down(struct adf_accel_dev *accel_dev);
60 int adf_dev_restart(struct adf_accel_dev *accel_dev);
61
62 void adf_devmgr_update_class_index(struct adf_hw_device_data *hw_data);
63 void adf_clean_vf_map(bool);
64 int adf_notify_fatal_error(struct adf_accel_dev *accel_dev);
65 void adf_error_notifier(struct adf_accel_dev *accel_dev);
66 int adf_devmgr_add_dev(struct adf_accel_dev *accel_dev,
67 struct adf_accel_dev *pf);
68 void adf_devmgr_rm_dev(struct adf_accel_dev *accel_dev,
69 struct adf_accel_dev *pf);
70 struct list_head *adf_devmgr_get_head(void);
71 struct adf_accel_dev *adf_devmgr_get_dev_by_id(u32 id);
72 struct adf_accel_dev *adf_devmgr_get_first(void);
73 struct adf_accel_dev *adf_devmgr_pci_to_accel_dev(struct pci_dev *pci_dev);
74 int adf_devmgr_verify_id(u32 id);
75 void adf_devmgr_get_num_dev(u32 *num);
76 int adf_devmgr_in_reset(struct adf_accel_dev *accel_dev);
77 int adf_dev_started(struct adf_accel_dev *accel_dev);
78 int adf_dev_restarting_notify(struct adf_accel_dev *accel_dev);
79 int adf_dev_restarted_notify(struct adf_accel_dev *accel_dev);
80 int adf_ae_init(struct adf_accel_dev *accel_dev);
81 int adf_ae_shutdown(struct adf_accel_dev *accel_dev);
82 int adf_ae_fw_load(struct adf_accel_dev *accel_dev);
83 void adf_ae_fw_release(struct adf_accel_dev *accel_dev);
84 int adf_ae_start(struct adf_accel_dev *accel_dev);
85 int adf_ae_stop(struct adf_accel_dev *accel_dev);
86
87 extern const struct pci_error_handlers adf_err_handler;
88 void adf_reset_sbr(struct adf_accel_dev *accel_dev);
89 void adf_reset_flr(struct adf_accel_dev *accel_dev);
90 int adf_dev_autoreset(struct adf_accel_dev *accel_dev);
91 void adf_dev_restore(struct adf_accel_dev *accel_dev);
92 int adf_init_aer(void);
93 void adf_exit_aer(void);
94 int adf_init_arb(struct adf_accel_dev *accel_dev);
95 void adf_exit_arb(struct adf_accel_dev *accel_dev);
96 void adf_update_ring_arb(struct adf_etr_ring_data *ring);
97 int adf_disable_arb_thd(struct adf_accel_dev *accel_dev, u32 ae, u32 thr);
98
99 int adf_dev_get(struct adf_accel_dev *accel_dev);
100 void adf_dev_put(struct adf_accel_dev *accel_dev);
101 int adf_dev_in_use(struct adf_accel_dev *accel_dev);
102 int adf_init_etr_data(struct adf_accel_dev *accel_dev);
103 void adf_cleanup_etr_data(struct adf_accel_dev *accel_dev);
104 int qat_crypto_register(void);
105 int qat_crypto_unregister(void);
106 int qat_crypto_vf_dev_config(struct adf_accel_dev *accel_dev);
107 struct qat_crypto_instance *qat_crypto_get_instance_node(int node);
108 void qat_crypto_put_instance(struct qat_crypto_instance *inst);
109 void qat_alg_callback(void *resp);
110 void qat_alg_asym_callback(void *resp);
111 int qat_algs_register(void);
112 void qat_algs_unregister(void);
113 int qat_asym_algs_register(void);
114 void qat_asym_algs_unregister(void);
115
116 struct qat_compression_instance *qat_compression_get_instance_node(int node);
117 void qat_compression_put_instance(struct qat_compression_instance *inst);
118 int qat_compression_register(void);
119 int qat_compression_unregister(void);
120 int qat_comp_algs_register(void);
121 void qat_comp_algs_unregister(void);
122 void qat_comp_alg_callback(void *resp);
123
124 int adf_isr_resource_alloc(struct adf_accel_dev *accel_dev);
125 void adf_isr_resource_free(struct adf_accel_dev *accel_dev);
126 int adf_vf_isr_resource_alloc(struct adf_accel_dev *accel_dev);
127 void adf_vf_isr_resource_free(struct adf_accel_dev *accel_dev);
128
129 int adf_pfvf_comms_disabled(struct adf_accel_dev *accel_dev);
130
131 int adf_sysfs_init(struct adf_accel_dev *accel_dev);
132
133 int qat_hal_init(struct adf_accel_dev *accel_dev);
134 void qat_hal_deinit(struct icp_qat_fw_loader_handle *handle);
135 int qat_hal_start(struct icp_qat_fw_loader_handle *handle);
136 void qat_hal_stop(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
137 unsigned int ctx_mask);
138 void qat_hal_reset(struct icp_qat_fw_loader_handle *handle);
139 int qat_hal_clr_reset(struct icp_qat_fw_loader_handle *handle);
140 void qat_hal_set_live_ctx(struct icp_qat_fw_loader_handle *handle,
141 unsigned char ae, unsigned int ctx_mask);
142 int qat_hal_check_ae_active(struct icp_qat_fw_loader_handle *handle,
143 unsigned int ae);
144 int qat_hal_set_ae_lm_mode(struct icp_qat_fw_loader_handle *handle,
145 unsigned char ae, enum icp_qat_uof_regtype lm_type,
146 unsigned char mode);
147 int qat_hal_set_ae_ctx_mode(struct icp_qat_fw_loader_handle *handle,
148 unsigned char ae, unsigned char mode);
149 int qat_hal_set_ae_nn_mode(struct icp_qat_fw_loader_handle *handle,
150 unsigned char ae, unsigned char mode);
151 void qat_hal_set_pc(struct icp_qat_fw_loader_handle *handle,
152 unsigned char ae, unsigned int ctx_mask, unsigned int upc);
153 void qat_hal_wr_uwords(struct icp_qat_fw_loader_handle *handle,
154 unsigned char ae, unsigned int uaddr,
155 unsigned int words_num, u64 *uword);
156 void qat_hal_wr_umem(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
157 unsigned int uword_addr, unsigned int words_num,
158 unsigned int *data);
159 int qat_hal_get_ins_num(void);
160 int qat_hal_batch_wr_lm(struct icp_qat_fw_loader_handle *handle,
161 unsigned char ae,
162 struct icp_qat_uof_batch_init *lm_init_header);
163 int qat_hal_init_gpr(struct icp_qat_fw_loader_handle *handle,
164 unsigned char ae, unsigned long ctx_mask,
165 enum icp_qat_uof_regtype reg_type,
166 unsigned short reg_num, unsigned int regdata);
167 int qat_hal_init_wr_xfer(struct icp_qat_fw_loader_handle *handle,
168 unsigned char ae, unsigned long ctx_mask,
169 enum icp_qat_uof_regtype reg_type,
170 unsigned short reg_num, unsigned int regdata);
171 int qat_hal_init_rd_xfer(struct icp_qat_fw_loader_handle *handle,
172 unsigned char ae, unsigned long ctx_mask,
173 enum icp_qat_uof_regtype reg_type,
174 unsigned short reg_num, unsigned int regdata);
175 int qat_hal_init_nn(struct icp_qat_fw_loader_handle *handle,
176 unsigned char ae, unsigned long ctx_mask,
177 unsigned short reg_num, unsigned int regdata);
178 void qat_hal_set_ae_tindex_mode(struct icp_qat_fw_loader_handle *handle,
179 unsigned char ae, unsigned char mode);
180 int qat_uclo_wr_all_uimage(struct icp_qat_fw_loader_handle *handle);
181 void qat_uclo_del_obj(struct icp_qat_fw_loader_handle *handle);
182 int qat_uclo_wr_mimage(struct icp_qat_fw_loader_handle *handle, void *addr_ptr,
183 int mem_size);
184 int qat_uclo_map_obj(struct icp_qat_fw_loader_handle *handle,
185 void *addr_ptr, u32 mem_size, const char *obj_name);
186 int qat_uclo_set_cfg_ae_mask(struct icp_qat_fw_loader_handle *handle,
187 unsigned int cfg_ae_mask);
188 int adf_init_misc_wq(void);
189 void adf_exit_misc_wq(void);
190 bool adf_misc_wq_queue_work(struct work_struct *work);
191 bool adf_misc_wq_queue_delayed_work(struct delayed_work *work,
192 unsigned long delay);
193 void adf_misc_wq_flush(void);
194 #if defined(CONFIG_PCI_IOV)
195 int adf_sriov_configure(struct pci_dev *pdev, int numvfs);
196 void adf_disable_sriov(struct adf_accel_dev *accel_dev);
197 void adf_reenable_sriov(struct adf_accel_dev *accel_dev);
198 void adf_enable_vf2pf_interrupts(struct adf_accel_dev *accel_dev, u32 vf_mask);
199 void adf_disable_all_vf2pf_interrupts(struct adf_accel_dev *accel_dev);
200 bool adf_recv_and_handle_pf2vf_msg(struct adf_accel_dev *accel_dev);
201 bool adf_recv_and_handle_vf2pf_msg(struct adf_accel_dev *accel_dev, u32 vf_nr);
202 int adf_pf2vf_handle_pf_restarting(struct adf_accel_dev *accel_dev);
203 void adf_enable_pf2vf_interrupts(struct adf_accel_dev *accel_dev);
204 void adf_disable_pf2vf_interrupts(struct adf_accel_dev *accel_dev);
205 void adf_schedule_vf2pf_handler(struct adf_accel_vf_info *vf_info);
206 int adf_init_pf_wq(void);
207 void adf_exit_pf_wq(void);
208 int adf_init_vf_wq(void);
209 void adf_exit_vf_wq(void);
210 void adf_flush_vf_wq(struct adf_accel_dev *accel_dev);
211 #else
212 #define adf_sriov_configure NULL
213
adf_disable_sriov(struct adf_accel_dev * accel_dev)214 static inline void adf_disable_sriov(struct adf_accel_dev *accel_dev)
215 {
216 }
217
adf_reenable_sriov(struct adf_accel_dev * accel_dev)218 static inline void adf_reenable_sriov(struct adf_accel_dev *accel_dev)
219 {
220 }
221
adf_init_pf_wq(void)222 static inline int adf_init_pf_wq(void)
223 {
224 return 0;
225 }
226
adf_exit_pf_wq(void)227 static inline void adf_exit_pf_wq(void)
228 {
229 }
230
adf_init_vf_wq(void)231 static inline int adf_init_vf_wq(void)
232 {
233 return 0;
234 }
235
adf_exit_vf_wq(void)236 static inline void adf_exit_vf_wq(void)
237 {
238 }
239
240 #endif
241
adf_get_pmisc_base(struct adf_accel_dev * accel_dev)242 static inline void __iomem *adf_get_pmisc_base(struct adf_accel_dev *accel_dev)
243 {
244 struct adf_hw_device_data *hw_data = accel_dev->hw_device;
245 struct adf_bar *pmisc;
246
247 pmisc = &GET_BARS(accel_dev)[hw_data->get_misc_bar_id(hw_data)];
248
249 return pmisc->virt_addr;
250 }
251
adf_get_etr_base(struct adf_accel_dev * accel_dev)252 static inline void __iomem *adf_get_etr_base(struct adf_accel_dev *accel_dev)
253 {
254 struct adf_hw_device_data *hw_data = accel_dev->hw_device;
255 struct adf_bar *etr;
256
257 etr = &GET_BARS(accel_dev)[hw_data->get_etr_bar_id(hw_data)];
258
259 return etr->virt_addr;
260 }
261
adf_get_aram_base(struct adf_accel_dev * accel_dev)262 static inline void __iomem *adf_get_aram_base(struct adf_accel_dev *accel_dev)
263 {
264 struct adf_hw_device_data *hw_data = accel_dev->hw_device;
265 struct adf_bar *param;
266
267 param = &GET_BARS(accel_dev)[hw_data->get_sram_bar_id(hw_data)];
268
269 return param->virt_addr;
270 }
271
272 #endif
273