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 }; 44 45 struct service_hndl { 46 int (*event_hld)(struct adf_accel_dev *accel_dev, 47 enum adf_event event); 48 unsigned long init_status[ADF_DEVS_ARRAY_SIZE]; 49 unsigned long start_status[ADF_DEVS_ARRAY_SIZE]; 50 char *name; 51 struct list_head list; 52 }; 53 54 int adf_service_register(struct service_hndl *service); 55 int adf_service_unregister(struct service_hndl *service); 56 57 int adf_dev_up(struct adf_accel_dev *accel_dev, bool init_config); 58 int adf_dev_down(struct adf_accel_dev *accel_dev, bool cache_config); 59 int adf_dev_restart(struct adf_accel_dev *accel_dev); 60 61 void adf_devmgr_update_class_index(struct adf_hw_device_data *hw_data); 62 void adf_clean_vf_map(bool); 63 int adf_devmgr_add_dev(struct adf_accel_dev *accel_dev, 64 struct adf_accel_dev *pf); 65 void adf_devmgr_rm_dev(struct adf_accel_dev *accel_dev, 66 struct adf_accel_dev *pf); 67 struct list_head *adf_devmgr_get_head(void); 68 struct adf_accel_dev *adf_devmgr_get_dev_by_id(u32 id); 69 struct adf_accel_dev *adf_devmgr_get_first(void); 70 struct adf_accel_dev *adf_devmgr_pci_to_accel_dev(struct pci_dev *pci_dev); 71 int adf_devmgr_verify_id(u32 id); 72 void adf_devmgr_get_num_dev(u32 *num); 73 int adf_devmgr_in_reset(struct adf_accel_dev *accel_dev); 74 int adf_dev_started(struct adf_accel_dev *accel_dev); 75 int adf_dev_restarting_notify(struct adf_accel_dev *accel_dev); 76 int adf_dev_restarted_notify(struct adf_accel_dev *accel_dev); 77 int adf_ae_init(struct adf_accel_dev *accel_dev); 78 int adf_ae_shutdown(struct adf_accel_dev *accel_dev); 79 int adf_ae_fw_load(struct adf_accel_dev *accel_dev); 80 void adf_ae_fw_release(struct adf_accel_dev *accel_dev); 81 int adf_ae_start(struct adf_accel_dev *accel_dev); 82 int adf_ae_stop(struct adf_accel_dev *accel_dev); 83 84 extern const struct pci_error_handlers adf_err_handler; 85 void adf_reset_sbr(struct adf_accel_dev *accel_dev); 86 void adf_reset_flr(struct adf_accel_dev *accel_dev); 87 void adf_dev_restore(struct adf_accel_dev *accel_dev); 88 int adf_init_aer(void); 89 void adf_exit_aer(void); 90 int adf_init_admin_comms(struct adf_accel_dev *accel_dev); 91 void adf_exit_admin_comms(struct adf_accel_dev *accel_dev); 92 int adf_send_admin_init(struct adf_accel_dev *accel_dev); 93 int adf_get_ae_fw_counters(struct adf_accel_dev *accel_dev, u16 ae, u64 *reqs, u64 *resps); 94 int adf_init_admin_pm(struct adf_accel_dev *accel_dev, u32 idle_delay); 95 int adf_send_admin_tim_sync(struct adf_accel_dev *accel_dev, u32 cnt); 96 int adf_send_admin_hb_timer(struct adf_accel_dev *accel_dev, uint32_t ticks); 97 int adf_get_fw_timestamp(struct adf_accel_dev *accel_dev, u64 *timestamp); 98 int adf_init_arb(struct adf_accel_dev *accel_dev); 99 void adf_exit_arb(struct adf_accel_dev *accel_dev); 100 void adf_update_ring_arb(struct adf_etr_ring_data *ring); 101 102 int adf_dev_get(struct adf_accel_dev *accel_dev); 103 void adf_dev_put(struct adf_accel_dev *accel_dev); 104 int adf_dev_in_use(struct adf_accel_dev *accel_dev); 105 int adf_init_etr_data(struct adf_accel_dev *accel_dev); 106 void adf_cleanup_etr_data(struct adf_accel_dev *accel_dev); 107 int qat_crypto_register(void); 108 int qat_crypto_unregister(void); 109 int qat_crypto_vf_dev_config(struct adf_accel_dev *accel_dev); 110 struct qat_crypto_instance *qat_crypto_get_instance_node(int node); 111 void qat_crypto_put_instance(struct qat_crypto_instance *inst); 112 void qat_alg_callback(void *resp); 113 void qat_alg_asym_callback(void *resp); 114 int qat_algs_register(void); 115 void qat_algs_unregister(void); 116 int qat_asym_algs_register(void); 117 void qat_asym_algs_unregister(void); 118 119 struct qat_compression_instance *qat_compression_get_instance_node(int node); 120 void qat_compression_put_instance(struct qat_compression_instance *inst); 121 int qat_compression_register(void); 122 int qat_compression_unregister(void); 123 int qat_comp_algs_register(void); 124 void qat_comp_algs_unregister(void); 125 void qat_comp_alg_callback(void *resp); 126 127 int adf_isr_resource_alloc(struct adf_accel_dev *accel_dev); 128 void adf_isr_resource_free(struct adf_accel_dev *accel_dev); 129 int adf_vf_isr_resource_alloc(struct adf_accel_dev *accel_dev); 130 void adf_vf_isr_resource_free(struct adf_accel_dev *accel_dev); 131 132 int adf_pfvf_comms_disabled(struct adf_accel_dev *accel_dev); 133 134 int adf_sysfs_init(struct adf_accel_dev *accel_dev); 135 136 int qat_hal_init(struct adf_accel_dev *accel_dev); 137 void qat_hal_deinit(struct icp_qat_fw_loader_handle *handle); 138 int qat_hal_start(struct icp_qat_fw_loader_handle *handle); 139 void qat_hal_stop(struct icp_qat_fw_loader_handle *handle, unsigned char ae, 140 unsigned int ctx_mask); 141 void qat_hal_reset(struct icp_qat_fw_loader_handle *handle); 142 int qat_hal_clr_reset(struct icp_qat_fw_loader_handle *handle); 143 void qat_hal_set_live_ctx(struct icp_qat_fw_loader_handle *handle, 144 unsigned char ae, unsigned int ctx_mask); 145 int qat_hal_check_ae_active(struct icp_qat_fw_loader_handle *handle, 146 unsigned int ae); 147 int qat_hal_set_ae_lm_mode(struct icp_qat_fw_loader_handle *handle, 148 unsigned char ae, enum icp_qat_uof_regtype lm_type, 149 unsigned char mode); 150 int qat_hal_set_ae_ctx_mode(struct icp_qat_fw_loader_handle *handle, 151 unsigned char ae, unsigned char mode); 152 int qat_hal_set_ae_nn_mode(struct icp_qat_fw_loader_handle *handle, 153 unsigned char ae, unsigned char mode); 154 void qat_hal_set_pc(struct icp_qat_fw_loader_handle *handle, 155 unsigned char ae, unsigned int ctx_mask, unsigned int upc); 156 void qat_hal_wr_uwords(struct icp_qat_fw_loader_handle *handle, 157 unsigned char ae, unsigned int uaddr, 158 unsigned int words_num, u64 *uword); 159 void qat_hal_wr_umem(struct icp_qat_fw_loader_handle *handle, unsigned char ae, 160 unsigned int uword_addr, unsigned int words_num, 161 unsigned int *data); 162 int qat_hal_get_ins_num(void); 163 int qat_hal_batch_wr_lm(struct icp_qat_fw_loader_handle *handle, 164 unsigned char ae, 165 struct icp_qat_uof_batch_init *lm_init_header); 166 int qat_hal_init_gpr(struct icp_qat_fw_loader_handle *handle, 167 unsigned char ae, unsigned long ctx_mask, 168 enum icp_qat_uof_regtype reg_type, 169 unsigned short reg_num, unsigned int regdata); 170 int qat_hal_init_wr_xfer(struct icp_qat_fw_loader_handle *handle, 171 unsigned char ae, unsigned long ctx_mask, 172 enum icp_qat_uof_regtype reg_type, 173 unsigned short reg_num, unsigned int regdata); 174 int qat_hal_init_rd_xfer(struct icp_qat_fw_loader_handle *handle, 175 unsigned char ae, unsigned long ctx_mask, 176 enum icp_qat_uof_regtype reg_type, 177 unsigned short reg_num, unsigned int regdata); 178 int qat_hal_init_nn(struct icp_qat_fw_loader_handle *handle, 179 unsigned char ae, unsigned long ctx_mask, 180 unsigned short reg_num, unsigned int regdata); 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, const 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 int adf_init_misc_wq(void); 192 void adf_exit_misc_wq(void); 193 bool adf_misc_wq_queue_work(struct work_struct *work); 194 bool adf_misc_wq_queue_delayed_work(struct delayed_work *work, 195 unsigned long delay); 196 #if defined(CONFIG_PCI_IOV) 197 int adf_sriov_configure(struct pci_dev *pdev, int numvfs); 198 void adf_disable_sriov(struct adf_accel_dev *accel_dev); 199 void adf_enable_vf2pf_interrupts(struct adf_accel_dev *accel_dev, u32 vf_mask); 200 void adf_disable_all_vf2pf_interrupts(struct adf_accel_dev *accel_dev); 201 bool adf_recv_and_handle_pf2vf_msg(struct adf_accel_dev *accel_dev); 202 bool adf_recv_and_handle_vf2pf_msg(struct adf_accel_dev *accel_dev, u32 vf_nr); 203 int adf_pf2vf_handle_pf_restarting(struct adf_accel_dev *accel_dev); 204 void adf_enable_pf2vf_interrupts(struct adf_accel_dev *accel_dev); 205 void adf_disable_pf2vf_interrupts(struct adf_accel_dev *accel_dev); 206 void adf_schedule_vf2pf_handler(struct adf_accel_vf_info *vf_info); 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 215 static inline void adf_disable_sriov(struct adf_accel_dev *accel_dev) 216 { 217 } 218 219 static inline int adf_init_pf_wq(void) 220 { 221 return 0; 222 } 223 224 static inline void adf_exit_pf_wq(void) 225 { 226 } 227 228 static inline int adf_init_vf_wq(void) 229 { 230 return 0; 231 } 232 233 static inline void adf_exit_vf_wq(void) 234 { 235 } 236 237 #endif 238 239 static inline void __iomem *adf_get_pmisc_base(struct adf_accel_dev *accel_dev) 240 { 241 struct adf_hw_device_data *hw_data = accel_dev->hw_device; 242 struct adf_bar *pmisc; 243 244 pmisc = &GET_BARS(accel_dev)[hw_data->get_misc_bar_id(hw_data)]; 245 246 return pmisc->virt_addr; 247 } 248 249 #endif 250