Add more detailed comments for many of the Base Types

[mirror_edk2.git] / MdePkg / Include / Ebc / ProcessorBind.h

/** @file\r
  Processor or compiler specific defines and types for EBC.\r
\r
  We currently only have one EBC complier so there may be some Intel compiler\r
  specific functions in this file.\r
\r
  Copyright (c) 2006, Intel Corporation<BR>                                                         \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 __PROCESSOR_BIND_H__\r
#define __PROCESSOR_BIND_H__\r
\r
///\r
/// Define the processor type so other code can make processor based choices\r
///\r
#define MDE_CPU_EBC\r
\r
//\r
// Native integer types\r
//\r
\r
///\r
/// 1-byte signed value\r
///\r
typedef char                  INT8;\r
///\r
/// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
/// values are undefined.\r
///\r
typedef unsigned char         BOOLEAN;\r
///\r
/// 1-byte unsigned value\r
///\r
typedef unsigned char         UINT8;\r
///\r
/// 1-byte Character\r
///\r
typedef char                  CHAR8;\r
///\r
/// 2-byte signed value\r
///\r
typedef short                 INT16;\r
///\r
/// 2-byte unsigned value\r
///\r
typedef unsigned short        UINT16;\r
///\r
/// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
/// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
///\r
typedef unsigned short        CHAR16;\r
///\r
/// 4-byte signed value\r
///\r
typedef int                   INT32;\r
///\r
/// 4-byte unsigned value\r
///\r
typedef unsigned int          UINT32;\r
///\r
/// 8-byte signed value\r
///\r
typedef __int64               INT64;\r
///\r
/// 8-byte unsigned value\r
///\r
typedef unsigned __int64      UINT64;\r
\r
///\r
/// Signed value of native width.  (4 bytes on supported 32-bit processor instructions,\r
/// 8 bytes on supported 64-bit processor instructions)\r
/// "long" type scales to the processor native size with EBC compiler\r
///\r
typedef long                  INTN;\r
///\r
/// Unsigned value of native width.  (4 bytes on supported 32-bit processor instructions,\r
/// 8 bytes on supported 64-bit processor instructions)\r
/// "long" type scales to the processor native size with EBC compiler\r
///\r
typedef unsigned long         UINTN;\r
\r
///\r
/// A value of native width with the highest bit set.\r
/// Scalable macro to set the most significant bit in a natural number\r
///\r
#define MAX_BIT     (1ULL << (sizeof (INTN) * 8 - 1)) \r
///\r
/// A value of native width with the two highest bits set.\r
/// Scalable macro to set the most 2 significant bits in a natural number\r
///\r
#define MAX_2_BITS  (3ULL << (sizeof (INTN) * 8 - 2))\r
\r
///\r
/// Maximum legal EBC address\r
///\r
#define MAX_ADDRESS   ((UINTN) ~0)\r
\r
///\r
/// The stack alignment required for EBC\r
///\r
#define CPU_STACK_ALIGNMENT   sizeof(UINTN)\r
\r
///\r
/// Modifier to ensure that all protocol member functions and EFI intrinsics\r
/// use the correct C calling convention. All protocol member functions and\r
/// EFI intrinsics are required to modify their member functions with EFIAPI.\r
///\r
#define EFIAPI    \r
\r
///\r
/// The Microsoft* C compiler can removed references to unreferenced data items\r
///  if the /OPT:REF linker option is used. We defined a macro as this is a \r
///  a non standard extension. Currently not supported by the EBC compiler\r
///\r
#define GLOBAL_REMOVE_IF_UNREFERENCED\r
\r
\r
/**\r
  Return the pointer to the first instruction of a function given a function pointer.\r
  On EBC architectures, these two pointer values are the same, \r
  so the implementation of this macro is very simple.\r
  \r
  @param  FunctionPointer   A pointer to a function.\r
\r
  @return The pointer to the first instruction of a function given a function pointer.\r
**/\r
#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)\r
\r
#endif \r
\r