2 * Copyright Gavin Shan, IBM Corporation 2016.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
10 #ifndef __NCSI_PKT_H__
11 #define __NCSI_PKT_H__
14 unsigned char mc_id
; /* Management controller ID */
15 unsigned char revision
; /* NCSI version - 0x01 */
16 unsigned char reserved
; /* Reserved */
17 unsigned char id
; /* Packet sequence number */
18 unsigned char type
; /* Packet type */
19 unsigned char channel
; /* Network controller ID */
20 __be16 length
; /* Payload length */
21 __be32 reserved1
[2]; /* Reserved */
24 struct ncsi_cmd_pkt_hdr
{
25 struct ncsi_pkt_hdr common
; /* Common NCSI packet header */
28 struct ncsi_rsp_pkt_hdr
{
29 struct ncsi_pkt_hdr common
; /* Common NCSI packet header */
30 __be16 code
; /* Response code */
31 __be16 reason
; /* Response reason */
34 struct ncsi_aen_pkt_hdr
{
35 struct ncsi_pkt_hdr common
; /* Common NCSI packet header */
36 unsigned char reserved2
[3]; /* Reserved */
37 unsigned char type
; /* AEN packet type */
40 /* NCSI common command packet */
42 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
43 __be32 checksum
; /* Checksum */
44 unsigned char pad
[26];
48 struct ncsi_rsp_pkt_hdr rsp
; /* Response header */
49 __be32 checksum
; /* Checksum */
50 unsigned char pad
[22];
54 struct ncsi_cmd_sp_pkt
{
55 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
56 unsigned char reserved
[3]; /* Reserved */
57 unsigned char hw_arbitration
; /* HW arbitration */
58 __be32 checksum
; /* Checksum */
59 unsigned char pad
[22];
63 struct ncsi_cmd_dc_pkt
{
64 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
65 unsigned char reserved
[3]; /* Reserved */
66 unsigned char ald
; /* Allow link down */
67 __be32 checksum
; /* Checksum */
68 unsigned char pad
[22];
72 struct ncsi_cmd_rc_pkt
{
73 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
74 __be32 reserved
; /* Reserved */
75 __be32 checksum
; /* Checksum */
76 unsigned char pad
[22];
80 struct ncsi_cmd_ae_pkt
{
81 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
82 unsigned char reserved
[3]; /* Reserved */
83 unsigned char mc_id
; /* MC ID */
84 __be32 mode
; /* AEN working mode */
85 __be32 checksum
; /* Checksum */
86 unsigned char pad
[18];
90 struct ncsi_cmd_sl_pkt
{
91 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
92 __be32 mode
; /* Link working mode */
93 __be32 oem_mode
; /* OEM link mode */
94 __be32 checksum
; /* Checksum */
95 unsigned char pad
[18];
99 struct ncsi_cmd_svf_pkt
{
100 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
101 __be16 reserved
; /* Reserved */
102 __be16 vlan
; /* VLAN ID */
103 __be16 reserved1
; /* Reserved */
104 unsigned char index
; /* VLAN table index */
105 unsigned char enable
; /* Enable or disable */
106 __be32 checksum
; /* Checksum */
107 unsigned char pad
[18];
111 struct ncsi_cmd_ev_pkt
{
112 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
113 unsigned char reserved
[3]; /* Reserved */
114 unsigned char mode
; /* VLAN filter mode */
115 __be32 checksum
; /* Checksum */
116 unsigned char pad
[22];
119 /* Set MAC Address */
120 struct ncsi_cmd_sma_pkt
{
121 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
122 unsigned char mac
[6]; /* MAC address */
123 unsigned char index
; /* MAC table index */
124 unsigned char at_e
; /* Addr type and operation */
125 __be32 checksum
; /* Checksum */
126 unsigned char pad
[18];
129 /* Enable Broadcast Filter */
130 struct ncsi_cmd_ebf_pkt
{
131 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
132 __be32 mode
; /* Filter mode */
133 __be32 checksum
; /* Checksum */
134 unsigned char pad
[22];
137 /* Enable Global Multicast Filter */
138 struct ncsi_cmd_egmf_pkt
{
139 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
140 __be32 mode
; /* Global MC mode */
141 __be32 checksum
; /* Checksum */
142 unsigned char pad
[22];
145 /* Set NCSI Flow Control */
146 struct ncsi_cmd_snfc_pkt
{
147 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
148 unsigned char reserved
[3]; /* Reserved */
149 unsigned char mode
; /* Flow control mode */
150 __be32 checksum
; /* Checksum */
151 unsigned char pad
[22];
154 /* OEM Request Command as per NCSI Specification */
155 struct ncsi_cmd_oem_pkt
{
156 struct ncsi_cmd_pkt_hdr cmd
; /* Command header */
157 __be32 mfr_id
; /* Manufacture ID */
158 unsigned char data
[]; /* OEM Payload Data */
161 /* OEM Response Packet as per NCSI Specification */
162 struct ncsi_rsp_oem_pkt
{
163 struct ncsi_rsp_pkt_hdr rsp
; /* Command header */
164 __be32 mfr_id
; /* Manufacture ID */
165 unsigned char data
[]; /* Payload data */
168 /* Mellanox Response Data */
169 struct ncsi_rsp_oem_mlx_pkt
{
170 unsigned char cmd_rev
; /* Command Revision */
171 unsigned char cmd
; /* Command ID */
172 unsigned char param
; /* Parameter */
173 unsigned char optional
; /* Optional data */
174 unsigned char data
[]; /* Data */
177 /* Broadcom Response Data */
178 struct ncsi_rsp_oem_bcm_pkt
{
179 unsigned char ver
; /* Payload Version */
180 unsigned char type
; /* OEM Command type */
181 __be16 len
; /* Payload Length */
182 unsigned char data
[]; /* Cmd specific Data */
185 /* Get Link Status */
186 struct ncsi_rsp_gls_pkt
{
187 struct ncsi_rsp_pkt_hdr rsp
; /* Response header */
188 __be32 status
; /* Link status */
189 __be32 other
; /* Other indications */
190 __be32 oem_status
; /* OEM link status */
192 unsigned char pad
[10];
196 struct ncsi_rsp_gvi_pkt
{
197 struct ncsi_rsp_pkt_hdr rsp
; /* Response header */
198 __be32 ncsi_version
; /* NCSI version */
199 unsigned char reserved
[3]; /* Reserved */
200 unsigned char alpha2
; /* NCSI version */
201 unsigned char fw_name
[12]; /* f/w name string */
202 __be32 fw_version
; /* f/w version */
203 __be16 pci_ids
[4]; /* PCI IDs */
204 __be32 mf_id
; /* Manufacture ID */
208 /* Get Capabilities */
209 struct ncsi_rsp_gc_pkt
{
210 struct ncsi_rsp_pkt_hdr rsp
; /* Response header */
211 __be32 cap
; /* Capabilities */
212 __be32 bc_cap
; /* Broadcast cap */
213 __be32 mc_cap
; /* Multicast cap */
214 __be32 buf_cap
; /* Buffering cap */
215 __be32 aen_cap
; /* AEN cap */
216 unsigned char vlan_cnt
; /* VLAN filter count */
217 unsigned char mixed_cnt
; /* Mix filter count */
218 unsigned char mc_cnt
; /* MC filter count */
219 unsigned char uc_cnt
; /* UC filter count */
220 unsigned char reserved
[2]; /* Reserved */
221 unsigned char vlan_mode
; /* VLAN mode */
222 unsigned char channel_cnt
; /* Channel count */
223 __be32 checksum
; /* Checksum */
227 struct ncsi_rsp_gp_pkt
{
228 struct ncsi_rsp_pkt_hdr rsp
; /* Response header */
229 unsigned char mac_cnt
; /* Number of MAC addr */
230 unsigned char reserved
[2]; /* Reserved */
231 unsigned char mac_enable
; /* MAC addr enable flags */
232 unsigned char vlan_cnt
; /* VLAN tag count */
233 unsigned char reserved1
; /* Reserved */
234 __be16 vlan_enable
; /* VLAN tag enable flags */
235 __be32 link_mode
; /* Link setting */
236 __be32 bc_mode
; /* BC filter mode */
237 __be32 valid_modes
; /* Valid mode parameters */
238 unsigned char vlan_mode
; /* VLAN mode */
239 unsigned char fc_mode
; /* Flow control mode */
240 unsigned char reserved2
[2]; /* Reserved */
241 __be32 aen_mode
; /* AEN mode */
242 unsigned char mac
[6]; /* Supported MAC addr */
243 __be16 vlan
; /* Supported VLAN tags */
244 __be32 checksum
; /* Checksum */
247 /* Get Controller Packet Statistics */
248 struct ncsi_rsp_gcps_pkt
{
249 struct ncsi_rsp_pkt_hdr rsp
; /* Response header */
250 __be32 cnt_hi
; /* Counter cleared */
251 __be32 cnt_lo
; /* Counter cleared */
252 __be32 rx_bytes
; /* Rx bytes */
253 __be32 tx_bytes
; /* Tx bytes */
254 __be32 rx_uc_pkts
; /* Rx UC packets */
255 __be32 rx_mc_pkts
; /* Rx MC packets */
256 __be32 rx_bc_pkts
; /* Rx BC packets */
257 __be32 tx_uc_pkts
; /* Tx UC packets */
258 __be32 tx_mc_pkts
; /* Tx MC packets */
259 __be32 tx_bc_pkts
; /* Tx BC packets */
260 __be32 fcs_err
; /* FCS errors */
261 __be32 align_err
; /* Alignment errors */
262 __be32 false_carrier
; /* False carrier detection */
263 __be32 runt_pkts
; /* Rx runt packets */
264 __be32 jabber_pkts
; /* Rx jabber packets */
265 __be32 rx_pause_xon
; /* Rx pause XON frames */
266 __be32 rx_pause_xoff
; /* Rx XOFF frames */
267 __be32 tx_pause_xon
; /* Tx XON frames */
268 __be32 tx_pause_xoff
; /* Tx XOFF frames */
269 __be32 tx_s_collision
; /* Single collision frames */
270 __be32 tx_m_collision
; /* Multiple collision frames */
271 __be32 l_collision
; /* Late collision frames */
272 __be32 e_collision
; /* Excessive collision frames */
273 __be32 rx_ctl_frames
; /* Rx control frames */
274 __be32 rx_64_frames
; /* Rx 64-bytes frames */
275 __be32 rx_127_frames
; /* Rx 65-127 bytes frames */
276 __be32 rx_255_frames
; /* Rx 128-255 bytes frames */
277 __be32 rx_511_frames
; /* Rx 256-511 bytes frames */
278 __be32 rx_1023_frames
; /* Rx 512-1023 bytes frames */
279 __be32 rx_1522_frames
; /* Rx 1024-1522 bytes frames */
280 __be32 rx_9022_frames
; /* Rx 1523-9022 bytes frames */
281 __be32 tx_64_frames
; /* Tx 64-bytes frames */
282 __be32 tx_127_frames
; /* Tx 65-127 bytes frames */
283 __be32 tx_255_frames
; /* Tx 128-255 bytes frames */
284 __be32 tx_511_frames
; /* Tx 256-511 bytes frames */
285 __be32 tx_1023_frames
; /* Tx 512-1023 bytes frames */
286 __be32 tx_1522_frames
; /* Tx 1024-1522 bytes frames */
287 __be32 tx_9022_frames
; /* Tx 1523-9022 bytes frames */
288 __be32 rx_valid_bytes
; /* Rx valid bytes */
289 __be32 rx_runt_pkts
; /* Rx error runt packets */
290 __be32 rx_jabber_pkts
; /* Rx error jabber packets */
291 __be32 checksum
; /* Checksum */
294 /* Get NCSI Statistics */
295 struct ncsi_rsp_gns_pkt
{
296 struct ncsi_rsp_pkt_hdr rsp
; /* Response header */
297 __be32 rx_cmds
; /* Rx NCSI commands */
298 __be32 dropped_cmds
; /* Dropped commands */
299 __be32 cmd_type_errs
; /* Command type errors */
300 __be32 cmd_csum_errs
; /* Command checksum errors */
301 __be32 rx_pkts
; /* Rx NCSI packets */
302 __be32 tx_pkts
; /* Tx NCSI packets */
303 __be32 tx_aen_pkts
; /* Tx AEN packets */
304 __be32 checksum
; /* Checksum */
307 /* Get NCSI Pass-through Statistics */
308 struct ncsi_rsp_gnpts_pkt
{
309 struct ncsi_rsp_pkt_hdr rsp
; /* Response header */
310 __be32 tx_pkts
; /* Tx packets */
311 __be32 tx_dropped
; /* Tx dropped packets */
312 __be32 tx_channel_err
; /* Tx channel errors */
313 __be32 tx_us_err
; /* Tx undersize errors */
314 __be32 rx_pkts
; /* Rx packets */
315 __be32 rx_dropped
; /* Rx dropped packets */
316 __be32 rx_channel_err
; /* Rx channel errors */
317 __be32 rx_us_err
; /* Rx undersize errors */
318 __be32 rx_os_err
; /* Rx oversize errors */
319 __be32 checksum
; /* Checksum */
322 /* Get package status */
323 struct ncsi_rsp_gps_pkt
{
324 struct ncsi_rsp_pkt_hdr rsp
; /* Response header */
325 __be32 status
; /* Hardware arbitration status */
329 /* Get package UUID */
330 struct ncsi_rsp_gpuuid_pkt
{
331 struct ncsi_rsp_pkt_hdr rsp
; /* Response header */
332 unsigned char uuid
[16]; /* UUID */
336 /* AEN: Link State Change */
337 struct ncsi_aen_lsc_pkt
{
338 struct ncsi_aen_pkt_hdr aen
; /* AEN header */
339 __be32 status
; /* Link status */
340 __be32 oem_status
; /* OEM link status */
341 __be32 checksum
; /* Checksum */
342 unsigned char pad
[14];
345 /* AEN: Configuration Required */
346 struct ncsi_aen_cr_pkt
{
347 struct ncsi_aen_pkt_hdr aen
; /* AEN header */
348 __be32 checksum
; /* Checksum */
349 unsigned char pad
[22];
352 /* AEN: Host Network Controller Driver Status Change */
353 struct ncsi_aen_hncdsc_pkt
{
354 struct ncsi_aen_pkt_hdr aen
; /* AEN header */
355 __be32 status
; /* Status */
356 __be32 checksum
; /* Checksum */
357 unsigned char pad
[18];
360 /* NCSI packet revision */
361 #define NCSI_PKT_REVISION 0x01
363 /* NCSI packet commands */
364 #define NCSI_PKT_CMD_CIS 0x00 /* Clear Initial State */
365 #define NCSI_PKT_CMD_SP 0x01 /* Select Package */
366 #define NCSI_PKT_CMD_DP 0x02 /* Deselect Package */
367 #define NCSI_PKT_CMD_EC 0x03 /* Enable Channel */
368 #define NCSI_PKT_CMD_DC 0x04 /* Disable Channel */
369 #define NCSI_PKT_CMD_RC 0x05 /* Reset Channel */
370 #define NCSI_PKT_CMD_ECNT 0x06 /* Enable Channel Network Tx */
371 #define NCSI_PKT_CMD_DCNT 0x07 /* Disable Channel Network Tx */
372 #define NCSI_PKT_CMD_AE 0x08 /* AEN Enable */
373 #define NCSI_PKT_CMD_SL 0x09 /* Set Link */
374 #define NCSI_PKT_CMD_GLS 0x0a /* Get Link */
375 #define NCSI_PKT_CMD_SVF 0x0b /* Set VLAN Filter */
376 #define NCSI_PKT_CMD_EV 0x0c /* Enable VLAN */
377 #define NCSI_PKT_CMD_DV 0x0d /* Disable VLAN */
378 #define NCSI_PKT_CMD_SMA 0x0e /* Set MAC address */
379 #define NCSI_PKT_CMD_EBF 0x10 /* Enable Broadcast Filter */
380 #define NCSI_PKT_CMD_DBF 0x11 /* Disable Broadcast Filter */
381 #define NCSI_PKT_CMD_EGMF 0x12 /* Enable Global Multicast Filter */
382 #define NCSI_PKT_CMD_DGMF 0x13 /* Disable Global Multicast Filter */
383 #define NCSI_PKT_CMD_SNFC 0x14 /* Set NCSI Flow Control */
384 #define NCSI_PKT_CMD_GVI 0x15 /* Get Version ID */
385 #define NCSI_PKT_CMD_GC 0x16 /* Get Capabilities */
386 #define NCSI_PKT_CMD_GP 0x17 /* Get Parameters */
387 #define NCSI_PKT_CMD_GCPS 0x18 /* Get Controller Packet Statistics */
388 #define NCSI_PKT_CMD_GNS 0x19 /* Get NCSI Statistics */
389 #define NCSI_PKT_CMD_GNPTS 0x1a /* Get NCSI Pass-throu Statistics */
390 #define NCSI_PKT_CMD_GPS 0x1b /* Get package status */
391 #define NCSI_PKT_CMD_OEM 0x50 /* OEM */
392 #define NCSI_PKT_CMD_PLDM 0x51 /* PLDM request over NCSI over RBT */
393 #define NCSI_PKT_CMD_GPUUID 0x52 /* Get package UUID */
395 /* NCSI packet responses */
396 #define NCSI_PKT_RSP_CIS (NCSI_PKT_CMD_CIS + 0x80)
397 #define NCSI_PKT_RSP_SP (NCSI_PKT_CMD_SP + 0x80)
398 #define NCSI_PKT_RSP_DP (NCSI_PKT_CMD_DP + 0x80)
399 #define NCSI_PKT_RSP_EC (NCSI_PKT_CMD_EC + 0x80)
400 #define NCSI_PKT_RSP_DC (NCSI_PKT_CMD_DC + 0x80)
401 #define NCSI_PKT_RSP_RC (NCSI_PKT_CMD_RC + 0x80)
402 #define NCSI_PKT_RSP_ECNT (NCSI_PKT_CMD_ECNT + 0x80)
403 #define NCSI_PKT_RSP_DCNT (NCSI_PKT_CMD_DCNT + 0x80)
404 #define NCSI_PKT_RSP_AE (NCSI_PKT_CMD_AE + 0x80)
405 #define NCSI_PKT_RSP_SL (NCSI_PKT_CMD_SL + 0x80)
406 #define NCSI_PKT_RSP_GLS (NCSI_PKT_CMD_GLS + 0x80)
407 #define NCSI_PKT_RSP_SVF (NCSI_PKT_CMD_SVF + 0x80)
408 #define NCSI_PKT_RSP_EV (NCSI_PKT_CMD_EV + 0x80)
409 #define NCSI_PKT_RSP_DV (NCSI_PKT_CMD_DV + 0x80)
410 #define NCSI_PKT_RSP_SMA (NCSI_PKT_CMD_SMA + 0x80)
411 #define NCSI_PKT_RSP_EBF (NCSI_PKT_CMD_EBF + 0x80)
412 #define NCSI_PKT_RSP_DBF (NCSI_PKT_CMD_DBF + 0x80)
413 #define NCSI_PKT_RSP_EGMF (NCSI_PKT_CMD_EGMF + 0x80)
414 #define NCSI_PKT_RSP_DGMF (NCSI_PKT_CMD_DGMF + 0x80)
415 #define NCSI_PKT_RSP_SNFC (NCSI_PKT_CMD_SNFC + 0x80)
416 #define NCSI_PKT_RSP_GVI (NCSI_PKT_CMD_GVI + 0x80)
417 #define NCSI_PKT_RSP_GC (NCSI_PKT_CMD_GC + 0x80)
418 #define NCSI_PKT_RSP_GP (NCSI_PKT_CMD_GP + 0x80)
419 #define NCSI_PKT_RSP_GCPS (NCSI_PKT_CMD_GCPS + 0x80)
420 #define NCSI_PKT_RSP_GNS (NCSI_PKT_CMD_GNS + 0x80)
421 #define NCSI_PKT_RSP_GNPTS (NCSI_PKT_CMD_GNPTS + 0x80)
422 #define NCSI_PKT_RSP_GPS (NCSI_PKT_CMD_GPS + 0x80)
423 #define NCSI_PKT_RSP_OEM (NCSI_PKT_CMD_OEM + 0x80)
424 #define NCSI_PKT_RSP_PLDM (NCSI_PKT_CMD_PLDM + 0x80)
425 #define NCSI_PKT_RSP_GPUUID (NCSI_PKT_CMD_GPUUID + 0x80)
427 /* NCSI response code/reason */
428 #define NCSI_PKT_RSP_C_COMPLETED 0x0000 /* Command Completed */
429 #define NCSI_PKT_RSP_C_FAILED 0x0001 /* Command Failed */
430 #define NCSI_PKT_RSP_C_UNAVAILABLE 0x0002 /* Command Unavailable */
431 #define NCSI_PKT_RSP_C_UNSUPPORTED 0x0003 /* Command Unsupported */
432 #define NCSI_PKT_RSP_R_NO_ERROR 0x0000 /* No Error */
433 #define NCSI_PKT_RSP_R_INTERFACE 0x0001 /* Interface not ready */
434 #define NCSI_PKT_RSP_R_PARAM 0x0002 /* Invalid Parameter */
435 #define NCSI_PKT_RSP_R_CHANNEL 0x0003 /* Channel not Ready */
436 #define NCSI_PKT_RSP_R_PACKAGE 0x0004 /* Package not Ready */
437 #define NCSI_PKT_RSP_R_LENGTH 0x0005 /* Invalid payload length */
438 #define NCSI_PKT_RSP_R_UNKNOWN 0x7fff /* Command type unsupported */
440 /* NCSI AEN packet type */
441 #define NCSI_PKT_AEN 0xFF /* AEN Packet */
442 #define NCSI_PKT_AEN_LSC 0x00 /* Link status change */
443 #define NCSI_PKT_AEN_CR 0x01 /* Configuration required */
444 #define NCSI_PKT_AEN_HNCDSC 0x02 /* HNC driver status change */
446 #endif /* __NCSI_PKT_H__ */