Merge branches 'pm-cpuidle', 'pm-opp' and 'pm-avs'
[linux-2.6-microblaze.git] / net / ncsi / ncsi-pkt.h
1 /*
2  * Copyright Gavin Shan, IBM Corporation 2016.
3  *
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.
8  */
9
10 #ifndef __NCSI_PKT_H__
11 #define __NCSI_PKT_H__
12
13 struct ncsi_pkt_hdr {
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                 */
22 };
23
24 struct ncsi_cmd_pkt_hdr {
25         struct ncsi_pkt_hdr common; /* Common NCSI packet header */
26 };
27
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           */
32 };
33
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           */
38 };
39
40 /* NCSI common command packet */
41 struct ncsi_cmd_pkt {
42         struct ncsi_cmd_pkt_hdr cmd;      /* Command header */
43         __be32                  checksum; /* Checksum       */
44         unsigned char           pad[26];
45 };
46
47 struct ncsi_rsp_pkt {
48         struct ncsi_rsp_pkt_hdr rsp;      /* Response header */
49         __be32                  checksum; /* Checksum        */
50         unsigned char           pad[22];
51 };
52
53 /* Select Package */
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];
60 };
61
62 /* Disable Channel */
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];
69 };
70
71 /* Reset Channel */
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];
77 };
78
79 /* AEN Enable */
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];
87 };
88
89 /* Set Link */
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];
96 };
97
98 /* Set VLAN Filter */
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[14];
108 };
109
110 /* Enable VLAN */
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];
117 };
118
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];
127 };
128
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];
135 };
136
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];
143 };
144
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];
152 };
153
154 /* Get Link Status */
155 struct ncsi_rsp_gls_pkt {
156         struct ncsi_rsp_pkt_hdr rsp;        /* Response header   */
157         __be32                  status;     /* Link status       */
158         __be32                  other;      /* Other indications */
159         __be32                  oem_status; /* OEM link status   */
160         __be32                  checksum;
161         unsigned char           pad[10];
162 };
163
164 /* Get Version ID */
165 struct ncsi_rsp_gvi_pkt {
166         struct ncsi_rsp_pkt_hdr rsp;          /* Response header */
167         __be32                  ncsi_version; /* NCSI version    */
168         unsigned char           reserved[3];  /* Reserved        */
169         unsigned char           alpha2;       /* NCSI version    */
170         unsigned char           fw_name[12];  /* f/w name string */
171         __be32                  fw_version;   /* f/w version     */
172         __be16                  pci_ids[4];   /* PCI IDs         */
173         __be32                  mf_id;        /* Manufacture ID  */
174         __be32                  checksum;
175 };
176
177 /* Get Capabilities */
178 struct ncsi_rsp_gc_pkt {
179         struct ncsi_rsp_pkt_hdr rsp;         /* Response header   */
180         __be32                  cap;         /* Capabilities      */
181         __be32                  bc_cap;      /* Broadcast cap     */
182         __be32                  mc_cap;      /* Multicast cap     */
183         __be32                  buf_cap;     /* Buffering cap     */
184         __be32                  aen_cap;     /* AEN cap           */
185         unsigned char           vlan_cnt;    /* VLAN filter count */
186         unsigned char           mixed_cnt;   /* Mix filter count  */
187         unsigned char           mc_cnt;      /* MC filter count   */
188         unsigned char           uc_cnt;      /* UC filter count   */
189         unsigned char           reserved[2]; /* Reserved          */
190         unsigned char           vlan_mode;   /* VLAN mode         */
191         unsigned char           channel_cnt; /* Channel count     */
192         __be32                  checksum;    /* Checksum          */
193 };
194
195 /* Get Parameters */
196 struct ncsi_rsp_gp_pkt {
197         struct ncsi_rsp_pkt_hdr rsp;          /* Response header       */
198         unsigned char           mac_cnt;      /* Number of MAC addr    */
199         unsigned char           reserved[2];  /* Reserved              */
200         unsigned char           mac_enable;   /* MAC addr enable flags */
201         unsigned char           vlan_cnt;     /* VLAN tag count        */
202         unsigned char           reserved1;    /* Reserved              */
203         __be16                  vlan_enable;  /* VLAN tag enable flags */
204         __be32                  link_mode;    /* Link setting          */
205         __be32                  bc_mode;      /* BC filter mode        */
206         __be32                  valid_modes;  /* Valid mode parameters */
207         unsigned char           vlan_mode;    /* VLAN mode             */
208         unsigned char           fc_mode;      /* Flow control mode     */
209         unsigned char           reserved2[2]; /* Reserved              */
210         __be32                  aen_mode;     /* AEN mode              */
211         unsigned char           mac[6];       /* Supported MAC addr    */
212         __be16                  vlan;         /* Supported VLAN tags   */
213         __be32                  checksum;     /* Checksum              */
214 };
215
216 /* Get Controller Packet Statistics */
217 struct ncsi_rsp_gcps_pkt {
218         struct ncsi_rsp_pkt_hdr rsp;            /* Response header            */
219         __be32                  cnt_hi;         /* Counter cleared            */
220         __be32                  cnt_lo;         /* Counter cleared            */
221         __be32                  rx_bytes;       /* Rx bytes                   */
222         __be32                  tx_bytes;       /* Tx bytes                   */
223         __be32                  rx_uc_pkts;     /* Rx UC packets              */
224         __be32                  rx_mc_pkts;     /* Rx MC packets              */
225         __be32                  rx_bc_pkts;     /* Rx BC packets              */
226         __be32                  tx_uc_pkts;     /* Tx UC packets              */
227         __be32                  tx_mc_pkts;     /* Tx MC packets              */
228         __be32                  tx_bc_pkts;     /* Tx BC packets              */
229         __be32                  fcs_err;        /* FCS errors                 */
230         __be32                  align_err;      /* Alignment errors           */
231         __be32                  false_carrier;  /* False carrier detection    */
232         __be32                  runt_pkts;      /* Rx runt packets            */
233         __be32                  jabber_pkts;    /* Rx jabber packets          */
234         __be32                  rx_pause_xon;   /* Rx pause XON frames        */
235         __be32                  rx_pause_xoff;  /* Rx XOFF frames             */
236         __be32                  tx_pause_xon;   /* Tx XON frames              */
237         __be32                  tx_pause_xoff;  /* Tx XOFF frames             */
238         __be32                  tx_s_collision; /* Single collision frames    */
239         __be32                  tx_m_collision; /* Multiple collision frames  */
240         __be32                  l_collision;    /* Late collision frames      */
241         __be32                  e_collision;    /* Excessive collision frames */
242         __be32                  rx_ctl_frames;  /* Rx control frames          */
243         __be32                  rx_64_frames;   /* Rx 64-bytes frames         */
244         __be32                  rx_127_frames;  /* Rx 65-127 bytes frames     */
245         __be32                  rx_255_frames;  /* Rx 128-255 bytes frames    */
246         __be32                  rx_511_frames;  /* Rx 256-511 bytes frames    */
247         __be32                  rx_1023_frames; /* Rx 512-1023 bytes frames   */
248         __be32                  rx_1522_frames; /* Rx 1024-1522 bytes frames  */
249         __be32                  rx_9022_frames; /* Rx 1523-9022 bytes frames  */
250         __be32                  tx_64_frames;   /* Tx 64-bytes frames         */
251         __be32                  tx_127_frames;  /* Tx 65-127 bytes frames     */
252         __be32                  tx_255_frames;  /* Tx 128-255 bytes frames    */
253         __be32                  tx_511_frames;  /* Tx 256-511 bytes frames    */
254         __be32                  tx_1023_frames; /* Tx 512-1023 bytes frames   */
255         __be32                  tx_1522_frames; /* Tx 1024-1522 bytes frames  */
256         __be32                  tx_9022_frames; /* Tx 1523-9022 bytes frames  */
257         __be32                  rx_valid_bytes; /* Rx valid bytes             */
258         __be32                  rx_runt_pkts;   /* Rx error runt packets      */
259         __be32                  rx_jabber_pkts; /* Rx error jabber packets    */
260         __be32                  checksum;       /* Checksum                   */
261 };
262
263 /* Get NCSI Statistics */
264 struct ncsi_rsp_gns_pkt {
265         struct ncsi_rsp_pkt_hdr rsp;           /* Response header         */
266         __be32                  rx_cmds;       /* Rx NCSI commands        */
267         __be32                  dropped_cmds;  /* Dropped commands        */
268         __be32                  cmd_type_errs; /* Command type errors     */
269         __be32                  cmd_csum_errs; /* Command checksum errors */
270         __be32                  rx_pkts;       /* Rx NCSI packets         */
271         __be32                  tx_pkts;       /* Tx NCSI packets         */
272         __be32                  tx_aen_pkts;   /* Tx AEN packets          */
273         __be32                  checksum;      /* Checksum                */
274 };
275
276 /* Get NCSI Pass-through Statistics */
277 struct ncsi_rsp_gnpts_pkt {
278         struct ncsi_rsp_pkt_hdr rsp;            /* Response header     */
279         __be32                  tx_pkts;        /* Tx packets          */
280         __be32                  tx_dropped;     /* Tx dropped packets  */
281         __be32                  tx_channel_err; /* Tx channel errors   */
282         __be32                  tx_us_err;      /* Tx undersize errors */
283         __be32                  rx_pkts;        /* Rx packets          */
284         __be32                  rx_dropped;     /* Rx dropped packets  */
285         __be32                  rx_channel_err; /* Rx channel errors   */
286         __be32                  rx_us_err;      /* Rx undersize errors */
287         __be32                  rx_os_err;      /* Rx oversize errors  */
288         __be32                  checksum;       /* Checksum            */
289 };
290
291 /* Get package status */
292 struct ncsi_rsp_gps_pkt {
293         struct ncsi_rsp_pkt_hdr rsp;      /* Response header             */
294         __be32                  status;   /* Hardware arbitration status */
295         __be32                  checksum;
296 };
297
298 /* Get package UUID */
299 struct ncsi_rsp_gpuuid_pkt {
300         struct ncsi_rsp_pkt_hdr rsp;      /* Response header */
301         unsigned char           uuid[16]; /* UUID            */
302         __be32                  checksum;
303 };
304
305 /* AEN: Link State Change */
306 struct ncsi_aen_lsc_pkt {
307         struct ncsi_aen_pkt_hdr aen;        /* AEN header      */
308         __be32                  status;     /* Link status     */
309         __be32                  oem_status; /* OEM link status */
310         __be32                  checksum;   /* Checksum        */
311         unsigned char           pad[14];
312 };
313
314 /* AEN: Configuration Required */
315 struct ncsi_aen_cr_pkt {
316         struct ncsi_aen_pkt_hdr aen;      /* AEN header */
317         __be32                  checksum; /* Checksum   */
318         unsigned char           pad[22];
319 };
320
321 /* AEN: Host Network Controller Driver Status Change */
322 struct ncsi_aen_hncdsc_pkt {
323         struct ncsi_aen_pkt_hdr aen;      /* AEN header */
324         __be32                  status;   /* Status     */
325         __be32                  checksum; /* Checksum   */
326         unsigned char           pad[18];
327 };
328
329 /* NCSI packet revision */
330 #define NCSI_PKT_REVISION       0x01
331
332 /* NCSI packet commands */
333 #define NCSI_PKT_CMD_CIS        0x00 /* Clear Initial State              */
334 #define NCSI_PKT_CMD_SP         0x01 /* Select Package                   */
335 #define NCSI_PKT_CMD_DP         0x02 /* Deselect Package                 */
336 #define NCSI_PKT_CMD_EC         0x03 /* Enable Channel                   */
337 #define NCSI_PKT_CMD_DC         0x04 /* Disable Channel                  */
338 #define NCSI_PKT_CMD_RC         0x05 /* Reset Channel                    */
339 #define NCSI_PKT_CMD_ECNT       0x06 /* Enable Channel Network Tx        */
340 #define NCSI_PKT_CMD_DCNT       0x07 /* Disable Channel Network Tx       */
341 #define NCSI_PKT_CMD_AE         0x08 /* AEN Enable                       */
342 #define NCSI_PKT_CMD_SL         0x09 /* Set Link                         */
343 #define NCSI_PKT_CMD_GLS        0x0a /* Get Link                         */
344 #define NCSI_PKT_CMD_SVF        0x0b /* Set VLAN Filter                  */
345 #define NCSI_PKT_CMD_EV         0x0c /* Enable VLAN                      */
346 #define NCSI_PKT_CMD_DV         0x0d /* Disable VLAN                     */
347 #define NCSI_PKT_CMD_SMA        0x0e /* Set MAC address                  */
348 #define NCSI_PKT_CMD_EBF        0x10 /* Enable Broadcast Filter          */
349 #define NCSI_PKT_CMD_DBF        0x11 /* Disable Broadcast Filter         */
350 #define NCSI_PKT_CMD_EGMF       0x12 /* Enable Global Multicast Filter   */
351 #define NCSI_PKT_CMD_DGMF       0x13 /* Disable Global Multicast Filter  */
352 #define NCSI_PKT_CMD_SNFC       0x14 /* Set NCSI Flow Control            */
353 #define NCSI_PKT_CMD_GVI        0x15 /* Get Version ID                   */
354 #define NCSI_PKT_CMD_GC         0x16 /* Get Capabilities                 */
355 #define NCSI_PKT_CMD_GP         0x17 /* Get Parameters                   */
356 #define NCSI_PKT_CMD_GCPS       0x18 /* Get Controller Packet Statistics */
357 #define NCSI_PKT_CMD_GNS        0x19 /* Get NCSI Statistics              */
358 #define NCSI_PKT_CMD_GNPTS      0x1a /* Get NCSI Pass-throu Statistics   */
359 #define NCSI_PKT_CMD_GPS        0x1b /* Get package status               */
360 #define NCSI_PKT_CMD_OEM        0x50 /* OEM                              */
361 #define NCSI_PKT_CMD_PLDM       0x51 /* PLDM request over NCSI over RBT  */
362 #define NCSI_PKT_CMD_GPUUID     0x52 /* Get package UUID                 */
363
364 /* NCSI packet responses */
365 #define NCSI_PKT_RSP_CIS        (NCSI_PKT_CMD_CIS    + 0x80)
366 #define NCSI_PKT_RSP_SP         (NCSI_PKT_CMD_SP     + 0x80)
367 #define NCSI_PKT_RSP_DP         (NCSI_PKT_CMD_DP     + 0x80)
368 #define NCSI_PKT_RSP_EC         (NCSI_PKT_CMD_EC     + 0x80)
369 #define NCSI_PKT_RSP_DC         (NCSI_PKT_CMD_DC     + 0x80)
370 #define NCSI_PKT_RSP_RC         (NCSI_PKT_CMD_RC     + 0x80)
371 #define NCSI_PKT_RSP_ECNT       (NCSI_PKT_CMD_ECNT   + 0x80)
372 #define NCSI_PKT_RSP_DCNT       (NCSI_PKT_CMD_DCNT   + 0x80)
373 #define NCSI_PKT_RSP_AE         (NCSI_PKT_CMD_AE     + 0x80)
374 #define NCSI_PKT_RSP_SL         (NCSI_PKT_CMD_SL     + 0x80)
375 #define NCSI_PKT_RSP_GLS        (NCSI_PKT_CMD_GLS    + 0x80)
376 #define NCSI_PKT_RSP_SVF        (NCSI_PKT_CMD_SVF    + 0x80)
377 #define NCSI_PKT_RSP_EV         (NCSI_PKT_CMD_EV     + 0x80)
378 #define NCSI_PKT_RSP_DV         (NCSI_PKT_CMD_DV     + 0x80)
379 #define NCSI_PKT_RSP_SMA        (NCSI_PKT_CMD_SMA    + 0x80)
380 #define NCSI_PKT_RSP_EBF        (NCSI_PKT_CMD_EBF    + 0x80)
381 #define NCSI_PKT_RSP_DBF        (NCSI_PKT_CMD_DBF    + 0x80)
382 #define NCSI_PKT_RSP_EGMF       (NCSI_PKT_CMD_EGMF   + 0x80)
383 #define NCSI_PKT_RSP_DGMF       (NCSI_PKT_CMD_DGMF   + 0x80)
384 #define NCSI_PKT_RSP_SNFC       (NCSI_PKT_CMD_SNFC   + 0x80)
385 #define NCSI_PKT_RSP_GVI        (NCSI_PKT_CMD_GVI    + 0x80)
386 #define NCSI_PKT_RSP_GC         (NCSI_PKT_CMD_GC     + 0x80)
387 #define NCSI_PKT_RSP_GP         (NCSI_PKT_CMD_GP     + 0x80)
388 #define NCSI_PKT_RSP_GCPS       (NCSI_PKT_CMD_GCPS   + 0x80)
389 #define NCSI_PKT_RSP_GNS        (NCSI_PKT_CMD_GNS    + 0x80)
390 #define NCSI_PKT_RSP_GNPTS      (NCSI_PKT_CMD_GNPTS  + 0x80)
391 #define NCSI_PKT_RSP_GPS        (NCSI_PKT_CMD_GPS    + 0x80)
392 #define NCSI_PKT_RSP_OEM        (NCSI_PKT_CMD_OEM    + 0x80)
393 #define NCSI_PKT_RSP_PLDM       (NCSI_PKT_CMD_PLDM   + 0x80)
394 #define NCSI_PKT_RSP_GPUUID     (NCSI_PKT_CMD_GPUUID + 0x80)
395
396 /* NCSI response code/reason */
397 #define NCSI_PKT_RSP_C_COMPLETED        0x0000 /* Command Completed        */
398 #define NCSI_PKT_RSP_C_FAILED           0x0001 /* Command Failed           */
399 #define NCSI_PKT_RSP_C_UNAVAILABLE      0x0002 /* Command Unavailable      */
400 #define NCSI_PKT_RSP_C_UNSUPPORTED      0x0003 /* Command Unsupported      */
401 #define NCSI_PKT_RSP_R_NO_ERROR         0x0000 /* No Error                 */
402 #define NCSI_PKT_RSP_R_INTERFACE        0x0001 /* Interface not ready      */
403 #define NCSI_PKT_RSP_R_PARAM            0x0002 /* Invalid Parameter        */
404 #define NCSI_PKT_RSP_R_CHANNEL          0x0003 /* Channel not Ready        */
405 #define NCSI_PKT_RSP_R_PACKAGE          0x0004 /* Package not Ready        */
406 #define NCSI_PKT_RSP_R_LENGTH           0x0005 /* Invalid payload length   */
407 #define NCSI_PKT_RSP_R_UNKNOWN          0x7fff /* Command type unsupported */
408
409 /* NCSI AEN packet type */
410 #define NCSI_PKT_AEN            0xFF /* AEN Packet               */
411 #define NCSI_PKT_AEN_LSC        0x00 /* Link status change       */
412 #define NCSI_PKT_AEN_CR         0x01 /* Configuration required   */
413 #define NCSI_PKT_AEN_HNCDSC     0x02 /* HNC driver status change */
414
415 #endif /* __NCSI_PKT_H__ */