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 }; 80 81 enum pvrdma_wc_status { 82 PVRDMA_WC_SUCCESS, 83 PVRDMA_WC_LOC_LEN_ERR, 84 PVRDMA_WC_LOC_QP_OP_ERR, 85 PVRDMA_WC_LOC_EEC_OP_ERR, 86 PVRDMA_WC_LOC_PROT_ERR, 87 PVRDMA_WC_WR_FLUSH_ERR, 88 PVRDMA_WC_MW_BIND_ERR, 89 PVRDMA_WC_BAD_RESP_ERR, 90 PVRDMA_WC_LOC_ACCESS_ERR, 91 PVRDMA_WC_REM_INV_REQ_ERR, 92 PVRDMA_WC_REM_ACCESS_ERR, 93 PVRDMA_WC_REM_OP_ERR, 94 PVRDMA_WC_RETRY_EXC_ERR, 95 PVRDMA_WC_RNR_RETRY_EXC_ERR, 96 PVRDMA_WC_LOC_RDD_VIOL_ERR, 97 PVRDMA_WC_REM_INV_RD_REQ_ERR, 98 PVRDMA_WC_REM_ABORT_ERR, 99 PVRDMA_WC_INV_EECN_ERR, 100 PVRDMA_WC_INV_EEC_STATE_ERR, 101 PVRDMA_WC_FATAL_ERR, 102 PVRDMA_WC_RESP_TIMEOUT_ERR, 103 PVRDMA_WC_GENERAL_ERR, 104 }; 105 106 enum pvrdma_wc_opcode { 107 PVRDMA_WC_SEND, 108 PVRDMA_WC_RDMA_WRITE, 109 PVRDMA_WC_RDMA_READ, 110 PVRDMA_WC_COMP_SWAP, 111 PVRDMA_WC_FETCH_ADD, 112 PVRDMA_WC_BIND_MW, 113 PVRDMA_WC_LSO, 114 PVRDMA_WC_LOCAL_INV, 115 PVRDMA_WC_FAST_REG_MR, 116 PVRDMA_WC_MASKED_COMP_SWAP, 117 PVRDMA_WC_MASKED_FETCH_ADD, 118 PVRDMA_WC_RECV = 1 << 7, 119 PVRDMA_WC_RECV_RDMA_WITH_IMM, 120 }; 121 122 enum pvrdma_wc_flags { 123 PVRDMA_WC_GRH = 1 << 0, 124 PVRDMA_WC_WITH_IMM = 1 << 1, 125 PVRDMA_WC_WITH_INVALIDATE = 1 << 2, 126 PVRDMA_WC_IP_CSUM_OK = 1 << 3, 127 PVRDMA_WC_WITH_SMAC = 1 << 4, 128 PVRDMA_WC_WITH_VLAN = 1 << 5, 129 PVRDMA_WC_WITH_NETWORK_HDR_TYPE = 1 << 6, 130 PVRDMA_WC_FLAGS_MAX = PVRDMA_WC_WITH_NETWORK_HDR_TYPE, 131 }; 132 133 struct pvrdma_alloc_ucontext_resp { 134 __u32 qp_tab_size; 135 __u32 reserved; 136 }; 137 138 struct pvrdma_alloc_pd_resp { 139 __u32 pdn; 140 __u32 reserved; 141 }; 142 143 struct pvrdma_create_cq { 144 __u64 buf_addr; 145 __u32 buf_size; 146 __u32 reserved; 147 }; 148 149 struct pvrdma_create_cq_resp { 150 __u32 cqn; 151 __u32 reserved; 152 }; 153 154 struct pvrdma_resize_cq { 155 __u64 buf_addr; 156 __u32 buf_size; 157 __u32 reserved; 158 }; 159 160 struct pvrdma_create_srq { 161 __u64 buf_addr; 162 }; 163 164 struct pvrdma_create_srq_resp { 165 __u32 srqn; 166 __u32 reserved; 167 }; 168 169 struct pvrdma_create_qp { 170 __u64 rbuf_addr; 171 __u64 sbuf_addr; 172 __u32 rbuf_size; 173 __u32 sbuf_size; 174 __u64 qp_addr; 175 }; 176 177 /* PVRDMA masked atomic compare and swap */ 178 struct pvrdma_ex_cmp_swap { 179 __u64 swap_val; 180 __u64 compare_val; 181 __u64 swap_mask; 182 __u64 compare_mask; 183 }; 184 185 /* PVRDMA masked atomic fetch and add */ 186 struct pvrdma_ex_fetch_add { 187 __u64 add_val; 188 __u64 field_boundary; 189 }; 190 191 /* PVRDMA address vector. */ 192 struct pvrdma_av { 193 __u32 port_pd; 194 __u32 sl_tclass_flowlabel; 195 __u8 dgid[16]; 196 __u8 src_path_bits; 197 __u8 gid_index; 198 __u8 stat_rate; 199 __u8 hop_limit; 200 __u8 dmac[6]; 201 __u8 reserved[6]; 202 }; 203 204 /* PVRDMA scatter/gather entry */ 205 struct pvrdma_sge { 206 __u64 addr; 207 __u32 length; 208 __u32 lkey; 209 }; 210 211 /* PVRDMA receive queue work request */ 212 struct pvrdma_rq_wqe_hdr { 213 __u64 wr_id; /* wr id */ 214 __u32 num_sge; /* size of s/g array */ 215 __u32 total_len; /* reserved */ 216 }; 217 /* Use pvrdma_sge (ib_sge) for receive queue s/g array elements. */ 218 219 /* PVRDMA send queue work request */ 220 struct pvrdma_sq_wqe_hdr { 221 __u64 wr_id; /* wr id */ 222 __u32 num_sge; /* size of s/g array */ 223 __u32 total_len; /* reserved */ 224 __u32 opcode; /* operation type */ 225 __u32 send_flags; /* wr flags */ 226 union { 227 __be32 imm_data; 228 __u32 invalidate_rkey; 229 } ex; 230 __u32 reserved; 231 union { 232 struct { 233 __u64 remote_addr; 234 __u32 rkey; 235 __u8 reserved[4]; 236 } rdma; 237 struct { 238 __u64 remote_addr; 239 __u64 compare_add; 240 __u64 swap; 241 __u32 rkey; 242 __u32 reserved; 243 } atomic; 244 struct { 245 __u64 remote_addr; 246 __u32 log_arg_sz; 247 __u32 rkey; 248 union { 249 struct pvrdma_ex_cmp_swap cmp_swap; 250 struct pvrdma_ex_fetch_add fetch_add; 251 } wr_data; 252 } masked_atomics; 253 struct { 254 __u64 iova_start; 255 __u64 pl_pdir_dma; 256 __u32 page_shift; 257 __u32 page_list_len; 258 __u32 length; 259 __u32 access_flags; 260 __u32 rkey; 261 } fast_reg; 262 struct { 263 __u32 remote_qpn; 264 __u32 remote_qkey; 265 struct pvrdma_av av; 266 } ud; 267 } wr; 268 }; 269 /* Use pvrdma_sge (ib_sge) for send queue s/g array elements. */ 270 271 /* Completion queue element. */ 272 struct pvrdma_cqe { 273 __u64 wr_id; 274 __u64 qp; 275 __u32 opcode; 276 __u32 status; 277 __u32 byte_len; 278 __be32 imm_data; 279 __u32 src_qp; 280 __u32 wc_flags; 281 __u32 vendor_err; 282 __u16 pkey_index; 283 __u16 slid; 284 __u8 sl; 285 __u8 dlid_path_bits; 286 __u8 port_num; 287 __u8 smac[6]; 288 __u8 network_hdr_type; 289 __u8 reserved2[6]; /* Pad to next power of 2 (64). */ 290 }; 291 292 #endif /* __VMW_PVRDMA_ABI_H__ */ 293