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 kernel/time/ntp.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>
115 static DEFINE_MUTEX(nvram_mutex);
116 static DEFINE_SPINLOCK(nvram_state_lock);
117 static int nvram_open_cnt; /* #times opened */
118 static int nvram_open_mode; /* special open modes */
119 #define NVRAM_WRITE 1 /* opened for writing (exclusive) */
120 #define NVRAM_EXCL 2 /* opened with O_EXCL */
122 static int mach_check_checksum(void);
123 static void mach_set_checksum(void);
125 #ifdef CONFIG_PROC_FS
126 static void mach_proc_infos(unsigned char *contents, struct seq_file *seq,
131 * These functions are provided to be called internally or by other parts of
132 * the kernel. It's up to the caller to ensure correct checksum before reading
133 * or after writing (needs to be done only once).
135 * It is worth noting that these functions all access bytes of general
136 * purpose memory in the NVRAM - that is to say, they all add the
137 * NVRAM_FIRST_BYTE offset. Pass them offsets into NVRAM as if you did not
138 * know about the RTC cruft.
141 unsigned char __nvram_read_byte(int i)
143 return CMOS_READ(NVRAM_FIRST_BYTE + i);
145 EXPORT_SYMBOL(__nvram_read_byte);
147 unsigned char 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);
157 EXPORT_SYMBOL(nvram_read_byte);
159 /* This races nicely with trying to read with checksum checking (nvram_read) */
160 void __nvram_write_byte(unsigned char c, int i)
162 CMOS_WRITE(c, NVRAM_FIRST_BYTE + i);
164 EXPORT_SYMBOL(__nvram_write_byte);
166 void 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);
174 EXPORT_SYMBOL(nvram_write_byte);
176 int __nvram_check_checksum(void)
178 return mach_check_checksum();
180 EXPORT_SYMBOL(__nvram_check_checksum);
182 int nvram_check_checksum(void)
187 spin_lock_irqsave(&rtc_lock, flags);
188 rv = __nvram_check_checksum();
189 spin_unlock_irqrestore(&rtc_lock, flags);
192 EXPORT_SYMBOL(nvram_check_checksum);
194 static void __nvram_set_checksum(void)
200 void nvram_set_checksum(void)
204 spin_lock_irqsave(&rtc_lock, flags);
205 __nvram_set_checksum();
206 spin_unlock_irqrestore(&rtc_lock, flags);
211 * The are the file operation function for user access to /dev/nvram
214 static loff_t nvram_llseek(struct file *file, loff_t offset, int origin)
221 offset += file->f_pos;
224 offset += NVRAM_BYTES;
230 return (offset >= 0) ? (file->f_pos = offset) : -EINVAL;
233 static ssize_t nvram_read(struct file *file, char __user *buf,
234 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);
262 static ssize_t nvram_write(struct file *file, const char __user *buf,
263 size_t count, loff_t *ppos)
265 unsigned char contents[NVRAM_BYTES];
269 if (i >= NVRAM_BYTES)
270 return 0; /* Past EOF */
272 if (count > NVRAM_BYTES - i)
273 count = NVRAM_BYTES - i;
274 if (count > NVRAM_BYTES)
275 return -EFAULT; /* Can't happen, but prove it to gcc */
277 if (copy_from_user(contents, buf, count))
280 spin_lock_irq(&rtc_lock);
282 if (!__nvram_check_checksum())
285 for (tmp = contents; count--; ++i, ++tmp)
286 __nvram_write_byte(*tmp, i);
288 __nvram_set_checksum();
290 spin_unlock_irq(&rtc_lock);
294 return tmp - contents;
297 spin_unlock_irq(&rtc_lock);
301 static long nvram_ioctl(struct file *file, unsigned int cmd,
309 /* initialize NVRAM contents and checksum */
310 if (!capable(CAP_SYS_ADMIN))
313 mutex_lock(&nvram_mutex);
314 spin_lock_irq(&rtc_lock);
316 for (i = 0; i < NVRAM_BYTES; ++i)
317 __nvram_write_byte(0, i);
318 __nvram_set_checksum();
320 spin_unlock_irq(&rtc_lock);
321 mutex_unlock(&nvram_mutex);
325 /* just set checksum, contents unchanged (maybe useful after
326 * checksum garbaged somehow...) */
327 if (!capable(CAP_SYS_ADMIN))
330 mutex_lock(&nvram_mutex);
331 spin_lock_irq(&rtc_lock);
332 __nvram_set_checksum();
333 spin_unlock_irq(&rtc_lock);
334 mutex_unlock(&nvram_mutex);
342 static int nvram_open(struct inode *inode, struct file *file)
344 spin_lock(&nvram_state_lock);
346 if ((nvram_open_cnt && (file->f_flags & O_EXCL)) ||
347 (nvram_open_mode & NVRAM_EXCL) ||
348 ((file->f_mode & FMODE_WRITE) && (nvram_open_mode & NVRAM_WRITE))) {
349 spin_unlock(&nvram_state_lock);
353 if (file->f_flags & O_EXCL)
354 nvram_open_mode |= NVRAM_EXCL;
355 if (file->f_mode & FMODE_WRITE)
356 nvram_open_mode |= NVRAM_WRITE;
359 spin_unlock(&nvram_state_lock);
364 static int nvram_release(struct inode *inode, struct file *file)
366 spin_lock(&nvram_state_lock);
370 /* if only one instance is open, clear the EXCL bit */
371 if (nvram_open_mode & NVRAM_EXCL)
372 nvram_open_mode &= ~NVRAM_EXCL;
373 if (file->f_mode & FMODE_WRITE)
374 nvram_open_mode &= ~NVRAM_WRITE;
376 spin_unlock(&nvram_state_lock);
381 #ifndef CONFIG_PROC_FS
382 static int nvram_add_proc_fs(void)
389 static int nvram_proc_read(struct seq_file *seq, void *offset)
391 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 mach_proc_infos(contents, seq, offset);
404 static int nvram_proc_open(struct inode *inode, struct file *file)
406 return single_open(file, nvram_proc_read, NULL);
409 static const struct file_operations nvram_proc_fops = {
410 .owner = THIS_MODULE,
411 .open = nvram_proc_open,
414 .release = single_release,
417 static int nvram_add_proc_fs(void)
419 if (!proc_create("driver/nvram", 0, NULL, &nvram_proc_fops))
424 #endif /* CONFIG_PROC_FS */
426 static const struct file_operations nvram_fops = {
427 .owner = THIS_MODULE,
428 .llseek = nvram_llseek,
430 .write = nvram_write,
431 .unlocked_ioctl = nvram_ioctl,
433 .release = nvram_release,
436 static struct miscdevice nvram_dev = {
442 static int __init nvram_init(void)
446 /* First test whether the driver should init at all */
447 if (!CHECK_DRIVER_INIT())
450 ret = misc_register(&nvram_dev);
452 printk(KERN_ERR "nvram: can't misc_register on minor=%d\n",
456 ret = nvram_add_proc_fs();
458 printk(KERN_ERR "nvram: can't create /proc/driver/nvram\n");
462 printk(KERN_INFO "Non-volatile memory driver v" NVRAM_VERSION "\n");
466 misc_deregister(&nvram_dev);
470 static void __exit 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
485 static int pc_check_checksum(void)
488 unsigned short sum = 0;
489 unsigned short expect;
491 for (i = PC_CKS_RANGE_START; i <= PC_CKS_RANGE_END; ++i)
492 sum += __nvram_read_byte(i);
493 expect = __nvram_read_byte(PC_CKS_LOC)<<8 |
494 __nvram_read_byte(PC_CKS_LOC+1);
495 return (sum & 0xffff) == expect;
498 static void pc_set_checksum(void)
501 unsigned short sum = 0;
503 for (i = PC_CKS_RANGE_START; i <= PC_CKS_RANGE_END; ++i)
504 sum += __nvram_read_byte(i);
505 __nvram_write_byte(sum >> 8, PC_CKS_LOC);
506 __nvram_write_byte(sum & 0xff, PC_CKS_LOC + 1);
509 #ifdef CONFIG_PROC_FS
511 static char *floppy_types[] = {
512 "none", "5.25'' 360k", "5.25'' 1.2M", "3.5'' 720k", "3.5'' 1.44M",
513 "3.5'' 2.88M", "3.5'' 2.88M"
516 static char *gfx_types[] = {
517 "EGA, VGA, ... (with BIOS)",
523 static void pc_proc_infos(unsigned char *nvram, struct seq_file *seq,
529 spin_lock_irq(&rtc_lock);
530 checksum = __nvram_check_checksum();
531 spin_unlock_irq(&rtc_lock);
533 seq_printf(seq, "Checksum status: %svalid\n", checksum ? "" : "not ");
535 seq_printf(seq, "# floppies : %d\n",
536 (nvram[6] & 1) ? (nvram[6] >> 6) + 1 : 0);
537 seq_printf(seq, "Floppy 0 type : ");
538 type = nvram[2] >> 4;
539 if (type < ARRAY_SIZE(floppy_types))
540 seq_printf(seq, "%s\n", floppy_types[type]);
542 seq_printf(seq, "%d (unknown)\n", type);
543 seq_printf(seq, "Floppy 1 type : ");
544 type = nvram[2] & 0x0f;
545 if (type < ARRAY_SIZE(floppy_types))
546 seq_printf(seq, "%s\n", floppy_types[type]);
548 seq_printf(seq, "%d (unknown)\n", type);
550 seq_printf(seq, "HD 0 type : ");
551 type = nvram[4] >> 4;
553 seq_printf(seq, "%02x\n", type == 0x0f ? nvram[11] : type);
555 seq_printf(seq, "none\n");
557 seq_printf(seq, "HD 1 type : ");
558 type = nvram[4] & 0x0f;
560 seq_printf(seq, "%02x\n", type == 0x0f ? nvram[12] : type);
562 seq_printf(seq, "none\n");
564 seq_printf(seq, "HD type 48 data: %d/%d/%d C/H/S, precomp %d, lz %d\n",
565 nvram[18] | (nvram[19] << 8),
566 nvram[20], nvram[25],
567 nvram[21] | (nvram[22] << 8), nvram[23] | (nvram[24] << 8));
568 seq_printf(seq, "HD type 49 data: %d/%d/%d C/H/S, precomp %d, lz %d\n",
569 nvram[39] | (nvram[40] << 8),
570 nvram[41], nvram[46],
571 nvram[42] | (nvram[43] << 8), nvram[44] | (nvram[45] << 8));
573 seq_printf(seq, "DOS base memory: %d kB\n", nvram[7] | (nvram[8] << 8));
574 seq_printf(seq, "Extended memory: %d kB (configured), %d kB (tested)\n",
575 nvram[9] | (nvram[10] << 8), nvram[34] | (nvram[35] << 8));
577 seq_printf(seq, "Gfx adapter : %s\n",
578 gfx_types[(nvram[6] >> 4) & 3]);
580 seq_printf(seq, "FPU : %sinstalled\n",
581 (nvram[6] & 2) ? "" : "not ");
587 #endif /* MACH == PC */
591 static int atari_check_checksum(void)
594 unsigned char sum = 0;
596 for (i = ATARI_CKS_RANGE_START; i <= ATARI_CKS_RANGE_END; ++i)
597 sum += __nvram_read_byte(i);
598 return (__nvram_read_byte(ATARI_CKS_LOC) == (~sum & 0xff)) &&
599 (__nvram_read_byte(ATARI_CKS_LOC + 1) == (sum & 0xff));
602 static void atari_set_checksum(void)
605 unsigned char sum = 0;
607 for (i = ATARI_CKS_RANGE_START; i <= ATARI_CKS_RANGE_END; ++i)
608 sum += __nvram_read_byte(i);
609 __nvram_write_byte(~sum, ATARI_CKS_LOC);
610 __nvram_write_byte(sum, ATARI_CKS_LOC + 1);
613 #ifdef CONFIG_PROC_FS
621 { 0x20, "NetBSD (?)" },
623 { 0x00, "unspecified" }
626 static char *languages[] = {
638 static char *dateformat[] = {
649 static char *colors[] = {
650 "2", "4", "16", "256", "65536", "??", "??", "??"
653 static void atari_proc_infos(unsigned char *nvram, struct seq_file *seq,
656 int checksum = nvram_check_checksum();
660 seq_printf(seq, "Checksum status : %svalid\n", checksum ? "" : "not ");
662 seq_printf(seq, "Boot preference : ");
663 for (i = ARRAY_SIZE(boot_prefs) - 1; i >= 0; --i) {
664 if (nvram[1] == boot_prefs[i].val) {
665 seq_printf(seq, "%s\n", boot_prefs[i].name);
670 seq_printf(seq, "0x%02x (undefined)\n", nvram[1]);
672 seq_printf(seq, "SCSI arbitration : %s\n",
673 (nvram[16] & 0x80) ? "on" : "off");
674 seq_printf(seq, "SCSI host ID : ");
675 if (nvram[16] & 0x80)
676 seq_printf(seq, "%d\n", nvram[16] & 7);
678 seq_printf(seq, "n/a\n");
680 /* the following entries are defined only for the Falcon */
681 if ((atari_mch_cookie >> 16) != ATARI_MCH_FALCON)
684 seq_printf(seq, "OS language : ");
685 if (nvram[6] < ARRAY_SIZE(languages))
686 seq_printf(seq, "%s\n", languages[nvram[6]]);
688 seq_printf(seq, "%u (undefined)\n", nvram[6]);
689 seq_printf(seq, "Keyboard language: ");
690 if (nvram[7] < ARRAY_SIZE(languages))
691 seq_printf(seq, "%s\n", languages[nvram[7]]);
693 seq_printf(seq, "%u (undefined)\n", nvram[7]);
694 seq_printf(seq, "Date format : ");
695 seq_printf(seq, dateformat[nvram[8] & 7],
696 nvram[9] ? nvram[9] : '/', nvram[9] ? nvram[9] : '/');
697 seq_printf(seq, ", %dh clock\n", nvram[8] & 16 ? 24 : 12);
698 seq_printf(seq, "Boot delay : ");
700 seq_printf(seq, "default");
702 seq_printf(seq, "%ds%s\n", nvram[10],
703 nvram[10] < 8 ? ", no memory test" : "");
705 vmode = (nvram[14] << 8) || nvram[15];
707 "Video mode : %s colors, %d columns, %s %s monitor\n",
710 vmode & 16 ? "VGA" : "TV", vmode & 32 ? "PAL" : "NTSC");
711 seq_printf(seq, " %soverscan, compat. mode %s%s\n",
712 vmode & 64 ? "" : "no ",
713 vmode & 128 ? "on" : "off",
715 (vmode & 16 ? ", line doubling" : ", half screen") : "");
721 #endif /* MACH == ATARI */
723 MODULE_LICENSE("GPL");
724 MODULE_ALIAS_MISCDEV(NVRAM_MINOR);