[PATCH] i2c: Drop i2c_driver.flags, 2 of 3
[linux-2.6.git] / 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/sched.h>
34 #include <linux/jiffies.h>
35 #include <linux/i2c.h>
36
37 /* Addresses to scan */
38 static 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 semaphore 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         .owner          = THIS_MODULE,
72         .name           = "eeprom",
73         .id             = I2C_DRIVERID_EEPROM,
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         down(&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 += I2C_SMBUS_BLOCK_MAX)
91                                 if (i2c_smbus_read_i2c_block_data(client, i, data->data + i) != I2C_SMBUS_BLOCK_MAX)
92                                         goto exit;
93                 } else {
94                         if (i2c_smbus_write_byte(client, slice << 5)) {
95                                 dev_dbg(&client->dev, "eeprom read start has failed!\n");
96                                 goto exit;
97                         }
98                         for (i = slice << 5; i < (slice + 1) << 5; i++) {
99                                 j = i2c_smbus_read_byte(client);
100                                 if (j < 0)
101                                         goto exit;
102                                 data->data[i] = (u8) j;
103                         }
104                 }
105                 data->last_updated[slice] = jiffies;
106                 data->valid |= (1 << slice);
107         }
108 exit:
109         up(&data->update_lock);
110 }
111
112 static ssize_t eeprom_read(struct kobject *kobj, char *buf, loff_t off, size_t count)
113 {
114         struct i2c_client *client = to_i2c_client(container_of(kobj, struct device, kobj));
115         struct eeprom_data *data = i2c_get_clientdata(client);
116         u8 slice;
117
118         if (off > EEPROM_SIZE)
119                 return 0;
120         if (off + count > EEPROM_SIZE)
121                 count = EEPROM_SIZE - off;
122
123         /* Only refresh slices which contain requested bytes */
124         for (slice = off >> 5; slice <= (off + count - 1) >> 5; slice++)
125                 eeprom_update_client(client, slice);
126
127         /* Hide Vaio security settings to regular users (16 first bytes) */
128         if (data->nature == VAIO && off < 16 && !capable(CAP_SYS_ADMIN)) {
129                 size_t in_row1 = 16 - off;
130                 in_row1 = min(in_row1, count);
131                 memset(buf, 0, in_row1);
132                 if (count - in_row1 > 0)
133                         memcpy(buf + in_row1, &data->data[16], count - in_row1);
134         } else {
135                 memcpy(buf, &data->data[off], count);
136         }
137
138         return count;
139 }
140
141 static struct bin_attribute eeprom_attr = {
142         .attr = {
143                 .name = "eeprom",
144                 .mode = S_IRUGO,
145                 .owner = THIS_MODULE,
146         },
147         .size = EEPROM_SIZE,
148         .read = eeprom_read,
149 };
150
151 static int eeprom_attach_adapter(struct i2c_adapter *adapter)
152 {
153         return i2c_probe(adapter, &addr_data, eeprom_detect);
154 }
155
156 /* This function is called by i2c_probe */
157 static int eeprom_detect(struct i2c_adapter *adapter, int address, int kind)
158 {
159         struct i2c_client *new_client;
160         struct eeprom_data *data;
161         int err = 0;
162
163         /* There are three ways we can read the EEPROM data:
164            (1) I2C block reads (faster, but unsupported by most adapters)
165            (2) Consecutive byte reads (100% overhead)
166            (3) Regular byte data reads (200% overhead)
167            The third method is not implemented by this driver because all
168            known adapters support at least the second. */
169         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_READ_BYTE_DATA
170                                             | I2C_FUNC_SMBUS_BYTE))
171                 goto exit;
172
173         if (!(data = kzalloc(sizeof(struct eeprom_data), GFP_KERNEL))) {
174                 err = -ENOMEM;
175                 goto exit;
176         }
177
178         new_client = &data->client;
179         memset(data->data, 0xff, EEPROM_SIZE);
180         i2c_set_clientdata(new_client, data);
181         new_client->addr = address;
182         new_client->adapter = adapter;
183         new_client->driver = &eeprom_driver;
184         new_client->flags = 0;
185
186         /* Fill in the remaining client fields */
187         strlcpy(new_client->name, "eeprom", I2C_NAME_SIZE);
188         data->valid = 0;
189         init_MUTEX(&data->update_lock);
190         data->nature = UNKNOWN;
191
192         /* Tell the I2C layer a new client has arrived */
193         if ((err = i2c_attach_client(new_client)))
194                 goto exit_kfree;
195
196         /* Detect the Vaio nature of EEPROMs.
197            We use the "PCG-" prefix as the signature. */
198         if (address == 0x57) {
199                 if (i2c_smbus_read_byte_data(new_client, 0x80) == 'P'
200                  && i2c_smbus_read_byte(new_client) == 'C'
201                  && i2c_smbus_read_byte(new_client) == 'G'
202                  && i2c_smbus_read_byte(new_client) == '-') {
203                         dev_info(&new_client->dev, "Vaio EEPROM detected, "
204                                 "enabling password protection\n");
205                         data->nature = VAIO;
206                 }
207         }
208
209         /* create the sysfs eeprom file */
210         sysfs_create_bin_file(&new_client->dev.kobj, &eeprom_attr);
211
212         return 0;
213
214 exit_kfree:
215         kfree(data);
216 exit:
217         return err;
218 }
219
220 static int eeprom_detach_client(struct i2c_client *client)
221 {
222         int err;
223
224         err = i2c_detach_client(client);
225         if (err)
226                 return err;
227
228         kfree(i2c_get_clientdata(client));
229
230         return 0;
231 }
232
233 static int __init eeprom_init(void)
234 {
235         return i2c_add_driver(&eeprom_driver);
236 }
237
238 static void __exit eeprom_exit(void)
239 {
240         i2c_del_driver(&eeprom_driver);
241 }
242
243
244 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
245                 "Philip Edelbrock <phil@netroedge.com> and "
246                 "Greg Kroah-Hartman <greg@kroah.com>");
247 MODULE_DESCRIPTION("I2C EEPROM driver");
248 MODULE_LICENSE("GPL");
249
250 module_init(eeprom_init);
251 module_exit(eeprom_exit);