[mirror_ubuntu-eoan-kernel.git] / drivers / i2c / chips / eeprom.c

/*
    eeprom.c - Part of lm_sensors, Linux kernel modules for hardware
               monitoring
    Copyright (C) 1998, 1999  Frodo Looijaard <frodol@dds.nl> and
			       Philip Edelbrock <phil@netroedge.com>
    Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
    Copyright (C) 2003 IBM Corp.

    2004-01-16  Jean Delvare <khali@linux-fr.org>
    Divide the eeprom in 32-byte (arbitrary) slices. This significantly
    speeds sensors up, as well as various scripts using the eeprom
    module.

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/jiffies.h>
#include <linux/i2c.h>
#include <linux/mutex.h>

/* Addresses to scan */
static const unsigned short normal_i2c[] = { 0x50, 0x51, 0x52, 0x53, 0x54,
					0x55, 0x56, 0x57, I2C_CLIENT_END };

/* Insmod parameters */
I2C_CLIENT_INSMOD_1(eeprom);


/* Size of EEPROM in bytes */
#define EEPROM_SIZE		256

/* possible types of eeprom devices */
enum eeprom_nature {
	UNKNOWN,
	VAIO,
};

/* Each client has this additional data */
struct eeprom_data {
	struct i2c_client client;
	struct mutex update_lock;
	u8 valid;			/* bitfield, bit!=0 if slice is valid */
	unsigned long last_updated[8];	/* In jiffies, 8 slices */
	u8 data[EEPROM_SIZE];		/* Register values */
	enum eeprom_nature nature;
};


static int eeprom_attach_adapter(struct i2c_adapter *adapter);
static int eeprom_detect(struct i2c_adapter *adapter, int address, int kind);
static int eeprom_detach_client(struct i2c_client *client);

/* This is the driver that will be inserted */
static struct i2c_driver eeprom_driver = {
	.driver = {
		.name	= "eeprom",
	},
	.attach_adapter	= eeprom_attach_adapter,
	.detach_client	= eeprom_detach_client,
};

static void eeprom_update_client(struct i2c_client *client, u8 slice)
{
	struct eeprom_data *data = i2c_get_clientdata(client);
	int i, j;

	mutex_lock(&data->update_lock);

	if (!(data->valid & (1 << slice)) ||
	    time_after(jiffies, data->last_updated[slice] + 300 * HZ)) {
		dev_dbg(&client->dev, "Starting eeprom update, slice %u\n", slice);

		if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_I2C_BLOCK)) {
			for (i = slice << 5; i < (slice + 1) << 5; i += 32)
				if (i2c_smbus_read_i2c_block_data(client, i,
							32, data->data + i)
							!= 32)
					goto exit;
		} else {
			if (i2c_smbus_write_byte(client, slice << 5)) {
				dev_dbg(&client->dev, "eeprom read start has failed!\n");
				goto exit;
			}
			for (i = slice << 5; i < (slice + 1) << 5; i++) {
				j = i2c_smbus_read_byte(client);
				if (j < 0)
					goto exit;
				data->data[i] = (u8) j;
			}
		}
		data->last_updated[slice] = jiffies;
		data->valid |= (1 << slice);
	}
exit:
	mutex_unlock(&data->update_lock);
}

static ssize_t eeprom_read(struct kobject *kobj, struct bin_attribute *bin_attr,
			   char *buf, loff_t off, size_t count)
{
	struct i2c_client *client = to_i2c_client(container_of(kobj, struct device, kobj));
	struct eeprom_data *data = i2c_get_clientdata(client);
	u8 slice;

	if (off > EEPROM_SIZE)
		return 0;
	if (off + count > EEPROM_SIZE)
		count = EEPROM_SIZE - off;

	/* Only refresh slices which contain requested bytes */
	for (slice = off >> 5; slice <= (off + count - 1) >> 5; slice++)
		eeprom_update_client(client, slice);

	/* Hide Vaio private settings to regular users:
	   - BIOS passwords: bytes 0x00 to 0x0f
	   - UUID: bytes 0x10 to 0x1f
	   - Serial number: 0xc0 to 0xdf */
	if (data->nature == VAIO && !capable(CAP_SYS_ADMIN)) {
		int i;

		for (i = 0; i < count; i++) {
			if ((off + i <= 0x1f) ||
			    (off + i >= 0xc0 && off + i <= 0xdf))
				buf[i] = 0;
			else
				buf[i] = data->data[off + i];
		}
	} else {
		memcpy(buf, &data->data[off], count);
	}

	return count;
}

