2005-06-04 01:03:27 +08:00
|
|
|
/*
|
|
|
|
max6875.c - driver for MAX6874/MAX6875
|
|
|
|
|
|
|
|
Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
|
|
|
|
|
|
|
|
Based on i2c/chips/eeprom.c
|
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
The MAX6875 has a bank of registers and two banks of EEPROM.
|
|
|
|
Address ranges are defined as follows:
|
|
|
|
* 0x0000 - 0x0046 = configuration registers
|
|
|
|
* 0x8000 - 0x8046 = configuration EEPROM
|
|
|
|
* 0x8100 - 0x82FF = user EEPROM
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
This driver makes the user EEPROM available for read.
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
The registers & config EEPROM should be accessed via i2c-dev.
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
The MAX6875 ignores the lowest address bit, so each chip responds to
|
|
|
|
two addresses - 0x50/0x51 and 0x52/0x53.
|
|
|
|
|
|
|
|
Note that the MAX6875 uses i2c_smbus_write_byte_data() to set the read
|
|
|
|
address, so this driver is destructive if loaded for the wrong EEPROM chip.
|
2005-06-04 01:03:27 +08:00
|
|
|
|
|
|
|
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; version 2 of the License.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <linux/kernel.h>
|
|
|
|
#include <linux/init.h>
|
|
|
|
#include <linux/module.h>
|
|
|
|
#include <linux/slab.h>
|
|
|
|
#include <linux/i2c.h>
|
2005-07-13 02:21:11 +08:00
|
|
|
#include <asm/semaphore.h>
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
/* Do not scan - the MAX6875 access method will write to some EEPROM chips */
|
[PATCH] I2C: New max6875 driver may corrupt EEPROMs
After a careful code analysis on the new max6875 driver
(drivers/i2c/chips/max6875.c), I have come to the conclusion that this
driver may cause EEPROM corruptions if used on random systems.
The EEPROM part of the MAX6875 chip is accessed using rather uncommon
I2C sequences. What is seen by the MAX6875 as reads can be seen by a
standard EEPROM (24C02) as writes. If you check the detection method
used by the driver, you'll find that the first SMBus command it will
send on the bus is i2c_smbus_write_byte_data(client, 0x80, 0x40). For
the MAX6875 it makes an internal pointer point to a specific offset of
the EEPROM waiting for a subsequent read command, so it's not an actual
data write operation, but for a standard EEPROM, this instead means
writing value 0x40 to offset 0x80. Blame Philips and Intel for the
obscure protocol.
Since the MAX6875 and the standard, common 24C02 EEPROMs share two I2C
addresses (0x50 and 0x52), loading the max6875 driver on a system with
standard EEPROMs at either address will trigger a write on these
EEPROMs, which will lead to their corruption if they happen not to be
write protected. This kind of EEPROMs can be found on memory modules
(SPD), ethernet adapters (MAC address), laptops (proprietary data) and
displays (EDID/DDC). Most of these are hopefully write-protected, but
not all of them.
For this reason, I would recommend that the max6875 driver be
neutralized, in a way that nobody can corrupt his/her EEPROMs by just
loading the driver. This means either deleting the driver completely, or
not listing any default address for it. I'd like this to be done before
2.6.13-rc1 is released.
Additionally, the max6875 driver lacks the 24RF08 corruption preventer
present in the eeprom driver, which means that loading this driver in a
system with such a chip would corrupt it as well.
Here is a proposed quick patch addressing the issue, although I wouldn't
mind a complete removal if it makes everyone feel safer. I think Ben
has plans to replace this driver by a much simplified one anyway.
Signed-off-by: Jean Delvare <khali@linux-fr.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2005-06-25 03:14:16 +08:00
|
|
|
static unsigned short normal_i2c[] = {I2C_CLIENT_END};
|
2005-06-04 01:03:27 +08:00
|
|
|
|
|
|
|
/* Insmod parameters */
|
2005-08-01 03:49:03 +08:00
|
|
|
I2C_CLIENT_INSMOD_1(max6875);
|
2005-06-04 01:03:27 +08:00
|
|
|
|
|
|
|
/* The MAX6875 can only read/write 16 bytes at a time */
|
|
|
|
#define SLICE_SIZE 16
|
|
|
|
#define SLICE_BITS 4
|
|
|
|
|
|
|
|
/* USER EEPROM is at addresses 0x8100 - 0x82FF */
|
|
|
|
#define USER_EEPROM_BASE 0x8100
|
|
|
|
#define USER_EEPROM_SIZE 0x0200
|
|
|
|
#define USER_EEPROM_SLICES 32
|
|
|
|
|
|
|
|
/* MAX6875 commands */
|
2005-07-13 02:21:11 +08:00
|
|
|
#define MAX6875_CMD_BLK_READ 0x84
|
2005-06-04 01:03:27 +08:00
|
|
|
|
|
|
|
/* Each client has this additional data */
|
|
|
|
struct max6875_data {
|
|
|
|
struct i2c_client client;
|
|
|
|
struct semaphore update_lock;
|
2005-07-13 02:21:11 +08:00
|
|
|
|
|
|
|
u32 valid;
|
|
|
|
u8 data[USER_EEPROM_SIZE];
|
|
|
|
unsigned long last_updated[USER_EEPROM_SLICES];
|
2005-06-04 01:03:27 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
static int max6875_attach_adapter(struct i2c_adapter *adapter);
|
|
|
|
static int max6875_detect(struct i2c_adapter *adapter, int address, int kind);
|
|
|
|
static int max6875_detach_client(struct i2c_client *client);
|
|
|
|
|
|
|
|
/* This is the driver that will be inserted */
|
|
|
|
static struct i2c_driver max6875_driver = {
|
|
|
|
.owner = THIS_MODULE,
|
|
|
|
.name = "max6875",
|
|
|
|
.flags = I2C_DF_NOTIFY,
|
|
|
|
.attach_adapter = max6875_attach_adapter,
|
|
|
|
.detach_client = max6875_detach_client,
|
|
|
|
};
|
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
static void max6875_update_slice(struct i2c_client *client, int slice)
|
2005-06-04 01:03:27 +08:00
|
|
|
{
|
|
|
|
struct max6875_data *data = i2c_get_clientdata(client);
|
2005-07-13 02:21:11 +08:00
|
|
|
int i, j, addr;
|
|
|
|
u8 *buf;
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
if (slice >= USER_EEPROM_SLICES)
|
|
|
|
return;
|
2005-06-04 01:03:27 +08:00
|
|
|
|
|
|
|
down(&data->update_lock);
|
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
buf = &data->data[slice << SLICE_BITS];
|
|
|
|
|
|
|
|
if (!(data->valid & (1 << slice)) ||
|
|
|
|
time_after(jiffies, data->last_updated[slice])) {
|
|
|
|
|
2005-07-28 01:43:03 +08:00
|
|
|
dev_dbg(&client->dev, "Starting update of slice %u\n", slice);
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
data->valid &= ~(1 << slice);
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
addr = USER_EEPROM_BASE + (slice << SLICE_BITS);
|
|
|
|
|
|
|
|
/* select the eeprom address */
|
|
|
|
if (i2c_smbus_write_byte_data(client, addr >> 8, addr & 0xFF)) {
|
|
|
|
dev_err(&client->dev, "address set failed\n");
|
|
|
|
goto exit_up;
|
2005-06-04 01:03:27 +08:00
|
|
|
}
|
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
if (i2c_check_functionality(client->adapter,
|
|
|
|
I2C_FUNC_SMBUS_READ_I2C_BLOCK)) {
|
|
|
|
if (i2c_smbus_read_i2c_block_data(client,
|
|
|
|
MAX6875_CMD_BLK_READ,
|
|
|
|
buf) != SLICE_SIZE) {
|
|
|
|
goto exit_up;
|
2005-06-04 01:03:27 +08:00
|
|
|
}
|
|
|
|
} else {
|
2005-07-13 02:21:11 +08:00
|
|
|
for (i = 0; i < SLICE_SIZE; i++) {
|
2005-06-04 01:03:27 +08:00
|
|
|
j = i2c_smbus_read_byte(client);
|
2005-07-13 02:21:11 +08:00
|
|
|
if (j < 0) {
|
|
|
|
goto exit_up;
|
2005-06-04 01:03:27 +08:00
|
|
|
}
|
2005-07-13 02:21:11 +08:00
|
|
|
buf[i] = j;
|
2005-06-04 01:03:27 +08:00
|
|
|
}
|
|
|
|
}
|
2005-07-13 02:21:11 +08:00
|
|
|
data->last_updated[slice] = jiffies;
|
|
|
|
data->valid |= (1 << slice);
|
2005-06-04 01:03:27 +08:00
|
|
|
}
|
2005-07-13 02:21:11 +08:00
|
|
|
exit_up:
|
2005-06-04 01:03:27 +08:00
|
|
|
up(&data->update_lock);
|
|
|
|
}
|
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
static ssize_t max6875_read(struct kobject *kobj, char *buf, loff_t off,
|
|
|
|
size_t count)
|
2005-06-04 01:03:27 +08:00
|
|
|
{
|
2005-07-13 02:21:11 +08:00
|
|
|
struct i2c_client *client = kobj_to_i2c_client(kobj);
|
2005-06-04 01:03:27 +08:00
|
|
|
struct max6875_data *data = i2c_get_clientdata(client);
|
2005-07-13 02:21:11 +08:00
|
|
|
int slice, max_slice;
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
if (off > USER_EEPROM_SIZE)
|
2005-06-04 01:03:27 +08:00
|
|
|
return 0;
|
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
if (off + count > USER_EEPROM_SIZE)
|
|
|
|
count = USER_EEPROM_SIZE - off;
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
/* refresh slices which contain requested bytes */
|
|
|
|
max_slice = (off + count - 1) >> SLICE_BITS;
|
|
|
|
for (slice = (off >> SLICE_BITS); slice <= max_slice; slice++)
|
|
|
|
max6875_update_slice(client, slice);
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
memcpy(buf, &data->data[off], count);
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
return count;
|
2005-06-04 01:03:27 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
static struct bin_attribute user_eeprom_attr = {
|
|
|
|
.attr = {
|
2005-07-13 02:21:11 +08:00
|
|
|
.name = "eeprom",
|
|
|
|
.mode = S_IRUGO,
|
2005-06-04 01:03:27 +08:00
|
|
|
.owner = THIS_MODULE,
|
|
|
|
},
|
2005-07-13 02:21:11 +08:00
|
|
|
.size = USER_EEPROM_SIZE,
|
|
|
|
.read = max6875_read,
|
2005-06-04 01:03:27 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
static int max6875_attach_adapter(struct i2c_adapter *adapter)
|
|
|
|
{
|
2005-08-01 03:42:02 +08:00
|
|
|
return i2c_probe(adapter, &addr_data, max6875_detect);
|
2005-06-04 01:03:27 +08:00
|
|
|
}
|
|
|
|
|
2005-08-01 03:42:02 +08:00
|
|
|
/* This function is called by i2c_probe */
|
2005-06-04 01:03:27 +08:00
|
|
|
static int max6875_detect(struct i2c_adapter *adapter, int address, int kind)
|
|
|
|
{
|
2005-07-13 02:21:11 +08:00
|
|
|
struct i2c_client *real_client;
|
|
|
|
struct i2c_client *fake_client;
|
2005-06-04 01:03:27 +08:00
|
|
|
struct max6875_data *data;
|
|
|
|
int err = 0;
|
|
|
|
|
2005-07-28 01:43:14 +08:00
|
|
|
if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WRITE_BYTE_DATA
|
2005-07-13 02:21:11 +08:00
|
|
|
| I2C_FUNC_SMBUS_READ_BYTE))
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
/* Only check even addresses */
|
|
|
|
if (address & 1)
|
|
|
|
return 0;
|
|
|
|
|
2005-10-18 05:09:43 +08:00
|
|
|
if (!(data = kzalloc(sizeof(struct max6875_data), GFP_KERNEL)))
|
2005-07-13 02:21:11 +08:00
|
|
|
return -ENOMEM;
|
2005-06-04 01:03:27 +08:00
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
/* A fake client is created on the odd address */
|
2005-10-18 05:09:43 +08:00
|
|
|
if (!(fake_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL))) {
|
2005-07-13 02:21:11 +08:00
|
|
|
err = -ENOMEM;
|
|
|
|
goto exit_kfree1;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Init real i2c_client */
|
|
|
|
real_client = &data->client;
|
|
|
|
i2c_set_clientdata(real_client, data);
|
|
|
|
real_client->addr = address;
|
|
|
|
real_client->adapter = adapter;
|
|
|
|
real_client->driver = &max6875_driver;
|
|
|
|
real_client->flags = 0;
|
|
|
|
strlcpy(real_client->name, "max6875", I2C_NAME_SIZE);
|
2005-06-04 01:03:27 +08:00
|
|
|
init_MUTEX(&data->update_lock);
|
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
/* Init fake client data */
|
|
|
|
/* set the client data to the i2c_client so that it will get freed */
|
|
|
|
i2c_set_clientdata(fake_client, fake_client);
|
|
|
|
fake_client->addr = address | 1;
|
|
|
|
fake_client->adapter = adapter;
|
|
|
|
fake_client->driver = &max6875_driver;
|
|
|
|
fake_client->flags = 0;
|
2005-07-28 01:43:14 +08:00
|
|
|
strlcpy(fake_client->name, "max6875 subclient", I2C_NAME_SIZE);
|
2005-07-13 02:21:11 +08:00
|
|
|
|
|
|
|
/* Prevent 24RF08 corruption (in case of user error) */
|
|
|
|
i2c_smbus_write_quick(real_client, 0);
|
|
|
|
|
|
|
|
if ((err = i2c_attach_client(real_client)) != 0)
|
|
|
|
goto exit_kfree2;
|
|
|
|
|
|
|
|
if ((err = i2c_attach_client(fake_client)) != 0)
|
|
|
|
goto exit_detach;
|
|
|
|
|
|
|
|
sysfs_create_bin_file(&real_client->dev.kobj, &user_eeprom_attr);
|
2005-06-04 01:03:27 +08:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
|
2005-07-13 02:21:11 +08:00
|
|
|
exit_detach:
|
|
|
|
i2c_detach_client(real_client);
|
|
|
|
exit_kfree2:
|
|
|
|
kfree(fake_client);
|
|
|
|
exit_kfree1:
|
2005-06-04 01:03:27 +08:00
|
|
|
kfree(data);
|
|
|
|
return err;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int max6875_detach_client(struct i2c_client *client)
|
|
|
|
{
|
|
|
|
int err;
|
|
|
|
|
|
|
|
err = i2c_detach_client(client);
|
2005-07-28 04:14:49 +08:00
|
|
|
if (err)
|
2005-06-04 01:03:27 +08:00
|
|
|
return err;
|
|
|
|
kfree(i2c_get_clientdata(client));
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int __init max6875_init(void)
|
|
|
|
{
|
|
|
|
return i2c_add_driver(&max6875_driver);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void __exit max6875_exit(void)
|
|
|
|
{
|
|
|
|
i2c_del_driver(&max6875_driver);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
MODULE_AUTHOR("Ben Gardner <bgardner@wabtec.com>");
|
|
|
|
MODULE_DESCRIPTION("MAX6875 driver");
|
|
|
|
MODULE_LICENSE("GPL");
|
|
|
|
|
|
|
|
module_init(max6875_init);
|
|
|
|
module_exit(max6875_exit);
|