]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/IpmiNetFnApp.h
MdePkg/IndustryStandard/Ipmi: Update IPMI header files
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / IpmiNetFnApp.h
CommitLineData
e59a797f
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 App commands, including:\r
5 IPM Device "Global" Commands (Chapter 20)\r
6 Firmware Firewall & Command Discovery Commands (Chapter 21)\r
7 BMC Watchdog Timer Commands (Chapter 27)\r
8 IPMI Messaging Support Commands (Chapter 22)\r
9 RMCP+ Support and Payload Commands (Chapter 24)\r
10\r
11 See IPMI specification, Appendix G, Command Assignments\r
12 and Appendix H, Sub-function Assignments.\r
13\r
25517f7c 14 Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>\r
e59a797f
DB
15 This program and the accompanying materials\r
16 are licensed and made available under the terms and conditions of the BSD License\r
17 which accompanies this distribution. The full text of the license may be found at\r
18 http://opensource.org/licenses/bsd-license.php\r
19\r
20 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
21 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
22**/\r
23\r
24#ifndef _IPMI_NET_FN_APP_H_\r
25#define _IPMI_NET_FN_APP_H_\r
26\r
27#pragma pack(1)\r
28//\r
29// Net function definition for App command\r
30//\r
31#define IPMI_NETFN_APP 0x06\r
32\r
33//\r
34// Below is Definitions for IPM Device "Global" Commands (Chapter 20)\r
35//\r
36\r
37//\r
38// Definitions for Get Device ID command\r
39//\r
40#define IPMI_APP_GET_DEVICE_ID 0x1\r
41\r
42//\r
43// Constants and Structure definitions for "Get Device ID" command to follow here\r
44//\r
45typedef struct {\r
aeff1d6e 46 UINT8 CompletionCode;\r
e59a797f
DB
47 UINT8 DeviceId;\r
48 UINT8 DeviceRevision : 4;\r
49 UINT8 Reserved : 3;\r
50 UINT8 DeviceSdr : 1;\r
51 UINT8 MajorFirmwareRev : 7;\r
52 UINT8 UpdateMode : 1;\r
53 UINT8 MinorFirmwareRev;\r
54 UINT8 SpecificationVersion;\r
55 UINT8 SensorDeviceSupport : 1;\r
56 UINT8 SdrRepositorySupport : 1;\r
57 UINT8 SelDeviceSupport : 1;\r
58 UINT8 FruInventorySupport : 1;\r
59 UINT8 IpmbMessageReceiver : 1;\r
60 UINT8 IpmbMessageGenerator : 1;\r
61 UINT8 BridgeSupport : 1;\r
62 UINT8 ChassisSupport : 1;\r
63 UINT8 ManufacturerId[3];\r
64 UINT16 ProductId;\r
65 UINT32 AuxFirmwareRevInfo;\r
aeff1d6e 66} IPMI_GET_DEVICE_ID_RESPONSE;\r
e59a797f
DB
67\r
68\r
69//\r
70// Definitions for Cold Reset command\r
71//\r
72#define IPMI_APP_COLD_RESET 0x2\r
73\r
74//\r
75// Constants and Structure definitions for "Cold Reset" command to follow here\r
76//\r
77\r
78//\r
79// Definitions for Warm Reset command\r
80//\r
81#define IPMI_APP_WARM_RESET 0x3\r
82\r
83//\r
84// Constants and Structure definitions for "Warm Reset" command to follow here\r
85//\r
86\r
87//\r
88// Definitions for Get Self Results command\r
89//\r
90#define IPMI_APP_GET_SELFTEST_RESULTS 0x4\r
91\r
92//\r
aeff1d6e 93// Constants and Structure definitions for "Get Self Test Results" command to follow here\r
e59a797f
DB
94//\r
95typedef struct {\r
aeff1d6e 96 UINT8 CompletionCode;\r
e59a797f
DB
97 UINT8 Result;\r
98 UINT8 Param;\r
aeff1d6e 99} IPMI_SELF_TEST_RESULT_RESPONSE;\r
e59a797f
DB
100\r
101#define IPMI_APP_SELFTEST_NO_ERROR 0x55\r
102#define IPMI_APP_SELFTEST_NOT_IMPLEMENTED 0x56\r
103#define IPMI_APP_SELFTEST_ERROR 0x57\r
104#define IPMI_APP_SELFTEST_FATAL_HW_ERROR 0x58\r
105#define IPMI_APP_SELFTEST_INACCESSIBLE_SEL 0x80\r
106#define IPMI_APP_SELFTEST_INACCESSIBLE_SDR 0x40\r
107#define IPMI_APP_SELFTEST_INACCESSIBLE_FRU 0x20\r
108#define IPMI_APP_SELFTEST_IPMB_SIGNAL_FAIL 0x10\r
109#define IPMI_APP_SELFTEST_SDR_REPOSITORY_EMPTY 0x08\r
110#define IPMI_APP_SELFTEST_FRU_CORRUPT 0x04\r
111#define IPMI_APP_SELFTEST_FW_BOOTBLOCK_CORRUPT 0x02\r
112#define IPMI_APP_SELFTEST_FW_CORRUPT 0x01\r
113\r
114//\r
115// Definitions for Manufacturing Test ON command\r
116//\r
117#define IPMI_APP_MANUFACTURING_TEST_ON 0x5\r
118\r
119//\r
120// Constants and Structure definitions for "Manufacturing Test ON" command to follow here\r
121//\r
122\r
123//\r
124// Definitions for Set ACPI Power State command\r
125//\r
126#define IPMI_APP_SET_ACPI_POWERSTATE 0x6\r
127\r
128//\r
129// Constants and Structure definitions for "Set ACPI Power State" command to follow here\r
130//\r
25517f7c
HW
131\r
132//\r
133// Definitions for System Power State\r
134//\r
135// Working\r
136#define IPMI_SYSTEM_POWER_STATE_S0_G0 0x0\r
137#define IPMI_SYSTEM_POWER_STATE_S1 0x1\r
138#define IPMI_SYSTEM_POWER_STATE_S2 0x2\r
139#define IPMI_SYSTEM_POWER_STATE_S3 0x3\r
140#define IPMI_SYSTEM_POWER_STATE_S4 0x4\r
141// Soft off\r
142#define IPMI_SYSTEM_POWER_STATE_S5_G2 0x5\r
143// Sent when message source cannot differentiate between S4 and S5\r
144#define IPMI_SYSTEM_POWER_STATE_S4_S5 0x6\r
145// Mechanical off\r
146#define IPMI_SYSTEM_POWER_STATE_G3 0x7\r
147// Sleeping - cannot differentiate between S1-S3\r
148#define IPMI_SYSTEM_POWER_STATE_SLEEPING 0x8\r
149// Sleeping - cannot differentiate between S1-S4\r
150#define IPMI_SYSTEM_POWER_STATE_G1_SLEEPING 0x9\r
151// S5 entered by override\r
152#define IPMI_SYSTEM_POWER_STATE_OVERRIDE 0xA\r
153#define IPMI_SYSTEM_POWER_STATE_LEGACY_ON 0x20\r
154#define IPMI_SYSTEM_POWER_STATE_LEGACY_OFF 0x21\r
155#define IPMI_SYSTEM_POWER_STATE_UNKNOWN 0x2A\r
156#define IPMI_SYSTEM_POWER_STATE_NO_CHANGE 0x7F\r
157\r
158//\r
159// Definitions for Device Power State\r
160//\r
161#define IPMI_DEVICE_POWER_STATE_D0 0x0\r
162#define IPMI_DEVICE_POWER_STATE_D1 0x1\r
163#define IPMI_DEVICE_POWER_STATE_D2 0x2\r
164#define IPMI_DEVICE_POWER_STATE_D3 0x3\r
165#define IPMI_DEVICE_POWER_STATE_UNKNOWN 0x2A\r
166#define IPMI_DEVICE_POWER_STATE_NO_CHANGE 0x7F\r
167\r
e59a797f 168typedef struct {\r
aeff1d6e
DB
169 UINT8 AcpiSystemPowerState : 7;\r
170 UINT8 AcpiSystemStateChange : 1;\r
171 UINT8 AcpiDevicePowerState : 7;\r
172 UINT8 AcpiDeviceStateChange : 1;\r
173} IPMI_SET_ACPI_POWER_STATE_REQUEST;\r
e59a797f
DB
174\r
175//\r
176// Definitions for Get ACPI Power State command\r
177//\r
178#define IPMI_APP_GET_ACPI_POWERSTATE 0x7\r
179\r
180//\r
181// Constants and Structure definitions for "Get ACPI Power State" command to follow here\r
182//\r
183\r
184//\r
185// Definitions for Get Device GUID command\r
186//\r
187#define IPMI_APP_GET_DEVICE_GUID 0x8\r
188\r
189//\r
190// Constants and Structure definitions for "Get Device GUID" command to follow here\r
191//\r
192//\r
193// Message structure definition for "Get Device Guid" IPMI command\r
194//\r
195typedef struct {\r
aeff1d6e
DB
196 UINT8 CompletionCode;\r
197 UINT8 Guid[16];\r
198} IPMI_GET_DEVICE_GUID_RESPONSE;\r
e59a797f
DB
199\r
200//\r
201// Below is Definitions for BMC Watchdog Timer Commands (Chapter 27)\r
202//\r
203\r
204//\r
205// Definitions for Reset WatchDog Timer command\r
206//\r
207#define IPMI_APP_RESET_WATCHDOG_TIMER 0x22\r
208\r
209//\r
25517f7c
HW
210// Definitions for Set WatchDog Timer command\r
211//\r
212#define IPMI_APP_SET_WATCHDOG_TIMER 0x24\r
213\r
214//\r
215// Constants and Structure definitions for "Set WatchDog Timer" command to follow here\r
216//\r
217\r
218//\r
219// Definitions for watchdog timer use\r
220//\r
221#define IPMI_WATCHDOG_TIMER_BIOS_FRB2 0x1\r
222#define IPMI_WATCHDOG_TIMER_BIOS_POST 0x2\r
223#define IPMI_WATCHDOG_TIMER_OS_LOADER 0x3\r
224#define IPMI_WATCHDOG_TIMER_SMS 0x4\r
225#define IPMI_WATCHDOG_TIMER_OEM 0x5\r
226\r
227//\r
228// Structure definition for timer Use\r
e59a797f
DB
229//\r
230typedef struct {\r
231 UINT8 TimerUse : 3;\r
232 UINT8 Reserved : 3;\r
233 UINT8 TimerRunning : 1;\r
234 UINT8 TimerUseExpirationFlagLog : 1;\r
235} IPMI_WATCHDOG_TIMER_USE;\r
236\r
237//\r
25517f7c 238// Definitions for watchdog timeout action\r
e59a797f 239//\r
25517f7c
HW
240#define IPMI_WATCHDOG_TIMER_ACTION_NO_ACTION 0x0\r
241#define IPMI_WATCHDOG_TIMER_ACTION_HARD_RESET 0x1\r
242#define IPMI_WATCHDOG_TIMER_ACTION_POWER_DONW 0x2\r
243#define IPMI_WATCHDOG_TIMER_ACTION_POWER_CYCLE 0x3\r
e59a797f
DB
244\r
245//\r
25517f7c
HW
246// Definitions for watchdog pre-timeout interrupt\r
247//\r
248#define IPMI_WATCHDOG_PRE_TIMEOUT_INTERRUPT_NONE 0x0\r
249#define IPMI_WATCHDOG_PRE_TIMEOUT_INTERRUPT_SMI 0x1\r
250#define IPMI_WATCHDOG_PRE_TIMEOUT_INTERRUPT_NMI 0x2\r
251#define IPMI_WATCHDOG_PRE_TIMEOUT_INTERRUPT_MESSAGING 0x3\r
252\r
253//\r
254// Structure definitions for Timer Actions\r
e59a797f 255//\r
25517f7c
HW
256typedef struct {\r
257 UINT8 TimeoutAction : 3;\r
258 UINT8 Reserved1 : 1;\r
259 UINT8 PreTimeoutInterrupt : 3;\r
260 UINT8 Reserved2 : 1;\r
261} IPMI_WATCHDOG_TIMER_ACTIONS;\r
262\r
263//\r
264// Bit definitions for Timer use expiration flags\r
265//\r
266#define IPMI_WATCHDOG_TIMER_EXPIRATION_FLAG_BIOS_FRB2 BIT1\r
267#define IPMI_WATCHDOG_TIMER_EXPIRATION_FLAG_BIOS_POST BIT2\r
268#define IPMI_WATCHDOG_TIMER_EXPIRATION_FLAG_OS_LOAD BIT3\r
269#define IPMI_WATCHDOG_TIMER_EXPIRATION_FLAG_SMS_OS BIT4\r
270#define IPMI_WATCHDOG_TIMER_EXPIRATION_FLAG_OEM BIT5\r
271\r
e59a797f
DB
272typedef struct {\r
273 IPMI_WATCHDOG_TIMER_USE TimerUse;\r
25517f7c 274 IPMI_WATCHDOG_TIMER_ACTIONS TimerActions;\r
e59a797f
DB
275 UINT8 PretimeoutInterval;\r
276 UINT8 TimerUseExpirationFlagsClear;\r
277 UINT16 InitialCountdownValue;\r
aeff1d6e 278} IPMI_SET_WATCHDOG_TIMER_REQUEST;\r
e59a797f
DB
279\r
280//\r
281// Definitions for Get WatchDog Timer command\r
282//\r
283#define IPMI_APP_GET_WATCHDOG_TIMER 0x25\r
284\r
285//\r
286// Constants and Structure definitions for "Get WatchDog Timer" command to follow here\r
287//\r
288typedef struct {\r
aeff1d6e 289 UINT8 CompletionCode;\r
e59a797f 290 IPMI_WATCHDOG_TIMER_USE TimerUse;\r
25517f7c 291 IPMI_WATCHDOG_TIMER_ACTIONS TimerActions;\r
e59a797f
DB
292 UINT8 PretimeoutInterval;\r
293 UINT8 TimerUseExpirationFlagsClear;\r
294 UINT16 InitialCountdownValue;\r
295 UINT16 PresentCountdownValue;\r
aeff1d6e 296} IPMI_GET_WATCHDOG_TIMER_RESPONSE;\r
e59a797f
DB
297\r
298//\r
299// Below is Definitions for IPMI Messaging Support Commands (Chapter 22)\r
300//\r
301\r
302//\r
303// Definitions for Set BMC Global Enables command\r
304//\r
305#define IPMI_APP_SET_BMC_GLOBAL_ENABLES 0x2E\r
306\r
307//\r
308// Constants and Structure definitions for "Set BMC Global Enables " command to follow here\r
309//\r
25517f7c
HW
310typedef struct {\r
311 UINT8 EnableReceiveMessageQueueInterrupt : 1;\r
312 UINT8 EnableEventMessageBufferFullInterrupt : 1;\r
313 UINT8 EnableEventMessageBuffer : 1;\r
314 UINT8 EnableSystemEventLogging : 1;\r
315 UINT8 Reserved : 1;\r
316 UINT8 Oem0Enable : 1;\r
317 UINT8 Oem1Enable : 1;\r
318 UINT8 Oem2Enable : 1;\r
319} IPMI_SET_BMC_GLOBAL_ENABLES_REQUEST;\r
e59a797f
DB
320\r
321//\r
322// Definitions for Get BMC Global Enables command\r
323//\r
324#define IPMI_APP_GET_BMC_GLOBAL_ENABLES 0x2F\r
325\r
326//\r
327// Constants and Structure definitions for "Get BMC Global Enables " command to follow here\r
328//\r
25517f7c
HW
329typedef struct {\r
330 UINT8 CompletionCode;\r
331 UINT8 ReceiveMessageQueueInterrupt : 1;\r
332 UINT8 EventMessageBufferFullInterrupt : 1;\r
333 UINT8 EventMessageBuffer : 1;\r
334 UINT8 SystemEventLogging : 1;\r
335 UINT8 Reserved : 1;\r
336 UINT8 Oem0Enable : 1;\r
337 UINT8 Oem1Enable : 1;\r
338 UINT8 Oem2Enable : 1;\r
339} IPMI_GET_BMC_GLOBAL_ENABLES_RESPONSE;\r
e59a797f
DB
340\r
341//\r
342// Definitions for Clear Message Flags command\r
343//\r
344#define IPMI_APP_CLEAR_MESSAGE_FLAGS 0x30\r
345\r
346//\r
347// Constants and Structure definitions for "Clear Message Flags" command to follow here\r
348//\r
25517f7c
HW
349typedef struct {\r
350 UINT8 ClearReceiveMessageQueue : 1;\r
351 UINT8 ClearEventMessageBuffer : 1;\r
352 UINT8 Reserved0 : 1;\r
353 UINT8 ClearWatchdogPerTimeoutInterruptFlag : 1;\r
354 UINT8 Reserved : 1;\r
355 UINT8 ClearOem0Enable : 1;\r
356 UINT8 ClearOem1Enable : 1;\r
357 UINT8 ClearOem2Enable : 1;\r
358} IPMI_CLEAR_MESSAGE_FLAGS_REQUEST;\r
e59a797f
DB
359\r
360//\r
361// Definitions for Get Message Flags command\r
362//\r
363#define IPMI_APP_GET_MESSAGE_FLAGS 0x31\r
364\r
365//\r
366// Constants and Structure definitions for "Get Message Flags" command to follow here\r
367//\r
25517f7c
HW
368typedef struct {\r
369 UINT8 CompletionCode;\r
370 UINT8 ReceiveMessageAvailable : 1;\r
371 UINT8 EventMessageBufferFull : 1;\r
372 UINT8 Reserved0 : 1;\r
373 UINT8 WatchdogPerTimeoutInterruptOccurred : 1;\r
374 UINT8 Reserved : 1;\r
375 UINT8 Oem0DataAvailable : 1;\r
376 UINT8 Oem1DataAvailable : 1;\r
377 UINT8 Oem2DataAvailable : 1;\r
378} IPMI_GET_MESSAGE_FLAGS_RESPONSE;\r
e59a797f
DB
379\r
380//\r
381// Definitions for Enable Message Channel Receive command\r
382//\r
383#define IPMI_APP_ENABLE_MESSAGE_CHANNEL_RECEIVE 0x32\r
384\r
385//\r
386// Constants and Structure definitions for "Enable Message Channel Receive" command to follow here\r
387//\r
388\r
389//\r
390// Definitions for Get Message command\r
391//\r
392#define IPMI_APP_GET_MESSAGE 0x33\r
393\r
394//\r
395// Constants and Structure definitions for "Get Message" command to follow here\r
396//\r
25517f7c
HW
397typedef struct {\r
398 UINT8 CompletionCode;\r
399 UINT8 ChannelNumber : 4;\r
400 UINT8 InferredPrivilegeLevel : 4;\r
401 UINT8 MessageData[0];\r
402} IPMI_GET_MESSAGE_RESPONSE;\r
e59a797f
DB
403\r
404//\r
405// Definitions for Send Message command\r
406//\r
407#define IPMI_APP_SEND_MESSAGE 0x34\r
408\r
409//\r
410// Constants and Structure definitions for "Send Message" command to follow here\r
411//\r
25517f7c
HW
412typedef struct {\r
413 UINT8 CompletionCode;\r
414 UINT8 ChannelNumber : 4;\r
415 UINT8 Authentication : 1;\r
416 UINT8 Encryption : 1;\r
417 UINT8 Tracking : 2;\r
418 UINT8 MessageData[0];\r
419} IPMI_SEND_MESSAGE_REQUEST;\r
420\r
421typedef struct {\r
422 UINT8 CompletionCode;\r
423 UINT8 ResponseData[0];\r
424} IPMI_SEND_MESSAGE_RESPONSE;\r
e59a797f
DB
425\r
426//\r
427// Definitions for Read Event Message Buffer command\r
428//\r
429#define IPMI_APP_READ_EVENT_MSG_BUFFER 0x35\r
430\r
431//\r
432// Constants and Structure definitions for "Read Event Message Buffer" command to follow here\r
433//\r
434\r
435//\r
436// Definitions for Get BT Interface Capabilities command\r
437//\r
438#define IPMI_APP_GET_BT_INTERFACE_CAPABILITY 0x36\r
439\r
440//\r
441// Constants and Structure definitions for "Get BT Interface Capabilities" command to follow here\r
442//\r
443\r
444//\r
445// Definitions for Get System GUID command\r
446//\r
447#define IPMI_APP_GET_SYSTEM_GUID 0x37\r
448\r
449//\r
450// Constants and Structure definitions for "Get System GUID" command to follow here\r
451//\r
452\r
453//\r
454// Definitions for Get Channel Authentication Capabilities command\r
455//\r
456#define IPMI_APP_GET_CHANNEL_AUTHENTICATION_CAPABILITIES 0x38\r
457\r
458//\r
459// Constants and Structure definitions for "Get Channel Authentication Capabilities" command to follow here\r
460//\r
461\r
462//\r
463// Definitions for Get Session Challenge command\r
464//\r
465#define IPMI_APP_GET_SESSION_CHALLENGE 0x39\r
466\r
467//\r
468// Constants and Structure definitions for "Get Session Challenge" command to follow here\r
469//\r
470\r
471//\r
472// Definitions for Activate Session command\r
473//\r
474#define IPMI_APP_ACTIVATE_SESSION 0x3A\r
475\r
476//\r
477// Constants and Structure definitions for "Activate Session" command to follow here\r
478//\r
479\r
480//\r
481// Definitions for Set Session Privelege Level command\r
482//\r
483#define IPMI_APP_SET_SESSION_PRIVELEGE_LEVEL 0x3B\r
484\r
485//\r
486// Constants and Structure definitions for "Set Session Privelege Level" command to follow here\r
487//\r
488\r
489//\r
490// Definitions for Close Session command\r
491//\r
492#define IPMI_APP_CLOSE_SESSION 0x3C\r
493\r
494//\r
495// Constants and Structure definitions for "Close Session" command to follow here\r
496//\r
497\r
498//\r
499// Definitions for Get Session Info command\r
500//\r
501#define IPMI_APP_GET_SESSION_INFO 0x3D\r
502\r
503//\r
504// Constants and Structure definitions for "Get Session Info" command to follow here\r
505//\r
506\r
507//\r
508// Definitions for Get Auth Code command\r
509//\r
510#define IPMI_APP_GET_AUTHCODE 0x3F\r
511\r
512//\r
513// Constants and Structure definitions for "Get AuthCode" command to follow here\r
514//\r
515\r
516//\r
517// Definitions for Set Channel Access command\r
518//\r
519#define IPMI_APP_SET_CHANNEL_ACCESS 0x40\r
520\r
521//\r
522// Constants and Structure definitions for "Set Channel Access" command to follow here\r
523//\r
524\r
525//\r
526// Definitions for Get Channel Access command\r
527//\r
528#define IPMI_APP_GET_CHANNEL_ACCESS 0x41\r
529\r
530//\r
531// Constants and Structure definitions for "Get Channel Access" command to follow here\r
532//\r
25517f7c
HW
533\r
534//\r
535// Definitions for channel access memory type in Get Channel Access command request\r
536//\r
537#define IPMI_CHANNEL_ACCESS_MEMORY_TYPE_NON_VOLATILE 0x1\r
538#define IPMI_CHANNEL_ACCESS_MEMORY_TYPE_PRESENT_VOLATILE_SETTING 0x2\r
539\r
540//\r
541// Definitions for channel access modes in Get Channel Access command response\r
542//\r
543#define IPMI_CHANNEL_ACCESS_MODES_DISABLED 0x0\r
544#define IPMI_CHANNEL_ACCESS_MODES_PRE_BOOT_ONLY 0x1\r
545#define IPMI_CHANNEL_ACCESS_MODES_ALWAYS_AVAILABLE 0x2\r
546#define IPMI_CHANNEL_ACCESS_MODES_SHARED 0x3\r
547\r
e59a797f 548typedef struct {\r
aeff1d6e
DB
549 UINT8 ChannelNo : 4;\r
550 UINT8 Reserve1 : 4;\r
551 UINT8 Reserve2 : 6;\r
552 UINT8 MemoryType : 2;\r
553} IPMI_GET_CHANNEL_ACCESS_REQUEST;\r
e59a797f
DB
554\r
555typedef struct {\r
aeff1d6e
DB
556 UINT8 CompletionCode;\r
557 UINT8 AccessMode : 3;\r
558 UINT8 UserLevelAuthEnabled : 1;\r
559 UINT8 MessageAuthEnable : 1;\r
560 UINT8 Alert : 1;\r
561 UINT8 Reserve1 : 2;\r
562 UINT8 ChannelPriviledgeLimit : 4;\r
563 UINT8 Reserve2 : 4;\r
e59a797f
DB
564} IPMI_GET_CHANNEL_ACCESS_RESPONSE;\r
565\r
566//\r
567// Definitions for Get Channel Info command\r
568//\r
569#define IPMI_APP_GET_CHANNEL_INFO 0x42\r
570\r
571//\r
572// Constants and Structure definitions for "Get Channel Info" command to follow here\r
573//\r
25517f7c
HW
574\r
575//\r
576// Definitions for channel media type\r
577//\r
578// IPMB (I2C)\r
579#define IPMI_CHANNEL_MEDIA_TYPE_IPMB 0x1\r
580// ICMB v1.0\r
581#define IPMI_CHANNEL_MEDIA_TYPE_ICMB_1_0 0x2\r
582// ICMB v0.9\r
583#define IPMI_CHANNEL_MEDIA_TYPE_ICMB_0_9 0x3\r
584// 802.3 LAN\r
585#define IPMI_CHANNEL_MEDIA_TYPE_802_3_LAN 0x4\r
586// Asynch. Serial/Modem (RS-232)\r
587#define IPMI_CHANNEL_MEDIA_TYPE_RS_232 0x5\r
588// Other LAN\r
589#define IPMI_CHANNEL_MEDIA_TYPE_OTHER_LAN 0x6\r
590// PCI SMBus\r
591#define IPMI_CHANNEL_MEDIA_TYPE_PCI_SM_BUS 0x7\r
592// SMBus v1.0/1.1\r
593#define IPMI_CHANNEL_MEDIA_TYPE_SM_BUS_V1 0x8\r
594// SMBus v2.0\r
595#define IPMI_CHANNEL_MEDIA_TYPE_SM_BUS_V2 0x9\r
596// USB 1.x\r
597#define IPMI_CHANNEL_MEDIA_TYPE_USB1 0xA\r
598// USB 2.x\r
599#define IPMI_CHANNEL_MEDIA_TYPE_USB2 0xB\r
600// System Interface (KCS, SMIC, or BT)\r
601#define IPMI_CHANNEL_MEDIA_TYPE_SYSTEM_INTERFACE 0xC\r
602// OEM\r
603#define IPMI_CHANNEL_MEDIA_TYPE_OEM_START 0x60\r
604#define IPMI_CHANNEL_MEDIA_TYPE_OEM_END 0x7F\r
605\r
e59a797f 606typedef struct {\r
aeff1d6e 607 UINT8 CompletionCode;\r
e59a797f
DB
608 UINT8 ChannelNo : 4;\r
609 UINT8 Reserve1 : 4;\r
610 UINT8 ChannelMediumType : 7;\r
611 UINT8 Reserve2 : 1;\r
612 UINT8 ChannelProtocolType : 5;\r
613 UINT8 Reserve3 : 3;\r
614 UINT8 ActiveSessionCount : 6;\r
615 UINT8 SessionSupport : 2;\r
aeff1d6e
DB
616 UINT8 VendorId[3];\r
617 UINT16 AuxChannelInfo;\r
618} IPMI_GET_CHANNEL_INFO_RESPONSE;\r
e59a797f
DB
619\r
620//\r
621// Definitions for Get Channel Info command\r
622//\r
623#define IPMI_APP_GET_CHANNEL_INFO 0x42\r
624\r
625//\r
626// Constants and Structure definitions for "Get Channel Info" command to follow here\r
627//\r
628\r
629//\r
630// Definitions for Set User Access command\r
631//\r
632#define IPMI_APP_SET_USER_ACCESS 0x43\r
633\r
634//\r
635// Constants and Structure definitions for "Set User Access" command to follow here\r
636//\r
637\r
638//\r
639// Definitions for Get User Access command\r
640//\r
641#define IPMI_APP_GET_USER_ACCESS 0x44\r
642\r
643//\r
644// Constants and Structure definitions for "Get User Access" command to follow here\r
645//\r
25517f7c
HW
646typedef struct {\r
647 UINT8 ChannelNo : 4;\r
648 UINT8 Reserved1 : 4;\r
649 UINT8 UserId : 6;\r
650 UINT8 Reserved2 : 2;\r
651} IPMI_GET_USER_ACCESS_REQUEST;\r
652\r
653typedef struct {\r
654 UINT8 CompletionCode;\r
655 UINT8 MaxUserId : 6;\r
656 UINT8 Reserved1 : 2;\r
657 UINT8 CurrentUserId : 6;\r
658 UINT8 UserIdEnableStatus : 2;\r
659 UINT8 FixedUserId : 6;\r
660 UINT8 Reserved2 : 2;\r
661 UINT8 UserPrivilegeLimit : 4;\r
662 UINT8 EnableIpmiMessaging : 1;\r
663 UINT8 EnableUserLinkAuthetication : 1;\r
664 UINT8 UserAccessAvailable : 1;\r
665 UINT8 Reserved3 : 1;\r
666} IPMI_GET_USER_ACCESS_RESPONSE;\r
e59a797f
DB
667\r
668//\r
669// Definitions for Set User Name command\r
670//\r
671#define IPMI_APP_SET_USER_NAME 0x45\r
672\r
673//\r
674// Constants and Structure definitions for "Set User Name" command to follow here\r
675//\r
25517f7c
HW
676typedef struct {\r
677 UINT8 UserId : 6;\r
678 UINT8 Reserved : 2;\r
679 UINT8 UserName[16];\r
680} IPMI_SET_USER_NAME_REQUEST;\r
e59a797f
DB
681\r
682//\r
683// Definitions for Get User Name command\r
684//\r
685#define IPMI_APP_GET_USER_NAME 0x46\r
686\r
687//\r
688// Constants and Structure definitions for "Get User Name" command to follow here\r
689//\r
25517f7c
HW
690typedef struct {\r
691 UINT8 UserId : 6;\r
692 UINT8 Reserved : 2;\r
693} IPMI_GET_USER_NAME_REQUEST;\r
694\r
695typedef struct {\r
696 UINT8 CompletionCode;\r
697 UINT8 UserName[16];\r
698} IPMI_GET_USER_NAME_RESPONSE;\r
e59a797f
DB
699\r
700//\r
701// Definitions for Set User Password command\r
702//\r
703#define IPMI_APP_SET_USER_PASSWORD 0x47\r
704\r
705//\r
706// Constants and Structure definitions for "Set User Password" command to follow here\r
707//\r
708\r
25517f7c
HW
709//\r
710// Definitions for Set User password command operation type\r
711//\r
712#define IPMI_SET_USER_PASSWORD_OPERATION_TYPE_DISABLE_USER 0x0\r
713#define IPMI_SET_USER_PASSWORD_OPERATION_TYPE_ENABLE_USER 0x1\r
714#define IPMI_SET_USER_PASSWORD_OPERATION_TYPE_SET_PASSWORD 0x2\r
715#define IPMI_SET_USER_PASSWORD_OPERATION_TYPE_TEST_PASSWORD 0x3\r
716\r
717//\r
718// Definitions for Set user password command password size\r
719//\r
720#define IPMI_SET_USER_PASSWORD_PASSWORD_SIZE_16 0x0\r
721#define IPMI_SET_USER_PASSWORD_PASSWORD_SIZE_20 0x1\r
722\r
723typedef struct {\r
724 UINT8 UserId : 6;\r
725 UINT8 Reserved1 : 1;\r
726 UINT8 PasswordSize : 1;\r
727 UINT8 Operation : 2;\r
728 UINT8 Reserved2 : 6;\r
729 UINT8 PasswordData[0]; // 16 or 20 bytes, depending on the 'PasswordSize' field\r
730} IPMI_SET_USER_PASSWORD_REQUEST;\r
731\r
e59a797f
DB
732//\r
733// Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24)\r
734//\r
735\r
736//\r
737// Definitions for Activate Payload command\r
738//\r
739#define IPMI_APP_ACTIVATE_PAYLOAD 0x48\r
740\r
741//\r
742// Constants and Structure definitions for "Activate Payload" command to follow here\r
743//\r
744\r
745//\r
746// Definitions for De-Activate Payload command\r
747//\r
748#define IPMI_APP_DEACTIVATE_PAYLOAD 0x49\r
749\r
750//\r
751// Constants and Structure definitions for "DeActivate Payload" command to follow here\r
752//\r
753\r
754//\r
755// Definitions for Get Payload activation Status command\r
756//\r
757#define IPMI_APP_GET_PAYLOAD_ACTIVATION_STATUS 0x4a\r
758\r
759//\r
760// Constants and Structure definitions for "Get Payload activation Status" command to follow here\r
761//\r
762\r
763//\r
764// Definitions for Get Payload Instance Info command\r
765//\r
766#define IPMI_APP_GET_PAYLOAD_INSTANCE_INFO 0x4b\r
767\r
768//\r
769// Constants and Structure definitions for "Get Payload Instance Info" command to follow here\r
770//\r
771\r
772//\r
773// Definitions for Set User Payload Access command\r
774//\r
775#define IPMI_APP_SET_USER_PAYLOAD_ACCESS 0x4C\r
776\r
777//\r
778// Constants and Structure definitions for "Set User Payload Access" command to follow here\r
779//\r
780\r
781//\r
782// Definitions for Get User Payload Access command\r
783//\r
784#define IPMI_APP_GET_USER_PAYLOAD_ACCESS 0x4D\r
785\r
786//\r
787// Constants and Structure definitions for "Get User Payload Access" command to follow here\r
788//\r
789\r
790//\r
791// Definitions for Get Channel Payload Support command\r
792//\r
793#define IPMI_APP_GET_CHANNEL_PAYLOAD_SUPPORT 0x4E\r
794\r
795//\r
796// Constants and Structure definitions for "Get Channel Payload Support" command to follow here\r
797//\r
798\r
799//\r
800// Definitions for Get Channel Payload Version command\r
801//\r
802#define IPMI_APP_GET_CHANNEL_PAYLOAD_VERSION 0x4F\r
803\r
804//\r
805// Constants and Structure definitions for "Get Channel Payload Version" command to follow here\r
806//\r
807\r
808//\r
809// Definitions for Get Channel OEM Payload Info command\r
810//\r
811#define IPMI_APP_GET_CHANNEL_OEM_PAYLOAD_INFO 0x50\r
812\r
813//\r
814// Constants and Structure definitions for "Get Channel OEM Payload Info" command to follow here\r
815//\r
816\r
817//\r
818// Definitions for Master Write-Read command\r
819//\r
820#define IPMI_APP_MASTER_WRITE_READ 0x52\r
821\r
822//\r
823// Constants and Structure definitions for "Master Write Read" command to follow here\r
824//\r
825\r
826//\r
827// Definitions for Get Channel Cipher Suites command\r
828//\r
829#define IPMI_APP_GET_CHANNEL_CIPHER_SUITES 0x54\r
830\r
831//\r
832// Constants and Structure definitions for "Get Channel Cipher Suites" command to follow here\r
833//\r
834\r
835//\r
836// Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24, Section 3)\r
837//\r
838\r
839//\r
840// Definitions for Suspend-Resume Payload Encryption command\r
841//\r
842#define IPMI_APP_SUSPEND_RESUME_PAYLOAD_ENCRYPTION 0x55\r
843\r
844//\r
845// Constants and Structure definitions for "Suspend-Resume Payload Encryption" command to follow here\r
846//\r
847\r
848//\r
849// Below is Definitions for IPMI Messaging Support Commands (Chapter 22, Section 25 and 9)\r
850//\r
851\r
852//\r
853// Definitions for Set Channel Security Keys command\r
854//\r
855#define IPMI_APP_SET_CHANNEL_SECURITY_KEYS 0x56\r
856\r
857//\r
858// Constants and Structure definitions for "Set Channel Security Keys" command to follow here\r
859//\r
860\r
861//\r
862// Definitions for Get System Interface Capabilities command\r
863//\r
864#define IPMI_APP_GET_SYSTEM_INTERFACE_CAPABILITIES 0x57\r
865\r
866//\r
867// Constants and Structure definitions for "Get System Interface Capabilities" command to follow here\r
868//\r
869\r
25517f7c
HW
870//\r
871// Definitions for Get System Interface Capabilities command SSIF transaction support\r
872//\r
873#define IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_SSIF_TRANSACTION_SUPPORT_SINGLE_PARTITION_RW 0x0\r
874#define IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_SSIF_TRANSACTION_SUPPORT_MULTI_PARTITION_RW 0x1\r
875#define IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_SSIF_TRANSACTION_SUPPORT_MULTI_PARTITION_RW_WITH_MIDDLE 0x2\r
876\r
e59a797f
DB
877#pragma pack()\r
878#endif\r