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 https://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
  27 #ifndef COMMON_H
  28 #define COMMON_H
  29
  30 #include <sys/types.h>
  31 #include <sys/stat.h>
  32 #include <assert.h>
  33 #include <errno.h>
  34 #include <unistd.h>
  35 #include <fcntl.h>
  36 #include <stdint.h>
  37 #include <stdlib.h>
  38 #include <stdio.h>
  39 #include <string.h>
  40 #include <ctype.h>
  41
  42 #define FALSE 0
  43 #define TRUE 1
  44
  45 #define BUG() assert(0)
  46
  47 #define COMMON_RESULT_START 0x10000
  48 #define LAYOUT_RESULT_START 0x20000
  49 #define CMOS_RESULT_START 0x30000
  50 #define CMOS_OP_RESULT_START 0x40000
  51
  52 #define OK 0                    /* 0 is used universally to indicate success. */
  53
  54 #define LINE_EOF (COMMON_RESULT_START + 0)
  55 #define LINE_TOO_LONG (COMMON_RESULT_START + 1)
  56
  57 #ifdef __MINGW32__
  58 #define PROT_READ 1
  59 #define PROT_WRITE 2
  60 #define MAP_PRIVATE 1
  61
  62 void *win32_mmap(void *start, size_t length, int prot, int flags, int fd, off_t offset);
  63 int win32_munmap(void *start, size_t length);
  64
  65 #define mmap win32_mmap
  66 #define munmap win32_munmap
  67
  68 #define MAP_FAILED ((void *)-1)
  69 #define MAP_SHARED 1
  70 #endif
  71
  72 /* basename of this program, as reported by argv[0] */
  73 extern const char prog_name[];
  74
  75 /* version of this program */
  76 extern const char prog_version[];
  77
  78 int get_line_from_file(FILE * f, char line[], int line_buf_size);
  79 void out_of_memory(void);
  80 void usage(FILE * outfile);
  81
  82 #endif                          /* COMMON_H */