static struct bin_attribute eeprom_attr = {
	.attr = {
		.name = "eeprom",
		.mode = S_IRUGO,
	},
	.size = EEPROM_SIZE,
	.read = eeprom_read,
};

static int eeprom_attach_adapter(struct i2c_adapter *adapter)
{
	return i2c_probe(adapter, &addr_data, eeprom_detect);
}

/* This function is called by i2c_probe */
static int eeprom_detect(struct i2c_adapter *adapter, int address, int kind)
{
	struct i2c_client *new_client;
	struct eeprom_data *data;
	int err = 0;

	/* There are three ways we can read the EEPROM data:
	   (1) I2C block reads (faster, but unsupported by most adapters)
	   (2) Consecutive byte reads (100% overhead)
	   (3) Regular byte data reads (200% overhead)
	   The third method is not implemented by this driver because all
	   known adapters support at least the second. */
	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_READ_BYTE_DATA
					    | I2C_FUNC_SMBUS_BYTE))
		goto exit;

	if (!(data = kzalloc(sizeof(struct eeprom_data), GFP_KERNEL))) {
		err = -ENOMEM;
		goto exit;
	}

	new_client = &data->client;
	memset(data->data, 0xff, EEPROM_SIZE);
	i2c_set_clientdata(new_client, data);
	new_client->addr = address;
	new_client->adapter = adapter;
	new_client->driver = &eeprom_driver;
	new_client->flags = 0;

	/* Fill in the remaining client fields */
	strlcpy(new_client->name, "eeprom", I2C_NAME_SIZE);
	data->valid = 0;
	mutex_init(&data->update_lock);
	data->nature = UNKNOWN;

	/* Tell the I2C layer a new client has arrived */
	if ((err = i2c_attach_client(new_client)))
		goto exit_kfree;

	/* Detect the Vaio nature of EEPROMs.
	   We use the "PCG-" or "VGN-" prefix as the signature. */
	if (address == 0x57) {
		char name[4];

		name[0] = i2c_smbus_read_byte_data(new_client, 0x80);
		name[1] = i2c_smbus_read_byte(new_client);
		name[2] = i2c_smbus_read_byte(new_client);
		name[3] = i2c_smbus_read_byte(new_client);

		if (!memcmp(name, "PCG-", 4) || !memcmp(name, "VGN-", 4)) {
			dev_info(&new_client->dev, "Vaio EEPROM detected, "
				 "enabling privacy protection\n");
			data->nature = VAIO;
		}
	}

	/* create the sysfs eeprom file */
	err = sysfs_create_bin_file(&new_client->dev.kobj, &eeprom_attr);
	if (err)
		goto exit_detach;

	return 0;

exit_detach:
	i2c_detach_client(new_client);
exit_kfree:
	kfree(data);
exit:
	return err;
}

static int eeprom_detach_client(struct i2c_client *client)
{
	int err;

	sysfs_remove_bin_file(&client->dev.kobj, &eeprom_attr);

	err = i2c_detach_client(client);
	if (err)
		return err;

	kfree(i2c_get_clientdata(client));

	return 0;
}

static int __init eeprom_init(void)
{
	return i2c_add_driver(&eeprom_driver);
}

static void __exit eeprom_exit(void)
{
	i2c_del_driver(&eeprom_driver);
}


MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
		"Philip Edelbrock <phil@netroedge.com> and "
		"Greg Kroah-Hartman <greg@kroah.com>");
MODULE_DESCRIPTION("I2C EEPROM driver");
MODULE_LICENSE("GPL");

module_init(eeprom_init);
module_exit(eeprom_exit);
Commit	Line	Data
1da177e4 LT	1	/*
	2	eeprom.c - Part of lm_sensors, Linux kernel modules for hardware
	3	monitoring
	4	Copyright (C) 1998, 1999 Frodo Looijaard <frodol@dds.nl> and
	5	Philip Edelbrock <phil@netroedge.com>
	6	Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
	7	Copyright (C) 2003 IBM Corp.
	8
	9	2004-01-16 Jean Delvare <khali@linux-fr.org>
	10	Divide the eeprom in 32-byte (arbitrary) slices. This significantly
	11	speeds sensors up, as well as various scripts using the eeprom
	12	module.
	13
	14	This program is free software; you can redistribute it and/or modify
	15	it under the terms of the GNU General Public License as published by
	16	the Free Software Foundation; either version 2 of the License, or
	17	(at your option) any later version.
	18
	19	This program is distributed in the hope that it will be useful,
	20	but WITHOUT ANY WARRANTY; without even the implied warranty of
	21	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	22	GNU General Public License for more details.
	23
	24	You should have received a copy of the GNU General Public License
	25	along with this program; if not, write to the Free Software
	26	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	27	*/
	28
1da177e4 LT	29	#include <linux/kernel.h>
	30	#include <linux/init.h>
	31	#include <linux/module.h>
	32	#include <linux/slab.h>
1da177e4 LT	33	#include <linux/jiffies.h>
1da177e4 LT	34	#include <linux/i2c.h>
5c085d36	35	#include <linux/mutex.h>
1da177e4 LT	36
1da177e4 LT	37	/* Addresses to scan */
2cdddeb8	38	static const unsigned short normal_i2c[] = { 0x50, 0x51, 0x52, 0x53, 0x54,
1da177e4	39	0x55, 0x56, 0x57, I2C_CLIENT_END };
1da177e4 LT	40
1da177e4 LT	41	/* Insmod parameters */
f4b50261	42	I2C_CLIENT_INSMOD_1(eeprom);
1da177e4 LT	43
	44
	45	/* Size of EEPROM in bytes */
	46	#define EEPROM_SIZE 256
	47
	48	/* possible types of eeprom devices */
	49	enum eeprom_nature {
	50	UNKNOWN,
	51	VAIO,
	52	};
	53
	54	/* Each client has this additional data */
	55	struct eeprom_data {
	56	struct i2c_client client;
5c085d36	57	struct mutex update_lock;
1da177e4 LT	58	u8 valid; /* bitfield, bit!=0 if slice is valid */
	59	unsigned long last_updated[8]; /* In jiffies, 8 slices */
	60	u8 data[EEPROM_SIZE]; /* Register values */
	61	enum eeprom_nature nature;
	62	};
	63
	64
	65	static int eeprom_attach_adapter(struct i2c_adapter *adapter);
	66	static int eeprom_detect(struct i2c_adapter *adapter, int address, int kind);
	67	static int eeprom_detach_client(struct i2c_client *client);
	68
	69	/* This is the driver that will be inserted */
	70	static struct i2c_driver eeprom_driver = {
a9718b0c	71	.driver = {
a9718b0c LR	72	.name = "eeprom",
a9718b0c LR	73	},
1da177e4 LT	74	.attach_adapter = eeprom_attach_adapter,
	75	.detach_client = eeprom_detach_client,
	76	};
	77
	78	static void eeprom_update_client(struct i2c_client *client, u8 slice)
	79	{
	80	struct eeprom_data *data = i2c_get_clientdata(client);
	81	int i, j;
	82
5c085d36	83	mutex_lock(&data->update_lock);
1da177e4 LT	84
	85	if (!(data->valid & (1 << slice)) \|\|
	86	time_after(jiffies, data->last_updated[slice] + 300 * HZ)) {
	87	dev_dbg(&client->dev, "Starting eeprom update, slice %u\n", slice);
	88
	89	if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_I2C_BLOCK)) {
4b2643d7 JD	90	for (i = slice << 5; i < (slice + 1) << 5; i += 32)
	91	if (i2c_smbus_read_i2c_block_data(client, i,
	92	32, data->data + i)
	93	!= 32)
1da177e4 LT	94	goto exit;
	95	} else {
	96	if (i2c_smbus_write_byte(client, slice << 5)) {
	97	dev_dbg(&client->dev, "eeprom read start has failed!\n");
	98	goto exit;
	99	}
	100	for (i = slice << 5; i < (slice + 1) << 5; i++) {
	101	j = i2c_smbus_read_byte(client);
	102	if (j < 0)
	103	goto exit;
	104	data->data[i] = (u8) j;
	105	}
	106	}
	107	data->last_updated[slice] = jiffies;
	108	data->valid \|= (1 << slice);
	109	}
	110	exit:
