util/nvramtool/common.h

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