]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/IpmiNetFnStorage.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
MdePkg: Fix ACPI NFIT GUID definitions
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / IpmiNetFnStorage.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 Storage commands, including:\r
5 FRU Inventory Commands (Chapter 34)\r
6 SDR Repository (Chapter 33)\r
7 System Event Log(SEL) Commands (Chapter 31)\r
aeff1d6e 8 SEL Record Formats (Chapter 32)\r
e59a797f
DB		 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 _IPMI_NET_FN_STORAGE_H_\r
24#define _IPMI_NET_FN_STORAGE_H_\r
25\r
26#pragma pack(1)\r
27//\r
28// Net function definition for Storage command\r
29//\r
30#define IPMI_NETFN_STORAGE 0x0A\r
31\r
32//\r
33// All Storage commands and their structure definitions to follow here\r
34//\r
35\r
36//\r
37// Below is Definitions for FRU Inventory Commands (Chapter 34)\r
38//\r
39\r
40//\r
41// Definitions for Get Fru Inventory Area Info command\r
42//\r
43#define IPMI_STORAGE_GET_FRU_INVENTORY_AREAINFO 0x10\r
44\r
45//\r
46// Constants and Structure definitions for "Get Fru Inventory Area Info" command to follow here\r
47//\r
48\r
49//\r
50// Definitions for Get Fru Data command\r
51//\r
52#define IPMI_STORAGE_READ_FRU_DATA 0x11\r
53\r
54//\r
55// Constants and Structure definitions for "Get Fru Data" command to follow here\r
56//\r
57typedef struct {\r
58 UINT8 FruDeviceId;\r
59 UINT16 FruOffset;\r
60} IPMI_FRU_COMMON_DATA;\r
61\r
62typedef struct {\r
63 IPMI_FRU_COMMON_DATA Data;\r
64 UINT8 Count;\r
65} IPMI_FRU_READ_COMMAND;\r
66\r
67//\r
68// Definitions for Write Fru Data command\r
69//\r
70#define IPMI_STORAGE_WRITE_FRU_DATA 0x12\r
71\r
72//\r
73// Constants and Structure definitions for "Write Fru Data" command to follow here\r
74//\r
75typedef struct {\r
76 IPMI_FRU_COMMON_DATA Data;\r
77 UINT8 FruData[16];\r
78} IPMI_FRU_WRITE_COMMAND;\r
79\r
80//\r
81// Below is Definitions for SDR Repository (Chapter 33)\r
82//\r
83\r
84//\r
85// Definitions for Get SDR Repository Info command\r
86//\r
87#define IPMI_STORAGE_GET_SDR_REPOSITORY_INFO 0x20\r
88\r
89//\r
90// Constants and Structure definitions for "Get SDR Repository Info" command to follow here\r
91//\r
92typedef struct {\r
aeff1d6e 93 UINT8 CompletionCode;\r
e59a797f
DB		 94 UINT8 Version;\r
95 UINT16 RecordCount;\r
96 UINT16 FreeSpace;\r
97 UINT32 RecentAdditionTimeStamp;\r
98 UINT32 RecentEraseTimeStamp;\r
99 UINT8 SdrRepAllocInfoCmd : 1;\r
100 UINT8 SdrRepReserveCmd : 1;\r
101 UINT8 PartialAddSdrCmd : 1;\r
102 UINT8 DeleteSdrRepCmd : 1;\r
103 UINT8 Reserved : 1;\r
104 UINT8 SdrRepUpdateOp : 2;\r
105 UINT8 Overflow : 1;\r
aeff1d6e 106} IPMI_GET_SDR_REPOSITORY_INFO;\r
e59a797f
DB		 107\r
108//\r
109// Definitions for Get SDR Repository Allocateion Info command\r
110//\r
111#define IPMI_STORAGE_GET_SDR_REPOSITORY_ALLOCATION_INFO 0x21\r
112\r
113//\r
114// Constants and Structure definitions for "Get SDR Repository Allocateion Info" command to follow here\r
115//\r
116\r
117//\r
118// Definitions for Reserve SDR Repository command\r
119//\r
120#define IPMI_STORAGE_RESERVE_SDR_REPOSITORY 0x22\r
121\r
122//\r
123// Constants and Structure definitions for "Reserve SDR Repository" command to follow here\r
124//\r
125\r
126//\r
127// Definitions for Get SDR command\r
128//\r
129#define IPMI_STORAGE_GET_SDR 0x23\r
130\r
131//\r
132// Constants and Structure definitions for "Get SDR" command to follow here\r
133//\r
134\r
135typedef struct {\r
136 UINT16 RecordId; // 1\r
137 UINT8 Version; // 3\r
138 UINT8 RecordType; // 4\r
139 UINT8 RecordLength; // 5\r
140 UINT8 OwnerId; // 6\r
141 UINT8 OwnerLun; // 7\r
142 UINT8 SensorNumber; // 8\r
143 UINT8 EntityId; // 9\r
144 UINT8 EntityInstance; // 10\r
145 UINT8 EventScanningEnabled : 1; // 11\r
146 UINT8 EventScanningDisabled : 1; // 11\r
147 UINT8 InitSensorType : 1; // 11\r
148 UINT8 InitHysteresis : 1; // 11\r
149 UINT8 InitThresholds : 1; // 11\r
150 UINT8 InitEvent : 1; // 11\r
151 UINT8 InitScanning : 1; // 11\r
152 UINT8 Reserved : 1; // 11\r
153 UINT8 EventMessageControl : 2; // 12\r
154 UINT8 ThresholdAccessSupport : 2; // 12\r
155 UINT8 HysteresisSupport : 2; // 12\r
156 UINT8 ReArmSupport : 1; // 12\r
157 UINT8 IgnoreSensor : 1; // 12\r
158 UINT8 SensorType; // 13\r
159 UINT8 EventType; // 14\r
160 UINT8 Reserved1[7]; // 15\r
161 UINT8 UnitType; // 22\r
162 UINT8 Reserved2; // 23\r
163 UINT8 Linearization : 7; // 24\r
164 UINT8 Reserved3 : 1; // 24\r
165 UINT8 MLo; // 25\r
166 UINT8 Toleremce : 6; // 26\r
167 UINT8 MHi : 2; // 26\r
168 UINT8 BLo; // 27\r
169 UINT8 AccuracyLow : 6; // 28\r
170 UINT8 BHi : 2; // 28\r
171 UINT8 Reserved4 : 2; // 29\r
172 UINT8 AccuracyExp : 2; // 29\r
173 UINT8 AccuracyHi : 4; // 29\r
174 UINT8 BExp : 4; // 30\r
175 UINT8 RExp : 4; // 30\r
176 UINT8 NominalReadingSpscified : 1; // 31\r
177 UINT8 NominalMaxSpscified : 1; // 31\r
178 UINT8 NominalMinSpscified : 1; // 31\r
179 UINT8 Reserved5 : 5; // 31\r
180 UINT8 NominalReading; // 32\r
181 UINT8 Reserved6[4]; // 33\r
182 UINT8 UpperNonRecoverThreshold; // 37\r
183 UINT8 UpperCriticalThreshold; // 38\r
184 UINT8 UpperNonCriticalThreshold; // 39\r
185 UINT8 LowerNonRecoverThreshold; // 40\r
186 UINT8 LowerCriticalThreshold; // 41\r
187 UINT8 LowerNonCriticalThreshold; // 42\r
188 UINT8 Reserved7[5]; // 43\r
189 UINT8 IdStringLength; // 48\r
190 UINT8 AsciiIdString[16]; // 49 - 64\r
191} IPMI_SDR_RECORD_STRUCT_1;\r
192\r
193typedef struct {\r
194 UINT16 RecordId; // 1\r
195 UINT8 Version; // 3\r
196 UINT8 RecordType; // 4\r
197 UINT8 RecordLength; // 5\r
198 UINT8 OwnerId; // 6\r
199 UINT8 OwnerLun; // 7\r
200 UINT8 SensorNumber; // 8\r
201 UINT8 EntityId; // 9\r
202 UINT8 EntityInstance; // 10\r
203 UINT8 SensorScanning : 1; // 11\r
204 UINT8 EventScanning : 1; // 11\r
205 UINT8 InitSensorType : 1; // 11\r
206 UINT8 InitHysteresis : 1; // 11\r
207 UINT8 InitThresholds : 1; // 11\r
208 UINT8 InitEvent : 1; // 11\r
209 UINT8 InitScanning : 1; // 11\r
210 UINT8 Reserved : 1; // 11\r
211 UINT8 EventMessageControl : 2; // 12\r
212 UINT8 ThresholdAccessSupport : 2; // 12\r
213 UINT8 HysteresisSupport : 2; // 12\r
214 UINT8 ReArmSupport : 1; // 12\r
215 UINT8 IgnoreSensor : 1; // 12\r
216 UINT8 SensorType; // 13\r
217 UINT8 EventType; // 14\r
218 UINT8 Reserved1[7]; // 15\r
219 UINT8 UnitType; // 22\r
220 UINT8 Reserved2[9]; // 23\r
221 UINT8 IdStringLength; // 32\r
222 UINT8 AsciiIdString[16]; // 33 - 48\r
223} IPMI_SDR_RECORD_STRUCT_2;\r
224\r
225typedef struct {\r
226 UINT8 Reserved1 : 1;\r
227 UINT8 ControllerSlaveAddress : 7;\r
228 UINT8 FruDeviceId;\r
229 UINT8 BusId : 3;\r
230 UINT8 Lun : 2;\r
231 UINT8 Reserved : 2;\r
232 UINT8 LogicalFruDevice : 1;\r
233 UINT8 Reserved3 : 4;\r
234 UINT8 ChannelNumber : 4;\r
235} IPMI_FRU_DATA_INFO;\r
236\r
237typedef struct {\r
238 UINT16 RecordId; // 1\r
239 UINT8 Version; // 3\r
240 UINT8 RecordType; // 4\r
241 UINT8 RecordLength; // 5\r
242 IPMI_FRU_DATA_INFO FruDeviceData; // 6\r
243 UINT8 Reserved1; // 10\r
244 UINT8 DeviceType; // 11\r
245 UINT8 DeviceTypeModifier; // 12\r
246 UINT8 FruEntityId; // 13\r
247 UINT8 FruEntityInstance; // 14\r
248 UINT8 OemReserved; // 15\r
249 UINT8 Length : 4; // 16\r
250 UINT8 Reserved2 : 1; // 16\r
251 UINT8 StringType : 3; // 16\r
252 UINT8 String[16]; // 17\r
253} IPMI_SDR_RECORD_STRUCT_11;\r
254\r
255typedef struct {\r
256 UINT16 NextRecordId; //1\r
257 UINT16 RecordId; //3\r
258 UINT8 Version; //5\r
259 UINT8 RecordType; //6\r
260 UINT8 RecordLength; //7\r
261 UINT8 ManufacturerId[3]; //8\r
262 UINT8 StringChars[20];\r
263} IPMI_SDR_RECORD_STRUCT_C0;\r
264\r
265typedef struct {\r
266 UINT16 NextRecordId; //1\r
267 UINT16 RecordId; //3\r
268 UINT8 Version; //5\r
269 UINT8 RecordType; //6\r
270 UINT8 RecordLength; //7\r
271} IPMI_SDR_RECORD_STRUCT_HEADER;\r
272\r
273typedef union {\r
274 IPMI_SDR_RECORD_STRUCT_1 SensorType1;\r
275 IPMI_SDR_RECORD_STRUCT_2 SensorType2;\r
276 IPMI_SDR_RECORD_STRUCT_11 SensorType11;\r
277 IPMI_SDR_RECORD_STRUCT_C0 SensorTypeC0;\r
278 IPMI_SDR_RECORD_STRUCT_HEADER SensorHeader;\r
279} IPMI_SENSOR_RECORD_STRUCT;\r
280\r
281typedef struct {\r
282 UINT16 ReservationId;\r
283 UINT16 RecordId;\r
284 UINT8 RecordOffset;\r
285 UINT8 BytesToRead;\r
aeff1d6e 286} IPMI_GET_SDR_REQUEST;\r
e59a797f
DB		 287\r
288//\r
289// Definitions for Add SDR command\r
290//\r
291#define IPMI_STORAGE_ADD_SDR 0x24\r
292\r
293//\r
294// Constants and Structure definitions for "Add SDR" command to follow here\r
295//\r
296\r
297//\r
298// Definitions for Partial Add SDR command\r
299//\r
300#define IPMI_STORAGE_PARTIAL_ADD_SDR 0x25\r
301\r
302//\r
303// Constants and Structure definitions for "Partial Add SDR" command to follow here\r
304//\r
305\r
306//\r
307// Definitions for Delete SDR command\r
308//\r
309#define IPMI_STORAGE_DELETE_SDR 0x26\r
310\r
311//\r
312// Constants and Structure definitions for "Delete SDR" command to follow here\r
313//\r
314\r
315//\r
316// Definitions for Clear SDR Repository command\r
317//\r
318#define IPMI_STORAGE_CLEAR_SDR 0x27\r
319\r
320//\r
321// Constants and Structure definitions for "Clear SDR Repository" command to follow here\r
322//\r
323\r
324//\r
325// Definitions for Get SDR Repository Time command\r
326//\r
327#define IPMI_STORAGE_GET_SDR_REPOSITORY_TIME 0x28\r
328\r
329//\r
330// Constants and Structure definitions for "Get SDR Repository Time" command to follow here\r
331//\r
332\r
333//\r
334// Definitions for Set SDR Repository Time command\r
335//\r
336#define IPMI_STORAGE_SET_SDR_REPOSITORY_TIME 0x29\r
337\r
338//\r
339// Constants and Structure definitions for "Set SDR Repository Time" command to follow here\r
340//\r
341\r
342//\r
343// Definitions for Enter SDR Repository Update Mode command\r
344//\r
345#define IPMI_STORAGE_ENTER_SDR_UPDATE_MODE 0x2A\r
346\r
347//\r
348// Constants and Structure definitions for "Enter SDR Repository Update Mode" command to follow here\r
349//\r
350\r
351//\r
352// Definitions for Exit SDR Repository Update Mode command\r
353//\r
354#define IPMI_STORAGE_EXIT_SDR_UPDATE_MODE 0x2B\r
355\r
356//\r
357// Constants and Structure definitions for "Exit SDR Repository Update Mode" command to follow here\r
358//\r
359\r
360//\r
361// Definitions for Run Initialize Agent command\r
362//\r
363#define IPMI_STORAGE_RUN_INIT_AGENT 0x2C\r
364\r
365//\r
366// Constants and Structure definitions for "Run Initialize Agent" command to follow here\r
367//\r
368\r
369//\r
370// Below is Definitions for System Event Log(SEL) Commands (Chapter 31)\r
371//\r
372\r
373//\r
374// Definitions for Get SEL Info command\r
375//\r
376#define IPMI_STORAGE_GET_SEL_INFO 0x40\r
377\r
378//\r
379// Constants and Structure definitions for "Get SEL Info" command to follow here\r
380//\r
381typedef struct {\r
aeff1d6e 382 UINT8 CompletionCode;\r
e59a797f
DB		 383 UINT8 Version; // Version of SEL\r
384 UINT16 NoOfEntries; // No of Entries in the SEL\r
385 UINT16 FreeSpace; // Free space in Bytes\r
386 UINT32 RecentAddTimeStamp; // Most Recent Addition of Time Stamp\r
387 UINT32 RecentEraseTimeStamp; // Most Recent Erasure of Time Stamp\r
388 UINT8 OperationSupport; // Operation Support\r
aeff1d6e 389} IPMI_GET_SEL_INFO_RESPONSE;\r
e59a797f
DB		 390\r
391//\r
392// Definitions for Get SEL Allocation Info command\r
393//\r
394#define IPMI_STORAGE_GET_SEL_ALLOCATION_INFO 0x41\r
395\r
396//\r
397// Constants and Structure definitions for "Get SEL Allocation Info" command to follow here\r
398//\r
399\r
400//\r
401// Definitions for Reserve SEL command\r
402//\r
403#define IPMI_STORAGE_RESERVE_SEL 0x42\r
404\r
405//\r
406// Constants and Structure definitions for "Reserve SEL" command to follow here\r
407//\r
408\r
409//\r
410// Definitions for Get SEL Entry command\r
411//\r
412#define IPMI_STORAGE_GET_SEL_ENTRY 0x43\r
413\r
414//\r
415// Constants and Structure definitions for "Get SEL Entry" command to follow here\r
416//\r
e59a797f
DB		 417typedef struct {\r
418 UINT8 ReserveId[2]; // Reservation ID, LS Byte First\r
419 UINT8 SelRecID[2]; // Sel Record ID, LS Byte First\r
420 UINT8 Offset; // Offset Into Record\r
421 UINT8 BytesToRead; // Bytes to be Read, 0xFF for entire record\r
aeff1d6e 422} IPMI_GET_SEL_ENTRY_REQUEST;\r
e59a797f
DB		 423\r
424//\r
425// Definitions for Add SEL Entry command\r
426//\r
427#define IPMI_STORAGE_ADD_SEL_ENTRY 0x44\r
428\r
429//\r
430// Constants and Structure definitions for "Add SEL Entry" command to follow here\r
431//\r
e59a797f
DB		 432\r
433//\r
434// Definitions for Partial Add SEL Entry command\r
435//\r
436#define IPMI_STORAGE_PARTIAL_ADD_SEL_ENTRY 0x45\r
437\r
438//\r
439// Constants and Structure definitions for "Partial Add SEL Entry" command to follow here\r
440//\r
441\r
442//\r
443// Definitions for Delete SEL Entry command\r
444//\r
445#define IPMI_STORAGE_DELETE_SEL_ENTRY 0x46\r
446\r
447//\r
448// Constants and Structure definitions for "Delete SEL Entry" command to follow here\r
449//\r
450typedef struct {\r
451 UINT8 ReserveId[2]; // Reservation ID, LS byte first\r
452 UINT8 RecordToDelete[2]; // Record to Delete, LS Byte First\r
aeff1d6e 453} IPMI_DELETE_SEL_REQUEST;\r
e59a797f
DB		 454\r
455//\r
456// Definitions for Clear SEL command\r
457//\r
458#define IPMI_STORAGE_CLEAR_SEL 0x47\r
459\r
460//\r
461// Constants and Structure definitions for "Clear SEL" command to follow here\r
462//\r
463typedef struct {\r
464 UINT8 Reserve[2]; // Reserve ID, LSB first\r
465 UINT8 AscC; // Ascii for 'C' (0x43)\r
466 UINT8 AscL; // Ascii for 'L' (0x4c)\r
467 UINT8 AscR; // Ascii for 'R' (0x52)\r
468 UINT8 Erase; // 0xAA, Initiate Erase, 0x00 Get Erase Status\r
aeff1d6e 469} IPMI_CLEAR_SEL_REQUEST;\r
e59a797f
DB		 470\r
471//\r
472// Definitions for Get SEL Time command\r
473//\r
474#define IPMI_STORAGE_GET_SEL_TIME 0x48\r
475\r
476//\r
477// Constants and Structure definitions for "Get SEL Time" command to follow here\r
478//\r
479\r
480//\r
481// Definitions for Set SEL Time command\r
482//\r
483#define IPMI_STORAGE_SET_SEL_TIME 0x49\r
484\r
485//\r
486// Constants and Structure definitions for "Set SEL Time" command to follow here\r
487//\r
488\r
489//\r
490// Definitions for Get Auxillary Log Status command\r
491//\r
492#define IPMI_STORAGE_GET_AUXILLARY_LOG_STATUS 0x5A\r
493\r
494//\r
495// Constants and Structure definitions for "Get Auxillary Log Status" command to follow here\r
496//\r
497\r
498//\r
499// Definitions for Set Auxillary Log Status command\r
500//\r
501#define IPMI_STORAGE_SET_AUXILLARY_LOG_STATUS 0x5B\r
502\r
503//\r
504// Constants and Structure definitions for "Set Auxillary Log Status" command to follow here\r
505//\r
aeff1d6e
DB		 506\r
507#define IPMI_COMPLETE_SEL_RECORD 0xFF\r
508\r
509//\r
510// Below is Definitions for SEL Record Formats (Chapter 32)\r
511//\r
512typedef struct {\r
513 UINT16 RecordId;\r
514 UINT8 RecordType;\r
515 UINT32 TimeStamp;\r
516 UINT16 GeneratorId;\r
517 UINT8 EvMRevision;\r
518 UINT8 SensorType;\r
519 UINT8 SensorNumber;\r
520 UINT8 EventDirType;\r
521 UINT8 OEMEvData1;\r
522 UINT8 OEMEvData2;\r
523 UINT8 OEMEvData3;\r
524} IPMI_SEL_EVENT_RECORD_DATA;\r
525\r
526#define IPMI_SEL_SYSTEM_RECORD 0x02\r
527\r
528#define IPMI_EVM_REVISION 0x04\r
529#define IPMI_BIOS_ID 0x18\r
530#define IPMI_FORMAT_REV 0x00\r
531#define IPMI_FORMAT_REV1 0x01\r
532#define IPMI_SOFTWARE_ID 0x01\r
533#define IPMI_PLATFORM_VAL_ID 0x01\r
534#define IPMI_GENERATOR_ID(i,f) ((i << 1) | (f << 1) | IPMI_SOFTWARE_ID)\r
535\r
536#define IPMI_SENSOR_TYPE_EVENT_CODE_DISCRETE 0x6F\r
537\r
538#define IPMI_OEM_SPECIFIC_DATA 0x02\r
539#define IPMI_SENSOR_SPECIFIC_DATA 0x03\r
540\r
e59a797f
DB		 541#pragma pack()\r
542#endif\r
EFI Development Kit II mirror for PVE