Update or add comments to files and functions for use by Doxygen.

[mirror_edk2.git] / StdLib / Include / Ia32 / machine / limits.h

/** @file\r
  This header <machine/limits.h> defines several macros that expand to various\r
  CPU-architecture-specific limits and parameters of the standard integer types.\r
\r
  The values given below are constant expressions suitable for use\r
  in #if preprocessing directives.\r
\r
  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials are licensed and made available under\r
  the terms and conditions of the BSD License that accompanies this distribution.\r
  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.\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
#include  <x86/limits.h>\r
\r
/** Number of bits making up a pointer. **/\r
#define __POINTER_BIT   32\r
\r
/** Number of bits comprising an object of type long int. **/\r
#define __LONG_BIT      32\r
\r
/** Minimum value for an object of type long int. **/\r
#define __LONG_MIN    (-2147483647L - 1L)   // -(2^31 - 1)\r
\r
/** Maximum value for an object of type long int. **/\r
#define __LONG_MAX    +2147483647L          // 2^31 - 1\r
\r
/** Maximum value for an object of type unsigned long int. **/\r
#define __ULONG_MAX   0xffffffff            // 2^32 - 1\r
\r