util/nvramtool/common.h

   1 /*****************************************************************************\
   2  * common.h
   3  * $Id$
   4  *****************************************************************************
   5  *  Copyright (C) 2002-2005 The Regents of the University of California.
   6  *  Produced at the Lawrence Livermore National Laboratory.
   7  *  Written by Dave Peterson <dsp@llnl.gov> <dave_peterson@pobox.com>.
   8  *  UCRL-CODE-2003-012
   9  *  All rights reserved.
  10  *
  11  *  This file is part of nvramtool, a utility for reading/writing coreboot
  12  *  parameters and displaying information from the coreboot table.
  13  *  For details, see http://coreboot.org/nvramtool.
  14  *
  15  *  Please also read the file DISCLAIMER which is included in this software
  16  *  distribution.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify it
  19  *  under the terms of the GNU General Public License (as published by the
  20  *  Free Software Foundation) version 2, dated June 1991.
  21  *
  22  *  This program is distributed in the hope that it will be useful, but
  23  *  WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY OF
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the terms and
  25  *  conditions of the GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License along
  28  *  with this program; if not, write to the Free Software Foundation, Inc.,
  29  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  30 \*****************************************************************************/
  31
  32 #ifndef COMMON_H
  33 #define COMMON_H
  34
  35 #include <sys/types.h>
  36 #include <sys/stat.h>
  37 #include <assert.h>
  38 #include <errno.h>
  39 #include <unistd.h>
  40 #include <fcntl.h>
  41 #include <stdint.h>
  42 #include <stdlib.h>
  43 #include <stdio.h>
  44 #include <string.h>
  45 #include <ctype.h>
  46
  47 #define FALSE 0
  48 #define TRUE 1
  49
  50 #define BUG() assert(0)
  51
  52 #define COMMON_RESULT_START 0x10000
  53 #define LAYOUT_RESULT_START 0x20000
  54 #define CMOS_RESULT_START 0x30000
  55 #define CMOS_OP_RESULT_START 0x40000
  56
  57 #define OK 0  /* 0 is used universally to indicate success. */
  58
  59 #define LINE_EOF (COMMON_RESULT_START + 0)
  60 #define LINE_TOO_LONG (COMMON_RESULT_START + 1)
  61
  62 /* basename of this program, as reported by argv[0] */
  63 extern const char prog_name[];
  64
  65 /* version of this program */
  66 extern const char prog_version[];
  67
  68 int get_line_from_file (FILE *f, char line[], int line_buf_size);
  69 void out_of_memory (void);
  70 void usage (FILE *outfile);
  71
  72 #endif  /* COMMON_H */