common/cnxk: add NIX Rx queue management API
[dpdk.git] / drivers / common / cnxk / roc_nix.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(C) 2021 Marvell.
3  */
4
5 #ifndef _ROC_NIX_H_
6 #define _ROC_NIX_H_
7
8 /* Constants */
9 enum roc_nix_rss_reta_sz {
10         ROC_NIX_RSS_RETA_SZ_64 = 64,
11         ROC_NIX_RSS_RETA_SZ_128 = 128,
12         ROC_NIX_RSS_RETA_SZ_256 = 256,
13 };
14
15 enum roc_nix_sq_max_sqe_sz {
16         roc_nix_maxsqesz_w16 = NIX_MAXSQESZ_W16,
17         roc_nix_maxsqesz_w8 = NIX_MAXSQESZ_W8,
18 };
19
20 /* NIX LF RX offload configuration flags.
21  * These are input flags to roc_nix_lf_alloc:rx_cfg
22  */
23 #define ROC_NIX_LF_RX_CFG_DROP_RE     BIT_ULL(32)
24 #define ROC_NIX_LF_RX_CFG_L2_LEN_ERR  BIT_ULL(33)
25 #define ROC_NIX_LF_RX_CFG_IP6_UDP_OPT BIT_ULL(34)
26 #define ROC_NIX_LF_RX_CFG_DIS_APAD    BIT_ULL(35)
27 #define ROC_NIX_LF_RX_CFG_CSUM_IL4    BIT_ULL(36)
28 #define ROC_NIX_LF_RX_CFG_CSUM_OL4    BIT_ULL(37)
29 #define ROC_NIX_LF_RX_CFG_LEN_IL4     BIT_ULL(38)
30 #define ROC_NIX_LF_RX_CFG_LEN_IL3     BIT_ULL(39)
31 #define ROC_NIX_LF_RX_CFG_LEN_OL4     BIT_ULL(40)
32 #define ROC_NIX_LF_RX_CFG_LEN_OL3     BIT_ULL(41)
33
34 /* Group 0 will be used for RSS, 1 -7 will be used for npc_flow RSS action*/
35 #define ROC_NIX_RSS_GROUP_DEFAULT 0
36 #define ROC_NIX_RSS_GRPS          8
37 #define ROC_NIX_RSS_RETA_MAX      ROC_NIX_RSS_RETA_SZ_256
38 #define ROC_NIX_RSS_KEY_LEN       48 /* 352 Bits */
39
40 #define ROC_NIX_DEFAULT_HW_FRS 1514
41
42 #define ROC_NIX_VWQE_MAX_SIZE_LOG2 11
43 #define ROC_NIX_VWQE_MIN_SIZE_LOG2 2
44
45 struct roc_nix_rq {
46         /* Input parameters */
47         uint16_t qid;
48         uint64_t aura_handle;
49         bool ipsech_ena;
50         uint16_t first_skip;
51         uint16_t later_skip;
52         uint16_t wqe_skip;
53         uint16_t lpb_size;
54         uint32_t tag_mask;
55         uint32_t flow_tag_width;
56         uint8_t tt;     /* Valid when SSO is enabled */
57         uint16_t hwgrp; /* Valid when SSO is enabled */
58         bool sso_ena;
59         bool vwqe_ena;
60         uint64_t spb_aura_handle; /* Valid when SPB is enabled */
61         uint16_t spb_size;        /* Valid when SPB is enabled */
62         bool spb_ena;
63         uint8_t vwqe_first_skip;
64         uint32_t vwqe_max_sz_exp;
65         uint64_t vwqe_wait_tmo;
66         uint64_t vwqe_aura_handle;
67         /* End of Input parameters */
68         struct roc_nix *roc_nix;
69 };
70
71 struct roc_nix_cq {
72         /* Input parameters */
73         uint16_t qid;
74         uint16_t nb_desc;
75         /* End of Input parameters */
76         uint16_t drop_thresh;
77         struct roc_nix *roc_nix;
78         uintptr_t door;
79         int64_t *status;
80         uint64_t wdata;
81         void *desc_base;
82         uint32_t qmask;
83         uint32_t head;
84 };
85
86 struct roc_nix {
87         /* Input parameters */
88         struct plt_pci_device *pci_dev;
89         uint16_t port_id;
90         bool rss_tag_as_xor;
91         uint16_t max_sqb_count;
92         enum roc_nix_rss_reta_sz reta_sz;
93         bool enable_loop;
94         /* End of input parameters */
95         /* LMT line base for "Per Core Tx LMT line" mode*/
96         uintptr_t lmt_base;
97         bool io_enabled;
98         bool rx_ptp_ena;
99         uint16_t cints;
100
101 #define ROC_NIX_MEM_SZ (6 * 1024)
102         uint8_t reserved[ROC_NIX_MEM_SZ] __plt_cache_aligned;
103 } __plt_cache_aligned;
104
105 /* Dev */
106 int __roc_api roc_nix_dev_init(struct roc_nix *roc_nix);
107 int __roc_api roc_nix_dev_fini(struct roc_nix *roc_nix);
108
109 /* Type */
110 bool __roc_api roc_nix_is_lbk(struct roc_nix *roc_nix);
111 bool __roc_api roc_nix_is_sdp(struct roc_nix *roc_nix);
112 bool __roc_api roc_nix_is_pf(struct roc_nix *roc_nix);
113 bool __roc_api roc_nix_is_vf_or_sdp(struct roc_nix *roc_nix);
114 int __roc_api roc_nix_get_base_chan(struct roc_nix *roc_nix);
115 int __roc_api roc_nix_get_pf(struct roc_nix *roc_nix);
116 int __roc_api roc_nix_get_vf(struct roc_nix *roc_nix);
117 uint16_t __roc_api roc_nix_get_pf_func(struct roc_nix *roc_nix);
118 uint16_t __roc_api roc_nix_get_vwqe_interval(struct roc_nix *roc_nix);
119 int __roc_api roc_nix_max_pkt_len(struct roc_nix *roc_nix);
120
121 /* LF ops */
122 int __roc_api roc_nix_lf_alloc(struct roc_nix *roc_nix, uint32_t nb_rxq,
123                                uint32_t nb_txq, uint64_t rx_cfg);
124 int __roc_api roc_nix_lf_free(struct roc_nix *roc_nix);
125
126 /* IRQ */
127 void __roc_api roc_nix_rx_queue_intr_enable(struct roc_nix *roc_nix,
128                                             uint16_t rxq_id);
129 void __roc_api roc_nix_rx_queue_intr_disable(struct roc_nix *roc_nix,
130                                              uint16_t rxq_id);
131 void __roc_api roc_nix_err_intr_ena_dis(struct roc_nix *roc_nix, bool enb);
132 void __roc_api roc_nix_ras_intr_ena_dis(struct roc_nix *roc_nix, bool enb);
133 int __roc_api roc_nix_register_queue_irqs(struct roc_nix *roc_nix);
134 void __roc_api roc_nix_unregister_queue_irqs(struct roc_nix *roc_nix);
135 int __roc_api roc_nix_register_cq_irqs(struct roc_nix *roc_nix);
136 void __roc_api roc_nix_unregister_cq_irqs(struct roc_nix *roc_nix);
137
138 /* Queue */
139 int __roc_api roc_nix_rq_init(struct roc_nix *roc_nix, struct roc_nix_rq *rq,
140                               bool ena);
141 int __roc_api roc_nix_rq_modify(struct roc_nix *roc_nix, struct roc_nix_rq *rq,
142                                 bool ena);
143 int __roc_api roc_nix_rq_ena_dis(struct roc_nix_rq *rq, bool enable);
144 int __roc_api roc_nix_rq_fini(struct roc_nix_rq *rq);
145 int __roc_api roc_nix_cq_init(struct roc_nix *roc_nix, struct roc_nix_cq *cq);
146 int __roc_api roc_nix_cq_fini(struct roc_nix_cq *cq);
147
148 #endif /* _ROC_NIX_H_ */