1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */ 2 /* 3 * Copyright (c) 2012-2016 VMware, Inc. All rights reserved. 4 * 5 * This program is free software; you can redistribute it and/or 6 * modify it under the terms of EITHER the GNU General Public License 7 * version 2 as published by the Free Software Foundation or the BSD 8 * 2-Clause License. This program is distributed in the hope that it 9 * will be useful, but WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED 10 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 11 * See the GNU General Public License version 2 for more details at 12 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html. 13 * 14 * You should have received a copy of the GNU General Public License 15 * along with this program available in the file COPYING in the main 16 * directory of this source tree. 17 * 18 * The BSD 2-Clause License 19 * 20 * Redistribution and use in source and binary forms, with or 21 * without modification, are permitted provided that the following 22 * conditions are met: 23 * 24 * - Redistributions of source code must retain the above 25 * copyright notice, this list of conditions and the following 26 * disclaimer. 27 * 28 * - Redistributions in binary form must reproduce the above 29 * copyright notice, this list of conditions and the following 30 * disclaimer in the documentation and/or other materials 31 * provided with the distribution. 32 * 33 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 34 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 35 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 36 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 37 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 38 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 39 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 40 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 41 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 42 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 43 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 44 * OF THE POSSIBILITY OF SUCH DAMAGE. 45 */ 46 47 #ifndef __VMW_PVRDMA_ABI_H__ 48 #define __VMW_PVRDMA_ABI_H__ 49 50 #include <linux/types.h> 51 52 #define PVRDMA_UVERBS_ABI_VERSION 3 /* ABI Version. */ 53 #define PVRDMA_UAR_HANDLE_MASK 0x00FFFFFF /* Bottom 24 bits. */ 54 #define PVRDMA_UAR_QP_OFFSET 0 /* QP doorbell. */ 55 #define PVRDMA_UAR_QP_SEND BIT(30) /* Send bit. */ 56 #define PVRDMA_UAR_QP_RECV BIT(31) /* Recv bit. */ 57 #define PVRDMA_UAR_CQ_OFFSET 4 /* CQ doorbell. */ 58 #define PVRDMA_UAR_CQ_ARM_SOL BIT(29) /* Arm solicited bit. */ 59 #define PVRDMA_UAR_CQ_ARM BIT(30) /* Arm bit. */ 60 #define PVRDMA_UAR_CQ_POLL BIT(31) /* Poll bit. */ 61 62 enum pvrdma_wr_opcode { 63 PVRDMA_WR_RDMA_WRITE, 64 PVRDMA_WR_RDMA_WRITE_WITH_IMM, 65 PVRDMA_WR_SEND, 66 PVRDMA_WR_SEND_WITH_IMM, 67 PVRDMA_WR_RDMA_READ, 68 PVRDMA_WR_ATOMIC_CMP_AND_SWP, 69 PVRDMA_WR_ATOMIC_FETCH_AND_ADD, 70 PVRDMA_WR_LSO, 71 PVRDMA_WR_SEND_WITH_INV, 72 PVRDMA_WR_RDMA_READ_WITH_INV, 73 PVRDMA_WR_LOCAL_INV, 74 PVRDMA_WR_FAST_REG_MR, 75 PVRDMA_WR_MASKED_ATOMIC_CMP_AND_SWP, 76 PVRDMA_WR_MASKED_ATOMIC_FETCH_AND_ADD, 77 PVRDMA_WR_BIND_MW, 78 PVRDMA_WR_REG_SIG_MR, 79 PVRDMA_WR_ERROR, 80 }; 81 82 enum pvrdma_wc_status { 83 PVRDMA_WC_SUCCESS, 84 PVRDMA_WC_LOC_LEN_ERR, 85 PVRDMA_WC_LOC_QP_OP_ERR, 86 PVRDMA_WC_LOC_EEC_OP_ERR, 87 PVRDMA_WC_LOC_PROT_ERR, 88 PVRDMA_WC_WR_FLUSH_ERR, 89 PVRDMA_WC_MW_BIND_ERR, 90 PVRDMA_WC_BAD_RESP_ERR, 91 PVRDMA_WC_LOC_ACCESS_ERR, 92 PVRDMA_WC_REM_INV_REQ_ERR, 93 PVRDMA_WC_REM_ACCESS_ERR, 94 PVRDMA_WC_REM_OP_ERR, 95 PVRDMA_WC_RETRY_EXC_ERR, 96 PVRDMA_WC_RNR_RETRY_EXC_ERR, 97 PVRDMA_WC_LOC_RDD_VIOL_ERR, 98 PVRDMA_WC_REM_INV_RD_REQ_ERR, 99 PVRDMA_WC_REM_ABORT_ERR, 100 PVRDMA_WC_INV_EECN_ERR, 101 PVRDMA_WC_INV_EEC_STATE_ERR, 102 PVRDMA_WC_FATAL_ERR, 103 PVRDMA_WC_RESP_TIMEOUT_ERR, 104 PVRDMA_WC_GENERAL_ERR, 105 }; 106 107 enum pvrdma_wc_opcode { 108 PVRDMA_WC_SEND, 109 PVRDMA_WC_RDMA_WRITE, 110 PVRDMA_WC_RDMA_READ, 111 PVRDMA_WC_COMP_SWAP, 112 PVRDMA_WC_FETCH_ADD, 113 PVRDMA_WC_BIND_MW, 114 PVRDMA_WC_LSO, 115 PVRDMA_WC_LOCAL_INV, 116 PVRDMA_WC_FAST_REG_MR, 117 PVRDMA_WC_MASKED_COMP_SWAP, 118 PVRDMA_WC_MASKED_FETCH_ADD, 119 PVRDMA_WC_RECV = 1 << 7, 120 PVRDMA_WC_RECV_RDMA_WITH_IMM, 121 }; 122 123 enum pvrdma_wc_flags { 124 PVRDMA_WC_GRH = 1 << 0, 125 PVRDMA_WC_WITH_IMM = 1 << 1, 126 PVRDMA_WC_WITH_INVALIDATE = 1 << 2, 127 PVRDMA_WC_IP_CSUM_OK = 1 << 3, 128 PVRDMA_WC_WITH_SMAC = 1 << 4, 129 PVRDMA_WC_WITH_VLAN = 1 << 5, 130 PVRDMA_WC_WITH_NETWORK_HDR_TYPE = 1 << 6, 131 PVRDMA_WC_FLAGS_MAX = PVRDMA_WC_WITH_NETWORK_HDR_TYPE, 132 }; 133 134 struct pvrdma_alloc_ucontext_resp { 135 __u32 qp_tab_size; 136 __u32 reserved; 137 }; 138 139 struct pvrdma_alloc_pd_resp { 140 __u32 pdn; 141 __u32 reserved; 142 }; 143 144 struct pvrdma_create_cq { 145 __u64 buf_addr; 146 __u32 buf_size; 147 __u32 reserved; 148 }; 149 150 struct pvrdma_create_cq_resp { 151 __u32 cqn; 152 __u32 reserved; 153 }; 154 155 struct pvrdma_resize_cq { 156 __u64 buf_addr; 157 __u32 buf_size; 158 __u32 reserved; 159 }; 160 161 struct pvrdma_create_srq { 162 __u64 buf_addr; 163 }; 164 165 struct pvrdma_create_srq_resp { 166 __u32 srqn; 167 __u32 reserved; 168 }; 169 170 struct pvrdma_create_qp { 171 __u64 rbuf_addr; 172 __u64 sbuf_addr; 173 __u32 rbuf_size; 174 __u32 sbuf_size; 175 __u64 qp_addr; 176 }; 177 178 /* PVRDMA masked atomic compare and swap */ 179 struct pvrdma_ex_cmp_swap { 180 __u64 swap_val; 181 __u64 compare_val; 182 __u64 swap_mask; 183 __u64 compare_mask; 184 }; 185 186 /* PVRDMA masked atomic fetch and add */ 187 struct pvrdma_ex_fetch_add { 188 __u64 add_val; 189 __u64 field_boundary; 190 }; 191 192 /* PVRDMA address vector. */ 193 struct pvrdma_av { 194 __u32 port_pd; 195 __u32 sl_tclass_flowlabel; 196 __u8 dgid[16]; 197 __u8 src_path_bits; 198 __u8 gid_index; 199 __u8 stat_rate; 200 __u8 hop_limit; 201 __u8 dmac[6]; 202 __u8 reserved[6]; 203 }; 204 205 /* PVRDMA scatter/gather entry */ 206 struct pvrdma_sge { 207 __u64 addr; 208 __u32 length; 209 __u32 lkey; 210 }; 211 212 /* PVRDMA receive queue work request */ 213 struct pvrdma_rq_wqe_hdr { 214 __u64 wr_id; /* wr id */ 215 __u32 num_sge; /* size of s/g array */ 216 __u32 total_len; /* reserved */ 217 }; 218 /* Use pvrdma_sge (ib_sge) for receive queue s/g array elements. */ 219 220 /* PVRDMA send queue work request */ 221 struct pvrdma_sq_wqe_hdr { 222 __u64 wr_id; /* wr id */ 223 __u32 num_sge; /* size of s/g array */ 224 __u32 total_len; /* reserved */ 225 __u32 opcode; /* operation type */ 226 __u32 send_flags; /* wr flags */ 227 union { 228 __be32 imm_data; 229 __u32 invalidate_rkey; 230 } ex; 231 __u32 reserved; 232 union { 233 struct { 234 __u64 remote_addr; 235 __u32 rkey; 236 __u8 reserved[4]; 237 } rdma; 238 struct { 239 __u64 remote_addr; 240 __u64 compare_add; 241 __u64 swap; 242 __u32 rkey; 243 __u32 reserved; 244 } atomic; 245 struct { 246 __u64 remote_addr; 247 __u32 log_arg_sz; 248 __u32 rkey; 249 union { 250 struct pvrdma_ex_cmp_swap cmp_swap; 251 struct pvrdma_ex_fetch_add fetch_add; 252 } wr_data; 253 } masked_atomics; 254 struct { 255 __u64 iova_start; 256 __u64 pl_pdir_dma; 257 __u32 page_shift; 258 __u32 page_list_len; 259 __u32 length; 260 __u32 access_flags; 261 __u32 rkey; 262 } fast_reg; 263 struct { 264 __u32 remote_qpn; 265 __u32 remote_qkey; 266 struct pvrdma_av av; 267 } ud; 268 } wr; 269 }; 270 /* Use pvrdma_sge (ib_sge) for send queue s/g array elements. */ 271 272 /* Completion queue element. */ 273 struct pvrdma_cqe { 274 __u64 wr_id; 275 __u64 qp; 276 __u32 opcode; 277 __u32 status; 278 __u32 byte_len; 279 __be32 imm_data; 280 __u32 src_qp; 281 __u32 wc_flags; 282 __u32 vendor_err; 283 __u16 pkey_index; 284 __u16 slid; 285 __u8 sl; 286 __u8 dlid_path_bits; 287 __u8 port_num; 288 __u8 smac[6]; 289 __u8 network_hdr_type; 290 __u8 reserved2[6]; /* Pad to next power of 2 (64). */ 291 }; 292 293 #endif /* __VMW_PVRDMA_ABI_H__ */ 294