1 /* 2 * Copyright (c) 2004 Topspin Corporation. 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 IB_PACK_H 34 #define IB_PACK_H 35 36 #include <rdma/ib_verbs.h> 37 #include <uapi/linux/if_ether.h> 38 39 enum { 40 IB_LRH_BYTES = 8, 41 IB_ETH_BYTES = 14, 42 IB_VLAN_BYTES = 4, 43 IB_GRH_BYTES = 40, 44 IB_IP4_BYTES = 20, 45 IB_UDP_BYTES = 8, 46 IB_BTH_BYTES = 12, 47 IB_DETH_BYTES = 8 48 }; 49 50 struct ib_field { 51 size_t struct_offset_bytes; 52 size_t struct_size_bytes; 53 int offset_words; 54 int offset_bits; 55 int size_bits; 56 char *field_name; 57 }; 58 59 #define RESERVED \ 60 .field_name = "reserved" 61 62 /* 63 * This macro cleans up the definitions of constants for BTH opcodes. 64 * It is used to define constants such as IB_OPCODE_UD_SEND_ONLY, 65 * which becomes IB_OPCODE_UD + IB_OPCODE_SEND_ONLY, and this gives 66 * the correct value. 67 * 68 * In short, user code should use the constants defined using the 69 * macro rather than worrying about adding together other constants. 70 */ 71 #define IB_OPCODE(transport, op) \ 72 IB_OPCODE_ ## transport ## _ ## op = \ 73 IB_OPCODE_ ## transport + IB_OPCODE_ ## op 74 75 enum { 76 /* transport types -- just used to define real constants */ 77 IB_OPCODE_RC = 0x00, 78 IB_OPCODE_UC = 0x20, 79 IB_OPCODE_RD = 0x40, 80 IB_OPCODE_UD = 0x60, 81 /* per IBTA 1.3 vol 1 Table 38, A10.3.2 */ 82 IB_OPCODE_CNP = 0x80, 83 84 /* operations -- just used to define real constants */ 85 IB_OPCODE_SEND_FIRST = 0x00, 86 IB_OPCODE_SEND_MIDDLE = 0x01, 87 IB_OPCODE_SEND_LAST = 0x02, 88 IB_OPCODE_SEND_LAST_WITH_IMMEDIATE = 0x03, 89 IB_OPCODE_SEND_ONLY = 0x04, 90 IB_OPCODE_SEND_ONLY_WITH_IMMEDIATE = 0x05, 91 IB_OPCODE_RDMA_WRITE_FIRST = 0x06, 92 IB_OPCODE_RDMA_WRITE_MIDDLE = 0x07, 93 IB_OPCODE_RDMA_WRITE_LAST = 0x08, 94 IB_OPCODE_RDMA_WRITE_LAST_WITH_IMMEDIATE = 0x09, 95 IB_OPCODE_RDMA_WRITE_ONLY = 0x0a, 96 IB_OPCODE_RDMA_WRITE_ONLY_WITH_IMMEDIATE = 0x0b, 97 IB_OPCODE_RDMA_READ_REQUEST = 0x0c, 98 IB_OPCODE_RDMA_READ_RESPONSE_FIRST = 0x0d, 99 IB_OPCODE_RDMA_READ_RESPONSE_MIDDLE = 0x0e, 100 IB_OPCODE_RDMA_READ_RESPONSE_LAST = 0x0f, 101 IB_OPCODE_RDMA_READ_RESPONSE_ONLY = 0x10, 102 IB_OPCODE_ACKNOWLEDGE = 0x11, 103 IB_OPCODE_ATOMIC_ACKNOWLEDGE = 0x12, 104 IB_OPCODE_COMPARE_SWAP = 0x13, 105 IB_OPCODE_FETCH_ADD = 0x14, 106 107 /* real constants follow -- see comment about above IB_OPCODE() 108 macro for more details */ 109 110 /* RC */ 111 IB_OPCODE(RC, SEND_FIRST), 112 IB_OPCODE(RC, SEND_MIDDLE), 113 IB_OPCODE(RC, SEND_LAST), 114 IB_OPCODE(RC, SEND_LAST_WITH_IMMEDIATE), 115 IB_OPCODE(RC, SEND_ONLY), 116 IB_OPCODE(RC, SEND_ONLY_WITH_IMMEDIATE), 117 IB_OPCODE(RC, RDMA_WRITE_FIRST), 118 IB_OPCODE(RC, RDMA_WRITE_MIDDLE), 119 IB_OPCODE(RC, RDMA_WRITE_LAST), 120 IB_OPCODE(RC, RDMA_WRITE_LAST_WITH_IMMEDIATE), 121 IB_OPCODE(RC, RDMA_WRITE_ONLY), 122 IB_OPCODE(RC, RDMA_WRITE_ONLY_WITH_IMMEDIATE), 123 IB_OPCODE(RC, RDMA_READ_REQUEST), 124 IB_OPCODE(RC, RDMA_READ_RESPONSE_FIRST), 125 IB_OPCODE(RC, RDMA_READ_RESPONSE_MIDDLE), 126 IB_OPCODE(RC, RDMA_READ_RESPONSE_LAST), 127 IB_OPCODE(RC, RDMA_READ_RESPONSE_ONLY), 128 IB_OPCODE(RC, ACKNOWLEDGE), 129 IB_OPCODE(RC, ATOMIC_ACKNOWLEDGE), 130 IB_OPCODE(RC, COMPARE_SWAP), 131 IB_OPCODE(RC, FETCH_ADD), 132 133 /* UC */ 134 IB_OPCODE(UC, SEND_FIRST), 135 IB_OPCODE(UC, SEND_MIDDLE), 136 IB_OPCODE(UC, SEND_LAST), 137 IB_OPCODE(UC, SEND_LAST_WITH_IMMEDIATE), 138 IB_OPCODE(UC, SEND_ONLY), 139 IB_OPCODE(UC, SEND_ONLY_WITH_IMMEDIATE), 140 IB_OPCODE(UC, RDMA_WRITE_FIRST), 141 IB_OPCODE(UC, RDMA_WRITE_MIDDLE), 142 IB_OPCODE(UC, RDMA_WRITE_LAST), 143 IB_OPCODE(UC, RDMA_WRITE_LAST_WITH_IMMEDIATE), 144 IB_OPCODE(UC, RDMA_WRITE_ONLY), 145 IB_OPCODE(UC, RDMA_WRITE_ONLY_WITH_IMMEDIATE), 146 147 /* RD */ 148 IB_OPCODE(RD, SEND_FIRST), 149 IB_OPCODE(RD, SEND_MIDDLE), 150 IB_OPCODE(RD, SEND_LAST), 151 IB_OPCODE(RD, SEND_LAST_WITH_IMMEDIATE), 152 IB_OPCODE(RD, SEND_ONLY), 153 IB_OPCODE(RD, SEND_ONLY_WITH_IMMEDIATE), 154 IB_OPCODE(RD, RDMA_WRITE_FIRST), 155 IB_OPCODE(RD, RDMA_WRITE_MIDDLE), 156 IB_OPCODE(RD, RDMA_WRITE_LAST), 157 IB_OPCODE(RD, RDMA_WRITE_LAST_WITH_IMMEDIATE), 158 IB_OPCODE(RD, RDMA_WRITE_ONLY), 159 IB_OPCODE(RD, RDMA_WRITE_ONLY_WITH_IMMEDIATE), 160 IB_OPCODE(RD, RDMA_READ_REQUEST), 161 IB_OPCODE(RD, RDMA_READ_RESPONSE_FIRST), 162 IB_OPCODE(RD, RDMA_READ_RESPONSE_MIDDLE), 163 IB_OPCODE(RD, RDMA_READ_RESPONSE_LAST), 164 IB_OPCODE(RD, RDMA_READ_RESPONSE_ONLY), 165 IB_OPCODE(RD, ACKNOWLEDGE), 166 IB_OPCODE(RD, ATOMIC_ACKNOWLEDGE), 167 IB_OPCODE(RD, COMPARE_SWAP), 168 IB_OPCODE(RD, FETCH_ADD), 169 170 /* UD */ 171 IB_OPCODE(UD, SEND_ONLY), 172 IB_OPCODE(UD, SEND_ONLY_WITH_IMMEDIATE) 173 }; 174 175 enum { 176 IB_LNH_RAW = 0, 177 IB_LNH_IP = 1, 178 IB_LNH_IBA_LOCAL = 2, 179 IB_LNH_IBA_GLOBAL = 3 180 }; 181 182 struct ib_unpacked_lrh { 183 u8 virtual_lane; 184 u8 link_version; 185 u8 service_level; 186 u8 link_next_header; 187 __be16 destination_lid; 188 __be16 packet_length; 189 __be16 source_lid; 190 }; 191 192 struct ib_unpacked_grh { 193 u8 ip_version; 194 u8 traffic_class; 195 __be32 flow_label; 196 __be16 payload_length; 197 u8 next_header; 198 u8 hop_limit; 199 union ib_gid source_gid; 200 union ib_gid destination_gid; 201 }; 202 203 struct ib_unpacked_bth { 204 u8 opcode; 205 u8 solicited_event; 206 u8 mig_req; 207 u8 pad_count; 208 u8 transport_header_version; 209 __be16 pkey; 210 __be32 destination_qpn; 211 u8 ack_req; 212 __be32 psn; 213 }; 214 215 struct ib_unpacked_deth { 216 __be32 qkey; 217 __be32 source_qpn; 218 }; 219 220 struct ib_unpacked_eth { 221 u8 dmac_h[4]; 222 u8 dmac_l[2]; 223 u8 smac_h[2]; 224 u8 smac_l[4]; 225 __be16 type; 226 }; 227 228 struct ib_unpacked_ip4 { 229 u8 ver; 230 u8 hdr_len; 231 u8 tos; 232 __be16 tot_len; 233 __be16 id; 234 __be16 frag_off; 235 u8 ttl; 236 u8 protocol; 237 __sum16 check; 238 __be32 saddr; 239 __be32 daddr; 240 }; 241 242 struct ib_unpacked_udp { 243 __be16 sport; 244 __be16 dport; 245 __be16 length; 246 __be16 csum; 247 }; 248 249 struct ib_unpacked_vlan { 250 __be16 tag; 251 __be16 type; 252 }; 253 254 struct ib_ud_header { 255 int lrh_present; 256 struct ib_unpacked_lrh lrh; 257 int eth_present; 258 struct ib_unpacked_eth eth; 259 int vlan_present; 260 struct ib_unpacked_vlan vlan; 261 int grh_present; 262 struct ib_unpacked_grh grh; 263 int ipv4_present; 264 struct ib_unpacked_ip4 ip4; 265 int udp_present; 266 struct ib_unpacked_udp udp; 267 struct ib_unpacked_bth bth; 268 struct ib_unpacked_deth deth; 269 int immediate_present; 270 __be32 immediate_data; 271 }; 272 273 void ib_pack(const struct ib_field *desc, 274 int desc_len, 275 void *structure, 276 void *buf); 277 278 void ib_unpack(const struct ib_field *desc, 279 int desc_len, 280 void *buf, 281 void *structure); 282 283 __sum16 ib_ud_ip4_csum(struct ib_ud_header *header); 284 285 int ib_ud_header_init(int payload_bytes, 286 int lrh_present, 287 int eth_present, 288 int vlan_present, 289 int grh_present, 290 int ip_version, 291 int udp_present, 292 int immediate_present, 293 struct ib_ud_header *header); 294 295 int ib_ud_header_pack(struct ib_ud_header *header, 296 void *buf); 297 298 int ib_ud_header_unpack(void *buf, 299 struct ib_ud_header *header); 300 301 #endif /* IB_PACK_H */ 302