add comments to function declarations and definitions and updated to match coding...

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / SmbiosView / LibSmbios.h

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbios.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbios.h
index d1ecc858acea5b2c6fa42239f3189bd3ba0a6bcf..5e146cde52bb3f63ebaf9db6a5b156c9286bb8c9 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbios.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbios.h
@@ -1,7 +1,7 @@
 /** @file\r
   Lib include  for SMBIOS services. Used to get system serial number and GUID\r
 \r
-  Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -12,8 +12,8 @@
 \r
 **/\r
 \r
-#ifndef _LIB_SMBIOS_H\r
-#define _LIB_SMBIOS_H\r
+#ifndef _LIB_SMBIOS_H_\r
+#define _LIB_SMBIOS_H_\r
 \r
 //\r
 // Define SMBIOS tables.\r
@@ -215,14 +215,14 @@ typedef struct {
   UINT8         DevFuncNum;\r
 } SMBIOS_TYPE9;\r
 \r
-typedef struct DeviceStruct {\r
+typedef struct _DEVICE_STRUCTURE {\r
   UINT8         DeviceType;\r
   SMBIOS_STRING DescriptionString;\r
-} DeviceStruct;\r
+} DEVICE_STRUCTURE;\r
 \r
 typedef struct {\r
   SMBIOS_HEADER Hdr;\r
-  DeviceStruct  Device[1];\r
+  DEVICE_STRUCTURE  Device[1];\r
 } SMBIOS_TYPE10;\r
 \r
 typedef struct {\r
@@ -239,7 +239,7 @@ typedef struct {
   SMBIOS_HEADER Hdr;\r
   UINT8         InstallableLanguages;\r
   UINT8         Flags;\r
-  UINT8         reserved[15];\r
+  UINT8         Reserved[15];\r
   SMBIOS_STRING CurrentLanguages;\r
 } SMBIOS_TYPE13;\r
 \r
@@ -622,17 +622,19 @@ typedef union {
 \r
 #pragma pack()\r
 \r
-CHAR8         *\r
-LibGetSmbiosString (\r
-  IN  SMBIOS_STRUCTURE_POINTER      *Smbios,\r
-  IN  UINT16                        StringNumber\r
-  );\r
+/**\r
+  Return SMBIOS string given the string number.\r
 \r
-EFI_STATUS\r
-LibGetSmbiosSystemGuidAndSerialNumber (\r
-  IN  EFI_GUID                      *SystemGuid,\r
-  OUT CHAR8                         **SystemSerialNumber\r
-  );\r
+  @param[in] Smbios         Pointer to SMBIOS structure.\r
+  @param[in] StringNumber   String number to return. -1 is used to skip all strings and\r
+                            point to the next SMBIOS structure.\r
 \r
+  @return Pointer to string, or pointer to next SMBIOS strcuture if StringNumber == -1\r
+**/\r
+CHAR8*\r
+LibGetSmbiosString (\r
+  IN  SMBIOS_STRUCTURE_POINTER    *Smbios,\r
+  IN  UINT16                      StringNumber\r
+  );\r
 \r
 #endif\r