Commit 109b3a89 authored by Finn Thain's avatar Finn Thain Committed by Greg Kroah-Hartman
Browse files

char/nvram: Implement NVRAM read/write methods 



Refactor the RTC "CMOS" NVRAM functions so that they can be used as
arch_nvram_ops methods. Checksumming logic is moved from the misc device
operations to the nvram read/write operations. This makes the misc device
implementation more generic.

This preserves the locking mechanism such that "read if checksum valid"
and "write and update checksum" remain atomic operations.

Some platforms implement byte-range read/write methods which are similar
to file_operations struct methods. Other platforms provide only
byte-at-a-time methods. The former are more efficient but may be
unavailable so fall back on the latter methods when necessary.

Tested-by: default avatarStan Johnson <userm57@yahoo.com>
Signed-off-by: default avatarFinn Thain <fthain@telegraphics.com.au>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 2d58636e

drivers/char/nvram.c

+74 −46
Original line number Diff line number Diff line
@@ -41,6 +41,7 @@ 
#include <linux/init.h>

#include <linux/proc_fs.h>

#include <linux/seq_file.h>

#include <linux/slab.h>

#include <linux/spinlock.h>

#include <linux/io.h>

#include <linux/uaccess.h>
@@ -161,7 +162,46 @@ static ssize_t pc_nvram_get_size(void) 
	return NVRAM_BYTES;

}



static ssize_t pc_nvram_read(char *buf, size_t count, loff_t *ppos)

{

	char *p = buf;

	loff_t i;



	spin_lock_irq(&rtc_lock);

	if (!__nvram_check_checksum()) {

		spin_unlock_irq(&rtc_lock);

		return -EIO;

	}

	for (i = *ppos; count > 0 && i < NVRAM_BYTES; --count, ++i, ++p)

		*p = __nvram_read_byte(i);

	spin_unlock_irq(&rtc_lock);



	*ppos = i;

	return p - buf;

}



static ssize_t pc_nvram_write(char *buf, size_t count, loff_t *ppos)

{

	char *p = buf;

	loff_t i;



	spin_lock_irq(&rtc_lock);

	if (!__nvram_check_checksum()) {

		spin_unlock_irq(&rtc_lock);

		return -EIO;

	}

	for (i = *ppos; count > 0 && i < NVRAM_BYTES; --count, ++i, ++p)

		__nvram_write_byte(*p, i);

	__nvram_set_checksum();

	spin_unlock_irq(&rtc_lock);



	*ppos = i;

	return p - buf;

}



const struct nvram_ops arch_nvram_ops = {

	.read           = pc_nvram_read,

	.write          = pc_nvram_write,

	.read_byte      = pc_nvram_read_byte,

	.write_byte     = pc_nvram_write_byte,

	.get_size       = pc_nvram_get_size,
@@ -184,69 +224,57 @@ static loff_t nvram_misc_llseek(struct file *file, loff_t offset, int origin) 
static ssize_t nvram_misc_read(struct file *file, char __user *buf,

			       size_t count, loff_t *ppos)

{

	unsigned char contents[NVRAM_BYTES];

	unsigned i = *ppos;

	unsigned char *tmp;



	spin_lock_irq(&rtc_lock);

	char *tmp;

	ssize_t ret;



	if (!__nvram_check_checksum())

		goto checksum_err;



	for (tmp = contents; count-- > 0 && i < NVRAM_BYTES; ++i, ++tmp)

		*tmp = __nvram_read_byte(i);

	if (!access_ok(buf, count))

		return -EFAULT;

	if (*ppos >= nvram_size)

		return 0;



	spin_unlock_irq(&rtc_lock);

	count = min_t(size_t, count, nvram_size - *ppos);

	count = min_t(size_t, count, PAGE_SIZE);



	if (copy_to_user(buf, contents, tmp - contents))

		return -EFAULT;

	tmp = kmalloc(count, GFP_KERNEL);

	if (!tmp)

		return -ENOMEM;



	*ppos = i;

	ret = nvram_read(tmp, count, ppos);

	if (ret <= 0)

		goto out;



	return tmp - contents;

	if (copy_to_user(buf, tmp, ret)) {

		*ppos -= ret;

		ret = -EFAULT;

	}



checksum_err:

	spin_unlock_irq(&rtc_lock);

	return -EIO;

out:

	kfree(tmp);

	return ret;

}



static ssize_t nvram_misc_write(struct file *file, const char __user *buf,

				size_t count, loff_t *ppos)

{

	unsigned char contents[NVRAM_BYTES];

	unsigned i = *ppos;

	unsigned char *tmp;



	if (i >= NVRAM_BYTES)

		return 0;	/* Past EOF */



	if (count > NVRAM_BYTES - i)

		count = NVRAM_BYTES - i;

	if (count > NVRAM_BYTES)

		return -EFAULT;	/* Can't happen, but prove it to gcc */

	char *tmp;

	ssize_t ret;



	if (copy_from_user(contents, buf, count))

	if (!access_ok(buf, count))

		return -EFAULT;

	if (*ppos >= nvram_size)

		return 0;



	spin_lock_irq(&rtc_lock);



	if (!__nvram_check_checksum())

		goto checksum_err;



	for (tmp = contents; count--; ++i, ++tmp)

		__nvram_write_byte(*tmp, i);



	__nvram_set_checksum();



	spin_unlock_irq(&rtc_lock);



	*ppos = i;

	count = min_t(size_t, count, nvram_size - *ppos);

	count = min_t(size_t, count, PAGE_SIZE);



	return tmp - contents;

	tmp = memdup_user(buf, count);

	if (IS_ERR(tmp))

		return PTR_ERR(tmp);



checksum_err:

	spin_unlock_irq(&rtc_lock);

	return -EIO;

	ret = nvram_write(tmp, count, ppos);

	kfree(tmp);

	return ret;

}



static long nvram_misc_ioctl(struct file *file, unsigned int cmd,

include/linux/nvram.h

+30 −2
Original line number Diff line number Diff line
@@ -66,18 +66,46 @@ static inline void nvram_write_byte(unsigned char val, int addr) 
#endif

}



static inline ssize_t nvram_read_bytes(char *buf, size_t count, loff_t *ppos)

{

	ssize_t nvram_size = nvram_get_size();

	loff_t i;

	char *p = buf;



	if (nvram_size < 0)

		return nvram_size;

	for (i = *ppos; count > 0 && i < nvram_size; ++i, ++p, --count)

		*p = nvram_read_byte(i);

	*ppos = i;

	return p - buf;

}



static inline ssize_t nvram_write_bytes(char *buf, size_t count, loff_t *ppos)

{

	ssize_t nvram_size = nvram_get_size();

	loff_t i;

	char *p = buf;



	if (nvram_size < 0)

		return nvram_size;

	for (i = *ppos; count > 0 && i < nvram_size; ++i, ++p, --count)

		nvram_write_byte(*p, i);

	*ppos = i;

	return p - buf;

}



static inline ssize_t nvram_read(char *buf, size_t count, loff_t *ppos)

{

	if (arch_nvram_ops.read)

		return arch_nvram_ops.read(buf, count, ppos);

	return -ENODEV;

	return nvram_read_bytes(buf, count, ppos);

}



static inline ssize_t nvram_write(char *buf, size_t count, loff_t *ppos)

{

	if (arch_nvram_ops.write)

		return arch_nvram_ops.write(buf, count, ppos);

	return -ENODEV;

	return nvram_write_bytes(buf, count, ppos);

}



#endif  /* _LINUX_NVRAM_H */

CRA Git | Maintained and supported by SUSTech CRA and CCSE