xref: /linux/drivers/infiniband/hw/efa/efa_admin_cmds_defs.h (revision 08df80a3c51674ab73ae770885a383ca553fbbbf)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
2 /*
3  * Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All rights reserved.
4  */
5 
6 #ifndef _EFA_ADMIN_CMDS_H_
7 #define _EFA_ADMIN_CMDS_H_
8 
9 #define EFA_ADMIN_API_VERSION_MAJOR          0
10 #define EFA_ADMIN_API_VERSION_MINOR          1
11 
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_CREATE_EQ                         = 18,
32 	EFA_ADMIN_DESTROY_EQ                        = 19,
33 	EFA_ADMIN_MAX_OPCODE                        = 19,
34 };
35 
36 enum efa_admin_aq_feature_id {
37 	EFA_ADMIN_DEVICE_ATTR                       = 1,
38 	EFA_ADMIN_AENQ_CONFIG                       = 2,
39 	EFA_ADMIN_NETWORK_ATTR                      = 3,
40 	EFA_ADMIN_QUEUE_ATTR                        = 4,
41 	EFA_ADMIN_HW_HINTS                          = 5,
42 	EFA_ADMIN_HOST_INFO                         = 6,
43 	EFA_ADMIN_EVENT_QUEUE_ATTR                  = 7,
44 };
45 
46 /* QP transport type */
47 enum efa_admin_qp_type {
48 	/* Unreliable Datagram */
49 	EFA_ADMIN_QP_TYPE_UD                        = 1,
50 	/* Scalable Reliable Datagram */
51 	EFA_ADMIN_QP_TYPE_SRD                       = 2,
52 };
53 
54 /* QP state */
55 enum efa_admin_qp_state {
56 	EFA_ADMIN_QP_STATE_RESET                    = 0,
57 	EFA_ADMIN_QP_STATE_INIT                     = 1,
58 	EFA_ADMIN_QP_STATE_RTR                      = 2,
59 	EFA_ADMIN_QP_STATE_RTS                      = 3,
60 	EFA_ADMIN_QP_STATE_SQD                      = 4,
61 	EFA_ADMIN_QP_STATE_SQE                      = 5,
62 	EFA_ADMIN_QP_STATE_ERR                      = 6,
63 };
64 
65 enum efa_admin_get_stats_type {
66 	EFA_ADMIN_GET_STATS_TYPE_BASIC              = 0,
67 	EFA_ADMIN_GET_STATS_TYPE_MESSAGES           = 1,
68 	EFA_ADMIN_GET_STATS_TYPE_RDMA_READ          = 2,
69 	EFA_ADMIN_GET_STATS_TYPE_RDMA_WRITE         = 3,
70 };
71 
72 enum efa_admin_get_stats_scope {
73 	EFA_ADMIN_GET_STATS_SCOPE_ALL               = 0,
74 	EFA_ADMIN_GET_STATS_SCOPE_QUEUE             = 1,
75 };
76 
77 /*
78  * QP allocation sizes, converted by fabric QueuePair (QP) create command
79  * from QP capabilities.
80  */
81 struct efa_admin_qp_alloc_size {
82 	/* Send descriptor ring size in bytes */
83 	u32 send_queue_ring_size;
84 
85 	/* Max number of WQEs that can be outstanding on send queue. */
86 	u32 send_queue_depth;
87 
88 	/*
89 	 * Recv descriptor ring size in bytes, sufficient for user-provided
90 	 * number of WQEs
91 	 */
92 	u32 recv_queue_ring_size;
93 
94 	/* Max number of WQEs that can be outstanding on recv queue */
95 	u32 recv_queue_depth;
96 };
97 
98 struct efa_admin_create_qp_cmd {
99 	/* Common Admin Queue descriptor */
100 	struct efa_admin_aq_common_desc aq_common_desc;
101 
102 	/* Protection Domain associated with this QP */
103 	u16 pd;
104 
105 	/* QP type */
106 	u8 qp_type;
107 
108 	/*
109 	 * 0 : sq_virt - If set, SQ ring base address is
110 	 *    virtual (IOVA returned by MR registration)
111 	 * 1 : rq_virt - If set, RQ ring base address is
112 	 *    virtual (IOVA returned by MR registration)
113 	 * 7:2 : reserved - MBZ
114 	 */
115 	u8 flags;
116 
117 	/*
118 	 * Send queue (SQ) ring base physical address. This field is not
119 	 * used if this is a Low Latency Queue(LLQ).
120 	 */
121 	u64 sq_base_addr;
122 
123 	/* Receive queue (RQ) ring base address. */
124 	u64 rq_base_addr;
125 
126 	/* Index of CQ to be associated with Send Queue completions */
127 	u32 send_cq_idx;
128 
129 	/* Index of CQ to be associated with Recv Queue completions */
130 	u32 recv_cq_idx;
131 
132 	/*
133 	 * Memory registration key for the SQ ring, used only when not in
134 	 * LLQ mode and base address is virtual
135 	 */
136 	u32 sq_l_key;
137 
138 	/*
139 	 * Memory registration key for the RQ ring, used only when base
140 	 * address is virtual
141 	 */
142 	u32 rq_l_key;
143 
144 	/* Requested QP allocation sizes */
145 	struct efa_admin_qp_alloc_size qp_alloc_size;
146 
147 	/* UAR number */
148 	u16 uar;
149 
150 	/* MBZ */
151 	u16 reserved;
152 
153 	/* MBZ */
154 	u32 reserved2;
155 };
156 
157 struct efa_admin_create_qp_resp {
158 	/* Common Admin Queue completion descriptor */
159 	struct efa_admin_acq_common_desc acq_common_desc;
160 
161 	/*
162 	 * Opaque handle to be used for consequent admin operations on the
163 	 * QP
164 	 */
165 	u32 qp_handle;
166 
167 	/*
168 	 * QP number in the given EFA virtual device. Least-significant bits (as
169 	 * needed according to max_qp) carry unique QP ID
170 	 */
171 	u16 qp_num;
172 
173 	/* MBZ */
174 	u16 reserved;
175 
176 	/* Index of sub-CQ for Send Queue completions */
177 	u16 send_sub_cq_idx;
178 
179 	/* Index of sub-CQ for Receive Queue completions */
180 	u16 recv_sub_cq_idx;
181 
182 	/* SQ doorbell address, as offset to PCIe DB BAR */
183 	u32 sq_db_offset;
184 
185 	/* RQ doorbell address, as offset to PCIe DB BAR */
186 	u32 rq_db_offset;
187 
188 	/*
189 	 * low latency send queue ring base address as an offset to PCIe
190 	 * MMIO LLQ_MEM BAR
191 	 */
192 	u32 llq_descriptors_offset;
193 };
194 
195 struct efa_admin_modify_qp_cmd {
196 	/* Common Admin Queue descriptor */
197 	struct efa_admin_aq_common_desc aq_common_desc;
198 
199 	/*
200 	 * Mask indicating which fields should be updated
201 	 * 0 : qp_state
202 	 * 1 : cur_qp_state
203 	 * 2 : qkey
204 	 * 3 : sq_psn
205 	 * 4 : sq_drained_async_notify
206 	 * 5 : rnr_retry
207 	 * 31:6 : reserved
208 	 */
209 	u32 modify_mask;
210 
211 	/* QP handle returned by create_qp command */
212 	u32 qp_handle;
213 
214 	/* QP state */
215 	u32 qp_state;
216 
217 	/* Override current QP state (before applying the transition) */
218 	u32 cur_qp_state;
219 
220 	/* QKey */
221 	u32 qkey;
222 
223 	/* SQ PSN */
224 	u32 sq_psn;
225 
226 	/* Enable async notification when SQ is drained */
227 	u8 sq_drained_async_notify;
228 
229 	/* Number of RNR retries (valid only for SRD QPs) */
230 	u8 rnr_retry;
231 
232 	/* MBZ */
233 	u16 reserved2;
234 };
235 
236 struct efa_admin_modify_qp_resp {
237 	/* Common Admin Queue completion descriptor */
238 	struct efa_admin_acq_common_desc acq_common_desc;
239 };
240 
241 struct efa_admin_query_qp_cmd {
242 	/* Common Admin Queue descriptor */
243 	struct efa_admin_aq_common_desc aq_common_desc;
244 
245 	/* QP handle returned by create_qp command */
246 	u32 qp_handle;
247 };
248 
249 struct efa_admin_query_qp_resp {
250 	/* Common Admin Queue completion descriptor */
251 	struct efa_admin_acq_common_desc acq_common_desc;
252 
253 	/* QP state */
254 	u32 qp_state;
255 
256 	/* QKey */
257 	u32 qkey;
258 
259 	/* SQ PSN */
260 	u32 sq_psn;
261 
262 	/* Indicates that draining is in progress */
263 	u8 sq_draining;
264 
265 	/* Number of RNR retries (valid only for SRD QPs) */
266 	u8 rnr_retry;
267 
268 	/* MBZ */
269 	u16 reserved2;
270 };
271 
272 struct efa_admin_destroy_qp_cmd {
273 	/* Common Admin Queue descriptor */
274 	struct efa_admin_aq_common_desc aq_common_desc;
275 
276 	/* QP handle returned by create_qp command */
277 	u32 qp_handle;
278 };
279 
280 struct efa_admin_destroy_qp_resp {
281 	/* Common Admin Queue completion descriptor */
282 	struct efa_admin_acq_common_desc acq_common_desc;
283 };
284 
285 /*
286  * Create Address Handle command parameters. Must not be called more than
287  * once for the same destination
288  */
289 struct efa_admin_create_ah_cmd {
290 	/* Common Admin Queue descriptor */
291 	struct efa_admin_aq_common_desc aq_common_desc;
292 
293 	/* Destination address in network byte order */
294 	u8 dest_addr[16];
295 
296 	/* PD number */
297 	u16 pd;
298 
299 	/* MBZ */
300 	u16 reserved;
301 };
302 
303 struct efa_admin_create_ah_resp {
304 	/* Common Admin Queue completion descriptor */
305 	struct efa_admin_acq_common_desc acq_common_desc;
306 
307 	/* Target interface address handle (opaque) */
308 	u16 ah;
309 
310 	/* MBZ */
311 	u16 reserved;
312 };
313 
314 struct efa_admin_destroy_ah_cmd {
315 	/* Common Admin Queue descriptor */
316 	struct efa_admin_aq_common_desc aq_common_desc;
317 
318 	/* Target interface address handle (opaque) */
319 	u16 ah;
320 
321 	/* PD number */
322 	u16 pd;
323 };
324 
325 struct efa_admin_destroy_ah_resp {
326 	/* Common Admin Queue completion descriptor */
327 	struct efa_admin_acq_common_desc acq_common_desc;
328 };
329 
330 /*
331  * Registration of MemoryRegion, required for QP working with Virtual
332  * Addresses. In standard verbs semantics, region length is limited to 2GB
333  * space, but EFA offers larger MR support for large memory space, to ease
334  * on users working with very large datasets (i.e. full GPU memory mapping).
335  */
336 struct efa_admin_reg_mr_cmd {
337 	/* Common Admin Queue descriptor */
338 	struct efa_admin_aq_common_desc aq_common_desc;
339 
340 	/* Protection Domain */
341 	u16 pd;
342 
343 	/* MBZ */
344 	u16 reserved16_w1;
345 
346 	/* Physical Buffer List, each element is page-aligned. */
347 	union {
348 		/*
349 		 * Inline array of guest-physical page addresses of user
350 		 * memory pages (optimization for short region
351 		 * registrations)
352 		 */
353 		u64 inline_pbl_array[4];
354 
355 		/* points to PBL (direct or indirect, chained if needed) */
356 		struct efa_admin_ctrl_buff_info pbl;
357 	} pbl;
358 
359 	/* Memory region length, in bytes. */
360 	u64 mr_length;
361 
362 	/*
363 	 * flags and page size
364 	 * 4:0 : phys_page_size_shift - page size is (1 <<
365 	 *    phys_page_size_shift). Page size is used for
366 	 *    building the Virtual to Physical address mapping
367 	 * 6:5 : reserved - MBZ
368 	 * 7 : mem_addr_phy_mode_en - Enable bit for physical
369 	 *    memory registration (no translation), can be used
370 	 *    only by privileged clients. If set, PBL must
371 	 *    contain a single entry.
372 	 */
373 	u8 flags;
374 
375 	/*
376 	 * permissions
377 	 * 0 : local_write_enable - Local write permissions:
378 	 *    must be set for RQ buffers and buffers posted for
379 	 *    RDMA Read requests
380 	 * 1 : remote_write_enable - Remote write
381 	 *    permissions: must be set to enable RDMA write to
382 	 *    the region
383 	 * 2 : remote_read_enable - Remote read permissions:
384 	 *    must be set to enable RDMA read from the region
385 	 * 7:3 : reserved2 - MBZ
386 	 */
387 	u8 permissions;
388 
389 	/* MBZ */
390 	u16 reserved16_w5;
391 
392 	/* number of pages in PBL (redundant, could be calculated) */
393 	u32 page_num;
394 
395 	/*
396 	 * IO Virtual Address associated with this MR. If
397 	 * mem_addr_phy_mode_en is set, contains the physical address of
398 	 * the region.
399 	 */
400 	u64 iova;
401 };
402 
403 struct efa_admin_reg_mr_resp {
404 	/* Common Admin Queue completion descriptor */
405 	struct efa_admin_acq_common_desc acq_common_desc;
406 
407 	/*
408 	 * L_Key, to be used in conjunction with local buffer references in
409 	 * SQ and RQ WQE, or with virtual RQ/CQ rings
410 	 */
411 	u32 l_key;
412 
413 	/*
414 	 * R_Key, to be used in RDMA messages to refer to remotely accessed
415 	 * memory region
416 	 */
417 	u32 r_key;
418 
419 	/*
420 	 * Mask indicating which fields have valid values
421 	 * 0 : recv_ic_id
422 	 * 1 : rdma_read_ic_id
423 	 * 2 : rdma_recv_ic_id
424 	 */
425 	u8 validity;
426 
427 	/*
428 	 * Physical interconnect used by the device to reach the MR for receive
429 	 * operation
430 	 */
431 	u8 recv_ic_id;
432 
433 	/*
434 	 * Physical interconnect used by the device to reach the MR for RDMA
435 	 * read operation
436 	 */
437 	u8 rdma_read_ic_id;
438 
439 	/*
440 	 * Physical interconnect used by the device to reach the MR for RDMA
441 	 * write receive
442 	 */
443 	u8 rdma_recv_ic_id;
444 };
445 
446 struct efa_admin_dereg_mr_cmd {
447 	/* Common Admin Queue descriptor */
448 	struct efa_admin_aq_common_desc aq_common_desc;
449 
450 	/* L_Key, memory region's l_key */
451 	u32 l_key;
452 };
453 
454 struct efa_admin_dereg_mr_resp {
455 	/* Common Admin Queue completion descriptor */
456 	struct efa_admin_acq_common_desc acq_common_desc;
457 };
458 
459 struct efa_admin_create_cq_cmd {
460 	struct efa_admin_aq_common_desc aq_common_desc;
461 
462 	/*
463 	 * 4:0 : reserved5 - MBZ
464 	 * 5 : interrupt_mode_enabled - if set, cq operates
465 	 *    in interrupt mode (i.e. CQ events and EQ elements
466 	 *    are generated), otherwise - polling
467 	 * 6 : virt - If set, ring base address is virtual
468 	 *    (IOVA returned by MR registration)
469 	 * 7 : reserved6 - MBZ
470 	 */
471 	u8 cq_caps_1;
472 
473 	/*
474 	 * 4:0 : cq_entry_size_words - size of CQ entry in
475 	 *    32-bit words, valid values: 4, 8.
476 	 * 5 : set_src_addr - If set, source address will be
477 	 *    filled on RX completions from unknown senders.
478 	 *    Requires 8 words CQ entry size.
479 	 * 7:6 : reserved7 - MBZ
480 	 */
481 	u8 cq_caps_2;
482 
483 	/* completion queue depth in # of entries. must be power of 2 */
484 	u16 cq_depth;
485 
486 	/* EQ number assigned to this cq */
487 	u16 eqn;
488 
489 	/* MBZ */
490 	u16 reserved;
491 
492 	/*
493 	 * CQ ring base address, virtual or physical depending on 'virt'
494 	 * flag
495 	 */
496 	struct efa_common_mem_addr cq_ba;
497 
498 	/*
499 	 * Memory registration key for the ring, used only when base
500 	 * address is virtual
501 	 */
502 	u32 l_key;
503 
504 	/*
505 	 * number of sub cqs - must be equal to sub_cqs_per_cq of queue
506 	 * attributes.
507 	 */
508 	u16 num_sub_cqs;
509 
510 	/* UAR number */
511 	u16 uar;
512 };
513 
514 struct efa_admin_create_cq_resp {
515 	struct efa_admin_acq_common_desc acq_common_desc;
516 
517 	u16 cq_idx;
518 
519 	/* actual cq depth in number of entries */
520 	u16 cq_actual_depth;
521 
522 	/* CQ doorbell address, as offset to PCIe DB BAR */
523 	u32 db_offset;
524 
525 	/*
526 	 * 0 : db_valid - If set, doorbell offset is valid.
527 	 *    Always set when interrupts are requested.
528 	 */
529 	u32 flags;
530 };
531 
532 struct efa_admin_destroy_cq_cmd {
533 	struct efa_admin_aq_common_desc aq_common_desc;
534 
535 	u16 cq_idx;
536 
537 	/* MBZ */
538 	u16 reserved1;
539 };
540 
541 struct efa_admin_destroy_cq_resp {
542 	struct efa_admin_acq_common_desc acq_common_desc;
543 };
544 
545 /*
546  * EFA AQ Get Statistics command. Extended statistics are placed in control
547  * buffer pointed by AQ entry
548  */
549 struct efa_admin_aq_get_stats_cmd {
550 	struct efa_admin_aq_common_desc aq_common_descriptor;
551 
552 	union {
553 		/* command specific inline data */
554 		u32 inline_data_w1[3];
555 
556 		struct efa_admin_ctrl_buff_info control_buffer;
557 	} u;
558 
559 	/* stats type as defined in enum efa_admin_get_stats_type */
560 	u8 type;
561 
562 	/* stats scope defined in enum efa_admin_get_stats_scope */
563 	u8 scope;
564 
565 	u16 scope_modifier;
566 };
567 
568 struct efa_admin_basic_stats {
569 	u64 tx_bytes;
570 
571 	u64 tx_pkts;
572 
573 	u64 rx_bytes;
574 
575 	u64 rx_pkts;
576 
577 	u64 rx_drops;
578 };
579 
580 struct efa_admin_messages_stats {
581 	u64 send_bytes;
582 
583 	u64 send_wrs;
584 
585 	u64 recv_bytes;
586 
587 	u64 recv_wrs;
588 };
589 
590 struct efa_admin_rdma_read_stats {
591 	u64 read_wrs;
592 
593 	u64 read_bytes;
594 
595 	u64 read_wr_err;
596 
597 	u64 read_resp_bytes;
598 };
599 
600 struct efa_admin_rdma_write_stats {
601 	u64 write_wrs;
602 
603 	u64 write_bytes;
604 
605 	u64 write_wr_err;
606 
607 	u64 write_recv_bytes;
608 };
609 
610 struct efa_admin_acq_get_stats_resp {
611 	struct efa_admin_acq_common_desc acq_common_desc;
612 
613 	union {
614 		struct efa_admin_basic_stats basic_stats;
615 
616 		struct efa_admin_messages_stats messages_stats;
617 
618 		struct efa_admin_rdma_read_stats rdma_read_stats;
619 
620 		struct efa_admin_rdma_write_stats rdma_write_stats;
621 	} u;
622 };
623 
624 struct efa_admin_get_set_feature_common_desc {
625 	/* MBZ */
626 	u8 reserved0;
627 
628 	/* as appears in efa_admin_aq_feature_id */
629 	u8 feature_id;
630 
631 	/* MBZ */
632 	u16 reserved16;
633 };
634 
635 struct efa_admin_feature_device_attr_desc {
636 	/* Bitmap of efa_admin_aq_feature_id */
637 	u64 supported_features;
638 
639 	/* Bitmap of supported page sizes in MR registrations */
640 	u64 page_size_cap;
641 
642 	u32 fw_version;
643 
644 	u32 admin_api_version;
645 
646 	u32 device_version;
647 
648 	/* Bar used for SQ and RQ doorbells */
649 	u16 db_bar;
650 
651 	/* Indicates how many bits are used on physical address access */
652 	u8 phys_addr_width;
653 
654 	/* Indicates how many bits are used on virtual address access */
655 	u8 virt_addr_width;
656 
657 	/*
658 	 * 0 : rdma_read - If set, RDMA Read is supported on
659 	 *    TX queues
660 	 * 1 : rnr_retry - If set, RNR retry is supported on
661 	 *    modify QP command
662 	 * 2 : data_polling_128 - If set, 128 bytes data
663 	 *    polling is supported
664 	 * 3 : rdma_write - If set, RDMA Write is supported
665 	 *    on TX queues
666 	 * 31:4 : reserved - MBZ
667 	 */
668 	u32 device_caps;
669 
670 	/* Max RDMA transfer size in bytes */
671 	u32 max_rdma_size;
672 };
673 
674 struct efa_admin_feature_queue_attr_desc {
675 	/* The maximum number of queue pairs supported */
676 	u32 max_qp;
677 
678 	/* Maximum number of WQEs per Send Queue */
679 	u32 max_sq_depth;
680 
681 	/* Maximum size of data that can be sent inline in a Send WQE */
682 	u32 inline_buf_size;
683 
684 	/* Maximum number of buffer descriptors per Recv Queue */
685 	u32 max_rq_depth;
686 
687 	/* The maximum number of completion queues supported per VF */
688 	u32 max_cq;
689 
690 	/* Maximum number of CQEs per Completion Queue */
691 	u32 max_cq_depth;
692 
693 	/* Number of sub-CQs to be created for each CQ */
694 	u16 sub_cqs_per_cq;
695 
696 	/* Minimum number of WQEs per SQ */
697 	u16 min_sq_depth;
698 
699 	/* Maximum number of SGEs (buffers) allowed for a single send WQE */
700 	u16 max_wr_send_sges;
701 
702 	/* Maximum number of SGEs allowed for a single recv WQE */
703 	u16 max_wr_recv_sges;
704 
705 	/* The maximum number of memory regions supported */
706 	u32 max_mr;
707 
708 	/* The maximum number of pages can be registered */
709 	u32 max_mr_pages;
710 
711 	/* The maximum number of protection domains supported */
712 	u32 max_pd;
713 
714 	/* The maximum number of address handles supported */
715 	u32 max_ah;
716 
717 	/* The maximum size of LLQ in bytes */
718 	u32 max_llq_size;
719 
720 	/* Maximum number of SGEs for a single RDMA read/write WQE */
721 	u16 max_wr_rdma_sges;
722 
723 	/*
724 	 * Maximum number of bytes that can be written to SQ between two
725 	 * consecutive doorbells (in units of 64B). Driver must ensure that only
726 	 * complete WQEs are written to queue before issuing a doorbell.
727 	 * Examples: max_tx_batch=16 and WQE size = 64B, means up to 16 WQEs can
728 	 * be written to SQ between two consecutive doorbells. max_tx_batch=11
729 	 * and WQE size = 128B, means up to 5 WQEs can be written to SQ between
730 	 * two consecutive doorbells. Zero means unlimited.
731 	 */
732 	u16 max_tx_batch;
733 };
734 
735 struct efa_admin_event_queue_attr_desc {
736 	/* The maximum number of event queues supported */
737 	u32 max_eq;
738 
739 	/* Maximum number of EQEs per Event Queue */
740 	u32 max_eq_depth;
741 
742 	/* Supported events bitmask */
743 	u32 event_bitmask;
744 };
745 
746 struct efa_admin_feature_aenq_desc {
747 	/* bitmask for AENQ groups the device can report */
748 	u32 supported_groups;
749 
750 	/* bitmask for AENQ groups to report */
751 	u32 enabled_groups;
752 };
753 
754 struct efa_admin_feature_network_attr_desc {
755 	/* Raw address data in network byte order */
756 	u8 addr[16];
757 
758 	/* max packet payload size in bytes */
759 	u32 mtu;
760 };
761 
762 /*
763  * When hint value is 0, hints capabilities are not supported or driver
764  * should use its own predefined value
765  */
766 struct efa_admin_hw_hints {
767 	/* value in ms */
768 	u16 mmio_read_timeout;
769 
770 	/* value in ms */
771 	u16 driver_watchdog_timeout;
772 
773 	/* value in ms */
774 	u16 admin_completion_timeout;
775 
776 	/* poll interval in ms */
777 	u16 poll_interval;
778 };
779 
780 struct efa_admin_get_feature_cmd {
781 	struct efa_admin_aq_common_desc aq_common_descriptor;
782 
783 	struct efa_admin_ctrl_buff_info control_buffer;
784 
785 	struct efa_admin_get_set_feature_common_desc feature_common;
786 
787 	u32 raw[11];
788 };
789 
790 struct efa_admin_get_feature_resp {
791 	struct efa_admin_acq_common_desc acq_common_desc;
792 
793 	union {
794 		u32 raw[14];
795 
796 		struct efa_admin_feature_device_attr_desc device_attr;
797 
798 		struct efa_admin_feature_aenq_desc aenq;
799 
800 		struct efa_admin_feature_network_attr_desc network_attr;
801 
802 		struct efa_admin_feature_queue_attr_desc queue_attr;
803 
804 		struct efa_admin_event_queue_attr_desc event_queue_attr;
805 
806 		struct efa_admin_hw_hints hw_hints;
807 	} u;
808 };
809 
810 struct efa_admin_set_feature_cmd {
811 	struct efa_admin_aq_common_desc aq_common_descriptor;
812 
813 	struct efa_admin_ctrl_buff_info control_buffer;
814 
815 	struct efa_admin_get_set_feature_common_desc feature_common;
816 
817 	union {
818 		u32 raw[11];
819 
820 		/* AENQ configuration */
821 		struct efa_admin_feature_aenq_desc aenq;
822 	} u;
823 };
824 
825 struct efa_admin_set_feature_resp {
826 	struct efa_admin_acq_common_desc acq_common_desc;
827 
828 	union {
829 		u32 raw[14];
830 	} u;
831 };
832 
833 struct efa_admin_alloc_pd_cmd {
834 	struct efa_admin_aq_common_desc aq_common_descriptor;
835 };
836 
837 struct efa_admin_alloc_pd_resp {
838 	struct efa_admin_acq_common_desc acq_common_desc;
839 
840 	/* PD number */
841 	u16 pd;
842 
843 	/* MBZ */
844 	u16 reserved;
845 };
846 
847 struct efa_admin_dealloc_pd_cmd {
848 	struct efa_admin_aq_common_desc aq_common_descriptor;
849 
850 	/* PD number */
851 	u16 pd;
852 
853 	/* MBZ */
854 	u16 reserved;
855 };
856 
857 struct efa_admin_dealloc_pd_resp {
858 	struct efa_admin_acq_common_desc acq_common_desc;
859 };
860 
861 struct efa_admin_alloc_uar_cmd {
862 	struct efa_admin_aq_common_desc aq_common_descriptor;
863 };
864 
865 struct efa_admin_alloc_uar_resp {
866 	struct efa_admin_acq_common_desc acq_common_desc;
867 
868 	/* UAR number */
869 	u16 uar;
870 
871 	/* MBZ */
872 	u16 reserved;
873 };
874 
875 struct efa_admin_dealloc_uar_cmd {
876 	struct efa_admin_aq_common_desc aq_common_descriptor;
877 
878 	/* UAR number */
879 	u16 uar;
880 
881 	/* MBZ */
882 	u16 reserved;
883 };
884 
885 struct efa_admin_dealloc_uar_resp {
886 	struct efa_admin_acq_common_desc acq_common_desc;
887 };
888 
889 struct efa_admin_create_eq_cmd {
890 	struct efa_admin_aq_common_desc aq_common_descriptor;
891 
892 	/* Size of the EQ in entries, must be power of 2 */
893 	u16 depth;
894 
895 	/* MSI-X table entry index */
896 	u8 msix_vec;
897 
898 	/*
899 	 * 4:0 : entry_size_words - size of EQ entry in
900 	 *    32-bit words
901 	 * 7:5 : reserved - MBZ
902 	 */
903 	u8 caps;
904 
905 	/* EQ ring base address */
906 	struct efa_common_mem_addr ba;
907 
908 	/*
909 	 * Enabled events on this EQ
910 	 * 0 : completion_events - Enable completion events
911 	 * 31:1 : reserved - MBZ
912 	 */
913 	u32 event_bitmask;
914 
915 	/* MBZ */
916 	u32 reserved;
917 };
918 
919 struct efa_admin_create_eq_resp {
920 	struct efa_admin_acq_common_desc acq_common_desc;
921 
922 	/* EQ number */
923 	u16 eqn;
924 
925 	/* MBZ */
926 	u16 reserved;
927 };
928 
929 struct efa_admin_destroy_eq_cmd {
930 	struct efa_admin_aq_common_desc aq_common_descriptor;
931 
932 	/* EQ number */
933 	u16 eqn;
934 
935 	/* MBZ */
936 	u16 reserved;
937 };
938 
939 struct efa_admin_destroy_eq_resp {
940 	struct efa_admin_acq_common_desc acq_common_desc;
941 };
942 
943 /* asynchronous event notification groups */
944 enum efa_admin_aenq_group {
945 	EFA_ADMIN_FATAL_ERROR                       = 1,
946 	EFA_ADMIN_WARNING                           = 2,
947 	EFA_ADMIN_NOTIFICATION                      = 3,
948 	EFA_ADMIN_KEEP_ALIVE                        = 4,
949 	EFA_ADMIN_AENQ_GROUPS_NUM                   = 5,
950 };
951 
952 struct efa_admin_mmio_req_read_less_resp {
953 	u16 req_id;
954 
955 	u16 reg_off;
956 
957 	/* value is valid when poll is cleared */
958 	u32 reg_val;
959 };
960 
961 enum efa_admin_os_type {
962 	EFA_ADMIN_OS_LINUX                          = 0,
963 };
964 
965 struct efa_admin_host_info {
966 	/* OS distribution string format */
967 	u8 os_dist_str[128];
968 
969 	/* Defined in enum efa_admin_os_type */
970 	u32 os_type;
971 
972 	/* Kernel version string format */
973 	u8 kernel_ver_str[32];
974 
975 	/* Kernel version numeric format */
976 	u32 kernel_ver;
977 
978 	/*
979 	 * 7:0 : driver_module_type
980 	 * 15:8 : driver_sub_minor
981 	 * 23:16 : driver_minor
982 	 * 31:24 : driver_major
983 	 */
984 	u32 driver_ver;
985 
986 	/*
987 	 * Device's Bus, Device and Function
988 	 * 2:0 : function
989 	 * 7:3 : device
990 	 * 15:8 : bus
991 	 */
992 	u16 bdf;
993 
994 	/*
995 	 * Spec version
996 	 * 7:0 : spec_minor
997 	 * 15:8 : spec_major
998 	 */
999 	u16 spec_ver;
1000 
1001 	/*
1002 	 * 0 : intree - Intree driver
1003 	 * 1 : gdr - GPUDirect RDMA supported
1004 	 * 31:2 : reserved2
1005 	 */
1006 	u32 flags;
1007 };
1008 
1009 /* create_qp_cmd */
1010 #define EFA_ADMIN_CREATE_QP_CMD_SQ_VIRT_MASK                BIT(0)
1011 #define EFA_ADMIN_CREATE_QP_CMD_RQ_VIRT_MASK                BIT(1)
1012 
1013 /* modify_qp_cmd */
1014 #define EFA_ADMIN_MODIFY_QP_CMD_QP_STATE_MASK               BIT(0)
1015 #define EFA_ADMIN_MODIFY_QP_CMD_CUR_QP_STATE_MASK           BIT(1)
1016 #define EFA_ADMIN_MODIFY_QP_CMD_QKEY_MASK                   BIT(2)
1017 #define EFA_ADMIN_MODIFY_QP_CMD_SQ_PSN_MASK                 BIT(3)
1018 #define EFA_ADMIN_MODIFY_QP_CMD_SQ_DRAINED_ASYNC_NOTIFY_MASK BIT(4)
1019 #define EFA_ADMIN_MODIFY_QP_CMD_RNR_RETRY_MASK              BIT(5)
1020 
1021 /* reg_mr_cmd */
1022 #define EFA_ADMIN_REG_MR_CMD_PHYS_PAGE_SIZE_SHIFT_MASK      GENMASK(4, 0)
1023 #define EFA_ADMIN_REG_MR_CMD_MEM_ADDR_PHY_MODE_EN_MASK      BIT(7)
1024 #define EFA_ADMIN_REG_MR_CMD_LOCAL_WRITE_ENABLE_MASK        BIT(0)
1025 #define EFA_ADMIN_REG_MR_CMD_REMOTE_WRITE_ENABLE_MASK       BIT(1)
1026 #define EFA_ADMIN_REG_MR_CMD_REMOTE_READ_ENABLE_MASK        BIT(2)
1027 
1028 /* reg_mr_resp */
1029 #define EFA_ADMIN_REG_MR_RESP_RECV_IC_ID_MASK               BIT(0)
1030 #define EFA_ADMIN_REG_MR_RESP_RDMA_READ_IC_ID_MASK          BIT(1)
1031 #define EFA_ADMIN_REG_MR_RESP_RDMA_RECV_IC_ID_MASK          BIT(2)
1032 
1033 /* create_cq_cmd */
1034 #define EFA_ADMIN_CREATE_CQ_CMD_INTERRUPT_MODE_ENABLED_MASK BIT(5)
1035 #define EFA_ADMIN_CREATE_CQ_CMD_VIRT_MASK                   BIT(6)
1036 #define EFA_ADMIN_CREATE_CQ_CMD_CQ_ENTRY_SIZE_WORDS_MASK    GENMASK(4, 0)
1037 #define EFA_ADMIN_CREATE_CQ_CMD_SET_SRC_ADDR_MASK           BIT(5)
1038 
1039 /* create_cq_resp */
1040 #define EFA_ADMIN_CREATE_CQ_RESP_DB_VALID_MASK              BIT(0)
1041 
1042 /* feature_device_attr_desc */
1043 #define EFA_ADMIN_FEATURE_DEVICE_ATTR_DESC_RDMA_READ_MASK   BIT(0)
1044 #define EFA_ADMIN_FEATURE_DEVICE_ATTR_DESC_RNR_RETRY_MASK   BIT(1)
1045 #define EFA_ADMIN_FEATURE_DEVICE_ATTR_DESC_DATA_POLLING_128_MASK BIT(2)
1046 #define EFA_ADMIN_FEATURE_DEVICE_ATTR_DESC_RDMA_WRITE_MASK  BIT(3)
1047 
1048 /* create_eq_cmd */
1049 #define EFA_ADMIN_CREATE_EQ_CMD_ENTRY_SIZE_WORDS_MASK       GENMASK(4, 0)
1050 #define EFA_ADMIN_CREATE_EQ_CMD_VIRT_MASK                   BIT(6)
1051 #define EFA_ADMIN_CREATE_EQ_CMD_COMPLETION_EVENTS_MASK      BIT(0)
1052 
1053 /* host_info */
1054 #define EFA_ADMIN_HOST_INFO_DRIVER_MODULE_TYPE_MASK         GENMASK(7, 0)
1055 #define EFA_ADMIN_HOST_INFO_DRIVER_SUB_MINOR_MASK           GENMASK(15, 8)
1056 #define EFA_ADMIN_HOST_INFO_DRIVER_MINOR_MASK               GENMASK(23, 16)
1057 #define EFA_ADMIN_HOST_INFO_DRIVER_MAJOR_MASK               GENMASK(31, 24)
1058 #define EFA_ADMIN_HOST_INFO_FUNCTION_MASK                   GENMASK(2, 0)
1059 #define EFA_ADMIN_HOST_INFO_DEVICE_MASK                     GENMASK(7, 3)
1060 #define EFA_ADMIN_HOST_INFO_BUS_MASK                        GENMASK(15, 8)
1061 #define EFA_ADMIN_HOST_INFO_SPEC_MINOR_MASK                 GENMASK(7, 0)
1062 #define EFA_ADMIN_HOST_INFO_SPEC_MAJOR_MASK                 GENMASK(15, 8)
1063 #define EFA_ADMIN_HOST_INFO_INTREE_MASK                     BIT(0)
1064 #define EFA_ADMIN_HOST_INFO_GDR_MASK                        BIT(1)
1065 
1066 #endif /* _EFA_ADMIN_CMDS_H_ */
1067