Add Ppi/Guid/Protocol header file path into the comments for user reference.

[mirror_edk2.git] / MdePkg / Include / Uefi / UefiBaseType.h

/** @file\r
  Defines data types and constants introduced in UEFI.\r
\r
  Copyright (c) 2006 - 2008, Intel Corporation\r
  All rights reserved. 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 __UEFI_BASETYPE_H__\r
#define __UEFI_BASETYPE_H__\r
\r
#include <Base.h>\r
\r
//\r
// Basical data type definitions introduced in UEFI.\r
//\r
\r
///\r
/// 128-bit buffer containing a unique identifier value.\r
///\r
typedef GUID                      EFI_GUID;\r
///\r
/// Function return status for EFI API\r
///\r
typedef RETURN_STATUS             EFI_STATUS;\r
///\r
/// A collection of related interfaces.\r
///\r
typedef VOID                      *EFI_HANDLE;\r
///\r
/// Handle to an event structure.\r
///\r
typedef VOID                      *EFI_EVENT;\r
///\r
/// Task priority level.\r
///\r
typedef UINTN                     EFI_TPL;\r
///\r
/// Logical block address.\r
///\r
typedef UINT64                    EFI_LBA;\r
\r
///\r
/// 64-bit physical memory address.\r
///\r
typedef UINT64                    EFI_PHYSICAL_ADDRESS;\r
\r
///\r
/// 64-bit virtual memory address.\r
///\r
typedef UINT64                    EFI_VIRTUAL_ADDRESS;\r
\r
///\r
/// EFI Time Abstraction:\r
///  Year:       1998 - 20XX\r
///  Month:      1 - 12\r
///  Day:        1 - 31\r
///  Hour:       0 - 23\r
///  Minute:     0 - 59\r
///  Second:     0 - 59\r
///  Nanosecond: 0 - 999,999,999\r
///  TimeZone:   -1440 to 1440 or 2047\r
///\r
typedef struct {\r
  UINT16  Year;\r
  UINT8   Month;\r
  UINT8   Day;\r
  UINT8   Hour;\r
  UINT8   Minute;\r
  UINT8   Second;\r
  UINT8   Pad1;\r
  UINT32  Nanosecond;\r
  INT16   TimeZone;\r
  UINT8   Daylight;\r
  UINT8   Pad2;\r
} EFI_TIME;\r
\r
\r
///\r
/// 4-byte buffer. An IPv4 internet protocol address.\r
///\r
typedef struct {\r
  UINT8 Addr[4];\r
} EFI_IPv4_ADDRESS;\r
\r
///\r
/// 16-byte buffer. An IPv6 internet protocol address\r
///\r
typedef struct {\r
  UINT8 Addr[16];\r
} EFI_IPv6_ADDRESS;\r
\r
///\r
/// 32-byte buffer containing a network Media Access Control address.\r
///\r
typedef struct {\r
  UINT8 Addr[32];\r
} EFI_MAC_ADDRESS;\r
\r
///\r
/// 16-byte buffer aligned on a 4-byte boundary.\r
/// An IPv4 or IPv6 internet protocol address.\r
///\r
typedef union {\r
  UINT32            Addr[4];\r
  EFI_IPv4_ADDRESS  v4;\r
  EFI_IPv6_ADDRESS  v6;\r
} EFI_IP_ADDRESS;\r
\r
\r
//\r
// Enumeration of EFI_STATUS.\r
// \r
#define EFI_SUCCESS               RETURN_SUCCESS              \r
#define EFI_LOAD_ERROR            RETURN_LOAD_ERROR           \r
#define EFI_INVALID_PARAMETER     RETURN_INVALID_PARAMETER    \r
#define EFI_UNSUPPORTED           RETURN_UNSUPPORTED          \r
#define EFI_BAD_BUFFER_SIZE       RETURN_BAD_BUFFER_SIZE      \r
#define EFI_BUFFER_TOO_SMALL      RETURN_BUFFER_TOO_SMALL     \r
#define EFI_NOT_READY             RETURN_NOT_READY            \r
#define EFI_DEVICE_ERROR          RETURN_DEVICE_ERROR         \r
#define EFI_WRITE_PROTECTED       RETURN_WRITE_PROTECTED      \r
#define EFI_OUT_OF_RESOURCES      RETURN_OUT_OF_RESOURCES     \r
#define EFI_VOLUME_CORRUPTED      RETURN_VOLUME_CORRUPTED     \r
#define EFI_VOLUME_FULL           RETURN_VOLUME_FULL          \r
#define EFI_NO_MEDIA              RETURN_NO_MEDIA             \r
#define EFI_MEDIA_CHANGED         RETURN_MEDIA_CHANGED        \r
#define EFI_NOT_FOUND             RETURN_NOT_FOUND            \r
#define EFI_ACCESS_DENIED         RETURN_ACCESS_DENIED        \r
#define EFI_NO_RESPONSE           RETURN_NO_RESPONSE          \r
#define EFI_NO_MAPPING            RETURN_NO_MAPPING           \r
#define EFI_TIMEOUT               RETURN_TIMEOUT              \r
#define EFI_NOT_STARTED           RETURN_NOT_STARTED          \r
#define EFI_ALREADY_STARTED       RETURN_ALREADY_STARTED      \r
#define EFI_ABORTED               RETURN_ABORTED              \r
#define EFI_ICMP_ERROR            RETURN_ICMP_ERROR           \r
#define EFI_TFTP_ERROR            RETURN_TFTP_ERROR           \r
#define EFI_PROTOCOL_ERROR        RETURN_PROTOCOL_ERROR       \r
#define EFI_INCOMPATIBLE_VERSION  RETURN_INCOMPATIBLE_VERSION \r
#define EFI_SECURITY_VIOLATION    RETURN_SECURITY_VIOLATION   \r
#define EFI_CRC_ERROR             RETURN_CRC_ERROR   \r
#define EFI_END_OF_MEDIA          RETURN_END_OF_MEDIA\r
#define EFI_END_OF_FILE           RETURN_END_OF_FILE\r
#define EFI_INVALID_LANGUAGE      RETURN_INVALID_LANGUAGE\r
\r
#define EFI_WARN_UNKNOWN_GLYPH    RETURN_WARN_UNKNOWN_GLYPH   \r
#define EFI_WARN_DELETE_FAILURE   RETURN_WARN_DELETE_FAILURE  \r
#define EFI_WARN_WRITE_FAILURE    RETURN_WARN_WRITE_FAILURE   \r
#define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL\r
\r
\r
//\r
// Define macro to encode the status code.\r
// \r
#define EFIERR(_a)                ENCODE_ERROR(_a)\r
\r
#define EFI_ERROR(A)              RETURN_ERROR(A)\r
\r
\r
\r
//\r
// The EFI memory allocation functions work in units of EFI_PAGEs that are\r
// 4K. This should in no way be confused with the page size of the processor.\r
// An EFI_PAGE is just the quanta of memory in EFI.\r
//\r
#define EFI_PAGE_SIZE             0x1000\r
#define EFI_PAGE_MASK             0xFFF\r
#define EFI_PAGE_SHIFT            12\r
\r
#define EFI_SIZE_TO_PAGES(a)  (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))\r
\r
#define EFI_PAGES_TO_SIZE(a)   ( (a) << EFI_PAGE_SHIFT)\r
\r
///\r
/// Limited buffer size for a language code recommended by RFC3066\r
/// (42 characters plus a NULL terminator)\r
///\r
#define RFC_3066_ENTRY_SIZE             (42 + 1)\r
\r
///\r
/// The size of a 3 character ISO639 language code.\r
///\r
#define ISO_639_2_ENTRY_SIZE            3\r
\r
\r
#endif\r