net/iavf: replace license text with SPDX tag
[dpdk.git] / drivers / compress / qat / qat_comp.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2015-2019 Intel Corporation
3  */
4
5 #ifndef _QAT_COMP_H_
6 #define _QAT_COMP_H_
7
8 #ifdef RTE_LIBRTE_COMPRESSDEV
9
10 #include <rte_compressdev.h>
11 #include <rte_compressdev_pmd.h>
12
13 #include "qat_common.h"
14 #include "icp_qat_hw.h"
15 #include "icp_qat_fw_comp.h"
16 #include "icp_qat_fw_la.h"
17
18 #define QAT_64_BYTE_ALIGN_MASK (~0x3f)
19 #define QAT_64_BYTE_ALIGN (64)
20 #define QAT_NUM_BUFS_IN_IM_SGL 1
21
22 #define ERR_CODE_QAT_COMP_WRONG_FW -99
23
24 /* fallback to fixed compression threshold */
25 #define QAT_FALLBACK_THLD ((uint32_t)(RTE_PMD_QAT_COMP_IM_BUFFER_SIZE / 1.1))
26
27 #define QAT_MIN_OUT_BUF_SIZE 46
28
29 enum qat_comp_request_type {
30         QAT_COMP_REQUEST_FIXED_COMP_STATELESS,
31         QAT_COMP_REQUEST_DYNAMIC_COMP_STATELESS,
32         QAT_COMP_REQUEST_DECOMPRESS,
33         REQ_COMP_END
34 };
35
36 struct array_of_ptrs {
37         phys_addr_t pointer[0];
38 };
39
40 struct qat_inter_sgl {
41         qat_sgl_hdr;
42         struct qat_flat_buf buffers[QAT_NUM_BUFS_IN_IM_SGL];
43 } __rte_packed __rte_cache_aligned;
44
45
46 struct qat_comp_op_cookie {
47         phys_addr_t qat_sgl_src_phys_addr;
48         phys_addr_t qat_sgl_dst_phys_addr;
49         /* dynamically created SGLs */
50         uint8_t error;
51         uint8_t socket_id;
52         uint16_t src_nb_elems;
53         uint16_t dst_nb_elems;
54         struct qat_sgl *qat_sgl_src_d;
55         struct qat_sgl *qat_sgl_dst_d;
56 };
57
58 struct qat_comp_xform {
59         struct icp_qat_fw_comp_req qat_comp_req_tmpl;
60         enum qat_comp_request_type qat_comp_request_type;
61         enum rte_comp_checksum_type checksum_type;
62 };
63
64 int
65 qat_comp_build_request(void *in_op, uint8_t *out_msg, void *op_cookie,
66                        enum qat_device_gen qat_dev_gen __rte_unused);
67
68 int
69 qat_comp_process_response(void **op, uint8_t *resp, void *op_cookie,
70                           uint64_t *dequeue_err_count);
71
72 int
73 qat_comp_private_xform_create(struct rte_compressdev *dev,
74                               const struct rte_comp_xform *xform,
75                               void **private_xform);
76
77 int
78 qat_comp_private_xform_free(struct rte_compressdev *dev, void *private_xform);
79
80 unsigned int
81 qat_comp_xform_size(void);
82
83 #endif
84 #endif