ib_pack.h 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245
  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. * $Id: ib_pack.h,v 1.1.1.1 2007/06/12 07:27:15 eyryu Exp $
  33. */
  34. #ifndef IB_PACK_H
  35. #define IB_PACK_H
  36. #include <rdma/ib_verbs.h>
  37. enum {
  38. IB_LRH_BYTES = 8,
  39. IB_GRH_BYTES = 40,
  40. IB_BTH_BYTES = 12,
  41. IB_DETH_BYTES = 8
  42. };
  43. struct ib_field {
  44. size_t struct_offset_bytes;
  45. size_t struct_size_bytes;
  46. int offset_words;
  47. int offset_bits;
  48. int size_bits;
  49. char *field_name;
  50. };
  51. #define RESERVED \
  52. .field_name = "reserved"
  53. /*
  54. * This macro cleans up the definitions of constants for BTH opcodes.
  55. * It is used to define constants such as IB_OPCODE_UD_SEND_ONLY,
  56. * which becomes IB_OPCODE_UD + IB_OPCODE_SEND_ONLY, and this gives
  57. * the correct value.
  58. *
  59. * In short, user code should use the constants defined using the
  60. * macro rather than worrying about adding together other constants.
  61. */
  62. #define IB_OPCODE(transport, op) \
  63. IB_OPCODE_ ## transport ## _ ## op = \
  64. IB_OPCODE_ ## transport + IB_OPCODE_ ## op
  65. enum {
  66. /* transport types -- just used to define real constants */
  67. IB_OPCODE_RC = 0x00,
  68. IB_OPCODE_UC = 0x20,
  69. IB_OPCODE_RD = 0x40,
  70. IB_OPCODE_UD = 0x60,
  71. /* operations -- just used to define real constants */
  72. IB_OPCODE_SEND_FIRST = 0x00,
  73. IB_OPCODE_SEND_MIDDLE = 0x01,
  74. IB_OPCODE_SEND_LAST = 0x02,
  75. IB_OPCODE_SEND_LAST_WITH_IMMEDIATE = 0x03,
  76. IB_OPCODE_SEND_ONLY = 0x04,
  77. IB_OPCODE_SEND_ONLY_WITH_IMMEDIATE = 0x05,
  78. IB_OPCODE_RDMA_WRITE_FIRST = 0x06,
  79. IB_OPCODE_RDMA_WRITE_MIDDLE = 0x07,
  80. IB_OPCODE_RDMA_WRITE_LAST = 0x08,
  81. IB_OPCODE_RDMA_WRITE_LAST_WITH_IMMEDIATE = 0x09,
  82. IB_OPCODE_RDMA_WRITE_ONLY = 0x0a,
  83. IB_OPCODE_RDMA_WRITE_ONLY_WITH_IMMEDIATE = 0x0b,
  84. IB_OPCODE_RDMA_READ_REQUEST = 0x0c,
  85. IB_OPCODE_RDMA_READ_RESPONSE_FIRST = 0x0d,
  86. IB_OPCODE_RDMA_READ_RESPONSE_MIDDLE = 0x0e,
  87. IB_OPCODE_RDMA_READ_RESPONSE_LAST = 0x0f,
  88. IB_OPCODE_RDMA_READ_RESPONSE_ONLY = 0x10,
  89. IB_OPCODE_ACKNOWLEDGE = 0x11,
  90. IB_OPCODE_ATOMIC_ACKNOWLEDGE = 0x12,
  91. IB_OPCODE_COMPARE_SWAP = 0x13,
  92. IB_OPCODE_FETCH_ADD = 0x14,
  93. /* real constants follow -- see comment about above IB_OPCODE()
  94. macro for more details */
  95. /* RC */
  96. IB_OPCODE(RC, SEND_FIRST),
  97. IB_OPCODE(RC, SEND_MIDDLE),
  98. IB_OPCODE(RC, SEND_LAST),
  99. IB_OPCODE(RC, SEND_LAST_WITH_IMMEDIATE),
  100. IB_OPCODE(RC, SEND_ONLY),
  101. IB_OPCODE(RC, SEND_ONLY_WITH_IMMEDIATE),
  102. IB_OPCODE(RC, RDMA_WRITE_FIRST),
  103. IB_OPCODE(RC, RDMA_WRITE_MIDDLE),
  104. IB_OPCODE(RC, RDMA_WRITE_LAST),
  105. IB_OPCODE(RC, RDMA_WRITE_LAST_WITH_IMMEDIATE),
  106. IB_OPCODE(RC, RDMA_WRITE_ONLY),
  107. IB_OPCODE(RC, RDMA_WRITE_ONLY_WITH_IMMEDIATE),
  108. IB_OPCODE(RC, RDMA_READ_REQUEST),
  109. IB_OPCODE(RC, RDMA_READ_RESPONSE_FIRST),
  110. IB_OPCODE(RC, RDMA_READ_RESPONSE_MIDDLE),
  111. IB_OPCODE(RC, RDMA_READ_RESPONSE_LAST),
  112. IB_OPCODE(RC, RDMA_READ_RESPONSE_ONLY),
  113. IB_OPCODE(RC, ACKNOWLEDGE),
  114. IB_OPCODE(RC, ATOMIC_ACKNOWLEDGE),
  115. IB_OPCODE(RC, COMPARE_SWAP),
  116. IB_OPCODE(RC, FETCH_ADD),
  117. /* UC */
  118. IB_OPCODE(UC, SEND_FIRST),
  119. IB_OPCODE(UC, SEND_MIDDLE),
  120. IB_OPCODE(UC, SEND_LAST),
  121. IB_OPCODE(UC, SEND_LAST_WITH_IMMEDIATE),
  122. IB_OPCODE(UC, SEND_ONLY),
  123. IB_OPCODE(UC, SEND_ONLY_WITH_IMMEDIATE),
  124. IB_OPCODE(UC, RDMA_WRITE_FIRST),
  125. IB_OPCODE(UC, RDMA_WRITE_MIDDLE),
  126. IB_OPCODE(UC, RDMA_WRITE_LAST),
  127. IB_OPCODE(UC, RDMA_WRITE_LAST_WITH_IMMEDIATE),
  128. IB_OPCODE(UC, RDMA_WRITE_ONLY),
  129. IB_OPCODE(UC, RDMA_WRITE_ONLY_WITH_IMMEDIATE),
  130. /* RD */
  131. IB_OPCODE(RD, SEND_FIRST),
  132. IB_OPCODE(RD, SEND_MIDDLE),
  133. IB_OPCODE(RD, SEND_LAST),
  134. IB_OPCODE(RD, SEND_LAST_WITH_IMMEDIATE),
  135. IB_OPCODE(RD, SEND_ONLY),
  136. IB_OPCODE(RD, SEND_ONLY_WITH_IMMEDIATE),
  137. IB_OPCODE(RD, RDMA_WRITE_FIRST),
  138. IB_OPCODE(RD, RDMA_WRITE_MIDDLE),
  139. IB_OPCODE(RD, RDMA_WRITE_LAST),
  140. IB_OPCODE(RD, RDMA_WRITE_LAST_WITH_IMMEDIATE),
  141. IB_OPCODE(RD, RDMA_WRITE_ONLY),
  142. IB_OPCODE(RD, RDMA_WRITE_ONLY_WITH_IMMEDIATE),
  143. IB_OPCODE(RD, RDMA_READ_REQUEST),
  144. IB_OPCODE(RD, RDMA_READ_RESPONSE_FIRST),
  145. IB_OPCODE(RD, RDMA_READ_RESPONSE_MIDDLE),
  146. IB_OPCODE(RD, RDMA_READ_RESPONSE_LAST),
  147. IB_OPCODE(RD, RDMA_READ_RESPONSE_ONLY),
  148. IB_OPCODE(RD, ACKNOWLEDGE),
  149. IB_OPCODE(RD, ATOMIC_ACKNOWLEDGE),
  150. IB_OPCODE(RD, COMPARE_SWAP),
  151. IB_OPCODE(RD, FETCH_ADD),
  152. /* UD */
  153. IB_OPCODE(UD, SEND_ONLY),
  154. IB_OPCODE(UD, SEND_ONLY_WITH_IMMEDIATE)
  155. };
  156. enum {
  157. IB_LNH_RAW = 0,
  158. IB_LNH_IP = 1,
  159. IB_LNH_IBA_LOCAL = 2,
  160. IB_LNH_IBA_GLOBAL = 3
  161. };
  162. struct ib_unpacked_lrh {
  163. u8 virtual_lane;
  164. u8 link_version;
  165. u8 service_level;
  166. u8 link_next_header;
  167. __be16 destination_lid;
  168. __be16 packet_length;
  169. __be16 source_lid;
  170. };
  171. struct ib_unpacked_grh {
  172. u8 ip_version;
  173. u8 traffic_class;
  174. __be32 flow_label;
  175. __be16 payload_length;
  176. u8 next_header;
  177. u8 hop_limit;
  178. union ib_gid source_gid;
  179. union ib_gid destination_gid;
  180. };
  181. struct ib_unpacked_bth {
  182. u8 opcode;
  183. u8 solicited_event;
  184. u8 mig_req;
  185. u8 pad_count;
  186. u8 transport_header_version;
  187. __be16 pkey;
  188. __be32 destination_qpn;
  189. u8 ack_req;
  190. __be32 psn;
  191. };
  192. struct ib_unpacked_deth {
  193. __be32 qkey;
  194. __be32 source_qpn;
  195. };
  196. struct ib_ud_header {
  197. struct ib_unpacked_lrh lrh;
  198. int grh_present;
  199. struct ib_unpacked_grh grh;
  200. struct ib_unpacked_bth bth;
  201. struct ib_unpacked_deth deth;
  202. int immediate_present;
  203. __be32 immediate_data;
  204. };
  205. void ib_pack(const struct ib_field *desc,
  206. int desc_len,
  207. void *structure,
  208. void *buf);
  209. void ib_unpack(const struct ib_field *desc,
  210. int desc_len,
  211. void *buf,
  212. void *structure);
  213. void ib_ud_header_init(int payload_bytes,
  214. int grh_present,
  215. struct ib_ud_header *header);
  216. int ib_ud_header_pack(struct ib_ud_header *header,
  217. void *buf);
  218. int ib_ud_header_unpack(void *buf,
  219. struct ib_ud_header *header);
  220. #endif /* IB_PACK_H */