rename a file.

[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 - 2010, 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
EFI_STATUS\r
LibSmbiosInit (\r
  VOID\r
  );\r
\r
VOID\r
LibSmbiosCleanup (\r
  VOID\r
  );\r
\r
VOID\r
LibSmbiosGetEPS (\r
  SMBIOS_STRUCTURE_TABLE **pEntryPointStructure\r
  );\r
\r
VOID\r
LibSmbiosGetStructHead (\r
  SMBIOS_STRUCTURE_POINTER *pHead\r
  );\r
\r
EFI_STATUS\r
LibGetSmbiosInfo (\r
  OUT CHAR8   *dmiBIOSRevision,\r
  OUT UINT16  *NumStructures,\r
  OUT UINT16  *StructureSize,\r
  OUT UINT32  *dmiStorageBase,\r
  OUT UINT16  *dmiStorageSize\r
  );\r
\r
/*++\r
  Description:\r
    Get SMBIOS Information.\r
\r
  Arguments:\r
    dmiBIOSRevision   - Revision of the SMBIOS Extensions.\r
    NumStructures     - Max. Number of Structures the BIOS will return.\r
    StructureSize     - Size of largest SMBIOS Structure.\r
    dmiStorageBase    - 32-bit physical base address for memory mapped SMBIOS data.\r
    dmiStorageSize    - Size of the memory-mapped SMBIOS data.\r
\r
  Returns:\r
    DMI_SUCCESS                 - successful.\r
    DMI_FUNCTION_NOT_SUPPORTED  - Does not support SMBIOS calling interface capability.\r
**/\r
EFI_STATUS\r
LibGetSmbiosStructure (\r
  IN  OUT UINT16  *Handle,\r
  IN  OUT UINT8   *Buffer,\r
  OUT UINT16      *Length\r
  );\r
\r
/*++\r
  Description:\r
    Get SMBIOS structure given the Handle,copy data to the Buffer,Handle is then the next.\r
\r
  Arguments:\r
    Handle:         - 0x0: get the first structure\r
                    - Others: get a certain structure according to this value.\r
    Buffter:        - contains the pointer to the caller's memory buffer.\r
\r
  Returns:\r
    DMI_SUCCESS         - Buffer contains the required structure data\r
                        - Handle is updated with next structure handle or 0xFFFF(end-of-list).\r
    DMI_INVALID_HANDLE  - Buffer not contain the requiring structure data\r
                        - Handle is updated with next structure handle or 0xFFFF(end-of-list).\r
**/\r
VOID\r
SmbiosGetPendingString (\r
  IN  SMBIOS_STRUCTURE_POINTER      *Smbios,\r
  IN  UINT16                        StringNumber,\r
  OUT CHAR8                         *Buffer\r
  );\r
\r
EFI_STATUS\r
SmbiosCheckStructure (\r
  IN  SMBIOS_STRUCTURE_POINTER      *Smbios\r
  );\r
\r
#endif\r