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

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

/** @file\r
  API for SMBIOS Plug and Play functions, access to SMBIOS table and structures.\r
\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
  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
#ifndef _LIB_SMBIOS_VIEW_H_\r
#define _LIB_SMBIOS_VIEW_H_\r
\r
#include "LibSmbios.h"\r
\r
#define DMI_SUCCESS                     0x00\r
#define DMI_UNKNOWN_FUNCTION            0x81\r
#define DMI_FUNCTION_NOT_SUPPORTED      0x82\r
#define DMI_INVALID_HANDLE              0x83\r
#define DMI_BAD_PARAMETER               0x84\r
#define DMI_INVALID_SUBFUNCTION         0x85\r
#define DMI_NO_CHANGE                   0x86\r
#define DMI_ADD_STRUCTURE_FAILED        0x87\r
#define DMI_READ_ONLY                   0x8D\r
#define DMI_LOCK_NOT_SUPPORTED          0x90\r
#define DMI_CURRENTLY_LOCKED            0x91\r
#define DMI_INVALID_LOCK                0x92\r
\r
#define INVALIDE_HANDLE                 (UINT16) (-1)\r
\r
#define EFI_SMBIOSERR(val)              EFIERR (0x30000 | val)\r
\r
#define EFI_SMBIOSERR_FAILURE           EFI_SMBIOSERR (1)\r
#define EFI_SMBIOSERR_STRUCT_NOT_FOUND  EFI_SMBIOSERR (2)\r
#define EFI_SMBIOSERR_TYPE_UNKNOWN      EFI_SMBIOSERR (3)\r
#define EFI_SMBIOSERR_UNSUPPORTED       EFI_SMBIOSERR (4)\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
/**\r
  Cleanup the Smbios information.\r
**/\r
VOID\r
LibSmbiosCleanup (\r
  VOID\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_STRUCTURE_TABLE **EntryPointStructure\r
  );\r
\r
/**\r
    Get SMBIOS structure given the Handle,copy data to the Buffer,\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[in,out] Buffer     The pointer to the caller's memory buffer.\r
    @param[out] Length        Length of return buffer in bytes.\r
\r
    @retval DMI_SUCCESS   Buffer contains the required structure data\r
                          Handle is updated with next structure handle or\r
                          0xFFFF(end-of-list).\r
\r
    @retval DMI_INVALID_HANDLE  Buffer not contain the requiring structure data.\r
                                Handle is updated with next structure handle or\r
                                0xFFFF(end-of-list).\r
**/\r
EFI_STATUS\r
LibGetSmbiosStructure (\r
  IN  OUT UINT16  *Handle,\r
  IN  OUT UINT8   *Buffer,\r
  OUT UINT16      *Length\r
  );\r
\r
/**\r
  Get a string from the smbios information.\r
\r
  @param[in] Smbios         The pointer to the smbios information.\r
  @param[in] StringNumber   The index to the string to get.\r
  @param[out] Buffer        The buffer to fill with the string when retrieved.\r
**/\r
VOID\r
SmbiosGetPendingString (\r
  IN  SMBIOS_STRUCTURE_POINTER      *Smbios,\r
  IN  UINT16                        StringNumber,\r
  OUT CHAR8                         *Buffer\r
  );\r
\r
/**\r
  Check the structure to see if it is legal.\r
\r
  @param[in] Smbios    - Pointer to the structure that will be checked.\r
\r
  @retval DMI_SUCCESS           Structure data is legal.\r
  @retval DMI_BAD_PARAMETER     Structure data contains bad parameter.\r
**/\r
EFI_STATUS\r
SmbiosCheckStructure (\r
  IN  SMBIOS_STRUCTURE_POINTER *Smbios\r
  );\r
\r
#endif\r