2 max6875.c - driver for MAX6874/MAX6875
4 Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
6 Based on i2c/chips/eeprom.c
8 The MAX6875 has a bank of registers and two banks of EEPROM.
9 Address ranges are defined as follows:
10 * 0x0000 - 0x0046 = configuration registers
11 * 0x8000 - 0x8046 = configuration EEPROM
12 * 0x8100 - 0x82FF = user EEPROM
14 This driver makes the user EEPROM available for read.
16 The registers & config EEPROM should be accessed via i2c-dev.
18 The MAX6875 ignores the lowest address bit, so each chip responds to
19 two addresses - 0x50/0x51 and 0x52/0x53.
21 Note that the MAX6875 uses i2c_smbus_write_byte_data() to set the read
22 address, so this driver is destructive if loaded for the wrong EEPROM chip.
24 This program is free software; you can redistribute it and/or modify
25 it under the terms of the GNU General Public License as published by
26 the Free Software Foundation; version 2 of the License.
29 #include <linux/kernel.h>
30 #include <linux/init.h>
31 #include <linux/module.h>
32 #include <linux/slab.h>
33 #include <linux/i2c.h>
34 #include <linux/i2c-sensor.h>
35 #include <asm/semaphore.h>
37 /* Do not scan - the MAX6875 access method will write to some EEPROM chips */
38 static unsigned short normal_i2c[] = {I2C_CLIENT_END};
39 static unsigned int normal_isa[] = {I2C_CLIENT_ISA_END};
41 /* Insmod parameters */
42 SENSORS_INSMOD_1(max6875);
44 /* The MAX6875 can only read/write 16 bytes at a time */
48 /* USER EEPROM is at addresses 0x8100 - 0x82FF */
49 #define USER_EEPROM_BASE 0x8100
50 #define USER_EEPROM_SIZE 0x0200
51 #define USER_EEPROM_SLICES 32
53 /* MAX6875 commands */
54 #define MAX6875_CMD_BLK_READ 0x84
56 /* Each client has this additional data */
58 struct i2c_client client;
59 struct semaphore update_lock;
62 u8 data[USER_EEPROM_SIZE];
63 unsigned long last_updated[USER_EEPROM_SLICES];
66 static int max6875_attach_adapter(struct i2c_adapter *adapter);
67 static int max6875_detect(struct i2c_adapter *adapter, int address, int kind);
68 static int max6875_detach_client(struct i2c_client *client);
70 /* This is the driver that will be inserted */
71 static struct i2c_driver max6875_driver = {
74 .flags = I2C_DF_NOTIFY,
75 .attach_adapter = max6875_attach_adapter,
76 .detach_client = max6875_detach_client,
79 static void max6875_update_slice(struct i2c_client *client, int slice)
81 struct max6875_data *data = i2c_get_clientdata(client);
85 if (slice >= USER_EEPROM_SLICES)
88 down(&data->update_lock);
90 buf = &data->data[slice << SLICE_BITS];
92 if (!(data->valid & (1 << slice)) ||
93 time_after(jiffies, data->last_updated[slice])) {
95 dev_dbg(&client->dev, "Starting update of slice %u\n", slice);
97 data->valid &= ~(1 << slice);
99 addr = USER_EEPROM_BASE + (slice << SLICE_BITS);
101 /* select the eeprom address */
102 if (i2c_smbus_write_byte_data(client, addr >> 8, addr & 0xFF)) {
103 dev_err(&client->dev, "address set failed\n");
107 if (i2c_check_functionality(client->adapter,
108 I2C_FUNC_SMBUS_READ_I2C_BLOCK)) {
109 if (i2c_smbus_read_i2c_block_data(client,
110 MAX6875_CMD_BLK_READ,
111 buf) != SLICE_SIZE) {
115 for (i = 0; i < SLICE_SIZE; i++) {
116 j = i2c_smbus_read_byte(client);
123 data->last_updated[slice] = jiffies;
124 data->valid |= (1 << slice);
127 up(&data->update_lock);
130 static ssize_t max6875_read(struct kobject *kobj, char *buf, loff_t off,
133 struct i2c_client *client = kobj_to_i2c_client(kobj);
134 struct max6875_data *data = i2c_get_clientdata(client);
135 int slice, max_slice;
137 if (off > USER_EEPROM_SIZE)
140 if (off + count > USER_EEPROM_SIZE)
141 count = USER_EEPROM_SIZE - off;
143 /* refresh slices which contain requested bytes */
144 max_slice = (off + count - 1) >> SLICE_BITS;
145 for (slice = (off >> SLICE_BITS); slice <= max_slice; slice++)
146 max6875_update_slice(client, slice);
148 memcpy(buf, &data->data[off], count);
153 static struct bin_attribute user_eeprom_attr = {
157 .owner = THIS_MODULE,
159 .size = USER_EEPROM_SIZE,
160 .read = max6875_read,
163 static int max6875_attach_adapter(struct i2c_adapter *adapter)
165 return i2c_detect(adapter, &addr_data, max6875_detect);
168 /* This function is called by i2c_detect */
169 static int max6875_detect(struct i2c_adapter *adapter, int address, int kind)
171 struct i2c_client *real_client;
172 struct i2c_client *fake_client;
173 struct max6875_data *data;
176 /* Prevent 24rf08 corruption (in case of user error) */
178 i2c_smbus_xfer(adapter, address, 0, 0, 0,
179 I2C_SMBUS_QUICK, NULL);
181 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WRITE_BYTE_DATA
182 | I2C_FUNC_SMBUS_READ_BYTE))
185 /* Only check even addresses */
189 if (!(data = kmalloc(sizeof(struct max6875_data), GFP_KERNEL)))
191 memset(data, 0, sizeof(struct max6875_data));
193 /* A fake client is created on the odd address */
194 if (!(fake_client = kmalloc(sizeof(struct i2c_client), GFP_KERNEL))) {
198 memset(fake_client, 0, sizeof(struct i2c_client));
200 /* Init real i2c_client */
201 real_client = &data->client;
202 i2c_set_clientdata(real_client, data);
203 real_client->addr = address;
204 real_client->adapter = adapter;
205 real_client->driver = &max6875_driver;
206 real_client->flags = 0;
207 strlcpy(real_client->name, "max6875", I2C_NAME_SIZE);
208 init_MUTEX(&data->update_lock);
210 /* Init fake client data */
211 /* set the client data to the i2c_client so that it will get freed */
212 i2c_set_clientdata(fake_client, fake_client);
213 fake_client->addr = address | 1;
214 fake_client->adapter = adapter;
215 fake_client->driver = &max6875_driver;
216 fake_client->flags = 0;
217 strlcpy(fake_client->name, "max6875 subclient", I2C_NAME_SIZE);
219 /* Prevent 24RF08 corruption (in case of user error) */
220 i2c_smbus_write_quick(real_client, 0);
222 if ((err = i2c_attach_client(real_client)) != 0)
225 if ((err = i2c_attach_client(fake_client)) != 0)
228 sysfs_create_bin_file(&real_client->dev.kobj, &user_eeprom_attr);
233 i2c_detach_client(real_client);
241 static int max6875_detach_client(struct i2c_client *client)
245 err = i2c_detach_client(client);
247 dev_err(&client->dev, "i2c_detach_client() failed\n");
250 kfree(i2c_get_clientdata(client));
254 static int __init max6875_init(void)
256 return i2c_add_driver(&max6875_driver);
259 static void __exit max6875_exit(void)
261 i2c_del_driver(&max6875_driver);
265 MODULE_AUTHOR("Ben Gardner <bgardner@wabtec.com>");
266 MODULE_DESCRIPTION("MAX6875 driver");
267 MODULE_LICENSE("GPL");
269 module_init(max6875_init);
270 module_exit(max6875_exit);