drivers/common/qat/qat_qp.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018 Intel Corporation
   3  */
   4 #ifndef _QAT_QP_H_
   5 #define _QAT_QP_H_
   6
   7 #include "qat_common.h"
   8 #include "adf_transport_access_macros.h"
   9
  10 struct qat_pci_device;
  11
  12 #define QAT_CSR_HEAD_WRITE_THRESH 32U
  13 /* number of requests to accumulate before writing head CSR */
  14
  15 #define QAT_QP_MIN_INFL_THRESHOLD       256
  16
  17 /* Default qp configuration for GEN4 devices */
  18 #define QAT_GEN4_QP_DEFCON      (QAT_SERVICE_SYMMETRIC |        \
  19                                 QAT_SERVICE_SYMMETRIC << 8 |    \
  20                                 QAT_SERVICE_SYMMETRIC << 16 |   \
  21                                 QAT_SERVICE_SYMMETRIC << 24)
  22
  23 /* QAT GEN 4 specific macros */
  24 #define QAT_GEN4_BUNDLE_NUM             4
  25 #define QAT_GEN4_QPS_PER_BUNDLE_NUM     1
  26
  27 /**
  28  * Structure with data needed for creation of queue pair.
  29  */
  30 struct qat_qp_hw_data {
  31         enum qat_service_type service_type;
  32         uint8_t hw_bundle_num;
  33         uint8_t tx_ring_num;
  34         uint8_t rx_ring_num;
  35         uint16_t tx_msg_size;
  36         uint16_t rx_msg_size;
  37 };
  38
  39 /**
  40  * Structure with data needed for creation of queue pair on gen4.
  41  */
  42 struct qat_qp_gen4_data {
  43         struct qat_qp_hw_data qat_qp_hw_data;
  44         uint8_t reserved;
  45         uint8_t valid;
  46 };
  47
  48 /**
  49  * Structure with data needed for creation of queue pair.
  50  */
  51 struct qat_qp_config {
  52         const struct qat_qp_hw_data *hw;
  53         uint32_t nb_descriptors;
  54         uint32_t cookie_size;
  55         int socket_id;
  56         const char *service_str;
  57 };
  58
  59 /**
  60  * Structure associated with each queue.
  61  */
  62 struct qat_queue {
  63         char            memz_name[RTE_MEMZONE_NAMESIZE];
  64         void            *base_addr;             /* Base address */
  65         rte_iova_t      base_phys_addr;         /* Queue physical address */
  66         uint32_t        head;                   /* Shadow copy of the head */
  67         uint32_t        tail;                   /* Shadow copy of the tail */
  68         uint32_t        modulo_mask;
  69         uint32_t        msg_size;
  70         uint32_t        queue_size;
  71         uint8_t         trailz;
  72         uint8_t         hw_bundle_number;
  73         uint8_t         hw_queue_number;
  74         /* HW queue aka ring offset on bundle */
  75         uint32_t        csr_head;               /* last written head value */
  76         uint32_t        csr_tail;               /* last written tail value */
  77         uint16_t        nb_processed_responses;
  78         /* number of responses processed since last CSR head write */
  79 };
  80
  81 struct qat_qp {
  82         void                    *mmap_bar_addr;
  83         struct qat_queue        tx_q;
  84         struct qat_queue        rx_q;
  85         struct qat_common_stats stats;
  86         struct rte_mempool *op_cookie_pool;
  87         void **op_cookies;
  88         uint32_t nb_descriptors;
  89         enum qat_device_gen qat_dev_gen;
  90         enum qat_service_type service_type;
  91         struct qat_pci_device *qat_dev;
  92         /**< qat device this qp is on */
  93         uint32_t enqueued;
  94         uint32_t dequeued __rte_aligned(4);
  95         uint16_t max_inflights;
  96         uint16_t min_enq_burst_threshold;
  97 } __rte_cache_aligned;
  98
  99 extern const struct qat_qp_hw_data qat_gen1_qps[][ADF_MAX_QPS_ON_ANY_SERVICE];
 100 extern const struct qat_qp_hw_data qat_gen3_qps[][ADF_MAX_QPS_ON_ANY_SERVICE];
 101
 102 uint16_t
 103 qat_enqueue_op_burst(void *qp, void **ops, uint16_t nb_ops);
 104
 105 uint16_t
 106 qat_enqueue_comp_op_burst(void *qp, void **ops, uint16_t nb_ops);
 107
 108 uint16_t
 109 qat_dequeue_op_burst(void *qp, void **ops, uint16_t nb_ops);
 110
 111 int
 112 qat_qp_release(enum qat_device_gen qat_dev_gen, struct qat_qp **qp_addr);
 113
 114 int
 115 qat_qp_setup(struct qat_pci_device *qat_dev,
 116                 struct qat_qp **qp_addr, uint16_t queue_pair_id,
 117                 struct qat_qp_config *qat_qp_conf);
 118
 119 int
 120 qat_qps_per_service(struct qat_pci_device *qat_dev,
 121                         enum qat_service_type service);
 122
 123 int
 124 qat_cq_get_fw_version(struct qat_qp *qp);
 125
 126 /* Needed for weak function*/
 127 int
 128 qat_comp_process_response(void **op __rte_unused, uint8_t *resp __rte_unused,
 129                           void *op_cookie __rte_unused,
 130                           uint64_t *dequeue_err_count __rte_unused);
 131
 132 int
 133 qat_select_valid_queue(struct qat_pci_device *qat_dev, int qp_id,
 134                         enum qat_service_type service_type);
 135
 136 int
 137 qat_read_qp_config(struct qat_pci_device *qat_dev);
 138
 139 #endif /* _QAT_QP_H_ */