2 * CMOS/NV-RAM driver for Linux
4 * Copyright (C) 1997 Roman Hodek <Roman.Hodek@informatik.uni-erlangen.de>
5 * idea by and with help from Richard Jelinek <rj@suse.de>
6 * Portions copyright (c) 2001,2002 Sun Microsystems (thockin@sun.com)
8 * This driver allows you to access the contents of the non-volatile memory in
9 * the mc146818rtc.h real-time clock. This chip is built into all PCs and into
10 * many Atari machines. In the former it's called "CMOS-RAM", in the latter
11 * "NVRAM" (NV stands for non-volatile).
13 * The data are supplied as a (seekable) character device, /dev/nvram. The
14 * size of this file is dependent on the controller. The usual size is 114,
15 * the number of freely available bytes in the memory (i.e., not used by the
18 * Checksums over the NVRAM contents are managed by this driver. In case of a
19 * bad checksum, reads and writes return -EIO. The checksum can be initialized
20 * to a sane state either by ioctl(NVRAM_INIT) (clear whole NVRAM) or
21 * ioctl(NVRAM_SETCKS) (doesn't change contents, just makes checksum valid
22 * again; use with care!)
24 * This file also provides some functions for other parts of the kernel that
25 * want to access the NVRAM: nvram_{read,write,check_checksum,set_checksum}.
26 * Obviously this can be used only if this driver is always configured into
27 * the kernel and is not a module. Since the functions are used by some Atari
28 * drivers, this is the case on the Atari.
31 * 1.1 Cesar Barros: SMP locking fixes
33 * 1.2 Erik Gilling: Cobalt Networks support
34 * Tim Hockin: general cleanup, Cobalt support
37 #define NVRAM_VERSION "1.2"
39 #include <linux/module.h>
40 #include <linux/smp_lock.h>
41 #include <linux/nvram.h>
46 /* select machine configuration */
47 #if defined(CONFIG_ATARI)
49 #elif defined(__i386__) || defined(__x86_64__) || defined(__arm__) /* and others?? */
52 # error Cannot build nvram driver for this machine configuration.
58 #define CHECK_DRIVER_INIT() 1
60 /* On PCs, the checksum is built only over bytes 2..31 */
61 #define PC_CKS_RANGE_START 2
62 #define PC_CKS_RANGE_END 31
64 #define NVRAM_BYTES (128-NVRAM_FIRST_BYTE)
66 #define mach_check_checksum pc_check_checksum
67 #define mach_set_checksum pc_set_checksum
68 #define mach_proc_infos pc_proc_infos
74 /* Special parameters for RTC in Atari machines */
75 #include <asm/atarihw.h>
76 #include <asm/atariints.h>
77 #define RTC_PORT(x) (TT_RTC_BAS + 2*(x))
78 #define CHECK_DRIVER_INIT() (MACH_IS_ATARI && ATARIHW_PRESENT(TT_CLK))
80 #define NVRAM_BYTES 50
82 /* On Ataris, the checksum is over all bytes except the checksum bytes
83 * themselves; these are at the very end */
84 #define ATARI_CKS_RANGE_START 0
85 #define ATARI_CKS_RANGE_END 47
86 #define ATARI_CKS_LOC 48
88 #define mach_check_checksum atari_check_checksum
89 #define mach_set_checksum atari_set_checksum
90 #define mach_proc_infos atari_proc_infos
94 /* Note that *all* calls to CMOS_READ and CMOS_WRITE must be done with
95 * rtc_lock held. Due to the index-port/data-port design of the RTC, we
96 * don't want two different things trying to get to it at once. (e.g. the
97 * periodic 11 min sync from time.c vs. this driver.)
100 #include <linux/types.h>
101 #include <linux/errno.h>
102 #include <linux/miscdevice.h>
103 #include <linux/slab.h>
104 #include <linux/ioport.h>
105 #include <linux/fcntl.h>
106 #include <linux/mc146818rtc.h>
107 #include <linux/init.h>
108 #include <linux/proc_fs.h>
109 #include <linux/spinlock.h>
112 #include <asm/uaccess.h>
113 #include <asm/system.h>
115 static DEFINE_SPINLOCK(nvram_state_lock
);
116 static int nvram_open_cnt
; /* #times opened */
117 static int nvram_open_mode
; /* special open modes */
118 #define NVRAM_WRITE 1 /* opened for writing (exclusive) */
119 #define NVRAM_EXCL 2 /* opened with O_EXCL */
121 static int mach_check_checksum(void);
122 static void mach_set_checksum(void);
124 #ifdef CONFIG_PROC_FS
125 static int mach_proc_infos(unsigned char *contents
, char *buffer
, int *len
,
126 off_t
*begin
, off_t offset
, int size
);
130 * These functions are provided to be called internally or by other parts of
131 * the kernel. It's up to the caller to ensure correct checksum before reading
132 * or after writing (needs to be done only once).
134 * It is worth noting that these functions all access bytes of general
135 * purpose memory in the NVRAM - that is to say, they all add the
136 * NVRAM_FIRST_BYTE offset. Pass them offsets into NVRAM as if you did not
137 * know about the RTC cruft.
141 __nvram_read_byte(int i
)
143 return CMOS_READ(NVRAM_FIRST_BYTE
+ i
);
147 nvram_read_byte(int i
)
152 spin_lock_irqsave(&rtc_lock
, flags
);
153 c
= __nvram_read_byte(i
);
154 spin_unlock_irqrestore(&rtc_lock
, flags
);
158 /* This races nicely with trying to read with checksum checking (nvram_read) */
160 __nvram_write_byte(unsigned char c
, int i
)
162 CMOS_WRITE(c
, NVRAM_FIRST_BYTE
+ i
);
166 nvram_write_byte(unsigned char c
, int i
)
170 spin_lock_irqsave(&rtc_lock
, flags
);
171 __nvram_write_byte(c
, i
);
172 spin_unlock_irqrestore(&rtc_lock
, flags
);
176 __nvram_check_checksum(void)
178 return mach_check_checksum();
182 nvram_check_checksum(void)
187 spin_lock_irqsave(&rtc_lock
, flags
);
188 rv
= __nvram_check_checksum();
189 spin_unlock_irqrestore(&rtc_lock
, flags
);
194 __nvram_set_checksum(void)
201 nvram_set_checksum(void)
205 spin_lock_irqsave(&rtc_lock
, flags
);
206 __nvram_set_checksum();
207 spin_unlock_irqrestore(&rtc_lock
, flags
);
212 * The are the file operation function for user access to /dev/nvram
215 static loff_t
nvram_llseek(struct file
*file
,loff_t offset
, int origin
)
223 offset
+= file
->f_pos
;
226 offset
+= NVRAM_BYTES
;
230 return (offset
>= 0) ? (file
->f_pos
= offset
) : -EINVAL
;
234 nvram_read(struct file
*file
, char __user
*buf
, size_t count
, loff_t
*ppos
)
236 unsigned char contents
[NVRAM_BYTES
];
240 spin_lock_irq(&rtc_lock
);
242 if (!__nvram_check_checksum())
245 for (tmp
= contents
; count
-- > 0 && i
< NVRAM_BYTES
; ++i
, ++tmp
)
246 *tmp
= __nvram_read_byte(i
);
248 spin_unlock_irq(&rtc_lock
);
250 if (copy_to_user(buf
, contents
, tmp
- contents
))
255 return tmp
- contents
;
258 spin_unlock_irq(&rtc_lock
);
263 nvram_write(struct file
*file
, const char __user
*buf
, size_t count
, loff_t
*ppos
)
265 unsigned char contents
[NVRAM_BYTES
];
270 len
= (NVRAM_BYTES
- i
) < count
? (NVRAM_BYTES
- i
) : count
;
271 if (copy_from_user(contents
, buf
, len
))
274 spin_lock_irq(&rtc_lock
);
276 if (!__nvram_check_checksum())
279 for (tmp
= contents
; count
-- > 0 && i
< NVRAM_BYTES
; ++i
, ++tmp
)
280 __nvram_write_byte(*tmp
, i
);
282 __nvram_set_checksum();
284 spin_unlock_irq(&rtc_lock
);
288 return tmp
- contents
;
291 spin_unlock_irq(&rtc_lock
);
296 nvram_ioctl(struct inode
*inode
, struct file
*file
,
297 unsigned int cmd
, unsigned long arg
)
304 /* initialize NVRAM contents and checksum */
305 if (!capable(CAP_SYS_ADMIN
))
308 spin_lock_irq(&rtc_lock
);
310 for (i
= 0; i
< NVRAM_BYTES
; ++i
)
311 __nvram_write_byte(0, i
);
312 __nvram_set_checksum();
314 spin_unlock_irq(&rtc_lock
);
318 /* just set checksum, contents unchanged (maybe useful after
319 * checksum garbaged somehow...) */
320 if (!capable(CAP_SYS_ADMIN
))
323 spin_lock_irq(&rtc_lock
);
324 __nvram_set_checksum();
325 spin_unlock_irq(&rtc_lock
);
334 nvram_open(struct inode
*inode
, struct file
*file
)
337 spin_lock(&nvram_state_lock
);
339 if ((nvram_open_cnt
&& (file
->f_flags
& O_EXCL
)) ||
340 (nvram_open_mode
& NVRAM_EXCL
) ||
341 ((file
->f_mode
& FMODE_WRITE
) && (nvram_open_mode
& NVRAM_WRITE
))) {
342 spin_unlock(&nvram_state_lock
);
347 if (file
->f_flags
& O_EXCL
)
348 nvram_open_mode
|= NVRAM_EXCL
;
349 if (file
->f_mode
& FMODE_WRITE
)
350 nvram_open_mode
|= NVRAM_WRITE
;
353 spin_unlock(&nvram_state_lock
);
360 nvram_release(struct inode
*inode
, struct file
*file
)
362 spin_lock(&nvram_state_lock
);
366 /* if only one instance is open, clear the EXCL bit */
367 if (nvram_open_mode
& NVRAM_EXCL
)
368 nvram_open_mode
&= ~NVRAM_EXCL
;
369 if (file
->f_mode
& FMODE_WRITE
)
370 nvram_open_mode
&= ~NVRAM_WRITE
;
372 spin_unlock(&nvram_state_lock
);
377 #ifndef CONFIG_PROC_FS
379 nvram_read_proc(char *buffer
, char **start
, off_t offset
,
380 int size
, int *eof
, void *data
)
387 nvram_read_proc(char *buffer
, char **start
, off_t offset
,
388 int size
, int *eof
, void *data
)
390 unsigned char contents
[NVRAM_BYTES
];
394 spin_lock_irq(&rtc_lock
);
395 for (i
= 0; i
< NVRAM_BYTES
; ++i
)
396 contents
[i
] = __nvram_read_byte(i
);
397 spin_unlock_irq(&rtc_lock
);
399 *eof
= mach_proc_infos(contents
, buffer
, &len
, &begin
, offset
, size
);
401 if (offset
>= begin
+ len
)
403 *start
= buffer
+ (offset
- begin
);
404 return (size
< begin
+ len
- offset
) ? size
: begin
+ len
- offset
;
408 /* This macro frees the machine specific function from bounds checking and
409 * this like that... */
410 #define PRINT_PROC(fmt,args...) \
412 *len += sprintf(buffer+*len, fmt, ##args); \
413 if (*begin + *len > offset + size) \
415 if (*begin + *len < offset) { \
421 #endif /* CONFIG_PROC_FS */
423 static const struct file_operations nvram_fops
= {
424 .owner
= THIS_MODULE
,
425 .llseek
= nvram_llseek
,
427 .write
= nvram_write
,
428 .ioctl
= nvram_ioctl
,
430 .release
= nvram_release
,
433 static struct miscdevice nvram_dev
= {
444 /* First test whether the driver should init at all */
445 if (!CHECK_DRIVER_INIT())
448 ret
= misc_register(&nvram_dev
);
450 printk(KERN_ERR
"nvram: can't misc_register on minor=%d\n",
454 if (!create_proc_read_entry("driver/nvram", 0, NULL
, nvram_read_proc
,
456 printk(KERN_ERR
"nvram: can't create /proc/driver/nvram\n");
461 printk(KERN_INFO
"Non-volatile memory driver v" NVRAM_VERSION
"\n");
465 misc_deregister(&nvram_dev
);
470 nvram_cleanup_module(void)
472 remove_proc_entry("driver/nvram", NULL
);
473 misc_deregister(&nvram_dev
);
476 module_init(nvram_init
);
477 module_exit(nvram_cleanup_module
);
480 * Machine specific functions
486 pc_check_checksum(void)
489 unsigned short sum
= 0;
490 unsigned short expect
;
492 for (i
= PC_CKS_RANGE_START
; i
<= PC_CKS_RANGE_END
; ++i
)
493 sum
+= __nvram_read_byte(i
);
494 expect
= __nvram_read_byte(PC_CKS_LOC
)<<8 |
495 __nvram_read_byte(PC_CKS_LOC
+1);
496 return ((sum
& 0xffff) == expect
);
500 pc_set_checksum(void)
503 unsigned short sum
= 0;
505 for (i
= PC_CKS_RANGE_START
; i
<= PC_CKS_RANGE_END
; ++i
)
506 sum
+= __nvram_read_byte(i
);
507 __nvram_write_byte(sum
>> 8, PC_CKS_LOC
);
508 __nvram_write_byte(sum
& 0xff, PC_CKS_LOC
+ 1);
511 #ifdef CONFIG_PROC_FS
513 static char *floppy_types
[] = {
514 "none", "5.25'' 360k", "5.25'' 1.2M", "3.5'' 720k", "3.5'' 1.44M",
515 "3.5'' 2.88M", "3.5'' 2.88M"
518 static char *gfx_types
[] = {
519 "EGA, VGA, ... (with BIOS)",
526 pc_proc_infos(unsigned char *nvram
, char *buffer
, int *len
,
527 off_t
*begin
, off_t offset
, int size
)
532 spin_lock_irq(&rtc_lock
);
533 checksum
= __nvram_check_checksum();
534 spin_unlock_irq(&rtc_lock
);
536 PRINT_PROC("Checksum status: %svalid\n", checksum
? "" : "not ");
538 PRINT_PROC("# floppies : %d\n",
539 (nvram
[6] & 1) ? (nvram
[6] >> 6) + 1 : 0);
540 PRINT_PROC("Floppy 0 type : ");
541 type
= nvram
[2] >> 4;
542 if (type
< ARRAY_SIZE(floppy_types
))
543 PRINT_PROC("%s\n", floppy_types
[type
]);
545 PRINT_PROC("%d (unknown)\n", type
);
546 PRINT_PROC("Floppy 1 type : ");
547 type
= nvram
[2] & 0x0f;
548 if (type
< ARRAY_SIZE(floppy_types
))
549 PRINT_PROC("%s\n", floppy_types
[type
]);
551 PRINT_PROC("%d (unknown)\n", type
);
553 PRINT_PROC("HD 0 type : ");
554 type
= nvram
[4] >> 4;
556 PRINT_PROC("%02x\n", type
== 0x0f ? nvram
[11] : type
);
558 PRINT_PROC("none\n");
560 PRINT_PROC("HD 1 type : ");
561 type
= nvram
[4] & 0x0f;
563 PRINT_PROC("%02x\n", type
== 0x0f ? nvram
[12] : type
);
565 PRINT_PROC("none\n");
567 PRINT_PROC("HD type 48 data: %d/%d/%d C/H/S, precomp %d, lz %d\n",
568 nvram
[18] | (nvram
[19] << 8),
569 nvram
[20], nvram
[25],
570 nvram
[21] | (nvram
[22] << 8), nvram
[23] | (nvram
[24] << 8));
571 PRINT_PROC("HD type 49 data: %d/%d/%d C/H/S, precomp %d, lz %d\n",
572 nvram
[39] | (nvram
[40] << 8),
573 nvram
[41], nvram
[46],
574 nvram
[42] | (nvram
[43] << 8), nvram
[44] | (nvram
[45] << 8));
576 PRINT_PROC("DOS base memory: %d kB\n", nvram
[7] | (nvram
[8] << 8));
577 PRINT_PROC("Extended memory: %d kB (configured), %d kB (tested)\n",
578 nvram
[9] | (nvram
[10] << 8), nvram
[34] | (nvram
[35] << 8));
580 PRINT_PROC("Gfx adapter : %s\n", gfx_types
[(nvram
[6] >> 4) & 3]);
582 PRINT_PROC("FPU : %sinstalled\n",
583 (nvram
[6] & 2) ? "" : "not ");
589 #endif /* MACH == PC */
594 atari_check_checksum(void)
597 unsigned char sum
= 0;
599 for (i
= ATARI_CKS_RANGE_START
; i
<= ATARI_CKS_RANGE_END
; ++i
)
600 sum
+= __nvram_read_byte(i
);
601 return (__nvram_read_byte(ATARI_CKS_LOC
) == (~sum
& 0xff) &&
602 __nvram_read_byte(ATARI_CKS_LOC
+ 1) == (sum
& 0xff));
606 atari_set_checksum(void)
609 unsigned char sum
= 0;
611 for (i
= ATARI_CKS_RANGE_START
; i
<= ATARI_CKS_RANGE_END
; ++i
)
612 sum
+= __nvram_read_byte(i
);
613 __nvram_write_byte(~sum
, ATARI_CKS_LOC
);
614 __nvram_write_byte(sum
, ATARI_CKS_LOC
+ 1);
617 #ifdef CONFIG_PROC_FS
625 { 0x20, "NetBSD (?)" },
627 { 0x00, "unspecified" }
630 static char *languages
[] = {
642 static char *dateformat
[] = {
653 static char *colors
[] = {
654 "2", "4", "16", "256", "65536", "??", "??", "??"
658 atari_proc_infos(unsigned char *nvram
, char *buffer
, int *len
,
659 off_t
*begin
, off_t offset
, int size
)
661 int checksum
= nvram_check_checksum();
665 PRINT_PROC("Checksum status : %svalid\n", checksum
? "" : "not ");
667 PRINT_PROC("Boot preference : ");
668 for (i
= ARRAY_SIZE(boot_prefs
) - 1; i
>= 0; --i
) {
669 if (nvram
[1] == boot_prefs
[i
].val
) {
670 PRINT_PROC("%s\n", boot_prefs
[i
].name
);
675 PRINT_PROC("0x%02x (undefined)\n", nvram
[1]);
677 PRINT_PROC("SCSI arbitration : %s\n",
678 (nvram
[16] & 0x80) ? "on" : "off");
679 PRINT_PROC("SCSI host ID : ");
680 if (nvram
[16] & 0x80)
681 PRINT_PROC("%d\n", nvram
[16] & 7);
685 /* the following entries are defined only for the Falcon */
686 if ((atari_mch_cookie
>> 16) != ATARI_MCH_FALCON
)
689 PRINT_PROC("OS language : ");
690 if (nvram
[6] < ARRAY_SIZE(languages
))
691 PRINT_PROC("%s\n", languages
[nvram
[6]]);
693 PRINT_PROC("%u (undefined)\n", nvram
[6]);
694 PRINT_PROC("Keyboard language: ");
695 if (nvram
[7] < ARRAY_SIZE(languages
))
696 PRINT_PROC("%s\n", languages
[nvram
[7]]);
698 PRINT_PROC("%u (undefined)\n", nvram
[7]);
699 PRINT_PROC("Date format : ");
700 PRINT_PROC(dateformat
[nvram
[8] & 7],
701 nvram
[9] ? nvram
[9] : '/', nvram
[9] ? nvram
[9] : '/');
702 PRINT_PROC(", %dh clock\n", nvram
[8] & 16 ? 24 : 12);
703 PRINT_PROC("Boot delay : ");
705 PRINT_PROC("default");
707 PRINT_PROC("%ds%s\n", nvram
[10],
708 nvram
[10] < 8 ? ", no memory test" : "");
710 vmode
= (nvram
[14] << 8) || nvram
[15];
711 PRINT_PROC("Video mode : %s colors, %d columns, %s %s monitor\n",
714 vmode
& 16 ? "VGA" : "TV", vmode
& 32 ? "PAL" : "NTSC");
715 PRINT_PROC(" %soverscan, compat. mode %s%s\n",
716 vmode
& 64 ? "" : "no ",
717 vmode
& 128 ? "on" : "off",
719 (vmode
& 16 ? ", line doubling" : ", half screen") : "");
725 #endif /* MACH == ATARI */
727 MODULE_LICENSE("GPL");
729 EXPORT_SYMBOL(__nvram_read_byte
);
730 EXPORT_SYMBOL(nvram_read_byte
);
731 EXPORT_SYMBOL(__nvram_write_byte
);
732 EXPORT_SYMBOL(nvram_write_byte
);
733 EXPORT_SYMBOL(__nvram_check_checksum
);
734 EXPORT_SYMBOL(nvram_check_checksum
);
735 MODULE_ALIAS_MISCDEV(NVRAM_MINOR
);