drivers/common/qat/qat_common.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018 Intel Corporation
   3  */
   4 #ifndef _QAT_COMMON_H_
   5 #define _QAT_COMMON_H_
   6
   7 #include <stdint.h>
   8
   9 #include <rte_mbuf.h>
  10
  11 /**< Intel(R) QAT device name for PCI registration */
  12 #define QAT_PCI_NAME    qat
  13 #define QAT_64_BTYE_ALIGN_MASK (~0x3f)
  14
  15 /* Intel(R) QuickAssist Technology device generation is enumerated
  16  * from one according to the generation of the device
  17  */
  18 enum qat_device_gen {
  19         QAT_GEN1 = 1,
  20         QAT_GEN2,
  21         QAT_GEN3,
  22         QAT_GEN4
  23 };
  24
  25 enum qat_service_type {
  26         QAT_SERVICE_ASYMMETRIC = 0,
  27         QAT_SERVICE_SYMMETRIC,
  28         QAT_SERVICE_COMPRESSION,
  29         QAT_SERVICE_INVALID
  30 };
  31
  32 enum qat_svc_list {
  33         QAT_SVC_UNUSED = 0,
  34         QAT_SVC_CRYPTO = 1,
  35         QAT_SVC_COMPRESSION = 2,
  36         QAT_SVC_SYM = 3,
  37         QAT_SVC_ASYM = 4,
  38 };
  39
  40 #define QAT_MAX_SERVICES                (QAT_SERVICE_INVALID)
  41
  42 /**< Common struct for scatter-gather list operations */
  43 struct qat_flat_buf {
  44         uint32_t len;
  45         uint32_t resrvd;
  46         uint64_t addr;
  47 } __rte_packed;
  48
  49 #define qat_sgl_hdr  struct { \
  50         uint64_t resrvd; \
  51         uint32_t num_bufs; \
  52         uint32_t num_mapped_bufs; \
  53 }
  54
  55 __extension__
  56 struct qat_sgl {
  57         qat_sgl_hdr;
  58         /* flexible array of flat buffers*/
  59         struct qat_flat_buf buffers[0];
  60 } __rte_packed __rte_cache_aligned;
  61
  62 /** Common, i.e. not service-specific, statistics */
  63 struct qat_common_stats {
  64         uint64_t enqueued_count;
  65         /**< Count of all operations enqueued */
  66         uint64_t dequeued_count;
  67         /**< Count of all operations dequeued */
  68
  69         uint64_t enqueue_err_count;
  70         /**< Total error count on operations enqueued */
  71         uint64_t dequeue_err_count;
  72         /**< Total error count on operations dequeued */
  73         uint64_t threshold_hit_count;
  74         /**< Total number of times min qp threshold condition was fulfilled */
  75
  76 };
  77
  78 struct qat_pci_device;
  79
  80 int
  81 qat_sgl_fill_array(struct rte_mbuf *buf, int64_t offset,
  82                 void *list_in, uint32_t data_len,
  83                 const uint16_t max_segs);
  84 void
  85 qat_stats_get(struct qat_pci_device *dev,
  86                 struct qat_common_stats *stats,
  87                 enum qat_service_type service);
  88 void
  89 qat_stats_reset(struct qat_pci_device *dev,
  90                 enum qat_service_type service);
  91
  92 #endif /* _QAT_COMMON_H_ */