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  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 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 #if defined(__FreeBSD__)
  47 #include <sys/types.h>
  48 #include <machine/cpufunc.h>
  49 #define OUTB(x, y) do { u_int tmp = (y); outb(tmp, (x)); } while (0)
  50 #define OUTW(x, y) do { u_int tmp = (y); outw(tmp, (x)); } while (0)
  51 #define OUTL(x, y) do { u_int tmp = (y); outl(tmp, (x)); } while (0)
  52 #define INB(x) __extension__ ({ u_int tmp = (x); inb(tmp); })
  53 #define INW(x) __extension__ ({ u_int tmp = (x); inw(tmp); })
  54 #define INL(x) __extension__ ({ u_int tmp = (x); inl(tmp); })
  55 #else
  56 #if defined(__GLIBC__)
  57 #include <sys/io.h>
  58 #endif
  59 #if (defined(__MACH__) && defined(__APPLE__))
  60 #include <DirectIO/darwinio.h>
  61 #endif
  62 #define OUTB outb
  63 #define OUTW outw
  64 #define OUTL outl
  65 #define INB  inb
  66 #define INW  inw
  67 #define INL  inl
  68 #endif
  69
  70 #define FALSE 0
  71 #define TRUE 1
  72
  73 #define BUG() assert(0)
  74
  75 #define COMMON_RESULT_START 0x10000
  76 #define LAYOUT_RESULT_START 0x20000
  77 #define CMOS_RESULT_START 0x30000
  78 #define CMOS_OP_RESULT_START 0x40000
  79
  80 #define OK 0  /* 0 is used universally to indicate success. */
  81
  82 #define LINE_EOF (COMMON_RESULT_START + 0)
  83 #define LINE_TOO_LONG (COMMON_RESULT_START + 1)
  84
  85 /* basename of this program, as reported by argv[0] */
  86 extern const char prog_name[];
  87
  88 /* version of this program */
  89 extern const char prog_version[];
  90
  91 int get_line_from_file (FILE *f, char line[], int line_buf_size);
  92 void out_of_memory (void);
  93 void usage (FILE *outfile);
  94
  95 #endif  /* COMMON_H */