5c085d36	111	mutex_unlock(&data->update_lock);
1da177e4 LT	112	}
1da177e4 LT	113
91a69029 ZR	114	static ssize_t eeprom_read(struct kobject kobj, struct bin_attribute bin_attr,
91a69029 ZR	115	char *buf, loff_t off, size_t count)
1da177e4 LT	116	{
	117	struct i2c_client *client = to_i2c_client(container_of(kobj, struct device, kobj));
	118	struct eeprom_data *data = i2c_get_clientdata(client);
	119	u8 slice;
	120
	121	if (off > EEPROM_SIZE)
	122	return 0;
	123	if (off + count > EEPROM_SIZE)
	124	count = EEPROM_SIZE - off;
	125
	126	/* Only refresh slices which contain requested bytes */
	127	for (slice = off >> 5; slice <= (off + count - 1) >> 5; slice++)
	128	eeprom_update_client(client, slice);
	129
0f2cbd38 JD	130	/* Hide Vaio private settings to regular users:
	131	- BIOS passwords: bytes 0x00 to 0x0f
	132	- UUID: bytes 0x10 to 0x1f
	133	- Serial number: 0xc0 to 0xdf */
	134	if (data->nature == VAIO && !capable(CAP_SYS_ADMIN)) {
	135	int i;
	136
	137	for (i = 0; i < count; i++) {
	138	if ((off + i <= 0x1f) \|\|
	139	(off + i >= 0xc0 && off + i <= 0xdf))
	140	buf[i] = 0;
	141	else
	142	buf[i] = data->data[off + i];
	143	}
1da177e4 LT	144	} else {
	145	memcpy(buf, &data->data[off], count);
	146	}
	147
	148	return count;
	149	}
	150
	151	static struct bin_attribute eeprom_attr = {
	152	.attr = {
	153	.name = "eeprom",
	154	.mode = S_IRUGO,
1da177e4 LT	155	},
	156	.size = EEPROM_SIZE,
	157	.read = eeprom_read,
	158	};
	159
	160	static int eeprom_attach_adapter(struct i2c_adapter *adapter)
	161	{
2ed2dc3c	162	return i2c_probe(adapter, &addr_data, eeprom_detect);
1da177e4 LT	163	}
1da177e4 LT	164
2ed2dc3c	165	/* This function is called by i2c_probe */
6536c49a	166	static int eeprom_detect(struct i2c_adapter *adapter, int address, int kind)
1da177e4 LT	167	{
	168	struct i2c_client *new_client;
	169	struct eeprom_data *data;
	170	int err = 0;
	171
	172	/* There are three ways we can read the EEPROM data:
	173	(1) I2C block reads (faster, but unsupported by most adapters)
	174	(2) Consecutive byte reads (100% overhead)
	175	(3) Regular byte data reads (200% overhead)
	176	The third method is not implemented by this driver because all
	177	known adapters support at least the second. */
	178	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_READ_BYTE_DATA
	179	\| I2C_FUNC_SMBUS_BYTE))
	180	goto exit;
	181
