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> |
34 | #include <linux/i2c.h> | |
5c085d36 | 35 | #include <linux/mutex.h> |
1da177e4 LT |
36 | |
37 | /* Addresses to scan */ | |
38 | static unsigned short normal_i2c[] = { 0x50, 0x51, 0x52, 0x53, 0x54, | |
39 | 0x55, 0x56, 0x57, I2C_CLIENT_END }; | |
1da177e4 LT |
40 | |
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", |
73 | }, | |
1da177e4 | 74 | .id = I2C_DRIVERID_EEPROM, |
1da177e4 LT |
75 | .attach_adapter = eeprom_attach_adapter, |
76 | .detach_client = eeprom_detach_client, | |
77 | }; | |
78 | ||
79 | static void eeprom_update_client(struct i2c_client *client, u8 slice) | |
80 | { | |
81 | struct eeprom_data *data = i2c_get_clientdata(client); | |
82 | int i, j; | |
83 | ||
5c085d36 | 84 | mutex_lock(&data->update_lock); |
1da177e4 LT |
85 | |
86 | if (!(data->valid & (1 << slice)) || | |
87 | time_after(jiffies, data->last_updated[slice] + 300 * HZ)) { | |
88 | dev_dbg(&client->dev, "Starting eeprom update, slice %u\n", slice); | |
89 | ||
90 | if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_I2C_BLOCK)) { | |
4b2643d7 JD |
91 | for (i = slice << 5; i < (slice + 1) << 5; i += 32) |
92 | if (i2c_smbus_read_i2c_block_data(client, i, | |
93 | 32, data->data + i) | |
94 | != 32) | |
1da177e4 LT |
95 | goto exit; |
96 | } else { | |
97 | if (i2c_smbus_write_byte(client, slice << 5)) { | |
98 | dev_dbg(&client->dev, "eeprom read start has failed!\n"); | |
99 | goto exit; | |
100 | } | |
101 | for (i = slice << 5; i < (slice + 1) << 5; i++) { | |
102 | j = i2c_smbus_read_byte(client); | |
103 | if (j < 0) | |
104 | goto exit; | |
105 | data->data[i] = (u8) j; | |
106 | } | |
107 | } | |
108 | data->last_updated[slice] = jiffies; | |
109 | data->valid |= (1 << slice); | |
110 | } | |
111 | exit: | |
5c085d36 | 112 | mutex_unlock(&data->update_lock); |
1da177e4 LT |
113 | } |
114 | ||
91a69029 ZR |
115 | static ssize_t eeprom_read(struct kobject *kobj, struct bin_attribute *bin_attr, |
116 | char *buf, loff_t off, size_t count) | |
1da177e4 LT |
117 | { |
118 | struct i2c_client *client = to_i2c_client(container_of(kobj, struct device, kobj)); | |
119 | struct eeprom_data *data = i2c_get_clientdata(client); | |
120 | u8 slice; | |
121 | ||
122 | if (off > EEPROM_SIZE) | |
123 | return 0; | |
124 | if (off + count > EEPROM_SIZE) | |
125 | count = EEPROM_SIZE - off; | |
126 | ||
127 | /* Only refresh slices which contain requested bytes */ | |
128 | for (slice = off >> 5; slice <= (off + count - 1) >> 5; slice++) | |
129 | eeprom_update_client(client, slice); | |
130 | ||
0f2cbd38 JD |
131 | /* Hide Vaio private settings to regular users: |
132 | - BIOS passwords: bytes 0x00 to 0x0f | |
133 | - UUID: bytes 0x10 to 0x1f | |
134 | - Serial number: 0xc0 to 0xdf */ | |
135 | if (data->nature == VAIO && !capable(CAP_SYS_ADMIN)) { | |
136 | int i; | |
137 | ||
138 | for (i = 0; i < count; i++) { | |
139 | if ((off + i <= 0x1f) || | |
140 | (off + i >= 0xc0 && off + i <= 0xdf)) | |
141 | buf[i] = 0; | |
142 | else | |
143 | buf[i] = data->data[off + i]; | |
144 | } | |
1da177e4 LT |
145 | } else { |
146 | memcpy(buf, &data->data[off], count); | |
147 | } | |
148 | ||
149 | return count; | |
150 | } | |
151 | ||
152 | static struct bin_attribute eeprom_attr = { | |
153 | .attr = { | |
154 | .name = "eeprom", | |
155 | .mode = S_IRUGO, | |
1da177e4 LT |
156 | }, |
157 | .size = EEPROM_SIZE, | |
158 | .read = eeprom_read, | |
159 | }; | |
160 | ||
161 | static int eeprom_attach_adapter(struct i2c_adapter *adapter) | |
162 | { | |
2ed2dc3c | 163 | return i2c_probe(adapter, &addr_data, eeprom_detect); |
1da177e4 LT |
164 | } |
165 | ||
2ed2dc3c | 166 | /* This function is called by i2c_probe */ |
6536c49a | 167 | static int eeprom_detect(struct i2c_adapter *adapter, int address, int kind) |
1da177e4 LT |
168 | { |
169 | struct i2c_client *new_client; | |
170 | struct eeprom_data *data; | |
171 | int err = 0; | |
172 | ||
173 | /* There are three ways we can read the EEPROM data: | |
174 | (1) I2C block reads (faster, but unsupported by most adapters) | |
175 | (2) Consecutive byte reads (100% overhead) | |
176 | (3) Regular byte data reads (200% overhead) | |
177 | The third method is not implemented by this driver because all | |
178 | known adapters support at least the second. */ | |
179 | if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_READ_BYTE_DATA | |
180 | | I2C_FUNC_SMBUS_BYTE)) | |
181 | goto exit; | |
182 | ||
5263ebb5 | 183 | if (!(data = kzalloc(sizeof(struct eeprom_data), GFP_KERNEL))) { |
1da177e4 LT |
184 | err = -ENOMEM; |
185 | goto exit; | |
186 | } | |
1da177e4 LT |
187 | |
188 | new_client = &data->client; | |
189 | memset(data->data, 0xff, EEPROM_SIZE); | |
190 | i2c_set_clientdata(new_client, data); | |
191 | new_client->addr = address; | |
192 | new_client->adapter = adapter; | |
193 | new_client->driver = &eeprom_driver; | |
194 | new_client->flags = 0; | |
195 | ||
1da177e4 LT |
196 | /* Fill in the remaining client fields */ |
197 | strlcpy(new_client->name, "eeprom", I2C_NAME_SIZE); | |
198 | data->valid = 0; | |
5c085d36 | 199 | mutex_init(&data->update_lock); |
1da177e4 LT |
200 | data->nature = UNKNOWN; |
201 | ||
202 | /* Tell the I2C layer a new client has arrived */ | |
203 | if ((err = i2c_attach_client(new_client))) | |
204 | goto exit_kfree; | |
205 | ||
206 | /* Detect the Vaio nature of EEPROMs. | |
207 | We use the "PCG-" prefix as the signature. */ | |
208 | if (address == 0x57) { | |
209 | if (i2c_smbus_read_byte_data(new_client, 0x80) == 'P' | |
210 | && i2c_smbus_read_byte(new_client) == 'C' | |
211 | && i2c_smbus_read_byte(new_client) == 'G' | |
212 | && i2c_smbus_read_byte(new_client) == '-') { | |
213 | dev_info(&new_client->dev, "Vaio EEPROM detected, " | |
0f2cbd38 | 214 | "enabling privacy protection\n"); |
1da177e4 LT |
215 | data->nature = VAIO; |
216 | } | |
217 | } | |
218 | ||
219 | /* create the sysfs eeprom file */ | |
7d9db67f JD |
220 | err = sysfs_create_bin_file(&new_client->dev.kobj, &eeprom_attr); |
221 | if (err) | |
222 | goto exit_detach; | |
1da177e4 LT |
223 | |
224 | return 0; | |
225 | ||
7d9db67f JD |
226 | exit_detach: |
227 | i2c_detach_client(new_client); | |
1da177e4 LT |
228 | exit_kfree: |
229 | kfree(data); | |
230 | exit: | |
231 | return err; | |
232 | } | |
233 | ||
234 | static int eeprom_detach_client(struct i2c_client *client) | |
235 | { | |
236 | int err; | |
237 | ||
7d9db67f JD |
238 | sysfs_remove_bin_file(&client->dev.kobj, &eeprom_attr); |
239 | ||
1da177e4 | 240 | err = i2c_detach_client(client); |
7bef5594 | 241 | if (err) |
1da177e4 | 242 | return err; |
1da177e4 LT |
243 | |
244 | kfree(i2c_get_clientdata(client)); | |
245 | ||
246 | return 0; | |
247 | } | |
248 | ||
249 | static int __init eeprom_init(void) | |
250 | { | |
251 | return i2c_add_driver(&eeprom_driver); | |
252 | } | |
253 | ||
254 | static void __exit eeprom_exit(void) | |
255 | { | |
256 | i2c_del_driver(&eeprom_driver); | |
257 | } | |
258 | ||
259 | ||
260 | MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and " | |
261 | "Philip Edelbrock <phil@netroedge.com> and " | |
262 | "Greg Kroah-Hartman <greg@kroah.com>"); | |
263 | MODULE_DESCRIPTION("I2C EEPROM driver"); | |
264 | MODULE_LICENSE("GPL"); | |
265 | ||
266 | module_init(eeprom_init); | |
267 | module_exit(eeprom_exit); |