ib_pack.h 7.7 KB

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