]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/SmbiosView.h
ShellPkg/Application: Remove unnecessary EFIAPI
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / SmbiosView / SmbiosView.h
CommitLineData
5d73d92f 1/** @file\r
2 Tools of clarify the content of the smbios table.\r
3\r
ec8a502e 4 Copyright (c) 2005 - 2015, 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_VIEW_H_\r
16#define _SMBIOS_VIEW_H_\r
5d73d92f 17\r
18#define STRUCTURE_TYPE_RANDOM (UINT8) 0xFE\r
19#define STRUCTURE_TYPE_INVALID (UINT8) 0xFF\r
20\r
5d73d92f 21typedef struct {\r
22 UINT16 Index;\r
23 UINT8 Type;\r
24 UINT16 Handle;\r
25 UINT16 Addr; // offset from table head\r
26 UINT16 Length; // total structure length\r
27} STRUCTURE_STATISTICS;\r
28\r
29/**\r
30 Query all structures Data from SMBIOS table and Display\r
31 the information to users as required display option.\r
32\r
33 @param[in] QueryType Structure type to view.\r
34 @param[in] QueryHandle Structure handle to view.\r
35 @param[in] Option Display option: none,outline,normal,detail.\r
36 @param[in] RandomView Support for -h parameter.\r
37\r
38 @retval EFI_SUCCESS print is successful.\r
39 @retval EFI_BAD_BUFFER_SIZE structure is out of the range of SMBIOS table.\r
40**/\r
41EFI_STATUS\r
42EFIAPI\r
43SMBiosView (\r
44 IN UINT8 QueryType,\r
45 IN UINT16 QueryHandle,\r
46 IN UINT8 Option,\r
47 IN BOOLEAN RandomView\r
48 );\r
49\r
ec8a502e
EL
50/**\r
51 Query all structures Data from SMBIOS table and Display\r
52 the information to users as required display option.\r
53\r
54 @param[in] QueryType Structure type to view.\r
55 @param[in] QueryHandle Structure handle to view.\r
56 @param[in] Option Display option: none,outline,normal,detail.\r
57 @param[in] RandomView Support for -h parameter.\r
58\r
59 @retval EFI_SUCCESS print is successful.\r
60 @retval EFI_BAD_BUFFER_SIZE structure is out of the range of SMBIOS table.\r
61**/\r
62EFI_STATUS\r
63EFIAPI\r
64SMBios64View (\r
65 IN UINT8 QueryType,\r
66 IN UINT16 QueryHandle,\r
67 IN UINT8 Option,\r
68 IN BOOLEAN RandomView\r
69 );\r
70\r
5d73d92f 71/**\r
72 Function to initialize the global mStatisticsTable object.\r
73\r
74 @retval EFI_SUCCESS print is successful.\r
75**/\r
76EFI_STATUS\r
77EFIAPI\r
78InitSmbiosTableStatistics (\r
79 VOID\r
80 );\r
81\r
ec8a502e
EL
82/**\r
83 Function to initialize the global mSmbios64BitStatisticsTable object.\r
84\r
85 @retval EFI_SUCCESS print is successful.\r
86**/\r
87EFI_STATUS\r
88EFIAPI\r
89InitSmbios64BitTableStatistics (\r
90 VOID\r
91 );\r
92\r
5d73d92f 93/**\r
94 Function to display the global mStatisticsTable object.\r
95\r
96 @param[in] Option ECHO, NORMAL, or DETAIL control the amount of detail displayed.\r
97\r
98 @retval EFI_SUCCESS print is successful.\r
99**/\r
100EFI_STATUS\r
101EFIAPI\r
102DisplayStatisticsTable (\r
103 IN UINT8 Option\r
104 );\r
105\r
ec8a502e
EL
106/**\r
107 Function to display the global mSmbios64BitStatisticsTable object.\r
108\r
109 @param[in] Option ECHO, NORMAL, or DETAIL control the amount of detail displayed.\r
110\r
111 @retval EFI_SUCCESS print is successful.\r
112**/\r
113EFI_STATUS\r
114EFIAPI\r
115DisplaySmbios64BitStatisticsTable (\r
116 IN UINT8 Option\r
117 );\r
118\r
5d73d92f 119/**\r
120 function to return a string of the detail level.\r
121\r
122 @param[in] ShowType The detail level whose name is desired in clear text.\r
123\r
124 @return A pointer to a string representing the ShowType (or 'undefined type' if not known).\r
125**/\r
126CHAR16*\r
127EFIAPI\r
128GetShowTypeString (\r
129 UINT8 ShowType\r
130 );\r
131\r
132extern UINT8 gShowType;\r
133\r
ec8a502e
EL
134extern UINTN mSmbios64BitTableLength;\r
135\r
5d73d92f 136#endif\r