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
35 * 1.3 Wim Van Sebroeck: convert PRINT_PROC to seq_file
38 #define NVRAM_VERSION "1.3"
40 #include <linux/module.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 ?? */
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/ioport.h>
104 #include <linux/fcntl.h>
105 #include <linux/mc146818rtc.h>
106 #include <linux/init.h>
107 #include <linux/proc_fs.h>
108 #include <linux/seq_file.h>
109 #include <linux/spinlock.h>
110 #include <linux/io.h>
111 #include <linux/uaccess.h>
112 #include <linux/mutex.h>
114 #include <asm/system.h>
116 static DEFINE_MUTEX(nvram_mutex);
117 static DEFINE_SPINLOCK(nvram_state_lock);
118 static int nvram_open_cnt; /* #times opened */
119 static int nvram_open_mode; /* special open modes */
120 #define NVRAM_WRITE 1 /* opened for writing (exclusive) */
121 #define NVRAM_EXCL 2 /* opened with O_EXCL */
123 static int mach_check_checksum(void);
124 static void mach_set_checksum(void);
126 #ifdef CONFIG_PROC_FS
127 static void mach_proc_infos(unsigned char *contents, struct seq_file *seq,
132 * These functions are provided to be called internally or by other parts of
133 * the kernel. It's up to the caller to ensure correct checksum before reading
134 * or after writing (needs to be done only once).
136 * It is worth noting that these functions all access bytes of general
137 * purpose memory in the NVRAM - that is to say, they all add the
138 * NVRAM_FIRST_BYTE offset. Pass them offsets into NVRAM as if you did not
139 * know about the RTC cruft.
142 unsigned char __nvram_read_byte(int i)
144 return CMOS_READ(NVRAM_FIRST_BYTE + i);
146 EXPORT_SYMBOL(__nvram_read_byte);
148 unsigned char nvram_read_byte(int i)
153 spin_lock_irqsave(&rtc_lock, flags);
154 c = __nvram_read_byte(i);
155 spin_unlock_irqrestore(&rtc_lock, flags);
158 EXPORT_SYMBOL(nvram_read_byte);
160 /* This races nicely with trying to read with checksum checking (nvram_read) */
161 void __nvram_write_byte(unsigned char c, int i)
163 CMOS_WRITE(c, NVRAM_FIRST_BYTE + i);
165 EXPORT_SYMBOL(__nvram_write_byte);
167 void nvram_write_byte(unsigned char c, int i)
171 spin_lock_irqsave(&rtc_lock, flags);
172 __nvram_write_byte(c, i);
173 spin_unlock_irqrestore(&rtc_lock, flags);
175 EXPORT_SYMBOL(nvram_write_byte);
177 int __nvram_check_checksum(void)
179 return mach_check_checksum();
181 EXPORT_SYMBOL(__nvram_check_checksum);
183 int nvram_check_checksum(void)
188 spin_lock_irqsave(&rtc_lock, flags);
189 rv = __nvram_check_checksum();
190 spin_unlock_irqrestore(&rtc_lock, flags);
193 EXPORT_SYMBOL(nvram_check_checksum);
195 static void __nvram_set_checksum(void)
201 void 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)
222 offset += file->f_pos;
225 offset += NVRAM_BYTES;
231 return (offset >= 0) ? (file->f_pos = offset) : -EINVAL;
234 static ssize_t nvram_read(struct file *file, char __user *buf,
235 size_t count, loff_t *ppos)
237 unsigned char contents[NVRAM_BYTES];
241 spin_lock_irq(&rtc_lock);
243 if (!__nvram_check_checksum())
246 for (tmp = contents; count-- > 0 && i < NVRAM_BYTES; ++i, ++tmp)
247 *tmp = __nvram_read_byte(i);
249 spin_unlock_irq(&rtc_lock);
251 if (copy_to_user(buf, contents, tmp - contents))
256 return tmp - contents;
259 spin_unlock_irq(&rtc_lock);
263 static ssize_t nvram_write(struct file *file, const char __user *buf,
264 size_t count, loff_t *ppos)
266 unsigned char contents[NVRAM_BYTES];
270 if (i >= NVRAM_BYTES)
271 return 0; /* Past EOF */
273 if (count > NVRAM_BYTES - i)
274 count = NVRAM_BYTES - i;
275 if (count > NVRAM_BYTES)
276 return -EFAULT; /* Can't happen, but prove it to gcc */
278 if (copy_from_user(contents, buf, count))
281 spin_lock_irq(&rtc_lock);
283 if (!__nvram_check_checksum())
286 for (tmp = contents; count--; ++i, ++tmp)
287 __nvram_write_byte(*tmp, i);
289 __nvram_set_checksum();
291 spin_unlock_irq(&rtc_lock);
295 return tmp - contents;
298 spin_unlock_irq(&rtc_lock);
302 static long nvram_ioctl(struct file *file, unsigned int cmd,
310 /* initialize NVRAM contents and checksum */
311 if (!capable(CAP_SYS_ADMIN))
314 mutex_lock(&nvram_mutex);
315 spin_lock_irq(&rtc_lock);
317 for (i = 0; i < NVRAM_BYTES; ++i)
318 __nvram_write_byte(0, i);
319 __nvram_set_checksum();
321 spin_unlock_irq(&rtc_lock);
322 mutex_unlock(&nvram_mutex);
326 /* just set checksum, contents unchanged (maybe useful after
327 * checksum garbaged somehow...) */
328 if (!capable(CAP_SYS_ADMIN))
331 mutex_lock(&nvram_mutex);
332 spin_lock_irq(&rtc_lock);
333 __nvram_set_checksum();
334 spin_unlock_irq(&rtc_lock);
335 mutex_unlock(&nvram_mutex);
343 static int nvram_open(struct inode *inode, struct file *file)
345 spin_lock(&nvram_state_lock);
347 if ((nvram_open_cnt && (file->f_flags & O_EXCL)) ||
348 (nvram_open_mode & NVRAM_EXCL) ||
349 ((file->f_mode & FMODE_WRITE) && (nvram_open_mode & NVRAM_WRITE))) {
350 spin_unlock(&nvram_state_lock);
354 if (file->f_flags & O_EXCL)
355 nvram_open_mode |= NVRAM_EXCL;
356 if (file->f_mode & FMODE_WRITE)
357 nvram_open_mode |= NVRAM_WRITE;
360 spin_unlock(&nvram_state_lock);
365 static int nvram_release(struct inode *inode, struct file *file)
367 spin_lock(&nvram_state_lock);
371 /* if only one instance is open, clear the EXCL bit */
372 if (nvram_open_mode & NVRAM_EXCL)
373 nvram_open_mode &= ~NVRAM_EXCL;
374 if (file->f_mode & FMODE_WRITE)
375 nvram_open_mode &= ~NVRAM_WRITE;
377 spin_unlock(&nvram_state_lock);
382 #ifndef CONFIG_PROC_FS
383 static int nvram_add_proc_fs(void)
390 static int nvram_proc_read(struct seq_file *seq, void *offset)
392 unsigned char contents[NVRAM_BYTES];
395 spin_lock_irq(&rtc_lock);
396 for (i = 0; i < NVRAM_BYTES; ++i)
397 contents[i] = __nvram_read_byte(i);
398 spin_unlock_irq(&rtc_lock);
400 mach_proc_infos(contents, seq, offset);
405 static int nvram_proc_open(struct inode *inode, struct file *file)
407 return single_open(file, nvram_proc_read, NULL);
410 static const struct file_operations nvram_proc_fops = {
411 .owner = THIS_MODULE,
412 .open = nvram_proc_open,
415 .release = single_release,
418 static int nvram_add_proc_fs(void)
420 if (!proc_create("driver/nvram", 0, NULL, &nvram_proc_fops))
425 #endif /* CONFIG_PROC_FS */
427 static const struct file_operations nvram_fops = {
428 .owner = THIS_MODULE,
429 .llseek = nvram_llseek,
431 .write = nvram_write,
432 .unlocked_ioctl = nvram_ioctl,
434 .release = nvram_release,
437 static struct miscdevice nvram_dev = {
443 static int __init nvram_init(void)
447 /* First test whether the driver should init at all */
448 if (!CHECK_DRIVER_INIT())
451 ret = misc_register(&nvram_dev);
453 printk(KERN_ERR "nvram: can't misc_register on minor=%d\n",
457 ret = nvram_add_proc_fs();
459 printk(KERN_ERR "nvram: can't create /proc/driver/nvram\n");
463 printk(KERN_INFO "Non-volatile memory driver v" NVRAM_VERSION "\n");
467 misc_deregister(&nvram_dev);
471 static void __exit nvram_cleanup_module(void)
473 remove_proc_entry("driver/nvram", NULL);
474 misc_deregister(&nvram_dev);
477 module_init(nvram_init);
478 module_exit(nvram_cleanup_module);
481 * Machine specific functions
486 static int 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;
499 static void pc_set_checksum(void)
502 unsigned short sum = 0;
504 for (i = PC_CKS_RANGE_START; i <= PC_CKS_RANGE_END; ++i)
505 sum += __nvram_read_byte(i);
506 __nvram_write_byte(sum >> 8, PC_CKS_LOC);
507 __nvram_write_byte(sum & 0xff, PC_CKS_LOC + 1);
510 #ifdef CONFIG_PROC_FS
512 static char *floppy_types[] = {
513 "none", "5.25'' 360k", "5.25'' 1.2M", "3.5'' 720k", "3.5'' 1.44M",
514 "3.5'' 2.88M", "3.5'' 2.88M"
517 static char *gfx_types[] = {
518 "EGA, VGA, ... (with BIOS)",
524 static void pc_proc_infos(unsigned char *nvram, struct seq_file *seq,
530 spin_lock_irq(&rtc_lock);
531 checksum = __nvram_check_checksum();
532 spin_unlock_irq(&rtc_lock);
534 seq_printf(seq, "Checksum status: %svalid\n", checksum ? "" : "not ");
536 seq_printf(seq, "# floppies : %d\n",
537 (nvram[6] & 1) ? (nvram[6] >> 6) + 1 : 0);
538 seq_printf(seq, "Floppy 0 type : ");
539 type = nvram[2] >> 4;
540 if (type < ARRAY_SIZE(floppy_types))
541 seq_printf(seq, "%s\n", floppy_types[type]);
543 seq_printf(seq, "%d (unknown)\n", type);
544 seq_printf(seq, "Floppy 1 type : ");
545 type = nvram[2] & 0x0f;
546 if (type < ARRAY_SIZE(floppy_types))
547 seq_printf(seq, "%s\n", floppy_types[type]);
549 seq_printf(seq, "%d (unknown)\n", type);
551 seq_printf(seq, "HD 0 type : ");
552 type = nvram[4] >> 4;
554 seq_printf(seq, "%02x\n", type == 0x0f ? nvram[11] : type);
556 seq_printf(seq, "none\n");
558 seq_printf(seq, "HD 1 type : ");
559 type = nvram[4] & 0x0f;
561 seq_printf(seq, "%02x\n", type == 0x0f ? nvram[12] : type);
563 seq_printf(seq, "none\n");
565 seq_printf(seq, "HD type 48 data: %d/%d/%d C/H/S, precomp %d, lz %d\n",
566 nvram[18] | (nvram[19] << 8),
567 nvram[20], nvram[25],
568 nvram[21] | (nvram[22] << 8), nvram[23] | (nvram[24] << 8));
569 seq_printf(seq, "HD type 49 data: %d/%d/%d C/H/S, precomp %d, lz %d\n",
570 nvram[39] | (nvram[40] << 8),
571 nvram[41], nvram[46],
572 nvram[42] | (nvram[43] << 8), nvram[44] | (nvram[45] << 8));
574 seq_printf(seq, "DOS base memory: %d kB\n", nvram[7] | (nvram[8] << 8));
575 seq_printf(seq, "Extended memory: %d kB (configured), %d kB (tested)\n",
576 nvram[9] | (nvram[10] << 8), nvram[34] | (nvram[35] << 8));
578 seq_printf(seq, "Gfx adapter : %s\n",
579 gfx_types[(nvram[6] >> 4) & 3]);
581 seq_printf(seq, "FPU : %sinstalled\n",
582 (nvram[6] & 2) ? "" : "not ");
588 #endif /* MACH == PC */
592 static int atari_check_checksum(void)
595 unsigned char sum = 0;
597 for (i = ATARI_CKS_RANGE_START; i <= ATARI_CKS_RANGE_END; ++i)
598 sum += __nvram_read_byte(i);
599 return (__nvram_read_byte(ATARI_CKS_LOC) == (~sum & 0xff)) &&
600 (__nvram_read_byte(ATARI_CKS_LOC + 1) == (sum & 0xff));
603 static void atari_set_checksum(void)
606 unsigned char sum = 0;
608 for (i = ATARI_CKS_RANGE_START; i <= ATARI_CKS_RANGE_END; ++i)
609 sum += __nvram_read_byte(i);
610 __nvram_write_byte(~sum, ATARI_CKS_LOC);
611 __nvram_write_byte(sum, ATARI_CKS_LOC + 1);
614 #ifdef CONFIG_PROC_FS
622 { 0x20, "NetBSD (?)" },
624 { 0x00, "unspecified" }
627 static char *languages[] = {
639 static char *dateformat[] = {
650 static char *colors[] = {
651 "2", "4", "16", "256", "65536", "??", "??", "??"
654 static void atari_proc_infos(unsigned char *nvram, struct seq_file *seq,
657 int checksum = nvram_check_checksum();
661 seq_printf(seq, "Checksum status : %svalid\n", checksum ? "" : "not ");
663 seq_printf(seq, "Boot preference : ");
664 for (i = ARRAY_SIZE(boot_prefs) - 1; i >= 0; --i) {
665 if (nvram[1] == boot_prefs[i].val) {
666 seq_printf(seq, "%s\n", boot_prefs[i].name);
671 seq_printf(seq, "0x%02x (undefined)\n", nvram[1]);
673 seq_printf(seq, "SCSI arbitration : %s\n",
674 (nvram[16] & 0x80) ? "on" : "off");
675 seq_printf(seq, "SCSI host ID : ");
676 if (nvram[16] & 0x80)
677 seq_printf(seq, "%d\n", nvram[16] & 7);
679 seq_printf(seq, "n/a\n");
681 /* the following entries are defined only for the Falcon */
682 if ((atari_mch_cookie >> 16) != ATARI_MCH_FALCON)
685 seq_printf(seq, "OS language : ");
686 if (nvram[6] < ARRAY_SIZE(languages))
687 seq_printf(seq, "%s\n", languages[nvram[6]]);
689 seq_printf(seq, "%u (undefined)\n", nvram[6]);
690 seq_printf(seq, "Keyboard language: ");
691 if (nvram[7] < ARRAY_SIZE(languages))
692 seq_printf(seq, "%s\n", languages[nvram[7]]);
694 seq_printf(seq, "%u (undefined)\n", nvram[7]);
695 seq_printf(seq, "Date format : ");
696 seq_printf(seq, dateformat[nvram[8] & 7],
697 nvram[9] ? nvram[9] : '/', nvram[9] ? nvram[9] : '/');
698 seq_printf(seq, ", %dh clock\n", nvram[8] & 16 ? 24 : 12);
699 seq_printf(seq, "Boot delay : ");
701 seq_printf(seq, "default");
703 seq_printf(seq, "%ds%s\n", nvram[10],
704 nvram[10] < 8 ? ", no memory test" : "");
706 vmode = (nvram[14] << 8) || nvram[15];
708 "Video mode : %s colors, %d columns, %s %s monitor\n",
711 vmode & 16 ? "VGA" : "TV", vmode & 32 ? "PAL" : "NTSC");
712 seq_printf(seq, " %soverscan, compat. mode %s%s\n",
713 vmode & 64 ? "" : "no ",
714 vmode & 128 ? "on" : "off",
716 (vmode & 16 ? ", line doubling" : ", half screen") : "");
722 #endif /* MACH == ATARI */
724 MODULE_LICENSE("GPL");
725 MODULE_ALIAS_MISCDEV(NVRAM_MINOR);