2 IPMI 2.0 definitions from the IPMI Specification Version 2.0, Revision 1.1.
4 This file contains all NetFn App commands, including:
5 IPM Device "Global" Commands (Chapter 20)
6 Firmware Firewall & Command Discovery Commands (Chapter 21)
7 BMC Watchdog Timer Commands (Chapter 27)
8 IPMI Messaging Support Commands (Chapter 22)
9 RMCP+ Support and Payload Commands (Chapter 24)
11 See IPMI specification, Appendix G, Command Assignments
12 and Appendix H, Sub-function Assignments.
14 Copyright (c) 1999 - 2015, Intel Corporation. All rights reserved.<BR>
15 This program and the accompanying materials
16 are licensed and made available under the terms and conditions of the BSD License
17 which accompanies this distribution. The full text of the license may be found at
18 http://opensource.org/licenses/bsd-license.php
20 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
21 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
24 #ifndef _IPMINETFNAPPDEFINITIONS_H_
25 #define _IPMINETFNAPPDEFINITIONS_H_
29 // Net function definition for App command
31 #define IPMI_NETFN_APP 0x06
34 // Below is Definitions for IPM Device "Global" Commands (Chapter 20)
38 // Definitions for Get Device ID command
40 #define IPMI_APP_GET_DEVICE_ID 0x1
43 // Constants and Structure definitions for "Get Device ID" command to follow here
47 UINT8 DeviceRevision
: 4;
50 UINT8 MajorFirmwareRev
: 7;
52 UINT8 MinorFirmwareRev
;
53 UINT8 SpecificationVersion
;
54 UINT8 SensorDeviceSupport
: 1;
55 UINT8 SdrRepositorySupport
: 1;
56 UINT8 SelDeviceSupport
: 1;
57 UINT8 FruInventorySupport
: 1;
58 UINT8 IpmbMessageReceiver
: 1;
59 UINT8 IpmbMessageGenerator
: 1;
60 UINT8 BridgeSupport
: 1;
61 UINT8 ChassisSupport
: 1;
62 UINT8 ManufacturerId
[3];
64 UINT32 AuxFirmwareRevInfo
;
65 } IPMI_MSG_GET_DEVICE_ID_RSP
;
69 // Definitions for Cold Reset command
71 #define IPMI_APP_COLD_RESET 0x2
74 // Constants and Structure definitions for "Cold Reset" command to follow here
78 // Definitions for Warm Reset command
80 #define IPMI_APP_WARM_RESET 0x3
83 // Constants and Structure definitions for "Warm Reset" command to follow here
87 // Definitions for Get Self Results command
89 #define IPMI_APP_GET_SELFTEST_RESULTS 0x4
92 // Constants and Structure definitions for "Get Self Results" command to follow here
97 } IPMI_MSG_SELFTEST_RESULT_RSP
;
99 #define IPMI_APP_SELFTEST_NO_ERROR 0x55
100 #define IPMI_APP_SELFTEST_NOT_IMPLEMENTED 0x56
101 #define IPMI_APP_SELFTEST_ERROR 0x57
102 #define IPMI_APP_SELFTEST_FATAL_HW_ERROR 0x58
103 #define IPMI_APP_SELFTEST_INACCESSIBLE_SEL 0x80
104 #define IPMI_APP_SELFTEST_INACCESSIBLE_SDR 0x40
105 #define IPMI_APP_SELFTEST_INACCESSIBLE_FRU 0x20
106 #define IPMI_APP_SELFTEST_IPMB_SIGNAL_FAIL 0x10
107 #define IPMI_APP_SELFTEST_SDR_REPOSITORY_EMPTY 0x08
108 #define IPMI_APP_SELFTEST_FRU_CORRUPT 0x04
109 #define IPMI_APP_SELFTEST_FW_BOOTBLOCK_CORRUPT 0x02
110 #define IPMI_APP_SELFTEST_FW_CORRUPT 0x01
113 // Definitions for Manufacturing Test ON command
115 #define IPMI_APP_MANUFACTURING_TEST_ON 0x5
118 // Constants and Structure definitions for "Manufacturing Test ON" command to follow here
122 // Definitions for Set ACPI Power State command
124 #define IPMI_APP_SET_ACPI_POWERSTATE 0x6
127 // Constants and Structure definitions for "Set ACPI Power State" command to follow here
130 UINT8 SystemPowerState
: 7;
131 UINT8 SystemStateChange
: 1;
132 UINT8 DevicePowerState
: 7;
133 UINT8 DeviceStateChange
: 1;
134 } IPMI_ACPI_POWER_STATE
;
137 // Definitions for Get ACPI Power State command
139 #define IPMI_APP_GET_ACPI_POWERSTATE 0x7
142 // Constants and Structure definitions for "Get ACPI Power State" command to follow here
146 // Definitions for Get Device GUID command
148 #define IPMI_APP_GET_DEVICE_GUID 0x8
151 // Constants and Structure definitions for "Get Device GUID" command to follow here
154 // Message structure definition for "Get Device Guid" IPMI command
158 } IPMI_MSG_GET_DEVICE_GUID_RSP
;
161 // Below is Definitions for BMC Watchdog Timer Commands (Chapter 27)
165 // Definitions for Reset WatchDog Timer command
167 #define IPMI_APP_RESET_WATCHDOG_TIMER 0x22
170 // Constants and Structure definitions for "Reset WatchDog Timer" command to follow here
175 UINT8 TimerRunning
: 1;
176 UINT8 TimerUseExpirationFlagLog
: 1;
177 } IPMI_WATCHDOG_TIMER_USE
;
180 // Definitions for Set WatchDog Timer command
182 #define IPMI_APP_SET_WATCHDOG_TIMER 0x24
185 // Constants and Structure definitions for "Set WatchDog Timer" command to follow here
188 IPMI_WATCHDOG_TIMER_USE TimerUse
;
190 UINT8 PretimeoutInterval
;
191 UINT8 TimerUseExpirationFlagsClear
;
192 UINT16 InitialCountdownValue
;
193 } IPMI_SET_WATCHDOG_TIMER
;
196 // Definitions for Get WatchDog Timer command
198 #define IPMI_APP_GET_WATCHDOG_TIMER 0x25
201 // Constants and Structure definitions for "Get WatchDog Timer" command to follow here
204 IPMI_WATCHDOG_TIMER_USE TimerUse
;
206 UINT8 PretimeoutInterval
;
207 UINT8 TimerUseExpirationFlagsClear
;
208 UINT16 InitialCountdownValue
;
209 UINT16 PresentCountdownValue
;
210 } IPMI_WATCHDOG_TIMER
;
213 // The following srucure is temporary, need to be removed later
218 UINT8 StartTimer
: 1;
222 UINT8 TimeoutAction
: 3;
224 UINT8 PreTimeoutIntr
: 3;
230 UINT8 PreTimeoutInterval
;
231 UINT8 ExpirationReserved1
: 1;
232 UINT8 BiosFrb2TimerExpirationFlag
: 1;
233 UINT8 BiosPostTimerExpirationFlag
: 1;
234 UINT8 OsLoadTimerExpirationFlag
: 1;
235 UINT8 ExpirationReserved2
: 4;
237 UINT16 CurrCountdown
;
242 // Below is Definitions for IPMI Messaging Support Commands (Chapter 22)
246 // Definitions for Set BMC Global Enables command
248 #define IPMI_APP_SET_BMC_GLOBAL_ENABLES 0x2E
251 // Constants and Structure definitions for "Set BMC Global Enables " command to follow here
255 // Definitions for Get BMC Global Enables command
257 #define IPMI_APP_GET_BMC_GLOBAL_ENABLES 0x2F
260 // Constants and Structure definitions for "Get BMC Global Enables " command to follow here
264 // Definitions for Clear Message Flags command
266 #define IPMI_APP_CLEAR_MESSAGE_FLAGS 0x30
269 // Constants and Structure definitions for "Clear Message Flags" command to follow here
273 // Definitions for Get Message Flags command
275 #define IPMI_APP_GET_MESSAGE_FLAGS 0x31
278 // Constants and Structure definitions for "Get Message Flags" command to follow here
282 // Definitions for Enable Message Channel Receive command
284 #define IPMI_APP_ENABLE_MESSAGE_CHANNEL_RECEIVE 0x32
287 // Constants and Structure definitions for "Enable Message Channel Receive" command to follow here
291 // Definitions for Get Message command
293 #define IPMI_APP_GET_MESSAGE 0x33
296 // Constants and Structure definitions for "Get Message" command to follow here
300 // Definitions for Send Message command
302 #define IPMI_APP_SEND_MESSAGE 0x34
305 // Constants and Structure definitions for "Send Message" command to follow here
309 // Definitions for Read Event Message Buffer command
311 #define IPMI_APP_READ_EVENT_MSG_BUFFER 0x35
314 // Constants and Structure definitions for "Read Event Message Buffer" command to follow here
318 // Definitions for Get BT Interface Capabilities command
320 #define IPMI_APP_GET_BT_INTERFACE_CAPABILITY 0x36
323 // Constants and Structure definitions for "Get BT Interface Capabilities" command to follow here
327 // Definitions for Get System GUID command
329 #define IPMI_APP_GET_SYSTEM_GUID 0x37
332 // Constants and Structure definitions for "Get System GUID" command to follow here
336 // Definitions for Get Channel Authentication Capabilities command
338 #define IPMI_APP_GET_CHANNEL_AUTHENTICATION_CAPABILITIES 0x38
341 // Constants and Structure definitions for "Get Channel Authentication Capabilities" command to follow here
345 // Definitions for Get Session Challenge command
347 #define IPMI_APP_GET_SESSION_CHALLENGE 0x39
350 // Constants and Structure definitions for "Get Session Challenge" command to follow here
354 // Definitions for Activate Session command
356 #define IPMI_APP_ACTIVATE_SESSION 0x3A
359 // Constants and Structure definitions for "Activate Session" command to follow here
363 // Definitions for Set Session Privelege Level command
365 #define IPMI_APP_SET_SESSION_PRIVELEGE_LEVEL 0x3B
368 // Constants and Structure definitions for "Set Session Privelege Level" command to follow here
372 // Definitions for Close Session command
374 #define IPMI_APP_CLOSE_SESSION 0x3C
377 // Constants and Structure definitions for "Close Session" command to follow here
381 // Definitions for Get Session Info command
383 #define IPMI_APP_GET_SESSION_INFO 0x3D
386 // Constants and Structure definitions for "Get Session Info" command to follow here
390 // Definitions for Get Auth Code command
392 #define IPMI_APP_GET_AUTHCODE 0x3F
395 // Constants and Structure definitions for "Get AuthCode" command to follow here
399 // Definitions for Set Channel Access command
401 #define IPMI_APP_SET_CHANNEL_ACCESS 0x40
404 // Constants and Structure definitions for "Set Channel Access" command to follow here
408 // Definitions for Get Channel Access command
410 #define IPMI_APP_GET_CHANNEL_ACCESS 0x41
413 // Constants and Structure definitions for "Get Channel Access" command to follow here
419 UINT8 MemoryType
: 2;
420 } IPMI_GET_CHANNEL_ACCESS_COMMAND
;
423 UINT8 AccessMode
: 3;
424 UINT8 UserLevelAuthEnabled
: 1;
425 UINT8 MessageAuthEnable
: 1;
428 UINT8 ChannelPriviledgeLimit
: 4;
430 } IPMI_GET_CHANNEL_ACCESS_RESPONSE
;
433 // Definitions for Get Channel Info command
435 #define IPMI_APP_GET_CHANNEL_INFO 0x42
438 // Constants and Structure definitions for "Get Channel Info" command to follow here
443 UINT8 ChannelMediumType
: 7;
445 UINT8 ChannelProtocolType
: 5;
447 UINT8 ActiveSessionCount
: 6;
448 UINT8 SessionSupport
: 2;
449 UINT32 VendorId
: 24;
450 UINT16 AuxChannelInfo
: 16;
455 // Definitions for Get Channel Info command
457 #define IPMI_APP_GET_CHANNEL_INFO 0x42
460 // Constants and Structure definitions for "Get Channel Info" command to follow here
464 // Definitions for Set User Access command
466 #define IPMI_APP_SET_USER_ACCESS 0x43
469 // Constants and Structure definitions for "Set User Access" command to follow here
473 // Definitions for Get User Access command
475 #define IPMI_APP_GET_USER_ACCESS 0x44
478 // Constants and Structure definitions for "Get User Access" command to follow here
482 // Definitions for Set User Name command
484 #define IPMI_APP_SET_USER_NAME 0x45
487 // Constants and Structure definitions for "Set User Name" command to follow here
491 // Definitions for Get User Name command
493 #define IPMI_APP_GET_USER_NAME 0x46
496 // Constants and Structure definitions for "Get User Name" command to follow here
500 // Definitions for Set User Password command
502 #define IPMI_APP_SET_USER_PASSWORD 0x47
505 // Constants and Structure definitions for "Set User Password" command to follow here
509 // Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24)
513 // Definitions for Activate Payload command
515 #define IPMI_APP_ACTIVATE_PAYLOAD 0x48
518 // Constants and Structure definitions for "Activate Payload" command to follow here
522 // Definitions for De-Activate Payload command
524 #define IPMI_APP_DEACTIVATE_PAYLOAD 0x49
527 // Constants and Structure definitions for "DeActivate Payload" command to follow here
531 // Definitions for Get Payload activation Status command
533 #define IPMI_APP_GET_PAYLOAD_ACTIVATION_STATUS 0x4a
536 // Constants and Structure definitions for "Get Payload activation Status" command to follow here
540 // Definitions for Get Payload Instance Info command
542 #define IPMI_APP_GET_PAYLOAD_INSTANCE_INFO 0x4b
545 // Constants and Structure definitions for "Get Payload Instance Info" command to follow here
549 // Definitions for Set User Payload Access command
551 #define IPMI_APP_SET_USER_PAYLOAD_ACCESS 0x4C
554 // Constants and Structure definitions for "Set User Payload Access" command to follow here
558 // Definitions for Get User Payload Access command
560 #define IPMI_APP_GET_USER_PAYLOAD_ACCESS 0x4D
563 // Constants and Structure definitions for "Get User Payload Access" command to follow here
567 // Definitions for Get Channel Payload Support command
569 #define IPMI_APP_GET_CHANNEL_PAYLOAD_SUPPORT 0x4E
572 // Constants and Structure definitions for "Get Channel Payload Support" command to follow here
576 // Definitions for Get Channel Payload Version command
578 #define IPMI_APP_GET_CHANNEL_PAYLOAD_VERSION 0x4F
581 // Constants and Structure definitions for "Get Channel Payload Version" command to follow here
585 // Definitions for Get Channel OEM Payload Info command
587 #define IPMI_APP_GET_CHANNEL_OEM_PAYLOAD_INFO 0x50
590 // Constants and Structure definitions for "Get Channel OEM Payload Info" command to follow here
594 // Definitions for Master Write-Read command
596 #define IPMI_APP_MASTER_WRITE_READ 0x52
599 // Constants and Structure definitions for "Master Write Read" command to follow here
603 // Definitions for Get Channel Cipher Suites command
605 #define IPMI_APP_GET_CHANNEL_CIPHER_SUITES 0x54
608 // Constants and Structure definitions for "Get Channel Cipher Suites" command to follow here
612 // Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24, Section 3)
616 // Definitions for Suspend-Resume Payload Encryption command
618 #define IPMI_APP_SUSPEND_RESUME_PAYLOAD_ENCRYPTION 0x55
621 // Constants and Structure definitions for "Suspend-Resume Payload Encryption" command to follow here
625 // Below is Definitions for IPMI Messaging Support Commands (Chapter 22, Section 25 and 9)
629 // Definitions for Set Channel Security Keys command
631 #define IPMI_APP_SET_CHANNEL_SECURITY_KEYS 0x56
634 // Constants and Structure definitions for "Set Channel Security Keys" command to follow here
638 // Definitions for Get System Interface Capabilities command
640 #define IPMI_APP_GET_SYSTEM_INTERFACE_CAPABILITIES 0x57
643 // Constants and Structure definitions for "Get System Interface Capabilities" command to follow here