sys/dev/ena/ena.h

   1 /*-
   2  * BSD LICENSE
   3  *
   4  * Copyright (c) 2015-2019 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  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * $FreeBSD$
  31  *
  32  */
  33
  34 #ifndef ENA_H
  35 #define ENA_H
  36
  37 #include <sys/types.h>
  38
  39 #include "ena-com/ena_com.h"
  40 #include "ena-com/ena_eth_com.h"
  41
  42 #define DRV_MODULE_VER_MAJOR    2
  43 #define DRV_MODULE_VER_MINOR    0
  44 #define DRV_MODULE_VER_SUBMINOR 0
  45
  46 #define DRV_MODULE_NAME         "ena"
  47
  48 #ifndef DRV_MODULE_VERSION
  49 #define DRV_MODULE_VERSION                              \
  50         __XSTRING(DRV_MODULE_VER_MAJOR) "."             \
  51         __XSTRING(DRV_MODULE_VER_MINOR) "."             \
  52         __XSTRING(DRV_MODULE_VER_SUBMINOR)
  53 #endif
  54 #define DEVICE_NAME     "Elastic Network Adapter (ENA)"
  55 #define DEVICE_DESC     "ENA adapter"
  56
  57 /* Calculate DMA mask - width for ena cannot exceed 48, so it is safe */
  58 #define ENA_DMA_BIT_MASK(x)             ((1ULL << (x)) - 1ULL)
  59
  60 /* 1 for AENQ + ADMIN */
  61 #define ENA_ADMIN_MSIX_VEC              1
  62 #define ENA_MAX_MSIX_VEC(io_queues)     (ENA_ADMIN_MSIX_VEC + (io_queues))
  63
  64 #define ENA_REG_BAR                     0
  65 #define ENA_MEM_BAR                     2
  66
  67 #define ENA_BUS_DMA_SEGS                32
  68
  69 #define ENA_DEFAULT_BUF_RING_SIZE       4096
  70
  71 #define ENA_DEFAULT_RING_SIZE           1024
  72
  73 /*
  74  * Refill Rx queue when number of required descriptors is above
  75  * QUEUE_SIZE / ENA_RX_REFILL_THRESH_DIVIDER or ENA_RX_REFILL_THRESH_PACKET
  76  */
  77 #define ENA_RX_REFILL_THRESH_DIVIDER    8
  78 #define ENA_RX_REFILL_THRESH_PACKET     256
  79
  80 #define ENA_IRQNAME_SIZE                40
  81
  82 #define ENA_PKT_MAX_BUFS                19
  83
  84 #define ENA_RX_RSS_TABLE_LOG_SIZE       7
  85 #define ENA_RX_RSS_TABLE_SIZE           (1 << ENA_RX_RSS_TABLE_LOG_SIZE)
  86
  87 #define ENA_HASH_KEY_SIZE               40
  88
  89 #define ENA_MAX_FRAME_LEN               10000
  90 #define ENA_MIN_FRAME_LEN               60
  91
  92 #define ENA_TX_RESUME_THRESH            (ENA_PKT_MAX_BUFS + 2)
  93
  94 #define DB_THRESHOLD    64
  95
  96 #define TX_COMMIT       32
  97  /*
  98  * TX budget for cleaning. It should be half of the RX budget to reduce amount
  99  *  of TCP retransmissions.
 100  */
 101 #define TX_BUDGET       128
 102 /* RX cleanup budget. -1 stands for infinity. */
 103 #define RX_BUDGET       256
 104 /*
 105  * How many times we can repeat cleanup in the io irq handling routine if the
 106  * RX or TX budget was depleted.
 107  */
 108 #define CLEAN_BUDGET    8
 109
 110 #define RX_IRQ_INTERVAL 20
 111 #define TX_IRQ_INTERVAL 50
 112
 113 #define ENA_MIN_MTU             128
 114
 115 #define ENA_TSO_MAXSIZE         65536
 116
 117 #define ENA_MMIO_DISABLE_REG_READ       BIT(0)
 118
 119 #define ENA_TX_RING_IDX_NEXT(idx, ring_size) (((idx) + 1) & ((ring_size) - 1))
 120
 121 #define ENA_RX_RING_IDX_NEXT(idx, ring_size) (((idx) + 1) & ((ring_size) - 1))
 122
 123 #define ENA_IO_TXQ_IDX(q)               (2 * (q))
 124 #define ENA_IO_RXQ_IDX(q)               (2 * (q) + 1)
 125
 126 #define ENA_MGMNT_IRQ_IDX               0
 127 #define ENA_IO_IRQ_FIRST_IDX            1
 128 #define ENA_IO_IRQ_IDX(q)               (ENA_IO_IRQ_FIRST_IDX + (q))
 129
 130 #define ENA_MAX_NO_INTERRUPT_ITERATIONS 3
 131
 132 /*
 133  * ENA device should send keep alive msg every 1 sec.
 134  * We wait for 6 sec just to be on the safe side.
 135  */
 136 #define DEFAULT_KEEP_ALIVE_TO           (SBT_1S * 6)
 137
 138 /* Time in jiffies before concluding the transmitter is hung. */
 139 #define DEFAULT_TX_CMP_TO               (SBT_1S * 5)
 140
 141 /* Number of queues to check for missing queues per timer tick */
 142 #define DEFAULT_TX_MONITORED_QUEUES     (4)
 143
 144 /* Max number of timeouted packets before device reset */
 145 #define DEFAULT_TX_CMP_THRESHOLD        (128)
 146
 147 /*
 148  * Supported PCI vendor and devices IDs
 149  */
 150 #define PCI_VENDOR_ID_AMAZON    0x1d0f
 151
 152 #define PCI_DEV_ID_ENA_PF       0x0ec2
 153 #define PCI_DEV_ID_ENA_LLQ_PF   0x1ec2
 154 #define PCI_DEV_ID_ENA_VF       0xec20
 155 #define PCI_DEV_ID_ENA_LLQ_VF   0xec21
 156
 157 /*
 158  * Flags indicating current ENA driver state
 159  */
 160 enum ena_flags_t {
 161         ENA_FLAG_DEVICE_RUNNING,
 162         ENA_FLAG_DEV_UP,
 163         ENA_FLAG_LINK_UP,
 164         ENA_FLAG_MSIX_ENABLED,
 165         ENA_FLAG_TRIGGER_RESET,
 166         ENA_FLAG_ONGOING_RESET,
 167         ENA_FLAG_DEV_UP_BEFORE_RESET,
 168         ENA_FLAG_RSS_ACTIVE,
 169         ENA_FLAGS_NUMBER = ENA_FLAG_RSS_ACTIVE
 170 };
 171
 172 BITSET_DEFINE(_ena_state, ENA_FLAGS_NUMBER);
 173 typedef struct _ena_state ena_state_t;
 174
 175 #define ENA_FLAG_ZERO(adapter)          \
 176         BIT_ZERO(ENA_FLAGS_NUMBER, &(adapter)->flags)
 177 #define ENA_FLAG_ISSET(bit, adapter)    \
 178         BIT_ISSET(ENA_FLAGS_NUMBER, (bit), &(adapter)->flags)
 179 #define ENA_FLAG_SET_ATOMIC(bit, adapter)       \
 180         BIT_SET_ATOMIC(ENA_FLAGS_NUMBER, (bit), &(adapter)->flags)
 181 #define ENA_FLAG_CLEAR_ATOMIC(bit, adapter)     \
 182         BIT_CLR_ATOMIC(ENA_FLAGS_NUMBER, (bit), &(adapter)->flags)
 183
 184 struct msix_entry {
 185         int entry;
 186         int vector;
 187 };
 188
 189 typedef struct _ena_vendor_info_t {
 190         uint16_t vendor_id;
 191         uint16_t device_id;
 192         unsigned int index;
 193 } ena_vendor_info_t;
 194
 195 struct ena_irq {
 196         /* Interrupt resources */
 197         struct resource *res;
 198         driver_filter_t *handler;
 199         void *data;
 200         void *cookie;
 201         unsigned int vector;
 202         bool requested;
 203         int cpu;
 204         char name[ENA_IRQNAME_SIZE];
 205 };
 206
 207 struct ena_que {
 208         struct ena_adapter *adapter;
 209         struct ena_ring *tx_ring;
 210         struct ena_ring *rx_ring;
 211
 212         struct task cleanup_task;
 213         struct taskqueue *cleanup_tq;
 214
 215         uint32_t id;
 216         int cpu;
 217 };
 218
 219 struct ena_calc_queue_size_ctx {
 220         struct ena_com_dev_get_features_ctx *get_feat_ctx;
 221         struct ena_com_dev *ena_dev;
 222         device_t pdev;
 223         uint16_t rx_queue_size;
 224         uint16_t tx_queue_size;
 225         uint16_t max_tx_sgl_size;
 226         uint16_t max_rx_sgl_size;
 227 };
 228
 229 struct ena_tx_buffer {
 230         struct mbuf *mbuf;
 231         /* # of ena desc for this specific mbuf
 232          * (includes data desc and metadata desc) */
 233         unsigned int tx_descs;
 234         /* # of buffers used by this mbuf */
 235         unsigned int num_of_bufs;
 236         bus_dmamap_t map_head;
 237         bus_dmamap_t map_seg;
 238
 239         /* Indicate if segments of the mbuf were mapped */
 240         bool seg_mapped;
 241         /* Indicate if bufs[0] maps the linear data of the mbuf */
 242         bool head_mapped;
 243
 244         /* Used to detect missing tx packets */
 245         struct bintime timestamp;
 246         bool print_once;
 247
 248         struct ena_com_buf bufs[ENA_PKT_MAX_BUFS];
 249 } __aligned(CACHE_LINE_SIZE);
 250
 251 struct ena_rx_buffer {
 252         struct mbuf *mbuf;
 253         bus_dmamap_t map;
 254         struct ena_com_buf ena_buf;
 255 #ifdef DEV_NETMAP
 256         uint32_t netmap_buf_idx;
 257 #endif /* DEV_NETMAP */
 258 } __aligned(CACHE_LINE_SIZE);
 259
 260 struct ena_stats_tx {
 261         counter_u64_t cnt;
 262         counter_u64_t bytes;
 263         counter_u64_t prepare_ctx_err;
 264         counter_u64_t dma_mapping_err;
 265         counter_u64_t doorbells;
 266         counter_u64_t missing_tx_comp;
 267         counter_u64_t bad_req_id;
 268         counter_u64_t collapse;
 269         counter_u64_t collapse_err;
 270         counter_u64_t queue_wakeup;
 271         counter_u64_t queue_stop;
 272         counter_u64_t llq_buffer_copy;
 273 };
 274
 275 struct ena_stats_rx {
 276         counter_u64_t cnt;
 277         counter_u64_t bytes;
 278         counter_u64_t refil_partial;
 279         counter_u64_t bad_csum;
 280         counter_u64_t mjum_alloc_fail;
 281         counter_u64_t mbuf_alloc_fail;
 282         counter_u64_t dma_mapping_err;
 283         counter_u64_t bad_desc_num;
 284         counter_u64_t bad_req_id;
 285         counter_u64_t empty_rx_ring;
 286 };
 287
 288 struct ena_ring {
 289         /* Holds the empty requests for TX/RX out of order completions */
 290         union {
 291                 uint16_t *free_tx_ids;
 292                 uint16_t *free_rx_ids;
 293         };
 294         struct ena_com_dev *ena_dev;
 295         struct ena_adapter *adapter;
 296         struct ena_com_io_cq *ena_com_io_cq;
 297         struct ena_com_io_sq *ena_com_io_sq;
 298
 299         uint16_t qid;
 300
 301         /* Determines if device will use LLQ or normal mode for TX */
 302         enum ena_admin_placement_policy_type tx_mem_queue_type;
 303         /* The maximum length the driver can push to the device (For LLQ) */
 304         uint8_t tx_max_header_size;
 305
 306         bool first_interrupt;
 307         uint16_t no_interrupt_event_cnt;
 308
 309         struct ena_com_rx_buf_info ena_bufs[ENA_PKT_MAX_BUFS];
 310
 311         /*
 312          * Fields used for Adaptive Interrupt Modulation - to be implemented in
 313          * the future releases
 314          */
 315         uint32_t  smoothed_interval;
 316         enum ena_intr_moder_level moder_tbl_idx;
 317
 318         struct ena_que *que;
 319         struct lro_ctrl lro;
 320
 321         uint16_t next_to_use;
 322         uint16_t next_to_clean;
 323
 324         union {
 325                 struct ena_tx_buffer *tx_buffer_info; /* contex of tx packet */
 326                 struct ena_rx_buffer *rx_buffer_info; /* contex of rx packet */
 327         };
 328         int ring_size; /* number of tx/rx_buffer_info's entries */
 329
 330         struct buf_ring *br; /* only for TX */
 331         uint32_t buf_ring_size;
 332
 333         struct mtx ring_mtx;
 334         char mtx_name[16];
 335
 336         struct {
 337                 struct task enqueue_task;
 338                 struct taskqueue *enqueue_tq;
 339         };
 340
 341         union {
 342                 struct ena_stats_tx tx_stats;
 343                 struct ena_stats_rx rx_stats;
 344         };
 345
 346         union {
 347                 int empty_rx_queue;
 348                 /* For Tx ring to indicate if it's running or not */
 349                 bool running;
 350         };
 351
 352         /* How many packets are sent in one Tx loop, used for doorbells */
 353         uint32_t acum_pkts;
 354
 355         /* Used for LLQ */
 356         uint8_t *push_buf_intermediate_buf;
 357
 358 #ifdef DEV_NETMAP
 359         bool initialized;
 360 #endif /* DEV_NETMAP */
 361 } __aligned(CACHE_LINE_SIZE);
 362
 363 struct ena_stats_dev {
 364         counter_u64_t wd_expired;
 365         counter_u64_t interface_up;
 366         counter_u64_t interface_down;
 367         counter_u64_t admin_q_pause;
 368 };
 369
 370 struct ena_hw_stats {
 371         counter_u64_t rx_packets;
 372         counter_u64_t tx_packets;
 373
 374         counter_u64_t rx_bytes;
 375         counter_u64_t tx_bytes;
 376
 377         counter_u64_t rx_drops;
 378 };
 379
 380 /* Board specific private data structure */
 381 struct ena_adapter {
 382         struct ena_com_dev *ena_dev;
 383
 384         /* OS defined structs */
 385         if_t ifp;
 386         device_t pdev;
 387         struct ifmedia  media;
 388
 389         /* OS resources */
 390         struct resource *memory;
 391         struct resource *registers;
 392
 393         struct mtx global_mtx;
 394         struct sx ioctl_sx;
 395
 396         /* MSI-X */
 397         struct msix_entry *msix_entries;
 398         int msix_vecs;
 399
 400         /* DMA tags used throughout the driver adapter for Tx and Rx */
 401         bus_dma_tag_t tx_buf_tag;
 402         bus_dma_tag_t rx_buf_tag;
 403         int dma_width;
 404
 405         uint32_t max_mtu;
 406
 407         uint16_t max_tx_sgl_size;
 408         uint16_t max_rx_sgl_size;
 409
 410         uint32_t tx_offload_cap;
 411
 412         /* Tx fast path data */
 413         int num_queues;
 414
 415         unsigned int tx_ring_size;
 416         unsigned int rx_ring_size;
 417
 418         uint16_t buf_ring_size;
 419
 420         /* RSS*/
 421         uint8_t rss_ind_tbl[ENA_RX_RSS_TABLE_SIZE];
 422
 423         uint8_t mac_addr[ETHER_ADDR_LEN];
 424         /* mdio and phy*/
 425
 426         ena_state_t flags;
 427
 428         /* Queue will represent one TX and one RX ring */
 429         struct ena_que que[ENA_MAX_NUM_IO_QUEUES]
 430             __aligned(CACHE_LINE_SIZE);
 431
 432         /* TX */
 433         struct ena_ring tx_ring[ENA_MAX_NUM_IO_QUEUES]
 434             __aligned(CACHE_LINE_SIZE);
 435
 436         /* RX */
 437         struct ena_ring rx_ring[ENA_MAX_NUM_IO_QUEUES]
 438             __aligned(CACHE_LINE_SIZE);
 439
 440         struct ena_irq irq_tbl[ENA_MAX_MSIX_VEC(ENA_MAX_NUM_IO_QUEUES)];
 441
 442         /* Timer service */
 443         struct callout timer_service;
 444         sbintime_t keep_alive_timestamp;
 445         uint32_t next_monitored_tx_qid;
 446         struct task reset_task;
 447         struct taskqueue *reset_tq;
 448         int wd_active;
 449         sbintime_t keep_alive_timeout;
 450         sbintime_t missing_tx_timeout;
 451         uint32_t missing_tx_max_queues;
 452         uint32_t missing_tx_threshold;
 453
 454         /* Statistics */
 455         struct ena_stats_dev dev_stats;
 456         struct ena_hw_stats hw_stats;
 457
 458         enum ena_regs_reset_reason_types reset_reason;
 459 };
 460
 461 #define ENA_RING_MTX_LOCK(_ring)                mtx_lock(&(_ring)->ring_mtx)
 462 #define ENA_RING_MTX_TRYLOCK(_ring)             mtx_trylock(&(_ring)->ring_mtx)
 463 #define ENA_RING_MTX_UNLOCK(_ring)              mtx_unlock(&(_ring)->ring_mtx)
 464
 465 static inline int ena_mbuf_count(struct mbuf *mbuf)
 466 {
 467         int count = 1;
 468
 469         while ((mbuf = mbuf->m_next) != NULL)
 470                 ++count;
 471
 472         return count;
 473 }
 474
 475 int     ena_up(struct ena_adapter *);
 476 void    ena_down(struct ena_adapter *);
 477 int     ena_restore_device(struct ena_adapter *);
 478 void    ena_destroy_device(struct ena_adapter *, bool);
 479 int     ena_refill_rx_bufs(struct ena_ring *, uint32_t);
 480 inline int validate_rx_req_id(struct ena_ring *, uint16_t);
 481
 482 inline int
 483 validate_rx_req_id(struct ena_ring *rx_ring, uint16_t req_id)
 484 {
 485         if (likely(req_id < rx_ring->ring_size))
 486                 return (0);
 487
 488         device_printf(rx_ring->adapter->pdev, "Invalid rx req_id: %hu\n",
 489             req_id);
 490         counter_u64_add(rx_ring->rx_stats.bad_req_id, 1);
 491
 492         /* Trigger device reset */
 493         if (likely(!ENA_FLAG_ISSET(ENA_FLAG_TRIGGER_RESET, rx_ring->adapter))) {
 494                 rx_ring->adapter->reset_reason = ENA_REGS_RESET_INV_RX_REQ_ID;
 495                 ENA_FLAG_SET_ATOMIC(ENA_FLAG_TRIGGER_RESET, rx_ring->adapter);
 496         }
 497
 498         return (EFAULT);
 499 }
 500
 501 #endif /* !(ENA_H) */