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