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
52 int adf_service_register(struct service_hndl *service);
53 int adf_service_unregister(struct service_hndl *service);
54
55 int adf_dev_init(struct adf_accel_dev *accel_dev);
56 int adf_dev_start(struct adf_accel_dev *accel_dev);
57 void adf_dev_stop(struct adf_accel_dev *accel_dev);
58 void adf_dev_shutdown(struct adf_accel_dev *accel_dev);
59
60 int adf_iov_putmsg(struct adf_accel_dev *accel_dev, u32 msg, u8 vf_nr);
61 void adf_pf2vf_notify_restarting(struct adf_accel_dev *accel_dev);
62 int adf_enable_vf2pf_comms(struct adf_accel_dev *accel_dev);
63 void adf_vf2pf_req_hndl(struct adf_accel_vf_info *vf_info);
64 void adf_devmgr_update_class_index(struct adf_hw_device_data *hw_data);
65 void adf_clean_vf_map(bool);
66
67 int adf_ctl_dev_register(void);
68 void adf_ctl_dev_unregister(void);
69 int adf_processes_dev_register(void);
70 void adf_processes_dev_unregister(void);
71
72 int adf_devmgr_add_dev(struct adf_accel_dev *accel_dev,
73 struct adf_accel_dev *pf);
74 void adf_devmgr_rm_dev(struct adf_accel_dev *accel_dev,
75 struct adf_accel_dev *pf);
76 struct list_head *adf_devmgr_get_head(void);
77 struct adf_accel_dev *adf_devmgr_get_dev_by_id(u32 id);
78 struct adf_accel_dev *adf_devmgr_get_first(void);
79 struct adf_accel_dev *adf_devmgr_pci_to_accel_dev(struct pci_dev *pci_dev);
80 int adf_devmgr_verify_id(u32 id);
81 void adf_devmgr_get_num_dev(u32 *num);
82 int adf_devmgr_in_reset(struct adf_accel_dev *accel_dev);
83 int adf_dev_started(struct adf_accel_dev *accel_dev);
84 int adf_dev_restarting_notify(struct adf_accel_dev *accel_dev);
85 int adf_dev_restarted_notify(struct adf_accel_dev *accel_dev);
86 int adf_ae_init(struct adf_accel_dev *accel_dev);
87 int adf_ae_shutdown(struct adf_accel_dev *accel_dev);
88 int adf_ae_fw_load(struct adf_accel_dev *accel_dev);
89 void adf_ae_fw_release(struct adf_accel_dev *accel_dev);
90 int adf_ae_start(struct adf_accel_dev *accel_dev);
91 int adf_ae_stop(struct adf_accel_dev *accel_dev);
92
93 int adf_enable_aer(struct adf_accel_dev *accel_dev);
94 void adf_disable_aer(struct adf_accel_dev *accel_dev);
95 void adf_reset_sbr(struct adf_accel_dev *accel_dev);
96 void adf_reset_flr(struct adf_accel_dev *accel_dev);
97 void adf_dev_restore(struct adf_accel_dev *accel_dev);
98 int adf_init_aer(void);
99 void adf_exit_aer(void);
100 int adf_init_admin_comms(struct adf_accel_dev *accel_dev);
101 void adf_exit_admin_comms(struct adf_accel_dev *accel_dev);
102 int adf_send_admin_init(struct adf_accel_dev *accel_dev);
103 int adf_init_arb(struct adf_accel_dev *accel_dev);
104 void adf_exit_arb(struct adf_accel_dev *accel_dev);
105 void adf_update_ring_arb(struct adf_etr_ring_data *ring);
106
107 int adf_dev_get(struct adf_accel_dev *accel_dev);
108 void adf_dev_put(struct adf_accel_dev *accel_dev);
109 int adf_dev_in_use(struct adf_accel_dev *accel_dev);
110 int adf_init_etr_data(struct adf_accel_dev *accel_dev);
111 void adf_cleanup_etr_data(struct adf_accel_dev *accel_dev);
112 int qat_crypto_register(void);
113 int qat_crypto_unregister(void);
114 int qat_crypto_dev_config(struct adf_accel_dev *accel_dev);
115 struct qat_crypto_instance *qat_crypto_get_instance_node(int node);
116 void qat_crypto_put_instance(struct qat_crypto_instance *inst);
117 void qat_alg_callback(void *resp);
118 void qat_alg_asym_callback(void *resp);
119 int qat_algs_register(void);
120 void qat_algs_unregister(void);
121 int qat_asym_algs_register(void);
122 void qat_asym_algs_unregister(void);
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 qat_hal_init(struct adf_accel_dev *accel_dev);
130 void qat_hal_deinit(struct icp_qat_fw_loader_handle *handle);
131 int qat_hal_start(struct icp_qat_fw_loader_handle *handle);
132 void qat_hal_stop(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
133 unsigned int ctx_mask);
134 void qat_hal_reset(struct icp_qat_fw_loader_handle *handle);
135 int qat_hal_clr_reset(struct icp_qat_fw_loader_handle *handle);
136 void qat_hal_set_live_ctx(struct icp_qat_fw_loader_handle *handle,
137 unsigned char ae, unsigned int ctx_mask);
138 int qat_hal_check_ae_active(struct icp_qat_fw_loader_handle *handle,
139 unsigned int ae);
140 int qat_hal_set_ae_lm_mode(struct icp_qat_fw_loader_handle *handle,
141 unsigned char ae, enum icp_qat_uof_regtype lm_type,
142 unsigned char mode);
143 int qat_hal_set_ae_ctx_mode(struct icp_qat_fw_loader_handle *handle,
144 unsigned char ae, unsigned char mode);
145 int qat_hal_set_ae_nn_mode(struct icp_qat_fw_loader_handle *handle,
146 unsigned char ae, unsigned char mode);
147 void qat_hal_set_pc(struct icp_qat_fw_loader_handle *handle,
148 unsigned char ae, unsigned int ctx_mask, unsigned int upc);
149 void qat_hal_wr_uwords(struct icp_qat_fw_loader_handle *handle,
150 unsigned char ae, unsigned int uaddr,
151 unsigned int words_num, u64 *uword);
152 void qat_hal_wr_umem(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
153 unsigned int uword_addr, unsigned int words_num,
154 unsigned int *data);
155 int qat_hal_get_ins_num(void);
156 int qat_hal_batch_wr_lm(struct icp_qat_fw_loader_handle *handle,
157 unsigned char ae,
158 struct icp_qat_uof_batch_init *lm_init_header);
159 int qat_hal_init_gpr(struct icp_qat_fw_loader_handle *handle,
160 unsigned char ae, unsigned long ctx_mask,
161 enum icp_qat_uof_regtype reg_type,
162 unsigned short reg_num, unsigned int regdata);
163 int qat_hal_init_wr_xfer(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_rd_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_nn(struct icp_qat_fw_loader_handle *handle,
172 unsigned char ae, unsigned long ctx_mask,
173 unsigned short reg_num, unsigned int regdata);
174 int qat_hal_wr_lm(struct icp_qat_fw_loader_handle *handle,
175 unsigned char ae, unsigned short lm_addr, unsigned int value);
176 void qat_hal_set_ae_tindex_mode(struct icp_qat_fw_loader_handle *handle,
177 unsigned char ae, unsigned char mode);
178 int qat_uclo_wr_all_uimage(struct icp_qat_fw_loader_handle *handle);
179 void qat_uclo_del_obj(struct icp_qat_fw_loader_handle *handle);
180 int qat_uclo_wr_mimage(struct icp_qat_fw_loader_handle *handle, void *addr_ptr,
181 int mem_size);
182 int qat_uclo_map_obj(struct icp_qat_fw_loader_handle *handle,
183 void *addr_ptr, u32 mem_size, char *obj_name);
184 int qat_uclo_set_cfg_ae_mask(struct icp_qat_fw_loader_handle *handle,
185 unsigned int cfg_ae_mask);
186 #if defined(CONFIG_PCI_IOV)
187 int adf_sriov_configure(struct pci_dev *pdev, int numvfs);
188 void adf_disable_sriov(struct adf_accel_dev *accel_dev);
189 void adf_disable_vf2pf_interrupts(struct adf_accel_dev *accel_dev,
190 u32 vf_mask);
191 void adf_disable_vf2pf_interrupts_irq(struct adf_accel_dev *accel_dev,
192 u32 vf_mask);
193 void adf_enable_vf2pf_interrupts(struct adf_accel_dev *accel_dev,
194 u32 vf_mask);
195 void adf_enable_pf2vf_interrupts(struct adf_accel_dev *accel_dev);
196 void adf_disable_pf2vf_interrupts(struct adf_accel_dev *accel_dev);
197 void adf_schedule_vf2pf_handler(struct adf_accel_vf_info *vf_info);
198
199 int adf_vf2pf_notify_init(struct adf_accel_dev *accel_dev);
200 void adf_vf2pf_notify_shutdown(struct adf_accel_dev *accel_dev);
201 int adf_init_pf_wq(void);
202 void adf_exit_pf_wq(void);
203 int adf_init_vf_wq(void);
204 void adf_exit_vf_wq(void);
205 void adf_flush_vf_wq(struct adf_accel_dev *accel_dev);
206 #else
207 #define adf_sriov_configure NULL
208
adf_disable_sriov(struct adf_accel_dev * accel_dev)209 static inline void adf_disable_sriov(struct adf_accel_dev *accel_dev)
210 {
211 }
212
adf_enable_pf2vf_interrupts(struct adf_accel_dev * accel_dev)213 static inline void adf_enable_pf2vf_interrupts(struct adf_accel_dev *accel_dev)
214 {
215 }
216
adf_disable_pf2vf_interrupts(struct adf_accel_dev * accel_dev)217 static inline void adf_disable_pf2vf_interrupts(struct adf_accel_dev *accel_dev)
218 {
219 }
220
adf_vf2pf_notify_init(struct adf_accel_dev * accel_dev)221 static inline int adf_vf2pf_notify_init(struct adf_accel_dev *accel_dev)
222 {
223 return 0;
224 }
225
adf_vf2pf_notify_shutdown(struct adf_accel_dev * accel_dev)226 static inline void adf_vf2pf_notify_shutdown(struct adf_accel_dev *accel_dev)
227 {
228 }
229
adf_init_pf_wq(void)230 static inline int adf_init_pf_wq(void)
231 {
232 return 0;
233 }
234
adf_exit_pf_wq(void)235 static inline void adf_exit_pf_wq(void)
236 {
237 }
238
adf_init_vf_wq(void)239 static inline int adf_init_vf_wq(void)
240 {
241 return 0;
242 }
243
adf_exit_vf_wq(void)244 static inline void adf_exit_vf_wq(void)
245 {
246 }
247
adf_flush_vf_wq(struct adf_accel_dev * accel_dev)248 static inline void adf_flush_vf_wq(struct adf_accel_dev *accel_dev)
249 {
250 }
251
252 #endif
253 #endif
254