StdLib: Clarify and improve comments.

[mirror_edk2.git] / StdLib / Include / sys / ansi.h

/** @file\r
    ANSI type definitions.\r
\r
    Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
    This program and the accompanying materials are licensed and made available\r
    under the terms and conditions of the BSD License that accompanies this\r
    distribution.  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
    Copyright (c) 1990, 1993\r
    The Regents of the University of California.  All rights reserved.\r
\r
    This code is derived from software contributed to The NetBSD Foundation\r
    by Jun-ichiro itojun Hagino and by Klaus Klein.\r
\r
    Redistribution and use in source and binary forms, with or without\r
    modification, are permitted provided that the following conditions\r
    are met:\r
      - Redistributions of source code must retain the above copyright\r
        notice, this list of conditions and the following disclaimer.\r
      - Redistributions in binary form must reproduce the above copyright\r
        notice, this list of conditions and the following disclaimer in the\r
        documentation and/or other materials provided with the distribution.\r
      - Neither the name of the University nor the names of its contributors\r
        may be used to endorse or promote products derived from this software\r
        without specific prior written permission.\r
\r
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"\r
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
    ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE\r
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\r
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF\r
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
    POSSIBILITY OF SUCH DAMAGE.\r
\r
    NetBSD: ansi.h,v 1.11 2005/12/11 12:25:20 christos Exp\r
**/\r
#ifndef _SYS_ANSI_H_\r
#define _SYS_ANSI_H_\r
\r
#include <machine/int_types.h>\r
\r
typedef INT8 *      __caddr_t;      ///< core address\r
typedef __uint32_t  __gid_t;        ///< group id\r
typedef __uint32_t  __in_addr_t;    ///< IP(v4) address\r
typedef __uint16_t  __in_port_t;    ///< "Internet" port number\r
typedef __uint32_t  __mode_t;       ///< file permissions\r
typedef __int64_t   __off_t;        ///< file offset\r
typedef __int32_t   __pid_t;        ///< process id\r
typedef __uint8_t   __sa_family_t;  ///< socket address family\r
typedef UINT32      __socklen_t;    ///< socket-related datum length\r
typedef __uint32_t  __uid_t;        ///< user id\r
typedef __uint64_t  __fsblkcnt_t;   ///< fs block count (statvfs)\r
typedef __uint64_t  __fsfilcnt_t;   ///< fs file count\r
\r
#endif  /* !_SYS_ANSI_H_ */\r