Merge branch 'smsc47b397-new-id' into release
[linux-2.6] / drivers / i2c / chips / eeprom.c
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
29 #include <linux/kernel.h>
30 #include <linux/init.h>
31 #include <linux/module.h>
32 #include <linux/slab.h>
33 #include <linux/jiffies.h>
34 #include <linux/i2c.h>
35 #include <linux/mutex.h>
36
37 /* Addresses to scan */
38 static const unsigned short normal_i2c[] = { 0x50, 0x51, 0x52, 0x53, 0x54,
39                                         0x55, 0x56, 0x57, I2C_CLIENT_END };
40
41 /* Insmod parameters */
42 I2C_CLIENT_INSMOD_1(eeprom);
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;
57         struct mutex update_lock;
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 = {
71         .driver = {
72                 .name   = "eeprom",
73         },
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
83         mutex_lock(&data->update_lock);
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)) {
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)
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:
111         mutex_unlock(&data->update_lock);
112 }
113
114 static ssize_t eeprom_read(struct kobject *kobj, struct bin_attribute *bin_attr,
115                            char *buf, loff_t off, size_t count)
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
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                 }
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,
155         },
156         .size = EEPROM_SIZE,
157         .read = eeprom_read,
158 };
159
160 static int eeprom_attach_adapter(struct i2c_adapter *adapter)
161 {
162         return i2c_probe(adapter, &addr_data, eeprom_detect);
163 }
164
165 /* This function is called by i2c_probe */
166 static int eeprom_detect(struct i2c_adapter *adapter, int address, int kind)
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
182         if (!(data = kzalloc(sizeof(struct eeprom_data), GFP_KERNEL))) {
183                 err = -ENOMEM;
184                 goto exit;
185         }
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
195         /* Fill in the remaining client fields */
196         strlcpy(new_client->name, "eeprom", I2C_NAME_SIZE);
197         data->valid = 0;
198         mutex_init(&data->update_lock);
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.
206            We use the "PCG-" or "VGN-" prefix as the signature. */
207         if (address == 0x57) {
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)) {
216                         dev_info(&new_client->dev, "Vaio EEPROM detected, "
217                                  "enabling privacy protection\n");
218                         data->nature = VAIO;
219                 }
220         }
221
222         /* create the sysfs eeprom file */
223         err = sysfs_create_bin_file(&new_client->dev.kobj, &eeprom_attr);
224         if (err)
225                 goto exit_detach;
226
227         return 0;
228
229 exit_detach:
230         i2c_detach_client(new_client);
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
241         sysfs_remove_bin_file(&client->dev.kobj, &eeprom_attr);
242
243         err = i2c_detach_client(client);
244         if (err)
245                 return err;
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);