Linux Audio

Check our new training course

Yocto / OpenEmbedded training

Feb 10-13, 2025
Register
Loading...
v6.8
   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 */
  13enum 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
  36enum 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 */
  47enum 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 */
  55enum 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
  65enum 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
  72enum 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 */
  81struct 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
  98struct 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
 157struct 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
 195struct 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
 236struct efa_admin_modify_qp_resp {
 237	/* Common Admin Queue completion descriptor */
 238	struct efa_admin_acq_common_desc acq_common_desc;
 239};
 240
 241struct 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
 249struct 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
 272struct 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
 280struct 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 */
 289struct 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
 303struct 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
 314struct 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
 325struct 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 */
 336struct 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
 403struct 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
 446struct 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
 454struct efa_admin_dereg_mr_resp {
 455	/* Common Admin Queue completion descriptor */
 456	struct efa_admin_acq_common_desc acq_common_desc;
 457};
 458
 459struct 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
 514struct 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
 532struct 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
 541struct 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 */
 549struct 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
 568struct 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
 580struct 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
 590struct 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
 600struct 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
 610struct 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
 624struct 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
 635struct 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
 674struct 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
 735struct 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
 746struct 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
 754struct 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 */
 766struct 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
 780struct 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
 790struct 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
 810struct 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
 825struct 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
 833struct efa_admin_alloc_pd_cmd {
 834	struct efa_admin_aq_common_desc aq_common_descriptor;
 835};
 836
 837struct 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
 847struct 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
 857struct efa_admin_dealloc_pd_resp {
 858	struct efa_admin_acq_common_desc acq_common_desc;
 859};
 860
 861struct efa_admin_alloc_uar_cmd {
 862	struct efa_admin_aq_common_desc aq_common_descriptor;
 863};
 864
 865struct 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
 875struct 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
 885struct efa_admin_dealloc_uar_resp {
 886	struct efa_admin_acq_common_desc acq_common_desc;
 887};
 888
 889struct 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
 919struct 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
 929struct 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
 939struct efa_admin_destroy_eq_resp {
 940	struct efa_admin_acq_common_desc acq_common_desc;
 941};
 942
 943/* asynchronous event notification groups */
 944enum 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
 
 
 
 
 
 
 952struct 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
 961enum efa_admin_os_type {
 962	EFA_ADMIN_OS_LINUX                          = 0,
 963};
 964
 965struct 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_ */
v5.4
  1/* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
  2/*
  3 * Copyright 2018-2019 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 */
 13enum 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,
 
 
 32};
 33
 34enum 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,
 
 41};
 42
 43/* QP transport type */
 44enum 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,
 49};
 50
 51/* QP state */
 52enum 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,
 60};
 61
 62enum efa_admin_get_stats_type {
 63	EFA_ADMIN_GET_STATS_TYPE_BASIC              = 0,
 
 
 
 64};
 65
 66enum efa_admin_get_stats_scope {
 67	EFA_ADMIN_GET_STATS_SCOPE_ALL               = 0,
 68	EFA_ADMIN_GET_STATS_SCOPE_QUEUE             = 1,
 69};
 70
 71enum 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,
 77};
 78
 79/*
 80 * QP allocation sizes, converted by fabric QueuePair (QP) create command
 81 * from QP capabilities.
 82 */
 83struct efa_admin_qp_alloc_size {
 84	/* Send descriptor ring size in bytes */
 85	u32 send_queue_ring_size;
 86
 87	/* Max number of WQEs that can be outstanding on send queue. */
 88	u32 send_queue_depth;
 89
 90	/*
 91	 * Recv descriptor ring size in bytes, sufficient for user-provided
 92	 * number of WQEs
 93	 */
 94	u32 recv_queue_ring_size;
 95
 96	/* Max number of WQEs that can be outstanding on recv queue */
 97	u32 recv_queue_depth;
 98};
 99
