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 _IPMI_NET_FN_APP_H_
25 #define _IPMI_NET_FN_APP_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
48 UINT8 DeviceRevision
: 4;
51 UINT8 MajorFirmwareRev
: 7;
53 UINT8 MinorFirmwareRev
;
54 UINT8 SpecificationVersion
;
55 UINT8 SensorDeviceSupport
: 1;
56 UINT8 SdrRepositorySupport
: 1;
57 UINT8 SelDeviceSupport
: 1;
58 UINT8 FruInventorySupport
: 1;
59 UINT8 IpmbMessageReceiver
: 1;
60 UINT8 IpmbMessageGenerator
: 1;
61 UINT8 BridgeSupport
: 1;
62 UINT8 ChassisSupport
: 1;
63 UINT8 ManufacturerId
[3];
65 UINT32 AuxFirmwareRevInfo
;
66 } IPMI_GET_DEVICE_ID_RESPONSE
;
70 // Definitions for Cold Reset command
72 #define IPMI_APP_COLD_RESET 0x2
75 // Constants and Structure definitions for "Cold Reset" command to follow here
79 // Definitions for Warm Reset command
81 #define IPMI_APP_WARM_RESET 0x3
84 // Constants and Structure definitions for "Warm Reset" command to follow here
88 // Definitions for Get Self Results command
90 #define IPMI_APP_GET_SELFTEST_RESULTS 0x4
93 // Constants and Structure definitions for "Get Self Test Results" command to follow here
99 } IPMI_SELF_TEST_RESULT_RESPONSE
;
101 #define IPMI_APP_SELFTEST_NO_ERROR 0x55
102 #define IPMI_APP_SELFTEST_NOT_IMPLEMENTED 0x56
103 #define IPMI_APP_SELFTEST_ERROR 0x57
104 #define IPMI_APP_SELFTEST_FATAL_HW_ERROR 0x58
105 #define IPMI_APP_SELFTEST_INACCESSIBLE_SEL 0x80
106 #define IPMI_APP_SELFTEST_INACCESSIBLE_SDR 0x40
107 #define IPMI_APP_SELFTEST_INACCESSIBLE_FRU 0x20
108 #define IPMI_APP_SELFTEST_IPMB_SIGNAL_FAIL 0x10
109 #define IPMI_APP_SELFTEST_SDR_REPOSITORY_EMPTY 0x08
110 #define IPMI_APP_SELFTEST_FRU_CORRUPT 0x04
111 #define IPMI_APP_SELFTEST_FW_BOOTBLOCK_CORRUPT 0x02
112 #define IPMI_APP_SELFTEST_FW_CORRUPT 0x01
115 // Definitions for Manufacturing Test ON command
117 #define IPMI_APP_MANUFACTURING_TEST_ON 0x5
120 // Constants and Structure definitions for "Manufacturing Test ON" command to follow here
124 // Definitions for Set ACPI Power State command
126 #define IPMI_APP_SET_ACPI_POWERSTATE 0x6
129 // Constants and Structure definitions for "Set ACPI Power State" command to follow here
132 UINT8 AcpiSystemPowerState
: 7;
133 UINT8 AcpiSystemStateChange
: 1;
134 UINT8 AcpiDevicePowerState
: 7;
135 UINT8 AcpiDeviceStateChange
: 1;
136 } IPMI_SET_ACPI_POWER_STATE_REQUEST
;
139 // Definitions for Get ACPI Power State command
141 #define IPMI_APP_GET_ACPI_POWERSTATE 0x7
144 // Constants and Structure definitions for "Get ACPI Power State" command to follow here
148 // Definitions for Get Device GUID command
150 #define IPMI_APP_GET_DEVICE_GUID 0x8
153 // Constants and Structure definitions for "Get Device GUID" command to follow here
156 // Message structure definition for "Get Device Guid" IPMI command
159 UINT8 CompletionCode
;
161 } IPMI_GET_DEVICE_GUID_RESPONSE
;
164 // Below is Definitions for BMC Watchdog Timer Commands (Chapter 27)
168 // Definitions for Reset WatchDog Timer command
170 #define IPMI_APP_RESET_WATCHDOG_TIMER 0x22
173 // Constants and Structure definitions for "Reset WatchDog Timer" command to follow here
178 UINT8 TimerRunning
: 1;
179 UINT8 TimerUseExpirationFlagLog
: 1;
180 } IPMI_WATCHDOG_TIMER_USE
;
183 // Definitions for Set WatchDog Timer command
185 #define IPMI_APP_SET_WATCHDOG_TIMER 0x24
188 // Constants and Structure definitions for "Set WatchDog Timer" command to follow here
191 IPMI_WATCHDOG_TIMER_USE TimerUse
;
193 UINT8 PretimeoutInterval
;
194 UINT8 TimerUseExpirationFlagsClear
;
195 UINT16 InitialCountdownValue
;
196 } IPMI_SET_WATCHDOG_TIMER_REQUEST
;
199 // Definitions for Get WatchDog Timer command
201 #define IPMI_APP_GET_WATCHDOG_TIMER 0x25
204 // Constants and Structure definitions for "Get WatchDog Timer" command to follow here
207 UINT8 CompletionCode
;
208 IPMI_WATCHDOG_TIMER_USE TimerUse
;
210 UINT8 PretimeoutInterval
;
211 UINT8 TimerUseExpirationFlagsClear
;
212 UINT16 InitialCountdownValue
;
213 UINT16 PresentCountdownValue
;
214 } IPMI_GET_WATCHDOG_TIMER_RESPONSE
;
217 // Below is Definitions for IPMI Messaging Support Commands (Chapter 22)
221 // Definitions for Set BMC Global Enables command
223 #define IPMI_APP_SET_BMC_GLOBAL_ENABLES 0x2E
226 // Constants and Structure definitions for "Set BMC Global Enables " command to follow here
230 // Definitions for Get BMC Global Enables command
232 #define IPMI_APP_GET_BMC_GLOBAL_ENABLES 0x2F
235 // Constants and Structure definitions for "Get BMC Global Enables " command to follow here
239 // Definitions for Clear Message Flags command
241 #define IPMI_APP_CLEAR_MESSAGE_FLAGS 0x30
244 // Constants and Structure definitions for "Clear Message Flags" command to follow here
248 // Definitions for Get Message Flags command
250 #define IPMI_APP_GET_MESSAGE_FLAGS 0x31
253 // Constants and Structure definitions for "Get Message Flags" command to follow here
257 // Definitions for Enable Message Channel Receive command
259 #define IPMI_APP_ENABLE_MESSAGE_CHANNEL_RECEIVE 0x32
262 // Constants and Structure definitions for "Enable Message Channel Receive" command to follow here
266 // Definitions for Get Message command
268 #define IPMI_APP_GET_MESSAGE 0x33
271 // Constants and Structure definitions for "Get Message" command to follow here
275 // Definitions for Send Message command
277 #define IPMI_APP_SEND_MESSAGE 0x34
280 // Constants and Structure definitions for "Send Message" command to follow here
284 // Definitions for Read Event Message Buffer command
286 #define IPMI_APP_READ_EVENT_MSG_BUFFER 0x35
289 // Constants and Structure definitions for "Read Event Message Buffer" command to follow here
293 // Definitions for Get BT Interface Capabilities command
295 #define IPMI_APP_GET_BT_INTERFACE_CAPABILITY 0x36
298 // Constants and Structure definitions for "Get BT Interface Capabilities" command to follow here
302 // Definitions for Get System GUID command
304 #define IPMI_APP_GET_SYSTEM_GUID 0x37
307 // Constants and Structure definitions for "Get System GUID" command to follow here
311 // Definitions for Get Channel Authentication Capabilities command
313 #define IPMI_APP_GET_CHANNEL_AUTHENTICATION_CAPABILITIES 0x38
316 // Constants and Structure definitions for "Get Channel Authentication Capabilities" command to follow here
320 // Definitions for Get Session Challenge command
322 #define IPMI_APP_GET_SESSION_CHALLENGE 0x39
325 // Constants and Structure definitions for "Get Session Challenge" command to follow here
329 // Definitions for Activate Session command
331 #define IPMI_APP_ACTIVATE_SESSION 0x3A
334 // Constants and Structure definitions for "Activate Session" command to follow here
338 // Definitions for Set Session Privelege Level command
340 #define IPMI_APP_SET_SESSION_PRIVELEGE_LEVEL 0x3B
343 // Constants and Structure definitions for "Set Session Privelege Level" command to follow here
347 // Definitions for Close Session command
349 #define IPMI_APP_CLOSE_SESSION 0x3C
352 // Constants and Structure definitions for "Close Session" command to follow here
356 // Definitions for Get Session Info command
358 #define IPMI_APP_GET_SESSION_INFO 0x3D
361 // Constants and Structure definitions for "Get Session Info" command to follow here
365 // Definitions for Get Auth Code command
367 #define IPMI_APP_GET_AUTHCODE 0x3F
370 // Constants and Structure definitions for "Get AuthCode" command to follow here
374 // Definitions for Set Channel Access command
376 #define IPMI_APP_SET_CHANNEL_ACCESS 0x40
379 // Constants and Structure definitions for "Set Channel Access" command to follow here
383 // Definitions for Get Channel Access command
385 #define IPMI_APP_GET_CHANNEL_ACCESS 0x41
388 // Constants and Structure definitions for "Get Channel Access" command to follow here
394 UINT8 MemoryType
: 2;
395 } IPMI_GET_CHANNEL_ACCESS_REQUEST
;
398 UINT8 CompletionCode
;
399 UINT8 AccessMode
: 3;
400 UINT8 UserLevelAuthEnabled
: 1;
401 UINT8 MessageAuthEnable
: 1;
404 UINT8 ChannelPriviledgeLimit
: 4;
406 } IPMI_GET_CHANNEL_ACCESS_RESPONSE
;
409 // Definitions for Get Channel Info command
411 #define IPMI_APP_GET_CHANNEL_INFO 0x42
414 // Constants and Structure definitions for "Get Channel Info" command to follow here
417 UINT8 CompletionCode
;
420 UINT8 ChannelMediumType
: 7;
422 UINT8 ChannelProtocolType
: 5;
424 UINT8 ActiveSessionCount
: 6;
425 UINT8 SessionSupport
: 2;
427 UINT16 AuxChannelInfo
;
428 } IPMI_GET_CHANNEL_INFO_RESPONSE
;
431 // Definitions for Get Channel Info command
433 #define IPMI_APP_GET_CHANNEL_INFO 0x42
436 // Constants and Structure definitions for "Get Channel Info" command to follow here
440 // Definitions for Set User Access command
442 #define IPMI_APP_SET_USER_ACCESS 0x43
445 // Constants and Structure definitions for "Set User Access" command to follow here
449 // Definitions for Get User Access command
451 #define IPMI_APP_GET_USER_ACCESS 0x44
454 // Constants and Structure definitions for "Get User Access" command to follow here
458 // Definitions for Set User Name command
460 #define IPMI_APP_SET_USER_NAME 0x45
463 // Constants and Structure definitions for "Set User Name" command to follow here
467 // Definitions for Get User Name command
469 #define IPMI_APP_GET_USER_NAME 0x46
472 // Constants and Structure definitions for "Get User Name" command to follow here
476 // Definitions for Set User Password command
478 #define IPMI_APP_SET_USER_PASSWORD 0x47
481 // Constants and Structure definitions for "Set User Password" command to follow here
485 // Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24)
489 // Definitions for Activate Payload command
491 #define IPMI_APP_ACTIVATE_PAYLOAD 0x48
494 // Constants and Structure definitions for "Activate Payload" command to follow here
498 // Definitions for De-Activate Payload command
500 #define IPMI_APP_DEACTIVATE_PAYLOAD 0x49
503 // Constants and Structure definitions for "DeActivate Payload" command to follow here
507 // Definitions for Get Payload activation Status command
509 #define IPMI_APP_GET_PAYLOAD_ACTIVATION_STATUS 0x4a
512 // Constants and Structure definitions for "Get Payload activation Status" command to follow here
516 // Definitions for Get Payload Instance Info command
518 #define IPMI_APP_GET_PAYLOAD_INSTANCE_INFO 0x4b
521 // Constants and Structure definitions for "Get Payload Instance Info" command to follow here
525 // Definitions for Set User Payload Access command
527 #define IPMI_APP_SET_USER_PAYLOAD_ACCESS 0x4C
530 // Constants and Structure definitions for "Set User Payload Access" command to follow here
534 // Definitions for Get User Payload Access command
536 #define IPMI_APP_GET_USER_PAYLOAD_ACCESS 0x4D
539 // Constants and Structure definitions for "Get User Payload Access" command to follow here
543 // Definitions for Get Channel Payload Support command
545 #define IPMI_APP_GET_CHANNEL_PAYLOAD_SUPPORT 0x4E
548 // Constants and Structure definitions for "Get Channel Payload Support" command to follow here
552 // Definitions for Get Channel Payload Version command
554 #define IPMI_APP_GET_CHANNEL_PAYLOAD_VERSION 0x4F
557 // Constants and Structure definitions for "Get Channel Payload Version" command to follow here
561 // Definitions for Get Channel OEM Payload Info command
563 #define IPMI_APP_GET_CHANNEL_OEM_PAYLOAD_INFO 0x50
566 // Constants and Structure definitions for "Get Channel OEM Payload Info" command to follow here
570 // Definitions for Master Write-Read command
572 #define IPMI_APP_MASTER_WRITE_READ 0x52
575 // Constants and Structure definitions for "Master Write Read" command to follow here
579 // Definitions for Get Channel Cipher Suites command
581 #define IPMI_APP_GET_CHANNEL_CIPHER_SUITES 0x54
584 // Constants and Structure definitions for "Get Channel Cipher Suites" command to follow here
588 // Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24, Section 3)
592 // Definitions for Suspend-Resume Payload Encryption command
594 #define IPMI_APP_SUSPEND_RESUME_PAYLOAD_ENCRYPTION 0x55
597 // Constants and Structure definitions for "Suspend-Resume Payload Encryption" command to follow here
601 // Below is Definitions for IPMI Messaging Support Commands (Chapter 22, Section 25 and 9)
605 // Definitions for Set Channel Security Keys command
607 #define IPMI_APP_SET_CHANNEL_SECURITY_KEYS 0x56
610 // Constants and Structure definitions for "Set Channel Security Keys" command to follow here
614 // Definitions for Get System Interface Capabilities command
616 #define IPMI_APP_GET_SYSTEM_INTERFACE_CAPABILITIES 0x57
619 // Constants and Structure definitions for "Get System Interface Capabilities" command to follow here