Add SMBIOS 2.7.1 support to SmbiosView command.

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / SmbiosView / LibSmbiosView.c

/** @file\r
  API for SMBIOS table.\r
\r
  Copyright (c) 2005 - 2012, 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
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
    \r
\r
#include "../UefiShellDebug1CommandsLib.h"\r
#include <Guid/SmBios.h>\r
#include "LibSmbiosView.h"\r
#include "SmbiosView.h"\r
\r
STATIC UINT8                    mInit         = 0;\r
STATIC SMBIOS_TABLE_ENTRY_POINT *mSmbiosTable = NULL;\r
STATIC SMBIOS_STRUCTURE_POINTER m_SmbiosStruct;\r
STATIC SMBIOS_STRUCTURE_POINTER *mSmbiosStruct = &m_SmbiosStruct;\r
\r
/**\r
  Init the SMBIOS VIEW API's environment.\r
\r
  @retval EFI_SUCCESS  Successful to init the SMBIOS VIEW Lib.\r
**/\r
EFI_STATUS\r
LibSmbiosInit (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Init only once\r
  //\r
  if (mInit == 1) {\r
    return EFI_SUCCESS;\r
  }\r
  //\r
  // Get SMBIOS table from System Configure table\r
  //\r
  Status = GetSystemConfigurationTable (&gEfiSmbiosTableGuid, (VOID**)&mSmbiosTable);\r
\r
  if (mSmbiosTable == NULL) {\r
    ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_LIBSMBIOSVIEW_CANNOT_GET_TABLE), gShellDebug1HiiHandle);\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_LIBSMBIOSVIEW_GET_TABLE_ERROR), gShellDebug1HiiHandle, Status);\r
    return Status;\r
  }\r
  //\r
  // Init SMBIOS structure table address\r
  //\r
  mSmbiosStruct->Raw  = (UINT8 *) (UINTN) (mSmbiosTable->TableAddress);\r
\r
  mInit               = 1;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Cleanup the Smbios information.\r
**/\r
VOID\r
LibSmbiosCleanup (\r
  VOID\r
  )\r
{\r
  //\r
  // Release resources\r
  //\r
  if (mSmbiosTable != NULL) {\r
    mSmbiosTable = NULL;\r
  }\r
\r
  mInit = 0;\r
}\r
\r
/**\r
  Get the entry point structure for the table.\r
\r
  @param[out] EntryPointStructure  The pointer to populate.\r
**/\r
VOID\r
LibSmbiosGetEPS (\r
  OUT SMBIOS_TABLE_ENTRY_POINT **EntryPointStructure\r
  )\r
{\r
  //\r
  // return SMBIOS Table address\r
  //\r
  *EntryPointStructure = mSmbiosTable;\r
}\r
\r
/**\r
  Return SMBIOS string for the given string number.\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
  UINT16  Index;\r
  CHAR8   *String;\r
\r
  ASSERT (Smbios != NULL);\r
\r
  //\r
  // Skip over formatted section\r
  //\r
  String = (CHAR8 *) (Smbios->Raw + Smbios->Hdr->Length);\r
\r
  //\r
  // Look through unformated section\r
  //\r
  for (Index = 1; Index <= StringNumber; Index++) {\r
    if (StringNumber == Index) {\r
      return String;\r
    }\r
    //\r
    // Skip string\r
    //\r
    for (; *String != 0; String++);\r
    String++;\r
\r
    if (*String == 0) {\r
      //\r
      // If double NULL then we are done.\r
      //  Return pointer to next structure in Smbios.\r
      //  if you pass in a -1 you will always get here\r
      //\r
      Smbios->Raw = (UINT8 *)++String;\r
      return NULL;\r
    }\r
  }\r
\r
  return NULL;\r
}\r
\r
/**\r
    Get SMBIOS structure for the given Handle,\r
    Handle is changed to the next handle or 0xFFFF when the end is\r
    reached or the handle is not found.\r
\r
    @param[in, out] Handle     0xFFFF: get the first structure\r
                               Others: get a structure according to this value.\r
    @param[out] Buffer         The pointer to the pointer to the structure.\r
    @param[out] Length         Length of the structure.\r
\r
    @retval DMI_SUCCESS   Handle is updated with next structure handle or\r
                          0xFFFF(end-of-list).\r
\r
    @retval DMI_INVALID_HANDLE  Handle is updated with first structure handle or\r
                                0xFFFF(end-of-list).\r
**/\r
EFI_STATUS\r
LibGetSmbiosStructure (\r
  IN  OUT UINT16  *Handle,\r
  OUT UINT8       **Buffer,\r
  OUT UINT16      *Length\r
  )\r
{\r
  SMBIOS_STRUCTURE_POINTER  Smbios;\r
  SMBIOS_STRUCTURE_POINTER  SmbiosEnd;\r
  UINT8                     *Raw;\r
\r
  if (*Handle == INVALID_HANDLE) {\r
    *Handle = mSmbiosStruct->Hdr->Handle;\r
    return DMI_INVALID_HANDLE;\r
  }\r
\r
  if ((Buffer == NULL) || (Length == NULL)) {\r
    ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_LIBSMBIOSVIEW_NO_BUFF_LEN_SPEC), gShellDebug1HiiHandle);\r
    return DMI_INVALID_HANDLE;\r
  }\r
\r
  *Length       = 0;\r
  Smbios.Hdr    = mSmbiosStruct->Hdr;\r
  SmbiosEnd.Raw = Smbios.Raw + mSmbiosTable->TableLength;\r
  while (Smbios.Raw < SmbiosEnd.Raw) {\r
    if (Smbios.Hdr->Handle == *Handle) {\r
      Raw = Smbios.Raw;\r
      //\r
      // Walk to next structure\r
      //\r
      LibGetSmbiosString (&Smbios, (UINT16) (-1));\r
      //\r
      // Length = Next structure head - this structure head\r
      //\r
      *Length = (UINT16) (Smbios.Raw - Raw);\r
      *Buffer = Raw;\r
      //\r
      // update with the next structure handle.\r
      //\r
      if (Smbios.Raw < SmbiosEnd.Raw) {\r
        *Handle = Smbios.Hdr->Handle;\r
      } else {\r
        *Handle = INVALID_HANDLE;\r
      }\r
      return DMI_SUCCESS;\r
    }\r
    //\r
    // Walk to next structure\r
    //\r
    LibGetSmbiosString (&Smbios, (UINT16) (-1));\r
  }\r
\r
  *Handle = INVALID_HANDLE;\r
  return DMI_INVALID_HANDLE;\r
}\r
\r