75bf271e84af812fae510f85282d101f1335c7fe
[people/lynusvaz/gpxe.git] / src / include / gpxe / ib_mad.h
1 #ifndef _GPXE_IB_MAD_H
2 #define _GPXE_IB_MAD_H
3
4 /** @file
5  *
6  * Infiniband management datagrams
7  *
8  */
9
10 FILE_LICENCE ( GPL2_OR_LATER );
11
12 #include <stdint.h>
13 #include <gpxe/ib_packet.h>
14
15 /*****************************************************************************
16  *
17  * Subnet management MADs
18  *
19  *****************************************************************************
20  */
21
22 /** A subnet management header
23  *
24  * Defined in sections 14.2.1.1 and 14.2.1.2 of the IBA.
25  */
26 struct ib_smp_hdr {
27         uint64_t mkey;
28         uint16_t slid;
29         uint16_t dlid;
30         uint8_t reserved[28];
31 } __attribute__ (( packed ));
32
33 /** Bits to ignore in the management class for subnet management MADs */
34 #define IB_SMP_CLASS_IGNORE                     0x80
35
36 /** Subnet management class version */
37 #define IB_SMP_CLASS_VERSION                    1
38
39 /** Subnet management direction bit
40  *
41  * This bit resides in the "status" field in the MAD header.
42  */
43 #define IB_SMP_STATUS_D_INBOUND                 0x8000
44
45 /* Subnet management attributes */
46 #define IB_SMP_ATTR_NOTICE                      0x0002
47 #define IB_SMP_ATTR_NODE_DESC                   0x0010
48 #define IB_SMP_ATTR_NODE_INFO                   0x0011
49 #define IB_SMP_ATTR_SWITCH_INFO                 0x0012
50 #define IB_SMP_ATTR_GUID_INFO                   0x0014
51 #define IB_SMP_ATTR_PORT_INFO                   0x0015
52 #define IB_SMP_ATTR_PKEY_TABLE                  0x0016
53 #define IB_SMP_ATTR_SL_TO_VL_TABLE              0x0017
54 #define IB_SMP_ATTR_VL_ARB_TABLE                0x0018
55 #define IB_SMP_ATTR_LINEAR_FORWARD_TABLE        0x0019
56 #define IB_SMP_ATTR_RANDOM_FORWARD_TABLE        0x001A
57 #define IB_SMP_ATTR_MCAST_FORWARD_TABLE         0x001B
58 #define IB_SMP_ATTR_SM_INFO                     0x0020
59 #define IB_SMP_ATTR_VENDOR_DIAG                 0x0030
60 #define IB_SMP_ATTR_LED_INFO                    0x0031
61 #define IB_SMP_ATTR_VENDOR_MASK                 0xFF00
62
63 /**
64  * A Node Description attribute
65  *
66  * Defined in section 14.2.5.2 of the IBA
67  */
68 struct ib_node_desc {
69         char node_string[64];
70 } __attribute__ (( packed ));
71
72 /** A Node Information attribute
73  *
74  * Defined in section 14.2.5.3 of the IBA.
75  */
76 struct ib_node_info {
77         uint8_t base_version;
78         uint8_t class_version;
79         uint8_t node_type;
80         uint8_t num_ports;
81         struct ib_gid_half sys_guid;
82         struct ib_gid_half node_guid;
83         struct ib_gid_half port_guid;
84         uint16_t partition_cap;
85         uint16_t device_id;
86         uint32_t revision;
87         uint8_t local_port_num;
88         uint8_t vendor_id[3];
89 } __attribute__ ((packed));
90
91 #define IB_NODE_TYPE_HCA                0x01
92 #define IB_NODE_TYPE_SWITCH             0x02
93 #define IB_NODE_TYPE_ROUTER             0x03
94
95 /** A GUID Information attribute
96  *
97  * Defined in section 14.2.5.5 of the IBA.
98  */
99 struct ib_guid_info {
100         uint8_t guid[8][8];
101 } __attribute__ (( packed ));
102
103 /** A Port Information attribute
104  *
105  * Defined in section 14.2.5.6 of the IBA.
106  */
107 struct ib_port_info {
108         uint64_t mkey;
109         uint8_t gid_prefix[8];
110         uint16_t lid;
111         uint16_t mastersm_lid;
112         uint32_t cap_mask;
113         uint16_t diag_code;
114         uint16_t mkey_lease_period;
115         uint8_t local_port_num;
116         uint8_t link_width_enabled;
117         uint8_t link_width_supported;
118         uint8_t link_width_active;
119         uint8_t link_speed_supported__port_state;
120         uint8_t port_phys_state__link_down_def_state;
121         uint8_t mkey_prot_bits__lmc;
122         uint8_t link_speed_active__link_speed_enabled;
123         uint8_t neighbour_mtu__mastersm_sl;
124         uint8_t vl_cap__init_type;
125         uint8_t vl_high_limit;
126         uint8_t vl_arbitration_high_cap;
127         uint8_t vl_arbitration_low_cap;
128         uint8_t init_type_reply__mtu_cap;
129         uint8_t vl_stall_count__hoq_life;
130         uint8_t operational_vls__enforcement;
131         uint16_t mkey_violations;
132         uint16_t pkey_violations;
133         uint16_t qkey_violations;
134         uint8_t guid_cap;
135         uint8_t client_reregister__subnet_timeout;
136         uint8_t resp_time_value;
137         uint8_t local_phy_errors__overrun_errors;
138         uint16_t max_credit_hint;
139         uint32_t link_round_trip_latency;
140 } __attribute__ (( packed ));
141
142 #define IB_LINK_WIDTH_1X                0x01
143 #define IB_LINK_WIDTH_4X                0x02
144 #define IB_LINK_WIDTH_8X                0x04
145 #define IB_LINK_WIDTH_12X               0x08
146
147 #define IB_LINK_SPEED_SDR               0x01
148 #define IB_LINK_SPEED_DDR               0x02
149 #define IB_LINK_SPEED_QDR               0x04
150
151 #define IB_PORT_STATE_DOWN              0x01
152 #define IB_PORT_STATE_INIT              0x02
153 #define IB_PORT_STATE_ARMED             0x03
154 #define IB_PORT_STATE_ACTIVE            0x04
155
156 #define IB_PORT_PHYS_STATE_SLEEP        0x01
157 #define IB_PORT_PHYS_STATE_POLLING      0x02
158
159 #define IB_MTU_256                      0x01
160 #define IB_MTU_512                      0x02
161 #define IB_MTU_1024                     0x03
162 #define IB_MTU_2048                     0x04
163 #define IB_MTU_4096                     0x05
164
165 #define IB_VL_0                         0x01
166 #define IB_VL_0_1                       0x02
167 #define IB_VL_0_3                       0x03
168 #define IB_VL_0_7                       0x04
169 #define IB_VL_0_14                      0x05
170
171 /** A Partition Key Table attribute
172  *
173  * Defined in section 14.2.5.7 of the IBA.
174  */
175 struct ib_pkey_table {
176         uint16_t pkey[32];
177 } __attribute__ (( packed ));
178
179 /** A subnet management attribute */
180 union ib_smp_data {
181         struct ib_node_desc node_desc;
182         struct ib_node_info node_info;
183         struct ib_guid_info guid_info;
184         struct ib_port_info port_info;
185         struct ib_pkey_table pkey_table;
186         uint8_t bytes[64];
187 } __attribute__ (( packed ));
188
189 /** A subnet management directed route path */
190 struct ib_smp_dr_path {
191         uint8_t hops[64];
192 } __attribute__ (( packed ));
193
194 /** Subnet management MAD class-specific data */
195 struct ib_smp_class_specific {
196         uint8_t hop_pointer;
197         uint8_t hop_count;
198 } __attribute__ (( packed ));
199
200 /*****************************************************************************
201  *
202  * Subnet administration MADs
203  *
204  *****************************************************************************
205  */
206
207 #define IB_SA_CLASS_VERSION                     2
208
209 #define IB_SA_METHOD_DELETE_RESP                0x95
210
211 struct ib_rmpp_hdr {
212         uint32_t raw[3];
213 } __attribute__ (( packed ));
214
215 struct ib_sa_hdr {
216         uint32_t sm_key[2];
217         uint16_t reserved;
218         uint16_t attrib_offset;
219         uint32_t comp_mask[2];
220 } __attribute__ (( packed ));
221
222 #define IB_SA_ATTR_MC_MEMBER_REC                0x38
223 #define IB_SA_ATTR_PATH_REC                     0x35
224
225 struct ib_path_record {
226         uint32_t reserved0[2];
227         struct ib_gid dgid;
228         struct ib_gid sgid;
229         uint16_t dlid;
230         uint16_t slid;
231         uint32_t hop_limit__flow_label__raw_traffic;
232         uint32_t pkey__numb_path__reversible__tclass;
233         uint8_t reserved1;
234         uint8_t reserved__sl;
235         uint8_t mtu_selector__mtu;
236         uint8_t rate_selector__rate;
237         uint32_t preference__packet_lifetime__packet_lifetime_selector;
238         uint32_t reserved2[35];
239 } __attribute__ (( packed ));
240
241 #define IB_SA_PATH_REC_DGID                     (1<<2)
242 #define IB_SA_PATH_REC_SGID                     (1<<3)
243
244 struct ib_mc_member_record {
245         struct ib_gid mgid;
246         struct ib_gid port_gid;
247         uint32_t qkey;
248         uint16_t mlid;
249         uint8_t mtu_selector__mtu;
250         uint8_t tclass;
251         uint16_t pkey;
252         uint8_t rate_selector__rate;
253         uint8_t packet_lifetime_selector__packet_lifetime;
254         uint32_t sl__flow_label__hop_limit;
255         uint8_t scope__join_state;
256         uint8_t proxy_join__reserved;
257         uint16_t reserved0;
258         uint32_t reserved1[37];
259 } __attribute__ (( packed ));
260
261 #define IB_SA_MCMEMBER_REC_MGID                 (1<<0)
262 #define IB_SA_MCMEMBER_REC_PORT_GID             (1<<1)
263 #define IB_SA_MCMEMBER_REC_QKEY                 (1<<2)
264 #define IB_SA_MCMEMBER_REC_MLID                 (1<<3)
265 #define IB_SA_MCMEMBER_REC_MTU_SELECTOR         (1<<4)
266 #define IB_SA_MCMEMBER_REC_MTU                  (1<<5)
267 #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS        (1<<6)
268 #define IB_SA_MCMEMBER_REC_PKEY                 (1<<7)
269 #define IB_SA_MCMEMBER_REC_RATE_SELECTOR        (1<<8)
270 #define IB_SA_MCMEMBER_REC_RATE                 (1<<9)
271 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR    (1<<10)
272 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME     (1<<11)
273 #define IB_SA_MCMEMBER_REC_SL                   (1<<12)
274 #define IB_SA_MCMEMBER_REC_FLOW_LABEL           (1<<13)
275 #define IB_SA_MCMEMBER_REC_HOP_LIMIT            (1<<14)
276 #define IB_SA_MCMEMBER_REC_SCOPE                (1<<15)
277 #define IB_SA_MCMEMBER_REC_JOIN_STATE           (1<<16)
278 #define IB_SA_MCMEMBER_REC_PROXY_JOIN           (1<<17)
279
280 union ib_sa_data {
281         struct ib_path_record path_record;
282         struct ib_mc_member_record mc_member_record;
283 } __attribute__ (( packed ));
284
285 /*****************************************************************************
286  *
287  * MADs
288  *
289  *****************************************************************************
290  */
291
292 /** Management datagram class_specific data */
293 union ib_mad_class_specific {
294         uint16_t raw;
295         struct ib_smp_class_specific smp;
296 } __attribute__ (( packed ));
297
298 /** A management datagram common header
299  *
300  * Defined in section 13.4.2 of the IBA.
301  */
302 struct ib_mad_hdr {
303         uint8_t base_version;
304         uint8_t mgmt_class;
305         uint8_t class_version;
306         uint8_t method;
307         uint16_t status;
308         union ib_mad_class_specific class_specific;
309         uint32_t tid[2];
310         uint16_t attr_id;
311         uint8_t reserved[2];
312         uint32_t attr_mod;
313 } __attribute__ (( packed ));
314
315 /* Management base version */
316 #define IB_MGMT_BASE_VERSION                    1
317
318 /* Management classes */
319 #define IB_MGMT_CLASS_SUBN_LID_ROUTED           0x01
320 #define IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE       0x81
321 #define IB_MGMT_CLASS_SUBN_ADM                  0x03
322 #define IB_MGMT_CLASS_PERF_MGMT                 0x04
323 #define IB_MGMT_CLASS_BM                        0x05
324 #define IB_MGMT_CLASS_DEVICE_MGMT               0x06
325 #define IB_MGMT_CLASS_CM                        0x07
326 #define IB_MGMT_CLASS_SNMP                      0x08
327 #define IB_MGMT_CLASS_VENDOR_RANGE2_START       0x30
328 #define IB_MGMT_CLASS_VENDOR_RANGE2_END         0x4F
329
330 /* Management methods */
331 #define IB_MGMT_METHOD_GET                      0x01
332 #define IB_MGMT_METHOD_SET                      0x02
333 #define IB_MGMT_METHOD_GET_RESP                 0x81
334 #define IB_MGMT_METHOD_SEND                     0x03
335 #define IB_MGMT_METHOD_TRAP                     0x05
336 #define IB_MGMT_METHOD_REPORT                   0x06
337 #define IB_MGMT_METHOD_REPORT_RESP              0x86
338 #define IB_MGMT_METHOD_TRAP_REPRESS             0x07
339 #define IB_MGMT_METHOD_DELETE                   0x15
340
341 /* Status codes */
342 #define IB_MGMT_STATUS_OK                       0x0000
343 #define IB_MGMT_STATUS_BAD_VERSION              0x0001
344 #define IB_MGMT_STATUS_UNSUPPORTED_METHOD       0x0002
345 #define IB_MGMT_STATUS_UNSUPPORTED_METHOD_ATTR  0x0003
346 #define IB_MGMT_STATUS_INVALID_VALUE            0x0004
347
348 /** A subnet management MAD */
349 struct ib_mad_smp {
350         struct ib_mad_hdr mad_hdr;
351         struct ib_smp_hdr smp_hdr;
352         union ib_smp_data smp_data;
353         struct ib_smp_dr_path initial_path;
354         struct ib_smp_dr_path return_path;
355 } __attribute__ (( packed ));
356
357 /** A subnet administration MAD */
358 struct ib_mad_sa {
359         struct ib_mad_hdr mad_hdr;
360         struct ib_rmpp_hdr rmpp_hdr;
361         struct ib_sa_hdr sa_hdr;
362         union ib_sa_data sa_data;
363 } __attribute__ (( packed ));
364
365 /** A management datagram */
366 union ib_mad {
367         struct ib_mad_hdr hdr;
368         struct ib_mad_smp smp;
369         struct ib_mad_sa sa;
370         uint8_t bytes[256];
371 } __attribute__ (( packed ));
372
373 #endif /* _GPXE_IB_MAD_H */