[PATCH] drivers/char/nvram.c - CodingStyle + convert PRINT_PROC to seq_file

From: Wim Van Sebroeck
Date: Thu Dec 25 2008 - 07:57:23 EST

Hi Linus,

First of all a happy christmas to you and your family.

Please pull from 'master' branch of
git://git.kernel.org/pub/scm/linux/kernel/git/wim/linux-2.6-nvram.git
or if master.kernel.org hasn't synced up yet:
master.kernel.org:/pub/scm/linux/kernel/git/wim/linux-2.6-nvram.git

This will update the following files:

drivers/char/nvram.c | 264 +++++++++++++++++++++++----------------------------
1 file changed, 123 insertions(+), 141 deletions(-)

with these Changes:

Author: Wim Van Sebroeck <wim@xxxxxxxxx>
Date: Tue Nov 11 09:56:00 2008 +0000

[PATCH] nvram - convert PRINT_PROC to seq_file

Convert the /proc/drivers/nvram file from the old PRINT_PROC macro
to the new seq_file filesystem.

Signed-off-by: Wim Van Sebroeck <wim@xxxxxxxxx>

Author: Wim Van Sebroeck <wim@xxxxxxxxx>
Date: Tue Nov 11 09:44:07 2008 +0000

[PATCH] nvram - CodingStyle

Bring drivers/char/nvram.c in line with the Coding Style.

Signed-off-by: Wim Van Sebroeck <wim@xxxxxxxxx>

The Changes can also be looked at on:
http://www.kernel.org/git/?p=linux/kernel/git/wim/linux-2.6-nvram.git;a=summary

For completeness, I added the overal diff below.

Greetings,
Wim.

================================================================================
diff --git a/drivers/char/nvram.c b/drivers/char/nvram.c
index 8054ee8..88cee40 100644
--- a/drivers/char/nvram.c
+++ b/drivers/char/nvram.c
@@ -32,9 +32,10 @@
* added changelog
* 1.2 Erik Gilling: Cobalt Networks support
* Tim Hockin: general cleanup, Cobalt support
+ * 1.3 Wim Van Sebroeck: convert PRINT_PROC to seq_file
*/

-#define NVRAM_VERSION "1.2"
+#define NVRAM_VERSION "1.3"

#include <linux/module.h>
#include <linux/smp_lock.h>
@@ -46,7 +47,7 @@
/* select machine configuration */
#if defined(CONFIG_ATARI)
# define MACH ATARI
-#elif defined(__i386__) || defined(__x86_64__) || defined(__arm__) /* and others?? */
+#elif defined(__i386__) || defined(__x86_64__) || defined(__arm__) /* and ?? */
# define MACH PC
#else
# error Cannot build nvram driver for this machine configuration.
@@ -106,10 +107,11 @@
#include <linux/mc146818rtc.h>
#include <linux/init.h>
#include <linux/proc_fs.h>
+#include <linux/seq_file.h>
#include <linux/spinlock.h>
+#include <linux/io.h>
+#include <linux/uaccess.h>

-#include <asm/io.h>
-#include <asm/uaccess.h>
#include <asm/system.h>

static DEFINE_SPINLOCK(nvram_state_lock);
@@ -122,8 +124,8 @@ static int mach_check_checksum(void);
static void mach_set_checksum(void);

#ifdef CONFIG_PROC_FS
-static int mach_proc_infos(unsigned char *contents, char *buffer, int *len,
- off_t *begin, off_t offset, int size);
+static void mach_proc_infos(unsigned char *contents, struct seq_file *seq,
+ void *offset);
#endif

/*
@@ -133,18 +135,17 @@ static int mach_proc_infos(unsigned char *contents, char *buffer, int *len,
*
* It is worth noting that these functions all access bytes of general
* purpose memory in the NVRAM - that is to say, they all add the
- * NVRAM_FIRST_BYTE offset. Pass them offsets into NVRAM as if you did not
+ * NVRAM_FIRST_BYTE offset. Pass them offsets into NVRAM as if you did not
* know about the RTC cruft.
*/

