drivers/infiniband/hw/efa/efa_com_cmd.h

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