]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/EventLogInfo.h
add comments to function declarations and definitions and updated to match coding...
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / SmbiosView / EventLogInfo.h
CommitLineData
a1d4bfcc 1/** @file\r
5d73d92f 2 Module to clarify system event log of smbios structure.\r
3\r
a1d4bfcc 4 Copyright (c) 2005-2011, Intel Corporation. All rights reserved. <BR>\r
5d73d92f 5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
a1d4bfcc 15#ifndef _SMBIOS_EVENT_LOG_INFO_H_\r
16#define _SMBIOS_EVENT_LOG_INFO_H_\r
5d73d92f 17\r
18#define END_OF_LOG 0xFF\r
19\r
20#pragma pack(1)\r
21\r
22typedef struct {\r
23 UINT8 Type;\r
24 UINT8 Length;\r
25 UINT8 Year;\r
26 UINT8 Month;\r
27 UINT8 Day;\r
28 UINT8 Hour;\r
29 UINT8 Minute;\r
30 UINT8 Second;\r
31 UINT8 LogVariableData[1];\r
32} LOG_RECORD_FORMAT;\r
33\r
34typedef struct {\r
35 UINT8 OEMReserved[5];\r
a1d4bfcc 36 UINT8 Metw; // Multiple Event Time Window\r
37 UINT8 Meci; // Multiple Event Count Increment\r
5d73d92f 38 UINT8 CMOSAddress; // Pre-boot Event Log Reset - CMOS Address\r
39 UINT8 CMOSBitIndex; // Pre-boot Event Log Reset - CMOS Bit Index\r
40 UINT8 StartingOffset; // CMOS Checksum - Starting Offset\r
41 UINT8 ByteCount; // CMOS Checksum - Byte Count\r
42 UINT8 ChecksumOffset; // CMOS Checksum - Checksum Offset\r
43 UINT8 Reserved[3];\r
44 UINT8 HeaderRevision;\r
45} LOG_HEADER_TYPE1_FORMAT;\r
46\r
47#pragma pack()\r
48//\r
49// System Event Log (Type 15)\r
50//\r
51\r
52/**\r
53 Function to display system event log access information.\r
54\r
55 @param[in] Key Additional information to print.\r
56 @param[in] Option Whether to print the additional information.\r
57**/\r
58VOID\r
59EFIAPI\r
60DisplaySELAccessMethod (\r
61 IN CONST UINT8 Key,\r
62 IN CONST UINT8 Option\r
63 );\r
64\r
65/**\r
66 Function to display system event log status information.\r
67\r
68 @param[in] Key Additional information to print.\r
69 @param[in] Option Whether to print the additional information.\r
70**/\r
71VOID\r
72EFIAPI\r
73DisplaySELLogStatus (\r
74 UINT8 Key,\r
75 UINT8 Option\r
76 );\r
77\r
78/**\r
79 Function to display system event log header format information.\r
80\r
81 @param[in] Key Additional information to print.\r
82 @param[in] Option Whether to print the additional information.\r
83**/\r
84VOID\r
85EFIAPI\r
86DisplaySysEventLogHeaderFormat (\r
87 UINT8 Key,\r
88 UINT8 Option\r
89 );\r
90\r
91/**\r
92 Function to display system event log header information.\r
93\r
94 @param[in] LogHeaderFormat Format identifier.\r
95 @param[in] LogHeader Format informcation.\r
96**/\r
97VOID\r
98EFIAPI\r
99DisplaySysEventLogHeader (\r
100 UINT8 LogHeaderFormat,\r
101 UINT8 *LogHeader\r
102 );\r
103\r
104/**\r
105 Function to display system event log data.\r
106\r
107 @param[in] LogData The data information.\r
108 @param[in] LogAreaLength Length of the data.\r
109**/\r
110VOID\r
111EFIAPI\r
112DisplaySysEventLogData (\r
113 UINT8 *LogData,\r
114 UINT16 LogAreaLength\r
115 );\r
116\r
117#endif\r