drivers/infiniband/hw/mlx5/user.h

   1 /*
   2  * Copyright (c) 2013-2015, Mellanox Technologies. All rights reserved.
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the
   8  * OpenIB.org BSD license below:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  18  *      - Redistributions in binary form must reproduce the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer in the documentation and/or other materials
  21  *        provided with the distribution.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #ifndef MLX5_IB_USER_H
  34 #define MLX5_IB_USER_H
  35
  36 #include <linux/types.h>
  37
  38 #include "mlx5_ib.h"
  39
  40 enum {
  41         MLX5_QP_FLAG_SIGNATURE          = 1 << 0,
  42         MLX5_QP_FLAG_SCATTER_CQE        = 1 << 1,
  43 };
  44
  45 enum {
  46         MLX5_SRQ_FLAG_SIGNATURE         = 1 << 0,
  47 };
  48
  49
  50 /* Increment this value if any changes that break userspace ABI
  51  * compatibility are made.
  52  */
  53 #define MLX5_IB_UVERBS_ABI_VERSION      1
  54
  55 /* Make sure that all structs defined in this file remain laid out so
  56  * that they pack the same way on 32-bit and 64-bit architectures (to
  57  * avoid incompatibility between 32-bit userspace and 64-bit kernels).
  58  * In particular do not use pointer types -- pass pointers in __u64
  59  * instead.
  60  */
  61
  62 struct mlx5_ib_alloc_ucontext_req {
  63         __u32   total_num_uuars;
  64         __u32   num_low_latency_uuars;
  65 };
  66
  67 struct mlx5_ib_alloc_ucontext_req_v2 {
  68         __u32   total_num_uuars;
  69         __u32   num_low_latency_uuars;
  70         __u32   flags;
  71         __u32   comp_mask;
  72 };
  73
  74 enum mlx5_ib_alloc_ucontext_resp_mask {
  75         MLX5_IB_ALLOC_UCONTEXT_RESP_MASK_CORE_CLOCK_OFFSET = 1UL << 0,
  76 };
  77
  78 struct mlx5_ib_alloc_ucontext_resp {
  79         __u32   qp_tab_size;
  80         __u32   bf_reg_size;
  81         __u32   tot_uuars;
  82         __u32   cache_line_size;
  83         __u16   max_sq_desc_sz;
  84         __u16   max_rq_desc_sz;
  85         __u32   max_send_wqebb;
  86         __u32   max_recv_wr;
  87         __u32   max_srq_recv_wr;
  88         __u16   num_ports;
  89         __u16   reserved1;
  90         __u32   comp_mask;
  91         __u32   response_length;
  92         __u32   reserved2;
  93         __u64   hca_core_clock_offset;
  94 };
  95
  96 struct mlx5_ib_alloc_pd_resp {
  97         __u32   pdn;
  98 };
  99
 100 struct mlx5_ib_create_cq {
 101         __u64   buf_addr;
 102         __u64   db_addr;
 103         __u32   cqe_size;
 104         __u32   reserved; /* explicit padding (optional on i386) */
 105 };
 106
 107 struct mlx5_ib_create_cq_resp {
 108         __u32   cqn;
 109         __u32   reserved;
 110 };
 111
 112 struct mlx5_ib_resize_cq {
 113         __u64   buf_addr;
 114         __u16   cqe_size;
 115         __u16   reserved0;
 116         __u32   reserved1;
 117 };
 118
 119 struct mlx5_ib_create_srq {
 120         __u64   buf_addr;
 121         __u64   db_addr;
 122         __u32   flags;
 123         __u32   reserved0; /* explicit padding (optional on i386) */
 124         __u32   uidx;
 125         __u32   reserved1;
 126 };
 127
 128 struct mlx5_ib_create_srq_resp {
 129         __u32   srqn;
 130         __u32   reserved;
 131 };
 132
 133 struct mlx5_ib_create_qp {
 134         __u64   buf_addr;
 135         __u64   db_addr;
 136         __u32   sq_wqe_count;
 137         __u32   rq_wqe_count;
 138         __u32   rq_wqe_shift;
 139         __u32   flags;
 140         __u32   uidx;
 141         __u32   reserved0;
 142 };
 143
 144 struct mlx5_ib_create_qp_resp {
 145         __u32   uuar_index;
 146 };
 147
 148 static inline int get_qp_user_index(struct mlx5_ib_ucontext *ucontext,
 149                                     struct mlx5_ib_create_qp *ucmd,
 150                                     int inlen,
 151                                     u32 *user_index)
 152 {
 153         u8 cqe_version = ucontext->cqe_version;
 154
 155         if (field_avail(struct mlx5_ib_create_qp, uidx, inlen) &&
 156             !cqe_version && (ucmd->uidx == MLX5_IB_DEFAULT_UIDX))
 157                 return 0;
 158
 159         if (!!(field_avail(struct mlx5_ib_create_qp, uidx, inlen) !=
 160                !!cqe_version))
 161                 return -EINVAL;
 162
 163         return verify_assign_uidx(cqe_version, ucmd->uidx, user_index);
 164 }
 165
 166 static inline int get_srq_user_index(struct mlx5_ib_ucontext *ucontext,
 167                                      struct mlx5_ib_create_srq *ucmd,
 168                                      int inlen,
 169                                      u32 *user_index)
 170 {
 171         u8 cqe_version = ucontext->cqe_version;
 172
 173         if (field_avail(struct mlx5_ib_create_srq, uidx, inlen) &&
 174             !cqe_version && (ucmd->uidx == MLX5_IB_DEFAULT_UIDX))
 175                 return 0;
 176
 177         if (!!(field_avail(struct mlx5_ib_create_srq, uidx, inlen) !=
 178                !!cqe_version))
 179                 return -EINVAL;
 180
 181         return verify_assign_uidx(cqe_version, ucmd->uidx, user_index);
 182 }
 183 #endif /* MLX5_IB_USER_H */