xref: /dpdk/drivers/common/qat/qat_qp.h (revision 089e5ed727a15da2729cfee9b63533dd120bd04c)
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 #define QAT_CSR_TAIL_WRITE_THRESH 32U
15 /* number of requests to accumulate before writing tail CSR */
16 #define QAT_CSR_TAIL_FORCE_WRITE_THRESH 256U
17 /* number of inflights below which no tail write coalescing should occur */
18 
19 typedef int (*build_request_t)(void *op,
20 		uint8_t *req, void *op_cookie,
21 		enum qat_device_gen qat_dev_gen);
22 /**< Build a request from an op. */
23 
24 /**
25  * Structure with data needed for creation of queue pair.
26  */
27 struct qat_qp_hw_data {
28 	enum qat_service_type service_type;
29 	uint8_t hw_bundle_num;
30 	uint8_t tx_ring_num;
31 	uint8_t rx_ring_num;
32 	uint16_t tx_msg_size;
33 	uint16_t rx_msg_size;
34 };
35 /**
36  * Structure with data needed for creation of queue pair.
37  */
38 struct qat_qp_config {
39 	const struct qat_qp_hw_data *hw;
40 	uint32_t nb_descriptors;
41 	uint32_t cookie_size;
42 	int socket_id;
43 	build_request_t build_request;
44 	const char *service_str;
45 };
46 
47 /**
48  * Structure associated with each queue.
49  */
50 struct qat_queue {
51 	char		memz_name[RTE_MEMZONE_NAMESIZE];
52 	void		*base_addr;		/* Base address */
53 	rte_iova_t	base_phys_addr;		/* Queue physical address */
54 	uint32_t	head;			/* Shadow copy of the head */
55 	uint32_t	tail;			/* Shadow copy of the tail */
56 	uint32_t	modulo_mask;
57 	uint32_t	msg_size;
58 	uint16_t	max_inflights;
59 	uint32_t	queue_size;
60 	uint8_t		hw_bundle_number;
61 	uint8_t		hw_queue_number;
62 	/* HW queue aka ring offset on bundle */
63 	uint32_t	csr_head;		/* last written head value */
64 	uint32_t	csr_tail;		/* last written tail value */
65 	uint16_t	nb_processed_responses;
66 	/* number of responses processed since last CSR head write */
67 	uint16_t	nb_pending_requests;
68 	/* number of requests pending since last CSR tail write */
69 };
70 
71 struct qat_qp {
72 	void			*mmap_bar_addr;
73 	uint16_t		inflights16;
74 	struct qat_queue	tx_q;
75 	struct qat_queue	rx_q;
76 	struct qat_common_stats stats;
77 	struct rte_mempool *op_cookie_pool;
78 	void **op_cookies;
79 	uint32_t nb_descriptors;
80 	enum qat_device_gen qat_dev_gen;
81 	build_request_t build_request;
82 	enum qat_service_type service_type;
83 	struct qat_pci_device *qat_dev;
84 	/**< qat device this qp is on */
85 } __rte_cache_aligned;
86 
87 extern const struct qat_qp_hw_data qat_gen1_qps[][ADF_MAX_QPS_ON_ANY_SERVICE];
88 extern const struct qat_qp_hw_data qat_gen3_qps[][ADF_MAX_QPS_ON_ANY_SERVICE];
89 
90 uint16_t
91 qat_enqueue_op_burst(void *qp, void **ops, uint16_t nb_ops);
92 
93 uint16_t
94 qat_dequeue_op_burst(void *qp, void **ops, uint16_t nb_ops);
95 
96 int
97 qat_qp_release(struct qat_qp **qp_addr);
98 
99 int
100 qat_qp_setup(struct qat_pci_device *qat_dev,
101 		struct qat_qp **qp_addr, uint16_t queue_pair_id,
102 		struct qat_qp_config *qat_qp_conf);
103 
104 int
105 qat_qps_per_service(const struct qat_qp_hw_data *qp_hw_data,
106 			enum qat_service_type service);
107 
108 /* Needed for weak function*/
109 int
110 qat_comp_process_response(void **op __rte_unused, uint8_t *resp __rte_unused,
111 			  void *op_cookie __rte_unused,
112 			  uint64_t *dequeue_err_count __rte_unused);
113 
114 #endif /* _QAT_QP_H_ */
115