1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR Linux-OpenIB) */ 2 /* 3 * Copyright (c) 2016 Mellanox Technologies Ltd. All rights reserved. 4 * 5 * This software is available to you under a choice of one of two 6 * licenses. You may choose to be licensed under the terms of the GNU 7 * General Public License (GPL) Version 2, available from the file 8 * COPYING in the main directory of this source tree, or the 9 * OpenIB.org BSD license below: 10 * 11 * Redistribution and use in source and binary forms, with or 12 * without modification, are permitted provided that the following 13 * conditions are met: 14 * 15 * - Redistributions of source code must retain the above 16 * copyright notice, this list of conditions and the following 17 * disclaimer. 18 * 19 * - Redistributions in binary form must reproduce the above 20 * copyright notice, this list of conditions and the following 21 * disclaimer in the documentation and/or other materials 22 * provided with the distribution. 23 * 24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 31 * SOFTWARE. 32 */ 33 34 #ifndef RDMA_USER_RXE_H 35 #define RDMA_USER_RXE_H 36 37 #include <linux/types.h> 38 #include <linux/socket.h> 39 #include <linux/in.h> 40 #include <linux/in6.h> 41 42 enum { 43 RXE_NETWORK_TYPE_IPV4 = 1, 44 RXE_NETWORK_TYPE_IPV6 = 2, 45 }; 46 47 union rxe_gid { 48 __u8 raw[16]; 49 struct { 50 __be64 subnet_prefix; 51 __be64 interface_id; 52 } global; 53 }; 54 55 struct rxe_global_route { 56 union rxe_gid dgid; 57 __u32 flow_label; 58 __u8 sgid_index; 59 __u8 hop_limit; 60 __u8 traffic_class; 61 }; 62 63 struct rxe_av { 64 __u8 port_num; 65 /* From RXE_NETWORK_TYPE_* */ 66 __u8 network_type; 67 __u8 dmac[6]; 68 struct rxe_global_route grh; 69 union { 70 struct sockaddr_in _sockaddr_in; 71 struct sockaddr_in6 _sockaddr_in6; 72 } sgid_addr, dgid_addr; 73 }; 74 75 struct rxe_send_wr { 76 __aligned_u64 wr_id; 77 __u32 num_sge; 78 __u32 opcode; 79 __u32 send_flags; 80 union { 81 __be32 imm_data; 82 __u32 invalidate_rkey; 83 } ex; 84 union { 85 struct { 86 __aligned_u64 remote_addr; 87 __u32 rkey; 88 __u32 reserved; 89 } rdma; 90 struct { 91 __aligned_u64 remote_addr; 92 __aligned_u64 compare_add; 93 __aligned_u64 swap; 94 __u32 rkey; 95 __u32 reserved; 96 } atomic; 97 struct { 98 __u32 remote_qpn; 99 __u32 remote_qkey; 100 __u16 pkey_index; 101 } ud; 102 /* reg is only used by the kernel and is not part of the uapi */ 103 struct { 104 union { 105 struct ib_mr *mr; 106 __aligned_u64 reserved; 107 }; 108 __u32 key; 109 __u32 access; 110 } reg; 111 } wr; 112 }; 113 114 struct rxe_sge { 115 __aligned_u64 addr; 116 __u32 length; 117 __u32 lkey; 118 }; 119 120 struct mminfo { 121 __aligned_u64 offset; 122 __u32 size; 123 __u32 pad; 124 }; 125 126 struct rxe_dma_info { 127 __u32 length; 128 __u32 resid; 129 __u32 cur_sge; 130 __u32 num_sge; 131 __u32 sge_offset; 132 __u32 reserved; 133 union { 134 __u8 inline_data[0]; 135 struct rxe_sge sge[0]; 136 }; 137 }; 138 139 struct rxe_send_wqe { 140 struct rxe_send_wr wr; 141 struct rxe_av av; 142 __u32 status; 143 __u32 state; 144 __aligned_u64 iova; 145 __u32 mask; 146 __u32 first_psn; 147 __u32 last_psn; 148 __u32 ack_length; 149 __u32 ssn; 150 __u32 has_rd_atomic; 151 struct rxe_dma_info dma; 152 }; 153 154 struct rxe_recv_wqe { 155 __aligned_u64 wr_id; 156 __u32 num_sge; 157 __u32 padding; 158 struct rxe_dma_info dma; 159 }; 160 161 struct rxe_create_cq_resp { 162 struct mminfo mi; 163 }; 164 165 struct rxe_resize_cq_resp { 166 struct mminfo mi; 167 }; 168 169 struct rxe_create_qp_resp { 170 struct mminfo rq_mi; 171 struct mminfo sq_mi; 172 }; 173 174 struct rxe_create_srq_resp { 175 struct mminfo mi; 176 __u32 srq_num; 177 __u32 reserved; 178 }; 179 180 struct rxe_modify_srq_cmd { 181 __aligned_u64 mmap_info_addr; 182 }; 183 184 /* This data structure is stored at the base of work and 185 * completion queues shared between user space and kernel space. 186 * It contains the producer and consumer indices. Is also 187 * contains a copy of the queue size parameters for user space 188 * to use but the kernel must use the parameters in the 189 * rxe_queue struct. For performance reasons arrange to have 190 * producer and consumer indices in separate cache lines 191 * the kernel should always mask the indices to avoid accessing 192 * memory outside of the data area 193 */ 194 struct rxe_queue_buf { 195 __u32 log2_elem_size; 196 __u32 index_mask; 197 __u32 pad_1[30]; 198 __u32 producer_index; 199 __u32 pad_2[31]; 200 __u32 consumer_index; 201 __u32 pad_3[31]; 202 __u8 data[]; 203 }; 204 205 #endif /* RDMA_USER_RXE_H */ 206