5263ebb5	182	if (!(data = kzalloc(sizeof(struct eeprom_data), GFP_KERNEL))) {
1da177e4 LT	183	err = -ENOMEM;
	184	goto exit;
	185	}
1da177e4 LT	186
	187	new_client = &data->client;
	188	memset(data->data, 0xff, EEPROM_SIZE);
	189	i2c_set_clientdata(new_client, data);
	190	new_client->addr = address;
	191	new_client->adapter = adapter;
	192	new_client->driver = &eeprom_driver;
	193	new_client->flags = 0;
	194
1da177e4 LT	195	/* Fill in the remaining client fields */
	196	strlcpy(new_client->name, "eeprom", I2C_NAME_SIZE);
	197	data->valid = 0;
5c085d36	198	mutex_init(&data->update_lock);
1da177e4 LT	199	data->nature = UNKNOWN;
	200
	201	/* Tell the I2C layer a new client has arrived */
	202	if ((err = i2c_attach_client(new_client)))
	203	goto exit_kfree;
	204
	205	/* Detect the Vaio nature of EEPROMs.
8b925a3d	206	We use the "PCG-" or "VGN-" prefix as the signature. */
1da177e4	207	if (address == 0x57) {
8b925a3d JD	208	char name[4];
	209
	210	name[0] = i2c_smbus_read_byte_data(new_client, 0x80);
	211	name[1] = i2c_smbus_read_byte(new_client);
	212	name[2] = i2c_smbus_read_byte(new_client);
	213	name[3] = i2c_smbus_read_byte(new_client);
	214
	215	if (!memcmp(name, "PCG-", 4) \|\| !memcmp(name, "VGN-", 4)) {
1da177e4	216	dev_info(&new_client->dev, "Vaio EEPROM detected, "
0f2cbd38	217	"enabling privacy protection\n");
1da177e4 LT	218	data->nature = VAIO;
	219	}
	220	}
	221
	222	/* create the sysfs eeprom file */
7d9db67f JD	223	err = sysfs_create_bin_file(&new_client->dev.kobj, &eeprom_attr);
	224	if (err)
	225	goto exit_detach;
1da177e4 LT	226
	227	return 0;
	228
7d9db67f JD	229	exit_detach:
7d9db67f JD	230	i2c_detach_client(new_client);
1da177e4 LT	231	exit_kfree:
	232	kfree(data);
	233	exit:
	234	return err;
	235	}
	236
	237	static int eeprom_detach_client(struct i2c_client *client)
	238	{
	239	int err;
	240
7d9db67f JD	241	sysfs_remove_bin_file(&client->dev.kobj, &eeprom_attr);
7d9db67f JD	242
1da177e4	243	err = i2c_detach_client(client);
7bef5594	244	if (err)
1da177e4	245	return err;
1da177e4 LT	246
	247	kfree(i2c_get_clientdata(client));
	248
	249	return 0;
	250	}
	251
	252	static int __init eeprom_init(void)
	253	{
	254	return i2c_add_driver(&eeprom_driver);
	255	}
	256
	257	static void __exit eeprom_exit(void)
	258	{
	259	i2c_del_driver(&eeprom_driver);
	260	}
	261
	262
	263	MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
	264	"Philip Edelbrock <phil@netroedge.com> and "
	265	"Greg Kroah-Hartman <greg@kroah.com>");
	266	MODULE_DESCRIPTION("I2C EEPROM driver");
	267	MODULE_LICENSE("GPL");
	268
	269	module_init(eeprom_init);
	270	module_exit(eeprom_exit);