1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0-only) */
2 /* Copyright(c) 2014 - 2020 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
29 enum adf_dev_reset_mode {
30 ADF_DEV_RESET_ASYNC = 0,
31 ADF_DEV_RESET_SYNC
32 };
33
34 enum adf_event {
35 ADF_EVENT_INIT = 0,
36 ADF_EVENT_START,
37 ADF_EVENT_STOP,
38 ADF_EVENT_SHUTDOWN,
39 ADF_EVENT_RESTARTING,
40 ADF_EVENT_RESTARTED,
41 };
42
43 struct service_hndl {
44 int (*event_hld)(struct adf_accel_dev *accel_dev,
45 enum adf_event event);
46 unsigned long init_status[ADF_DEVS_ARRAY_SIZE];
47 unsigned long start_status[ADF_DEVS_ARRAY_SIZE];
48 char *name;
49 struct list_head list;
50 };
51
get_current_node(void)52 static inline int get_current_node(void)
53 {
54 return topology_physical_package_id(raw_smp_processor_id());
55 }
56
57 int adf_service_register(struct service_hndl *service);
58 int adf_service_unregister(struct service_hndl *service);
59
60 int adf_dev_init(struct adf_accel_dev *accel_dev);
61 int adf_dev_start(struct adf_accel_dev *accel_dev);
62 void adf_dev_stop(struct adf_accel_dev *accel_dev);
63 void adf_dev_shutdown(struct adf_accel_dev *accel_dev);
64
65 void adf_pf2vf_notify_restarting(struct adf_accel_dev *accel_dev);
66 int adf_enable_vf2pf_comms(struct adf_accel_dev *accel_dev);
67 void adf_vf2pf_req_hndl(struct adf_accel_vf_info *vf_info);
68 void adf_devmgr_update_class_index(struct adf_hw_device_data *hw_data);
69 void adf_clean_vf_map(bool);
70
71 int adf_ctl_dev_register(void);
72 void adf_ctl_dev_unregister(void);
73 int adf_processes_dev_register(void);
74 void adf_processes_dev_unregister(void);
75
76 int adf_devmgr_add_dev(struct adf_accel_dev *accel_dev,
77 struct adf_accel_dev *pf);
78 void adf_devmgr_rm_dev(struct adf_accel_dev *accel_dev,
79 struct adf_accel_dev *pf);
80 struct list_head *adf_devmgr_get_head(void);
81 struct adf_accel_dev *adf_devmgr_get_dev_by_id(u32 id);
82 struct adf_accel_dev *adf_devmgr_get_first(void);
83 struct adf_accel_dev *adf_devmgr_pci_to_accel_dev(struct pci_dev *pci_dev);
84 int adf_devmgr_verify_id(u32 id);
85 void adf_devmgr_get_num_dev(u32 *num);
86 int adf_devmgr_in_reset(struct adf_accel_dev *accel_dev);
87 int adf_dev_started(struct adf_accel_dev *accel_dev);
88 int adf_dev_restarting_notify(struct adf_accel_dev *accel_dev);
89 int adf_dev_restarted_notify(struct adf_accel_dev *accel_dev);
90 int adf_ae_init(struct adf_accel_dev *accel_dev);
91 int adf_ae_shutdown(struct adf_accel_dev *accel_dev);
92 int adf_ae_fw_load(struct adf_accel_dev *accel_dev);
93 void adf_ae_fw_release(struct adf_accel_dev *accel_dev);
94 int adf_ae_start(struct adf_accel_dev *accel_dev);
95 int adf_ae_stop(struct adf_accel_dev *accel_dev);
96
97 extern const struct pci_error_handlers adf_err_handler;
98 void adf_enable_aer(struct adf_accel_dev *accel_dev);
99 void adf_disable_aer(struct adf_accel_dev *accel_dev);
100 void adf_reset_sbr(struct adf_accel_dev *accel_dev);
101 void adf_reset_flr(struct adf_accel_dev *accel_dev);
102 void adf_dev_restore(struct adf_accel_dev *accel_dev);
103 int adf_init_aer(void);
104 void adf_exit_aer(void);
105 int adf_init_admin_comms(struct adf_accel_dev *accel_dev);
106 void adf_exit_admin_comms(struct adf_accel_dev *accel_dev);
107 int adf_send_admin_init(struct adf_accel_dev *accel_dev);
108 int adf_init_arb(struct adf_accel_dev *accel_dev);
109 void adf_exit_arb(struct adf_accel_dev *accel_dev);
110 void adf_update_ring_arb(struct adf_etr_ring_data *ring);
111
112 int adf_dev_get(struct adf_accel_dev *accel_dev);
113 void adf_dev_put(struct adf_accel_dev *accel_dev);
114 int adf_dev_in_use(struct adf_accel_dev *accel_dev);
115 int adf_init_etr_data(struct adf_accel_dev *accel_dev);
116 void adf_cleanup_etr_data(struct adf_accel_dev *accel_dev);
117 int qat_crypto_register(void);
118 int qat_crypto_unregister(void);
119 int qat_crypto_dev_config(struct adf_accel_dev *accel_dev);
120 struct qat_crypto_instance *qat_crypto_get_instance_node(int node);
121 void qat_crypto_put_instance(struct qat_crypto_instance *inst);
122 void qat_alg_callback(void *resp);
123 void qat_alg_asym_callback(void *resp);
124 int qat_algs_register(void);
125 void qat_algs_unregister(void);
126 int qat_asym_algs_register(void);
127 void qat_asym_algs_unregister(void);
128
129 int adf_isr_resource_alloc(struct adf_accel_dev *accel_dev);
130 void adf_isr_resource_free(struct adf_accel_dev *accel_dev);
131 int adf_vf_isr_resource_alloc(struct adf_accel_dev *accel_dev);
132 void adf_vf_isr_resource_free(struct adf_accel_dev *accel_dev);
133
134 int qat_hal_init(struct adf_accel_dev *accel_dev);
135 void qat_hal_deinit(struct icp_qat_fw_loader_handle *handle);
136 int qat_hal_start(struct icp_qat_fw_loader_handle *handle);
137 void qat_hal_stop(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
138 unsigned int ctx_mask);
139 void qat_hal_reset(struct icp_qat_fw_loader_handle *handle);
140 int qat_hal_clr_reset(struct icp_qat_fw_loader_handle *handle);
141 void qat_hal_set_live_ctx(struct icp_qat_fw_loader_handle *handle,
142 unsigned char ae, unsigned int ctx_mask);
143 int qat_hal_check_ae_active(struct icp_qat_fw_loader_handle *handle,
144 unsigned int ae);
145 int qat_hal_set_ae_lm_mode(struct icp_qat_fw_loader_handle *handle,
146 unsigned char ae, enum icp_qat_uof_regtype lm_type,
147 unsigned char mode);
148 int qat_hal_set_ae_ctx_mode(struct icp_qat_fw_loader_handle *handle,
149 unsigned char ae, unsigned char mode);
150 int qat_hal_set_ae_nn_mode(struct icp_qat_fw_loader_handle *handle,
151 unsigned char ae, unsigned char mode);
152 void qat_hal_set_pc(struct icp_qat_fw_loader_handle *handle,
153 unsigned char ae, unsigned int ctx_mask, unsigned int upc);
154 void qat_hal_wr_uwords(struct icp_qat_fw_loader_handle *handle,
155 unsigned char ae, unsigned int uaddr,
156 unsigned int words_num, u64 *uword);
157 void qat_hal_wr_umem(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
158 unsigned int uword_addr, unsigned int words_num,
159 unsigned int *data);
160 int qat_hal_get_ins_num(void);
161 int qat_hal_batch_wr_lm(struct icp_qat_fw_loader_handle *handle,
162 unsigned char ae,
163 struct icp_qat_uof_batch_init *lm_init_header);
164 int qat_hal_init_gpr(struct icp_qat_fw_loader_handle *handle,
165 unsigned char ae, unsigned long ctx_mask,
166 enum icp_qat_uof_regtype reg_type,
167 unsigned short reg_num, unsigned int regdata);
168 int qat_hal_init_wr_xfer(struct icp_qat_fw_loader_handle *handle,
169 unsigned char ae, unsigned long ctx_mask,
170 enum icp_qat_uof_regtype reg_type,
171 unsigned short reg_num, unsigned int regdata);
172 int qat_hal_init_rd_xfer(struct icp_qat_fw_loader_handle *handle,
173 unsigned char ae, unsigned long ctx_mask,
174 enum icp_qat_uof_regtype reg_type,
175 unsigned short reg_num, unsigned int regdata);
176 int qat_hal_init_nn(struct icp_qat_fw_loader_handle *handle,
177 unsigned char ae, unsigned long ctx_mask,
178 unsigned short reg_num, unsigned int regdata);
179 int qat_hal_wr_lm(struct icp_qat_fw_loader_handle *handle,
180 unsigned char ae, unsigned short lm_addr, unsigned int value);
181 void qat_hal_set_ae_tindex_mode(struct icp_qat_fw_loader_handle *handle,
182 unsigned char ae, unsigned char mode);
183 int qat_uclo_wr_all_uimage(struct icp_qat_fw_loader_handle *handle);
184 void qat_uclo_del_obj(struct icp_qat_fw_loader_handle *handle);
185 int qat_uclo_wr_mimage(struct icp_qat_fw_loader_handle *handle, void *addr_ptr,
186 int mem_size);
187 int qat_uclo_map_obj(struct icp_qat_fw_loader_handle *handle,
188 void *addr_ptr, u32 mem_size, char *obj_name);
189 int qat_uclo_set_cfg_ae_mask(struct icp_qat_fw_loader_handle *handle,
190 unsigned int cfg_ae_mask);
191 #if defined(CONFIG_PCI_IOV)
192 int adf_sriov_configure(struct pci_dev *pdev, int numvfs);
193 void adf_disable_sriov(struct adf_accel_dev *accel_dev);
194 void adf_disable_vf2pf_interrupts(struct adf_accel_dev *accel_dev,
195 u32 vf_mask);
196 void adf_disable_vf2pf_interrupts_irq(struct adf_accel_dev *accel_dev,
197 u32 vf_mask);
198 void adf_enable_vf2pf_interrupts(struct adf_accel_dev *accel_dev,
199 u32 vf_mask);
200 int adf_enable_pf2vf_comms(struct adf_accel_dev *accel_dev);
201 void adf_enable_pf2vf_interrupts(struct adf_accel_dev *accel_dev);
202 void adf_disable_pf2vf_interrupts(struct adf_accel_dev *accel_dev);
203 void adf_schedule_vf2pf_handler(struct adf_accel_vf_info *vf_info);
204 int adf_send_vf2pf_msg(struct adf_accel_dev *accel_dev, u32 msg);
205 int adf_vf2pf_notify_init(struct adf_accel_dev *accel_dev);
206 void adf_vf2pf_notify_shutdown(struct adf_accel_dev *accel_dev);
207 int adf_init_pf_wq(void);
208 void adf_exit_pf_wq(void);
209 int adf_init_vf_wq(void);
210 void adf_exit_vf_wq(void);
211 void adf_flush_vf_wq(struct adf_accel_dev *accel_dev);
212 #else
213 #define adf_sriov_configure NULL
214
adf_enable_pf2vf_comms(struct adf_accel_dev * accel_dev)215 static inline int adf_enable_pf2vf_comms(struct adf_accel_dev *accel_dev)
216 {
217 return 0;
218 }
219
adf_disable_sriov(struct adf_accel_dev * accel_dev)220 static inline void adf_disable_sriov(struct adf_accel_dev *accel_dev)
221 {
222 }
223
adf_enable_pf2vf_interrupts(struct adf_accel_dev * accel_dev)224 static inline void adf_enable_pf2vf_interrupts(struct adf_accel_dev *accel_dev)
225 {
226 }
227
adf_disable_pf2vf_interrupts(struct adf_accel_dev * accel_dev)228 static inline void adf_disable_pf2vf_interrupts(struct adf_accel_dev *accel_dev)
229 {
230 }
231
adf_vf2pf_notify_init(struct adf_accel_dev * accel_dev)232 static inline int adf_vf2pf_notify_init(struct adf_accel_dev *accel_dev)
233 {
234 return 0;
235 }
236
adf_vf2pf_notify_shutdown(struct adf_accel_dev * accel_dev)237 static inline void adf_vf2pf_notify_shutdown(struct adf_accel_dev *accel_dev)
238 {
239 }
240
adf_init_pf_wq(void)241 static inline int adf_init_pf_wq(void)
242 {
243 return 0;
244 }
245
adf_exit_pf_wq(void)246 static inline void adf_exit_pf_wq(void)
247 {
248 }
249
adf_init_vf_wq(void)250 static inline int adf_init_vf_wq(void)
251 {
252 return 0;
253 }
254
adf_exit_vf_wq(void)255 static inline void adf_exit_vf_wq(void)
256 {
257 }
258
adf_flush_vf_wq(struct adf_accel_dev * accel_dev)259 static inline void adf_flush_vf_wq(struct adf_accel_dev *accel_dev)
260 {
261 }
262
263 #endif
264 #endif
265