^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright (C) 1998, 1999 Frodo Looijaard <frodol@dds.nl> and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Philip Edelbrock <phil@netroedge.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 2003 Greg Kroah-Hartman <greg@kroah.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (C) 2003 IBM Corp.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Copyright (C) 2004 Jean Delvare <jdelvare@suse.de>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #include <linux/kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/capability.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/jiffies.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/i2c.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/mutex.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) /* Addresses to scan */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) static const unsigned short normal_i2c[] = { 0x50, 0x51, 0x52, 0x53, 0x54,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) 0x55, 0x56, 0x57, I2C_CLIENT_END };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) /* Size of EEPROM in bytes */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) #define EEPROM_SIZE 256
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) /* possible types of eeprom devices */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) enum eeprom_nature {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) UNKNOWN,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) VAIO,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) /* Each client has this additional data */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) struct eeprom_data {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) struct mutex update_lock;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) u8 valid; /* bitfield, bit!=0 if slice is valid */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) unsigned long last_updated[8]; /* In jiffies, 8 slices */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) u8 data[EEPROM_SIZE]; /* Register values */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) enum eeprom_nature nature;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) static void eeprom_update_client(struct i2c_client *client, u8 slice)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) struct eeprom_data *data = i2c_get_clientdata(client);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) mutex_lock(&data->update_lock);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) if (!(data->valid & (1 << slice)) ||
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) time_after(jiffies, data->last_updated[slice] + 300 * HZ)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) dev_dbg(&client->dev, "Starting eeprom update, slice %u\n", slice);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_I2C_BLOCK)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) for (i = slice << 5; i < (slice + 1) << 5; i += 32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) if (i2c_smbus_read_i2c_block_data(client, i,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) 32, data->data + i)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) != 32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) goto exit;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) for (i = slice << 5; i < (slice + 1) << 5; i += 2) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) int word = i2c_smbus_read_word_data(client, i);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) if (word < 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) goto exit;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) data->data[i] = word & 0xff;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) data->data[i + 1] = word >> 8;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) data->last_updated[slice] = jiffies;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) data->valid |= (1 << slice);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) exit:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) mutex_unlock(&data->update_lock);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) static ssize_t eeprom_read(struct file *filp, struct kobject *kobj,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) struct bin_attribute *bin_attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) char *buf, loff_t off, size_t count)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) struct i2c_client *client = kobj_to_i2c_client(kobj);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) struct eeprom_data *data = i2c_get_clientdata(client);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) u8 slice;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) /* Only refresh slices which contain requested bytes */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) for (slice = off >> 5; slice <= (off + count - 1) >> 5; slice++)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) eeprom_update_client(client, slice);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) /* Hide Vaio private settings to regular users:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) - BIOS passwords: bytes 0x00 to 0x0f
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) - UUID: bytes 0x10 to 0x1f
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) - Serial number: 0xc0 to 0xdf */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) if (data->nature == VAIO && !capable(CAP_SYS_ADMIN)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) int i;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) for (i = 0; i < count; i++) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) if ((off + i <= 0x1f) ||
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) (off + i >= 0xc0 && off + i <= 0xdf))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) buf[i] = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) buf[i] = data->data[off + i];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) memcpy(buf, &data->data[off], count);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) return count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) static const struct bin_attribute eeprom_attr = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) .attr = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) .name = "eeprom",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) .mode = S_IRUGO,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) .size = EEPROM_SIZE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) .read = eeprom_read,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) /* Return 0 if detection is successful, -ENODEV otherwise */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) static int eeprom_detect(struct i2c_client *client, struct i2c_board_info *info)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) struct i2c_adapter *adapter = client->adapter;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) /* EDID EEPROMs are often 24C00 EEPROMs, which answer to all
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) addresses 0x50-0x57, but we only care about 0x50. So decline
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) attaching to addresses >= 0x51 on DDC buses */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) if (!(adapter->class & I2C_CLASS_SPD) && client->addr >= 0x51)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) return -ENODEV;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) /* There are four ways we can read the EEPROM data:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) (1) I2C block reads (faster, but unsupported by most adapters)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) (2) Word reads (128% overhead)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) (3) Consecutive byte reads (88% overhead, unsafe)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) (4) Regular byte data reads (265% overhead)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) The third and fourth methods are not implemented by this driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) because all known adapters support one of the first two. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_READ_WORD_DATA)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) && !i2c_check_functionality(adapter, I2C_FUNC_SMBUS_READ_I2C_BLOCK))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) return -ENODEV;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) strlcpy(info->type, "eeprom", I2C_NAME_SIZE);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) static int eeprom_probe(struct i2c_client *client,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) const struct i2c_device_id *id)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) struct i2c_adapter *adapter = client->adapter;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) struct eeprom_data *data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) data = devm_kzalloc(&client->dev, sizeof(struct eeprom_data),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) if (!data)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) memset(data->data, 0xff, EEPROM_SIZE);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) i2c_set_clientdata(client, data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) mutex_init(&data->update_lock);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) data->nature = UNKNOWN;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) /* Detect the Vaio nature of EEPROMs.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) We use the "PCG-" or "VGN-" prefix as the signature. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) if (client->addr == 0x57
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) && i2c_check_functionality(adapter, I2C_FUNC_SMBUS_READ_BYTE_DATA)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) char name[4];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) name[0] = i2c_smbus_read_byte_data(client, 0x80);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) name[1] = i2c_smbus_read_byte_data(client, 0x81);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) name[2] = i2c_smbus_read_byte_data(client, 0x82);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) name[3] = i2c_smbus_read_byte_data(client, 0x83);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) if (!memcmp(name, "PCG-", 4) || !memcmp(name, "VGN-", 4)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) dev_info(&client->dev, "Vaio EEPROM detected, "
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) "enabling privacy protection\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) data->nature = VAIO;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) /* Let the users know they are using deprecated driver */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) dev_notice(&client->dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) "eeprom driver is deprecated, please use at24 instead\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) /* create the sysfs eeprom file */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) return sysfs_create_bin_file(&client->dev.kobj, &eeprom_attr);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) static int eeprom_remove(struct i2c_client *client)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) sysfs_remove_bin_file(&client->dev.kobj, &eeprom_attr);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) static const struct i2c_device_id eeprom_id[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) { "eeprom", 0 },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) { }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) static struct i2c_driver eeprom_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) .driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) .name = "eeprom",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) .probe = eeprom_probe,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) .remove = eeprom_remove,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) .id_table = eeprom_id,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) .class = I2C_CLASS_DDC | I2C_CLASS_SPD,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) .detect = eeprom_detect,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) .address_list = normal_i2c,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) module_i2c_driver(eeprom_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) "Philip Edelbrock <phil@netroedge.com> and "
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) "Greg Kroah-Hartman <greg@kroah.com>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) MODULE_DESCRIPTION("I2C EEPROM driver");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) MODULE_LICENSE("GPL");