-unsigned char
-__nvram_read_byte(int i)
+unsigned char __nvram_read_byte(int i)
{
return CMOS_READ(NVRAM_FIRST_BYTE + i);
}
+EXPORT_SYMBOL(__nvram_read_byte);

-unsigned char
-nvram_read_byte(int i)
+unsigned char nvram_read_byte(int i)
{
unsigned long flags;
unsigned char c;
@@ -154,16 +155,16 @@ nvram_read_byte(int i)
spin_unlock_irqrestore(&rtc_lock, flags);
return c;
}
+EXPORT_SYMBOL(nvram_read_byte);

/* This races nicely with trying to read with checksum checking (nvram_read) */
-void
-__nvram_write_byte(unsigned char c, int i)
+void __nvram_write_byte(unsigned char c, int i)
{
CMOS_WRITE(c, NVRAM_FIRST_BYTE + i);
}
+EXPORT_SYMBOL(__nvram_write_byte);

-void
-nvram_write_byte(unsigned char c, int i)
+void nvram_write_byte(unsigned char c, int i)
{
unsigned long flags;

@@ -171,15 +172,15 @@ nvram_write_byte(unsigned char c, int i)
__nvram_write_byte(c, i);
spin_unlock_irqrestore(&rtc_lock, flags);
}
+EXPORT_SYMBOL(nvram_write_byte);

-int
-__nvram_check_checksum(void)
+int __nvram_check_checksum(void)
{
return mach_check_checksum();
}
+EXPORT_SYMBOL(__nvram_check_checksum);

-int
-nvram_check_checksum(void)
+int nvram_check_checksum(void)
{
unsigned long flags;
int rv;
@@ -189,16 +190,15 @@ nvram_check_checksum(void)
spin_unlock_irqrestore(&rtc_lock, flags);
return rv;
}
+EXPORT_SYMBOL(nvram_check_checksum);

-static void
-__nvram_set_checksum(void)
+static void __nvram_set_checksum(void)
{
mach_set_checksum();
}

