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
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_devmgr_update_class_index(struct adf_hw_device_data *hw_data);
66 void adf_clean_vf_map(bool);
67
68 int adf_ctl_dev_register(void);
69 void adf_ctl_dev_unregister(void);
70 int adf_processes_dev_register(void);
71 void adf_processes_dev_unregister(void);
72
73 int adf_devmgr_add_dev(struct adf_accel_dev *accel_dev,
74 struct adf_accel_dev *pf);
75 void adf_devmgr_rm_dev(struct adf_accel_dev *accel_dev,
76 struct adf_accel_dev *pf);
77 struct list_head *adf_devmgr_get_head(void);
78 struct adf_accel_dev *adf_devmgr_get_dev_by_id(u32 id);
79 struct adf_accel_dev *adf_devmgr_get_first(void);
80 struct adf_accel_dev *adf_devmgr_pci_to_accel_dev(struct pci_dev *pci_dev);
81 int adf_devmgr_verify_id(u32 id);
82 void adf_devmgr_get_num_dev(u32 *num);
83 int adf_devmgr_in_reset(struct adf_accel_dev *accel_dev);
84 int adf_dev_started(struct adf_accel_dev *accel_dev);
85 int adf_dev_restarting_notify(struct adf_accel_dev *accel_dev);
86 int adf_dev_restarted_notify(struct adf_accel_dev *accel_dev);
87 int adf_ae_init(struct adf_accel_dev *accel_dev);
88 int adf_ae_shutdown(struct adf_accel_dev *accel_dev);
89 int adf_ae_fw_load(struct adf_accel_dev *accel_dev);
90 void adf_ae_fw_release(struct adf_accel_dev *accel_dev);
91 int adf_ae_start(struct adf_accel_dev *accel_dev);
92 int adf_ae_stop(struct adf_accel_dev *accel_dev);
93
94 extern const struct pci_error_handlers adf_err_handler;
95 void adf_enable_aer(struct adf_accel_dev *accel_dev);
96 void adf_disable_aer(struct adf_accel_dev *accel_dev);
97 void adf_reset_sbr(struct adf_accel_dev *accel_dev);
98 void adf_reset_flr(struct adf_accel_dev *accel_dev);
99 void adf_dev_restore(struct adf_accel_dev *accel_dev);
100 int adf_init_aer(void);
101 void adf_exit_aer(void);
102 int adf_init_admin_comms(struct adf_accel_dev *accel_dev);
103 void adf_exit_admin_comms(struct adf_accel_dev *accel_dev);
104 int adf_send_admin_init(struct adf_accel_dev *accel_dev);
105 int adf_init_admin_pm(struct adf_accel_dev *accel_dev, u32 idle_delay);
106 int adf_init_arb(struct adf_accel_dev *accel_dev);
107 void adf_exit_arb(struct adf_accel_dev *accel_dev);
108 void adf_update_ring_arb(struct adf_etr_ring_data *ring);
109
110 int adf_dev_get(struct adf_accel_dev *accel_dev);
111 void adf_dev_put(struct adf_accel_dev *accel_dev);
112 int adf_dev_in_use(struct adf_accel_dev *accel_dev);
113 int adf_init_etr_data(struct adf_accel_dev *accel_dev);
114 void adf_cleanup_etr_data(struct adf_accel_dev *accel_dev);
115 int qat_crypto_register(void);
116 int qat_crypto_unregister(void);
117 int qat_crypto_dev_config(struct adf_accel_dev *accel_dev);
118 int qat_crypto_vf_dev_config(struct adf_accel_dev *accel_dev);
119 struct qat_crypto_instance *qat_crypto_get_instance_node(int node);
120 void qat_crypto_put_instance(struct qat_crypto_instance *inst);
121 void qat_alg_callback(void *resp);
122 void qat_alg_asym_callback(void *resp);
123 int qat_algs_register(void);
124 void qat_algs_unregister(void);
125 int qat_asym_algs_register(void);
126 void qat_asym_algs_unregister(void);
127
128 int adf_isr_resource_alloc(struct adf_accel_dev *accel_dev);
129 void adf_isr_resource_free(struct adf_accel_dev *accel_dev);
130 int adf_vf_isr_resource_alloc(struct adf_accel_dev *accel_dev);
131 void adf_vf_isr_resource_free(struct adf_accel_dev *accel_dev);
132
133 int adf_pfvf_comms_disabled(struct adf_accel_dev *accel_dev);
134
135 int qat_hal_init(struct adf_accel_dev *accel_dev);
136 void qat_hal_deinit(struct icp_qat_fw_loader_handle *handle);
137 int qat_hal_start(struct icp_qat_fw_loader_handle *handle);
138 void qat_hal_stop(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
139 unsigned int ctx_mask);
140 void qat_hal_reset(struct icp_qat_fw_loader_handle *handle);
141 int qat_hal_clr_reset(struct icp_qat_fw_loader_handle *handle);
142 void qat_hal_set_live_ctx(struct icp_qat_fw_loader_handle *handle,
143 unsigned char ae, unsigned int ctx_mask);
144 int qat_hal_check_ae_active(struct icp_qat_fw_loader_handle *handle,
145 unsigned int ae);
146 int qat_hal_set_ae_lm_mode(struct icp_qat_fw_loader_handle *handle,
147 unsigned char ae, enum icp_qat_uof_regtype lm_type,
148 unsigned char mode);
149 int qat_hal_set_ae_ctx_mode(struct icp_qat_fw_loader_handle *handle,
150 unsigned char ae, unsigned char mode);
151 int qat_hal_set_ae_nn_mode(struct icp_qat_fw_loader_handle *handle,
152 unsigned char ae, unsigned char mode);
153 void qat_hal_set_pc(struct icp_qat_fw_loader_handle *handle,
154 unsigned char ae, unsigned int ctx_mask, unsigned int upc);
155 void qat_hal_wr_uwords(struct icp_qat_fw_loader_handle *handle,
156 unsigned char ae, unsigned int uaddr,
157 unsigned int words_num, u64 *uword);
158 void qat_hal_wr_umem(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
159 unsigned int uword_addr, unsigned int words_num,
160 unsigned int *data);
161 int qat_hal_get_ins_num(void);
162 int qat_hal_batch_wr_lm(struct icp_qat_fw_loader_handle *handle,
163 unsigned char ae,
164 struct icp_qat_uof_batch_init *lm_init_header);
165 int qat_hal_init_gpr(struct icp_qat_fw_loader_handle *handle,
166 unsigned char ae, unsigned long ctx_mask,
167 enum icp_qat_uof_regtype reg_type,
168 unsigned short reg_num, unsigned int regdata);
169 int qat_hal_init_wr_xfer(struct icp_qat_fw_loader_handle *handle,
170 unsigned char ae, unsigned long ctx_mask,
171 enum icp_qat_uof_regtype reg_type,
172 unsigned short reg_num, unsigned int regdata);
173 int qat_hal_init_rd_xfer(struct icp_qat_fw_loader_handle *handle,
174 unsigned char ae, unsigned long ctx_mask,
175 enum icp_qat_uof_regtype reg_type,
176 unsigned short reg_num, unsigned int regdata);
177 int qat_hal_init_nn(struct icp_qat_fw_loader_handle *handle,
178 unsigned char ae, unsigned long ctx_mask,
179 unsigned short reg_num, unsigned int regdata);
180 int qat_hal_wr_lm(struct icp_qat_fw_loader_handle *handle,
181 unsigned char ae, unsigned short lm_addr, unsigned int value);
182 void qat_hal_set_ae_tindex_mode(struct icp_qat_fw_loader_handle *handle,
183 unsigned char ae, unsigned char mode);
184 int qat_uclo_wr_all_uimage(struct icp_qat_fw_loader_handle *handle);
185 void qat_uclo_del_obj(struct icp_qat_fw_loader_handle *handle);
186 int qat_uclo_wr_mimage(struct icp_qat_fw_loader_handle *handle, void *addr_ptr,
187 int mem_size);
188 int qat_uclo_map_obj(struct icp_qat_fw_loader_handle *handle,
189 void *addr_ptr, u32 mem_size, char *obj_name);
190 int qat_uclo_set_cfg_ae_mask(struct icp_qat_fw_loader_handle *handle,
191 unsigned int cfg_ae_mask);
192 int adf_init_misc_wq(void);
193 void adf_exit_misc_wq(void);
194 bool adf_misc_wq_queue_work(struct work_struct *work);
195 #if defined(CONFIG_PCI_IOV)
196 int adf_sriov_configure(struct pci_dev *pdev, int numvfs);
197 void adf_disable_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_init_pf_wq(void)218 static inline int adf_init_pf_wq(void)
219 {
220 return 0;
221 }
222
adf_exit_pf_wq(void)223 static inline void adf_exit_pf_wq(void)
224 {
225 }
226
adf_init_vf_wq(void)227 static inline int adf_init_vf_wq(void)
228 {
229 return 0;
230 }
231
adf_exit_vf_wq(void)232 static inline void adf_exit_vf_wq(void)
233 {
234 }
235
236 #endif
237
adf_get_pmisc_base(struct adf_accel_dev * accel_dev)238 static inline void __iomem *adf_get_pmisc_base(struct adf_accel_dev *accel_dev)
239 {
240 struct adf_hw_device_data *hw_data = accel_dev->hw_device;
241 struct adf_bar *pmisc;
242
243 pmisc = &GET_BARS(accel_dev)[hw_data->get_misc_bar_id(hw_data)];
244
245 return pmisc->virt_addr;
246 }
247
248 #endif
249