]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/IpmiNetFnApp.h
MdePkg ACPI: Correct processor struct of PPTT
[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
14 Copyright (c) 1999 - 2015, Intel Corporation. All rights reserved.<BR>\r
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
131typedef struct {\r
aeff1d6e
DB
132 UINT8 AcpiSystemPowerState : 7;\r
133 UINT8 AcpiSystemStateChange : 1;\r
134 UINT8 AcpiDevicePowerState : 7;\r
135 UINT8 AcpiDeviceStateChange : 1;\r
136} IPMI_SET_ACPI_POWER_STATE_REQUEST;\r
e59a797f
DB
137\r
138//\r
139// Definitions for Get ACPI Power State command\r
140//\r
141#define IPMI_APP_GET_ACPI_POWERSTATE 0x7\r
142\r
143//\r
144// Constants and Structure definitions for "Get ACPI Power State" command to follow here\r
145//\r
146\r
147//\r
148// Definitions for Get Device GUID command\r
149//\r
150#define IPMI_APP_GET_DEVICE_GUID 0x8\r
151\r
152//\r
153// Constants and Structure definitions for "Get Device GUID" command to follow here\r
154//\r
155//\r
156// Message structure definition for "Get Device Guid" IPMI command\r
157//\r
158typedef struct {\r
aeff1d6e
DB
159 UINT8 CompletionCode;\r
160 UINT8 Guid[16];\r
161} IPMI_GET_DEVICE_GUID_RESPONSE;\r
e59a797f
DB
162\r
163//\r
164// Below is Definitions for BMC Watchdog Timer Commands (Chapter 27)\r
165//\r
166\r
167//\r
168// Definitions for Reset WatchDog Timer command\r
169//\r
170#define IPMI_APP_RESET_WATCHDOG_TIMER 0x22\r
171\r
172//\r
173// Constants and Structure definitions for "Reset WatchDog Timer" command to follow here\r
174//\r
175typedef struct {\r
176 UINT8 TimerUse : 3;\r
177 UINT8 Reserved : 3;\r
178 UINT8 TimerRunning : 1;\r
179 UINT8 TimerUseExpirationFlagLog : 1;\r
180} IPMI_WATCHDOG_TIMER_USE;\r
181\r
182//\r
183// Definitions for Set WatchDog Timer command\r
184//\r
185#define IPMI_APP_SET_WATCHDOG_TIMER 0x24\r
186\r
187//\r
188// Constants and Structure definitions for "Set WatchDog Timer" command to follow here\r
189//\r
190typedef struct {\r
191 IPMI_WATCHDOG_TIMER_USE TimerUse;\r
192 UINT8 TimerActions;\r
193 UINT8 PretimeoutInterval;\r
194 UINT8 TimerUseExpirationFlagsClear;\r
195 UINT16 InitialCountdownValue;\r
aeff1d6e 196} IPMI_SET_WATCHDOG_TIMER_REQUEST;\r
e59a797f
DB
197\r
198//\r
199// Definitions for Get WatchDog Timer command\r
200//\r
201#define IPMI_APP_GET_WATCHDOG_TIMER 0x25\r
202\r
203//\r
204// Constants and Structure definitions for "Get WatchDog Timer" command to follow here\r
205//\r
206typedef struct {\r
aeff1d6e 207 UINT8 CompletionCode;\r
e59a797f
DB
208 IPMI_WATCHDOG_TIMER_USE TimerUse;\r
209 UINT8 TimerActions;\r
210 UINT8 PretimeoutInterval;\r
211 UINT8 TimerUseExpirationFlagsClear;\r
212 UINT16 InitialCountdownValue;\r
213 UINT16 PresentCountdownValue;\r
aeff1d6e 214} IPMI_GET_WATCHDOG_TIMER_RESPONSE;\r
e59a797f
DB
215\r
216//\r
217// Below is Definitions for IPMI Messaging Support Commands (Chapter 22)\r
218//\r
219\r
220//\r
221// Definitions for Set BMC Global Enables command\r
222//\r
223#define IPMI_APP_SET_BMC_GLOBAL_ENABLES 0x2E\r
224\r
225//\r
226// Constants and Structure definitions for "Set BMC Global Enables " command to follow here\r
227//\r
228\r
229//\r
230// Definitions for Get BMC Global Enables command\r
231//\r
232#define IPMI_APP_GET_BMC_GLOBAL_ENABLES 0x2F\r
233\r
234//\r
235// Constants and Structure definitions for "Get BMC Global Enables " command to follow here\r
236//\r
237\r
238//\r
239// Definitions for Clear Message Flags command\r
240//\r
241#define IPMI_APP_CLEAR_MESSAGE_FLAGS 0x30\r
242\r
243//\r
244// Constants and Structure definitions for "Clear Message Flags" command to follow here\r
245//\r
246\r
247//\r
248// Definitions for Get Message Flags command\r
249//\r
250#define IPMI_APP_GET_MESSAGE_FLAGS 0x31\r
251\r
252//\r
253// Constants and Structure definitions for "Get Message Flags" command to follow here\r
254//\r
255\r
256//\r
257// Definitions for Enable Message Channel Receive command\r
258//\r
259#define IPMI_APP_ENABLE_MESSAGE_CHANNEL_RECEIVE 0x32\r
260\r
261//\r
262// Constants and Structure definitions for "Enable Message Channel Receive" command to follow here\r
263//\r
264\r
265//\r
266// Definitions for Get Message command\r
267//\r
268#define IPMI_APP_GET_MESSAGE 0x33\r
269\r
270//\r
271// Constants and Structure definitions for "Get Message" command to follow here\r
272//\r
273\r
274//\r
275// Definitions for Send Message command\r
276//\r
277#define IPMI_APP_SEND_MESSAGE 0x34\r
278\r
279//\r
280// Constants and Structure definitions for "Send Message" command to follow here\r
281//\r
282\r
283//\r
284// Definitions for Read Event Message Buffer command\r
285//\r
286#define IPMI_APP_READ_EVENT_MSG_BUFFER 0x35\r
287\r
288//\r
289// Constants and Structure definitions for "Read Event Message Buffer" command to follow here\r
290//\r
291\r
292//\r
293// Definitions for Get BT Interface Capabilities command\r
294//\r
295#define IPMI_APP_GET_BT_INTERFACE_CAPABILITY 0x36\r
296\r
297//\r
298// Constants and Structure definitions for "Get BT Interface Capabilities" command to follow here\r
299//\r
300\r
301//\r
302// Definitions for Get System GUID command\r
303//\r
304#define IPMI_APP_GET_SYSTEM_GUID 0x37\r
305\r
306//\r
307// Constants and Structure definitions for "Get System GUID" command to follow here\r
308//\r
309\r
310//\r
311// Definitions for Get Channel Authentication Capabilities command\r
312//\r
313#define IPMI_APP_GET_CHANNEL_AUTHENTICATION_CAPABILITIES 0x38\r
314\r
315//\r
316// Constants and Structure definitions for "Get Channel Authentication Capabilities" command to follow here\r
317//\r
318\r
319//\r
320// Definitions for Get Session Challenge command\r
321//\r
322#define IPMI_APP_GET_SESSION_CHALLENGE 0x39\r
323\r
324//\r
325// Constants and Structure definitions for "Get Session Challenge" command to follow here\r
326//\r
327\r
328//\r
329// Definitions for Activate Session command\r
330//\r
331#define IPMI_APP_ACTIVATE_SESSION 0x3A\r
332\r
333//\r
334// Constants and Structure definitions for "Activate Session" command to follow here\r
335//\r
336\r
337//\r
338// Definitions for Set Session Privelege Level command\r
339//\r
340#define IPMI_APP_SET_SESSION_PRIVELEGE_LEVEL 0x3B\r
341\r
342//\r
343// Constants and Structure definitions for "Set Session Privelege Level" command to follow here\r
344//\r
345\r
346//\r
347// Definitions for Close Session command\r
348//\r
349#define IPMI_APP_CLOSE_SESSION 0x3C\r
350\r
351//\r
352// Constants and Structure definitions for "Close Session" command to follow here\r
353//\r
354\r
355//\r
356// Definitions for Get Session Info command\r
357//\r
358#define IPMI_APP_GET_SESSION_INFO 0x3D\r
359\r
360//\r
361// Constants and Structure definitions for "Get Session Info" command to follow here\r
362//\r
363\r
364//\r
365// Definitions for Get Auth Code command\r
366//\r
367#define IPMI_APP_GET_AUTHCODE 0x3F\r
368\r
369//\r
370// Constants and Structure definitions for "Get AuthCode" command to follow here\r
371//\r
372\r
373//\r
374// Definitions for Set Channel Access command\r
375//\r
376#define IPMI_APP_SET_CHANNEL_ACCESS 0x40\r
377\r
378//\r
379// Constants and Structure definitions for "Set Channel Access" command to follow here\r
380//\r
381\r
382//\r
383// Definitions for Get Channel Access command\r
384//\r
385#define IPMI_APP_GET_CHANNEL_ACCESS 0x41\r
386\r
387//\r
388// Constants and Structure definitions for "Get Channel Access" command to follow here\r
389//\r
390typedef struct {\r
aeff1d6e
DB
391 UINT8 ChannelNo : 4;\r
392 UINT8 Reserve1 : 4;\r
393 UINT8 Reserve2 : 6;\r
394 UINT8 MemoryType : 2;\r
395} IPMI_GET_CHANNEL_ACCESS_REQUEST;\r
e59a797f
DB
396\r
397typedef struct {\r
aeff1d6e
DB
398 UINT8 CompletionCode;\r
399 UINT8 AccessMode : 3;\r
400 UINT8 UserLevelAuthEnabled : 1;\r
401 UINT8 MessageAuthEnable : 1;\r
402 UINT8 Alert : 1;\r
403 UINT8 Reserve1 : 2;\r
404 UINT8 ChannelPriviledgeLimit : 4;\r
405 UINT8 Reserve2 : 4;\r
e59a797f
DB
406} IPMI_GET_CHANNEL_ACCESS_RESPONSE;\r
407\r
408//\r
409// Definitions for Get Channel Info command\r
410//\r
411#define IPMI_APP_GET_CHANNEL_INFO 0x42\r
412\r
413//\r
414// Constants and Structure definitions for "Get Channel Info" command to follow here\r
415//\r
416typedef struct {\r
aeff1d6e 417 UINT8 CompletionCode;\r
e59a797f
DB
418 UINT8 ChannelNo : 4;\r
419 UINT8 Reserve1 : 4;\r
420 UINT8 ChannelMediumType : 7;\r
421 UINT8 Reserve2 : 1;\r
422 UINT8 ChannelProtocolType : 5;\r
423 UINT8 Reserve3 : 3;\r
424 UINT8 ActiveSessionCount : 6;\r
425 UINT8 SessionSupport : 2;\r
aeff1d6e
DB
426 UINT8 VendorId[3];\r
427 UINT16 AuxChannelInfo;\r
428} IPMI_GET_CHANNEL_INFO_RESPONSE;\r
e59a797f
DB
429\r
430//\r
431// Definitions for Get Channel Info command\r
432//\r
433#define IPMI_APP_GET_CHANNEL_INFO 0x42\r
434\r
435//\r
436// Constants and Structure definitions for "Get Channel Info" command to follow here\r
437//\r
438\r
439//\r
440// Definitions for Set User Access command\r
441//\r
442#define IPMI_APP_SET_USER_ACCESS 0x43\r
443\r
444//\r
445// Constants and Structure definitions for "Set User Access" command to follow here\r
446//\r
447\r
448//\r
449// Definitions for Get User Access command\r
450//\r
451#define IPMI_APP_GET_USER_ACCESS 0x44\r
452\r
453//\r
454// Constants and Structure definitions for "Get User Access" command to follow here\r
455//\r
456\r
457//\r
458// Definitions for Set User Name command\r
459//\r
460#define IPMI_APP_SET_USER_NAME 0x45\r
461\r
462//\r
463// Constants and Structure definitions for "Set User Name" command to follow here\r
464//\r
465\r
466//\r
467// Definitions for Get User Name command\r
468//\r
469#define IPMI_APP_GET_USER_NAME 0x46\r
470\r
471//\r
472// Constants and Structure definitions for "Get User Name" command to follow here\r
473//\r
474\r
475//\r
476// Definitions for Set User Password command\r
477//\r
478#define IPMI_APP_SET_USER_PASSWORD 0x47\r
479\r
480//\r
481// Constants and Structure definitions for "Set User Password" command to follow here\r
482//\r
483\r
484//\r
485// Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24)\r
486//\r
487\r
488//\r
489// Definitions for Activate Payload command\r
490//\r
491#define IPMI_APP_ACTIVATE_PAYLOAD 0x48\r
492\r
493//\r
494// Constants and Structure definitions for "Activate Payload" command to follow here\r
495//\r
496\r
497//\r
498// Definitions for De-Activate Payload command\r
499//\r
500#define IPMI_APP_DEACTIVATE_PAYLOAD 0x49\r
501\r
502//\r
503// Constants and Structure definitions for "DeActivate Payload" command to follow here\r
504//\r
505\r
506//\r
507// Definitions for Get Payload activation Status command\r
508//\r
509#define IPMI_APP_GET_PAYLOAD_ACTIVATION_STATUS 0x4a\r
510\r
511//\r
512// Constants and Structure definitions for "Get Payload activation Status" command to follow here\r
513//\r
514\r
515//\r
516// Definitions for Get Payload Instance Info command\r
517//\r
518#define IPMI_APP_GET_PAYLOAD_INSTANCE_INFO 0x4b\r
519\r
520//\r
521// Constants and Structure definitions for "Get Payload Instance Info" command to follow here\r
522//\r
523\r
524//\r
525// Definitions for Set User Payload Access command\r
526//\r
527#define IPMI_APP_SET_USER_PAYLOAD_ACCESS 0x4C\r
528\r
529//\r
530// Constants and Structure definitions for "Set User Payload Access" command to follow here\r
531//\r
532\r
533//\r
534// Definitions for Get User Payload Access command\r
535//\r
536#define IPMI_APP_GET_USER_PAYLOAD_ACCESS 0x4D\r
537\r
538//\r
539// Constants and Structure definitions for "Get User Payload Access" command to follow here\r
540//\r
541\r
542//\r
543// Definitions for Get Channel Payload Support command\r
544//\r
545#define IPMI_APP_GET_CHANNEL_PAYLOAD_SUPPORT 0x4E\r
546\r
547//\r
548// Constants and Structure definitions for "Get Channel Payload Support" command to follow here\r
549//\r
550\r
551//\r
552// Definitions for Get Channel Payload Version command\r
553//\r
554#define IPMI_APP_GET_CHANNEL_PAYLOAD_VERSION 0x4F\r
555\r
556//\r
557// Constants and Structure definitions for "Get Channel Payload Version" command to follow here\r
558//\r
559\r
560//\r
561// Definitions for Get Channel OEM Payload Info command\r
562//\r
563#define IPMI_APP_GET_CHANNEL_OEM_PAYLOAD_INFO 0x50\r
564\r
565//\r
566// Constants and Structure definitions for "Get Channel OEM Payload Info" command to follow here\r
567//\r
568\r
569//\r
570// Definitions for Master Write-Read command\r
571//\r
572#define IPMI_APP_MASTER_WRITE_READ 0x52\r
573\r
574//\r
575// Constants and Structure definitions for "Master Write Read" command to follow here\r
576//\r
577\r
578//\r
579// Definitions for Get Channel Cipher Suites command\r
580//\r
581#define IPMI_APP_GET_CHANNEL_CIPHER_SUITES 0x54\r
582\r
583//\r
584// Constants and Structure definitions for "Get Channel Cipher Suites" command to follow here\r
585//\r
586\r
587//\r
588// Below is Definitions for RMCP+ Support and Payload Commands (Chapter 24, Section 3)\r
589//\r
590\r
591//\r
592// Definitions for Suspend-Resume Payload Encryption command\r
593//\r
594#define IPMI_APP_SUSPEND_RESUME_PAYLOAD_ENCRYPTION 0x55\r
595\r
596//\r
597// Constants and Structure definitions for "Suspend-Resume Payload Encryption" command to follow here\r
598//\r
599\r
600//\r
601// Below is Definitions for IPMI Messaging Support Commands (Chapter 22, Section 25 and 9)\r
602//\r
603\r
604//\r
605// Definitions for Set Channel Security Keys command\r
606//\r
607#define IPMI_APP_SET_CHANNEL_SECURITY_KEYS 0x56\r
608\r
609//\r
610// Constants and Structure definitions for "Set Channel Security Keys" command to follow here\r
611//\r
612\r
613//\r
614// Definitions for Get System Interface Capabilities command\r
615//\r
616#define IPMI_APP_GET_SYSTEM_INTERFACE_CAPABILITIES 0x57\r
617\r
618//\r
619// Constants and Structure definitions for "Get System Interface Capabilities" command to follow here\r
620//\r
621\r
622#pragma pack()\r
623#endif\r