.. | .. |
---|
| 1 | +// SPDX-License-Identifier: GPL-2.0-only |
---|
1 | 2 | /* |
---|
2 | 3 | * I2C slave mode EEPROM simulator |
---|
3 | 4 | * |
---|
4 | 5 | * Copyright (C) 2014 by Wolfram Sang, Sang Engineering <wsa@sang-engineering.com> |
---|
5 | 6 | * Copyright (C) 2014 by Renesas Electronics Corporation |
---|
6 | 7 | * |
---|
7 | | - * This program is free software; you can redistribute it and/or modify it |
---|
8 | | - * under the terms of the GNU General Public License as published by the |
---|
9 | | - * Free Software Foundation; version 2 of the License. |
---|
10 | | - * |
---|
11 | | - * Because most IP blocks can only detect one I2C slave address anyhow, this |
---|
12 | | - * driver does not support simulating EEPROM types which take more than one |
---|
13 | | - * address. It is prepared to simulate bigger EEPROMs with an internal 16 bit |
---|
14 | | - * pointer, yet implementation is deferred until the need actually arises. |
---|
| 8 | + * Because most slave IP cores can only detect one I2C slave address anyhow, |
---|
| 9 | + * this driver does not support simulating EEPROM types which take more than |
---|
| 10 | + * one address. |
---|
15 | 11 | */ |
---|
16 | 12 | |
---|
| 13 | +/* |
---|
| 14 | + * FIXME: What to do if only 8 bits of a 16 bit address are sent? |
---|
| 15 | + * The ST-M24C64 sends only 0xff then. Needs verification with other |
---|
| 16 | + * EEPROMs, though. We currently use the 8 bit as a valid address. |
---|
| 17 | + */ |
---|
| 18 | + |
---|
| 19 | +#include <linux/bitfield.h> |
---|
| 20 | +#include <linux/firmware.h> |
---|
17 | 21 | #include <linux/i2c.h> |
---|
18 | 22 | #include <linux/init.h> |
---|
19 | 23 | #include <linux/module.h> |
---|
.. | .. |
---|
24 | 28 | |
---|
25 | 29 | struct eeprom_data { |
---|
26 | 30 | struct bin_attribute bin; |
---|
27 | | - bool first_write; |
---|
28 | 31 | spinlock_t buffer_lock; |
---|
29 | | - u8 buffer_idx; |
---|
| 32 | + u16 buffer_idx; |
---|
| 33 | + u16 address_mask; |
---|
| 34 | + u8 num_address_bytes; |
---|
| 35 | + u8 idx_write_cnt; |
---|
| 36 | + bool read_only; |
---|
30 | 37 | u8 buffer[]; |
---|
31 | 38 | }; |
---|
| 39 | + |
---|
| 40 | +#define I2C_SLAVE_BYTELEN GENMASK(15, 0) |
---|
| 41 | +#define I2C_SLAVE_FLAG_ADDR16 BIT(16) |
---|
| 42 | +#define I2C_SLAVE_FLAG_RO BIT(17) |
---|
| 43 | +#define I2C_SLAVE_DEVICE_MAGIC(_len, _flags) ((_flags) | ((_len) - 1)) |
---|
32 | 44 | |
---|
33 | 45 | static int i2c_slave_eeprom_slave_cb(struct i2c_client *client, |
---|
34 | 46 | enum i2c_slave_event event, u8 *val) |
---|
.. | .. |
---|
37 | 49 | |
---|
38 | 50 | switch (event) { |
---|
39 | 51 | case I2C_SLAVE_WRITE_RECEIVED: |
---|
40 | | - if (eeprom->first_write) { |
---|
41 | | - eeprom->buffer_idx = *val; |
---|
42 | | - eeprom->first_write = false; |
---|
| 52 | + if (eeprom->idx_write_cnt < eeprom->num_address_bytes) { |
---|
| 53 | + if (eeprom->idx_write_cnt == 0) |
---|
| 54 | + eeprom->buffer_idx = 0; |
---|
| 55 | + eeprom->buffer_idx = *val | (eeprom->buffer_idx << 8); |
---|
| 56 | + eeprom->idx_write_cnt++; |
---|
43 | 57 | } else { |
---|
44 | | - spin_lock(&eeprom->buffer_lock); |
---|
45 | | - eeprom->buffer[eeprom->buffer_idx++] = *val; |
---|
46 | | - spin_unlock(&eeprom->buffer_lock); |
---|
| 58 | + if (!eeprom->read_only) { |
---|
| 59 | + spin_lock(&eeprom->buffer_lock); |
---|
| 60 | + eeprom->buffer[eeprom->buffer_idx++ & eeprom->address_mask] = *val; |
---|
| 61 | + spin_unlock(&eeprom->buffer_lock); |
---|
| 62 | + } |
---|
47 | 63 | } |
---|
48 | 64 | break; |
---|
49 | 65 | |
---|
50 | 66 | case I2C_SLAVE_READ_PROCESSED: |
---|
51 | 67 | /* The previous byte made it to the bus, get next one */ |
---|
52 | 68 | eeprom->buffer_idx++; |
---|
53 | | - /* fallthrough */ |
---|
| 69 | + fallthrough; |
---|
54 | 70 | case I2C_SLAVE_READ_REQUESTED: |
---|
55 | 71 | spin_lock(&eeprom->buffer_lock); |
---|
56 | | - *val = eeprom->buffer[eeprom->buffer_idx]; |
---|
| 72 | + *val = eeprom->buffer[eeprom->buffer_idx & eeprom->address_mask]; |
---|
57 | 73 | spin_unlock(&eeprom->buffer_lock); |
---|
58 | 74 | /* |
---|
59 | 75 | * Do not increment buffer_idx here, because we don't know if |
---|
.. | .. |
---|
64 | 80 | |
---|
65 | 81 | case I2C_SLAVE_STOP: |
---|
66 | 82 | case I2C_SLAVE_WRITE_REQUESTED: |
---|
67 | | - eeprom->first_write = true; |
---|
| 83 | + eeprom->idx_write_cnt = 0; |
---|
68 | 84 | break; |
---|
69 | 85 | |
---|
70 | 86 | default: |
---|
.. | .. |
---|
80 | 96 | struct eeprom_data *eeprom; |
---|
81 | 97 | unsigned long flags; |
---|
82 | 98 | |
---|
83 | | - eeprom = dev_get_drvdata(container_of(kobj, struct device, kobj)); |
---|
| 99 | + eeprom = dev_get_drvdata(kobj_to_dev(kobj)); |
---|
84 | 100 | |
---|
85 | 101 | spin_lock_irqsave(&eeprom->buffer_lock, flags); |
---|
86 | 102 | memcpy(buf, &eeprom->buffer[off], count); |
---|
.. | .. |
---|
95 | 111 | struct eeprom_data *eeprom; |
---|
96 | 112 | unsigned long flags; |
---|
97 | 113 | |
---|
98 | | - eeprom = dev_get_drvdata(container_of(kobj, struct device, kobj)); |
---|
| 114 | + eeprom = dev_get_drvdata(kobj_to_dev(kobj)); |
---|
99 | 115 | |
---|
100 | 116 | spin_lock_irqsave(&eeprom->buffer_lock, flags); |
---|
101 | 117 | memcpy(&eeprom->buffer[off], buf, count); |
---|
.. | .. |
---|
104 | 120 | return count; |
---|
105 | 121 | } |
---|
106 | 122 | |
---|
| 123 | +static int i2c_slave_init_eeprom_data(struct eeprom_data *eeprom, struct i2c_client *client, |
---|
| 124 | + unsigned int size) |
---|
| 125 | +{ |
---|
| 126 | + const struct firmware *fw; |
---|
| 127 | + const char *eeprom_data; |
---|
| 128 | + int ret = device_property_read_string(&client->dev, "firmware-name", &eeprom_data); |
---|
| 129 | + |
---|
| 130 | + if (!ret) { |
---|
| 131 | + ret = request_firmware_into_buf(&fw, eeprom_data, &client->dev, |
---|
| 132 | + eeprom->buffer, size); |
---|
| 133 | + if (ret) |
---|
| 134 | + return ret; |
---|
| 135 | + release_firmware(fw); |
---|
| 136 | + } else { |
---|
| 137 | + /* An empty eeprom typically has all bits set to 1 */ |
---|
| 138 | + memset(eeprom->buffer, 0xff, size); |
---|
| 139 | + } |
---|
| 140 | + return 0; |
---|
| 141 | +} |
---|
| 142 | + |
---|
107 | 143 | static int i2c_slave_eeprom_probe(struct i2c_client *client, const struct i2c_device_id *id) |
---|
108 | 144 | { |
---|
109 | 145 | struct eeprom_data *eeprom; |
---|
110 | 146 | int ret; |
---|
111 | | - unsigned size = id->driver_data; |
---|
| 147 | + unsigned int size = FIELD_GET(I2C_SLAVE_BYTELEN, id->driver_data) + 1; |
---|
| 148 | + unsigned int flag_addr16 = FIELD_GET(I2C_SLAVE_FLAG_ADDR16, id->driver_data); |
---|
112 | 149 | |
---|
113 | 150 | eeprom = devm_kzalloc(&client->dev, sizeof(struct eeprom_data) + size, GFP_KERNEL); |
---|
114 | 151 | if (!eeprom) |
---|
115 | 152 | return -ENOMEM; |
---|
116 | 153 | |
---|
117 | | - eeprom->first_write = true; |
---|
| 154 | + eeprom->num_address_bytes = flag_addr16 ? 2 : 1; |
---|
| 155 | + eeprom->address_mask = size - 1; |
---|
| 156 | + eeprom->read_only = FIELD_GET(I2C_SLAVE_FLAG_RO, id->driver_data); |
---|
118 | 157 | spin_lock_init(&eeprom->buffer_lock); |
---|
119 | 158 | i2c_set_clientdata(client, eeprom); |
---|
| 159 | + |
---|
| 160 | + ret = i2c_slave_init_eeprom_data(eeprom, client, size); |
---|
| 161 | + if (ret) |
---|
| 162 | + return ret; |
---|
120 | 163 | |
---|
121 | 164 | sysfs_bin_attr_init(&eeprom->bin); |
---|
122 | 165 | eeprom->bin.attr.name = "slave-eeprom"; |
---|
.. | .. |
---|
149 | 192 | } |
---|
150 | 193 | |
---|
151 | 194 | static const struct i2c_device_id i2c_slave_eeprom_id[] = { |
---|
152 | | - { "slave-24c02", 2048 / 8 }, |
---|
| 195 | + { "slave-24c02", I2C_SLAVE_DEVICE_MAGIC(2048 / 8, 0) }, |
---|
| 196 | + { "slave-24c02ro", I2C_SLAVE_DEVICE_MAGIC(2048 / 8, I2C_SLAVE_FLAG_RO) }, |
---|
| 197 | + { "slave-24c32", I2C_SLAVE_DEVICE_MAGIC(32768 / 8, I2C_SLAVE_FLAG_ADDR16) }, |
---|
| 198 | + { "slave-24c32ro", I2C_SLAVE_DEVICE_MAGIC(32768 / 8, I2C_SLAVE_FLAG_ADDR16 | I2C_SLAVE_FLAG_RO) }, |
---|
| 199 | + { "slave-24c64", I2C_SLAVE_DEVICE_MAGIC(65536 / 8, I2C_SLAVE_FLAG_ADDR16) }, |
---|
| 200 | + { "slave-24c64ro", I2C_SLAVE_DEVICE_MAGIC(65536 / 8, I2C_SLAVE_FLAG_ADDR16 | I2C_SLAVE_FLAG_RO) }, |
---|
| 201 | + { "slave-24c512", I2C_SLAVE_DEVICE_MAGIC(524288 / 8, I2C_SLAVE_FLAG_ADDR16) }, |
---|
| 202 | + { "slave-24c512ro", I2C_SLAVE_DEVICE_MAGIC(524288 / 8, I2C_SLAVE_FLAG_ADDR16 | I2C_SLAVE_FLAG_RO) }, |
---|
153 | 203 | { } |
---|
154 | 204 | }; |
---|
155 | 205 | MODULE_DEVICE_TABLE(i2c, i2c_slave_eeprom_id); |
---|