6bcca08563b3d23e44962b41f5729de87c0fd8ef
[dpdk.git] / drivers / net / ena / ena_ethdev.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright (c) 2015-2020 Amazon.com, Inc. or its affiliates.
3  * All rights reserved.
4  */
5
6 #ifndef _ENA_ETHDEV_H_
7 #define _ENA_ETHDEV_H_
8
9 #include <rte_cycles.h>
10 #include <rte_pci.h>
11 #include <rte_bus_pci.h>
12 #include <rte_timer.h>
13
14 #include "ena_com.h"
15
16 #define ENA_REGS_BAR    0
17 #define ENA_MEM_BAR     2
18
19 #define ENA_MAX_NUM_QUEUES      128
20 #define ENA_MIN_FRAME_LEN       64
21 #define ENA_NAME_MAX_LEN        20
22 #define ENA_PKT_MAX_BUFS        17
23 #define ENA_RX_BUF_MIN_SIZE     1400
24 #define ENA_DEFAULT_RING_SIZE   1024
25
26 #define ENA_MIN_MTU             128
27
28 #define ENA_MMIO_DISABLE_REG_READ       BIT(0)
29
30 #define ENA_WD_TIMEOUT_SEC      3
31 #define ENA_DEVICE_KALIVE_TIMEOUT (ENA_WD_TIMEOUT_SEC * rte_get_timer_hz())
32
33 struct ena_adapter;
34
35 enum ena_ring_type {
36         ENA_RING_TYPE_RX = 1,
37         ENA_RING_TYPE_TX = 2,
38 };
39
40 struct ena_tx_buffer {
41         struct rte_mbuf *mbuf;
42         unsigned int tx_descs;
43         unsigned int num_of_bufs;
44         struct ena_com_buf bufs[ENA_PKT_MAX_BUFS];
45 };
46
47 /* Rx buffer holds only pointer to the mbuf - may be expanded in the future */
48 struct ena_rx_buffer {
49         struct rte_mbuf *mbuf;
50         struct ena_com_buf ena_buf;
51 };
52
53 struct ena_calc_queue_size_ctx {
54         struct ena_com_dev_get_features_ctx *get_feat_ctx;
55         struct ena_com_dev *ena_dev;
56         u32 max_rx_queue_size;
57         u32 max_tx_queue_size;
58         u16 max_tx_sgl_size;
59         u16 max_rx_sgl_size;
60 };
61
62 struct ena_stats_tx {
63         u64 cnt;
64         u64 bytes;
65         u64 prepare_ctx_err;
66         u64 linearize;
67         u64 linearize_failed;
68         u64 tx_poll;
69         u64 doorbells;
70         u64 bad_req_id;
71         u64 available_desc;
72 };
73
74 struct ena_stats_rx {
75         u64 cnt;
76         u64 bytes;
77         u64 refill_partial;
78         u64 bad_csum;
79         u64 mbuf_alloc_fail;
80         u64 bad_desc_num;
81         u64 bad_req_id;
82 };
83
84 struct ena_ring {
85         u16 next_to_use;
86         u16 next_to_clean;
87
88         enum ena_ring_type type;
89         enum ena_admin_placement_policy_type tx_mem_queue_type;
90         /* Holds the empty requests for TX/RX OOO completions */
91         union {
92                 uint16_t *empty_tx_reqs;
93                 uint16_t *empty_rx_reqs;
94         };
95
96         union {
97                 struct ena_tx_buffer *tx_buffer_info; /* contex of tx packet */
98                 struct ena_rx_buffer *rx_buffer_info; /* contex of rx packet */
99         };
100         struct rte_mbuf **rx_refill_buffer;
101         unsigned int ring_size; /* number of tx/rx_buffer_info's entries */
102
103         struct ena_com_io_cq *ena_com_io_cq;
104         struct ena_com_io_sq *ena_com_io_sq;
105
106         struct ena_com_rx_buf_info ena_bufs[ENA_PKT_MAX_BUFS]
107                                                 __rte_cache_aligned;
108
109         struct rte_mempool *mb_pool;
110         unsigned int port_id;
111         unsigned int id;
112         /* Max length PMD can push to device for LLQ */
113         uint8_t tx_max_header_size;
114         int configured;
115
116         uint8_t *push_buf_intermediate_buf;
117
118         struct ena_adapter *adapter;
119         uint64_t offloads;
120         u16 sgl_size;
121
122         bool disable_meta_caching;
123
124         union {
125                 struct ena_stats_rx rx_stats;
126                 struct ena_stats_tx tx_stats;
127         };
128
129         unsigned int numa_socket_id;
130 } __rte_cache_aligned;
131
132 enum ena_adapter_state {
133         ENA_ADAPTER_STATE_FREE    = 0,
134         ENA_ADAPTER_STATE_INIT    = 1,
135         ENA_ADAPTER_STATE_RUNNING = 2,
136         ENA_ADAPTER_STATE_STOPPED = 3,
137         ENA_ADAPTER_STATE_CONFIG  = 4,
138         ENA_ADAPTER_STATE_CLOSED  = 5,
139 };
140
141 struct ena_driver_stats {
142         rte_atomic64_t ierrors;
143         rte_atomic64_t oerrors;
144         rte_atomic64_t rx_nombuf;
145         u64 rx_drops;
146 };
147
148 struct ena_stats_dev {
149         u64 wd_expired;
150         u64 dev_start;
151         u64 dev_stop;
152         /*
153          * Tx drops cannot be reported as the driver statistic, because DPDK
154          * rte_eth_stats structure isn't providing appropriate field for that.
155          * As a workaround it is being published as an extended statistic.
156          */
157         u64 tx_drops;
158 };
159
160 struct ena_offloads {
161         bool tso4_supported;
162         bool tx_csum_supported;
163         bool rx_csum_supported;
164 };
165
166 /* board specific private data structure */
167 struct ena_adapter {
168         /* OS defined structs */
169         struct rte_pci_device *pdev;
170         struct rte_eth_dev_data *rte_eth_dev_data;
171         struct rte_eth_dev *rte_dev;
172
173         struct ena_com_dev ena_dev __rte_cache_aligned;
174
175         /* TX */
176         struct ena_ring tx_ring[ENA_MAX_NUM_QUEUES] __rte_cache_aligned;
177         u32 max_tx_ring_size;
178         u16 max_tx_sgl_size;
179
180         /* RX */
181         struct ena_ring rx_ring[ENA_MAX_NUM_QUEUES] __rte_cache_aligned;
182         u32 max_rx_ring_size;
183         u16 max_rx_sgl_size;
184
185         u32 max_num_io_queues;
186         u16 max_mtu;
187         struct ena_offloads offloads;
188
189         int id_number;
190         char name[ENA_NAME_MAX_LEN];
191         u8 mac_addr[RTE_ETHER_ADDR_LEN];
192
193         void *regs;
194         void *dev_mem_base;
195
196         struct ena_driver_stats *drv_stats;
197         enum ena_adapter_state state;
198
199         uint64_t tx_supported_offloads;
200         uint64_t tx_selected_offloads;
201         uint64_t rx_supported_offloads;
202         uint64_t rx_selected_offloads;
203
204         bool link_status;
205
206         enum ena_regs_reset_reason_types reset_reason;
207
208         struct rte_timer timer_wd;
209         uint64_t timestamp_wd;
210         uint64_t keep_alive_timeout;
211
212         struct ena_stats_dev dev_stats;
213
214         bool trigger_reset;
215
216         bool wd_state;
217
218         bool use_large_llq_hdr;
219 };
220
221 #endif /* _ENA_ETHDEV_H_ */