dm writecache: add cond_resched to loop in persistent_memory_claim()
[linux/fpc-iii.git] / drivers / infiniband / hw / efa / efa_admin_cmds_defs.h
blob96b104ab5415db0627137220fefc7ba9f55f1552
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
2 /*
3 * Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All rights reserved.
4 */
6 #ifndef _EFA_ADMIN_CMDS_H_
7 #define _EFA_ADMIN_CMDS_H_
9 #define EFA_ADMIN_API_VERSION_MAJOR 0
10 #define EFA_ADMIN_API_VERSION_MINOR 1
12 /* EFA admin queue opcodes */
13 enum efa_admin_aq_opcode {
14 EFA_ADMIN_CREATE_QP = 1,
15 EFA_ADMIN_MODIFY_QP = 2,
16 EFA_ADMIN_QUERY_QP = 3,
17 EFA_ADMIN_DESTROY_QP = 4,
18 EFA_ADMIN_CREATE_AH = 5,
19 EFA_ADMIN_DESTROY_AH = 6,
20 EFA_ADMIN_REG_MR = 7,
21 EFA_ADMIN_DEREG_MR = 8,
22 EFA_ADMIN_CREATE_CQ = 9,
23 EFA_ADMIN_DESTROY_CQ = 10,
24 EFA_ADMIN_GET_FEATURE = 11,
25 EFA_ADMIN_SET_FEATURE = 12,
26 EFA_ADMIN_GET_STATS = 13,
27 EFA_ADMIN_ALLOC_PD = 14,
28 EFA_ADMIN_DEALLOC_PD = 15,
29 EFA_ADMIN_ALLOC_UAR = 16,
30 EFA_ADMIN_DEALLOC_UAR = 17,
31 EFA_ADMIN_MAX_OPCODE = 17,
34 enum efa_admin_aq_feature_id {
35 EFA_ADMIN_DEVICE_ATTR = 1,
36 EFA_ADMIN_AENQ_CONFIG = 2,
37 EFA_ADMIN_NETWORK_ATTR = 3,
38 EFA_ADMIN_QUEUE_ATTR = 4,
39 EFA_ADMIN_HW_HINTS = 5,
40 EFA_ADMIN_FEATURES_OPCODE_NUM = 8,
43 /* QP transport type */
44 enum efa_admin_qp_type {
45 /* Unreliable Datagram */
46 EFA_ADMIN_QP_TYPE_UD = 1,
47 /* Scalable Reliable Datagram */
48 EFA_ADMIN_QP_TYPE_SRD = 2,
51 /* QP state */
52 enum efa_admin_qp_state {
53 EFA_ADMIN_QP_STATE_RESET = 0,
54 EFA_ADMIN_QP_STATE_INIT = 1,
55 EFA_ADMIN_QP_STATE_RTR = 2,
56 EFA_ADMIN_QP_STATE_RTS = 3,
57 EFA_ADMIN_QP_STATE_SQD = 4,
58 EFA_ADMIN_QP_STATE_SQE = 5,
59 EFA_ADMIN_QP_STATE_ERR = 6,
62 enum efa_admin_get_stats_type {
63 EFA_ADMIN_GET_STATS_TYPE_BASIC = 0,
66 enum efa_admin_get_stats_scope {
67 EFA_ADMIN_GET_STATS_SCOPE_ALL = 0,
68 EFA_ADMIN_GET_STATS_SCOPE_QUEUE = 1,
71 enum efa_admin_modify_qp_mask_bits {
72 EFA_ADMIN_QP_STATE_BIT = 0,
73 EFA_ADMIN_CUR_QP_STATE_BIT = 1,
74 EFA_ADMIN_QKEY_BIT = 2,
75 EFA_ADMIN_SQ_PSN_BIT = 3,
76 EFA_ADMIN_SQ_DRAINED_ASYNC_NOTIFY_BIT = 4,
80 * QP allocation sizes, converted by fabric QueuePair (QP) create command
81 * from QP capabilities.
83 struct efa_admin_qp_alloc_size {
84 /* Send descriptor ring size in bytes */
85 u32 send_queue_ring_size;
87 /* Max number of WQEs that can be outstanding on send queue. */
88 u32 send_queue_depth;
91 * Recv descriptor ring size in bytes, sufficient for user-provided
92 * number of WQEs
94 u32 recv_queue_ring_size;
96 /* Max number of WQEs that can be outstanding on recv queue */
97 u32 recv_queue_depth;
100 struct efa_admin_create_qp_cmd {
101 /* Common Admin Queue descriptor */
102 struct efa_admin_aq_common_desc aq_common_desc;
104 /* Protection Domain associated with this QP */
105 u16 pd;
107 /* QP type */
108 u8 qp_type;
111 * 0 : sq_virt - If set, SQ ring base address is
112 * virtual (IOVA returned by MR registration)
113 * 1 : rq_virt - If set, RQ ring base address is
114 * virtual (IOVA returned by MR registration)
115 * 7:2 : reserved - MBZ
117 u8 flags;
120 * Send queue (SQ) ring base physical address. This field is not
121 * used if this is a Low Latency Queue(LLQ).
123 u64 sq_base_addr;
125 /* Receive queue (RQ) ring base address. */
126 u64 rq_base_addr;
128 /* Index of CQ to be associated with Send Queue completions */
129 u32 send_cq_idx;
131 /* Index of CQ to be associated with Recv Queue completions */
132 u32 recv_cq_idx;
135 * Memory registration key for the SQ ring, used only when not in
136 * LLQ mode and base address is virtual
138 u32 sq_l_key;
141 * Memory registration key for the RQ ring, used only when base
142 * address is virtual
144 u32 rq_l_key;
146 /* Requested QP allocation sizes */
147 struct efa_admin_qp_alloc_size qp_alloc_size;
149 /* UAR number */
150 u16 uar;
152 /* MBZ */
153 u16 reserved;
155 /* MBZ */
156 u32 reserved2;
159 struct efa_admin_create_qp_resp {
160 /* Common Admin Queue completion descriptor */
161 struct efa_admin_acq_common_desc acq_common_desc;
164 * Opaque handle to be used for consequent admin operations on the
165 * QP
167 u32 qp_handle;
170 * QP number in the given EFA virtual device. Least-significant bits
171 * (as needed according to max_qp) carry unique QP ID
173 u16 qp_num;
175 /* MBZ */
176 u16 reserved;
178 /* Index of sub-CQ for Send Queue completions */
179 u16 send_sub_cq_idx;
181 /* Index of sub-CQ for Receive Queue completions */
182 u16 recv_sub_cq_idx;
184 /* SQ doorbell address, as offset to PCIe DB BAR */
185 u32 sq_db_offset;
187 /* RQ doorbell address, as offset to PCIe DB BAR */
188 u32 rq_db_offset;
191 * low latency send queue ring base address as an offset to PCIe
192 * MMIO LLQ_MEM BAR
194 u32 llq_descriptors_offset;
197 struct efa_admin_modify_qp_cmd {
198 /* Common Admin Queue descriptor */
199 struct efa_admin_aq_common_desc aq_common_desc;
202 * Mask indicating which fields should be updated see enum
203 * efa_admin_modify_qp_mask_bits
205 u32 modify_mask;
207 /* QP handle returned by create_qp command */
208 u32 qp_handle;
210 /* QP state */
211 u32 qp_state;
213 /* Override current QP state (before applying the transition) */
214 u32 cur_qp_state;
216 /* QKey */
217 u32 qkey;
219 /* SQ PSN */
220 u32 sq_psn;
222 /* Enable async notification when SQ is drained */
223 u8 sq_drained_async_notify;
225 /* MBZ */
226 u8 reserved1;
228 /* MBZ */
229 u16 reserved2;
232 struct efa_admin_modify_qp_resp {
233 /* Common Admin Queue completion descriptor */
234 struct efa_admin_acq_common_desc acq_common_desc;
237 struct efa_admin_query_qp_cmd {
238 /* Common Admin Queue descriptor */
239 struct efa_admin_aq_common_desc aq_common_desc;
241 /* QP handle returned by create_qp command */
242 u32 qp_handle;
245 struct efa_admin_query_qp_resp {
246 /* Common Admin Queue completion descriptor */
247 struct efa_admin_acq_common_desc acq_common_desc;
249 /* QP state */
250 u32 qp_state;
252 /* QKey */
253 u32 qkey;
255 /* SQ PSN */
256 u32 sq_psn;
258 /* Indicates that draining is in progress */
259 u8 sq_draining;
261 /* MBZ */
262 u8 reserved1;
264 /* MBZ */
265 u16 reserved2;
268 struct efa_admin_destroy_qp_cmd {
269 /* Common Admin Queue descriptor */
270 struct efa_admin_aq_common_desc aq_common_desc;
272 /* QP handle returned by create_qp command */
273 u32 qp_handle;
276 struct efa_admin_destroy_qp_resp {
277 /* Common Admin Queue completion descriptor */
278 struct efa_admin_acq_common_desc acq_common_desc;
282 * Create Address Handle command parameters. Must not be called more than
283 * once for the same destination
285 struct efa_admin_create_ah_cmd {
286 /* Common Admin Queue descriptor */
287 struct efa_admin_aq_common_desc aq_common_desc;
289 /* Destination address in network byte order */
290 u8 dest_addr[16];
292 /* PD number */
293 u16 pd;
295 /* MBZ */
296 u16 reserved;
299 struct efa_admin_create_ah_resp {
300 /* Common Admin Queue completion descriptor */
301 struct efa_admin_acq_common_desc acq_common_desc;
303 /* Target interface address handle (opaque) */
304 u16 ah;
306 /* MBZ */
307 u16 reserved;
310 struct efa_admin_destroy_ah_cmd {
311 /* Common Admin Queue descriptor */
312 struct efa_admin_aq_common_desc aq_common_desc;
314 /* Target interface address handle (opaque) */
315 u16 ah;
317 /* PD number */
318 u16 pd;
321 struct efa_admin_destroy_ah_resp {
322 /* Common Admin Queue completion descriptor */
323 struct efa_admin_acq_common_desc acq_common_desc;
327 * Registration of MemoryRegion, required for QP working with Virtual
328 * Addresses. In standard verbs semantics, region length is limited to 2GB
329 * space, but EFA offers larger MR support for large memory space, to ease
330 * on users working with very large datasets (i.e. full GPU memory mapping).
332 struct efa_admin_reg_mr_cmd {
333 /* Common Admin Queue descriptor */
334 struct efa_admin_aq_common_desc aq_common_desc;
336 /* Protection Domain */
337 u16 pd;
339 /* MBZ */
340 u16 reserved16_w1;
342 /* Physical Buffer List, each element is page-aligned. */
343 union {
345 * Inline array of guest-physical page addresses of user
346 * memory pages (optimization for short region
347 * registrations)
349 u64 inline_pbl_array[4];
351 /* points to PBL (direct or indirect, chained if needed) */
352 struct efa_admin_ctrl_buff_info pbl;
353 } pbl;
355 /* Memory region length, in bytes. */
356 u64 mr_length;
359 * flags and page size
360 * 4:0 : phys_page_size_shift - page size is (1 <<
361 * phys_page_size_shift). Page size is used for
362 * building the Virtual to Physical address mapping
363 * 6:5 : reserved - MBZ
364 * 7 : mem_addr_phy_mode_en - Enable bit for physical
365 * memory registration (no translation), can be used
366 * only by privileged clients. If set, PBL must
367 * contain a single entry.
369 u8 flags;
372 * permissions
373 * 0 : local_write_enable - Local write permissions:
374 * must be set for RQ buffers and buffers posted for
375 * RDMA Read requests
376 * 1 : reserved1 - MBZ
377 * 2 : remote_read_enable - Remote read permissions:
378 * must be set to enable RDMA read from the region
379 * 7:3 : reserved2 - MBZ
381 u8 permissions;
383 /* MBZ */
384 u16 reserved16_w5;
386 /* number of pages in PBL (redundant, could be calculated) */
387 u32 page_num;
390 * IO Virtual Address associated with this MR. If
391 * mem_addr_phy_mode_en is set, contains the physical address of
392 * the region.
394 u64 iova;
397 struct efa_admin_reg_mr_resp {
398 /* Common Admin Queue completion descriptor */
399 struct efa_admin_acq_common_desc acq_common_desc;
402 * L_Key, to be used in conjunction with local buffer references in
403 * SQ and RQ WQE, or with virtual RQ/CQ rings
405 u32 l_key;
408 * R_Key, to be used in RDMA messages to refer to remotely accessed
409 * memory region
411 u32 r_key;
414 struct efa_admin_dereg_mr_cmd {
415 /* Common Admin Queue descriptor */
416 struct efa_admin_aq_common_desc aq_common_desc;
418 /* L_Key, memory region's l_key */
419 u32 l_key;
422 struct efa_admin_dereg_mr_resp {
423 /* Common Admin Queue completion descriptor */
424 struct efa_admin_acq_common_desc acq_common_desc;
427 struct efa_admin_create_cq_cmd {
428 struct efa_admin_aq_common_desc aq_common_desc;
431 * 4:0 : reserved5 - MBZ
432 * 5 : interrupt_mode_enabled - if set, cq operates
433 * in interrupt mode (i.e. CQ events and MSI-X are
434 * generated), otherwise - polling
435 * 6 : virt - If set, ring base address is virtual
436 * (IOVA returned by MR registration)
437 * 7 : reserved6 - MBZ
439 u8 cq_caps_1;
442 * 4:0 : cq_entry_size_words - size of CQ entry in
443 * 32-bit words, valid values: 4, 8.
444 * 7:5 : reserved7 - MBZ
446 u8 cq_caps_2;
448 /* completion queue depth in # of entries. must be power of 2 */
449 u16 cq_depth;
451 /* msix vector assigned to this cq */
452 u32 msix_vector_idx;
455 * CQ ring base address, virtual or physical depending on 'virt'
456 * flag
458 struct efa_common_mem_addr cq_ba;
461 * Memory registration key for the ring, used only when base
462 * address is virtual
464 u32 l_key;
467 * number of sub cqs - must be equal to sub_cqs_per_cq of queue
468 * attributes.
470 u16 num_sub_cqs;
472 /* UAR number */
473 u16 uar;
476 struct efa_admin_create_cq_resp {
477 struct efa_admin_acq_common_desc acq_common_desc;
479 u16 cq_idx;
481 /* actual cq depth in number of entries */
482 u16 cq_actual_depth;
485 struct efa_admin_destroy_cq_cmd {
486 struct efa_admin_aq_common_desc aq_common_desc;
488 u16 cq_idx;
490 /* MBZ */
491 u16 reserved1;
494 struct efa_admin_destroy_cq_resp {
495 struct efa_admin_acq_common_desc acq_common_desc;
499 * EFA AQ Get Statistics command. Extended statistics are placed in control
500 * buffer pointed by AQ entry
502 struct efa_admin_aq_get_stats_cmd {
503 struct efa_admin_aq_common_desc aq_common_descriptor;
505 union {
506 /* command specific inline data */
507 u32 inline_data_w1[3];
509 struct efa_admin_ctrl_buff_info control_buffer;
510 } u;
512 /* stats type as defined in enum efa_admin_get_stats_type */
513 u8 type;
515 /* stats scope defined in enum efa_admin_get_stats_scope */
516 u8 scope;
518 u16 scope_modifier;
521 struct efa_admin_basic_stats {
522 u64 tx_bytes;
524 u64 tx_pkts;
526 u64 rx_bytes;
528 u64 rx_pkts;
530 u64 rx_drops;
533 struct efa_admin_acq_get_stats_resp {
534 struct efa_admin_acq_common_desc acq_common_desc;
536 struct efa_admin_basic_stats basic_stats;
539 struct efa_admin_get_set_feature_common_desc {
541 * 1:0 : select - 0x1 - current value; 0x3 - default
542 * value
543 * 7:3 : reserved3 - MBZ
545 u8 flags;
547 /* as appears in efa_admin_aq_feature_id */
548 u8 feature_id;
550 /* MBZ */
551 u16 reserved16;
554 struct efa_admin_feature_device_attr_desc {
555 /* Bitmap of efa_admin_aq_feature_id */
556 u64 supported_features;
558 /* Bitmap of supported page sizes in MR registrations */
559 u64 page_size_cap;
561 u32 fw_version;
563 u32 admin_api_version;
565 u32 device_version;
567 /* Bar used for SQ and RQ doorbells */
568 u16 db_bar;
570 /* Indicates how many bits are used on physical address access */
571 u8 phys_addr_width;
573 /* Indicates how many bits are used on virtual address access */
574 u8 virt_addr_width;
577 * 0 : rdma_read - If set, RDMA Read is supported on
578 * TX queues
579 * 31:1 : reserved - MBZ
581 u32 device_caps;
583 /* Max RDMA transfer size in bytes */
584 u32 max_rdma_size;
587 struct efa_admin_feature_queue_attr_desc {
588 /* The maximum number of queue pairs supported */
589 u32 max_qp;
591 /* Maximum number of WQEs per Send Queue */
592 u32 max_sq_depth;
594 /* Maximum size of data that can be sent inline in a Send WQE */
595 u32 inline_buf_size;
597 /* Maximum number of buffer descriptors per Recv Queue */
598 u32 max_rq_depth;
600 /* The maximum number of completion queues supported per VF */
601 u32 max_cq;
603 /* Maximum number of CQEs per Completion Queue */
604 u32 max_cq_depth;
606 /* Number of sub-CQs to be created for each CQ */
607 u16 sub_cqs_per_cq;
609 /* MBZ */
610 u16 reserved;
612 /* Maximum number of SGEs (buffers) allowed for a single send WQE */
613 u16 max_wr_send_sges;
615 /* Maximum number of SGEs allowed for a single recv WQE */
616 u16 max_wr_recv_sges;
618 /* The maximum number of memory regions supported */
619 u32 max_mr;
621 /* The maximum number of pages can be registered */
622 u32 max_mr_pages;
624 /* The maximum number of protection domains supported */
625 u32 max_pd;
627 /* The maximum number of address handles supported */
628 u32 max_ah;
630 /* The maximum size of LLQ in bytes */
631 u32 max_llq_size;
633 /* Maximum number of SGEs for a single RDMA read WQE */
634 u16 max_wr_rdma_sges;
637 struct efa_admin_feature_aenq_desc {
638 /* bitmask for AENQ groups the device can report */
639 u32 supported_groups;
641 /* bitmask for AENQ groups to report */
642 u32 enabled_groups;
645 struct efa_admin_feature_network_attr_desc {
646 /* Raw address data in network byte order */
647 u8 addr[16];
649 /* max packet payload size in bytes */
650 u32 mtu;
654 * When hint value is 0, hints capabilities are not supported or driver
655 * should use its own predefined value
657 struct efa_admin_hw_hints {
658 /* value in ms */
659 u16 mmio_read_timeout;
661 /* value in ms */
662 u16 driver_watchdog_timeout;
664 /* value in ms */
665 u16 admin_completion_timeout;
667 /* poll interval in ms */
668 u16 poll_interval;
671 struct efa_admin_get_feature_cmd {
672 struct efa_admin_aq_common_desc aq_common_descriptor;
674 struct efa_admin_ctrl_buff_info control_buffer;
676 struct efa_admin_get_set_feature_common_desc feature_common;
678 u32 raw[11];
681 struct efa_admin_get_feature_resp {
682 struct efa_admin_acq_common_desc acq_common_desc;
684 union {
685 u32 raw[14];
687 struct efa_admin_feature_device_attr_desc device_attr;
689 struct efa_admin_feature_aenq_desc aenq;
691 struct efa_admin_feature_network_attr_desc network_attr;
693 struct efa_admin_feature_queue_attr_desc queue_attr;
695 struct efa_admin_hw_hints hw_hints;
696 } u;
699 struct efa_admin_set_feature_cmd {
700 struct efa_admin_aq_common_desc aq_common_descriptor;
702 struct efa_admin_ctrl_buff_info control_buffer;
704 struct efa_admin_get_set_feature_common_desc feature_common;
706 union {
707 u32 raw[11];
709 /* AENQ configuration */
710 struct efa_admin_feature_aenq_desc aenq;
711 } u;
714 struct efa_admin_set_feature_resp {
715 struct efa_admin_acq_common_desc acq_common_desc;
717 union {
718 u32 raw[14];
719 } u;
722 struct efa_admin_alloc_pd_cmd {
723 struct efa_admin_aq_common_desc aq_common_descriptor;
726 struct efa_admin_alloc_pd_resp {
727 struct efa_admin_acq_common_desc acq_common_desc;
729 /* PD number */
730 u16 pd;
732 /* MBZ */
733 u16 reserved;
736 struct efa_admin_dealloc_pd_cmd {
737 struct efa_admin_aq_common_desc aq_common_descriptor;
739 /* PD number */
740 u16 pd;
742 /* MBZ */
743 u16 reserved;
746 struct efa_admin_dealloc_pd_resp {
747 struct efa_admin_acq_common_desc acq_common_desc;
750 struct efa_admin_alloc_uar_cmd {
751 struct efa_admin_aq_common_desc aq_common_descriptor;
754 struct efa_admin_alloc_uar_resp {
755 struct efa_admin_acq_common_desc acq_common_desc;
757 /* UAR number */
758 u16 uar;
760 /* MBZ */
761 u16 reserved;
764 struct efa_admin_dealloc_uar_cmd {
765 struct efa_admin_aq_common_desc aq_common_descriptor;
767 /* UAR number */
768 u16 uar;
770 /* MBZ */
771 u16 reserved;
774 struct efa_admin_dealloc_uar_resp {
775 struct efa_admin_acq_common_desc acq_common_desc;
778 /* asynchronous event notification groups */
779 enum efa_admin_aenq_group {
780 EFA_ADMIN_FATAL_ERROR = 1,
781 EFA_ADMIN_WARNING = 2,
782 EFA_ADMIN_NOTIFICATION = 3,
783 EFA_ADMIN_KEEP_ALIVE = 4,
784 EFA_ADMIN_AENQ_GROUPS_NUM = 5,
787 enum efa_admin_aenq_notification_syndrom {
788 EFA_ADMIN_SUSPEND = 0,
789 EFA_ADMIN_RESUME = 1,
790 EFA_ADMIN_UPDATE_HINTS = 2,
793 struct efa_admin_mmio_req_read_less_resp {
794 u16 req_id;
796 u16 reg_off;
798 /* value is valid when poll is cleared */
799 u32 reg_val;
802 /* create_qp_cmd */
803 #define EFA_ADMIN_CREATE_QP_CMD_SQ_VIRT_MASK BIT(0)
804 #define EFA_ADMIN_CREATE_QP_CMD_RQ_VIRT_MASK BIT(1)
806 /* reg_mr_cmd */
807 #define EFA_ADMIN_REG_MR_CMD_PHYS_PAGE_SIZE_SHIFT_MASK GENMASK(4, 0)
808 #define EFA_ADMIN_REG_MR_CMD_MEM_ADDR_PHY_MODE_EN_MASK BIT(7)
809 #define EFA_ADMIN_REG_MR_CMD_LOCAL_WRITE_ENABLE_MASK BIT(0)
810 #define EFA_ADMIN_REG_MR_CMD_REMOTE_READ_ENABLE_MASK BIT(2)
812 /* create_cq_cmd */
813 #define EFA_ADMIN_CREATE_CQ_CMD_INTERRUPT_MODE_ENABLED_MASK BIT(5)
814 #define EFA_ADMIN_CREATE_CQ_CMD_VIRT_MASK BIT(6)
815 #define EFA_ADMIN_CREATE_CQ_CMD_CQ_ENTRY_SIZE_WORDS_MASK GENMASK(4, 0)
817 /* get_set_feature_common_desc */
818 #define EFA_ADMIN_GET_SET_FEATURE_COMMON_DESC_SELECT_MASK GENMASK(1, 0)
820 /* feature_device_attr_desc */
821 #define EFA_ADMIN_FEATURE_DEVICE_ATTR_DESC_RDMA_READ_MASK BIT(0)
823 #endif /* _EFA_ADMIN_CMDS_H_ */