2 * Copyright (c) 2004 Topspin Corporation. All rights reserved.
3 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
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:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
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.
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
34 #include <linux/errno.h>
35 #include <linux/string.h>
37 #include <rdma/ib_pack.h>
39 #define STRUCT_FIELD(header, field) \
40 .struct_offset_bytes = offsetof(struct ib_unpacked_ ## header, field), \
41 .struct_size_bytes = sizeof ((struct ib_unpacked_ ## header *) 0)->field, \
42 .field_name = #header ":" #field
44 static const struct ib_field lrh_table[] = {
45 { STRUCT_FIELD(lrh, virtual_lane),
49 { STRUCT_FIELD(lrh, link_version),
53 { STRUCT_FIELD(lrh, service_level),
61 { STRUCT_FIELD(lrh, link_next_header),
65 { STRUCT_FIELD(lrh, destination_lid),
73 { STRUCT_FIELD(lrh, packet_length),
77 { STRUCT_FIELD(lrh, source_lid),
83 static const struct ib_field grh_table[] = {
84 { STRUCT_FIELD(grh, ip_version),
88 { STRUCT_FIELD(grh, traffic_class),
92 { STRUCT_FIELD(grh, flow_label),
96 { STRUCT_FIELD(grh, payload_length),
100 { STRUCT_FIELD(grh, next_header),
104 { STRUCT_FIELD(grh, hop_limit),
108 { STRUCT_FIELD(grh, source_gid),
112 { STRUCT_FIELD(grh, destination_gid),
118 static const struct ib_field bth_table[] = {
119 { STRUCT_FIELD(bth, opcode),
123 { STRUCT_FIELD(bth, solicited_event),
127 { STRUCT_FIELD(bth, mig_req),
131 { STRUCT_FIELD(bth, pad_count),
135 { STRUCT_FIELD(bth, transport_header_version),
139 { STRUCT_FIELD(bth, pkey),
147 { STRUCT_FIELD(bth, destination_qpn),
151 { STRUCT_FIELD(bth, ack_req),
159 { STRUCT_FIELD(bth, psn),
165 static const struct ib_field deth_table[] = {
166 { STRUCT_FIELD(deth, qkey),
174 { STRUCT_FIELD(deth, source_qpn),
181 * ib_ud_header_init - Initialize UD header structure
182 * @payload_bytes:Length of packet payload
183 * @grh_present:GRH flag (if non-zero, GRH will be included)
184 * @immediate_present: specify if immediate data should be used
185 * @header:Structure to initialize
187 * ib_ud_header_init() initializes the lrh.link_version, lrh.link_next_header,
188 * lrh.packet_length, grh.ip_version, grh.payload_length,
189 * grh.next_header, bth.opcode, bth.pad_count and
190 * bth.transport_header_version fields of a &struct ib_ud_header given
191 * the payload length and whether a GRH will be included.
193 void ib_ud_header_init(int payload_bytes,
195 int immediate_present,
196 struct ib_ud_header *header)
200 memset(header, 0, sizeof *header);
202 header->lrh.link_version = 0;
203 header->lrh.link_next_header =
204 grh_present ? IB_LNH_IBA_GLOBAL : IB_LNH_IBA_LOCAL;
205 packet_length = (IB_LRH_BYTES +
210 3) / 4; /* round up */
212 header->grh_present = grh_present;
214 packet_length += IB_GRH_BYTES / 4;
215 header->grh.ip_version = 6;
216 header->grh.payload_length =
217 cpu_to_be16((IB_BTH_BYTES +
221 3) & ~3); /* round up */
222 header->grh.next_header = 0x1b;
225 header->lrh.packet_length = cpu_to_be16(packet_length);
227 header->immediate_present = immediate_present;
228 if (immediate_present)
229 header->bth.opcode = IB_OPCODE_UD_SEND_ONLY_WITH_IMMEDIATE;
231 header->bth.opcode = IB_OPCODE_UD_SEND_ONLY;
232 header->bth.pad_count = (4 - payload_bytes) & 3;
233 header->bth.transport_header_version = 0;
235 EXPORT_SYMBOL(ib_ud_header_init);
238 * ib_ud_header_pack - Pack UD header struct into wire format
239 * @header:UD header struct
240 * @buf:Buffer to pack into
242 * ib_ud_header_pack() packs the UD header structure @header into wire
243 * format in the buffer @buf.
245 int ib_ud_header_pack(struct ib_ud_header *header,
250 ib_pack(lrh_table, ARRAY_SIZE(lrh_table),
254 if (header->grh_present) {
255 ib_pack(grh_table, ARRAY_SIZE(grh_table),
256 &header->grh, buf + len);
260 ib_pack(bth_table, ARRAY_SIZE(bth_table),
261 &header->bth, buf + len);
264 ib_pack(deth_table, ARRAY_SIZE(deth_table),
265 &header->deth, buf + len);
266 len += IB_DETH_BYTES;
268 if (header->immediate_present) {
269 memcpy(buf + len, &header->immediate_data, sizeof header->immediate_data);
270 len += sizeof header->immediate_data;
275 EXPORT_SYMBOL(ib_ud_header_pack);
278 * ib_ud_header_unpack - Unpack UD header struct from wire format
279 * @header:UD header struct
280 * @buf:Buffer to pack into
282 * ib_ud_header_pack() unpacks the UD header structure @header from wire
283 * format in the buffer @buf.
285 int ib_ud_header_unpack(void *buf,
286 struct ib_ud_header *header)
288 ib_unpack(lrh_table, ARRAY_SIZE(lrh_table),
292 if (header->lrh.link_version != 0) {
293 printk(KERN_WARNING "Invalid LRH.link_version %d\n",
294 header->lrh.link_version);
298 switch (header->lrh.link_next_header) {
299 case IB_LNH_IBA_LOCAL:
300 header->grh_present = 0;
303 case IB_LNH_IBA_GLOBAL:
304 header->grh_present = 1;
305 ib_unpack(grh_table, ARRAY_SIZE(grh_table),
309 if (header->grh.ip_version != 6) {
310 printk(KERN_WARNING "Invalid GRH.ip_version %d\n",
311 header->grh.ip_version);
314 if (header->grh.next_header != 0x1b) {
315 printk(KERN_WARNING "Invalid GRH.next_header 0x%02x\n",
316 header->grh.next_header);
322 printk(KERN_WARNING "Invalid LRH.link_next_header %d\n",
323 header->lrh.link_next_header);
327 ib_unpack(bth_table, ARRAY_SIZE(bth_table),
331 switch (header->bth.opcode) {
332 case IB_OPCODE_UD_SEND_ONLY:
333 header->immediate_present = 0;
335 case IB_OPCODE_UD_SEND_ONLY_WITH_IMMEDIATE:
336 header->immediate_present = 1;
339 printk(KERN_WARNING "Invalid BTH.opcode 0x%02x\n",
344 if (header->bth.transport_header_version != 0) {
345 printk(KERN_WARNING "Invalid BTH.transport_header_version %d\n",
346 header->bth.transport_header_version);
350 ib_unpack(deth_table, ARRAY_SIZE(deth_table),
352 buf += IB_DETH_BYTES;
354 if (header->immediate_present)
355 memcpy(&header->immediate_data, buf, sizeof header->immediate_data);
359 EXPORT_SYMBOL(ib_ud_header_unpack);