]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - drivers/crypto/qat/qat_common/adf_common_drv.h
crypto: qat - Add support for SRIOV
[mirror_ubuntu-focal-kernel.git] / drivers / crypto / qat / qat_common / adf_common_drv.h
CommitLineData
d8cba25d
TS
1/*
2 This file is provided under a dual BSD/GPLv2 license. When using or
3 redistributing this file, you may do so under either license.
4
5 GPL LICENSE SUMMARY
6 Copyright(c) 2014 Intel Corporation.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of version 2 of the GNU General Public License as
9 published by the Free Software Foundation.
10
11 This program is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
15
16 Contact Information:
17 qat-linux@intel.com
18
19 BSD LICENSE
20 Copyright(c) 2014 Intel Corporation.
21 Redistribution and use in source and binary forms, with or without
22 modification, are permitted provided that the following conditions
23 are met:
24
25 * Redistributions of source code must retain the above copyright
26 notice, this list of conditions and the following disclaimer.
27 * Redistributions in binary form must reproduce the above copyright
28 notice, this list of conditions and the following disclaimer in
29 the documentation and/or other materials provided with the
30 distribution.
31 * Neither the name of Intel Corporation nor the names of its
32 contributors may be used to endorse or promote products derived
33 from this software without specific prior written permission.
34
35 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
38 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
39 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
42 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
43 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
45 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46*/
47#ifndef ADF_DRV_H
48#define ADF_DRV_H
49
50#include <linux/list.h>
51#include <linux/pci.h>
52#include "adf_accel_devices.h"
53#include "icp_qat_fw_loader_handle.h"
54#include "icp_qat_hal.h"
55
551d7ed2 56#define ADF_MAJOR_VERSION 0
ed8ccaef
TS
57#define ADF_MINOR_VERSION 2
58#define ADF_BUILD_VERSION 0
551d7ed2
AB
59#define ADF_DRV_VERSION __stringify(ADF_MAJOR_VERSION) "." \
60 __stringify(ADF_MINOR_VERSION) "." \
61 __stringify(ADF_BUILD_VERSION)
62
d8cba25d
TS
63#define ADF_STATUS_RESTARTING 0
64#define ADF_STATUS_STARTING 1
65#define ADF_STATUS_CONFIGURED 2
66#define ADF_STATUS_STARTED 3
67#define ADF_STATUS_AE_INITIALISED 4
68#define ADF_STATUS_AE_UCODE_LOADED 5
69#define ADF_STATUS_AE_STARTED 6
70#define ADF_STATUS_ORPHAN_TH_RUNNING 7
71#define ADF_STATUS_IRQ_ALLOCATED 8
72
73enum adf_dev_reset_mode {
74 ADF_DEV_RESET_ASYNC = 0,
75 ADF_DEV_RESET_SYNC
76};
77
78enum adf_event {
79 ADF_EVENT_INIT = 0,
80 ADF_EVENT_START,
81 ADF_EVENT_STOP,
82 ADF_EVENT_SHUTDOWN,
83 ADF_EVENT_RESTARTING,
84 ADF_EVENT_RESTARTED,
85};
86
87struct service_hndl {
88 int (*event_hld)(struct adf_accel_dev *accel_dev,
89 enum adf_event event);
90 unsigned long init_status;
91 unsigned long start_status;
92 char *name;
93 struct list_head list;
d8cba25d
TS
94};
95
a9905320
TS
96static inline int get_current_node(void)
97{
ed8ccaef 98 return topology_physical_package_id(smp_processor_id());
a9905320
TS
99}
100
d8cba25d
TS
101int adf_service_register(struct service_hndl *service);
102int adf_service_unregister(struct service_hndl *service);
103
104int adf_dev_init(struct adf_accel_dev *accel_dev);
105int adf_dev_start(struct adf_accel_dev *accel_dev);
106int adf_dev_stop(struct adf_accel_dev *accel_dev);
22e4dda0 107void adf_dev_shutdown(struct adf_accel_dev *accel_dev);
d8cba25d 108
ed8ccaef
TS
109void adf_enable_pf2vf_interrupts(struct adf_accel_dev *accel_dev);
110void adf_disable_pf2vf_interrupts(struct adf_accel_dev *accel_dev);
111int adf_iov_putmsg(struct adf_accel_dev *accel_dev, u32 msg, u8 vf_nr);
112void adf_pf2vf_notify_restarting(struct adf_accel_dev *accel_dev);
113int adf_enable_vf2pf_comms(struct adf_accel_dev *accel_dev);
114void adf_devmgr_update_class_index(struct adf_hw_device_data *hw_data);
115void adf_clean_vf_map(bool);
116
d8cba25d
TS
117int adf_ctl_dev_register(void);
118void adf_ctl_dev_unregister(void);
119int adf_processes_dev_register(void);
120void adf_processes_dev_unregister(void);
121
ed8ccaef
TS
122int adf_devmgr_add_dev(struct adf_accel_dev *accel_dev,
123 struct adf_accel_dev *pf);
124void adf_devmgr_rm_dev(struct adf_accel_dev *accel_dev,
125 struct adf_accel_dev *pf);
d8cba25d
TS
126struct list_head *adf_devmgr_get_head(void);
127struct adf_accel_dev *adf_devmgr_get_dev_by_id(uint32_t id);
128struct adf_accel_dev *adf_devmgr_get_first(void);
129struct adf_accel_dev *adf_devmgr_pci_to_accel_dev(struct pci_dev *pci_dev);
130int adf_devmgr_verify_id(uint32_t id);
131void adf_devmgr_get_num_dev(uint32_t *num);
132int adf_devmgr_in_reset(struct adf_accel_dev *accel_dev);
133int adf_dev_started(struct adf_accel_dev *accel_dev);
134int adf_dev_restarting_notify(struct adf_accel_dev *accel_dev);
135int adf_dev_restarted_notify(struct adf_accel_dev *accel_dev);
136int adf_ae_init(struct adf_accel_dev *accel_dev);
137int adf_ae_shutdown(struct adf_accel_dev *accel_dev);
138int adf_ae_fw_load(struct adf_accel_dev *accel_dev);
b4e97050 139void adf_ae_fw_release(struct adf_accel_dev *accel_dev);
d8cba25d
TS
140int adf_ae_start(struct adf_accel_dev *accel_dev);
141int adf_ae_stop(struct adf_accel_dev *accel_dev);
142
143int adf_enable_aer(struct adf_accel_dev *accel_dev, struct pci_driver *adf);
144void adf_disable_aer(struct adf_accel_dev *accel_dev);
145int adf_init_aer(void);
146void adf_exit_aer(void);
a5733139
TS
147int adf_init_admin_comms(struct adf_accel_dev *accel_dev);
148void adf_exit_admin_comms(struct adf_accel_dev *accel_dev);
149int adf_send_admin_init(struct adf_accel_dev *accel_dev);
150int adf_init_arb(struct adf_accel_dev *accel_dev);
151void adf_exit_arb(struct adf_accel_dev *accel_dev);
152void adf_update_ring_arb(struct adf_etr_ring_data *ring);
d8cba25d
TS
153
154int adf_dev_get(struct adf_accel_dev *accel_dev);
155void adf_dev_put(struct adf_accel_dev *accel_dev);
156int adf_dev_in_use(struct adf_accel_dev *accel_dev);
157int adf_init_etr_data(struct adf_accel_dev *accel_dev);
158void adf_cleanup_etr_data(struct adf_accel_dev *accel_dev);
159int qat_crypto_register(void);
160int qat_crypto_unregister(void);
161struct qat_crypto_instance *qat_crypto_get_instance_node(int node);
162void qat_crypto_put_instance(struct qat_crypto_instance *inst);
163void qat_alg_callback(void *resp);
a9905320 164void qat_alg_asym_callback(void *resp);
d8cba25d
TS
165int qat_algs_init(void);
166void qat_algs_exit(void);
167int qat_algs_register(void);
168int qat_algs_unregister(void);
a9905320
TS
169int qat_asym_algs_register(void);
170void qat_asym_algs_unregister(void);
d8cba25d
TS
171
172int qat_hal_init(struct adf_accel_dev *accel_dev);
173void qat_hal_deinit(struct icp_qat_fw_loader_handle *handle);
174void qat_hal_start(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
175 unsigned int ctx_mask);
176void qat_hal_stop(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
177 unsigned int ctx_mask);
178void qat_hal_reset(struct icp_qat_fw_loader_handle *handle);
179int qat_hal_clr_reset(struct icp_qat_fw_loader_handle *handle);
180void qat_hal_set_live_ctx(struct icp_qat_fw_loader_handle *handle,
181 unsigned char ae, unsigned int ctx_mask);
182int qat_hal_set_ae_lm_mode(struct icp_qat_fw_loader_handle *handle,
183 unsigned char ae, enum icp_qat_uof_regtype lm_type,
184 unsigned char mode);
185int qat_hal_set_ae_ctx_mode(struct icp_qat_fw_loader_handle *handle,
186 unsigned char ae, unsigned char mode);
187int qat_hal_set_ae_nn_mode(struct icp_qat_fw_loader_handle *handle,
188 unsigned char ae, unsigned char mode);
189void qat_hal_set_pc(struct icp_qat_fw_loader_handle *handle,
190 unsigned char ae, unsigned int ctx_mask, unsigned int upc);
191void qat_hal_wr_uwords(struct icp_qat_fw_loader_handle *handle,
192 unsigned char ae, unsigned int uaddr,
193 unsigned int words_num, uint64_t *uword);
194void qat_hal_wr_umem(struct icp_qat_fw_loader_handle *handle, unsigned char ae,
195 unsigned int uword_addr, unsigned int words_num,
196 unsigned int *data);
197int qat_hal_get_ins_num(void);
198int qat_hal_batch_wr_lm(struct icp_qat_fw_loader_handle *handle,
199 unsigned char ae,
200 struct icp_qat_uof_batch_init *lm_init_header);
201int qat_hal_init_gpr(struct icp_qat_fw_loader_handle *handle,
202 unsigned char ae, unsigned char ctx_mask,
203 enum icp_qat_uof_regtype reg_type,
204 unsigned short reg_num, unsigned int regdata);
205int qat_hal_init_wr_xfer(struct icp_qat_fw_loader_handle *handle,
206 unsigned char ae, unsigned char ctx_mask,
207 enum icp_qat_uof_regtype reg_type,
208 unsigned short reg_num, unsigned int regdata);
209int qat_hal_init_rd_xfer(struct icp_qat_fw_loader_handle *handle,
210 unsigned char ae, unsigned char ctx_mask,
211 enum icp_qat_uof_regtype reg_type,
212 unsigned short reg_num, unsigned int regdata);
213int qat_hal_init_nn(struct icp_qat_fw_loader_handle *handle,
214 unsigned char ae, unsigned char ctx_mask,
215 unsigned short reg_num, unsigned int regdata);
216int qat_hal_wr_lm(struct icp_qat_fw_loader_handle *handle,
217 unsigned char ae, unsigned short lm_addr, unsigned int value);
218int qat_uclo_wr_all_uimage(struct icp_qat_fw_loader_handle *handle);
8f312d64 219void qat_uclo_del_uof_obj(struct icp_qat_fw_loader_handle *handle);
d8cba25d
TS
220int qat_uclo_map_uof_obj(struct icp_qat_fw_loader_handle *handle,
221 void *addr_ptr, int mem_size);
f3dd7e60
PY
222void qat_uclo_wr_mimage(struct icp_qat_fw_loader_handle *handle,
223 void *addr_ptr, int mem_size);
ed8ccaef
TS
224#if defined(CONFIG_PCI_IOV)
225int adf_sriov_configure(struct pci_dev *pdev, int numvfs);
226void adf_disable_sriov(struct adf_accel_dev *accel_dev);
227void adf_disable_vf2pf_interrupts(struct adf_accel_dev *accel_dev,
228 uint32_t vf_mask);
229void adf_enable_vf2pf_interrupts(struct adf_accel_dev *accel_dev,
230 uint32_t vf_mask);
231#else
232static inline int adf_sriov_configure(struct pci_dev *pdev, int numvfs)
233{
234 return 0;
235}
236
237static inline void adf_disable_sriov(struct adf_accel_dev *accel_dev)
238{
239}
240#endif
d8cba25d 241#endif