drivers/common/qat/qat_device.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018 Intel Corporation
   3  */
   4 #ifndef _QAT_DEVICE_H_
   5 #define _QAT_DEVICE_H_
   6
   7 #include <rte_bus_pci.h>
   8
   9 #include "qat_common.h"
  10 #include "qat_logs.h"
  11 #include "adf_transport_access_macros.h"
  12 #include "qat_qp.h"
  13
  14 #define QAT_DETACHED  (0)
  15 #define QAT_ATTACHED  (1)
  16
  17 #define QAT_DEV_NAME_MAX_LEN    64
  18
  19 enum qat_comp_num_im_buffers {
  20         QAT_NUM_INTERM_BUFS_GEN1 = 12,
  21         QAT_NUM_INTERM_BUFS_GEN2 = 20,
  22         QAT_NUM_INTERM_BUFS_GEN3 = 20
  23 };
  24
  25 /*
  26  * This struct holds all the data about a QAT pci device
  27  * including data about all services it supports.
  28  * It contains
  29  *  - hw_data
  30  *  - config data
  31  *  - runtime data
  32  */
  33 struct qat_sym_dev_private;
  34 struct qat_comp_dev_private;
  35
  36 struct qat_pci_device {
  37
  38         /* Data used by all services */
  39         char name[QAT_DEV_NAME_MAX_LEN];
  40         /**< Name of qat pci device */
  41         uint8_t qat_dev_id;
  42         /**< Device instance for this qat pci device */
  43         struct rte_pci_device *pci_dev;
  44         /**< PCI information. */
  45         enum qat_device_gen qat_dev_gen;
  46         /**< QAT device generation */
  47         rte_spinlock_t arb_csr_lock;
  48         /**< lock to protect accesses to the arbiter CSR */
  49         __extension__
  50         uint8_t attached : 1;
  51         /**< Flag indicating the device is attached */
  52
  53         struct qat_qp *qps_in_use[QAT_MAX_SERVICES][ADF_MAX_QPS_ON_ANY_SERVICE];
  54         /**< links to qps set up for each service, index same as on API */
  55
  56         /* Data relating to symmetric crypto service */
  57         struct qat_sym_dev_private *sym_dev;
  58         /**< link back to cryptodev private data */
  59         struct rte_device sym_rte_dev;
  60         /**< This represents the crypto subset of this pci device.
  61          * Register with this rather than with the one in
  62          * pci_dev so that its driver can have a crypto-specific name
  63          */
  64
  65         /* Data relating to compression service */
  66         struct qat_comp_dev_private *comp_dev;
  67         /**< link back to compressdev private data */
  68         struct rte_device comp_rte_dev;
  69         /**< This represents the compression subset of this pci device.
  70          * Register with this rather than with the one in
  71          * pci_dev so that its driver can have a compression-specific name
  72          */
  73
  74         /* Data relating to asymmetric crypto service */
  75
  76 };
  77
  78 struct qat_gen_hw_data {
  79         enum qat_device_gen dev_gen;
  80         const struct qat_qp_hw_data (*qp_hw_data)[ADF_MAX_QPS_ON_ANY_SERVICE];
  81         enum qat_comp_num_im_buffers comp_num_im_bufs_required;
  82 };
  83
  84 extern struct qat_gen_hw_data qat_gen_config[];
  85
  86 struct qat_pci_device *
  87 qat_pci_device_allocate(struct rte_pci_device *pci_dev);
  88
  89 int
  90 qat_pci_device_release(struct rte_pci_device *pci_dev);
  91
  92 struct qat_pci_device *
  93 qat_get_qat_dev_from_pci_dev(struct rte_pci_device *pci_dev);
  94
  95 /* declaration needed for weak functions */
  96 int
  97 qat_sym_dev_create(struct qat_pci_device *qat_pci_dev __rte_unused);
  98
  99 int
 100 qat_asym_dev_create(struct qat_pci_device *qat_pci_dev __rte_unused);
 101
 102 int
 103 qat_sym_dev_destroy(struct qat_pci_device *qat_pci_dev __rte_unused);
 104
 105 int
 106 qat_asym_dev_destroy(struct qat_pci_device *qat_pci_dev __rte_unused);
 107
 108 int
 109 qat_comp_dev_create(struct qat_pci_device *qat_pci_dev __rte_unused);
 110
 111 int
 112 qat_comp_dev_destroy(struct qat_pci_device *qat_pci_dev __rte_unused);
 113
 114 #endif /* _QAT_DEVICE_H_ */