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