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_cycles.h>
  38 #include <rte_pci.h>
  39 #include <rte_bus_pci.h>
  40 #include <rte_timer.h>
  41
  42 #include "ena_com.h"
  43
  44 #define ENA_REGS_BAR    0
  45 #define ENA_MEM_BAR     2
  46
  47 #define ENA_MAX_NUM_QUEUES      128
  48 #define ENA_DEFAULT_RING_SIZE   (1024)
  49 #define ENA_MIN_FRAME_LEN       64
  50 #define ENA_NAME_MAX_LEN        20
  51 #define ENA_PKT_MAX_BUFS        17
  52
  53 #define ENA_MIN_MTU             128
  54
  55 #define ENA_MMIO_DISABLE_REG_READ       BIT(0)
  56
  57 #define ENA_WD_TIMEOUT_SEC      3
  58 #define ENA_DEVICE_KALIVE_TIMEOUT (ENA_WD_TIMEOUT_SEC * rte_get_timer_hz())
  59
  60 struct ena_adapter;
  61
  62 enum ena_ring_type {
  63         ENA_RING_TYPE_RX = 1,
  64         ENA_RING_TYPE_TX = 2,
  65 };
  66
  67 struct ena_tx_buffer {
  68         struct rte_mbuf *mbuf;
  69         unsigned int tx_descs;
  70         unsigned int num_of_bufs;
  71         struct ena_com_buf bufs[ENA_PKT_MAX_BUFS];
  72 };
  73
  74 struct ena_ring {
  75         u16 next_to_use;
  76         u16 next_to_clean;
  77
  78         enum ena_ring_type type;
  79         enum ena_admin_placement_policy_type tx_mem_queue_type;
  80         /* Holds the empty requests for TX/RX OOO completions */
  81         union {
  82                 uint16_t *empty_tx_reqs;
  83                 uint16_t *empty_rx_reqs;
  84         };
  85
  86         union {
  87                 struct ena_tx_buffer *tx_buffer_info; /* contex of tx packet */
  88                 struct rte_mbuf **rx_buffer_info; /* contex of rx packet */
  89         };
  90         unsigned int ring_size; /* number of tx/rx_buffer_info's entries */
  91
  92         struct ena_com_io_cq *ena_com_io_cq;
  93         struct ena_com_io_sq *ena_com_io_sq;
  94
  95         struct ena_com_rx_buf_info ena_bufs[ENA_PKT_MAX_BUFS]
  96                                                 __rte_cache_aligned;
  97
  98         struct rte_mempool *mb_pool;
  99         unsigned int port_id;
 100         unsigned int id;
 101         /* Max length PMD can push to device for LLQ */
 102         uint8_t tx_max_header_size;
 103         int configured;
 104         struct ena_adapter *adapter;
 105         uint64_t offloads;
 106         u16 sgl_size;
 107 } __rte_cache_aligned;
 108
 109 enum ena_adapter_state {
 110         ENA_ADAPTER_STATE_FREE    = 0,
 111         ENA_ADAPTER_STATE_INIT    = 1,
 112         ENA_ADAPTER_STATE_RUNNING = 2,
 113         ENA_ADAPTER_STATE_STOPPED = 3,
 114         ENA_ADAPTER_STATE_CONFIG  = 4,
 115         ENA_ADAPTER_STATE_CLOSED  = 5,
 116 };
 117
 118 struct ena_driver_stats {
 119         rte_atomic64_t ierrors;
 120         rte_atomic64_t oerrors;
 121         rte_atomic64_t rx_nombuf;
 122 };
 123
 124 struct ena_stats_dev {
 125         u64 tx_timeout;
 126         u64 io_suspend;
 127         u64 io_resume;
 128         u64 wd_expired;
 129         u64 interface_up;
 130         u64 interface_down;
 131         u64 admin_q_pause;
 132 };
 133
 134 struct ena_stats_tx {
 135         u64 cnt;
 136         u64 bytes;
 137         u64 queue_stop;
 138         u64 prepare_ctx_err;
 139         u64 queue_wakeup;
 140         u64 dma_mapping_err;
 141         u64 linearize;
 142         u64 linearize_failed;
 143         u64 tx_poll;
 144         u64 doorbells;
 145         u64 missing_tx_comp;
 146         u64 bad_req_id;
 147 };
 148
 149 struct ena_stats_rx {
 150         u64 cnt;
 151         u64 bytes;
 152         u64 refil_partial;
 153         u64 bad_csum;
 154         u64 page_alloc_fail;
 155         u64 skb_alloc_fail;
 156         u64 dma_mapping_err;
 157         u64 bad_desc_num;
 158         u64 small_copy_len_pkt;
 159 };
 160
 161 /* board specific private data structure */
 162 struct ena_adapter {
 163         /* OS defined structs */
 164         struct rte_pci_device *pdev;
 165         struct rte_eth_dev_data *rte_eth_dev_data;
 166         struct rte_eth_dev *rte_dev;
 167
 168         struct ena_com_dev ena_dev __rte_cache_aligned;
 169
 170         /* TX */
 171         struct ena_ring tx_ring[ENA_MAX_NUM_QUEUES] __rte_cache_aligned;
 172         int tx_ring_size;
 173         u16 max_tx_sgl_size;
 174
 175         /* RX */
 176         struct ena_ring rx_ring[ENA_MAX_NUM_QUEUES] __rte_cache_aligned;
 177         int rx_ring_size;
 178
 179         u16 num_queues;
 180         u16 max_mtu;
 181         u8 tso4_supported;
 182
 183         int id_number;
 184         char name[ENA_NAME_MAX_LEN];
 185         u8 mac_addr[ETHER_ADDR_LEN];
 186
 187         void *regs;
 188         void *dev_mem_base;
 189
 190         struct ena_driver_stats *drv_stats;
 191         enum ena_adapter_state state;
 192
 193         uint64_t tx_supported_offloads;
 194         uint64_t tx_selected_offloads;
 195         uint64_t rx_supported_offloads;
 196         uint64_t rx_selected_offloads;
 197
 198         bool link_status;
 199
 200         enum ena_regs_reset_reason_types reset_reason;
 201
 202         struct rte_timer timer_wd;
 203         uint64_t timestamp_wd;
 204         uint64_t keep_alive_timeout;
 205
 206         bool trigger_reset;
 207
 208         bool wd_state;
 209 };
 210
 211 #endif /* _ENA_ETHDEV_H_ */