common/octeontx: move mbox to common folder
[dpdk.git] / drivers / net / ena / ena_ethdev.h
1 /*-
2 * BSD LICENSE
3 *
4 * Copyright (c) 2015-2016 Amazon.com, Inc. or its affiliates.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
16 * distribution.
17 * * Neither the name of copyright holder nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #ifndef _ENA_ETHDEV_H_
35 #define _ENA_ETHDEV_H_
36
37 #include <rte_pci.h>
38 #include <rte_bus_pci.h>
39
40 #include "ena_com.h"
41
42 #define ENA_REGS_BAR    0
43 #define ENA_MEM_BAR     2
44
45 #define ENA_MAX_NUM_QUEUES      128
46 #define ENA_DEFAULT_RING_SIZE   (1024)
47 #define ENA_MIN_FRAME_LEN       64
48 #define ENA_NAME_MAX_LEN        20
49 #define ENA_PKT_MAX_BUFS        17
50
51 #define ENA_MMIO_DISABLE_REG_READ       BIT(0)
52
53 struct ena_adapter;
54
55 enum ena_ring_type {
56         ENA_RING_TYPE_RX = 1,
57         ENA_RING_TYPE_TX = 2,
58 };
59
60 struct ena_tx_buffer {
61         struct rte_mbuf *mbuf;
62         unsigned int tx_descs;
63         unsigned int num_of_bufs;
64         struct ena_com_buf bufs[ENA_PKT_MAX_BUFS];
65 };
66
67 struct ena_ring {
68         u16 next_to_use;
69         u16 next_to_clean;
70
71         enum ena_ring_type type;
72         enum ena_admin_placement_policy_type tx_mem_queue_type;
73         /* Holds the empty requests for TX OOO completions */
74         uint16_t *empty_tx_reqs;
75         union {
76                 struct ena_tx_buffer *tx_buffer_info; /* contex of tx packet */
77                 struct rte_mbuf **rx_buffer_info; /* contex of rx packet */
78         };
79         unsigned int ring_size; /* number of tx/rx_buffer_info's entries */
80
81         struct ena_com_io_cq *ena_com_io_cq;
82         struct ena_com_io_sq *ena_com_io_sq;
83
84         struct ena_com_rx_buf_info ena_bufs[ENA_PKT_MAX_BUFS]
85                                                 __rte_cache_aligned;
86
87         struct rte_mempool *mb_pool;
88         unsigned int port_id;
89         unsigned int id;
90         /* Max length PMD can push to device for LLQ */
91         uint8_t tx_max_header_size;
92         int configured;
93         struct ena_adapter *adapter;
94         uint64_t offloads;
95 } __rte_cache_aligned;
96
97 enum ena_adapter_state {
98         ENA_ADAPTER_STATE_FREE    = 0,
99         ENA_ADAPTER_STATE_INIT    = 1,
100         ENA_ADAPTER_STATE_RUNNING  = 2,
101         ENA_ADAPTER_STATE_STOPPED = 3,
102         ENA_ADAPTER_STATE_CONFIG  = 4,
103 };
104
105 struct ena_driver_stats {
106         rte_atomic64_t ierrors;
107         rte_atomic64_t oerrors;
108         rte_atomic64_t rx_nombuf;
109 };
110
111 struct ena_stats_dev {
112         u64 tx_timeout;
113         u64 io_suspend;
114         u64 io_resume;
115         u64 wd_expired;
116         u64 interface_up;
117         u64 interface_down;
118         u64 admin_q_pause;
119 };
120
121 struct ena_stats_tx {
122         u64 cnt;
123         u64 bytes;
124         u64 queue_stop;
125         u64 prepare_ctx_err;
126         u64 queue_wakeup;
127         u64 dma_mapping_err;
128         u64 linearize;
129         u64 linearize_failed;
130         u64 tx_poll;
131         u64 doorbells;
132         u64 missing_tx_comp;
133         u64 bad_req_id;
134 };
135
136 struct ena_stats_rx {
137         u64 cnt;
138         u64 bytes;
139         u64 refil_partial;
140         u64 bad_csum;
141         u64 page_alloc_fail;
142         u64 skb_alloc_fail;
143         u64 dma_mapping_err;
144         u64 bad_desc_num;
145         u64 small_copy_len_pkt;
146 };
147
148 /* board specific private data structure */
149 struct ena_adapter {
150         /* OS defined structs */
151         struct rte_pci_device *pdev;
152         struct rte_eth_dev_data *rte_eth_dev_data;
153         struct rte_eth_dev *rte_dev;
154
155         struct ena_com_dev ena_dev __rte_cache_aligned;
156
157         /* TX */
158         struct ena_ring tx_ring[ENA_MAX_NUM_QUEUES] __rte_cache_aligned;
159         int tx_ring_size;
160
161         /* RX */
162         struct ena_ring rx_ring[ENA_MAX_NUM_QUEUES] __rte_cache_aligned;
163         int rx_ring_size;
164
165         u16 num_queues;
166         u16 max_mtu;
167         u8 tso4_supported;
168
169         int id_number;
170         char name[ENA_NAME_MAX_LEN];
171         u8 mac_addr[ETHER_ADDR_LEN];
172
173         void *regs;
174         void *dev_mem_base;
175
176         struct ena_driver_stats *drv_stats;
177         enum ena_adapter_state state;
178
179         uint64_t tx_supported_offloads;
180         uint64_t tx_selected_offloads;
181         uint64_t rx_supported_offloads;
182         uint64_t rx_selected_offloads;
183 };
184
185 #endif /* _ENA_ETHDEV_H_ */