1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * i2c-smbus.c - SMBus extensions to the I2C protocol
5 * Copyright (C) 2008 David Brownell
6 * Copyright (C) 2010-2019 Jean Delvare <jdelvare@suse.de>
9 #include <linux/device.h>
10 #include <linux/dmi.h>
11 #include <linux/i2c.h>
12 #include <linux/i2c-smbus.h>
13 #include <linux/interrupt.h>
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/property.h>
17 #include <linux/slab.h>
18 #include <linux/workqueue.h>
20 struct i2c_smbus_alert {
21 struct work_struct alert;
22 struct i2c_client *ara; /* Alert response address */
27 enum i2c_alert_protocol type;
31 /* If this is the alerting device, notify its driver */
32 static int smbus_do_alert(struct device *dev, void *addrp)
34 struct i2c_client *client = i2c_verify_client(dev);
35 struct alert_data *data = addrp;
36 struct i2c_driver *driver;
38 if (!client || client->addr != data->addr)
40 if (client->flags & I2C_CLIENT_TEN)
44 * Drivers should either disable alerts, or provide at least
45 * a minimal handler. Lock so the driver won't change.
48 if (client->dev.driver) {
49 driver = to_i2c_driver(client->dev.driver);
51 driver->alert(client, data->type, data->data);
53 dev_warn(&client->dev, "no driver alert()!\n");
55 dev_dbg(&client->dev, "alert with no driver\n");
58 /* Stop iterating after we find the device */
63 * The alert IRQ handler needs to hand work off to a task which can issue
64 * SMBus calls, because those sleeping calls can't be made in IRQ context.
66 static irqreturn_t smbus_alert(int irq, void *d)
68 struct i2c_smbus_alert *alert = d;
69 struct i2c_client *ara;
75 struct alert_data data;
78 * Devices with pending alerts reply in address order, low
79 * to high, because of slave transmit arbitration. After
80 * responding, an SMBus device stops asserting SMBALERT#.
82 * Note that SMBus 2.0 reserves 10-bit addresses for future
83 * use. We neither handle them, nor try to use PEC here.
85 status = i2c_smbus_read_byte(ara);
89 data.data = status & 1;
90 data.addr = status >> 1;
91 data.type = I2C_PROTOCOL_SMBUS_ALERT;
93 dev_dbg(&ara->dev, "SMBALERT# from dev 0x%02x, flag %d\n",
94 data.addr, data.data);
96 /* Notify driver for the device which issued the alert */
97 device_for_each_child(&ara->adapter->dev, &data,
104 static void smbalert_work(struct work_struct *work)
106 struct i2c_smbus_alert *alert;
108 alert = container_of(work, struct i2c_smbus_alert, alert);
110 smbus_alert(0, alert);
114 /* Setup SMBALERT# infrastructure */
115 static int smbalert_probe(struct i2c_client *ara,
116 const struct i2c_device_id *id)
118 struct i2c_smbus_alert_setup *setup = dev_get_platdata(&ara->dev);
119 struct i2c_smbus_alert *alert;
120 struct i2c_adapter *adapter = ara->adapter;
123 alert = devm_kzalloc(&ara->dev, sizeof(struct i2c_smbus_alert),
131 irq = fwnode_irq_get_byname(dev_fwnode(adapter->dev.parent),
137 INIT_WORK(&alert->alert, smbalert_work);
141 res = devm_request_threaded_irq(&ara->dev, irq,
143 IRQF_SHARED | IRQF_ONESHOT,
144 "smbus_alert", alert);
149 i2c_set_clientdata(ara, alert);
150 dev_info(&adapter->dev, "supports SMBALERT#\n");
155 /* IRQ and memory resources are managed so they are freed automatically */
156 static int smbalert_remove(struct i2c_client *ara)
158 struct i2c_smbus_alert *alert = i2c_get_clientdata(ara);
160 cancel_work_sync(&alert->alert);
164 static const struct i2c_device_id smbalert_ids[] = {
165 { "smbus_alert", 0 },
168 MODULE_DEVICE_TABLE(i2c, smbalert_ids);
170 static struct i2c_driver smbalert_driver = {
172 .name = "smbus_alert",
174 .probe = smbalert_probe,
175 .remove = smbalert_remove,
176 .id_table = smbalert_ids,
180 * i2c_handle_smbus_alert - Handle an SMBus alert
181 * @ara: the ARA client on the relevant adapter
182 * Context: can't sleep
184 * Helper function to be called from an I2C bus driver's interrupt
185 * handler. It will schedule the alert work, in turn calling the
186 * corresponding I2C device driver's alert function.
188 * It is assumed that ara is a valid i2c client previously returned by
189 * i2c_new_smbus_alert_device().
191 int i2c_handle_smbus_alert(struct i2c_client *ara)
193 struct i2c_smbus_alert *alert = i2c_get_clientdata(ara);
195 return schedule_work(&alert->alert);
197 EXPORT_SYMBOL_GPL(i2c_handle_smbus_alert);
199 module_i2c_driver(smbalert_driver);
201 #if IS_ENABLED(CONFIG_I2C_SLAVE)
202 #define SMBUS_HOST_NOTIFY_LEN 3
203 struct i2c_slave_host_notify_status {
208 static int i2c_slave_host_notify_cb(struct i2c_client *client,
209 enum i2c_slave_event event, u8 *val)
211 struct i2c_slave_host_notify_status *status = client->dev.platform_data;
214 case I2C_SLAVE_WRITE_RECEIVED:
215 /* We only retrieve the first byte received (addr)
216 * since there is currently no support to retrieve the data
217 * parameter from the client.
219 if (status->index == 0)
221 if (status->index < U8_MAX)
225 if (status->index == SMBUS_HOST_NOTIFY_LEN)
226 i2c_handle_smbus_host_notify(client->adapter,
229 case I2C_SLAVE_WRITE_REQUESTED:
232 case I2C_SLAVE_READ_REQUESTED:
233 case I2C_SLAVE_READ_PROCESSED:
242 * i2c_new_slave_host_notify_device - get a client for SMBus host-notify support
243 * @adapter: the target adapter
246 * Setup handling of the SMBus host-notify protocol on a given I2C bus segment.
248 * Handling is done by creating a device and its callback and handling data
249 * received via the SMBus host-notify address (0x8)
251 * This returns the client, which should be ultimately freed using
252 * i2c_free_slave_host_notify_device(); or an ERRPTR to indicate an error.
254 struct i2c_client *i2c_new_slave_host_notify_device(struct i2c_adapter *adapter)
256 struct i2c_board_info host_notify_board_info = {
257 I2C_BOARD_INFO("smbus_host_notify", 0x08),
258 .flags = I2C_CLIENT_SLAVE,
260 struct i2c_slave_host_notify_status *status;
261 struct i2c_client *client;
264 status = kzalloc(sizeof(struct i2c_slave_host_notify_status),
267 return ERR_PTR(-ENOMEM);
269 host_notify_board_info.platform_data = status;
271 client = i2c_new_client_device(adapter, &host_notify_board_info);
272 if (IS_ERR(client)) {
277 ret = i2c_slave_register(client, i2c_slave_host_notify_cb);
279 i2c_unregister_device(client);
286 EXPORT_SYMBOL_GPL(i2c_new_slave_host_notify_device);
289 * i2c_free_slave_host_notify_device - free the client for SMBus host-notify
291 * @client: the client to free
294 * Free the i2c_client allocated via i2c_new_slave_host_notify_device
296 void i2c_free_slave_host_notify_device(struct i2c_client *client)
298 if (IS_ERR_OR_NULL(client))
301 i2c_slave_unregister(client);
302 kfree(client->dev.platform_data);
303 i2c_unregister_device(client);
305 EXPORT_SYMBOL_GPL(i2c_free_slave_host_notify_device);
309 * SPD is not part of SMBus but we include it here for convenience as the
310 * target systems are the same.
311 * Restrictions to automatic SPD instantiation:
312 * - Only works if all filled slots have the same memory type
313 * - Only works for DDR2, DDR3 and DDR4 for now
314 * - Only works on systems with 1 to 4 memory slots
316 #if IS_ENABLED(CONFIG_DMI)
317 void i2c_register_spd(struct i2c_adapter *adap)
319 int n, slot_count = 0, dimm_count = 0;
321 u8 common_mem_type = 0x0, mem_type;
325 while ((handle = dmi_memdev_handle(slot_count)) != 0xffff) {
328 /* Skip empty slots */
329 mem_size = dmi_memdev_size(handle);
333 /* Skip undefined memory type */
334 mem_type = dmi_memdev_type(handle);
335 if (mem_type <= 0x02) /* Invalid, Other, Unknown */
338 if (!common_mem_type) {
339 /* First filled slot */
340 common_mem_type = mem_type;
342 /* Check that all filled slots have the same type */
343 if (mem_type != common_mem_type) {
345 "Different memory types mixed, not instantiating SPD\n");
352 /* No useful DMI data, bail out */
356 dev_info(&adap->dev, "%d/%d memory slots populated (from DMI)\n",
357 dimm_count, slot_count);
359 if (slot_count > 4) {
361 "Systems with more than 4 memory slots not supported yet, not instantiating SPD\n");
365 switch (common_mem_type) {
366 case 0x13: /* DDR2 */
367 case 0x18: /* DDR3 */
368 case 0x1C: /* LPDDR2 */
369 case 0x1D: /* LPDDR3 */
372 case 0x1A: /* DDR4 */
373 case 0x1E: /* LPDDR4 */
378 "Memory type 0x%02x not supported yet, not instantiating SPD\n",
384 * We don't know in which slots the memory modules are. We could
385 * try to guess from the slot names, but that would be rather complex
386 * and unreliable, so better probe all possible addresses until we
387 * have found all memory modules.
389 for (n = 0; n < slot_count && dimm_count; n++) {
390 struct i2c_board_info info;
391 unsigned short addr_list[2];
393 memset(&info, 0, sizeof(struct i2c_board_info));
394 strlcpy(info.type, name, I2C_NAME_SIZE);
395 addr_list[0] = 0x50 + n;
396 addr_list[1] = I2C_CLIENT_END;
398 if (!IS_ERR(i2c_new_scanned_device(adap, &info, addr_list, NULL))) {
400 "Successfully instantiated SPD at 0x%hx\n",
406 EXPORT_SYMBOL_GPL(i2c_register_spd);
409 MODULE_AUTHOR("Jean Delvare <jdelvare@suse.de>");
410 MODULE_DESCRIPTION("SMBus protocol extensions support");
411 MODULE_LICENSE("GPL");