#if 0
-void
-nvram_set_checksum(void)
+void nvram_set_checksum(void)
{
unsigned long flags;

@@ -212,7 +212,7 @@ nvram_set_checksum(void)
* The are the file operation function for user access to /dev/nvram
*/

-static loff_t nvram_llseek(struct file *file,loff_t offset, int origin )
+static loff_t nvram_llseek(struct file *file, loff_t offset, int origin)
{
lock_kernel();
switch (origin) {
@@ -230,8 +230,8 @@ static loff_t nvram_llseek(struct file *file,loff_t offset, int origin )
return (offset >= 0) ? (file->f_pos = offset) : -EINVAL;
}

-static ssize_t
-nvram_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
+static ssize_t nvram_read(struct file *file, char __user *buf,
+ size_t count, loff_t *ppos)
{
unsigned char contents[NVRAM_BYTES];
unsigned i = *ppos;
@@ -254,13 +254,13 @@ nvram_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)

return tmp - contents;

- checksum_err:
+checksum_err:
spin_unlock_irq(&rtc_lock);
return -EIO;
}

-static ssize_t
-nvram_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
+static ssize_t nvram_write(struct file *file, const char __user *buf,
+ size_t count, loff_t *ppos)
{
unsigned char contents[NVRAM_BYTES];
unsigned i = *ppos;
@@ -287,14 +287,13 @@ nvram_write(struct file *file, const char __user *buf, size_t count, loff_t *ppo

return tmp - contents;

- checksum_err:
+checksum_err:
spin_unlock_irq(&rtc_lock);
return -EIO;
}

-static int
-nvram_ioctl(struct inode *inode, struct file *file,
- unsigned int cmd, unsigned long arg)
+static int nvram_ioctl(struct inode *inode, struct file *file,
+ unsigned int cmd, unsigned long arg)
{
int i;

@@ -315,7 +314,7 @@ nvram_ioctl(struct inode *inode, struct file *file,
return 0;

case NVRAM_SETCKS:
- /* just set checksum, contents unchanged (maybe useful after
+ /* just set checksum, contents unchanged (maybe useful after
* checksum garbaged somehow...) */
if (!capable(CAP_SYS_ADMIN))
return -EACCES;
@@ -330,8 +329,7 @@ nvram_ioctl(struct inode *inode, struct file *file,
}
}

-static int
-nvram_open(struct inode *inode, struct file *file)
+static int nvram_open(struct inode *inode, struct file *file)
{
lock_kernel();
spin_lock(&nvram_state_lock);
@@ -356,8 +354,7 @@ nvram_open(struct inode *inode, struct file *file)
return 0;
}

-static int
-nvram_release(struct inode *inode, struct file *file)
+static int nvram_release(struct inode *inode, struct file *file)
{
spin_lock(&nvram_state_lock);

@@ -375,48 +372,47 @@ nvram_release(struct inode *inode, struct file *file)
}

#ifndef CONFIG_PROC_FS
-static int
-nvram_read_proc(char *buffer, char **start, off_t offset,
- int size, int *eof, void *data)
+static int nvram_add_proc_fs(void)
{
return 0;
}
+
#else

-static int
-nvram_read_proc(char *buffer, char **start, off_t offset,
- int size, int *eof, void *data)
+static int nvram_proc_read(struct seq_file *seq, void *offset)
{
unsigned char contents[NVRAM_BYTES];
- int i, len = 0;
- off_t begin = 0;
+ int i = 0;

spin_lock_irq(&rtc_lock);
for (i = 0; i < NVRAM_BYTES; ++i)
contents[i] = __nvram_read_byte(i);
spin_unlock_irq(&rtc_lock);

- *eof = mach_proc_infos(contents, buffer, &len, &begin, offset, size);
+ mach_proc_infos(contents, seq, offset);

- if (offset >= begin + len)
- return 0;
- *start = buffer + (offset - begin);
- return (size < begin + len - offset) ? size : begin + len - offset;
+ return 0;
+}

+static int nvram_proc_open(struct inode *inode, struct file *file)
+{
+ return single_open(file, nvram_proc_read, NULL);
}

-/* This macro frees the machine specific function from bounds checking and
- * this like that... */
-#define PRINT_PROC(fmt,args...) \
- do { \
- *len += sprintf(buffer+*len, fmt, ##args); \
- if (*begin + *len > offset + size) \
- return 0; \
- if (*begin + *len < offset) { \
- *begin += *len; \
- *len = 0; \
- } \
- } while(0)
+static const struct file_operations nvram_proc_fops = {
+ .owner = THIS_MODULE,
+ .open = nvram_proc_open,
+ .read = seq_read,
+ .llseek = seq_lseek,
+ .release = single_release,
+};
+
+static int nvram_add_proc_fs(void)
+{
+ if (!proc_create("driver/nvram", 0, NULL, &nvram_proc_fops))
+ return -ENOMEM;
+ return 0;
+}

#endif /* CONFIG_PROC_FS */

@@ -436,8 +432,7 @@ static struct miscdevice nvram_dev = {
&nvram_fops
};

-static int __init
-nvram_init(void)
+static int __init nvram_init(void)
{
int ret;

@@ -451,23 +446,21 @@ nvram_init(void)
NVRAM_MINOR);
goto out;
}
- if (!create_proc_read_entry("driver/nvram", 0, NULL, nvram_read_proc,
- NULL)) {
+ ret = nvram_add_proc_fs();
+ if (ret) {
printk(KERN_ERR "nvram: can't create /proc/driver/nvram\n");
- ret = -ENOMEM;
goto outmisc;
}
ret = 0;
printk(KERN_INFO "Non-volatile memory driver v" NVRAM_VERSION "\n");
- out:
+out:
return ret;
- outmisc:
+outmisc:
misc_deregister(&nvram_dev);
goto out;
}

-static void __exit
-nvram_cleanup_module(void)
+static void __exit nvram_cleanup_module(void)
{
remove_proc_entry("driver/nvram", NULL);
misc_deregister(&nvram_dev);
@@ -482,8 +475,7 @@ module_exit(nvram_cleanup_module);

#if MACH == PC

-static int
-pc_check_checksum(void)
+static int pc_check_checksum(void)
{
int i;
unsigned short sum = 0;
@@ -493,11 +485,10 @@ pc_check_checksum(void)
sum += __nvram_read_byte(i);
expect = __nvram_read_byte(PC_CKS_LOC)<<8 |
__nvram_read_byte(PC_CKS_LOC+1);
- return ((sum & 0xffff) == expect);
+ return (sum & 0xffff) == expect;
}

-static void
-pc_set_checksum(void)
+static void pc_set_checksum(void)
{
int i;
unsigned short sum = 0;
@@ -522,9 +513,8 @@ static char *gfx_types[] = {
"monochrome",
};

-static int
-pc_proc_infos(unsigned char *nvram, char *buffer, int *len,
- off_t *begin, off_t offset, int size)
+static void pc_proc_infos(unsigned char *nvram, struct seq_file *seq,
+ void *offset)
{
int checksum;
int type;
@@ -533,56 +523,57 @@ pc_proc_infos(unsigned char *nvram, char *buffer, int *len,
checksum = __nvram_check_checksum();
spin_unlock_irq(&rtc_lock);

- PRINT_PROC("Checksum status: %svalid\n", checksum ? "" : "not ");
+ seq_printf(seq, "Checksum status: %svalid\n", checksum ? "" : "not ");

- PRINT_PROC("# floppies : %d\n",
+ seq_printf(seq, "# floppies : %d\n",
(nvram[6] & 1) ? (nvram[6] >> 6) + 1 : 0);
- PRINT_PROC("Floppy 0 type : ");
+ seq_printf(seq, "Floppy 0 type : ");
type = nvram[2] >> 4;
if (type < ARRAY_SIZE(floppy_types))
- PRINT_PROC("%s\n", floppy_types[type]);
+ seq_printf(seq, "%s\n", floppy_types[type]);
else
- PRINT_PROC("%d (unknown)\n", type);
- PRINT_PROC("Floppy 1 type : ");
+ seq_printf(seq, "%d (unknown)\n", type);
+ seq_printf(seq, "Floppy 1 type : ");
type = nvram[2] & 0x0f;
if (type < ARRAY_SIZE(floppy_types))
- PRINT_PROC("%s\n", floppy_types[type]);
+ seq_printf(seq, "%s\n", floppy_types[type]);
else
- PRINT_PROC("%d (unknown)\n", type);
+ seq_printf(seq, "%d (unknown)\n", type);

- PRINT_PROC("HD 0 type : ");
+ seq_printf(seq, "HD 0 type : ");
type = nvram[4] >> 4;
if (type)
- PRINT_PROC("%02x\n", type == 0x0f ? nvram[11] : type);
+ seq_printf(seq, "%02x\n", type == 0x0f ? nvram[11] : type);
else
- PRINT_PROC("none\n");
+ seq_printf(seq, "none\n");

- PRINT_PROC("HD 1 type : ");
+ seq_printf(seq, "HD 1 type : ");
type = nvram[4] & 0x0f;
if (type)
- PRINT_PROC("%02x\n", type == 0x0f ? nvram[12] : type);
+ seq_printf(seq, "%02x\n", type == 0x0f ? nvram[12] : type);
else
- PRINT_PROC("none\n");
+ seq_printf(seq, "none\n");

- PRINT_PROC("HD type 48 data: %d/%d/%d C/H/S, precomp %d, lz %d\n",
+ seq_printf(seq, "HD type 48 data: %d/%d/%d C/H/S, precomp %d, lz %d\n",
nvram[18] | (nvram[19] << 8),
nvram[20], nvram[25],
nvram[21] | (nvram[22] << 8), nvram[23] | (nvram[24] << 8));
- PRINT_PROC("HD type 49 data: %d/%d/%d C/H/S, precomp %d, lz %d\n",
+ seq_printf(seq, "HD type 49 data: %d/%d/%d C/H/S, precomp %d, lz %d\n",
nvram[39] | (nvram[40] << 8),
nvram[41], nvram[46],
nvram[42] | (nvram[43] << 8), nvram[44] | (nvram[45] << 8));

- PRINT_PROC("DOS base memory: %d kB\n", nvram[7] | (nvram[8] << 8));
- PRINT_PROC("Extended memory: %d kB (configured), %d kB (tested)\n",
+ seq_printf(seq, "DOS base memory: %d kB\n", nvram[7] | (nvram[8] << 8));
+ seq_printf(seq, "Extended memory: %d kB (configured), %d kB (tested)\n",
nvram[9] | (nvram[10] << 8), nvram[34] | (nvram[35] << 8));

- PRINT_PROC("Gfx adapter : %s\n", gfx_types[(nvram[6] >> 4) & 3]);
+ seq_printf(seq, "Gfx adapter : %s\n",
+ gfx_types[(nvram[6] >> 4) & 3]);

- PRINT_PROC("FPU : %sinstalled\n",
+ seq_printf(seq, "FPU : %sinstalled\n",
(nvram[6] & 2) ? "" : "not ");

- return 1;
+ return;
}
#endif

@@ -590,20 +581,18 @@ pc_proc_infos(unsigned char *nvram, char *buffer, int *len,

#if MACH == ATARI

-static int
-atari_check_checksum(void)
+static int atari_check_checksum(void)
{
int i;
unsigned char sum = 0;

for (i = ATARI_CKS_RANGE_START; i <= ATARI_CKS_RANGE_END; ++i)
sum += __nvram_read_byte(i);
- return (__nvram_read_byte(ATARI_CKS_LOC) == (~sum & 0xff) &&
- __nvram_read_byte(ATARI_CKS_LOC + 1) == (sum & 0xff));
+ return (__nvram_read_byte(ATARI_CKS_LOC) == (~sum & 0xff)) &&
+ (__nvram_read_byte(ATARI_CKS_LOC + 1) == (sum & 0xff));
}

-static void
-atari_set_checksum(void)
+static void atari_set_checksum(void)
{
int i;
unsigned char sum = 0;
@@ -654,82 +643,75 @@ static char *colors[] = {
"2", "4", "16", "256", "65536", "??", "??", "??"
};

-static int
-atari_proc_infos(unsigned char *nvram, char *buffer, int *len,
- off_t *begin, off_t offset, int size)
+static void atari_proc_infos(unsigned char *nvram, struct seq_file *seq,
+ void *offset)
{
int checksum = nvram_check_checksum();
int i;
unsigned vmode;

- PRINT_PROC("Checksum status : %svalid\n", checksum ? "" : "not ");
+ seq_printf(seq, "Checksum status : %svalid\n", checksum ? "" : "not ");

- PRINT_PROC("Boot preference : ");
+ seq_printf(seq, "Boot preference : ");
for (i = ARRAY_SIZE(boot_prefs) - 1; i >= 0; --i) {
if (nvram[1] == boot_prefs[i].val) {
- PRINT_PROC("%s\n", boot_prefs[i].name);
+ seq_printf(seq, "%s\n", boot_prefs[i].name);
break;
}
}
if (i < 0)
- PRINT_PROC("0x%02x (undefined)\n", nvram[1]);
+ seq_printf(seq, "0x%02x (undefined)\n", nvram[1]);

- PRINT_PROC("SCSI arbitration : %s\n",
+ seq_printf(seq, "SCSI arbitration : %s\n",
(nvram[16] & 0x80) ? "on" : "off");
- PRINT_PROC("SCSI host ID : ");
+ seq_printf(seq, "SCSI host ID : ");
if (nvram[16] & 0x80)
- PRINT_PROC("%d\n", nvram[16] & 7);
+ seq_printf(seq, "%d\n", nvram[16] & 7);
else
- PRINT_PROC("n/a\n");
+ seq_printf(seq, "n/a\n");

/* the following entries are defined only for the Falcon */
if ((atari_mch_cookie >> 16) != ATARI_MCH_FALCON)
- return 1;
+ return;

- PRINT_PROC("OS language : ");
+ seq_printf(seq, "OS language : ");
if (nvram[6] < ARRAY_SIZE(languages))
- PRINT_PROC("%s\n", languages[nvram[6]]);
+ seq_printf(seq, "%s\n", languages[nvram[6]]);
else
- PRINT_PROC("%u (undefined)\n", nvram[6]);
- PRINT_PROC("Keyboard language: ");
+ seq_printf(seq, "%u (undefined)\n", nvram[6]);
+ seq_printf(seq, "Keyboard language: ");
if (nvram[7] < ARRAY_SIZE(languages))
- PRINT_PROC("%s\n", languages[nvram[7]]);
+ seq_printf(seq, "%s\n", languages[nvram[7]]);
else
- PRINT_PROC("%u (undefined)\n", nvram[7]);
- PRINT_PROC("Date format : ");
- PRINT_PROC(dateformat[nvram[8] & 7],
+ seq_printf(seq, "%u (undefined)\n", nvram[7]);
+ seq_printf(seq, "Date format : ");
+ seq_printf(seq, dateformat[nvram[8] & 7],
nvram[9] ? nvram[9] : '/', nvram[9] ? nvram[9] : '/');
- PRINT_PROC(", %dh clock\n", nvram[8] & 16 ? 24 : 12);
- PRINT_PROC("Boot delay : ");
+ seq_printf(seq, ", %dh clock\n", nvram[8] & 16 ? 24 : 12);
+ seq_printf(seq, "Boot delay : ");
if (nvram[10] == 0)
- PRINT_PROC("default");
+ seq_printf(seq, "default");
else
- PRINT_PROC("%ds%s\n", nvram[10],
+ seq_printf(seq, "%ds%s\n", nvram[10],
nvram[10] < 8 ? ", no memory test" : "");

vmode = (nvram[14] << 8) || nvram[15];
- PRINT_PROC("Video mode : %s colors, %d columns, %s %s monitor\n",
+ seq_printf(seq,
+ "Video mode : %s colors, %d columns, %s %s monitor\n",
colors[vmode & 7],
vmode & 8 ? 80 : 40,
vmode & 16 ? "VGA" : "TV", vmode & 32 ? "PAL" : "NTSC");
- PRINT_PROC(" %soverscan, compat. mode %s%s\n",
+ seq_printf(seq, " %soverscan, compat. mode %s%s\n",
vmode & 64 ? "" : "no ",
vmode & 128 ? "on" : "off",
vmode & 256 ?
(vmode & 16 ? ", line doubling" : ", half screen") : "");

- return 1;
+ return;
}
#endif

#endif /* MACH == ATARI */

MODULE_LICENSE("GPL");
-
-EXPORT_SYMBOL(__nvram_read_byte);
-EXPORT_SYMBOL(nvram_read_byte);
-EXPORT_SYMBOL(__nvram_write_byte);
-EXPORT_SYMBOL(nvram_write_byte);
-EXPORT_SYMBOL(__nvram_check_checksum);
-EXPORT_SYMBOL(nvram_check_checksum);
MODULE_ALIAS_MISCDEV(NVRAM_MINOR);
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/