Stefan Reinauer | 6540ae5 | 2007-07-12 16:35:42 +0000 | [diff] [blame] | 1 | /*****************************************************************************\ |
| 2 | * cmos_lowlevel.h |
Stefan Reinauer | 6540ae5 | 2007-07-12 16:35:42 +0000 | [diff] [blame] | 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 | * |
Uwe Hermann | 6e56594 | 2008-03-01 19:06:32 +0000 | [diff] [blame] | 10 | * This file is part of nvramtool, a utility for reading/writing coreboot |
Stefan Reinauer | f527e70 | 2008-01-18 15:33:49 +0000 | [diff] [blame] | 11 | * parameters and displaying information from the coreboot table. |
Uwe Hermann | 6e56594 | 2008-03-01 19:06:32 +0000 | [diff] [blame] | 12 | * For details, see http://coreboot.org/nvramtool. |
Stefan Reinauer | 6540ae5 | 2007-07-12 16:35:42 +0000 | [diff] [blame] | 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., |
Stefan Reinauer | ac7a2d2 | 2009-09-23 21:53:25 +0000 | [diff] [blame] | 28 | * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
Stefan Reinauer | 6540ae5 | 2007-07-12 16:35:42 +0000 | [diff] [blame] | 29 | \*****************************************************************************/ |
| 30 | |
Uwe Hermann | 6e56594 | 2008-03-01 19:06:32 +0000 | [diff] [blame] | 31 | #ifndef NVRAMTOOL_CMOS_LOWLEVEL_H |
| 32 | #define NVRAMTOOL_CMOS_LOWLEVEL_H |
Stefan Reinauer | 6540ae5 | 2007-07-12 16:35:42 +0000 | [diff] [blame] | 33 | |
| 34 | #include "common.h" |
Stefan Reinauer | a67aab7 | 2008-09-27 10:08:28 +0000 | [diff] [blame] | 35 | #include "layout.h" |
Stefan Reinauer | 6540ae5 | 2007-07-12 16:35:42 +0000 | [diff] [blame] | 36 | |
Patrick Georgi | 1e916e0 | 2011-01-28 07:54:11 +0000 | [diff] [blame^] | 37 | typedef struct { |
| 38 | void (*init)(void* data); |
| 39 | unsigned char (*read)(unsigned addr); |
| 40 | void (*write)(unsigned addr, unsigned char value); |
| 41 | void (*set_iopl)(int level); |
| 42 | } cmos_access_t; |
| 43 | |
Patrick Georgi | 9cd7eba | 2011-01-21 07:19:59 +0000 | [diff] [blame] | 44 | typedef enum { HAL_CMOS, HAL_MEMORY } hal_t; |
| 45 | void select_hal(hal_t hal, void *data); |
| 46 | |
Stefan Reinauer | 6540ae5 | 2007-07-12 16:35:42 +0000 | [diff] [blame] | 47 | #define CMOS_AREA_OUT_OF_RANGE (CMOS_RESULT_START + 0) |
| 48 | #define CMOS_AREA_OVERLAPS_RTC (CMOS_RESULT_START + 1) |
| 49 | #define CMOS_AREA_TOO_WIDE (CMOS_RESULT_START + 2) |
| 50 | |
Stefan Reinauer | 90b96b6 | 2010-01-13 21:00:23 +0000 | [diff] [blame] | 51 | unsigned long long cmos_read(const cmos_entry_t * e); |
| 52 | void cmos_write(const cmos_entry_t * e, unsigned long long value); |
| 53 | unsigned char cmos_read_byte(unsigned index); |
| 54 | void cmos_write_byte(unsigned index, unsigned char value); |
| 55 | void cmos_read_all(unsigned char data[]); |
| 56 | void cmos_write_all(unsigned char data[]); |
| 57 | void set_iopl(int level); |
| 58 | int verify_cmos_op(unsigned bit, unsigned length, cmos_entry_config_t config); |
Stefan Reinauer | 6540ae5 | 2007-07-12 16:35:42 +0000 | [diff] [blame] | 59 | |
Stefan Reinauer | 90b96b6 | 2010-01-13 21:00:23 +0000 | [diff] [blame] | 60 | #define CMOS_SIZE 256 /* size of CMOS memory in bytes */ |
| 61 | #define CMOS_RTC_AREA_SIZE 14 /* first 14 bytes control real time clock */ |
Stefan Reinauer | 6540ae5 | 2007-07-12 16:35:42 +0000 | [diff] [blame] | 62 | |
| 63 | /**************************************************************************** |
| 64 | * verify_cmos_byte_index |
| 65 | * |
| 66 | * Return 1 if 'index' does NOT specify a valid CMOS memory location. Else |
| 67 | * return 0. |
| 68 | ****************************************************************************/ |
Stefan Reinauer | 90b96b6 | 2010-01-13 21:00:23 +0000 | [diff] [blame] | 69 | static inline int verify_cmos_byte_index(unsigned index) |
| 70 | { |
| 71 | return (index < CMOS_RTC_AREA_SIZE) || (index >= CMOS_SIZE); |
| 72 | } |
Stefan Reinauer | 6540ae5 | 2007-07-12 16:35:42 +0000 | [diff] [blame] | 73 | |
Stefan Reinauer | 90b96b6 | 2010-01-13 21:00:23 +0000 | [diff] [blame] | 74 | #endif /* NVRAMTOOL_CMOS_LOWLEVEL_H */ |