]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/IpmiNetFnTransportDefinitions.h
MdePkg: Add 3 macro defined in latest TPM2 specification.
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / IpmiNetFnTransportDefinitions.h
CommitLineData
884a1730
DB
1/** @file\r
2 IPMI 2.0 definitions from the IPMI Specification Version 2.0, Revision 1.1.\r
3\r
4 This file contains all NetFn Transport commands, including:\r
5 IPM LAN Commands (Chapter 23)\r
6 IPMI Serial/Modem Commands (Chapter 25)\r
7 SOL Commands (Chapter 26)\r
8 Command Forwarding Commands (Chapter 35b)\r
9\r
10 See IPMI specification, Appendix G, Command Assignments\r
11 and Appendix H, Sub-function Assignments.\r
12\r
13 Copyright (c) 1999 - 2015, Intel Corporation. All rights reserved.<BR>\r
14 This program and the accompanying materials\r
15 are licensed and made available under the terms and conditions of the BSD License\r
16 which accompanies this distribution. The full text of the license may be found at\r
17 http://opensource.org/licenses/bsd-license.php\r
18\r
19 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
20 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
21**/\r
22\r
23#ifndef _IPMINETFNTRANSPORTDEFINITIONS_H_\r
24#define _IPMINETFNTRANSPORTDEFINITIONS_H_\r
25\r
26#pragma pack(1)\r
27//\r
28// Net function definition for Transport command\r
29//\r
30#define IPMI_NETFN_TRANSPORT 0x0C\r
31\r
32//\r
33// Below is Definitions for IPM LAN Commands (Chapter 23)\r
34//\r
35\r
36//\r
37// Definitions for Set Lan Configuration Parameters command\r
38//\r
39#define IPMI_TRANSPORT_SET_LAN_CONFIG_PARAMETERS 0x01\r
40\r
41//\r
42// Constants and Structure definitions for "Set Lan Configuration Parameters" command to follow here\r
43//\r
44\r
45//\r
46// LAN Management Structure\r
47//\r
48typedef enum {\r
49 IpmiLanReserved1,\r
50 IpmiLanReserved2,\r
51 IpmiLanAuthType,\r
52 IpmiLanIpAddress,\r
53 IpmiLanIpAddressSource,\r
54 IpmiLanMacAddress,\r
55 IpmiLanSubnetMask,\r
56 IpmiLanIpv4HeaderParam,\r
57 IpmiLanPrimaryRcmpPort,\r
58 IpmiLanSecondaryRcmpPort,\r
59 IpmiLanBmcGeneratedArpCtrl,\r
60 IpmiLanArpInterval,\r
61 IpmiLanDefaultGateway,\r
62 IpmiLanDefaultGatewayMac,\r
63 IpmiLanBackupGateway,\r
64 IpmiLanBackupGatewayMac,\r
65 IpmiLanCommunityString,\r
66 IpmiLanReserved3,\r
67 IpmiLanDestinationType,\r
68 IpmiLanDestinationAddress\r
69} IPMI_LAN_OPTION_TYPE;\r
70\r
71//\r
72// IP Address Source\r
73//\r
74typedef enum {\r
75 IpmiUnspecified,\r
76 IpmiStaticAddrsss,\r
77 IpmiDynamicAddressBmcDhcp,\r
78 IpmiDynamicAddressBiosDhcp,\r
79 IpmiDynamicAddressBmcNonDhcp\r
80} IPMI_IP_ADDRESS_SRC;\r
81\r
82//\r
83// Destination Type\r
84//\r
85typedef enum {\r
86 IpmiPetTrapDestination,\r
87 IpmiDirectedEventDestination,\r
88 IpmiReserved1,\r
89 IpmiReserved2,\r
90 IpmiReserved3,\r
91 IpmiReserved4,\r
92 IpmiReserved5,\r
93 IpmiOem1,\r
94 IpmiOem2\r
95} IPMI_LAN_DEST_TYPE_DEST_TYPE;\r
96\r
97typedef struct {\r
98 UINT8 NoAuth : 1;\r
99 UINT8 MD2Auth : 1;\r
100 UINT8 MD5Auth : 1;\r
101 UINT8 Reserved1 : 1;\r
102 UINT8 StraightPswd : 1;\r
103 UINT8 OemType : 1;\r
104 UINT8 Reserved2 : 2;\r
105} IPMI_LAN_AUTH_TYPE;\r
106\r
107typedef struct {\r
108 UINT8 IpAddress[4];\r
109} IPMI_LAN_IP_ADDRESS;\r
110\r
111typedef struct {\r
112 UINT8 AddressSrc : 4;\r
113 UINT8 Reserved : 4;\r
114} IPMI_LAN_IP_ADDRESS_SRC;\r
115\r
116typedef struct {\r
117 UINT8 MacAddress[6];\r
118} IPMI_LAN_MAC_ADDRESS;\r
119\r
120typedef struct {\r
121 UINT8 IpAddress[4];\r
122} IPMI_LAN_SUBNET_MASK;\r
123\r
124typedef struct {\r
125 UINT8 TimeToLive;\r
126 UINT8 IpFlag : 3;\r
127 UINT8 Reserved1 : 5;\r
128 UINT8 Precedence : 3;\r
129 UINT8 Reserved2 : 1;\r
130 UINT8 ServiceType : 4;\r
131} IPMI_LAN_IPV4_HDR_PARAM;\r
132\r
133typedef struct {\r
134 UINT8 RcmpPortMsb;\r
135 UINT8 RcmpPortLsb;\r
136} IPMI_LAN_RCMP_PORT;\r
137\r
138typedef struct {\r
139 UINT8 EnableBmcArpResponse : 1;\r
140 UINT8 EnableBmcGratuitousArp : 1;\r
141 UINT8 Reserved : 6;\r
142} IPMI_LAN_BMC_GENERATED_ARP_CONTROL;\r
143\r
144typedef struct {\r
145 UINT8 ArpInterval;\r
146} IPMI_LAN_ARP_INTERVAL;\r
147\r
148typedef struct {\r
149 UINT8 Data[18];\r
150} IPMI_LAN_COMMUNITY_STRING;\r
151\r
152typedef struct {\r
153 UINT8 DestinationSelector : 4;\r
154 UINT8 Reserved2 : 4;\r
155 UINT8 DestinationType : 3;\r
156 UINT8 Reserved1 : 4;\r
157 UINT8 AlertAcknowledged : 1;\r
158} IPMI_LAN_DEST_TYPE;\r
159\r
160typedef struct {\r
161 UINT8 DestinationSelector : 4;\r
162 UINT8 Reserved1 : 4;\r
163 UINT8 AlertingIpAddressSelector : 4;\r
164 UINT8 AddressFormat : 4;\r
165 UINT8 UseDefaultGateway : 1;\r
166 UINT8 Reserved2 : 7;\r
167 IPMI_LAN_IP_ADDRESS AlertingIpAddress;\r
168 IPMI_LAN_MAC_ADDRESS AlertingMacAddress;\r
169} IPMI_LAN_DEST_ADDRESS;\r
170\r
171typedef union {\r
172 IPMI_LAN_AUTH_TYPE IpmiLanAuthType;\r
173 IPMI_LAN_IP_ADDRESS IpmiLanIpAddress;\r
174 IPMI_LAN_IP_ADDRESS_SRC IpmiLanIpAddressSrc;\r
175 IPMI_LAN_MAC_ADDRESS IpmiLanMacAddress;\r
176 IPMI_LAN_SUBNET_MASK IpmiLanSubnetMask;\r
177 IPMI_LAN_IPV4_HDR_PARAM IpmiLanIpv4HdrParam;\r
178 IPMI_LAN_RCMP_PORT IpmiLanPrimaryRcmpPort;\r
179 IPMI_LAN_BMC_GENERATED_ARP_CONTROL IpmiLanArpControl;\r
180 IPMI_LAN_ARP_INTERVAL IpmiLanArpInterval;\r
181 IPMI_LAN_COMMUNITY_STRING IpmiLanCommunityString;\r
182 IPMI_LAN_DEST_TYPE IpmiLanDestType;\r
183 IPMI_LAN_DEST_ADDRESS IpmiLanDestAddress;\r
184} IPMI_LAN_OPTIONS;\r
185\r
186//\r
187// Definitions for Get Lan Configuration Parameters command\r
188//\r
189#define IPMI_TRANSPORT_GET_LAN_CONFIG_PARAMETERS 0x02\r
190\r
191//\r
192// Constants and Structure definitions for "Get Lan Configuration Parameters" command to follow here\r
193//\r
194\r
195//\r
196// Definitions for Suspend BMC ARPs command\r
197//\r
198#define IPMI_TRANSPORT_SUSPEND_BMC_ARPS 0x03\r
199\r
200//\r
201// Constants and Structure definitions for "Suspend BMC ARPs" command to follow here\r
202//\r
203\r
204//\r
205// Definitions for Get IP-UDP-RMCP Statistics command\r
206//\r
207#define IPMI_TRANSPORT_GET_PACKET_STATISTICS 0x04\r
208\r
209//\r
210// Constants and Structure definitions for "Get IP-UDP-RMCP Statistics" command to follow here\r
211//\r
212\r
213//\r
214// Below is Definitions for IPMI Serial/Modem Commands (Chapter 25)\r
215//\r
216\r
217//\r
218// Definitions for Set Serial/Modem Configuration command\r
219//\r
220#define IPMI_TRANSPORT_SET_SERIAL_CONFIGURATION 0x10\r
221\r
222//\r
223// Constants and Structure definitions for "Set Serial/Modem Configuration" command to follow here\r
224//\r
225\r
226//\r
227// EMP OPTION DATA\r
228//\r
229typedef struct {\r
230 UINT8 NoAuthentication : 1;\r
231 UINT8 MD2Authentication : 1;\r
232 UINT8 MD5Authentication : 1;\r
233 UINT8 Reserved1 : 1;\r
234 UINT8 StraightPassword : 1;\r
235 UINT8 OemProprietary : 1;\r
236 UINT8 Reservd2 : 2;\r
237} IPMI_EMP_AUTH_TYPE;\r
238\r
239typedef struct {\r
240 UINT8 EnableBasicMode : 1;\r
241 UINT8 EnablePPPMode : 1;\r
242 UINT8 EnableTerminalMode : 1;\r
243 UINT8 Reserved1 : 2;\r
244 UINT8 SnoopOsPPPNegotiation : 1;\r
245 UINT8 Reserved2 : 1;\r
246 UINT8 DirectConnect : 1;\r
247} IPMI_EMP_CONNECTION_TYPE;\r
248\r
249typedef struct {\r
250 UINT8 InactivityTimeout : 4;\r
251 UINT8 Reserved : 4;\r
252} IPMI_EMP_INACTIVITY_TIMEOUT;\r
253\r
254typedef struct {\r
255 UINT8 IpmiCallback : 1;\r
256 UINT8 CBCPCallback : 1;\r
257 UINT8 Reserved1 : 6;\r
258 UINT8 CbcpEnableNoCallback : 1;\r
259 UINT8 CbcpEnablePreSpecifiedNumber : 1;\r
260 UINT8 CbcpEnableUserSpecifiedNumber : 1;\r
261 UINT8 CbcpEnableCallbackFromList : 1;\r
262 UINT8 Reserved : 4;\r
263 UINT8 CallbackDestination1;\r
264 UINT8 CallbackDestination2;\r
265 UINT8 CallbackDestination3;\r
266} IPMI_EMP_CHANNEL_CALLBACK_CONTROL;\r
267\r
268typedef struct {\r
269 UINT8 CloseSessionOnDCDLoss : 1;\r
270 UINT8 EnableSessionInactivityTimeout : 1;\r
271 UINT8 Reserved : 6;\r
272} IPMI_EMP_SESSION_TERMINATION;\r
273\r
274typedef struct {\r
275 UINT8 Reserved1 : 5;\r
276 UINT8 EnableDtrHangup : 1;\r
277 UINT8 FlowControl : 2;\r
278 UINT8 BitRate : 4;\r
279 UINT8 Reserved2 : 4;\r
280 UINT8 SaveSetting : 1;\r
281 UINT8 SetComPort : 1;\r
282 UINT8 Reserved3 : 6;\r
283} IPMI_EMP_MESSAGING_COM_SETTING;\r
284\r
285typedef struct {\r
286 UINT8 RingDurationInterval : 6;\r
287 UINT8 Reserved1 : 2;\r
288 UINT8 RingDeadTime : 4;\r
289 UINT8 Reserved : 4;\r
290} IPMI_EMP_MODEM_RING_TIME;\r
291\r
292typedef struct {\r
293 UINT8 Reserved;\r
294 UINT8 InitString[48];\r
295} IPMI_EMP_MODEM_INIT_STRING;\r
296\r
297typedef struct {\r
298 UINT8 EscapeSequence[5];\r
299} IPMI_EMP_MODEM_ESC_SEQUENCE;\r
300\r
301typedef struct {\r
302 UINT8 HangupSequence[8];\r
303} IPMI_EMP_MODEM_HANGUP_SEQUENCE;\r
304\r
305typedef struct {\r
306 UINT8 ModelDialCommend[8];\r
307} IPMI_MODEM_DIALUP_COMMAND;\r
308\r
309typedef struct {\r
310 UINT8 PageBlackoutInterval;\r
311} IPMI_PAGE_BLACKOUT_INTERVAL;\r
312\r
313typedef struct {\r
314 UINT8 CommunityString[18];\r
315} IPMI_EMP_COMMUNITY_STRING;\r
316\r
317typedef struct {\r
318 UINT8 DestinationSelector : 4;\r
319 UINT8 Reserved1 : 4;\r
320 UINT8 DestinationType : 4;\r
321 UINT8 Reserved2 : 3;\r
322 UINT8 AlertAckRequired : 1;\r
323 UINT8 AlertAckTimeoutSeconds;\r
324 UINT8 NumRetriesCall : 3;\r
325 UINT8 Reserved3 : 1;\r
326 UINT8 NumRetryAlert : 3;\r
327 UINT8 Reserved4 : 1;\r
328 union {\r
329 struct {\r
330 UINT8 Reserved5 : 4;\r
331 UINT8 DialStringSelector : 4;\r
332 } DIAL_PAGE_DESTINATION;\r
333 struct {\r
334 UINT8 TapAccountSelector : 4;\r
335 UINT8 Reserved : 4;\r
336 } TAP_PAGE_DESTINATION;\r
337 struct {\r
338 UINT8 PPPAccountSetSelector;\r
339 UINT8 DialStringSelector;\r
340 } PPP_ALERT_DESTINATION;\r
341 } DEST_TYPE_SPECIFIC;\r
342} IPMI_EMP_DESTINATION_INFO;\r
343\r
344typedef struct {\r
345 UINT8 DestinationSelector : 4;\r
346 UINT8 Reserved1 : 4;\r
347 UINT8 Parity : 3;\r
348 UINT8 CharacterSize : 1;\r
349 UINT8 StopBit : 1;\r
350 UINT8 DtrHangup : 1;\r
351 UINT8 FlowControl : 2;\r
352 UINT8 BitRate : 4;\r
353 UINT8 Reserved2 : 4;\r
354 UINT8 SaveSetting : 1;\r
355 UINT8 SetComPort : 1;\r
356 UINT8 Reserved3 : 6;\r
357} IPMI_EMP_DESTINATION_COM_SETTING;\r
358\r
359typedef struct {\r
360 UINT8 DialStringSelector : 4;\r
361 UINT8 Reserved1 : 4;\r
362 UINT8 Reserved2;\r
363 UINT8 DialString[48];\r
364} IPMI_DESTINATION_DIAL_STRING;\r
365\r
366typedef struct {\r
367 UINT8 IpAddressSelector : 4;\r
368 UINT8 Reserved1 : 4;\r
369 union {\r
370 UINT32 IpAddressLong;\r
371 UINT8 IpAddress[4];\r
372 } PPP_IP_ADDRESS;\r
373} IPMI_DESTINATION_IP_ADDRESS;\r
374\r
375typedef struct {\r
376 UINT8 TapSelector;\r
377 UINT8 TapServiceSelector : 4;\r
378 UINT8 TapDialStringSelector : 4;\r
379} IPMI_DESTINATION_TAP_ACCOUNT;\r
380\r
381typedef struct {\r
382 UINT8 TapSelector;\r
383 UINT8 PagerIdString[16];\r
384} IPMI_TAP_PAGER_ID_STRING;\r
385\r
386typedef union {\r
387 UINT8 OptionData;\r
388 IPMI_EMP_AUTH_TYPE EmpAuthType;\r
389 IPMI_EMP_CONNECTION_TYPE EmpConnectionType;\r
390 IPMI_EMP_INACTIVITY_TIMEOUT EmpInactivityTimeout;\r
391 IPMI_EMP_CHANNEL_CALLBACK_CONTROL EmpCallbackControl;\r
392 IPMI_EMP_SESSION_TERMINATION EmpSessionTermination;\r
393 IPMI_EMP_MESSAGING_COM_SETTING EmpMessagingComSetting;\r
394 IPMI_EMP_MODEM_RING_TIME EmpModemRingTime;\r
395 IPMI_EMP_MODEM_INIT_STRING EmpModemInitString;\r
396 IPMI_EMP_MODEM_ESC_SEQUENCE EmpModemEscSequence;\r
397 IPMI_EMP_MODEM_HANGUP_SEQUENCE EmpModemHangupSequence;\r
398 IPMI_MODEM_DIALUP_COMMAND EmpModemDialupCommand;\r
399 IPMI_PAGE_BLACKOUT_INTERVAL EmpPageBlackoutInterval;\r
400 IPMI_EMP_COMMUNITY_STRING EmpCommunityString;\r
401 IPMI_EMP_DESTINATION_INFO EmpDestinationInfo;\r
402 IPMI_EMP_DESTINATION_COM_SETTING EmpDestinationComSetting;\r
403 UINT8 CallRetryBusySignalInterval;\r
404 IPMI_DESTINATION_DIAL_STRING DestinationDialString;\r
405 IPMI_DESTINATION_IP_ADDRESS DestinationIpAddress;\r
406 IPMI_DESTINATION_TAP_ACCOUNT DestinationTapAccount;\r
407 IPMI_TAP_PAGER_ID_STRING TapPagerIdString;\r
408} IPMI_EMP_OPTIONS;\r
409\r
410//\r
411// Definitions for Get Serial/Modem Configuration command\r
412//\r
413#define IPMI_TRANSPORT_GET_SERIAL_CONFIGURATION 0x11\r
414\r
415//\r
416// Constants and Structure definitions for "Get Serial/Modem Configuration" command to follow here\r
417//\r
418\r
419//\r
420// Definitions for Set Serial/Modem Mux command\r
421//\r
422#define IPMI_TRANSPORT_SET_SERIAL_MUX 0x12\r
423\r
424//\r
425// Constants and Structure definitions for "Set Serial/Modem Mux" command to follow here\r
426//\r
427typedef struct {\r
428 UINT8 ChannelNo : 4;\r
429 UINT8 Reserved1 : 4;\r
430 UINT8 MuxSetting : 4;\r
431 UINT8 Reserved2 : 4;\r
432} IPMI_SET_MUX_COMMAND;\r
433\r
434typedef struct {\r
435 UINT8 MuxSetToBmc : 1;\r
436 UINT8 CommandStatus : 1;\r
437 UINT8 MessagingSessionActive : 1;\r
438 UINT8 AlertInProgress : 1;\r
439 UINT8 Reserved2 : 2;\r
440 UINT8 MuxToBmcAllowed : 1;\r
441 UINT8 MuxToSystemBlocked : 1;\r
442} IPMI_MUX_CONFIG;\r
443\r
444//\r
445// Definitions for Get TAP Response Code command\r
446//\r
447#define IPMI_TRANSPORT_GET_TAP_RESPONSE_CODE 0x13\r
448\r
449//\r
450// Constants and Structure definitions for "Get TAP Response Code" command to follow here\r
451//\r
452\r
453//\r
454// Definitions for Set PPP UDP Proxy Transmit Data command\r
455//\r
456#define IPMI_TRANSPORT_SET_PPP_UDP_PROXY_TXDATA 0x14\r
457\r
458//\r
459// Constants and Structure definitions for "Set PPP UDP Proxy Transmit Data" command to follow here\r
460//\r
461\r
462//\r
463// Definitions for Get PPP UDP Proxy Transmit Data command\r
464//\r
465#define IPMI_TRANSPORT_GET_PPP_UDP_PROXY_TXDATA 0x15\r
466\r
467//\r
468// Constants and Structure definitions for "Get PPP UDP Proxy Transmit Data" command to follow here\r
469//\r
470\r
471//\r
472// Definitions for Send PPP UDP Proxy Packet command\r
473//\r
474#define IPMI_TRANSPORT_SEND_PPP_UDP_PROXY_PACKET 0x16\r
475\r
476//\r
477// Constants and Structure definitions for "Send PPP UDP Proxy Packet" command to follow here\r
478//\r
479\r
480//\r
481// Definitions for Get PPP UDP Proxy Receive Data command\r
482//\r
483#define IPMI_TRANSPORT_GET_PPP_UDP_PROXY_RX 0x17\r
484\r
485//\r
486// Constants and Structure definitions for "Get PPP UDP Proxy Receive Data" command to follow here\r
487//\r
488\r
489//\r
490// Definitions for Serial/Modem connection active command\r
491//\r
492#define IPMI_TRANSPORT_SERIAL_CONNECTION_ACTIVE 0x18\r
493\r
494//\r
495// Constants and Structure definitions for "Serial/Modem connection active" command to follow here\r
496//\r
497\r
498//\r
499// Definitions for Callback command\r
500//\r
501#define IPMI_TRANSPORT_CALLBACK 0x19\r
502\r
503//\r
504// Constants and Structure definitions for "Callback" command to follow here\r
505//\r
506\r
507//\r
508// Definitions for Set user Callback Options command\r
509//\r
510#define IPMI_TRANSPORT_SET_USER_CALLBACK_OPTIONS 0x1A\r
511\r
512//\r
513// Constants and Structure definitions for "Set user Callback Options" command to follow here\r
514//\r
515\r
516//\r
517// Definitions for Get user Callback Options command\r
518//\r
519#define IPMI_TRANSPORT_GET_USER_CALLBACK_OPTIONS 0x1B\r
520\r
521//\r
522// Constants and Structure definitions for "Get user Callback Options" command to follow here\r
523//\r
524\r
525//\r
526// Below is Definitions for SOL Commands (Chapter 26)\r
527//\r
528\r
529//\r
530// Definitions for SOL activating command\r
531//\r
532#define IPMI_TRANSPORT_SOL_ACTIVATING 0x20\r
533\r
534//\r
535// Constants and Structure definitions for "SOL activating" command to follow here\r
536//\r
537\r
538//\r
539// Definitions for Set SOL Configuration Parameters command\r
540//\r
541#define IPMI_TRANSPORT_SET_SOL_CONFIG_PARAM 0x21\r
542\r
543//\r
544// Constants and Structure definitions for "Set SOL Configuration Parameters" command to follow here\r
545//\r
546\r
547//\r
548// Definitions for Get SOL Configuration Parameters command\r
549//\r
550#define IPMI_TRANSPORT_GET_SOL_CONFIG_PARAM 0x22\r
551\r
552//\r
553// Constants and Structure definitions for "Get SOL Configuration Parameters" command to follow here\r
554//\r
555#pragma pack()\r
556#endif\r