Rename drivers/cmos.c to drivers/nvram.c (trivial).
[coreboot.git] / payloads / libpayload / drivers / nvram.c
1 /*
2  * This file is part of the libpayload project.
3  *
4  * Copyright (C) 2008 Uwe Hermann <uwe@hermann-uwe.de>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29
30 /*
31  * Datasheet:
32  *  - Name: MC146818: Real-time Clock Plus RAM (RTC)
33  *  - PDF: http://www.freescale.com/files/microcontrollers/doc/data_sheet/MC146818.pdf
34  *  - Order number: MC146818/D
35  */
36
37 /*
38  * See also:
39  * http://bochs.sourceforge.net/techspec/CMOS-reference.txt
40  * http://www.bioscentral.com/misc/cmosmap.htm
41  */
42
43 #include <libpayload.h>
44
45 #define RTC_PORT 0x70
46
47 /**
48  * Read a byte from the specified NVRAM address.
49  * 
50  * @param addr The NVRAM address to read a byte from.
51  * @return The byte at the given NVRAM address.
52  */
53 u8 nvram_read(u8 addr)
54 {
55         outb(addr, RTC_PORT);
56         return inb(RTC_PORT + 1);
57 }
58
59 /**
60  * Write a byte to the specified NVRAM address.
61  * 
62  * @param val The byte to write to NVRAM.
63  * @param addr The NVRAM address to write to.
64  */
65 void nvram_write(u8 val, u8 addr)
66 {
67         outb(addr, RTC_PORT);
68         outb(val, RTC_PORT + 1);
69 }