drivers/infiniband/hw/efa/efa_com_cmd.h

   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_COM_CMD_H_
   7 #define _EFA_COM_CMD_H_
   8
   9 #include "efa_com.h"
  10
  11 #define EFA_GID_SIZE 16
  12
  13 struct efa_com_create_qp_params {
  14         u64 rq_base_addr;
  15         u32 send_cq_idx;
  16         u32 recv_cq_idx;
  17         /*
  18          * Send descriptor ring size in bytes,
  19          * sufficient for user-provided number of WQEs and SGL size
  20          */
  21         u32 sq_ring_size_in_bytes;
  22         /* Max number of WQEs that will be posted on send queue */
  23         u32 sq_depth;
  24         /* Recv descriptor ring size in bytes */
  25         u32 rq_ring_size_in_bytes;
  26         u32 rq_depth;
  27         u16 pd;
  28         u16 uarn;
  29         u8 qp_type;
  30         u8 sl;
  31         u8 unsolicited_write_recv : 1;
  32 };
  33
  34 struct efa_com_create_qp_result {
  35         u32 qp_handle;
  36         u32 qp_num;
  37         u32 sq_db_offset;
  38         u32 rq_db_offset;
  39         u32 llq_descriptors_offset;
  40         u16 send_sub_cq_idx;
  41         u16 recv_sub_cq_idx;
  42 };
  43
  44 struct efa_com_modify_qp_params {
  45         u32 modify_mask;
  46         u32 qp_handle;
  47         u32 qp_state;
  48         u32 cur_qp_state;
  49         u32 qkey;
  50         u32 sq_psn;
  51         u8 sq_drained_async_notify;
  52         u8 rnr_retry;
  53 };
  54
  55 struct efa_com_query_qp_params {
  56         u32 qp_handle;
  57 };
  58
  59 struct efa_com_query_qp_result {
  60         u32 qp_state;
  61         u32 qkey;
  62         u32 sq_draining;
  63         u32 sq_psn;
  64         u8 rnr_retry;
  65 };
  66
  67 struct efa_com_destroy_qp_params {
  68         u32 qp_handle;
  69 };
  70
  71 struct efa_com_create_cq_params {
  72         /* cq physical base address in OS memory */
  73         dma_addr_t dma_addr;
  74         /* completion queue depth in # of entries */
  75         u16 sub_cq_depth;
  76         u16 num_sub_cqs;
  77         u16 uarn;
  78         u16 eqn;
  79         u8 entry_size_in_bytes;
  80         u8 interrupt_mode_enabled : 1;
  81         u8 set_src_addr : 1;
  82 };
  83
  84 struct efa_com_create_cq_result {
  85         /* cq identifier */
  86         u16 cq_idx;
  87         /* actual cq depth in # of entries */
  88         u16 actual_depth;
  89         u32 db_off;
  90         bool db_valid;
  91 };
  92
  93 struct efa_com_destroy_cq_params {
  94         u16 cq_idx;
  95 };
  96
  97 struct efa_com_create_ah_params {
  98         u16 pdn;
  99         /* Destination address in network byte order */
 100         u8 dest_addr[EFA_GID_SIZE];
 101 };
 102
 103 struct efa_com_create_ah_result {
 104         u16 ah;
 105 };
 106
 107 struct efa_com_destroy_ah_params {
 108         u16 ah;
 109         u16 pdn;
 110 };
 111
 112 struct efa_com_get_device_attr_result {
 113         u8 addr[EFA_GID_SIZE];
 114         u64 page_size_cap;
 115         u64 max_mr_pages;
 116         u64 guid;
 117         u32 mtu;
 118         u32 fw_version;
 119         u32 admin_api_version;
 120         u32 device_version;
 121         u32 supported_features;
 122         u32 phys_addr_width;
 123         u32 virt_addr_width;
 124         u32 max_qp;
 125         u32 max_sq_depth; /* wqes */
 126         u32 max_rq_depth; /* wqes */
 127         u32 max_cq;
 128         u32 max_cq_depth; /* cqes */
 129         u32 inline_buf_size;
 130         u32 max_mr;
 131         u32 max_pd;
 132         u32 max_ah;
 133         u32 max_llq_size;
 134         u32 max_rdma_size;
 135         u32 device_caps;
 136         u32 max_eq;
 137         u32 max_eq_depth;
 138         u32 event_bitmask; /* EQ events bitmask */
 139         u16 sub_cqs_per_cq;
 140         u16 max_sq_sge;
 141         u16 max_rq_sge;
 142         u16 max_wr_rdma_sge;
 143         u16 max_tx_batch;
 144         u16 min_sq_depth;
 145         u16 max_link_speed_gbps;
 146         u8 db_bar;
 147 };
 148
 149 struct efa_com_get_hw_hints_result {
 150         u16 mmio_read_timeout;
 151         u16 driver_watchdog_timeout;
 152         u16 admin_completion_timeout;
 153         u16 poll_interval;
 154         u32 reserved[4];
 155 };
 156
 157 struct efa_com_mem_addr {
 158         u32 mem_addr_low;
 159         u32 mem_addr_high;
 160 };
 161
 162 /* Used at indirect mode page list chunks for chaining */
 163 struct efa_com_ctrl_buff_info {
 164         /* indicates length of the buffer pointed by control_buffer_address. */
 165         u32 length;
 166         /* points to control buffer (direct or indirect) */
 167         struct efa_com_mem_addr address;
 168 };
 169
 170 struct efa_com_reg_mr_params {
 171         /* Memory region length, in bytes. */
 172         u64 mr_length_in_bytes;
 173         /* IO Virtual Address associated with this MR. */
 174         u64 iova;
 175         /* words 8:15: Physical Buffer List, each element is page-aligned. */
 176         union {
 177                 /*
 178                  * Inline array of physical addresses of app pages
 179                  * (optimization for short region reservations)
 180                  */
 181                 u64 inline_pbl_array[4];
 182                 /*
 183                  * Describes the next physically contiguous chunk of indirect
 184                  * page list. A page list contains physical addresses of command
 185                  * data pages. Data pages are 4KB; page list chunks are
 186                  * variable-sized.
 187                  */
 188                 struct efa_com_ctrl_buff_info pbl;
 189         } pbl;
 190         /* number of pages in PBL (redundant, could be calculated) */
 191         u32 page_num;
 192         /* Protection Domain */
 193         u16 pd;
 194         /*
 195          * phys_page_size_shift - page size is (1 << phys_page_size_shift)
 196          * Page size is used for building the Virtual to Physical
 197          * address mapping
 198          */
 199         u8 page_shift;
 200         /* see permissions field of struct efa_admin_reg_mr_cmd */
 201         u8 permissions;
 202         u8 inline_pbl;
 203         u8 indirect;
 204 };
 205
 206 struct efa_com_mr_interconnect_info {
 207         u16 recv_ic_id;
 208         u16 rdma_read_ic_id;
 209         u16 rdma_recv_ic_id;
 210         u8 recv_ic_id_valid : 1;
 211         u8 rdma_read_ic_id_valid : 1;
 212         u8 rdma_recv_ic_id_valid : 1;
 213 };
 214
 215 struct efa_com_reg_mr_result {
 216         /*
 217          * To be used in conjunction with local buffers references in SQ and
 218          * RQ WQE
 219          */
 220         u32 l_key;
 221         /*
 222          * To be used in incoming RDMA semantics messages to refer to remotely
 223          * accessed memory region
 224          */
 225         u32 r_key;
 226         struct efa_com_mr_interconnect_info ic_info;
 227 };
 228
 229 struct efa_com_dereg_mr_params {
 230         u32 l_key;
 231 };
 232
 233 struct efa_com_alloc_pd_result {
 234         u16 pdn;
 235 };
 236
 237 struct efa_com_dealloc_pd_params {
 238         u16 pdn;
 239 };
 240
 241 struct efa_com_alloc_uar_result {
 242         u16 uarn;
 243 };
 244
 245 struct efa_com_dealloc_uar_params {
 246         u16 uarn;
 247 };
 248
 249 struct efa_com_get_stats_params {
 250         /* see enum efa_admin_get_stats_type */
 251         u8 type;
 252         /* see enum efa_admin_get_stats_scope */
 253         u8 scope;
 254         u16 scope_modifier;
 255 };
 256
 257 struct efa_com_basic_stats {
 258         u64 tx_bytes;
 259         u64 tx_pkts;
 260         u64 rx_bytes;
 261         u64 rx_pkts;
 262         u64 rx_drops;
 263 };
 264
 265 struct efa_com_messages_stats {
 266         u64 send_bytes;
 267         u64 send_wrs;
 268         u64 recv_bytes;
 269         u64 recv_wrs;
 270 };
 271
 272 struct efa_com_rdma_read_stats {
 273         u64 read_wrs;
 274         u64 read_bytes;
 275         u64 read_wr_err;
 276         u64 read_resp_bytes;
 277 };
 278
 279 struct efa_com_rdma_write_stats {
 280         u64 write_wrs;
 281         u64 write_bytes;
 282         u64 write_wr_err;
 283         u64 write_recv_bytes;
 284 };
 285
 286 union efa_com_get_stats_result {
 287         struct efa_com_basic_stats basic_stats;
 288         struct efa_com_messages_stats messages_stats;
 289         struct efa_com_rdma_read_stats rdma_read_stats;
 290         struct efa_com_rdma_write_stats rdma_write_stats;
 291 };
 292
 293 int efa_com_create_qp(struct efa_com_dev *edev,
 294                       struct efa_com_create_qp_params *params,
 295                       struct efa_com_create_qp_result *res);
 296 int efa_com_modify_qp(struct efa_com_dev *edev,
 297                       struct efa_com_modify_qp_params *params);
 298 int efa_com_query_qp(struct efa_com_dev *edev,
 299                      struct efa_com_query_qp_params *params,
 300                      struct efa_com_query_qp_result *result);
 301 int efa_com_destroy_qp(struct efa_com_dev *edev,
 302                        struct efa_com_destroy_qp_params *params);
 303 int efa_com_create_cq(struct efa_com_dev *edev,
 304                       struct efa_com_create_cq_params *params,
 305                       struct efa_com_create_cq_result *result);
 306 int efa_com_destroy_cq(struct efa_com_dev *edev,
 307                        struct efa_com_destroy_cq_params *params);
 308 int efa_com_register_mr(struct efa_com_dev *edev,
 309                         struct efa_com_reg_mr_params *params,
 310                         struct efa_com_reg_mr_result *result);
 311 int efa_com_dereg_mr(struct efa_com_dev *edev,
 312                      struct efa_com_dereg_mr_params *params);
 313 int efa_com_create_ah(struct efa_com_dev *edev,
 314                       struct efa_com_create_ah_params *params,
 315                       struct efa_com_create_ah_result *result);
 316 int efa_com_destroy_ah(struct efa_com_dev *edev,
 317                        struct efa_com_destroy_ah_params *params);
 318 int efa_com_get_device_attr(struct efa_com_dev *edev,
 319                             struct efa_com_get_device_attr_result *result);
 320 int efa_com_get_hw_hints(struct efa_com_dev *edev,
 321                          struct efa_com_get_hw_hints_result *result);
 322 bool
 323 efa_com_check_supported_feature_id(struct efa_com_dev *edev,
 324                                    enum efa_admin_aq_feature_id feature_id);
 325 int efa_com_set_feature_ex(struct efa_com_dev *edev,
 326                            struct efa_admin_set_feature_resp *set_resp,
 327                            struct efa_admin_set_feature_cmd *set_cmd,
 328                            enum efa_admin_aq_feature_id feature_id,
 329                            dma_addr_t control_buf_dma_addr,
 330                            u32 control_buff_size);
 331 int efa_com_set_aenq_config(struct efa_com_dev *edev, u32 groups);
 332 int efa_com_alloc_pd(struct efa_com_dev *edev,
 333                      struct efa_com_alloc_pd_result *result);
 334 int efa_com_dealloc_pd(struct efa_com_dev *edev,
 335                        struct efa_com_dealloc_pd_params *params);
 336 int efa_com_alloc_uar(struct efa_com_dev *edev,
 337                       struct efa_com_alloc_uar_result *result);
 338 int efa_com_dealloc_uar(struct efa_com_dev *edev,
 339                         struct efa_com_dealloc_uar_params *params);
 340 int efa_com_get_stats(struct efa_com_dev *edev,
 341                       struct efa_com_get_stats_params *params,
 342                       union efa_com_get_stats_result *result);
 343
 344 #endif /* _EFA_COM_CMD_H_ */