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

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

/** @file\r
  Platform specific values for <limits.h>.\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
 * Copyright (c) 1988, 1993\r
 *  The Regents of the University of California.  All rights reserved.\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
 * 1. Redistributions of source code must retain the above copyright\r
 *    notice, this list of conditions and the following disclaimer.\r
 * 2. 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
 * 3. 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 REGENTS AND CONTRIBUTORS ``AS IS'' AND\r
 * 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 REGENTS OR CONTRIBUTORS BE LIABLE\r
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
 * SUCH DAMAGE.\r
 *\r
 *  syslimits.h 8.1 (Berkeley) 6/2/93\r
 *  NetBSD: syslimits.h,v 1.23 2005/12/11 12:25:21 christos Exp\r
**/\r
\r
#ifndef _SYS_SYSLIMITS_H_\r
#define _SYS_SYSLIMITS_H_\r
\r
#include <sys/featuretest.h>\r
\r
#define ARG_MAX     (2 * 1024)  ///< Maximum bytes for an exec function.\r
#define ARGC_MAX          (64)  ///< Maximum value for argc.\r
\r
#define MAX_INPUT         255   ///< Maximum bytes in terminal input.\r
#define NAME_MAX          255   ///< Maximum bytes in a file name.\r
#ifndef OPEN_MAX\r
  #define OPEN_MAX         20   ///< Maximum open files per process.\r
#endif\r
#define PATH_MAX         1024   ///< Maximum bytes in pathname.\r
#define PIPE_BUF          512   ///< Maximum bytes for atomic pipe writes.\r
\r
#ifndef CHILD_MAX\r
  #define CHILD_MAX       128   ///< Maximum simultaneous processes.\r
#endif\r
\r
#define LOGIN_NAME_MAX     17   ///< Maximum login name length including the NUL.\r
\r
#endif /* !_SYS_SYSLIMITS_H_ */\r