util/nvramtool/cmos_lowlevel.h

   1 /*****************************************************************************\
   2  * cmos_lowlevel.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 David S. 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 NVRAMTOOL_CMOS_LOWLEVEL_H
  28 #define NVRAMTOOL_CMOS_LOWLEVEL_H
  29
  30 #include "common.h"
  31 #include "layout.h"
  32
  33 typedef struct {
  34         void (*init)(void* data);
  35         unsigned char (*read)(unsigned addr);
  36         void (*write)(unsigned addr, unsigned char value);
  37         void (*set_iopl)(int level);
  38 } cmos_access_t;
  39
  40 typedef enum { HAL_CMOS, HAL_MEMORY } hal_t;
  41 void select_hal(hal_t hal, void *data);
  42
  43 #define CMOS_AREA_OUT_OF_RANGE (CMOS_RESULT_START + 0)
  44 #define CMOS_AREA_OVERLAPS_RTC (CMOS_RESULT_START + 1)
  45 #define CMOS_AREA_TOO_WIDE (CMOS_RESULT_START + 2)
  46
  47 unsigned long long cmos_read(const cmos_entry_t * e);
  48 void cmos_write(const cmos_entry_t * e, unsigned long long value);
  49 unsigned char cmos_read_byte(unsigned index);
  50 void cmos_write_byte(unsigned index, unsigned char value);
  51 void cmos_read_all(unsigned char data[]);
  52 void cmos_write_all(unsigned char data[]);
  53 void set_iopl(int level);
  54 int verify_cmos_op(unsigned bit, unsigned length, cmos_entry_config_t config);
  55
  56 #define CMOS_SIZE 256           /* size of CMOS memory in bytes */
  57 #define CMOS_RTC_AREA_SIZE 14   /* first 14 bytes control real time clock */
  58
  59 /****************************************************************************
  60  * verify_cmos_byte_index
  61  *
  62  * Return 1 if 'index' does NOT specify a valid CMOS memory location.  Else
  63  * return 0.
  64  ****************************************************************************/
  65 static inline int verify_cmos_byte_index(unsigned index)
  66 {
  67         return (index < CMOS_RTC_AREA_SIZE) || (index >= CMOS_SIZE);
  68 }
  69
  70 #endif                          /* NVRAMTOOL_CMOS_LOWLEVEL_H */