linux/include/rdma/ib_pack.h
<<
>>
Prefs 
   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
  39enum {
  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
  50struct 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
  75enum {
  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        /* opcode 0x15 is reserved */
 107        IB_OPCODE_SEND_LAST_WITH_INVALIDATE         = 0x16,
 108        IB_OPCODE_SEND_ONLY_WITH_INVALIDATE         = 0x17,
 109
 110        /* real constants follow -- see comment about above IB_OPCODE()
 111           macro for more details */
 112
 113        /* RC */
 114        IB_OPCODE(RC, SEND_FIRST),
 115        IB_OPCODE(RC, SEND_MIDDLE),
 116        IB_OPCODE(RC, SEND_LAST),
 117        IB_OPCODE(RC, SEND_LAST_WITH_IMMEDIATE),
 118        IB_OPCODE(RC, SEND_ONLY),
 119        IB_OPCODE(RC, SEND_ONLY_WITH_IMMEDIATE),
 120        IB_OPCODE(RC, RDMA_WRITE_FIRST),
 121        IB_OPCODE(RC, RDMA_WRITE_MIDDLE),
 122        IB_OPCODE(RC, RDMA_WRITE_LAST),
 123        IB_OPCODE(RC, RDMA_WRITE_LAST_WITH_IMMEDIATE),
 124        IB_OPCODE(RC, RDMA_WRITE_ONLY),
 125        IB_OPCODE(RC, RDMA_WRITE_ONLY_WITH_IMMEDIATE),
 126        IB_OPCODE(RC, RDMA_READ_REQUEST),
 127        IB_OPCODE(RC, RDMA_READ_RESPONSE_FIRST),
 128        IB_OPCODE(RC, RDMA_READ_RESPONSE_MIDDLE),
 129        IB_OPCODE(RC, RDMA_READ_RESPONSE_LAST),
 130        IB_OPCODE(RC, RDMA_READ_RESPONSE_ONLY),
 131        IB_OPCODE(RC, ACKNOWLEDGE),
 132        IB_OPCODE(RC, ATOMIC_ACKNOWLEDGE),
 133        IB_OPCODE(RC, COMPARE_SWAP),
 134        IB_OPCODE(RC, FETCH_ADD),
 135        IB_OPCODE(RC, SEND_LAST_WITH_INVALIDATE),
 136        IB_OPCODE(RC, SEND_ONLY_WITH_INVALIDATE),
 137
 138        /* UC */
 139        IB_OPCODE(UC, SEND_FIRST),
 140        IB_OPCODE(UC, SEND_MIDDLE),
 141        IB_OPCODE(UC, SEND_LAST),
 142        IB_OPCODE(UC, SEND_LAST_WITH_IMMEDIATE),
 143        IB_OPCODE(UC, SEND_ONLY),
 144        IB_OPCODE(UC, SEND_ONLY_WITH_IMMEDIATE),
 145        IB_OPCODE(UC, RDMA_WRITE_FIRST),
 146        IB_OPCODE(UC, RDMA_WRITE_MIDDLE),
 147        IB_OPCODE(UC, RDMA_WRITE_LAST),
 148        IB_OPCODE(UC, RDMA_WRITE_LAST_WITH_IMMEDIATE),
 149        IB_OPCODE(UC, RDMA_WRITE_ONLY),
 150        IB_OPCODE(UC, RDMA_WRITE_ONLY_WITH_IMMEDIATE),
 151
 152        /* RD */
 153        IB_OPCODE(RD, SEND_FIRST),
 154        IB_OPCODE(RD, SEND_MIDDLE),
 155        IB_OPCODE(RD, SEND_LAST),
 156        IB_OPCODE(RD, SEND_LAST_WITH_IMMEDIATE),
 157        IB_OPCODE(RD, SEND_ONLY),
 158        IB_OPCODE(RD, SEND_ONLY_WITH_IMMEDIATE),
 159        IB_OPCODE(RD, RDMA_WRITE_FIRST),
 160        IB_OPCODE(RD, RDMA_WRITE_MIDDLE),
 161        IB_OPCODE(RD, RDMA_WRITE_LAST),
 162        IB_OPCODE(RD, RDMA_WRITE_LAST_WITH_IMMEDIATE),
 163        IB_OPCODE(RD, RDMA_WRITE_ONLY),
 164        IB_OPCODE(RD, RDMA_WRITE_ONLY_WITH_IMMEDIATE),
 165        IB_OPCODE(RD, RDMA_READ_REQUEST),
 166        IB_OPCODE(RD, RDMA_READ_RESPONSE_FIRST),
 167        IB_OPCODE(RD, RDMA_READ_RESPONSE_MIDDLE),
 168        IB_OPCODE(RD, RDMA_READ_RESPONSE_LAST),
 169        IB_OPCODE(RD, RDMA_READ_RESPONSE_ONLY),
 170        IB_OPCODE(RD, ACKNOWLEDGE),
 171        IB_OPCODE(RD, ATOMIC_ACKNOWLEDGE),
 172        IB_OPCODE(RD, COMPARE_SWAP),
 173        IB_OPCODE(RD, FETCH_ADD),
 174
 175        /* UD */
 176        IB_OPCODE(UD, SEND_ONLY),
 177        IB_OPCODE(UD, SEND_ONLY_WITH_IMMEDIATE)
 178};
 179
 180enum {
 181        IB_LNH_RAW        = 0,
 182        IB_LNH_IP         = 1,
 183        IB_LNH_IBA_LOCAL  = 2,
 184        IB_LNH_IBA_GLOBAL = 3
 185};
 186
 187struct ib_unpacked_lrh {
 188        u8        virtual_lane;
 189        u8        link_version;
 190        u8        service_level;
 191        u8        link_next_header;
 192        __be16    destination_lid;
 193        __be16    packet_length;
 194        __be16    source_lid;
 195};
 196
 197struct ib_unpacked_grh {
 198        u8           ip_version;
 199        u8           traffic_class;
 200        __be32       flow_label;
 201        __be16       payload_length;
 202        u8           next_header;
 203        u8           hop_limit;
 204        union ib_gid source_gid;
 205        union ib_gid destination_gid;
 206};
 207
 208struct ib_unpacked_bth {
 209        u8           opcode;
 210        u8           solicited_event;
 211        u8           mig_req;
 212        u8           pad_count;
 213        u8           transport_header_version;
 214        __be16       pkey;
 215        __be32       destination_qpn;
 216        u8           ack_req;
 217        __be32       psn;
 218};
 219
 220struct ib_unpacked_deth {
 221        __be32       qkey;
 222        __be32       source_qpn;
 223};
 224
 225struct ib_unpacked_eth {
 226        u8      dmac_h[4];
 227        u8      dmac_l[2];
 228        u8      smac_h[2];
 229        u8      smac_l[4];
 230        __be16  type;
 231};
 232
 233struct ib_unpacked_ip4 {
 234        u8      ver;
 235        u8      hdr_len;
 236        u8      tos;
 237        __be16  tot_len;
 238        __be16  id;
 239        __be16  frag_off;
 240        u8      ttl;
 241        u8      protocol;
 242        __sum16 check;
 243        __be32  saddr;
 244        __be32  daddr;
 245};
 246
 247struct ib_unpacked_udp {
 248        __be16  sport;
 249        __be16  dport;
 250        __be16  length;
 251        __be16  csum;
 252};
 253
 254struct ib_unpacked_vlan {
 255        __be16  tag;
 256        __be16  type;
 257};
 258
 259struct ib_ud_header {
 260        int                     lrh_present;
 261        struct ib_unpacked_lrh  lrh;
 262        int                     eth_present;
 263        struct ib_unpacked_eth  eth;
 264        int                     vlan_present;
 265        struct ib_unpacked_vlan vlan;
 266        int                     grh_present;
 267        struct ib_unpacked_grh  grh;
 268        int                     ipv4_present;
 269        struct ib_unpacked_ip4  ip4;
 270        int                     udp_present;
 271        struct ib_unpacked_udp  udp;
 272        struct ib_unpacked_bth  bth;
 273        struct ib_unpacked_deth deth;
 274        int                     immediate_present;
 275        __be32                  immediate_data;
 276};
 277
 278void ib_pack(const struct ib_field        *desc,
 279             int                           desc_len,
 280             void                         *structure,
 281             void                         *buf);
 282
 283void ib_unpack(const struct ib_field        *desc,
 284               int                           desc_len,
 285               void                         *buf,
 286               void                         *structure);
 287
 288__sum16 ib_ud_ip4_csum(struct ib_ud_header *header);
 289
 290int ib_ud_header_init(int                   payload_bytes,
 291                      int                   lrh_present,
 292                      int                   eth_present,
 293                      int                   vlan_present,
 294                      int                   grh_present,
 295                      int                   ip_version,
 296                      int                   udp_present,
 297                      int                   immediate_present,
 298                      struct ib_ud_header *header);
 299
 300int ib_ud_header_pack(struct ib_ud_header *header,
 301                      void                *buf);
 302
 303int ib_ud_header_unpack(void                *buf,
 304                        struct ib_ud_header *header);
 305
 306#endif /* IB_PACK_H */
 307
Hosted by Missing Link Electronics. The original LXR software by the LXR community, this experimental version by lxr@linux.no.