100struct efa_admin_create_qp_cmd {
101	/* Common Admin Queue descriptor */
102	struct efa_admin_aq_common_desc aq_common_desc;
103
104	/* Protection Domain associated with this QP */
105	u16 pd;
106
107	/* QP type */
108	u8 qp_type;
109
110	/*
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
116	 */
117	u8 flags;
118
119	/*
120	 * Send queue (SQ) ring base physical address. This field is not
121	 * used if this is a Low Latency Queue(LLQ).
122	 */
123	u64 sq_base_addr;
124
125	/* Receive queue (RQ) ring base address. */
126	u64 rq_base_addr;
127
128	/* Index of CQ to be associated with Send Queue completions */
129	u32 send_cq_idx;
130
131	/* Index of CQ to be associated with Recv Queue completions */
132	u32 recv_cq_idx;
133
134	/*
135	 * Memory registration key for the SQ ring, used only when not in
136	 * LLQ mode and base address is virtual
137	 */
138	u32 sq_l_key;
139
140	/*
141	 * Memory registration key for the RQ ring, used only when base
142	 * address is virtual
143	 */
144	u32 rq_l_key;
145
146	/* Requested QP allocation sizes */
147	struct efa_admin_qp_alloc_size qp_alloc_size;
148
149	/* UAR number */
150	u16 uar;
151
152	/* MBZ */
153	u16 reserved;
154
155	/* MBZ */
156	u32 reserved2;
157};
158
159struct efa_admin_create_qp_resp {
160	/* Common Admin Queue completion descriptor */
161	struct efa_admin_acq_common_desc acq_common_desc;
162
163	/* Opaque handle to be used for consequent operations on the QP */
 
 
 
164	u32 qp_handle;
165
166	/* QP number in the given EFA virtual device */
 
 
 
167	u16 qp_num;
168
169	/* MBZ */
170	u16 reserved;
171
172	/* Index of sub-CQ for Send Queue completions */
173	u16 send_sub_cq_idx;
174
175	/* Index of sub-CQ for Receive Queue completions */
176	u16 recv_sub_cq_idx;
177
178	/* SQ doorbell address, as offset to PCIe DB BAR */
179	u32 sq_db_offset;
180
181	/* RQ doorbell address, as offset to PCIe DB BAR */
182	u32 rq_db_offset;
183
184	/*
185	 * low latency send queue ring base address as an offset to PCIe
186	 * MMIO LLQ_MEM BAR
187	 */
188	u32 llq_descriptors_offset;
189};
190
191struct efa_admin_modify_qp_cmd {
192	/* Common Admin Queue descriptor */
193	struct efa_admin_aq_common_desc aq_common_desc;
194
195	/*
196	 * Mask indicating which fields should be updated see enum
197	 * efa_admin_modify_qp_mask_bits
 
 
 
 
 
 
198	 */
199	u32 modify_mask;
200
201	/* QP handle returned by create_qp command */
202	u32 qp_handle;
203
204	/* QP state */
205	u32 qp_state;
206
207	/* Override current QP state (before applying the transition) */
208	u32 cur_qp_state;
209
210	/* QKey */
211	u32 qkey;
212
213	/* SQ PSN */
214	u32 sq_psn;
215
216	/* Enable async notification when SQ is drained */
217	u8 sq_drained_async_notify;
218
219	/* MBZ */
220	u8 reserved1;
221
222	/* MBZ */
223	u16 reserved2;
224};
225
226struct efa_admin_modify_qp_resp {
227	/* Common Admin Queue completion descriptor */
228	struct efa_admin_acq_common_desc acq_common_desc;
229};
230
231struct efa_admin_query_qp_cmd {
232	/* Common Admin Queue descriptor */
233	struct efa_admin_aq_common_desc aq_common_desc;
234
235	/* QP handle returned by create_qp command */
236	u32 qp_handle;
237};
238
239struct efa_admin_query_qp_resp {
240	/* Common Admin Queue completion descriptor */
241	struct efa_admin_acq_common_desc acq_common_desc;
242
243	/* QP state */
244	u32 qp_state;
245
246	/* QKey */
247	u32 qkey;
248
249	/* SQ PSN */
250	u32 sq_psn;
251
252	/* Indicates that draining is in progress */
253	u8 sq_draining;
254
255	/* MBZ */
256	u8 reserved1;
257
258	/* MBZ */
259	u16 reserved2;
260};
261
262struct efa_admin_destroy_qp_cmd {
263	/* Common Admin Queue descriptor */
264	struct efa_admin_aq_common_desc aq_common_desc;
265
266	/* QP handle returned by create_qp command */
267	u32 qp_handle;
268};
269
270struct efa_admin_destroy_qp_resp {
271	/* Common Admin Queue completion descriptor */
272	struct efa_admin_acq_common_desc acq_common_desc;
273};
274
275/*
276 * Create Address Handle command parameters. Must not be called more than
277 * once for the same destination
278 */
279struct efa_admin_create_ah_cmd {
280	/* Common Admin Queue descriptor */
281	struct efa_admin_aq_common_desc aq_common_desc;
282
283	/* Destination address in network byte order */
284	u8 dest_addr[16];
285
286	/* PD number */
287	u16 pd;
288
 
289	u16 reserved;
290};
291
292struct efa_admin_create_ah_resp {
293	/* Common Admin Queue completion descriptor */
294	struct efa_admin_acq_common_desc acq_common_desc;
295
296	/* Target interface address handle (opaque) */
297	u16 ah;
298
 
299	u16 reserved;
300};
301
302struct efa_admin_destroy_ah_cmd {
303	/* Common Admin Queue descriptor */
304	struct efa_admin_aq_common_desc aq_common_desc;
305
306	/* Target interface address handle (opaque) */
307	u16 ah;
308
309	/* PD number */
310	u16 pd;
311};
312
313struct efa_admin_destroy_ah_resp {
314	/* Common Admin Queue completion descriptor */
315	struct efa_admin_acq_common_desc acq_common_desc;
316};
317
318/*
319 * Registration of MemoryRegion, required for QP working with Virtual
320 * Addresses. In standard verbs semantics, region length is limited to 2GB
321 * space, but EFA offers larger MR support for large memory space, to ease
322 * on users working with very large datasets (i.e. full GPU memory mapping).
323 */
324struct efa_admin_reg_mr_cmd {
325	/* Common Admin Queue descriptor */
326	struct efa_admin_aq_common_desc aq_common_desc;
327
328	/* Protection Domain */
329	u16 pd;
330
331	/* MBZ */
332	u16 reserved16_w1;
333
334	/* Physical Buffer List, each element is page-aligned. */
335	union {
336		/*
337		 * Inline array of guest-physical page addresses of user
338		 * memory pages (optimization for short region
339		 * registrations)
340		 */
341		u64 inline_pbl_array[4];
342
343		/* points to PBL (direct or indirect, chained if needed) */
344		struct efa_admin_ctrl_buff_info pbl;
345	} pbl;
346
347	/* Memory region length, in bytes. */
348	u64 mr_length;
349
350	/*
351	 * flags and page size
352	 * 4:0 : phys_page_size_shift - page size is (1 <<
353	 *    phys_page_size_shift). Page size is used for
354	 *    building the Virtual to Physical address mapping
355	 * 6:5 : reserved - MBZ
356	 * 7 : mem_addr_phy_mode_en - Enable bit for physical
357	 *    memory registration (no translation), can be used
358	 *    only by privileged clients. If set, PBL must
359	 *    contain a single entry.
360	 */
361	u8 flags;
362
363	/*
364	 * permissions
365	 * 0 : local_write_enable - Write permissions: value
366	 *    of 1 needed for RQ buffers and for RDMA write
367	 * 7:1 : reserved1 - remote access flags, etc
 
 
 
 
 
 
368	 */
369	u8 permissions;
370
 
371	u16 reserved16_w5;
372
373	/* number of pages in PBL (redundant, could be calculated) */
374	u32 page_num;
375
376	/*
377	 * IO Virtual Address associated with this MR. If
378	 * mem_addr_phy_mode_en is set, contains the physical address of
379	 * the region.
380	 */
381	u64 iova;
382};
383
384struct efa_admin_reg_mr_resp {
385	/* Common Admin Queue completion descriptor */
386	struct efa_admin_acq_common_desc acq_common_desc;
387
388	/*
389	 * L_Key, to be used in conjunction with local buffer references in
390	 * SQ and RQ WQE, or with virtual RQ/CQ rings
391	 */
392	u32 l_key;
393
394	/*
395	 * R_Key, to be used in RDMA messages to refer to remotely accessed
396	 * memory region
397	 */
398	u32 r_key;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
399};
400
401struct efa_admin_dereg_mr_cmd {
402	/* Common Admin Queue descriptor */
403	struct efa_admin_aq_common_desc aq_common_desc;
404
405	/* L_Key, memory region's l_key */
406	u32 l_key;
407};
408
409struct efa_admin_dereg_mr_resp {
410	/* Common Admin Queue completion descriptor */
411	struct efa_admin_acq_common_desc acq_common_desc;
412};
413
414struct efa_admin_create_cq_cmd {
415	struct efa_admin_aq_common_desc aq_common_desc;
416
417	/*
418	 * 4:0 : reserved5
419	 * 5 : interrupt_mode_enabled - if set, cq operates
420	 *    in interrupt mode (i.e. CQ events and MSI-X are
421	 *    generated), otherwise - polling
422	 * 6 : virt - If set, ring base address is virtual
423	 *    (IOVA returned by MR registration)
424	 * 7 : reserved6
425	 */
426	u8 cq_caps_1;
427
428	/*
429	 * 4:0 : cq_entry_size_words - size of CQ entry in
430	 *    32-bit words, valid values: 4, 8.
431	 * 7:5 : reserved7
 
 
 
432	 */
433	u8 cq_caps_2;
434
435	/* completion queue depth in # of entries. must be power of 2 */
436	u16 cq_depth;
437
438	/* msix vector assigned to this cq */
439	u32 msix_vector_idx;
 
 
 
440
441	/*
442	 * CQ ring base address, virtual or physical depending on 'virt'
443	 * flag
444	 */
445	struct efa_common_mem_addr cq_ba;
446
447	/*
448	 * Memory registration key for the ring, used only when base
449	 * address is virtual
450	 */
451	u32 l_key;
452
453	/*
454	 * number of sub cqs - must be equal to sub_cqs_per_cq of queue
455	 *    attributes.
456	 */
457	u16 num_sub_cqs;
458
459	/* UAR number */
460	u16 uar;
461};
462
463struct efa_admin_create_cq_resp {
464	struct efa_admin_acq_common_desc acq_common_desc;
465
466	u16 cq_idx;
467
468	/* actual cq depth in number of entries */
469	u16 cq_actual_depth;
 
 
 
 
 
 
 
 
 
470};
471
472struct efa_admin_destroy_cq_cmd {
473	struct efa_admin_aq_common_desc aq_common_desc;
474
475	u16 cq_idx;
476
 
477	u16 reserved1;
478};
479
480struct efa_admin_destroy_cq_resp {
481	struct efa_admin_acq_common_desc acq_common_desc;
482};
483
484/*
485 * EFA AQ Get Statistics command. Extended statistics are placed in control
486 * buffer pointed by AQ entry
487 */
488struct efa_admin_aq_get_stats_cmd {
489	struct efa_admin_aq_common_desc aq_common_descriptor;
490
491	union {
492		/* command specific inline data */
493		u32 inline_data_w1[3];
494
495		struct efa_admin_ctrl_buff_info control_buffer;
496	} u;
497
498	/* stats type as defined in enum efa_admin_get_stats_type */
499	u8 type;
500
501	/* stats scope defined in enum efa_admin_get_stats_scope */
502	u8 scope;
503
504	u16 scope_modifier;
505};
506
507struct efa_admin_basic_stats {
508	u64 tx_bytes;
509
510	u64 tx_pkts;
511
512	u64 rx_bytes;
513
514	u64 rx_pkts;
515
516	u64 rx_drops;
517};
518
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
519struct efa_admin_acq_get_stats_resp {
520	struct efa_admin_acq_common_desc acq_common_desc;
521
522	struct efa_admin_basic_stats basic_stats;
 
 
 
 
 
 
 
 
523};
524
525struct efa_admin_get_set_feature_common_desc {
526	/*
527	 * 1:0 : select - 0x1 - current value; 0x3 - default
528	 *    value
529	 * 7:3 : reserved3
530	 */
531	u8 flags;
532
533	/* as appears in efa_admin_aq_feature_id */
534	u8 feature_id;
535
536	/* MBZ */
537	u16 reserved16;
538};
539
540struct efa_admin_feature_device_attr_desc {
541	/* Bitmap of efa_admin_aq_feature_id */
542	u64 supported_features;
543
544	/* Bitmap of supported page sizes in MR registrations */
545	u64 page_size_cap;
546
547	u32 fw_version;
548
549	u32 admin_api_version;
550
551	u32 device_version;
552
553	/* Bar used for SQ and RQ doorbells */
554	u16 db_bar;
555
556	/* Indicates how many bits are used physical address access */
557	u8 phys_addr_width;
558
559	/* Indicates how many bits are used virtual address access */
560	u8 virt_addr_width;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
561};
562
563struct efa_admin_feature_queue_attr_desc {
564	/* The maximum number of queue pairs supported */
565	u32 max_qp;
566
 
567	u32 max_sq_depth;
568
569	/* max send wr used in inline-buf */
570	u32 inline_buf_size;
571
 
572	u32 max_rq_depth;
573
574	/* The maximum number of completion queues supported per VF */
575	u32 max_cq;
576
 
577	u32 max_cq_depth;
578
579	/* Number of sub-CQs to be created for each CQ */
580	u16 sub_cqs_per_cq;
581
582	u16 reserved;
 
583
584	/*
585	 * Maximum number of SGEs (buffs) allowed for a single send work
586	 *    queue element (WQE)
587	 */
588	u16 max_wr_send_sges;
589
590	/* Maximum number of SGEs allowed for a single recv WQE */
591	u16 max_wr_recv_sges;
592
593	/* The maximum number of memory regions supported */
594	u32 max_mr;
595
596	/* The maximum number of pages can be registered */
597	u32 max_mr_pages;
598
599	/* The maximum number of protection domains supported */
600	u32 max_pd;
601
602	/* The maximum number of address handles supported */
603	u32 max_ah;
604
605	/* The maximum size of LLQ in bytes */
606	u32 max_llq_size;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
607};
608
609struct efa_admin_feature_aenq_desc {
610	/* bitmask for AENQ groups the device can report */
611	u32 supported_groups;
612
613	/* bitmask for AENQ groups to report */
614	u32 enabled_groups;
615};
616
617struct efa_admin_feature_network_attr_desc {
618	/* Raw address data in network byte order */
619	u8 addr[16];
620
 
621	u32 mtu;
622};
623
624/*
625 * When hint value is 0, hints capabilities are not supported or driver
626 * should use its own predefined value
627 */
628struct efa_admin_hw_hints {
629	/* value in ms */
630	u16 mmio_read_timeout;
631
632	/* value in ms */
633	u16 driver_watchdog_timeout;
634
635	/* value in ms */
636	u16 admin_completion_timeout;
637
638	/* poll interval in ms */
639	u16 poll_interval;
640};
641
642struct efa_admin_get_feature_cmd {
643	struct efa_admin_aq_common_desc aq_common_descriptor;
644
645	struct efa_admin_ctrl_buff_info control_buffer;
646
647	struct efa_admin_get_set_feature_common_desc feature_common;
648
649	u32 raw[11];
650};
651
652struct efa_admin_get_feature_resp {
653	struct efa_admin_acq_common_desc acq_common_desc;
654
655	union {
656		u32 raw[14];
657
658		struct efa_admin_feature_device_attr_desc device_attr;
659
660		struct efa_admin_feature_aenq_desc aenq;
661
662		struct efa_admin_feature_network_attr_desc network_attr;
663
664		struct efa_admin_feature_queue_attr_desc queue_attr;
665
 
 
666		struct efa_admin_hw_hints hw_hints;
667	} u;
668};
669
670struct efa_admin_set_feature_cmd {
671	struct efa_admin_aq_common_desc aq_common_descriptor;
672
673	struct efa_admin_ctrl_buff_info control_buffer;
674
675	struct efa_admin_get_set_feature_common_desc feature_common;
676
677	union {
678		u32 raw[11];
679
680		/* AENQ configuration */
681		struct efa_admin_feature_aenq_desc aenq;
682	} u;
683};
684
685struct efa_admin_set_feature_resp {
686	struct efa_admin_acq_common_desc acq_common_desc;
687
688	union {
689		u32 raw[14];
690	} u;
691};
692
693struct efa_admin_alloc_pd_cmd {
694	struct efa_admin_aq_common_desc aq_common_descriptor;
695};
696
697struct efa_admin_alloc_pd_resp {
698	struct efa_admin_acq_common_desc acq_common_desc;
699
700	/* PD number */
701	u16 pd;
702
703	/* MBZ */
704	u16 reserved;
705};
706
707struct efa_admin_dealloc_pd_cmd {
708	struct efa_admin_aq_common_desc aq_common_descriptor;
709
710	/* PD number */
711	u16 pd;
712
713	/* MBZ */
714	u16 reserved;
715};
716
717struct efa_admin_dealloc_pd_resp {
718	struct efa_admin_acq_common_desc acq_common_desc;
719};
720
721struct efa_admin_alloc_uar_cmd {
722	struct efa_admin_aq_common_desc aq_common_descriptor;
723};
724
725struct efa_admin_alloc_uar_resp {
726	struct efa_admin_acq_common_desc acq_common_desc;
727
728	/* UAR number */
729	u16 uar;
730
731	/* MBZ */
732	u16 reserved;
733};
734
735struct efa_admin_dealloc_uar_cmd {
736	struct efa_admin_aq_common_desc aq_common_descriptor;
737
738	/* UAR number */
739	u16 uar;
740
741	/* MBZ */
742	u16 reserved;
743};
744
745struct efa_admin_dealloc_uar_resp {
746	struct efa_admin_acq_common_desc acq_common_desc;
747};
748
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
749/* asynchronous event notification groups */
750enum efa_admin_aenq_group {
751	EFA_ADMIN_FATAL_ERROR                       = 1,
752	EFA_ADMIN_WARNING                           = 2,
753	EFA_ADMIN_NOTIFICATION                      = 3,
754	EFA_ADMIN_KEEP_ALIVE                        = 4,
755	EFA_ADMIN_AENQ_GROUPS_NUM                   = 5,
756};
757
758enum efa_admin_aenq_notification_syndrom {
759	EFA_ADMIN_SUSPEND                           = 0,
760	EFA_ADMIN_RESUME                            = 1,
761	EFA_ADMIN_UPDATE_HINTS                      = 2,
762};
763
764struct efa_admin_mmio_req_read_less_resp {
765	u16 req_id;
766
767	u16 reg_off;
768
769	/* value is valid when poll is cleared */
770	u32 reg_val;
771};
772
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
773/* create_qp_cmd */
774#define EFA_ADMIN_CREATE_QP_CMD_SQ_VIRT_MASK                BIT(0)
775#define EFA_ADMIN_CREATE_QP_CMD_RQ_VIRT_SHIFT               1
776#define EFA_ADMIN_CREATE_QP_CMD_RQ_VIRT_MASK                BIT(1)
777
 
 
 
 
 
 
 
 
778/* reg_mr_cmd */
779#define EFA_ADMIN_REG_MR_CMD_PHYS_PAGE_SIZE_SHIFT_MASK      GENMASK(4, 0)
780#define EFA_ADMIN_REG_MR_CMD_MEM_ADDR_PHY_MODE_EN_SHIFT     7
781#define EFA_ADMIN_REG_MR_CMD_MEM_ADDR_PHY_MODE_EN_MASK      BIT(7)
782#define EFA_ADMIN_REG_MR_CMD_LOCAL_WRITE_ENABLE_MASK        BIT(0)
 
 
 
 
 
 
 
783
784/* create_cq_cmd */
785#define EFA_ADMIN_CREATE_CQ_CMD_INTERRUPT_MODE_ENABLED_SHIFT 5
786#define EFA_ADMIN_CREATE_CQ_CMD_INTERRUPT_MODE_ENABLED_MASK BIT(5)
787#define EFA_ADMIN_CREATE_CQ_CMD_VIRT_SHIFT                  6
788#define EFA_ADMIN_CREATE_CQ_CMD_VIRT_MASK                   BIT(6)
789#define EFA_ADMIN_CREATE_CQ_CMD_CQ_ENTRY_SIZE_WORDS_MASK    GENMASK(4, 0)
 
 
 
 
790
791/* get_set_feature_common_desc */
792#define EFA_ADMIN_GET_SET_FEATURE_COMMON_DESC_SELECT_MASK   GENMASK(1, 0)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
793
794#endif /* _EFA_ADMIN_CMDS_H_ */