drivers/net/ena/base/ena_com.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_COM
  35 #define ENA_COM
  36
  37 #include "ena_plat.h"
  38 #include "ena_common_defs.h"
  39 #include "ena_admin_defs.h"
  40 #include "ena_eth_io_defs.h"
  41 #include "ena_regs_defs.h"
  42 #if defined(__linux__) && !defined(__KERNEL__)
  43 #include <rte_lcore.h>
  44 #include <rte_spinlock.h>
  45 #define __iomem
  46 #endif
  47
  48 #define ENA_MAX_NUM_IO_QUEUES           128U
  49 /* We need to queues for each IO (on for Tx and one for Rx) */
  50 #define ENA_TOTAL_NUM_QUEUES            (2 * (ENA_MAX_NUM_IO_QUEUES))
  51
  52 #define ENA_MAX_HANDLERS 256
  53
  54 #define ENA_MAX_PHYS_ADDR_SIZE_BITS 48
  55
  56 /* Unit in usec */
  57 #define ENA_REG_READ_TIMEOUT 200000
  58
  59 #define ADMIN_SQ_SIZE(depth)    ((depth) * sizeof(struct ena_admin_aq_entry))
  60 #define ADMIN_CQ_SIZE(depth)    ((depth) * sizeof(struct ena_admin_acq_entry))
  61 #define ADMIN_AENQ_SIZE(depth)  ((depth) * sizeof(struct ena_admin_aenq_entry))
  62
  63 /*****************************************************************************/
  64 /*****************************************************************************/
  65 /* ENA adaptive interrupt moderation settings */
  66
  67 #define ENA_INTR_LOWEST_USECS           (0)
  68 #define ENA_INTR_LOWEST_PKTS            (3)
  69 #define ENA_INTR_LOWEST_BYTES           (2 * 1524)
  70
  71 #define ENA_INTR_LOW_USECS              (32)
  72 #define ENA_INTR_LOW_PKTS               (12)
  73 #define ENA_INTR_LOW_BYTES              (16 * 1024)
  74
  75 #define ENA_INTR_MID_USECS              (80)
  76 #define ENA_INTR_MID_PKTS               (48)
  77 #define ENA_INTR_MID_BYTES              (64 * 1024)
  78
  79 #define ENA_INTR_HIGH_USECS             (128)
  80 #define ENA_INTR_HIGH_PKTS              (96)
  81 #define ENA_INTR_HIGH_BYTES             (128 * 1024)
  82
  83 #define ENA_INTR_HIGHEST_USECS          (192)
  84 #define ENA_INTR_HIGHEST_PKTS           (128)
  85 #define ENA_INTR_HIGHEST_BYTES          (192 * 1024)
  86
  87 #define ENA_INTR_INITIAL_TX_INTERVAL_USECS              196
  88 #define ENA_INTR_INITIAL_RX_INTERVAL_USECS              4
  89 #define ENA_INTR_DELAY_OLD_VALUE_WEIGHT                 6
  90 #define ENA_INTR_DELAY_NEW_VALUE_WEIGHT                 4
  91
  92 enum ena_intr_moder_level {
  93         ENA_INTR_MODER_LOWEST = 0,
  94         ENA_INTR_MODER_LOW,
  95         ENA_INTR_MODER_MID,
  96         ENA_INTR_MODER_HIGH,
  97         ENA_INTR_MODER_HIGHEST,
  98         ENA_INTR_MAX_NUM_OF_LEVELS,
  99 };
 100
 101 struct ena_intr_moder_entry {
 102         unsigned int intr_moder_interval;
 103         unsigned int pkts_per_interval;
 104         unsigned int bytes_per_interval;
 105 };
 106
 107 enum queue_direction {
 108         ENA_COM_IO_QUEUE_DIRECTION_TX,
 109         ENA_COM_IO_QUEUE_DIRECTION_RX
 110 };
 111
 112 struct ena_com_buf {
 113         dma_addr_t paddr; /**< Buffer physical address */
 114         u16 len; /**< Buffer length in bytes */
 115 };
 116
 117 struct ena_com_rx_buf_info {
 118         u16 len;
 119         u16 req_id;
 120 };
 121
 122 struct ena_com_io_desc_addr {
 123         u8  __iomem *pbuf_dev_addr; /* LLQ address */
 124         u8  *virt_addr;
 125         dma_addr_t phys_addr;
 126         ena_mem_handle_t mem_handle;
 127 };
 128
 129 struct ena_com_tx_meta {
 130         u16 mss;
 131         u16 l3_hdr_len;
 132         u16 l3_hdr_offset;
 133         u16 l3_outer_hdr_len; /* In words */
 134         u16 l3_outer_hdr_offset;
 135         u16 l4_hdr_len; /* In words */
 136 };
 137
 138 struct ena_com_io_cq {
 139         struct ena_com_io_desc_addr cdesc_addr;
 140
 141         /* Interrupt unmask register */
 142         u32 __iomem *unmask_reg;
 143
 144         /* The completion queue head doorbell register */
 145         u32 __iomem *cq_head_db_reg;
 146
 147         /* numa configuration register (for TPH) */
 148         u32 __iomem *numa_node_cfg_reg;
 149
 150         /* The value to write to the above register to unmask
 151          * the interrupt of this queue
 152          */
 153         u32 msix_vector;
 154
 155         enum queue_direction direction;
 156
 157         /* holds the number of cdesc of the current packet */
 158         u16 cur_rx_pkt_cdesc_count;
 159         /* save the firt cdesc idx of the current packet */
 160         u16 cur_rx_pkt_cdesc_start_idx;
 161
 162         u16 q_depth;
 163         /* Caller qid */
 164         u16 qid;
 165
 166         /* Device queue index */
 167         u16 idx;
 168         u16 head;
 169         u16 last_head_update;
 170         u8 phase;
 171         u8 cdesc_entry_size_in_bytes;
 172
 173 } ____cacheline_aligned;
 174
 175 struct ena_com_io_sq {
 176         struct ena_com_io_desc_addr desc_addr;
 177
 178         u32 __iomem *db_addr;
 179         u8 __iomem *header_addr;
 180
 181         enum queue_direction direction;
 182         enum ena_admin_placement_policy_type mem_queue_type;
 183
 184         u32 msix_vector;
 185         struct ena_com_tx_meta cached_tx_meta;
 186
 187         u16 q_depth;
 188         u16 qid;
 189
 190         u16 idx;
 191         u16 tail;
 192         u16 next_to_comp;
 193         u32 tx_max_header_size;
 194         u8 phase;
 195         u8 desc_entry_size;
 196         u8 dma_addr_bits;
 197 } ____cacheline_aligned;
 198
 199 struct ena_com_admin_cq {
 200         struct ena_admin_acq_entry *entries;
 201         ena_mem_handle_t mem_handle;
 202         dma_addr_t dma_addr;
 203
 204         u16 head;
 205         u8 phase;
 206 };
 207
 208 struct ena_com_admin_sq {
 209         struct ena_admin_aq_entry *entries;
 210         ena_mem_handle_t mem_handle;
 211         dma_addr_t dma_addr;
 212
 213         u32 __iomem *db_addr;
 214
 215         u16 head;
 216         u16 tail;
 217         u8 phase;
 218
 219 };
 220
 221 struct ena_com_stats_admin {
 222         u32 aborted_cmd;
 223         u32 submitted_cmd;
 224         u32 completed_cmd;
 225         u32 out_of_space;
 226         u32 no_completion;
 227 };
 228
 229 struct ena_com_admin_queue {
 230         void *q_dmadev;
 231         ena_spinlock_t q_lock; /* spinlock for the admin queue */
 232         struct ena_comp_ctx *comp_ctx;
 233         u16 q_depth;
 234         struct ena_com_admin_cq cq;
 235         struct ena_com_admin_sq sq;
 236
 237         /* Indicate if the admin queue should poll for completion */
 238         bool polling;
 239
 240         u16 curr_cmd_id;
 241
 242         /* Indicate that the ena was initialized and can
 243          * process new admin commands
 244          */
 245         bool running_state;
 246
 247         /* Count the number of outstanding admin commands */
 248         ena_atomic32_t outstanding_cmds;
 249
 250         struct ena_com_stats_admin stats;
 251 };
 252
 253 struct ena_aenq_handlers;
 254
 255 struct ena_com_aenq {
 256         u16 head;
 257         u8 phase;
 258         struct ena_admin_aenq_entry *entries;
 259         dma_addr_t dma_addr;
 260         ena_mem_handle_t mem_handle;
 261         u16 q_depth;
 262         struct ena_aenq_handlers *aenq_handlers;
 263 };
 264
 265 struct ena_com_mmio_read {
 266         struct ena_admin_ena_mmio_req_read_less_resp *read_resp;
 267         dma_addr_t read_resp_dma_addr;
 268         ena_mem_handle_t read_resp_mem_handle;
 269         u16 seq_num;
 270         bool readless_supported;
 271         /* spin lock to ensure a single outstanding read */
 272         ena_spinlock_t lock;
 273 };
 274
 275 struct ena_rss {
 276         /* Indirect table */
 277         u16 *host_rss_ind_tbl;
 278         struct ena_admin_rss_ind_table_entry *rss_ind_tbl;
 279         dma_addr_t rss_ind_tbl_dma_addr;
 280         ena_mem_handle_t rss_ind_tbl_mem_handle;
 281         u16 tbl_log_size;
 282
 283         /* Hash key */
 284         enum ena_admin_hash_functions hash_func;
 285         struct ena_admin_feature_rss_flow_hash_control *hash_key;
 286         dma_addr_t hash_key_dma_addr;
 287         ena_mem_handle_t hash_key_mem_handle;
 288         u32 hash_init_val;
 289
 290         /* Flow Control */
 291         struct ena_admin_feature_rss_hash_control *hash_ctrl;
 292         dma_addr_t hash_ctrl_dma_addr;
 293         ena_mem_handle_t hash_ctrl_mem_handle;
 294
 295 };
 296
 297 struct ena_host_attribute {
 298         /* Debug area */
 299         u8 *debug_area_virt_addr;
 300         dma_addr_t debug_area_dma_addr;
 301         ena_mem_handle_t debug_area_dma_handle;
 302         u32 debug_area_size;
 303
 304         /* Host information */
 305         struct ena_admin_host_info *host_info;
 306         dma_addr_t host_info_dma_addr;
 307         ena_mem_handle_t host_info_dma_handle;
 308 };
 309
 310 /* Each ena_dev is a PCI function. */
 311 struct ena_com_dev {
 312         struct ena_com_admin_queue admin_queue;
 313         struct ena_com_aenq aenq;
 314         struct ena_com_io_cq io_cq_queues[ENA_TOTAL_NUM_QUEUES];
 315         struct ena_com_io_sq io_sq_queues[ENA_TOTAL_NUM_QUEUES];
 316         u8 __iomem *reg_bar;
 317         void __iomem *mem_bar;
 318         void *dmadev;
 319
 320         enum ena_admin_placement_policy_type tx_mem_queue_type;
 321         u32 tx_max_header_size;
 322         u16 stats_func; /* Selected function for extended statistic dump */
 323         u16 stats_queue; /* Selected queue for extended statistic dump */
 324
 325         struct ena_com_mmio_read mmio_read;
 326
 327         struct ena_rss rss;
 328         u32 supported_features;
 329         u32 dma_addr_bits;
 330
 331         struct ena_host_attribute host_attr;
 332         bool adaptive_coalescing;
 333         u16 intr_delay_resolution;
 334         u32 intr_moder_tx_interval;
 335         struct ena_intr_moder_entry *intr_moder_tbl;
 336 };
 337
 338 struct ena_com_dev_get_features_ctx {
 339         struct ena_admin_queue_feature_desc max_queues;
 340         struct ena_admin_device_attr_feature_desc dev_attr;
 341         struct ena_admin_feature_aenq_desc aenq;
 342         struct ena_admin_feature_offload_desc offload;
 343 };
 344
 345 struct ena_com_create_io_ctx {
 346         enum ena_admin_placement_policy_type mem_queue_type;
 347         enum queue_direction direction;
 348         int numa_node;
 349         u32 msix_vector;
 350         u16 queue_size;
 351         u16 qid;
 352 };
 353
 354 typedef void (*ena_aenq_handler)(void *data,
 355         struct ena_admin_aenq_entry *aenq_e);
 356
 357 /* Holds aenq handlers. Indexed by AENQ event group */
 358 struct ena_aenq_handlers {
 359         ena_aenq_handler handlers[ENA_MAX_HANDLERS];
 360         ena_aenq_handler unimplemented_handler;
 361 };
 362
 363 /*****************************************************************************/
 364 /*****************************************************************************/
 365 #if defined(__cplusplus)
 366 extern "C" {
 367 #endif
 368
 369 /* ena_com_mmio_reg_read_request_init - Init the mmio reg read mechanism
 370  * @ena_dev: ENA communication layer struct
 371  *
 372  * Initialize the register read mechanism.
 373  *
 374  * @note: This method must be the first stage in the initialization sequence.
 375  *
 376  * @return - 0 on success, negative value on failure.
 377  */
 378 int ena_com_mmio_reg_read_request_init(struct ena_com_dev *ena_dev);
 379
 380 /* ena_com_set_mmio_read_mode - Enable/disable the mmio reg read mechanism
 381  * @ena_dev: ENA communication layer struct
 382  * @realess_supported: readless mode (enable/disable)
 383  */
 384 void ena_com_set_mmio_read_mode(struct ena_com_dev *ena_dev,
 385                                 bool readless_supported);
 386
 387 /* ena_com_mmio_reg_read_request_write_dev_addr - Write the mmio reg read return
 388  * value physical address.
 389  * @ena_dev: ENA communication layer struct
 390  */
 391 void ena_com_mmio_reg_read_request_write_dev_addr(struct ena_com_dev *ena_dev);
 392
 393 /* ena_com_mmio_reg_read_request_destroy - Destroy the mmio reg read mechanism
 394  * @ena_dev: ENA communication layer struct
 395  */
 396 void ena_com_mmio_reg_read_request_destroy(struct ena_com_dev *ena_dev);
 397
 398 /* ena_com_admin_init - Init the admin and the async queues
 399  * @ena_dev: ENA communication layer struct
 400  * @aenq_handlers: Those handlers to be called upon event.
 401  * @init_spinlock: Indicate if this method should init the admin spinlock or
 402  * the spinlock was init before (for example, in a case of FLR).
 403  *
 404  * Initialize the admin submission and completion queues.
 405  * Initialize the asynchronous events notification queues.
 406  *
 407  * @return - 0 on success, negative value on failure.
 408  */
 409 int ena_com_admin_init(struct ena_com_dev *ena_dev,
 410                        struct ena_aenq_handlers *aenq_handlers,
 411                        bool init_spinlock);
 412
 413 /* ena_com_admin_destroy - Destroy the admin and the async events queues.
 414  * @ena_dev: ENA communication layer struct
 415  *
 416  * @note: Before calling this method, the caller must validate that the device
 417  * won't send any additional admin completions/aenq.
 418  * To achieve that, a FLR is recommended.
 419  */
 420 void ena_com_admin_destroy(struct ena_com_dev *ena_dev);
 421
 422 /* ena_com_dev_reset - Perform device FLR to the device.
 423  * @ena_dev: ENA communication layer struct
 424  *
 425  * @return - 0 on success, negative value on failure.
 426  */
 427 int ena_com_dev_reset(struct ena_com_dev *ena_dev);
 428
 429 /* ena_com_create_io_queue - Create io queue.
 430  * @ena_dev: ENA communication layer struct
 431  * ena_com_create_io_ctx - create context structure
 432  *
 433  * Create the submission and the completion queues.
 434  *
 435  * @return - 0 on success, negative value on failure.
 436  */
 437 int ena_com_create_io_queue(struct ena_com_dev *ena_dev,
 438                             struct ena_com_create_io_ctx *ctx);
 439
 440 /* ena_com_admin_destroy - Destroy IO queue with the queue id - qid.
 441  * @ena_dev: ENA communication layer struct
 442  */
 443 void ena_com_destroy_io_queue(struct ena_com_dev *ena_dev, u16 qid);
 444
 445 /* ena_com_get_io_handlers - Return the io queue handlers
 446  * @ena_dev: ENA communication layer struct
 447  * @qid - the caller virtual queue id.
 448  * @io_sq - IO submission queue handler
 449  * @io_cq - IO completion queue handler.
 450  *
 451  * @return - 0 on success, negative value on failure.
 452  */
 453 int ena_com_get_io_handlers(struct ena_com_dev *ena_dev, u16 qid,
 454                             struct ena_com_io_sq **io_sq,
 455                             struct ena_com_io_cq **io_cq);
 456
 457 /* ena_com_admin_aenq_enable - ENAble asynchronous event notifications
 458  * @ena_dev: ENA communication layer struct
 459  *
 460  * After this method, aenq event can be received via AENQ.
 461  */
 462 void ena_com_admin_aenq_enable(struct ena_com_dev *ena_dev);
 463
 464 /* ena_com_set_admin_running_state - Set the state of the admin queue
 465  * @ena_dev: ENA communication layer struct
 466  *
 467  * Change the state of the admin queue (enable/disable)
 468  */
 469 void ena_com_set_admin_running_state(struct ena_com_dev *ena_dev, bool state);
 470
 471 /* ena_com_get_admin_running_state - Get the admin queue state
 472  * @ena_dev: ENA communication layer struct
 473  *
 474  * Retrieve the state of the admin queue (enable/disable)
 475  *
 476  * @return - current polling mode (enable/disable)
 477  */
 478 bool ena_com_get_admin_running_state(struct ena_com_dev *ena_dev);
 479
 480 /* ena_com_set_admin_polling_mode - Set the admin completion queue polling mode
 481  * @ena_dev: ENA communication layer struct
 482  * @polling: ENAble/Disable polling mode
 483  *
 484  * Set the admin completion mode.
 485  */
 486 void ena_com_set_admin_polling_mode(struct ena_com_dev *ena_dev, bool polling);
 487
 488 /* ena_com_set_admin_polling_mode - Get the admin completion queue polling mode
 489  * @ena_dev: ENA communication layer struct
 490  *
 491  * Get the admin completion mode.
 492  * If polling mode is on, ena_com_execute_admin_command will perform a
 493  * polling on the admin completion queue for the commands completion,
 494  * otherwise it will wait on wait event.
 495  *
 496  * @return state
 497  */
 498 bool ena_com_get_ena_admin_polling_mode(struct ena_com_dev *ena_dev);
 499
 500 /* ena_com_admin_q_comp_intr_handler - admin queue interrupt handler
 501  * @ena_dev: ENA communication layer struct
 502  *
 503  * This method go over the admin completion queue and wake up all the pending
 504  * threads that wait on the commands wait event.
 505  *
 506  * @note: Should be called after MSI-X interrupt.
 507  */
 508 void ena_com_admin_q_comp_intr_handler(struct ena_com_dev *ena_dev);
 509
 510 /* ena_com_aenq_intr_handler - AENQ interrupt handler
 511  * @ena_dev: ENA communication layer struct
 512  *
 513  * This method go over the async event notification queue and call the proper
 514  * aenq handler.
 515  */
 516 void ena_com_aenq_intr_handler(struct ena_com_dev *dev, void *data);
 517
 518 /* ena_com_abort_admin_commands - Abort all the outstanding admin commands.
 519  * @ena_dev: ENA communication layer struct
 520  *
 521  * This method aborts all the outstanding admin commands.
 522  * The caller should then call ena_com_wait_for_abort_completion to make sure
 523  * all the commands were completed.
 524  */
 525 void ena_com_abort_admin_commands(struct ena_com_dev *ena_dev);
 526
 527 /* ena_com_wait_for_abort_completion - Wait for admin commands abort.
 528  * @ena_dev: ENA communication layer struct
 529  *
 530  * This method wait until all the outstanding admin commands will be completed.
 531  */
 532 void ena_com_wait_for_abort_completion(struct ena_com_dev *ena_dev);
 533
 534 /* ena_com_validate_version - Validate the device parameters
 535  * @ena_dev: ENA communication layer struct
 536  *
 537  * This method validate the device parameters are the same as the saved
 538  * parameters in ena_dev.
 539  * This method is useful after device reset, to validate the device mac address
 540  * and the device offloads are the same as before the reset.
 541  *
 542  * @return - 0 on success negative value otherwise.
 543  */
 544 int ena_com_validate_version(struct ena_com_dev *ena_dev);
 545
 546 /* ena_com_get_link_params - Retrieve physical link parameters.
 547  * @ena_dev: ENA communication layer struct
 548  * @resp: Link parameters
 549  *
 550  * Retrieve the physical link parameters,
 551  * like speed, auto-negotiation and full duplex support.
 552  *
 553  * @return - 0 on Success negative value otherwise.
 554  */
 555 int ena_com_get_link_params(struct ena_com_dev *ena_dev,
 556                             struct ena_admin_get_feat_resp *resp);
 557
 558 /* ena_com_get_dma_width - Retrieve physical dma address width the device
 559  * supports.
 560  * @ena_dev: ENA communication layer struct
 561  *
 562  * Retrieve the maximum physical address bits the device can handle.
 563  *
 564  * @return: > 0 on Success and negative value otherwise.
 565  */
 566 int ena_com_get_dma_width(struct ena_com_dev *ena_dev);
 567
 568 /* ena_com_set_aenq_config - Set aenq groups configurations
 569  * @ena_dev: ENA communication layer struct
 570  * @groups flag: bit fields flags of enum ena_admin_aenq_group.
 571  *
 572  * Configure which aenq event group the driver would like to receive.
 573  *
 574  * @return: 0 on Success and negative value otherwise.
 575  */
 576 int ena_com_set_aenq_config(struct ena_com_dev *ena_dev, u32 groups_flag);
 577
 578 /* ena_com_get_dev_attr_feat - Get device features
 579  * @ena_dev: ENA communication layer struct
 580  * @get_feat_ctx: returned context that contain the get features.
 581  *
 582  * @return: 0 on Success and negative value otherwise.
 583  */
 584 int
 585 ena_com_get_dev_attr_feat(struct ena_com_dev *ena_dev,
 586                           struct ena_com_dev_get_features_ctx *get_feat_ctx);
 587
 588 /* ena_com_get_dev_basic_stats - Get device basic statistics
 589  * @ena_dev: ENA communication layer struct
 590  * @stats: stats return value
 591  *
 592  * @return: 0 on Success and negative value otherwise.
 593  */
 594 int ena_com_get_dev_basic_stats(struct ena_com_dev *ena_dev,
 595                                 struct ena_admin_basic_stats *stats);
 596
 597 /* ena_com_set_dev_mtu - Configure the device mtu.
 598  * @ena_dev: ENA communication layer struct
 599  * @mtu: mtu value
 600  *
 601  * @return: 0 on Success and negative value otherwise.
 602  */
 603 int ena_com_set_dev_mtu(struct ena_com_dev *ena_dev, int mtu);
 604
 605 /* ena_com_get_offload_settings - Retrieve the device offloads capabilities
 606  * @ena_dev: ENA communication layer struct
 607  * @offlad: offload return value
 608  *
 609  * @return: 0 on Success and negative value otherwise.
 610  */
 611 int
 612 ena_com_get_offload_settings(struct ena_com_dev *ena_dev,
 613                              struct ena_admin_feature_offload_desc *offload);
 614
 615 /* ena_com_rss_init - Init RSS
 616  * @ena_dev: ENA communication layer struct
 617  * @log_size: indirection log size
 618  *
 619  * Allocate RSS/RFS resources.
 620  * The caller then can configure rss using ena_com_set_hash_function,
 621  * ena_com_set_hash_ctrl and ena_com_indirect_table_set.
 622  *
 623  * @return: 0 on Success and negative value otherwise.
 624  */
 625 int ena_com_rss_init(struct ena_com_dev *ena_dev, u16 log_size);
 626
 627 /* ena_com_rss_destroy - Destroy rss
 628  * @ena_dev: ENA communication layer struct
 629  *
 630  * Free all the RSS/RFS resources.
 631  */
 632 void ena_com_rss_destroy(struct ena_com_dev *ena_dev);
 633
 634 /* ena_com_fill_hash_function - Fill RSS hash function
 635  * @ena_dev: ENA communication layer struct
 636  * @func: The hash function (Toeplitz or crc)
 637  * @key: Hash key (for toeplitz hash)
 638  * @key_len: key length (max length 10 DW)
 639  * @init_val: initial value for the hash function
 640  *
 641  * Fill the ena_dev resources with the desire hash function, hash key, key_len
 642  * and key initial value (if needed by the hash function).
 643  * To flush the key into the device the caller should call
 644  * ena_com_set_hash_function.
 645  *
 646  * @return: 0 on Success and negative value otherwise.
 647  */
 648 int ena_com_fill_hash_function(struct ena_com_dev *ena_dev,
 649                                enum ena_admin_hash_functions func,
 650                                const u8 *key, u16 key_len, u32 init_val);
 651
 652 /* ena_com_set_hash_function - Flush the hash function and it dependencies to
 653  * the device.
 654  * @ena_dev: ENA communication layer struct
 655  *
 656  * Flush the hash function and it dependencies (key, key length and
 657  * initial value) if needed.
 658  *
 659  * @note: Prior to this method the caller should call ena_com_fill_hash_function
 660  *
 661  * @return: 0 on Success and negative value otherwise.
 662  */
 663 int ena_com_set_hash_function(struct ena_com_dev *ena_dev);
 664
 665 /* ena_com_get_hash_function - Retrieve the hash function and the hash key
 666  * from the device.
 667  * @ena_dev: ENA communication layer struct
 668  * @func: hash function
 669  * @key: hash key
 670  *
 671  * Retrieve the hash function and the hash key from the device.
 672  *
 673  * @note: If the caller called ena_com_fill_hash_function but didn't flash
 674  * it to the device, the new configuration will be lost.
 675  *
 676  * @return: 0 on Success and negative value otherwise.
 677  */
 678 int ena_com_get_hash_function(struct ena_com_dev *ena_dev,
 679                               enum ena_admin_hash_functions *func,
 680                               u8 *key);
 681
 682 /* ena_com_fill_hash_ctrl - Fill RSS hash control
 683  * @ena_dev: ENA communication layer struct.
 684  * @proto: The protocol to configure.
 685  * @hash_fields: bit mask of ena_admin_flow_hash_fields
 686  *
 687  * Fill the ena_dev resources with the desire hash control (the ethernet
 688  * fields that take part of the hash) for a specific protocol.
 689  * To flush the hash control to the device, the caller should call
 690  * ena_com_set_hash_ctrl.
 691  *
 692  * @return: 0 on Success and negative value otherwise.
 693  */
 694 int ena_com_fill_hash_ctrl(struct ena_com_dev *ena_dev,
 695                            enum ena_admin_flow_hash_proto proto,
 696                            u16 hash_fields);
 697
 698 /* ena_com_set_hash_ctrl - Flush the hash control resources to the device.
 699  * @ena_dev: ENA communication layer struct
 700  *
 701  * Flush the hash control (the ethernet fields that take part of the hash)
 702  *
 703  * @note: Prior to this method the caller should call ena_com_fill_hash_ctrl.
 704  *
 705  * @return: 0 on Success and negative value otherwise.
 706  */
 707 int ena_com_set_hash_ctrl(struct ena_com_dev *ena_dev);
 708
 709 /* ena_com_get_hash_ctrl - Retrieve the hash control from the device.
 710  * @ena_dev: ENA communication layer struct
 711  * @proto: The protocol to retrieve.
 712  * @fields: bit mask of ena_admin_flow_hash_fields.
 713  *
 714  * Retrieve the hash control from the device.
 715  *
 716  * @note, If the caller called ena_com_fill_hash_ctrl but didn't flash
 717  * it to the device, the new configuration will be lost.
 718  *
 719  * @return: 0 on Success and negative value otherwise.
 720  */
 721 int ena_com_get_hash_ctrl(struct ena_com_dev *ena_dev,
 722                           enum ena_admin_flow_hash_proto proto,
 723                           u16 *fields);
 724
 725 /* ena_com_set_default_hash_ctrl - Set the hash control to a default
 726  * configuration.
 727  * @ena_dev: ENA communication layer struct
 728  *
 729  * Fill the ena_dev resources with the default hash control configuration.
 730  * To flush the hash control to the device, the caller should call
 731  * ena_com_set_hash_ctrl.
 732  *
 733  * @return: 0 on Success and negative value otherwise.
 734  */
 735 int ena_com_set_default_hash_ctrl(struct ena_com_dev *ena_dev);
 736
 737 /* ena_com_indirect_table_fill_entry - Fill a single entry in the RSS
 738  * indirection table
 739  * @ena_dev: ENA communication layer struct.
 740  * @entry_idx - indirection table entry.
 741  * @entry_value - redirection value
 742  *
 743  * Fill a single entry of the RSS indirection table in the ena_dev resources.
 744  * To flush the indirection table to the device, the called should call
 745  * ena_com_indirect_table_set.
 746  *
 747  * @return: 0 on Success and negative value otherwise.
 748  */
 749 int ena_com_indirect_table_fill_entry(struct ena_com_dev *ena_dev,
 750                                       u16 entry_idx, u16 entry_value);
 751
 752 /* ena_com_indirect_table_set - Flush the indirection table to the device.
 753  * @ena_dev: ENA communication layer struct
 754  *
 755  * Flush the indirection hash control to the device.
 756  * Prior to this method the caller should call ena_com_indirect_table_fill_entry
 757  *
 758  * @return: 0 on Success and negative value otherwise.
 759  */
 760 int ena_com_indirect_table_set(struct ena_com_dev *ena_dev);
 761
 762 /* ena_com_indirect_table_get - Retrieve the indirection table from the device.
 763  * @ena_dev: ENA communication layer struct
 764  * @ind_tbl: indirection table
 765  *
 766  * Retrieve the RSS indirection table from the device.
 767  *
 768  * @note: If the caller called ena_com_indirect_table_fill_entry but didn't
 769  * flash it to the device, the new configuration will be lost.
 770  *
 771  * @return: 0 on Success and negative value otherwise.
 772  */
 773 int ena_com_indirect_table_get(struct ena_com_dev *ena_dev, u32 *ind_tbl);
 774
 775 /* ena_com_allocate_host_info - Allocate host info resources.
 776  * @ena_dev: ENA communication layer struct
 777  *
 778  * @return: 0 on Success and negative value otherwise.
 779  */
 780 int ena_com_allocate_host_info(struct ena_com_dev *ena_dev);
 781
 782 /* ena_com_allocate_debug_area - Allocate debug area.
 783  * @ena_dev: ENA communication layer struct
 784  * @debug_area_size - debug area size.
 785  *
 786  * @return: 0 on Success and negative value otherwise.
 787  */
 788 int ena_com_allocate_debug_area(struct ena_com_dev *ena_dev,
 789                                 u32 debug_area_size);
 790
 791 /* ena_com_delete_debug_area - Free the debug area resources.
 792  * @ena_dev: ENA communication layer struct
 793  *
 794  * Free the allocate debug area.
 795  */
 796 void ena_com_delete_debug_area(struct ena_com_dev *ena_dev);
 797
 798 /* ena_com_delete_host_info - Free the host info resources.
 799  * @ena_dev: ENA communication layer struct
 800  *
 801  * Free the allocate host info.
 802  */
 803 void ena_com_delete_host_info(struct ena_com_dev *ena_dev);
 804
 805 /* ena_com_set_host_attributes - Update the device with the host
 806  * attributes (debug area and host info) base address.
 807  * @ena_dev: ENA communication layer struct
 808  *
 809  * @return: 0 on Success and negative value otherwise.
 810  */
 811 int ena_com_set_host_attributes(struct ena_com_dev *ena_dev);
 812
 813 /* ena_com_create_io_cq - Create io completion queue.
 814  * @ena_dev: ENA communication layer struct
 815  * @io_cq - io completion queue handler
 816
 817  * Create IO completion queue.
 818  *
 819  * @return - 0 on success, negative value on failure.
 820  */
 821 int ena_com_create_io_cq(struct ena_com_dev *ena_dev,
 822                          struct ena_com_io_cq *io_cq);
 823
 824 /* ena_com_destroy_io_cq - Destroy io completion queue.
 825  * @ena_dev: ENA communication layer struct
 826  * @io_cq - io completion queue handler
 827
 828  * Destroy IO completion queue.
 829  *
 830  * @return - 0 on success, negative value on failure.
 831  */
 832 int ena_com_destroy_io_cq(struct ena_com_dev *ena_dev,
 833                           struct ena_com_io_cq *io_cq);
 834
 835 /* ena_com_execute_admin_command - Execute admin command
 836  * @admin_queue: admin queue.
 837  * @cmd: the admin command to execute.
 838  * @cmd_size: the command size.
 839  * @cmd_completion: command completion return value.
 840  * @cmd_comp_size: command completion size.
 841
 842  * Submit an admin command and then wait until the device will return a
 843  * completion.
 844  * The completion will be copyed into cmd_comp.
 845  *
 846  * @return - 0 on success, negative value on failure.
 847  */
 848 int ena_com_execute_admin_command(struct ena_com_admin_queue *admin_queue,
 849                                   struct ena_admin_aq_entry *cmd,
 850                                   size_t cmd_size,
 851                                   struct ena_admin_acq_entry *cmd_comp,
 852                                   size_t cmd_comp_size);
 853
 854 /* ena_com_init_interrupt_moderation - Init interrupt moderation
 855  * @ena_dev: ENA communication layer struct
 856  *
 857  * @return - 0 on success, negative value on failure.
 858  */
 859 int ena_com_init_interrupt_moderation(struct ena_com_dev *ena_dev);
 860
 861 /* ena_com_destroy_interrupt_moderation - Destroy interrupt moderation resources
 862  * @ena_dev: ENA communication layer struct
 863  */
 864 void ena_com_destroy_interrupt_moderation(struct ena_com_dev *ena_dev);
 865
 866 /* ena_com_interrupt_moderation_supported - Return if interrupt moderation
 867  * capability is supported by the device.
 868  *
 869  * @return - supported or not.
 870  */
 871 bool ena_com_interrupt_moderation_supported(struct ena_com_dev *ena_dev);
 872
 873 /* ena_com_config_default_interrupt_moderation_table - Restore the interrupt
 874  * moderation table back to the default parameters.
 875  * @ena_dev: ENA communication layer struct
 876  */
 877 void
 878 ena_com_config_default_interrupt_moderation_table(struct ena_com_dev *ena_dev);
 879
 880 /* ena_com_update_nonadaptive_moderation_interval_tx - Update the
 881  * non-adaptive interval in Tx direction.
 882  * @ena_dev: ENA communication layer struct
 883  * @tx_coalesce_usecs: Interval in usec.
 884  *
 885  * @return - 0 on success, negative value on failure.
 886  */
 887 int
 888 ena_com_update_nonadaptive_moderation_interval_tx(struct ena_com_dev *ena_dev,
 889                                                   u32 tx_coalesce_usecs);
 890
 891 /* ena_com_update_nonadaptive_moderation_interval_rx - Update the
 892  * non-adaptive interval in Rx direction.
 893  * @ena_dev: ENA communication layer struct
 894  * @rx_coalesce_usecs: Interval in usec.
 895  *
 896  * @return - 0 on success, negative value on failure.
 897  */
 898 int
 899 ena_com_update_nonadaptive_moderation_interval_rx(struct ena_com_dev *ena_dev,
 900                                                   u32 rx_coalesce_usecs);
 901
 902 /* ena_com_get_nonadaptive_moderation_interval_tx - Retrieve the
 903  * non-adaptive interval in Tx direction.
 904  * @ena_dev: ENA communication layer struct
 905  *
 906  * @return - interval in usec
 907  */
 908 unsigned int
 909 ena_com_get_nonadaptive_moderation_interval_tx(struct ena_com_dev *ena_dev);
 910
 911 /* ena_com_get_nonadaptive_moderation_interval_rx - Retrieve the
 912  * non-adaptive interval in Rx direction.
 913  * @ena_dev: ENA communication layer struct
 914  *
 915  * @return - interval in usec
 916  */
 917 unsigned int
 918 ena_com_get_nonadaptive_moderation_interval_rx(struct ena_com_dev *ena_dev);
 919
 920 /* ena_com_init_intr_moderation_entry - Update a single entry in the interrupt
 921  * moderation table.
 922  * @ena_dev: ENA communication layer struct
 923  * @level: Interrupt moderation table level
 924  * @entry: Entry value
 925  *
 926  * Update a single entry in the interrupt moderation table.
 927  */
 928 void ena_com_init_intr_moderation_entry(struct ena_com_dev *ena_dev,
 929                                         enum ena_intr_moder_level level,
 930                                         struct ena_intr_moder_entry *entry);
 931
 932 /* ena_com_get_intr_moderation_entry - Init ena_intr_moder_entry.
 933  * @ena_dev: ENA communication layer struct
 934  * @level: Interrupt moderation table level
 935  * @entry: Entry to fill.
 936  *
 937  * Initialize the entry according to the adaptive interrupt moderation table.
 938  */
 939 void ena_com_get_intr_moderation_entry(struct ena_com_dev *ena_dev,
 940                                        enum ena_intr_moder_level level,
 941                                        struct ena_intr_moder_entry *entry);
 942
 943 static inline bool
 944 ena_com_get_adaptive_moderation_enabled(struct ena_com_dev *ena_dev)
 945 {
 946         return ena_dev->adaptive_coalescing;
 947 }
 948
 949 static inline void
 950 ena_com_enable_adaptive_moderation(struct ena_com_dev *ena_dev)
 951 {
 952         ena_dev->adaptive_coalescing = true;
 953 }
 954
 955 static inline void
 956 ena_com_disable_adaptive_moderation(struct ena_com_dev *ena_dev)
 957 {
 958         ena_dev->adaptive_coalescing = false;
 959 }
 960
 961 /* ena_com_calculate_interrupt_delay - Calculate new interrupt delay
 962  * @ena_dev: ENA communication layer struct
 963  * @pkts: Number of packets since the last update
 964  * @bytes: Number of bytes received since the last update.
 965  * @smoothed_interval: Returned interval
 966  * @moder_tbl_idx: Current table level as input update new level as return
 967  * value.
 968  */
 969 static inline void
 970 ena_com_calculate_interrupt_delay(struct ena_com_dev *ena_dev,
 971                                   unsigned int pkts,
 972                                   unsigned int bytes,
 973                                   unsigned int *smoothed_interval,
 974                                   unsigned int *moder_tbl_idx)
 975 {
 976         enum ena_intr_moder_level curr_moder_idx, new_moder_idx;
 977         struct ena_intr_moder_entry *curr_moder_entry;
 978         struct ena_intr_moder_entry *pred_moder_entry;
 979         struct ena_intr_moder_entry *new_moder_entry;
 980         struct ena_intr_moder_entry *intr_moder_tbl = ena_dev->intr_moder_tbl;
 981         unsigned int interval;
 982
 983         /* We apply adaptive moderation on Rx path only.
 984          * Tx uses static interrupt moderation.
 985          */
 986         if (!pkts || !bytes)
 987                 /* Tx interrupt, or spurious interrupt,
 988                  * in both cases we just use same delay values
 989                  */
 990                 return;
 991
 992         curr_moder_idx = (enum ena_intr_moder_level)(*moder_tbl_idx);
 993         if (unlikely(curr_moder_idx >=  ENA_INTR_MAX_NUM_OF_LEVELS)) {
 994                 ena_trc_err("Wrong moderation index %u\n", curr_moder_idx);
 995                 return;
 996         }
 997
 998         curr_moder_entry = &intr_moder_tbl[curr_moder_idx];
 999         new_moder_idx = curr_moder_idx;
1000
1001         if (curr_moder_idx == ENA_INTR_MODER_LOWEST) {
1002                 if ((pkts > curr_moder_entry->pkts_per_interval) ||
1003                     (bytes > curr_moder_entry->bytes_per_interval))
1004                         new_moder_idx = (enum ena_intr_moder_level)(curr_moder_idx + 1);
1005         } else {
1006                 pred_moder_entry = &intr_moder_tbl[curr_moder_idx - 1];
1007
1008                 if ((pkts <= pred_moder_entry->pkts_per_interval) ||
1009                     (bytes <= pred_moder_entry->bytes_per_interval))
1010                         new_moder_idx = (enum ena_intr_moder_level)(curr_moder_idx - 1);
1011                 else if ((pkts > curr_moder_entry->pkts_per_interval) ||
1012                          (bytes > curr_moder_entry->bytes_per_interval)) {
1013                         if (curr_moder_idx != ENA_INTR_MODER_HIGHEST)
1014                                 new_moder_idx = (enum ena_intr_moder_level)(curr_moder_idx + 1);
1015                 }
1016         }
1017         new_moder_entry = &intr_moder_tbl[new_moder_idx];
1018
1019         interval = new_moder_entry->intr_moder_interval;
1020         *smoothed_interval = (
1021                 (interval * ENA_INTR_DELAY_NEW_VALUE_WEIGHT +
1022                 ENA_INTR_DELAY_OLD_VALUE_WEIGHT * (*smoothed_interval)) + 5) /
1023                 10;
1024
1025         *moder_tbl_idx = new_moder_idx;
1026 }
1027
1028 /* ena_com_update_intr_reg - Prepare interrupt register
1029  * @intr_reg: interrupt register to update.
1030  * @rx_delay_interval: Rx interval in usecs
1031  * @tx_delay_interval: Tx interval in usecs
1032  * @unmask: unask enable/disable
1033  *
1034  * Prepare interrupt update register with the supplied parameters.
1035  */
1036 static inline void ena_com_update_intr_reg(struct ena_eth_io_intr_reg *intr_reg,
1037                                            u32 rx_delay_interval,
1038                                            u32 tx_delay_interval,
1039                                            bool unmask)
1040 {
1041         intr_reg->intr_control = 0;
1042         intr_reg->intr_control |= rx_delay_interval &
1043                 ENA_ETH_IO_INTR_REG_RX_INTR_DELAY_MASK;
1044
1045         intr_reg->intr_control |=
1046                 (tx_delay_interval << ENA_ETH_IO_INTR_REG_TX_INTR_DELAY_SHIFT)
1047                 & ENA_ETH_IO_INTR_REG_RX_INTR_DELAY_MASK;
1048
1049         if (unmask)
1050                 intr_reg->intr_control |= ENA_ETH_IO_INTR_REG_INTR_UNMASK_MASK;
1051 }
1052
1053 int ena_com_get_dev_extended_stats(struct ena_com_dev *ena_dev, char *buff,
1054                                    u32 len);
1055
1056 int ena_com_extended_stats_set_func_queue(struct ena_com_dev *ena_dev,
1057                                           u32 funct_queue);
1058
1059 #if defined(__cplusplus)
1060 }
1061 #endif /* __cplusplus */
1062 #endif /* !(ENA_COM) */