161e3d0f7SWolfram Sang /* 261e3d0f7SWolfram Sang * Linux I2C core 361e3d0f7SWolfram Sang * 461e3d0f7SWolfram Sang * Copyright (C) 1995-99 Simon G. Vogl 561e3d0f7SWolfram Sang * With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> 661e3d0f7SWolfram Sang * Mux support by Rodolfo Giometti <giometti@enneenne.com> and 761e3d0f7SWolfram Sang * Michael Lawnick <michael.lawnick.ext@nsn.com> 861e3d0f7SWolfram Sang * 961e3d0f7SWolfram Sang * Copyright (C) 2013-2017 Wolfram Sang <wsa@the-dreams.de> 1061e3d0f7SWolfram Sang * 1161e3d0f7SWolfram Sang * This program is free software; you can redistribute it and/or modify it 1261e3d0f7SWolfram Sang * under the terms of the GNU General Public License as published by the Free 1361e3d0f7SWolfram Sang * Software Foundation; either version 2 of the License, or (at your option) 1461e3d0f7SWolfram Sang * any later version. 1561e3d0f7SWolfram Sang * 1661e3d0f7SWolfram Sang * This program is distributed in the hope that it will be useful, but WITHOUT 1761e3d0f7SWolfram Sang * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 1861e3d0f7SWolfram Sang * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 1991ed5349SWolfram Sang */ 2091ed5349SWolfram Sang 2191ed5349SWolfram Sang #define pr_fmt(fmt) "i2c-core: " fmt 2291ed5349SWolfram Sang 2391ed5349SWolfram Sang #include <dt-bindings/i2c/i2c.h> 2491ed5349SWolfram Sang #include <linux/acpi.h> 2591ed5349SWolfram Sang #include <linux/clk/clk-conf.h> 2691ed5349SWolfram Sang #include <linux/completion.h> 2791ed5349SWolfram Sang #include <linux/delay.h> 2891ed5349SWolfram Sang #include <linux/err.h> 2991ed5349SWolfram Sang #include <linux/errno.h> 3010c9ef04SPhil Reid #include <linux/gpio/consumer.h> 3191ed5349SWolfram Sang #include <linux/i2c.h> 32f8756c67SPhil Reid #include <linux/i2c-smbus.h> 3391ed5349SWolfram Sang #include <linux/idr.h> 3491ed5349SWolfram Sang #include <linux/init.h> 3591ed5349SWolfram Sang #include <linux/irqflags.h> 3691ed5349SWolfram Sang #include <linux/jump_label.h> 3791ed5349SWolfram Sang #include <linux/kernel.h> 3891ed5349SWolfram Sang #include <linux/module.h> 3991ed5349SWolfram Sang #include <linux/mutex.h> 4091ed5349SWolfram Sang #include <linux/of_device.h> 4191ed5349SWolfram Sang #include <linux/of.h> 4291ed5349SWolfram Sang #include <linux/of_irq.h> 4391ed5349SWolfram Sang #include <linux/pm_domain.h> 4491ed5349SWolfram Sang #include <linux/pm_runtime.h> 4591ed5349SWolfram Sang #include <linux/pm_wakeirq.h> 4691ed5349SWolfram Sang #include <linux/property.h> 4791ed5349SWolfram Sang #include <linux/rwsem.h> 4891ed5349SWolfram Sang #include <linux/slab.h> 4991ed5349SWolfram Sang 5091ed5349SWolfram Sang #include "i2c-core.h" 5191ed5349SWolfram Sang 5291ed5349SWolfram Sang #define CREATE_TRACE_POINTS 5391ed5349SWolfram Sang #include <trace/events/i2c.h> 5491ed5349SWolfram Sang 5591ed5349SWolfram Sang #define I2C_ADDR_OFFSET_TEN_BIT 0xa000 5691ed5349SWolfram Sang #define I2C_ADDR_OFFSET_SLAVE 0x1000 5791ed5349SWolfram Sang 5891ed5349SWolfram Sang #define I2C_ADDR_7BITS_MAX 0x77 5991ed5349SWolfram Sang #define I2C_ADDR_7BITS_COUNT (I2C_ADDR_7BITS_MAX + 1) 6091ed5349SWolfram Sang 61dde67eb1SPeter Rosin #define I2C_ADDR_DEVICE_ID 0x7c 62dde67eb1SPeter Rosin 6361e3d0f7SWolfram Sang /* 6461e3d0f7SWolfram Sang * core_lock protects i2c_adapter_idr, and guarantees that device detection, 6561e3d0f7SWolfram Sang * deletion of detected devices, and attach_adapter calls are serialized 6661e3d0f7SWolfram Sang */ 6791ed5349SWolfram Sang static DEFINE_MUTEX(core_lock); 6891ed5349SWolfram Sang static DEFINE_IDR(i2c_adapter_idr); 6991ed5349SWolfram Sang 7091ed5349SWolfram Sang static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver); 7191ed5349SWolfram Sang 7250888b01SDavidlohr Bueso static DEFINE_STATIC_KEY_FALSE(i2c_trace_msg_key); 7391ed5349SWolfram Sang static bool is_registered; 7491ed5349SWolfram Sang 7591ed5349SWolfram Sang int i2c_transfer_trace_reg(void) 7691ed5349SWolfram Sang { 7750888b01SDavidlohr Bueso static_branch_inc(&i2c_trace_msg_key); 7891ed5349SWolfram Sang return 0; 7991ed5349SWolfram Sang } 8091ed5349SWolfram Sang 8191ed5349SWolfram Sang void i2c_transfer_trace_unreg(void) 8291ed5349SWolfram Sang { 8350888b01SDavidlohr Bueso static_branch_dec(&i2c_trace_msg_key); 8491ed5349SWolfram Sang } 8591ed5349SWolfram Sang 8691ed5349SWolfram Sang const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id, 8791ed5349SWolfram Sang const struct i2c_client *client) 8891ed5349SWolfram Sang { 8991ed5349SWolfram Sang if (!(id && client)) 9091ed5349SWolfram Sang return NULL; 9191ed5349SWolfram Sang 9291ed5349SWolfram Sang while (id->name[0]) { 9391ed5349SWolfram Sang if (strcmp(client->name, id->name) == 0) 9491ed5349SWolfram Sang return id; 9591ed5349SWolfram Sang id++; 9691ed5349SWolfram Sang } 9791ed5349SWolfram Sang return NULL; 9891ed5349SWolfram Sang } 9991ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_match_id); 10091ed5349SWolfram Sang 10191ed5349SWolfram Sang static int i2c_device_match(struct device *dev, struct device_driver *drv) 10291ed5349SWolfram Sang { 10391ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 10491ed5349SWolfram Sang struct i2c_driver *driver; 10591ed5349SWolfram Sang 10691ed5349SWolfram Sang 10791ed5349SWolfram Sang /* Attempt an OF style match */ 10891ed5349SWolfram Sang if (i2c_of_match_device(drv->of_match_table, client)) 10991ed5349SWolfram Sang return 1; 11091ed5349SWolfram Sang 11191ed5349SWolfram Sang /* Then ACPI style match */ 11291ed5349SWolfram Sang if (acpi_driver_match_device(dev, drv)) 11391ed5349SWolfram Sang return 1; 11491ed5349SWolfram Sang 11591ed5349SWolfram Sang driver = to_i2c_driver(drv); 11691ed5349SWolfram Sang 11791ed5349SWolfram Sang /* Finally an I2C match */ 11891ed5349SWolfram Sang if (i2c_match_id(driver->id_table, client)) 11991ed5349SWolfram Sang return 1; 12091ed5349SWolfram Sang 12191ed5349SWolfram Sang return 0; 12291ed5349SWolfram Sang } 12391ed5349SWolfram Sang 12491ed5349SWolfram Sang static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env) 12591ed5349SWolfram Sang { 12691ed5349SWolfram Sang struct i2c_client *client = to_i2c_client(dev); 12791ed5349SWolfram Sang int rc; 12891ed5349SWolfram Sang 129af503716SJavier Martinez Canillas rc = of_device_uevent_modalias(dev, env); 130af503716SJavier Martinez Canillas if (rc != -ENODEV) 131af503716SJavier Martinez Canillas return rc; 132af503716SJavier Martinez Canillas 13391ed5349SWolfram Sang rc = acpi_device_uevent_modalias(dev, env); 13491ed5349SWolfram Sang if (rc != -ENODEV) 13591ed5349SWolfram Sang return rc; 13691ed5349SWolfram Sang 13791ed5349SWolfram Sang return add_uevent_var(env, "MODALIAS=%s%s", I2C_MODULE_PREFIX, client->name); 13891ed5349SWolfram Sang } 13991ed5349SWolfram Sang 14091ed5349SWolfram Sang /* i2c bus recovery routines */ 14191ed5349SWolfram Sang static int get_scl_gpio_value(struct i2c_adapter *adap) 14291ed5349SWolfram Sang { 1433991c5c8SPhil Reid return gpiod_get_value_cansleep(adap->bus_recovery_info->scl_gpiod); 14491ed5349SWolfram Sang } 14591ed5349SWolfram Sang 14691ed5349SWolfram Sang static void set_scl_gpio_value(struct i2c_adapter *adap, int val) 14791ed5349SWolfram Sang { 1483991c5c8SPhil Reid gpiod_set_value_cansleep(adap->bus_recovery_info->scl_gpiod, val); 14991ed5349SWolfram Sang } 15091ed5349SWolfram Sang 15191ed5349SWolfram Sang static int get_sda_gpio_value(struct i2c_adapter *adap) 15291ed5349SWolfram Sang { 1533991c5c8SPhil Reid return gpiod_get_value_cansleep(adap->bus_recovery_info->sda_gpiod); 15491ed5349SWolfram Sang } 15591ed5349SWolfram Sang 1568092178fSWolfram Sang static void set_sda_gpio_value(struct i2c_adapter *adap, int val) 15791ed5349SWolfram Sang { 1588092178fSWolfram Sang gpiod_set_value_cansleep(adap->bus_recovery_info->sda_gpiod, val); 15991ed5349SWolfram Sang } 16091ed5349SWolfram Sang 1617ca5f6beSWolfram Sang static int i2c_generic_bus_free(struct i2c_adapter *adap) 1627ca5f6beSWolfram Sang { 1637ca5f6beSWolfram Sang struct i2c_bus_recovery_info *bri = adap->bus_recovery_info; 1647ca5f6beSWolfram Sang int ret = -EOPNOTSUPP; 1657ca5f6beSWolfram Sang 1667ca5f6beSWolfram Sang if (bri->get_bus_free) 1677ca5f6beSWolfram Sang ret = bri->get_bus_free(adap); 1687ca5f6beSWolfram Sang else if (bri->get_sda) 1697ca5f6beSWolfram Sang ret = bri->get_sda(adap); 1707ca5f6beSWolfram Sang 1717ca5f6beSWolfram Sang if (ret < 0) 1727ca5f6beSWolfram Sang return ret; 1737ca5f6beSWolfram Sang 1747ca5f6beSWolfram Sang return ret ? 0 : -EBUSY; 1757ca5f6beSWolfram Sang } 1767ca5f6beSWolfram Sang 17791ed5349SWolfram Sang /* 17891ed5349SWolfram Sang * We are generating clock pulses. ndelay() determines durating of clk pulses. 17991ed5349SWolfram Sang * We will generate clock with rate 100 KHz and so duration of both clock levels 18091ed5349SWolfram Sang * is: delay in ns = (10^6 / 100) / 2 18191ed5349SWolfram Sang */ 18291ed5349SWolfram Sang #define RECOVERY_NDELAY 5000 18391ed5349SWolfram Sang #define RECOVERY_CLK_CNT 9 18491ed5349SWolfram Sang 185e1eb7d28SPhil Reid int i2c_generic_scl_recovery(struct i2c_adapter *adap) 18691ed5349SWolfram Sang { 18791ed5349SWolfram Sang struct i2c_bus_recovery_info *bri = adap->bus_recovery_info; 188f7ff75e2SWolfram Sang int i = 0, scl = 1, ret; 18991ed5349SWolfram Sang 19091ed5349SWolfram Sang if (bri->prepare_recovery) 19191ed5349SWolfram Sang bri->prepare_recovery(adap); 19291ed5349SWolfram Sang 193c4ae05b9SWolfram Sang /* 194c4ae05b9SWolfram Sang * If we can set SDA, we will always create a STOP to ensure additional 195c4ae05b9SWolfram Sang * pulses will do no harm. This is achieved by letting SDA follow SCL 196c4ae05b9SWolfram Sang * half a cycle later. Check the 'incomplete_write_byte' fault injector 197c4ae05b9SWolfram Sang * for details. 198c4ae05b9SWolfram Sang */ 199f7ff75e2SWolfram Sang bri->set_scl(adap, scl); 200c4ae05b9SWolfram Sang ndelay(RECOVERY_NDELAY / 2); 20172b08fccSWolfram Sang if (bri->set_sda) 202c4ae05b9SWolfram Sang bri->set_sda(adap, scl); 203c4ae05b9SWolfram Sang ndelay(RECOVERY_NDELAY / 2); 20491ed5349SWolfram Sang 20591ed5349SWolfram Sang /* 20691ed5349SWolfram Sang * By this time SCL is high, as we need to give 9 falling-rising edges 20791ed5349SWolfram Sang */ 20891ed5349SWolfram Sang while (i++ < RECOVERY_CLK_CNT * 2) { 209f7ff75e2SWolfram Sang if (scl) { 21091ed5349SWolfram Sang /* SCL shouldn't be low here */ 21191ed5349SWolfram Sang if (!bri->get_scl(adap)) { 21291ed5349SWolfram Sang dev_err(&adap->dev, 21391ed5349SWolfram Sang "SCL is stuck low, exit recovery\n"); 21491ed5349SWolfram Sang ret = -EBUSY; 21591ed5349SWolfram Sang break; 21691ed5349SWolfram Sang } 21791ed5349SWolfram Sang } 21891ed5349SWolfram Sang 219f7ff75e2SWolfram Sang scl = !scl; 220f7ff75e2SWolfram Sang bri->set_scl(adap, scl); 221c4ae05b9SWolfram Sang /* Creating STOP again, see above */ 222abe41184SWolfram Sang ndelay(RECOVERY_NDELAY / 2); 223abe41184SWolfram Sang if (bri->set_sda) 224f7ff75e2SWolfram Sang bri->set_sda(adap, scl); 225abe41184SWolfram Sang ndelay(RECOVERY_NDELAY / 2); 2260b71026cSWolfram Sang 227f7ff75e2SWolfram Sang if (scl) { 2287ca5f6beSWolfram Sang ret = i2c_generic_bus_free(adap); 2290b71026cSWolfram Sang if (ret == 0) 2300b71026cSWolfram Sang break; 23191ed5349SWolfram Sang } 2322806e6adSWolfram Sang } 2332806e6adSWolfram Sang 2347ca5f6beSWolfram Sang /* If we can't check bus status, assume recovery worked */ 2357ca5f6beSWolfram Sang if (ret == -EOPNOTSUPP) 2367ca5f6beSWolfram Sang ret = 0; 2377ca5f6beSWolfram Sang 23891ed5349SWolfram Sang if (bri->unprepare_recovery) 23991ed5349SWolfram Sang bri->unprepare_recovery(adap); 24091ed5349SWolfram Sang 24191ed5349SWolfram Sang return ret; 24291ed5349SWolfram Sang } 24391ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_generic_scl_recovery); 24491ed5349SWolfram Sang 24591ed5349SWolfram Sang int i2c_recover_bus(struct i2c_adapter *adap) 24691ed5349SWolfram Sang { 24791ed5349SWolfram Sang if (!adap->bus_recovery_info) 24891ed5349SWolfram Sang return -EOPNOTSUPP; 24991ed5349SWolfram Sang 25091ed5349SWolfram Sang dev_dbg(&adap->dev, "Trying i2c bus recovery\n"); 25191ed5349SWolfram Sang return adap->bus_recovery_info->recover_bus(adap); 25291ed5349SWolfram Sang } 25391ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_recover_bus); 25491ed5349SWolfram Sang 25591ed5349SWolfram Sang static void i2c_init_recovery(struct i2c_adapter *adap) 25691ed5349SWolfram Sang { 25791ed5349SWolfram Sang struct i2c_bus_recovery_info *bri = adap->bus_recovery_info; 25891ed5349SWolfram Sang char *err_str; 25991ed5349SWolfram Sang 26091ed5349SWolfram Sang if (!bri) 26191ed5349SWolfram Sang return; 26291ed5349SWolfram Sang 26391ed5349SWolfram Sang if (!bri->recover_bus) { 26491ed5349SWolfram Sang err_str = "no recover_bus() found"; 26591ed5349SWolfram Sang goto err; 26691ed5349SWolfram Sang } 26791ed5349SWolfram Sang 2683991c5c8SPhil Reid if (bri->scl_gpiod && bri->recover_bus == i2c_generic_scl_recovery) { 26991ed5349SWolfram Sang bri->get_scl = get_scl_gpio_value; 27091ed5349SWolfram Sang bri->set_scl = set_scl_gpio_value; 2718092178fSWolfram Sang if (bri->sda_gpiod) { 2723991c5c8SPhil Reid bri->get_sda = get_sda_gpio_value; 2738092178fSWolfram Sang /* FIXME: add proper flag instead of '0' once available */ 2748092178fSWolfram Sang if (gpiod_get_direction(bri->sda_gpiod) == 0) 2758092178fSWolfram Sang bri->set_sda = set_sda_gpio_value; 2768092178fSWolfram Sang } 2773991c5c8SPhil Reid return; 2783991c5c8SPhil Reid } 2793991c5c8SPhil Reid 280e1eb7d28SPhil Reid if (bri->recover_bus == i2c_generic_scl_recovery) { 28191ed5349SWolfram Sang /* Generic SCL recovery */ 28291ed5349SWolfram Sang if (!bri->set_scl || !bri->get_scl) { 28391ed5349SWolfram Sang err_str = "no {get|set}_scl() found"; 28491ed5349SWolfram Sang goto err; 28591ed5349SWolfram Sang } 286ffc59c49SWolfram Sang if (!bri->set_sda && !bri->get_sda) { 287ffc59c49SWolfram Sang err_str = "either get_sda() or set_sda() needed"; 288ffc59c49SWolfram Sang goto err; 289ffc59c49SWolfram Sang } 29091ed5349SWolfram Sang } 29191ed5349SWolfram Sang 29291ed5349SWolfram Sang return; 29391ed5349SWolfram Sang err: 29491ed5349SWolfram Sang dev_err(&adap->dev, "Not using recovery: %s\n", err_str); 29591ed5349SWolfram Sang adap->bus_recovery_info = NULL; 29691ed5349SWolfram Sang } 29791ed5349SWolfram Sang 29891ed5349SWolfram Sang static int i2c_smbus_host_notify_to_irq(const struct i2c_client *client) 29991ed5349SWolfram Sang { 30091ed5349SWolfram Sang struct i2c_adapter *adap = client->adapter; 30191ed5349SWolfram Sang unsigned int irq; 30291ed5349SWolfram Sang 30391ed5349SWolfram Sang if (!adap->host_notify_domain) 30491ed5349SWolfram Sang return -ENXIO; 30591ed5349SWolfram Sang 30691ed5349SWolfram Sang if (client->flags & I2C_CLIENT_TEN) 30791ed5349SWolfram Sang return -EINVAL; 30891ed5349SWolfram Sang 30991ed5349SWolfram Sang irq = irq_find_mapping(adap->host_notify_domain, client->addr); 31091ed5349SWolfram Sang if (!irq) 31191ed5349SWolfram Sang irq = irq_create_mapping(adap->host_notify_domain, 31291ed5349SWolfram Sang client->addr); 31391ed5349SWolfram Sang 31491ed5349SWolfram Sang return irq > 0 ? irq : -ENXIO; 31591ed5349SWolfram Sang } 31691ed5349SWolfram Sang 31791ed5349SWolfram Sang static int i2c_device_probe(struct device *dev) 31891ed5349SWolfram Sang { 31991ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 32091ed5349SWolfram Sang struct i2c_driver *driver; 32191ed5349SWolfram Sang int status; 32291ed5349SWolfram Sang 32391ed5349SWolfram Sang if (!client) 32491ed5349SWolfram Sang return 0; 32591ed5349SWolfram Sang 32691ed5349SWolfram Sang driver = to_i2c_driver(dev->driver); 32791ed5349SWolfram Sang 32891ed5349SWolfram Sang if (!client->irq && !driver->disable_i2c_core_irq_mapping) { 32991ed5349SWolfram Sang int irq = -ENOENT; 33091ed5349SWolfram Sang 33191ed5349SWolfram Sang if (client->flags & I2C_CLIENT_HOST_NOTIFY) { 33291ed5349SWolfram Sang dev_dbg(dev, "Using Host Notify IRQ\n"); 33391ed5349SWolfram Sang irq = i2c_smbus_host_notify_to_irq(client); 33491ed5349SWolfram Sang } else if (dev->of_node) { 33591ed5349SWolfram Sang irq = of_irq_get_byname(dev->of_node, "irq"); 33691ed5349SWolfram Sang if (irq == -EINVAL || irq == -ENODATA) 33791ed5349SWolfram Sang irq = of_irq_get(dev->of_node, 0); 33891ed5349SWolfram Sang } else if (ACPI_COMPANION(dev)) { 33991ed5349SWolfram Sang irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0); 34091ed5349SWolfram Sang } 34191ed5349SWolfram Sang if (irq == -EPROBE_DEFER) 34291ed5349SWolfram Sang return irq; 34391ed5349SWolfram Sang 34491ed5349SWolfram Sang if (irq < 0) 34591ed5349SWolfram Sang irq = 0; 34691ed5349SWolfram Sang 34791ed5349SWolfram Sang client->irq = irq; 34891ed5349SWolfram Sang } 34991ed5349SWolfram Sang 35091ed5349SWolfram Sang /* 351f4b17a14SJavier Martinez Canillas * An I2C ID table is not mandatory, if and only if, a suitable OF 352f4b17a14SJavier Martinez Canillas * or ACPI ID table is supplied for the probing device. 35391ed5349SWolfram Sang */ 35491ed5349SWolfram Sang if (!driver->id_table && 355c64ffff7SAndy Shevchenko !i2c_acpi_match_device(dev->driver->acpi_match_table, client) && 35691ed5349SWolfram Sang !i2c_of_match_device(dev->driver->of_match_table, client)) 35791ed5349SWolfram Sang return -ENODEV; 35891ed5349SWolfram Sang 35991ed5349SWolfram Sang if (client->flags & I2C_CLIENT_WAKE) { 36091ed5349SWolfram Sang int wakeirq = -ENOENT; 36191ed5349SWolfram Sang 36291ed5349SWolfram Sang if (dev->of_node) { 36391ed5349SWolfram Sang wakeirq = of_irq_get_byname(dev->of_node, "wakeup"); 36491ed5349SWolfram Sang if (wakeirq == -EPROBE_DEFER) 36591ed5349SWolfram Sang return wakeirq; 36691ed5349SWolfram Sang } 36791ed5349SWolfram Sang 36891ed5349SWolfram Sang device_init_wakeup(&client->dev, true); 36991ed5349SWolfram Sang 37091ed5349SWolfram Sang if (wakeirq > 0 && wakeirq != client->irq) 37191ed5349SWolfram Sang status = dev_pm_set_dedicated_wake_irq(dev, wakeirq); 37291ed5349SWolfram Sang else if (client->irq > 0) 37391ed5349SWolfram Sang status = dev_pm_set_wake_irq(dev, client->irq); 37491ed5349SWolfram Sang else 37591ed5349SWolfram Sang status = 0; 37691ed5349SWolfram Sang 37791ed5349SWolfram Sang if (status) 37891ed5349SWolfram Sang dev_warn(&client->dev, "failed to set up wakeup irq\n"); 37991ed5349SWolfram Sang } 38091ed5349SWolfram Sang 38191ed5349SWolfram Sang dev_dbg(dev, "probe\n"); 38291ed5349SWolfram Sang 38391ed5349SWolfram Sang status = of_clk_set_defaults(dev->of_node, false); 38491ed5349SWolfram Sang if (status < 0) 38591ed5349SWolfram Sang goto err_clear_wakeup_irq; 38691ed5349SWolfram Sang 38791ed5349SWolfram Sang status = dev_pm_domain_attach(&client->dev, true); 388e6a20b6cSUlf Hansson if (status) 38991ed5349SWolfram Sang goto err_clear_wakeup_irq; 39091ed5349SWolfram Sang 39191ed5349SWolfram Sang /* 39291ed5349SWolfram Sang * When there are no more users of probe(), 39391ed5349SWolfram Sang * rename probe_new to probe. 39491ed5349SWolfram Sang */ 39591ed5349SWolfram Sang if (driver->probe_new) 39691ed5349SWolfram Sang status = driver->probe_new(client); 39791ed5349SWolfram Sang else if (driver->probe) 39891ed5349SWolfram Sang status = driver->probe(client, 39991ed5349SWolfram Sang i2c_match_id(driver->id_table, client)); 40091ed5349SWolfram Sang else 40191ed5349SWolfram Sang status = -EINVAL; 40291ed5349SWolfram Sang 40391ed5349SWolfram Sang if (status) 40491ed5349SWolfram Sang goto err_detach_pm_domain; 40591ed5349SWolfram Sang 40691ed5349SWolfram Sang return 0; 40791ed5349SWolfram Sang 40891ed5349SWolfram Sang err_detach_pm_domain: 40991ed5349SWolfram Sang dev_pm_domain_detach(&client->dev, true); 41091ed5349SWolfram Sang err_clear_wakeup_irq: 41191ed5349SWolfram Sang dev_pm_clear_wake_irq(&client->dev); 41291ed5349SWolfram Sang device_init_wakeup(&client->dev, false); 41391ed5349SWolfram Sang return status; 41491ed5349SWolfram Sang } 41591ed5349SWolfram Sang 41691ed5349SWolfram Sang static int i2c_device_remove(struct device *dev) 41791ed5349SWolfram Sang { 41891ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 41991ed5349SWolfram Sang struct i2c_driver *driver; 42091ed5349SWolfram Sang int status = 0; 42191ed5349SWolfram Sang 42291ed5349SWolfram Sang if (!client || !dev->driver) 42391ed5349SWolfram Sang return 0; 42491ed5349SWolfram Sang 42591ed5349SWolfram Sang driver = to_i2c_driver(dev->driver); 42691ed5349SWolfram Sang if (driver->remove) { 42791ed5349SWolfram Sang dev_dbg(dev, "remove\n"); 42891ed5349SWolfram Sang status = driver->remove(client); 42991ed5349SWolfram Sang } 43091ed5349SWolfram Sang 43191ed5349SWolfram Sang dev_pm_domain_detach(&client->dev, true); 43291ed5349SWolfram Sang 43391ed5349SWolfram Sang dev_pm_clear_wake_irq(&client->dev); 43491ed5349SWolfram Sang device_init_wakeup(&client->dev, false); 43591ed5349SWolfram Sang 43691ed5349SWolfram Sang return status; 43791ed5349SWolfram Sang } 43891ed5349SWolfram Sang 43991ed5349SWolfram Sang static void i2c_device_shutdown(struct device *dev) 44091ed5349SWolfram Sang { 44191ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 44291ed5349SWolfram Sang struct i2c_driver *driver; 44391ed5349SWolfram Sang 44491ed5349SWolfram Sang if (!client || !dev->driver) 44591ed5349SWolfram Sang return; 44691ed5349SWolfram Sang driver = to_i2c_driver(dev->driver); 44791ed5349SWolfram Sang if (driver->shutdown) 44891ed5349SWolfram Sang driver->shutdown(client); 44991ed5349SWolfram Sang } 45091ed5349SWolfram Sang 45191ed5349SWolfram Sang static void i2c_client_dev_release(struct device *dev) 45291ed5349SWolfram Sang { 45391ed5349SWolfram Sang kfree(to_i2c_client(dev)); 45491ed5349SWolfram Sang } 45591ed5349SWolfram Sang 45691ed5349SWolfram Sang static ssize_t 45791ed5349SWolfram Sang show_name(struct device *dev, struct device_attribute *attr, char *buf) 45891ed5349SWolfram Sang { 45991ed5349SWolfram Sang return sprintf(buf, "%s\n", dev->type == &i2c_client_type ? 46091ed5349SWolfram Sang to_i2c_client(dev)->name : to_i2c_adapter(dev)->name); 46191ed5349SWolfram Sang } 46291ed5349SWolfram Sang static DEVICE_ATTR(name, S_IRUGO, show_name, NULL); 46391ed5349SWolfram Sang 46491ed5349SWolfram Sang static ssize_t 46591ed5349SWolfram Sang show_modalias(struct device *dev, struct device_attribute *attr, char *buf) 46691ed5349SWolfram Sang { 46791ed5349SWolfram Sang struct i2c_client *client = to_i2c_client(dev); 46891ed5349SWolfram Sang int len; 46991ed5349SWolfram Sang 470af503716SJavier Martinez Canillas len = of_device_modalias(dev, buf, PAGE_SIZE); 471af503716SJavier Martinez Canillas if (len != -ENODEV) 472af503716SJavier Martinez Canillas return len; 473af503716SJavier Martinez Canillas 47491ed5349SWolfram Sang len = acpi_device_modalias(dev, buf, PAGE_SIZE -1); 47591ed5349SWolfram Sang if (len != -ENODEV) 47691ed5349SWolfram Sang return len; 47791ed5349SWolfram Sang 47891ed5349SWolfram Sang return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name); 47991ed5349SWolfram Sang } 48091ed5349SWolfram Sang static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL); 48191ed5349SWolfram Sang 48291ed5349SWolfram Sang static struct attribute *i2c_dev_attrs[] = { 48391ed5349SWolfram Sang &dev_attr_name.attr, 48491ed5349SWolfram Sang /* modalias helps coldplug: modprobe $(cat .../modalias) */ 48591ed5349SWolfram Sang &dev_attr_modalias.attr, 48691ed5349SWolfram Sang NULL 48791ed5349SWolfram Sang }; 48891ed5349SWolfram Sang ATTRIBUTE_GROUPS(i2c_dev); 48991ed5349SWolfram Sang 49091ed5349SWolfram Sang struct bus_type i2c_bus_type = { 49191ed5349SWolfram Sang .name = "i2c", 49291ed5349SWolfram Sang .match = i2c_device_match, 49391ed5349SWolfram Sang .probe = i2c_device_probe, 49491ed5349SWolfram Sang .remove = i2c_device_remove, 49591ed5349SWolfram Sang .shutdown = i2c_device_shutdown, 49691ed5349SWolfram Sang }; 49791ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_bus_type); 49891ed5349SWolfram Sang 49991ed5349SWolfram Sang struct device_type i2c_client_type = { 50091ed5349SWolfram Sang .groups = i2c_dev_groups, 50191ed5349SWolfram Sang .uevent = i2c_device_uevent, 50291ed5349SWolfram Sang .release = i2c_client_dev_release, 50391ed5349SWolfram Sang }; 50491ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_client_type); 50591ed5349SWolfram Sang 50691ed5349SWolfram Sang 50791ed5349SWolfram Sang /** 50891ed5349SWolfram Sang * i2c_verify_client - return parameter as i2c_client, or NULL 50991ed5349SWolfram Sang * @dev: device, probably from some driver model iterator 51091ed5349SWolfram Sang * 51191ed5349SWolfram Sang * When traversing the driver model tree, perhaps using driver model 51291ed5349SWolfram Sang * iterators like @device_for_each_child(), you can't assume very much 51391ed5349SWolfram Sang * about the nodes you find. Use this function to avoid oopses caused 51491ed5349SWolfram Sang * by wrongly treating some non-I2C device as an i2c_client. 51591ed5349SWolfram Sang */ 51691ed5349SWolfram Sang struct i2c_client *i2c_verify_client(struct device *dev) 51791ed5349SWolfram Sang { 51891ed5349SWolfram Sang return (dev->type == &i2c_client_type) 51991ed5349SWolfram Sang ? to_i2c_client(dev) 52091ed5349SWolfram Sang : NULL; 52191ed5349SWolfram Sang } 52291ed5349SWolfram Sang EXPORT_SYMBOL(i2c_verify_client); 52391ed5349SWolfram Sang 52491ed5349SWolfram Sang 52591ed5349SWolfram Sang /* Return a unique address which takes the flags of the client into account */ 52691ed5349SWolfram Sang static unsigned short i2c_encode_flags_to_addr(struct i2c_client *client) 52791ed5349SWolfram Sang { 52891ed5349SWolfram Sang unsigned short addr = client->addr; 52991ed5349SWolfram Sang 53091ed5349SWolfram Sang /* For some client flags, add an arbitrary offset to avoid collisions */ 53191ed5349SWolfram Sang if (client->flags & I2C_CLIENT_TEN) 53291ed5349SWolfram Sang addr |= I2C_ADDR_OFFSET_TEN_BIT; 53391ed5349SWolfram Sang 53491ed5349SWolfram Sang if (client->flags & I2C_CLIENT_SLAVE) 53591ed5349SWolfram Sang addr |= I2C_ADDR_OFFSET_SLAVE; 53691ed5349SWolfram Sang 53791ed5349SWolfram Sang return addr; 53891ed5349SWolfram Sang } 53991ed5349SWolfram Sang 54091ed5349SWolfram Sang /* This is a permissive address validity check, I2C address map constraints 54191ed5349SWolfram Sang * are purposely not enforced, except for the general call address. */ 542398432edSWolfram Sang static int i2c_check_addr_validity(unsigned int addr, unsigned short flags) 54391ed5349SWolfram Sang { 54491ed5349SWolfram Sang if (flags & I2C_CLIENT_TEN) { 54591ed5349SWolfram Sang /* 10-bit address, all values are valid */ 54691ed5349SWolfram Sang if (addr > 0x3ff) 54791ed5349SWolfram Sang return -EINVAL; 54891ed5349SWolfram Sang } else { 54991ed5349SWolfram Sang /* 7-bit address, reject the general call address */ 55091ed5349SWolfram Sang if (addr == 0x00 || addr > 0x7f) 55191ed5349SWolfram Sang return -EINVAL; 55291ed5349SWolfram Sang } 55391ed5349SWolfram Sang return 0; 55491ed5349SWolfram Sang } 55591ed5349SWolfram Sang 55691ed5349SWolfram Sang /* And this is a strict address validity check, used when probing. If a 55791ed5349SWolfram Sang * device uses a reserved address, then it shouldn't be probed. 7-bit 55891ed5349SWolfram Sang * addressing is assumed, 10-bit address devices are rare and should be 55991ed5349SWolfram Sang * explicitly enumerated. */ 560e4991ecdSWolfram Sang int i2c_check_7bit_addr_validity_strict(unsigned short addr) 56191ed5349SWolfram Sang { 56291ed5349SWolfram Sang /* 56391ed5349SWolfram Sang * Reserved addresses per I2C specification: 56491ed5349SWolfram Sang * 0x00 General call address / START byte 56591ed5349SWolfram Sang * 0x01 CBUS address 56691ed5349SWolfram Sang * 0x02 Reserved for different bus format 56791ed5349SWolfram Sang * 0x03 Reserved for future purposes 56891ed5349SWolfram Sang * 0x04-0x07 Hs-mode master code 56991ed5349SWolfram Sang * 0x78-0x7b 10-bit slave addressing 57091ed5349SWolfram Sang * 0x7c-0x7f Reserved for future purposes 57191ed5349SWolfram Sang */ 57291ed5349SWolfram Sang if (addr < 0x08 || addr > 0x77) 57391ed5349SWolfram Sang return -EINVAL; 57491ed5349SWolfram Sang return 0; 57591ed5349SWolfram Sang } 57691ed5349SWolfram Sang 57791ed5349SWolfram Sang static int __i2c_check_addr_busy(struct device *dev, void *addrp) 57891ed5349SWolfram Sang { 57991ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 58091ed5349SWolfram Sang int addr = *(int *)addrp; 58191ed5349SWolfram Sang 58291ed5349SWolfram Sang if (client && i2c_encode_flags_to_addr(client) == addr) 58391ed5349SWolfram Sang return -EBUSY; 58491ed5349SWolfram Sang return 0; 58591ed5349SWolfram Sang } 58691ed5349SWolfram Sang 58791ed5349SWolfram Sang /* walk up mux tree */ 58891ed5349SWolfram Sang static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr) 58991ed5349SWolfram Sang { 59091ed5349SWolfram Sang struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter); 59191ed5349SWolfram Sang int result; 59291ed5349SWolfram Sang 59391ed5349SWolfram Sang result = device_for_each_child(&adapter->dev, &addr, 59491ed5349SWolfram Sang __i2c_check_addr_busy); 59591ed5349SWolfram Sang 59691ed5349SWolfram Sang if (!result && parent) 59791ed5349SWolfram Sang result = i2c_check_mux_parents(parent, addr); 59891ed5349SWolfram Sang 59991ed5349SWolfram Sang return result; 60091ed5349SWolfram Sang } 60191ed5349SWolfram Sang 60291ed5349SWolfram Sang /* recurse down mux tree */ 60391ed5349SWolfram Sang static int i2c_check_mux_children(struct device *dev, void *addrp) 60491ed5349SWolfram Sang { 60591ed5349SWolfram Sang int result; 60691ed5349SWolfram Sang 60791ed5349SWolfram Sang if (dev->type == &i2c_adapter_type) 60891ed5349SWolfram Sang result = device_for_each_child(dev, addrp, 60991ed5349SWolfram Sang i2c_check_mux_children); 61091ed5349SWolfram Sang else 61191ed5349SWolfram Sang result = __i2c_check_addr_busy(dev, addrp); 61291ed5349SWolfram Sang 61391ed5349SWolfram Sang return result; 61491ed5349SWolfram Sang } 61591ed5349SWolfram Sang 61691ed5349SWolfram Sang static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr) 61791ed5349SWolfram Sang { 61891ed5349SWolfram Sang struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter); 61991ed5349SWolfram Sang int result = 0; 62091ed5349SWolfram Sang 62191ed5349SWolfram Sang if (parent) 62291ed5349SWolfram Sang result = i2c_check_mux_parents(parent, addr); 62391ed5349SWolfram Sang 62491ed5349SWolfram Sang if (!result) 62591ed5349SWolfram Sang result = device_for_each_child(&adapter->dev, &addr, 62691ed5349SWolfram Sang i2c_check_mux_children); 62791ed5349SWolfram Sang 62891ed5349SWolfram Sang return result; 62991ed5349SWolfram Sang } 63091ed5349SWolfram Sang 63191ed5349SWolfram Sang /** 63291ed5349SWolfram Sang * i2c_adapter_lock_bus - Get exclusive access to an I2C bus segment 63391ed5349SWolfram Sang * @adapter: Target I2C bus segment 63491ed5349SWolfram Sang * @flags: I2C_LOCK_ROOT_ADAPTER locks the root i2c adapter, I2C_LOCK_SEGMENT 63591ed5349SWolfram Sang * locks only this branch in the adapter tree 63691ed5349SWolfram Sang */ 63791ed5349SWolfram Sang static void i2c_adapter_lock_bus(struct i2c_adapter *adapter, 63891ed5349SWolfram Sang unsigned int flags) 63991ed5349SWolfram Sang { 64091ed5349SWolfram Sang rt_mutex_lock(&adapter->bus_lock); 64191ed5349SWolfram Sang } 64291ed5349SWolfram Sang 64391ed5349SWolfram Sang /** 64491ed5349SWolfram Sang * i2c_adapter_trylock_bus - Try to get exclusive access to an I2C bus segment 64591ed5349SWolfram Sang * @adapter: Target I2C bus segment 64691ed5349SWolfram Sang * @flags: I2C_LOCK_ROOT_ADAPTER trylocks the root i2c adapter, I2C_LOCK_SEGMENT 64791ed5349SWolfram Sang * trylocks only this branch in the adapter tree 64891ed5349SWolfram Sang */ 64991ed5349SWolfram Sang static int i2c_adapter_trylock_bus(struct i2c_adapter *adapter, 65091ed5349SWolfram Sang unsigned int flags) 65191ed5349SWolfram Sang { 65291ed5349SWolfram Sang return rt_mutex_trylock(&adapter->bus_lock); 65391ed5349SWolfram Sang } 65491ed5349SWolfram Sang 65591ed5349SWolfram Sang /** 65691ed5349SWolfram Sang * i2c_adapter_unlock_bus - Release exclusive access to an I2C bus segment 65791ed5349SWolfram Sang * @adapter: Target I2C bus segment 65891ed5349SWolfram Sang * @flags: I2C_LOCK_ROOT_ADAPTER unlocks the root i2c adapter, I2C_LOCK_SEGMENT 65991ed5349SWolfram Sang * unlocks only this branch in the adapter tree 66091ed5349SWolfram Sang */ 66191ed5349SWolfram Sang static void i2c_adapter_unlock_bus(struct i2c_adapter *adapter, 66291ed5349SWolfram Sang unsigned int flags) 66391ed5349SWolfram Sang { 66491ed5349SWolfram Sang rt_mutex_unlock(&adapter->bus_lock); 66591ed5349SWolfram Sang } 66691ed5349SWolfram Sang 66791ed5349SWolfram Sang static void i2c_dev_set_name(struct i2c_adapter *adap, 668728fe6ceSHans de Goede struct i2c_client *client, 669728fe6ceSHans de Goede struct i2c_board_info const *info) 67091ed5349SWolfram Sang { 67191ed5349SWolfram Sang struct acpi_device *adev = ACPI_COMPANION(&client->dev); 67291ed5349SWolfram Sang 673728fe6ceSHans de Goede if (info && info->dev_name) { 674728fe6ceSHans de Goede dev_set_name(&client->dev, "i2c-%s", info->dev_name); 675728fe6ceSHans de Goede return; 676728fe6ceSHans de Goede } 677728fe6ceSHans de Goede 67891ed5349SWolfram Sang if (adev) { 67991ed5349SWolfram Sang dev_set_name(&client->dev, "i2c-%s", acpi_dev_name(adev)); 68091ed5349SWolfram Sang return; 68191ed5349SWolfram Sang } 68291ed5349SWolfram Sang 68391ed5349SWolfram Sang dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap), 68491ed5349SWolfram Sang i2c_encode_flags_to_addr(client)); 68591ed5349SWolfram Sang } 68691ed5349SWolfram Sang 68791ed5349SWolfram Sang static int i2c_dev_irq_from_resources(const struct resource *resources, 68891ed5349SWolfram Sang unsigned int num_resources) 68991ed5349SWolfram Sang { 69091ed5349SWolfram Sang struct irq_data *irqd; 69191ed5349SWolfram Sang int i; 69291ed5349SWolfram Sang 69391ed5349SWolfram Sang for (i = 0; i < num_resources; i++) { 69491ed5349SWolfram Sang const struct resource *r = &resources[i]; 69591ed5349SWolfram Sang 69691ed5349SWolfram Sang if (resource_type(r) != IORESOURCE_IRQ) 69791ed5349SWolfram Sang continue; 69891ed5349SWolfram Sang 69991ed5349SWolfram Sang if (r->flags & IORESOURCE_BITS) { 70091ed5349SWolfram Sang irqd = irq_get_irq_data(r->start); 70191ed5349SWolfram Sang if (!irqd) 70291ed5349SWolfram Sang break; 70391ed5349SWolfram Sang 70491ed5349SWolfram Sang irqd_set_trigger_type(irqd, r->flags & IORESOURCE_BITS); 70591ed5349SWolfram Sang } 70691ed5349SWolfram Sang 70791ed5349SWolfram Sang return r->start; 70891ed5349SWolfram Sang } 70991ed5349SWolfram Sang 71091ed5349SWolfram Sang return 0; 71191ed5349SWolfram Sang } 71291ed5349SWolfram Sang 71391ed5349SWolfram Sang /** 71491ed5349SWolfram Sang * i2c_new_device - instantiate an i2c device 71591ed5349SWolfram Sang * @adap: the adapter managing the device 71691ed5349SWolfram Sang * @info: describes one I2C device; bus_num is ignored 71791ed5349SWolfram Sang * Context: can sleep 71891ed5349SWolfram Sang * 71991ed5349SWolfram Sang * Create an i2c device. Binding is handled through driver model 72091ed5349SWolfram Sang * probe()/remove() methods. A driver may be bound to this device when we 72191ed5349SWolfram Sang * return from this function, or any later moment (e.g. maybe hotplugging will 72291ed5349SWolfram Sang * load the driver module). This call is not appropriate for use by mainboard 72391ed5349SWolfram Sang * initialization logic, which usually runs during an arch_initcall() long 72491ed5349SWolfram Sang * before any i2c_adapter could exist. 72591ed5349SWolfram Sang * 72691ed5349SWolfram Sang * This returns the new i2c client, which may be saved for later use with 72791ed5349SWolfram Sang * i2c_unregister_device(); or NULL to indicate an error. 72891ed5349SWolfram Sang */ 72991ed5349SWolfram Sang struct i2c_client * 73091ed5349SWolfram Sang i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info) 73191ed5349SWolfram Sang { 73291ed5349SWolfram Sang struct i2c_client *client; 73391ed5349SWolfram Sang int status; 73491ed5349SWolfram Sang 73591ed5349SWolfram Sang client = kzalloc(sizeof *client, GFP_KERNEL); 73691ed5349SWolfram Sang if (!client) 73791ed5349SWolfram Sang return NULL; 73891ed5349SWolfram Sang 73991ed5349SWolfram Sang client->adapter = adap; 74091ed5349SWolfram Sang 74191ed5349SWolfram Sang client->dev.platform_data = info->platform_data; 74291ed5349SWolfram Sang client->flags = info->flags; 74391ed5349SWolfram Sang client->addr = info->addr; 74491ed5349SWolfram Sang 74591ed5349SWolfram Sang client->irq = info->irq; 74691ed5349SWolfram Sang if (!client->irq) 74791ed5349SWolfram Sang client->irq = i2c_dev_irq_from_resources(info->resources, 74891ed5349SWolfram Sang info->num_resources); 74991ed5349SWolfram Sang 75091ed5349SWolfram Sang strlcpy(client->name, info->type, sizeof(client->name)); 75191ed5349SWolfram Sang 75291ed5349SWolfram Sang status = i2c_check_addr_validity(client->addr, client->flags); 75391ed5349SWolfram Sang if (status) { 75491ed5349SWolfram Sang dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n", 75591ed5349SWolfram Sang client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr); 75691ed5349SWolfram Sang goto out_err_silent; 75791ed5349SWolfram Sang } 75891ed5349SWolfram Sang 75991ed5349SWolfram Sang /* Check for address business */ 76091ed5349SWolfram Sang status = i2c_check_addr_busy(adap, i2c_encode_flags_to_addr(client)); 76191ed5349SWolfram Sang if (status) 76291ed5349SWolfram Sang goto out_err; 76391ed5349SWolfram Sang 76491ed5349SWolfram Sang client->dev.parent = &client->adapter->dev; 76591ed5349SWolfram Sang client->dev.bus = &i2c_bus_type; 76691ed5349SWolfram Sang client->dev.type = &i2c_client_type; 76704782265SBoris Brezillon client->dev.of_node = of_node_get(info->of_node); 76891ed5349SWolfram Sang client->dev.fwnode = info->fwnode; 76991ed5349SWolfram Sang 770728fe6ceSHans de Goede i2c_dev_set_name(adap, client, info); 77191ed5349SWolfram Sang 77291ed5349SWolfram Sang if (info->properties) { 77391ed5349SWolfram Sang status = device_add_properties(&client->dev, info->properties); 77491ed5349SWolfram Sang if (status) { 77591ed5349SWolfram Sang dev_err(&adap->dev, 77691ed5349SWolfram Sang "Failed to add properties to client %s: %d\n", 77791ed5349SWolfram Sang client->name, status); 77804782265SBoris Brezillon goto out_err_put_of_node; 77991ed5349SWolfram Sang } 78091ed5349SWolfram Sang } 78191ed5349SWolfram Sang 78291ed5349SWolfram Sang status = device_register(&client->dev); 78391ed5349SWolfram Sang if (status) 78491ed5349SWolfram Sang goto out_free_props; 78591ed5349SWolfram Sang 78691ed5349SWolfram Sang dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n", 78791ed5349SWolfram Sang client->name, dev_name(&client->dev)); 78891ed5349SWolfram Sang 78991ed5349SWolfram Sang return client; 79091ed5349SWolfram Sang 79191ed5349SWolfram Sang out_free_props: 79291ed5349SWolfram Sang if (info->properties) 79391ed5349SWolfram Sang device_remove_properties(&client->dev); 79404782265SBoris Brezillon out_err_put_of_node: 79504782265SBoris Brezillon of_node_put(info->of_node); 79691ed5349SWolfram Sang out_err: 79791ed5349SWolfram Sang dev_err(&adap->dev, 79891ed5349SWolfram Sang "Failed to register i2c client %s at 0x%02x (%d)\n", 79991ed5349SWolfram Sang client->name, client->addr, status); 80091ed5349SWolfram Sang out_err_silent: 80191ed5349SWolfram Sang kfree(client); 80291ed5349SWolfram Sang return NULL; 80391ed5349SWolfram Sang } 80491ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_new_device); 80591ed5349SWolfram Sang 80691ed5349SWolfram Sang 80791ed5349SWolfram Sang /** 80891ed5349SWolfram Sang * i2c_unregister_device - reverse effect of i2c_new_device() 80991ed5349SWolfram Sang * @client: value returned from i2c_new_device() 81091ed5349SWolfram Sang * Context: can sleep 81191ed5349SWolfram Sang */ 81291ed5349SWolfram Sang void i2c_unregister_device(struct i2c_client *client) 81391ed5349SWolfram Sang { 8147b43dd19SAndy Shevchenko if (!client) 8157b43dd19SAndy Shevchenko return; 816e0638fa4SLixin Wang 817e0638fa4SLixin Wang if (client->dev.of_node) { 81891ed5349SWolfram Sang of_node_clear_flag(client->dev.of_node, OF_POPULATED); 819e0638fa4SLixin Wang of_node_put(client->dev.of_node); 820e0638fa4SLixin Wang } 821e0638fa4SLixin Wang 82291ed5349SWolfram Sang if (ACPI_COMPANION(&client->dev)) 82391ed5349SWolfram Sang acpi_device_clear_enumerated(ACPI_COMPANION(&client->dev)); 82491ed5349SWolfram Sang device_unregister(&client->dev); 82591ed5349SWolfram Sang } 82691ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_unregister_device); 82791ed5349SWolfram Sang 82891ed5349SWolfram Sang 82991ed5349SWolfram Sang static const struct i2c_device_id dummy_id[] = { 83091ed5349SWolfram Sang { "dummy", 0 }, 83191ed5349SWolfram Sang { }, 83291ed5349SWolfram Sang }; 83391ed5349SWolfram Sang 83491ed5349SWolfram Sang static int dummy_probe(struct i2c_client *client, 83591ed5349SWolfram Sang const struct i2c_device_id *id) 83691ed5349SWolfram Sang { 83791ed5349SWolfram Sang return 0; 83891ed5349SWolfram Sang } 83991ed5349SWolfram Sang 84091ed5349SWolfram Sang static int dummy_remove(struct i2c_client *client) 84191ed5349SWolfram Sang { 84291ed5349SWolfram Sang return 0; 84391ed5349SWolfram Sang } 84491ed5349SWolfram Sang 84591ed5349SWolfram Sang static struct i2c_driver dummy_driver = { 84691ed5349SWolfram Sang .driver.name = "dummy", 84791ed5349SWolfram Sang .probe = dummy_probe, 84891ed5349SWolfram Sang .remove = dummy_remove, 84991ed5349SWolfram Sang .id_table = dummy_id, 85091ed5349SWolfram Sang }; 85191ed5349SWolfram Sang 85291ed5349SWolfram Sang /** 85391ed5349SWolfram Sang * i2c_new_dummy - return a new i2c device bound to a dummy driver 85491ed5349SWolfram Sang * @adapter: the adapter managing the device 85591ed5349SWolfram Sang * @address: seven bit address to be used 85691ed5349SWolfram Sang * Context: can sleep 85791ed5349SWolfram Sang * 85891ed5349SWolfram Sang * This returns an I2C client bound to the "dummy" driver, intended for use 85991ed5349SWolfram Sang * with devices that consume multiple addresses. Examples of such chips 86091ed5349SWolfram Sang * include various EEPROMS (like 24c04 and 24c08 models). 86191ed5349SWolfram Sang * 86291ed5349SWolfram Sang * These dummy devices have two main uses. First, most I2C and SMBus calls 86391ed5349SWolfram Sang * except i2c_transfer() need a client handle; the dummy will be that handle. 86491ed5349SWolfram Sang * And second, this prevents the specified address from being bound to a 86591ed5349SWolfram Sang * different driver. 86691ed5349SWolfram Sang * 86791ed5349SWolfram Sang * This returns the new i2c client, which should be saved for later use with 86891ed5349SWolfram Sang * i2c_unregister_device(); or NULL to indicate an error. 86991ed5349SWolfram Sang */ 87091ed5349SWolfram Sang struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address) 87191ed5349SWolfram Sang { 87291ed5349SWolfram Sang struct i2c_board_info info = { 87391ed5349SWolfram Sang I2C_BOARD_INFO("dummy", address), 87491ed5349SWolfram Sang }; 87591ed5349SWolfram Sang 87691ed5349SWolfram Sang return i2c_new_device(adapter, &info); 87791ed5349SWolfram Sang } 87891ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_new_dummy); 87991ed5349SWolfram Sang 88091ed5349SWolfram Sang /** 88191ed5349SWolfram Sang * i2c_new_secondary_device - Helper to get the instantiated secondary address 88291ed5349SWolfram Sang * and create the associated device 88391ed5349SWolfram Sang * @client: Handle to the primary client 88491ed5349SWolfram Sang * @name: Handle to specify which secondary address to get 88591ed5349SWolfram Sang * @default_addr: Used as a fallback if no secondary address was specified 88691ed5349SWolfram Sang * Context: can sleep 88791ed5349SWolfram Sang * 88891ed5349SWolfram Sang * I2C clients can be composed of multiple I2C slaves bound together in a single 88991ed5349SWolfram Sang * component. The I2C client driver then binds to the master I2C slave and needs 89091ed5349SWolfram Sang * to create I2C dummy clients to communicate with all the other slaves. 89191ed5349SWolfram Sang * 89291ed5349SWolfram Sang * This function creates and returns an I2C dummy client whose I2C address is 89391ed5349SWolfram Sang * retrieved from the platform firmware based on the given slave name. If no 89491ed5349SWolfram Sang * address is specified by the firmware default_addr is used. 89591ed5349SWolfram Sang * 89691ed5349SWolfram Sang * On DT-based platforms the address is retrieved from the "reg" property entry 89791ed5349SWolfram Sang * cell whose "reg-names" value matches the slave name. 89891ed5349SWolfram Sang * 89991ed5349SWolfram Sang * This returns the new i2c client, which should be saved for later use with 90091ed5349SWolfram Sang * i2c_unregister_device(); or NULL to indicate an error. 90191ed5349SWolfram Sang */ 90291ed5349SWolfram Sang struct i2c_client *i2c_new_secondary_device(struct i2c_client *client, 90391ed5349SWolfram Sang const char *name, 90491ed5349SWolfram Sang u16 default_addr) 90591ed5349SWolfram Sang { 90691ed5349SWolfram Sang struct device_node *np = client->dev.of_node; 90791ed5349SWolfram Sang u32 addr = default_addr; 90891ed5349SWolfram Sang int i; 90991ed5349SWolfram Sang 91091ed5349SWolfram Sang if (np) { 91191ed5349SWolfram Sang i = of_property_match_string(np, "reg-names", name); 91291ed5349SWolfram Sang if (i >= 0) 91391ed5349SWolfram Sang of_property_read_u32_index(np, "reg", i, &addr); 91491ed5349SWolfram Sang } 91591ed5349SWolfram Sang 91691ed5349SWolfram Sang dev_dbg(&client->adapter->dev, "Address for %s : 0x%x\n", name, addr); 91791ed5349SWolfram Sang return i2c_new_dummy(client->adapter, addr); 91891ed5349SWolfram Sang } 91991ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_new_secondary_device); 92091ed5349SWolfram Sang 92191ed5349SWolfram Sang /* ------------------------------------------------------------------------- */ 92291ed5349SWolfram Sang 92391ed5349SWolfram Sang /* I2C bus adapters -- one roots each I2C or SMBUS segment */ 92491ed5349SWolfram Sang 92591ed5349SWolfram Sang static void i2c_adapter_dev_release(struct device *dev) 92691ed5349SWolfram Sang { 92791ed5349SWolfram Sang struct i2c_adapter *adap = to_i2c_adapter(dev); 92891ed5349SWolfram Sang complete(&adap->dev_released); 92991ed5349SWolfram Sang } 93091ed5349SWolfram Sang 93191ed5349SWolfram Sang unsigned int i2c_adapter_depth(struct i2c_adapter *adapter) 93291ed5349SWolfram Sang { 93391ed5349SWolfram Sang unsigned int depth = 0; 93491ed5349SWolfram Sang 93591ed5349SWolfram Sang while ((adapter = i2c_parent_is_i2c_adapter(adapter))) 93691ed5349SWolfram Sang depth++; 93791ed5349SWolfram Sang 93891ed5349SWolfram Sang WARN_ONCE(depth >= MAX_LOCKDEP_SUBCLASSES, 93991ed5349SWolfram Sang "adapter depth exceeds lockdep subclass limit\n"); 94091ed5349SWolfram Sang 94191ed5349SWolfram Sang return depth; 94291ed5349SWolfram Sang } 94391ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_adapter_depth); 94491ed5349SWolfram Sang 94591ed5349SWolfram Sang /* 94691ed5349SWolfram Sang * Let users instantiate I2C devices through sysfs. This can be used when 94791ed5349SWolfram Sang * platform initialization code doesn't contain the proper data for 94891ed5349SWolfram Sang * whatever reason. Also useful for drivers that do device detection and 94991ed5349SWolfram Sang * detection fails, either because the device uses an unexpected address, 95091ed5349SWolfram Sang * or this is a compatible device with different ID register values. 95191ed5349SWolfram Sang * 95291ed5349SWolfram Sang * Parameter checking may look overzealous, but we really don't want 95391ed5349SWolfram Sang * the user to provide incorrect parameters. 95491ed5349SWolfram Sang */ 95591ed5349SWolfram Sang static ssize_t 95691ed5349SWolfram Sang i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr, 95791ed5349SWolfram Sang const char *buf, size_t count) 95891ed5349SWolfram Sang { 95991ed5349SWolfram Sang struct i2c_adapter *adap = to_i2c_adapter(dev); 96091ed5349SWolfram Sang struct i2c_board_info info; 96191ed5349SWolfram Sang struct i2c_client *client; 96291ed5349SWolfram Sang char *blank, end; 96391ed5349SWolfram Sang int res; 96491ed5349SWolfram Sang 96591ed5349SWolfram Sang memset(&info, 0, sizeof(struct i2c_board_info)); 96691ed5349SWolfram Sang 96791ed5349SWolfram Sang blank = strchr(buf, ' '); 96891ed5349SWolfram Sang if (!blank) { 96991ed5349SWolfram Sang dev_err(dev, "%s: Missing parameters\n", "new_device"); 97091ed5349SWolfram Sang return -EINVAL; 97191ed5349SWolfram Sang } 97291ed5349SWolfram Sang if (blank - buf > I2C_NAME_SIZE - 1) { 97391ed5349SWolfram Sang dev_err(dev, "%s: Invalid device name\n", "new_device"); 97491ed5349SWolfram Sang return -EINVAL; 97591ed5349SWolfram Sang } 97691ed5349SWolfram Sang memcpy(info.type, buf, blank - buf); 97791ed5349SWolfram Sang 97891ed5349SWolfram Sang /* Parse remaining parameters, reject extra parameters */ 97991ed5349SWolfram Sang res = sscanf(++blank, "%hi%c", &info.addr, &end); 98091ed5349SWolfram Sang if (res < 1) { 98191ed5349SWolfram Sang dev_err(dev, "%s: Can't parse I2C address\n", "new_device"); 98291ed5349SWolfram Sang return -EINVAL; 98391ed5349SWolfram Sang } 98491ed5349SWolfram Sang if (res > 1 && end != '\n') { 98591ed5349SWolfram Sang dev_err(dev, "%s: Extra parameters\n", "new_device"); 98691ed5349SWolfram Sang return -EINVAL; 98791ed5349SWolfram Sang } 98891ed5349SWolfram Sang 98991ed5349SWolfram Sang if ((info.addr & I2C_ADDR_OFFSET_TEN_BIT) == I2C_ADDR_OFFSET_TEN_BIT) { 99091ed5349SWolfram Sang info.addr &= ~I2C_ADDR_OFFSET_TEN_BIT; 99191ed5349SWolfram Sang info.flags |= I2C_CLIENT_TEN; 99291ed5349SWolfram Sang } 99391ed5349SWolfram Sang 99491ed5349SWolfram Sang if (info.addr & I2C_ADDR_OFFSET_SLAVE) { 99591ed5349SWolfram Sang info.addr &= ~I2C_ADDR_OFFSET_SLAVE; 99691ed5349SWolfram Sang info.flags |= I2C_CLIENT_SLAVE; 99791ed5349SWolfram Sang } 99891ed5349SWolfram Sang 99991ed5349SWolfram Sang client = i2c_new_device(adap, &info); 100091ed5349SWolfram Sang if (!client) 100191ed5349SWolfram Sang return -EINVAL; 100291ed5349SWolfram Sang 100391ed5349SWolfram Sang /* Keep track of the added device */ 100491ed5349SWolfram Sang mutex_lock(&adap->userspace_clients_lock); 100591ed5349SWolfram Sang list_add_tail(&client->detected, &adap->userspace_clients); 100691ed5349SWolfram Sang mutex_unlock(&adap->userspace_clients_lock); 100791ed5349SWolfram Sang dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device", 100891ed5349SWolfram Sang info.type, info.addr); 100991ed5349SWolfram Sang 101091ed5349SWolfram Sang return count; 101191ed5349SWolfram Sang } 101291ed5349SWolfram Sang static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device); 101391ed5349SWolfram Sang 101491ed5349SWolfram Sang /* 101591ed5349SWolfram Sang * And of course let the users delete the devices they instantiated, if 101691ed5349SWolfram Sang * they got it wrong. This interface can only be used to delete devices 101791ed5349SWolfram Sang * instantiated by i2c_sysfs_new_device above. This guarantees that we 101891ed5349SWolfram Sang * don't delete devices to which some kernel code still has references. 101991ed5349SWolfram Sang * 102091ed5349SWolfram Sang * Parameter checking may look overzealous, but we really don't want 102191ed5349SWolfram Sang * the user to delete the wrong device. 102291ed5349SWolfram Sang */ 102391ed5349SWolfram Sang static ssize_t 102491ed5349SWolfram Sang i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr, 102591ed5349SWolfram Sang const char *buf, size_t count) 102691ed5349SWolfram Sang { 102791ed5349SWolfram Sang struct i2c_adapter *adap = to_i2c_adapter(dev); 102891ed5349SWolfram Sang struct i2c_client *client, *next; 102991ed5349SWolfram Sang unsigned short addr; 103091ed5349SWolfram Sang char end; 103191ed5349SWolfram Sang int res; 103291ed5349SWolfram Sang 103391ed5349SWolfram Sang /* Parse parameters, reject extra parameters */ 103491ed5349SWolfram Sang res = sscanf(buf, "%hi%c", &addr, &end); 103591ed5349SWolfram Sang if (res < 1) { 103691ed5349SWolfram Sang dev_err(dev, "%s: Can't parse I2C address\n", "delete_device"); 103791ed5349SWolfram Sang return -EINVAL; 103891ed5349SWolfram Sang } 103991ed5349SWolfram Sang if (res > 1 && end != '\n') { 104091ed5349SWolfram Sang dev_err(dev, "%s: Extra parameters\n", "delete_device"); 104191ed5349SWolfram Sang return -EINVAL; 104291ed5349SWolfram Sang } 104391ed5349SWolfram Sang 104491ed5349SWolfram Sang /* Make sure the device was added through sysfs */ 104591ed5349SWolfram Sang res = -ENOENT; 104691ed5349SWolfram Sang mutex_lock_nested(&adap->userspace_clients_lock, 104791ed5349SWolfram Sang i2c_adapter_depth(adap)); 104891ed5349SWolfram Sang list_for_each_entry_safe(client, next, &adap->userspace_clients, 104991ed5349SWolfram Sang detected) { 105091ed5349SWolfram Sang if (i2c_encode_flags_to_addr(client) == addr) { 105191ed5349SWolfram Sang dev_info(dev, "%s: Deleting device %s at 0x%02hx\n", 105291ed5349SWolfram Sang "delete_device", client->name, client->addr); 105391ed5349SWolfram Sang 105491ed5349SWolfram Sang list_del(&client->detected); 105591ed5349SWolfram Sang i2c_unregister_device(client); 105691ed5349SWolfram Sang res = count; 105791ed5349SWolfram Sang break; 105891ed5349SWolfram Sang } 105991ed5349SWolfram Sang } 106091ed5349SWolfram Sang mutex_unlock(&adap->userspace_clients_lock); 106191ed5349SWolfram Sang 106291ed5349SWolfram Sang if (res < 0) 106391ed5349SWolfram Sang dev_err(dev, "%s: Can't find device in list\n", 106491ed5349SWolfram Sang "delete_device"); 106591ed5349SWolfram Sang return res; 106691ed5349SWolfram Sang } 106791ed5349SWolfram Sang static DEVICE_ATTR_IGNORE_LOCKDEP(delete_device, S_IWUSR, NULL, 106891ed5349SWolfram Sang i2c_sysfs_delete_device); 106991ed5349SWolfram Sang 107091ed5349SWolfram Sang static struct attribute *i2c_adapter_attrs[] = { 107191ed5349SWolfram Sang &dev_attr_name.attr, 107291ed5349SWolfram Sang &dev_attr_new_device.attr, 107391ed5349SWolfram Sang &dev_attr_delete_device.attr, 107491ed5349SWolfram Sang NULL 107591ed5349SWolfram Sang }; 107691ed5349SWolfram Sang ATTRIBUTE_GROUPS(i2c_adapter); 107791ed5349SWolfram Sang 107891ed5349SWolfram Sang struct device_type i2c_adapter_type = { 107991ed5349SWolfram Sang .groups = i2c_adapter_groups, 108091ed5349SWolfram Sang .release = i2c_adapter_dev_release, 108191ed5349SWolfram Sang }; 108291ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_adapter_type); 108391ed5349SWolfram Sang 108491ed5349SWolfram Sang /** 108591ed5349SWolfram Sang * i2c_verify_adapter - return parameter as i2c_adapter or NULL 108691ed5349SWolfram Sang * @dev: device, probably from some driver model iterator 108791ed5349SWolfram Sang * 108891ed5349SWolfram Sang * When traversing the driver model tree, perhaps using driver model 108991ed5349SWolfram Sang * iterators like @device_for_each_child(), you can't assume very much 109091ed5349SWolfram Sang * about the nodes you find. Use this function to avoid oopses caused 109191ed5349SWolfram Sang * by wrongly treating some non-I2C device as an i2c_adapter. 109291ed5349SWolfram Sang */ 109391ed5349SWolfram Sang struct i2c_adapter *i2c_verify_adapter(struct device *dev) 109491ed5349SWolfram Sang { 109591ed5349SWolfram Sang return (dev->type == &i2c_adapter_type) 109691ed5349SWolfram Sang ? to_i2c_adapter(dev) 109791ed5349SWolfram Sang : NULL; 109891ed5349SWolfram Sang } 109991ed5349SWolfram Sang EXPORT_SYMBOL(i2c_verify_adapter); 110091ed5349SWolfram Sang 110191ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 110291ed5349SWolfram Sang static struct class_compat *i2c_adapter_compat_class; 110391ed5349SWolfram Sang #endif 110491ed5349SWolfram Sang 110591ed5349SWolfram Sang static void i2c_scan_static_board_info(struct i2c_adapter *adapter) 110691ed5349SWolfram Sang { 110791ed5349SWolfram Sang struct i2c_devinfo *devinfo; 110891ed5349SWolfram Sang 110991ed5349SWolfram Sang down_read(&__i2c_board_lock); 111091ed5349SWolfram Sang list_for_each_entry(devinfo, &__i2c_board_list, list) { 111191ed5349SWolfram Sang if (devinfo->busnum == adapter->nr 111291ed5349SWolfram Sang && !i2c_new_device(adapter, 111391ed5349SWolfram Sang &devinfo->board_info)) 111491ed5349SWolfram Sang dev_err(&adapter->dev, 111591ed5349SWolfram Sang "Can't create device at 0x%02x\n", 111691ed5349SWolfram Sang devinfo->board_info.addr); 111791ed5349SWolfram Sang } 111891ed5349SWolfram Sang up_read(&__i2c_board_lock); 111991ed5349SWolfram Sang } 112091ed5349SWolfram Sang 112191ed5349SWolfram Sang static int i2c_do_add_adapter(struct i2c_driver *driver, 112291ed5349SWolfram Sang struct i2c_adapter *adap) 112391ed5349SWolfram Sang { 112491ed5349SWolfram Sang /* Detect supported devices on that bus, and instantiate them */ 112591ed5349SWolfram Sang i2c_detect(adap, driver); 112691ed5349SWolfram Sang 112791ed5349SWolfram Sang /* Let legacy drivers scan this bus for matching devices */ 112891ed5349SWolfram Sang if (driver->attach_adapter) { 112991ed5349SWolfram Sang dev_warn(&adap->dev, "%s: attach_adapter method is deprecated\n", 113091ed5349SWolfram Sang driver->driver.name); 113191ed5349SWolfram Sang dev_warn(&adap->dev, 113291ed5349SWolfram Sang "Please use another way to instantiate your i2c_client\n"); 113391ed5349SWolfram Sang /* We ignore the return code; if it fails, too bad */ 113491ed5349SWolfram Sang driver->attach_adapter(adap); 113591ed5349SWolfram Sang } 113691ed5349SWolfram Sang return 0; 113791ed5349SWolfram Sang } 113891ed5349SWolfram Sang 113991ed5349SWolfram Sang static int __process_new_adapter(struct device_driver *d, void *data) 114091ed5349SWolfram Sang { 114191ed5349SWolfram Sang return i2c_do_add_adapter(to_i2c_driver(d), data); 114291ed5349SWolfram Sang } 114391ed5349SWolfram Sang 114491ed5349SWolfram Sang static const struct i2c_lock_operations i2c_adapter_lock_ops = { 114591ed5349SWolfram Sang .lock_bus = i2c_adapter_lock_bus, 114691ed5349SWolfram Sang .trylock_bus = i2c_adapter_trylock_bus, 114791ed5349SWolfram Sang .unlock_bus = i2c_adapter_unlock_bus, 114891ed5349SWolfram Sang }; 114991ed5349SWolfram Sang 115091ed5349SWolfram Sang static void i2c_host_notify_irq_teardown(struct i2c_adapter *adap) 115191ed5349SWolfram Sang { 115291ed5349SWolfram Sang struct irq_domain *domain = adap->host_notify_domain; 115391ed5349SWolfram Sang irq_hw_number_t hwirq; 115491ed5349SWolfram Sang 115591ed5349SWolfram Sang if (!domain) 115691ed5349SWolfram Sang return; 115791ed5349SWolfram Sang 115891ed5349SWolfram Sang for (hwirq = 0 ; hwirq < I2C_ADDR_7BITS_COUNT ; hwirq++) 115991ed5349SWolfram Sang irq_dispose_mapping(irq_find_mapping(domain, hwirq)); 116091ed5349SWolfram Sang 116191ed5349SWolfram Sang irq_domain_remove(domain); 116291ed5349SWolfram Sang adap->host_notify_domain = NULL; 116391ed5349SWolfram Sang } 116491ed5349SWolfram Sang 116591ed5349SWolfram Sang static int i2c_host_notify_irq_map(struct irq_domain *h, 116691ed5349SWolfram Sang unsigned int virq, 116791ed5349SWolfram Sang irq_hw_number_t hw_irq_num) 116891ed5349SWolfram Sang { 116991ed5349SWolfram Sang irq_set_chip_and_handler(virq, &dummy_irq_chip, handle_simple_irq); 117091ed5349SWolfram Sang 117191ed5349SWolfram Sang return 0; 117291ed5349SWolfram Sang } 117391ed5349SWolfram Sang 117491ed5349SWolfram Sang static const struct irq_domain_ops i2c_host_notify_irq_ops = { 117591ed5349SWolfram Sang .map = i2c_host_notify_irq_map, 117691ed5349SWolfram Sang }; 117791ed5349SWolfram Sang 117891ed5349SWolfram Sang static int i2c_setup_host_notify_irq_domain(struct i2c_adapter *adap) 117991ed5349SWolfram Sang { 118091ed5349SWolfram Sang struct irq_domain *domain; 118191ed5349SWolfram Sang 118291ed5349SWolfram Sang if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_HOST_NOTIFY)) 118391ed5349SWolfram Sang return 0; 118491ed5349SWolfram Sang 118591ed5349SWolfram Sang domain = irq_domain_create_linear(adap->dev.fwnode, 118691ed5349SWolfram Sang I2C_ADDR_7BITS_COUNT, 118791ed5349SWolfram Sang &i2c_host_notify_irq_ops, adap); 118891ed5349SWolfram Sang if (!domain) 118991ed5349SWolfram Sang return -ENOMEM; 119091ed5349SWolfram Sang 119191ed5349SWolfram Sang adap->host_notify_domain = domain; 119291ed5349SWolfram Sang 119391ed5349SWolfram Sang return 0; 119491ed5349SWolfram Sang } 119591ed5349SWolfram Sang 119691ed5349SWolfram Sang /** 119791ed5349SWolfram Sang * i2c_handle_smbus_host_notify - Forward a Host Notify event to the correct 119891ed5349SWolfram Sang * I2C client. 119991ed5349SWolfram Sang * @adap: the adapter 120091ed5349SWolfram Sang * @addr: the I2C address of the notifying device 120191ed5349SWolfram Sang * Context: can't sleep 120291ed5349SWolfram Sang * 120391ed5349SWolfram Sang * Helper function to be called from an I2C bus driver's interrupt 120491ed5349SWolfram Sang * handler. It will schedule the Host Notify IRQ. 120591ed5349SWolfram Sang */ 120691ed5349SWolfram Sang int i2c_handle_smbus_host_notify(struct i2c_adapter *adap, unsigned short addr) 120791ed5349SWolfram Sang { 120891ed5349SWolfram Sang int irq; 120991ed5349SWolfram Sang 121091ed5349SWolfram Sang if (!adap) 121191ed5349SWolfram Sang return -EINVAL; 121291ed5349SWolfram Sang 121391ed5349SWolfram Sang irq = irq_find_mapping(adap->host_notify_domain, addr); 121491ed5349SWolfram Sang if (irq <= 0) 121591ed5349SWolfram Sang return -ENXIO; 121691ed5349SWolfram Sang 121791ed5349SWolfram Sang generic_handle_irq(irq); 121891ed5349SWolfram Sang 121991ed5349SWolfram Sang return 0; 122091ed5349SWolfram Sang } 122191ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_handle_smbus_host_notify); 122291ed5349SWolfram Sang 122391ed5349SWolfram Sang static int i2c_register_adapter(struct i2c_adapter *adap) 122491ed5349SWolfram Sang { 122591ed5349SWolfram Sang int res = -EINVAL; 122691ed5349SWolfram Sang 122791ed5349SWolfram Sang /* Can't register until after driver model init */ 122891ed5349SWolfram Sang if (WARN_ON(!is_registered)) { 122991ed5349SWolfram Sang res = -EAGAIN; 123091ed5349SWolfram Sang goto out_list; 123191ed5349SWolfram Sang } 123291ed5349SWolfram Sang 123391ed5349SWolfram Sang /* Sanity checks */ 123491ed5349SWolfram Sang if (WARN(!adap->name[0], "i2c adapter has no name")) 123591ed5349SWolfram Sang goto out_list; 123691ed5349SWolfram Sang 123791ed5349SWolfram Sang if (!adap->algo) { 123891ed5349SWolfram Sang pr_err("adapter '%s': no algo supplied!\n", adap->name); 123991ed5349SWolfram Sang goto out_list; 124091ed5349SWolfram Sang } 124191ed5349SWolfram Sang 124291ed5349SWolfram Sang if (!adap->lock_ops) 124391ed5349SWolfram Sang adap->lock_ops = &i2c_adapter_lock_ops; 124491ed5349SWolfram Sang 124591ed5349SWolfram Sang rt_mutex_init(&adap->bus_lock); 124691ed5349SWolfram Sang rt_mutex_init(&adap->mux_lock); 124791ed5349SWolfram Sang mutex_init(&adap->userspace_clients_lock); 124891ed5349SWolfram Sang INIT_LIST_HEAD(&adap->userspace_clients); 124991ed5349SWolfram Sang 125091ed5349SWolfram Sang /* Set default timeout to 1 second if not already set */ 125191ed5349SWolfram Sang if (adap->timeout == 0) 125291ed5349SWolfram Sang adap->timeout = HZ; 125391ed5349SWolfram Sang 125491ed5349SWolfram Sang /* register soft irqs for Host Notify */ 125591ed5349SWolfram Sang res = i2c_setup_host_notify_irq_domain(adap); 125691ed5349SWolfram Sang if (res) { 125791ed5349SWolfram Sang pr_err("adapter '%s': can't create Host Notify IRQs (%d)\n", 125891ed5349SWolfram Sang adap->name, res); 125991ed5349SWolfram Sang goto out_list; 126091ed5349SWolfram Sang } 126191ed5349SWolfram Sang 126291ed5349SWolfram Sang dev_set_name(&adap->dev, "i2c-%d", adap->nr); 126391ed5349SWolfram Sang adap->dev.bus = &i2c_bus_type; 126491ed5349SWolfram Sang adap->dev.type = &i2c_adapter_type; 126591ed5349SWolfram Sang res = device_register(&adap->dev); 126691ed5349SWolfram Sang if (res) { 126791ed5349SWolfram Sang pr_err("adapter '%s': can't register device (%d)\n", adap->name, res); 126891ed5349SWolfram Sang goto out_list; 126991ed5349SWolfram Sang } 127091ed5349SWolfram Sang 1271f8756c67SPhil Reid res = of_i2c_setup_smbus_alert(adap); 1272f8756c67SPhil Reid if (res) 1273f8756c67SPhil Reid goto out_reg; 1274f8756c67SPhil Reid 127591ed5349SWolfram Sang dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name); 127691ed5349SWolfram Sang 127791ed5349SWolfram Sang pm_runtime_no_callbacks(&adap->dev); 127891ed5349SWolfram Sang pm_suspend_ignore_children(&adap->dev, true); 127991ed5349SWolfram Sang pm_runtime_enable(&adap->dev); 128091ed5349SWolfram Sang 128191ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 128291ed5349SWolfram Sang res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev, 128391ed5349SWolfram Sang adap->dev.parent); 128491ed5349SWolfram Sang if (res) 128591ed5349SWolfram Sang dev_warn(&adap->dev, 128691ed5349SWolfram Sang "Failed to create compatibility class link\n"); 128791ed5349SWolfram Sang #endif 128891ed5349SWolfram Sang 128991ed5349SWolfram Sang i2c_init_recovery(adap); 129091ed5349SWolfram Sang 129191ed5349SWolfram Sang /* create pre-declared device nodes */ 129291ed5349SWolfram Sang of_i2c_register_devices(adap); 129391ed5349SWolfram Sang i2c_acpi_register_devices(adap); 129491ed5349SWolfram Sang i2c_acpi_install_space_handler(adap); 129591ed5349SWolfram Sang 129691ed5349SWolfram Sang if (adap->nr < __i2c_first_dynamic_bus_num) 129791ed5349SWolfram Sang i2c_scan_static_board_info(adap); 129891ed5349SWolfram Sang 129991ed5349SWolfram Sang /* Notify drivers */ 130091ed5349SWolfram Sang mutex_lock(&core_lock); 130191ed5349SWolfram Sang bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter); 130291ed5349SWolfram Sang mutex_unlock(&core_lock); 130391ed5349SWolfram Sang 130491ed5349SWolfram Sang return 0; 130591ed5349SWolfram Sang 1306f8756c67SPhil Reid out_reg: 1307f8756c67SPhil Reid init_completion(&adap->dev_released); 1308f8756c67SPhil Reid device_unregister(&adap->dev); 1309f8756c67SPhil Reid wait_for_completion(&adap->dev_released); 131091ed5349SWolfram Sang out_list: 131191ed5349SWolfram Sang mutex_lock(&core_lock); 131291ed5349SWolfram Sang idr_remove(&i2c_adapter_idr, adap->nr); 131391ed5349SWolfram Sang mutex_unlock(&core_lock); 131491ed5349SWolfram Sang return res; 131591ed5349SWolfram Sang } 131691ed5349SWolfram Sang 131791ed5349SWolfram Sang /** 131891ed5349SWolfram Sang * __i2c_add_numbered_adapter - i2c_add_numbered_adapter where nr is never -1 131991ed5349SWolfram Sang * @adap: the adapter to register (with adap->nr initialized) 132091ed5349SWolfram Sang * Context: can sleep 132191ed5349SWolfram Sang * 132291ed5349SWolfram Sang * See i2c_add_numbered_adapter() for details. 132391ed5349SWolfram Sang */ 132491ed5349SWolfram Sang static int __i2c_add_numbered_adapter(struct i2c_adapter *adap) 132591ed5349SWolfram Sang { 132691ed5349SWolfram Sang int id; 132791ed5349SWolfram Sang 132891ed5349SWolfram Sang mutex_lock(&core_lock); 132991ed5349SWolfram Sang id = idr_alloc(&i2c_adapter_idr, adap, adap->nr, adap->nr + 1, GFP_KERNEL); 133091ed5349SWolfram Sang mutex_unlock(&core_lock); 133191ed5349SWolfram Sang if (WARN(id < 0, "couldn't get idr")) 133291ed5349SWolfram Sang return id == -ENOSPC ? -EBUSY : id; 133391ed5349SWolfram Sang 133491ed5349SWolfram Sang return i2c_register_adapter(adap); 133591ed5349SWolfram Sang } 133691ed5349SWolfram Sang 133791ed5349SWolfram Sang /** 133891ed5349SWolfram Sang * i2c_add_adapter - declare i2c adapter, use dynamic bus number 133991ed5349SWolfram Sang * @adapter: the adapter to add 134091ed5349SWolfram Sang * Context: can sleep 134191ed5349SWolfram Sang * 134291ed5349SWolfram Sang * This routine is used to declare an I2C adapter when its bus number 134391ed5349SWolfram Sang * doesn't matter or when its bus number is specified by an dt alias. 134491ed5349SWolfram Sang * Examples of bases when the bus number doesn't matter: I2C adapters 134591ed5349SWolfram Sang * dynamically added by USB links or PCI plugin cards. 134691ed5349SWolfram Sang * 134791ed5349SWolfram Sang * When this returns zero, a new bus number was allocated and stored 134891ed5349SWolfram Sang * in adap->nr, and the specified adapter became available for clients. 134991ed5349SWolfram Sang * Otherwise, a negative errno value is returned. 135091ed5349SWolfram Sang */ 135191ed5349SWolfram Sang int i2c_add_adapter(struct i2c_adapter *adapter) 135291ed5349SWolfram Sang { 135391ed5349SWolfram Sang struct device *dev = &adapter->dev; 135491ed5349SWolfram Sang int id; 135591ed5349SWolfram Sang 135691ed5349SWolfram Sang if (dev->of_node) { 135791ed5349SWolfram Sang id = of_alias_get_id(dev->of_node, "i2c"); 135891ed5349SWolfram Sang if (id >= 0) { 135991ed5349SWolfram Sang adapter->nr = id; 136091ed5349SWolfram Sang return __i2c_add_numbered_adapter(adapter); 136191ed5349SWolfram Sang } 136291ed5349SWolfram Sang } 136391ed5349SWolfram Sang 136491ed5349SWolfram Sang mutex_lock(&core_lock); 136591ed5349SWolfram Sang id = idr_alloc(&i2c_adapter_idr, adapter, 136691ed5349SWolfram Sang __i2c_first_dynamic_bus_num, 0, GFP_KERNEL); 136791ed5349SWolfram Sang mutex_unlock(&core_lock); 136891ed5349SWolfram Sang if (WARN(id < 0, "couldn't get idr")) 136991ed5349SWolfram Sang return id; 137091ed5349SWolfram Sang 137191ed5349SWolfram Sang adapter->nr = id; 137291ed5349SWolfram Sang 137391ed5349SWolfram Sang return i2c_register_adapter(adapter); 137491ed5349SWolfram Sang } 137591ed5349SWolfram Sang EXPORT_SYMBOL(i2c_add_adapter); 137691ed5349SWolfram Sang 137791ed5349SWolfram Sang /** 137891ed5349SWolfram Sang * i2c_add_numbered_adapter - declare i2c adapter, use static bus number 137991ed5349SWolfram Sang * @adap: the adapter to register (with adap->nr initialized) 138091ed5349SWolfram Sang * Context: can sleep 138191ed5349SWolfram Sang * 138291ed5349SWolfram Sang * This routine is used to declare an I2C adapter when its bus number 138391ed5349SWolfram Sang * matters. For example, use it for I2C adapters from system-on-chip CPUs, 138491ed5349SWolfram Sang * or otherwise built in to the system's mainboard, and where i2c_board_info 138591ed5349SWolfram Sang * is used to properly configure I2C devices. 138691ed5349SWolfram Sang * 138791ed5349SWolfram Sang * If the requested bus number is set to -1, then this function will behave 138891ed5349SWolfram Sang * identically to i2c_add_adapter, and will dynamically assign a bus number. 138991ed5349SWolfram Sang * 139091ed5349SWolfram Sang * If no devices have pre-been declared for this bus, then be sure to 139191ed5349SWolfram Sang * register the adapter before any dynamically allocated ones. Otherwise 139291ed5349SWolfram Sang * the required bus ID may not be available. 139391ed5349SWolfram Sang * 139491ed5349SWolfram Sang * When this returns zero, the specified adapter became available for 139591ed5349SWolfram Sang * clients using the bus number provided in adap->nr. Also, the table 139691ed5349SWolfram Sang * of I2C devices pre-declared using i2c_register_board_info() is scanned, 139791ed5349SWolfram Sang * and the appropriate driver model device nodes are created. Otherwise, a 139891ed5349SWolfram Sang * negative errno value is returned. 139991ed5349SWolfram Sang */ 140091ed5349SWolfram Sang int i2c_add_numbered_adapter(struct i2c_adapter *adap) 140191ed5349SWolfram Sang { 140291ed5349SWolfram Sang if (adap->nr == -1) /* -1 means dynamically assign bus id */ 140391ed5349SWolfram Sang return i2c_add_adapter(adap); 140491ed5349SWolfram Sang 140591ed5349SWolfram Sang return __i2c_add_numbered_adapter(adap); 140691ed5349SWolfram Sang } 140791ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter); 140891ed5349SWolfram Sang 140991ed5349SWolfram Sang static void i2c_do_del_adapter(struct i2c_driver *driver, 141091ed5349SWolfram Sang struct i2c_adapter *adapter) 141191ed5349SWolfram Sang { 141291ed5349SWolfram Sang struct i2c_client *client, *_n; 141391ed5349SWolfram Sang 141491ed5349SWolfram Sang /* Remove the devices we created ourselves as the result of hardware 141591ed5349SWolfram Sang * probing (using a driver's detect method) */ 141691ed5349SWolfram Sang list_for_each_entry_safe(client, _n, &driver->clients, detected) { 141791ed5349SWolfram Sang if (client->adapter == adapter) { 141891ed5349SWolfram Sang dev_dbg(&adapter->dev, "Removing %s at 0x%x\n", 141991ed5349SWolfram Sang client->name, client->addr); 142091ed5349SWolfram Sang list_del(&client->detected); 142191ed5349SWolfram Sang i2c_unregister_device(client); 142291ed5349SWolfram Sang } 142391ed5349SWolfram Sang } 142491ed5349SWolfram Sang } 142591ed5349SWolfram Sang 142691ed5349SWolfram Sang static int __unregister_client(struct device *dev, void *dummy) 142791ed5349SWolfram Sang { 142891ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 142991ed5349SWolfram Sang if (client && strcmp(client->name, "dummy")) 143091ed5349SWolfram Sang i2c_unregister_device(client); 143191ed5349SWolfram Sang return 0; 143291ed5349SWolfram Sang } 143391ed5349SWolfram Sang 143491ed5349SWolfram Sang static int __unregister_dummy(struct device *dev, void *dummy) 143591ed5349SWolfram Sang { 143691ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 143791ed5349SWolfram Sang i2c_unregister_device(client); 143891ed5349SWolfram Sang return 0; 143991ed5349SWolfram Sang } 144091ed5349SWolfram Sang 144191ed5349SWolfram Sang static int __process_removed_adapter(struct device_driver *d, void *data) 144291ed5349SWolfram Sang { 144391ed5349SWolfram Sang i2c_do_del_adapter(to_i2c_driver(d), data); 144491ed5349SWolfram Sang return 0; 144591ed5349SWolfram Sang } 144691ed5349SWolfram Sang 144791ed5349SWolfram Sang /** 144891ed5349SWolfram Sang * i2c_del_adapter - unregister I2C adapter 144991ed5349SWolfram Sang * @adap: the adapter being unregistered 145091ed5349SWolfram Sang * Context: can sleep 145191ed5349SWolfram Sang * 145291ed5349SWolfram Sang * This unregisters an I2C adapter which was previously registered 145391ed5349SWolfram Sang * by @i2c_add_adapter or @i2c_add_numbered_adapter. 145491ed5349SWolfram Sang */ 145591ed5349SWolfram Sang void i2c_del_adapter(struct i2c_adapter *adap) 145691ed5349SWolfram Sang { 145791ed5349SWolfram Sang struct i2c_adapter *found; 145891ed5349SWolfram Sang struct i2c_client *client, *next; 145991ed5349SWolfram Sang 146091ed5349SWolfram Sang /* First make sure that this adapter was ever added */ 146191ed5349SWolfram Sang mutex_lock(&core_lock); 146291ed5349SWolfram Sang found = idr_find(&i2c_adapter_idr, adap->nr); 146391ed5349SWolfram Sang mutex_unlock(&core_lock); 146491ed5349SWolfram Sang if (found != adap) { 146591ed5349SWolfram Sang pr_debug("attempting to delete unregistered adapter [%s]\n", adap->name); 146691ed5349SWolfram Sang return; 146791ed5349SWolfram Sang } 146891ed5349SWolfram Sang 146991ed5349SWolfram Sang i2c_acpi_remove_space_handler(adap); 147091ed5349SWolfram Sang /* Tell drivers about this removal */ 147191ed5349SWolfram Sang mutex_lock(&core_lock); 147291ed5349SWolfram Sang bus_for_each_drv(&i2c_bus_type, NULL, adap, 147391ed5349SWolfram Sang __process_removed_adapter); 147491ed5349SWolfram Sang mutex_unlock(&core_lock); 147591ed5349SWolfram Sang 147691ed5349SWolfram Sang /* Remove devices instantiated from sysfs */ 147791ed5349SWolfram Sang mutex_lock_nested(&adap->userspace_clients_lock, 147891ed5349SWolfram Sang i2c_adapter_depth(adap)); 147991ed5349SWolfram Sang list_for_each_entry_safe(client, next, &adap->userspace_clients, 148091ed5349SWolfram Sang detected) { 148191ed5349SWolfram Sang dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name, 148291ed5349SWolfram Sang client->addr); 148391ed5349SWolfram Sang list_del(&client->detected); 148491ed5349SWolfram Sang i2c_unregister_device(client); 148591ed5349SWolfram Sang } 148691ed5349SWolfram Sang mutex_unlock(&adap->userspace_clients_lock); 148791ed5349SWolfram Sang 148891ed5349SWolfram Sang /* Detach any active clients. This can't fail, thus we do not 148991ed5349SWolfram Sang * check the returned value. This is a two-pass process, because 149091ed5349SWolfram Sang * we can't remove the dummy devices during the first pass: they 149191ed5349SWolfram Sang * could have been instantiated by real devices wishing to clean 149291ed5349SWolfram Sang * them up properly, so we give them a chance to do that first. */ 149391ed5349SWolfram Sang device_for_each_child(&adap->dev, NULL, __unregister_client); 149491ed5349SWolfram Sang device_for_each_child(&adap->dev, NULL, __unregister_dummy); 149591ed5349SWolfram Sang 149691ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 149791ed5349SWolfram Sang class_compat_remove_link(i2c_adapter_compat_class, &adap->dev, 149891ed5349SWolfram Sang adap->dev.parent); 149991ed5349SWolfram Sang #endif 150091ed5349SWolfram Sang 150191ed5349SWolfram Sang /* device name is gone after device_unregister */ 150291ed5349SWolfram Sang dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name); 150391ed5349SWolfram Sang 150491ed5349SWolfram Sang pm_runtime_disable(&adap->dev); 150591ed5349SWolfram Sang 150691ed5349SWolfram Sang i2c_host_notify_irq_teardown(adap); 150791ed5349SWolfram Sang 150891ed5349SWolfram Sang /* wait until all references to the device are gone 150991ed5349SWolfram Sang * 151091ed5349SWolfram Sang * FIXME: This is old code and should ideally be replaced by an 151191ed5349SWolfram Sang * alternative which results in decoupling the lifetime of the struct 151291ed5349SWolfram Sang * device from the i2c_adapter, like spi or netdev do. Any solution 151391ed5349SWolfram Sang * should be thoroughly tested with DEBUG_KOBJECT_RELEASE enabled! 151491ed5349SWolfram Sang */ 151591ed5349SWolfram Sang init_completion(&adap->dev_released); 151691ed5349SWolfram Sang device_unregister(&adap->dev); 151791ed5349SWolfram Sang wait_for_completion(&adap->dev_released); 151891ed5349SWolfram Sang 151991ed5349SWolfram Sang /* free bus id */ 152091ed5349SWolfram Sang mutex_lock(&core_lock); 152191ed5349SWolfram Sang idr_remove(&i2c_adapter_idr, adap->nr); 152291ed5349SWolfram Sang mutex_unlock(&core_lock); 152391ed5349SWolfram Sang 152491ed5349SWolfram Sang /* Clear the device structure in case this adapter is ever going to be 152591ed5349SWolfram Sang added again */ 152691ed5349SWolfram Sang memset(&adap->dev, 0, sizeof(adap->dev)); 152791ed5349SWolfram Sang } 152891ed5349SWolfram Sang EXPORT_SYMBOL(i2c_del_adapter); 152991ed5349SWolfram Sang 153091ed5349SWolfram Sang /** 153191ed5349SWolfram Sang * i2c_parse_fw_timings - get I2C related timing parameters from firmware 153291ed5349SWolfram Sang * @dev: The device to scan for I2C timing properties 153391ed5349SWolfram Sang * @t: the i2c_timings struct to be filled with values 153491ed5349SWolfram Sang * @use_defaults: bool to use sane defaults derived from the I2C specification 153591ed5349SWolfram Sang * when properties are not found, otherwise use 0 153691ed5349SWolfram Sang * 153791ed5349SWolfram Sang * Scan the device for the generic I2C properties describing timing parameters 153891ed5349SWolfram Sang * for the signal and fill the given struct with the results. If a property was 153991ed5349SWolfram Sang * not found and use_defaults was true, then maximum timings are assumed which 154091ed5349SWolfram Sang * are derived from the I2C specification. If use_defaults is not used, the 154191ed5349SWolfram Sang * results will be 0, so drivers can apply their own defaults later. The latter 154291ed5349SWolfram Sang * is mainly intended for avoiding regressions of existing drivers which want 154391ed5349SWolfram Sang * to switch to this function. New drivers almost always should use the defaults. 154491ed5349SWolfram Sang */ 154591ed5349SWolfram Sang 154691ed5349SWolfram Sang void i2c_parse_fw_timings(struct device *dev, struct i2c_timings *t, bool use_defaults) 154791ed5349SWolfram Sang { 154891ed5349SWolfram Sang int ret; 154991ed5349SWolfram Sang 155091ed5349SWolfram Sang memset(t, 0, sizeof(*t)); 155191ed5349SWolfram Sang 155291ed5349SWolfram Sang ret = device_property_read_u32(dev, "clock-frequency", &t->bus_freq_hz); 155391ed5349SWolfram Sang if (ret && use_defaults) 155491ed5349SWolfram Sang t->bus_freq_hz = 100000; 155591ed5349SWolfram Sang 155691ed5349SWolfram Sang ret = device_property_read_u32(dev, "i2c-scl-rising-time-ns", &t->scl_rise_ns); 155791ed5349SWolfram Sang if (ret && use_defaults) { 155891ed5349SWolfram Sang if (t->bus_freq_hz <= 100000) 155991ed5349SWolfram Sang t->scl_rise_ns = 1000; 156091ed5349SWolfram Sang else if (t->bus_freq_hz <= 400000) 156191ed5349SWolfram Sang t->scl_rise_ns = 300; 156291ed5349SWolfram Sang else 156391ed5349SWolfram Sang t->scl_rise_ns = 120; 156491ed5349SWolfram Sang } 156591ed5349SWolfram Sang 156691ed5349SWolfram Sang ret = device_property_read_u32(dev, "i2c-scl-falling-time-ns", &t->scl_fall_ns); 156791ed5349SWolfram Sang if (ret && use_defaults) { 156891ed5349SWolfram Sang if (t->bus_freq_hz <= 400000) 156991ed5349SWolfram Sang t->scl_fall_ns = 300; 157091ed5349SWolfram Sang else 157191ed5349SWolfram Sang t->scl_fall_ns = 120; 157291ed5349SWolfram Sang } 157391ed5349SWolfram Sang 157491ed5349SWolfram Sang device_property_read_u32(dev, "i2c-scl-internal-delay-ns", &t->scl_int_delay_ns); 157591ed5349SWolfram Sang 157691ed5349SWolfram Sang ret = device_property_read_u32(dev, "i2c-sda-falling-time-ns", &t->sda_fall_ns); 157791ed5349SWolfram Sang if (ret && use_defaults) 157891ed5349SWolfram Sang t->sda_fall_ns = t->scl_fall_ns; 15794717be73SAndy Shevchenko 15804717be73SAndy Shevchenko device_property_read_u32(dev, "i2c-sda-hold-time-ns", &t->sda_hold_ns); 158191ed5349SWolfram Sang } 158291ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_parse_fw_timings); 158391ed5349SWolfram Sang 158491ed5349SWolfram Sang /* ------------------------------------------------------------------------- */ 158591ed5349SWolfram Sang 158691ed5349SWolfram Sang int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *)) 158791ed5349SWolfram Sang { 158891ed5349SWolfram Sang int res; 158991ed5349SWolfram Sang 159091ed5349SWolfram Sang mutex_lock(&core_lock); 159191ed5349SWolfram Sang res = bus_for_each_dev(&i2c_bus_type, NULL, data, fn); 159291ed5349SWolfram Sang mutex_unlock(&core_lock); 159391ed5349SWolfram Sang 159491ed5349SWolfram Sang return res; 159591ed5349SWolfram Sang } 159691ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_for_each_dev); 159791ed5349SWolfram Sang 159891ed5349SWolfram Sang static int __process_new_driver(struct device *dev, void *data) 159991ed5349SWolfram Sang { 160091ed5349SWolfram Sang if (dev->type != &i2c_adapter_type) 160191ed5349SWolfram Sang return 0; 160291ed5349SWolfram Sang return i2c_do_add_adapter(data, to_i2c_adapter(dev)); 160391ed5349SWolfram Sang } 160491ed5349SWolfram Sang 160591ed5349SWolfram Sang /* 160691ed5349SWolfram Sang * An i2c_driver is used with one or more i2c_client (device) nodes to access 160791ed5349SWolfram Sang * i2c slave chips, on a bus instance associated with some i2c_adapter. 160891ed5349SWolfram Sang */ 160991ed5349SWolfram Sang 161091ed5349SWolfram Sang int i2c_register_driver(struct module *owner, struct i2c_driver *driver) 161191ed5349SWolfram Sang { 161291ed5349SWolfram Sang int res; 161391ed5349SWolfram Sang 161491ed5349SWolfram Sang /* Can't register until after driver model init */ 161591ed5349SWolfram Sang if (WARN_ON(!is_registered)) 161691ed5349SWolfram Sang return -EAGAIN; 161791ed5349SWolfram Sang 161891ed5349SWolfram Sang /* add the driver to the list of i2c drivers in the driver core */ 161991ed5349SWolfram Sang driver->driver.owner = owner; 162091ed5349SWolfram Sang driver->driver.bus = &i2c_bus_type; 162191ed5349SWolfram Sang INIT_LIST_HEAD(&driver->clients); 162291ed5349SWolfram Sang 162391ed5349SWolfram Sang /* When registration returns, the driver core 162491ed5349SWolfram Sang * will have called probe() for all matching-but-unbound devices. 162591ed5349SWolfram Sang */ 162691ed5349SWolfram Sang res = driver_register(&driver->driver); 162791ed5349SWolfram Sang if (res) 162891ed5349SWolfram Sang return res; 162991ed5349SWolfram Sang 163091ed5349SWolfram Sang pr_debug("driver [%s] registered\n", driver->driver.name); 163191ed5349SWolfram Sang 163291ed5349SWolfram Sang /* Walk the adapters that are already present */ 163391ed5349SWolfram Sang i2c_for_each_dev(driver, __process_new_driver); 163491ed5349SWolfram Sang 163591ed5349SWolfram Sang return 0; 163691ed5349SWolfram Sang } 163791ed5349SWolfram Sang EXPORT_SYMBOL(i2c_register_driver); 163891ed5349SWolfram Sang 163991ed5349SWolfram Sang static int __process_removed_driver(struct device *dev, void *data) 164091ed5349SWolfram Sang { 164191ed5349SWolfram Sang if (dev->type == &i2c_adapter_type) 164291ed5349SWolfram Sang i2c_do_del_adapter(data, to_i2c_adapter(dev)); 164391ed5349SWolfram Sang return 0; 164491ed5349SWolfram Sang } 164591ed5349SWolfram Sang 164691ed5349SWolfram Sang /** 164791ed5349SWolfram Sang * i2c_del_driver - unregister I2C driver 164891ed5349SWolfram Sang * @driver: the driver being unregistered 164991ed5349SWolfram Sang * Context: can sleep 165091ed5349SWolfram Sang */ 165191ed5349SWolfram Sang void i2c_del_driver(struct i2c_driver *driver) 165291ed5349SWolfram Sang { 165391ed5349SWolfram Sang i2c_for_each_dev(driver, __process_removed_driver); 165491ed5349SWolfram Sang 165591ed5349SWolfram Sang driver_unregister(&driver->driver); 165691ed5349SWolfram Sang pr_debug("driver [%s] unregistered\n", driver->driver.name); 165791ed5349SWolfram Sang } 165891ed5349SWolfram Sang EXPORT_SYMBOL(i2c_del_driver); 165991ed5349SWolfram Sang 166091ed5349SWolfram Sang /* ------------------------------------------------------------------------- */ 166191ed5349SWolfram Sang 166291ed5349SWolfram Sang /** 166391ed5349SWolfram Sang * i2c_use_client - increments the reference count of the i2c client structure 166491ed5349SWolfram Sang * @client: the client being referenced 166591ed5349SWolfram Sang * 166691ed5349SWolfram Sang * Each live reference to a client should be refcounted. The driver model does 166791ed5349SWolfram Sang * that automatically as part of driver binding, so that most drivers don't 166891ed5349SWolfram Sang * need to do this explicitly: they hold a reference until they're unbound 166991ed5349SWolfram Sang * from the device. 167091ed5349SWolfram Sang * 167191ed5349SWolfram Sang * A pointer to the client with the incremented reference counter is returned. 167291ed5349SWolfram Sang */ 167391ed5349SWolfram Sang struct i2c_client *i2c_use_client(struct i2c_client *client) 167491ed5349SWolfram Sang { 167591ed5349SWolfram Sang if (client && get_device(&client->dev)) 167691ed5349SWolfram Sang return client; 167791ed5349SWolfram Sang return NULL; 167891ed5349SWolfram Sang } 167991ed5349SWolfram Sang EXPORT_SYMBOL(i2c_use_client); 168091ed5349SWolfram Sang 168191ed5349SWolfram Sang /** 168291ed5349SWolfram Sang * i2c_release_client - release a use of the i2c client structure 168391ed5349SWolfram Sang * @client: the client being no longer referenced 168491ed5349SWolfram Sang * 168591ed5349SWolfram Sang * Must be called when a user of a client is finished with it. 168691ed5349SWolfram Sang */ 168791ed5349SWolfram Sang void i2c_release_client(struct i2c_client *client) 168891ed5349SWolfram Sang { 168991ed5349SWolfram Sang if (client) 169091ed5349SWolfram Sang put_device(&client->dev); 169191ed5349SWolfram Sang } 169291ed5349SWolfram Sang EXPORT_SYMBOL(i2c_release_client); 169391ed5349SWolfram Sang 169491ed5349SWolfram Sang struct i2c_cmd_arg { 169591ed5349SWolfram Sang unsigned cmd; 169691ed5349SWolfram Sang void *arg; 169791ed5349SWolfram Sang }; 169891ed5349SWolfram Sang 169991ed5349SWolfram Sang static int i2c_cmd(struct device *dev, void *_arg) 170091ed5349SWolfram Sang { 170191ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 170291ed5349SWolfram Sang struct i2c_cmd_arg *arg = _arg; 170391ed5349SWolfram Sang struct i2c_driver *driver; 170491ed5349SWolfram Sang 170591ed5349SWolfram Sang if (!client || !client->dev.driver) 170691ed5349SWolfram Sang return 0; 170791ed5349SWolfram Sang 170891ed5349SWolfram Sang driver = to_i2c_driver(client->dev.driver); 170991ed5349SWolfram Sang if (driver->command) 171091ed5349SWolfram Sang driver->command(client, arg->cmd, arg->arg); 171191ed5349SWolfram Sang return 0; 171291ed5349SWolfram Sang } 171391ed5349SWolfram Sang 171491ed5349SWolfram Sang void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg) 171591ed5349SWolfram Sang { 171691ed5349SWolfram Sang struct i2c_cmd_arg cmd_arg; 171791ed5349SWolfram Sang 171891ed5349SWolfram Sang cmd_arg.cmd = cmd; 171991ed5349SWolfram Sang cmd_arg.arg = arg; 172091ed5349SWolfram Sang device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd); 172191ed5349SWolfram Sang } 172291ed5349SWolfram Sang EXPORT_SYMBOL(i2c_clients_command); 172391ed5349SWolfram Sang 172491ed5349SWolfram Sang static int __init i2c_init(void) 172591ed5349SWolfram Sang { 172691ed5349SWolfram Sang int retval; 172791ed5349SWolfram Sang 172891ed5349SWolfram Sang retval = of_alias_get_highest_id("i2c"); 172991ed5349SWolfram Sang 173091ed5349SWolfram Sang down_write(&__i2c_board_lock); 173191ed5349SWolfram Sang if (retval >= __i2c_first_dynamic_bus_num) 173291ed5349SWolfram Sang __i2c_first_dynamic_bus_num = retval + 1; 173391ed5349SWolfram Sang up_write(&__i2c_board_lock); 173491ed5349SWolfram Sang 173591ed5349SWolfram Sang retval = bus_register(&i2c_bus_type); 173691ed5349SWolfram Sang if (retval) 173791ed5349SWolfram Sang return retval; 173891ed5349SWolfram Sang 173991ed5349SWolfram Sang is_registered = true; 174091ed5349SWolfram Sang 174191ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 174291ed5349SWolfram Sang i2c_adapter_compat_class = class_compat_register("i2c-adapter"); 174391ed5349SWolfram Sang if (!i2c_adapter_compat_class) { 174491ed5349SWolfram Sang retval = -ENOMEM; 174591ed5349SWolfram Sang goto bus_err; 174691ed5349SWolfram Sang } 174791ed5349SWolfram Sang #endif 174891ed5349SWolfram Sang retval = i2c_add_driver(&dummy_driver); 174991ed5349SWolfram Sang if (retval) 175091ed5349SWolfram Sang goto class_err; 175191ed5349SWolfram Sang 175291ed5349SWolfram Sang if (IS_ENABLED(CONFIG_OF_DYNAMIC)) 175391ed5349SWolfram Sang WARN_ON(of_reconfig_notifier_register(&i2c_of_notifier)); 175491ed5349SWolfram Sang if (IS_ENABLED(CONFIG_ACPI)) 175591ed5349SWolfram Sang WARN_ON(acpi_reconfig_notifier_register(&i2c_acpi_notifier)); 175691ed5349SWolfram Sang 175791ed5349SWolfram Sang return 0; 175891ed5349SWolfram Sang 175991ed5349SWolfram Sang class_err: 176091ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 176191ed5349SWolfram Sang class_compat_unregister(i2c_adapter_compat_class); 176291ed5349SWolfram Sang bus_err: 176391ed5349SWolfram Sang #endif 176491ed5349SWolfram Sang is_registered = false; 176591ed5349SWolfram Sang bus_unregister(&i2c_bus_type); 176691ed5349SWolfram Sang return retval; 176791ed5349SWolfram Sang } 176891ed5349SWolfram Sang 176991ed5349SWolfram Sang static void __exit i2c_exit(void) 177091ed5349SWolfram Sang { 177191ed5349SWolfram Sang if (IS_ENABLED(CONFIG_ACPI)) 177291ed5349SWolfram Sang WARN_ON(acpi_reconfig_notifier_unregister(&i2c_acpi_notifier)); 177391ed5349SWolfram Sang if (IS_ENABLED(CONFIG_OF_DYNAMIC)) 177491ed5349SWolfram Sang WARN_ON(of_reconfig_notifier_unregister(&i2c_of_notifier)); 177591ed5349SWolfram Sang i2c_del_driver(&dummy_driver); 177691ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 177791ed5349SWolfram Sang class_compat_unregister(i2c_adapter_compat_class); 177891ed5349SWolfram Sang #endif 177991ed5349SWolfram Sang bus_unregister(&i2c_bus_type); 178091ed5349SWolfram Sang tracepoint_synchronize_unregister(); 178191ed5349SWolfram Sang } 178291ed5349SWolfram Sang 178391ed5349SWolfram Sang /* We must initialize early, because some subsystems register i2c drivers 178491ed5349SWolfram Sang * in subsys_initcall() code, but are linked (and initialized) before i2c. 178591ed5349SWolfram Sang */ 178691ed5349SWolfram Sang postcore_initcall(i2c_init); 178791ed5349SWolfram Sang module_exit(i2c_exit); 178891ed5349SWolfram Sang 178991ed5349SWolfram Sang /* ---------------------------------------------------- 179091ed5349SWolfram Sang * the functional interface to the i2c busses. 179191ed5349SWolfram Sang * ---------------------------------------------------- 179291ed5349SWolfram Sang */ 179391ed5349SWolfram Sang 179491ed5349SWolfram Sang /* Check if val is exceeding the quirk IFF quirk is non 0 */ 179591ed5349SWolfram Sang #define i2c_quirk_exceeded(val, quirk) ((quirk) && ((val) > (quirk))) 179691ed5349SWolfram Sang 179791ed5349SWolfram Sang static int i2c_quirk_error(struct i2c_adapter *adap, struct i2c_msg *msg, char *err_msg) 179891ed5349SWolfram Sang { 179991ed5349SWolfram Sang dev_err_ratelimited(&adap->dev, "adapter quirk: %s (addr 0x%04x, size %u, %s)\n", 180091ed5349SWolfram Sang err_msg, msg->addr, msg->len, 180191ed5349SWolfram Sang msg->flags & I2C_M_RD ? "read" : "write"); 180291ed5349SWolfram Sang return -EOPNOTSUPP; 180391ed5349SWolfram Sang } 180491ed5349SWolfram Sang 180591ed5349SWolfram Sang static int i2c_check_for_quirks(struct i2c_adapter *adap, struct i2c_msg *msgs, int num) 180691ed5349SWolfram Sang { 180791ed5349SWolfram Sang const struct i2c_adapter_quirks *q = adap->quirks; 180891ed5349SWolfram Sang int max_num = q->max_num_msgs, i; 180991ed5349SWolfram Sang bool do_len_check = true; 181091ed5349SWolfram Sang 181191ed5349SWolfram Sang if (q->flags & I2C_AQ_COMB) { 181291ed5349SWolfram Sang max_num = 2; 181391ed5349SWolfram Sang 181491ed5349SWolfram Sang /* special checks for combined messages */ 181591ed5349SWolfram Sang if (num == 2) { 181691ed5349SWolfram Sang if (q->flags & I2C_AQ_COMB_WRITE_FIRST && msgs[0].flags & I2C_M_RD) 181791ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[0], "1st comb msg must be write"); 181891ed5349SWolfram Sang 181991ed5349SWolfram Sang if (q->flags & I2C_AQ_COMB_READ_SECOND && !(msgs[1].flags & I2C_M_RD)) 182091ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[1], "2nd comb msg must be read"); 182191ed5349SWolfram Sang 182291ed5349SWolfram Sang if (q->flags & I2C_AQ_COMB_SAME_ADDR && msgs[0].addr != msgs[1].addr) 182391ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[0], "comb msg only to same addr"); 182491ed5349SWolfram Sang 182591ed5349SWolfram Sang if (i2c_quirk_exceeded(msgs[0].len, q->max_comb_1st_msg_len)) 182691ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[0], "msg too long"); 182791ed5349SWolfram Sang 182891ed5349SWolfram Sang if (i2c_quirk_exceeded(msgs[1].len, q->max_comb_2nd_msg_len)) 182991ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[1], "msg too long"); 183091ed5349SWolfram Sang 183191ed5349SWolfram Sang do_len_check = false; 183291ed5349SWolfram Sang } 183391ed5349SWolfram Sang } 183491ed5349SWolfram Sang 183591ed5349SWolfram Sang if (i2c_quirk_exceeded(num, max_num)) 183691ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[0], "too many messages"); 183791ed5349SWolfram Sang 183891ed5349SWolfram Sang for (i = 0; i < num; i++) { 183991ed5349SWolfram Sang u16 len = msgs[i].len; 184091ed5349SWolfram Sang 184191ed5349SWolfram Sang if (msgs[i].flags & I2C_M_RD) { 184291ed5349SWolfram Sang if (do_len_check && i2c_quirk_exceeded(len, q->max_read_len)) 184391ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[i], "msg too long"); 1844d9cfe2ceSWolfram Sang 1845d9cfe2ceSWolfram Sang if (q->flags & I2C_AQ_NO_ZERO_LEN_READ && len == 0) 1846d9cfe2ceSWolfram Sang return i2c_quirk_error(adap, &msgs[i], "no zero length"); 184791ed5349SWolfram Sang } else { 184891ed5349SWolfram Sang if (do_len_check && i2c_quirk_exceeded(len, q->max_write_len)) 184991ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[i], "msg too long"); 1850d9cfe2ceSWolfram Sang 1851d9cfe2ceSWolfram Sang if (q->flags & I2C_AQ_NO_ZERO_LEN_WRITE && len == 0) 1852d9cfe2ceSWolfram Sang return i2c_quirk_error(adap, &msgs[i], "no zero length"); 185391ed5349SWolfram Sang } 185491ed5349SWolfram Sang } 185591ed5349SWolfram Sang 185691ed5349SWolfram Sang return 0; 185791ed5349SWolfram Sang } 185891ed5349SWolfram Sang 185991ed5349SWolfram Sang /** 186091ed5349SWolfram Sang * __i2c_transfer - unlocked flavor of i2c_transfer 186191ed5349SWolfram Sang * @adap: Handle to I2C bus 186291ed5349SWolfram Sang * @msgs: One or more messages to execute before STOP is issued to 186391ed5349SWolfram Sang * terminate the operation; each message begins with a START. 186491ed5349SWolfram Sang * @num: Number of messages to be executed. 186591ed5349SWolfram Sang * 186691ed5349SWolfram Sang * Returns negative errno, else the number of messages executed. 186791ed5349SWolfram Sang * 186891ed5349SWolfram Sang * Adapter lock must be held when calling this function. No debug logging 186991ed5349SWolfram Sang * takes place. adap->algo->master_xfer existence isn't checked. 187091ed5349SWolfram Sang */ 187191ed5349SWolfram Sang int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num) 187291ed5349SWolfram Sang { 187391ed5349SWolfram Sang unsigned long orig_jiffies; 187491ed5349SWolfram Sang int ret, try; 187591ed5349SWolfram Sang 18761eace834SArd Biesheuvel if (WARN_ON(!msgs || num < 1)) 18771eace834SArd Biesheuvel return -EINVAL; 18781eace834SArd Biesheuvel 187991ed5349SWolfram Sang if (adap->quirks && i2c_check_for_quirks(adap, msgs, num)) 188091ed5349SWolfram Sang return -EOPNOTSUPP; 188191ed5349SWolfram Sang 188250888b01SDavidlohr Bueso /* 188350888b01SDavidlohr Bueso * i2c_trace_msg_key gets enabled when tracepoint i2c_transfer gets 188491ed5349SWolfram Sang * enabled. This is an efficient way of keeping the for-loop from 188591ed5349SWolfram Sang * being executed when not needed. 188691ed5349SWolfram Sang */ 188750888b01SDavidlohr Bueso if (static_branch_unlikely(&i2c_trace_msg_key)) { 188891ed5349SWolfram Sang int i; 188991ed5349SWolfram Sang for (i = 0; i < num; i++) 189091ed5349SWolfram Sang if (msgs[i].flags & I2C_M_RD) 189191ed5349SWolfram Sang trace_i2c_read(adap, &msgs[i], i); 189291ed5349SWolfram Sang else 189391ed5349SWolfram Sang trace_i2c_write(adap, &msgs[i], i); 189491ed5349SWolfram Sang } 189591ed5349SWolfram Sang 189691ed5349SWolfram Sang /* Retry automatically on arbitration loss */ 189791ed5349SWolfram Sang orig_jiffies = jiffies; 189891ed5349SWolfram Sang for (ret = 0, try = 0; try <= adap->retries; try++) { 189991ed5349SWolfram Sang ret = adap->algo->master_xfer(adap, msgs, num); 190091ed5349SWolfram Sang if (ret != -EAGAIN) 190191ed5349SWolfram Sang break; 190291ed5349SWolfram Sang if (time_after(jiffies, orig_jiffies + adap->timeout)) 190391ed5349SWolfram Sang break; 190491ed5349SWolfram Sang } 190591ed5349SWolfram Sang 190650888b01SDavidlohr Bueso if (static_branch_unlikely(&i2c_trace_msg_key)) { 190791ed5349SWolfram Sang int i; 190891ed5349SWolfram Sang for (i = 0; i < ret; i++) 190991ed5349SWolfram Sang if (msgs[i].flags & I2C_M_RD) 191091ed5349SWolfram Sang trace_i2c_reply(adap, &msgs[i], i); 19114a3f7691SAhbong Chang trace_i2c_result(adap, num, ret); 191291ed5349SWolfram Sang } 191391ed5349SWolfram Sang 191491ed5349SWolfram Sang return ret; 191591ed5349SWolfram Sang } 191691ed5349SWolfram Sang EXPORT_SYMBOL(__i2c_transfer); 191791ed5349SWolfram Sang 191891ed5349SWolfram Sang /** 191991ed5349SWolfram Sang * i2c_transfer - execute a single or combined I2C message 192091ed5349SWolfram Sang * @adap: Handle to I2C bus 192191ed5349SWolfram Sang * @msgs: One or more messages to execute before STOP is issued to 192291ed5349SWolfram Sang * terminate the operation; each message begins with a START. 192391ed5349SWolfram Sang * @num: Number of messages to be executed. 192491ed5349SWolfram Sang * 192591ed5349SWolfram Sang * Returns negative errno, else the number of messages executed. 192691ed5349SWolfram Sang * 192791ed5349SWolfram Sang * Note that there is no requirement that each message be sent to 192891ed5349SWolfram Sang * the same slave address, although that is the most common model. 192991ed5349SWolfram Sang */ 193091ed5349SWolfram Sang int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num) 193191ed5349SWolfram Sang { 193291ed5349SWolfram Sang int ret; 193391ed5349SWolfram Sang 193491ed5349SWolfram Sang /* REVISIT the fault reporting model here is weak: 193591ed5349SWolfram Sang * 193691ed5349SWolfram Sang * - When we get an error after receiving N bytes from a slave, 193791ed5349SWolfram Sang * there is no way to report "N". 193891ed5349SWolfram Sang * 193991ed5349SWolfram Sang * - When we get a NAK after transmitting N bytes to a slave, 194091ed5349SWolfram Sang * there is no way to report "N" ... or to let the master 194191ed5349SWolfram Sang * continue executing the rest of this combined message, if 194291ed5349SWolfram Sang * that's the appropriate response. 194391ed5349SWolfram Sang * 194491ed5349SWolfram Sang * - When for example "num" is two and we successfully complete 194591ed5349SWolfram Sang * the first message but get an error part way through the 194691ed5349SWolfram Sang * second, it's unclear whether that should be reported as 194791ed5349SWolfram Sang * one (discarding status on the second message) or errno 194891ed5349SWolfram Sang * (discarding status on the first one). 194991ed5349SWolfram Sang */ 195091ed5349SWolfram Sang 195191ed5349SWolfram Sang if (adap->algo->master_xfer) { 195291ed5349SWolfram Sang #ifdef DEBUG 195391ed5349SWolfram Sang for (ret = 0; ret < num; ret++) { 195491ed5349SWolfram Sang dev_dbg(&adap->dev, 195591ed5349SWolfram Sang "master_xfer[%d] %c, addr=0x%02x, len=%d%s\n", 195691ed5349SWolfram Sang ret, (msgs[ret].flags & I2C_M_RD) ? 'R' : 'W', 195791ed5349SWolfram Sang msgs[ret].addr, msgs[ret].len, 195891ed5349SWolfram Sang (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : ""); 195991ed5349SWolfram Sang } 196091ed5349SWolfram Sang #endif 196191ed5349SWolfram Sang 196291ed5349SWolfram Sang if (in_atomic() || irqs_disabled()) { 196391ed5349SWolfram Sang ret = i2c_trylock_bus(adap, I2C_LOCK_SEGMENT); 196491ed5349SWolfram Sang if (!ret) 196591ed5349SWolfram Sang /* I2C activity is ongoing. */ 196691ed5349SWolfram Sang return -EAGAIN; 196791ed5349SWolfram Sang } else { 196891ed5349SWolfram Sang i2c_lock_bus(adap, I2C_LOCK_SEGMENT); 196991ed5349SWolfram Sang } 197091ed5349SWolfram Sang 197191ed5349SWolfram Sang ret = __i2c_transfer(adap, msgs, num); 197291ed5349SWolfram Sang i2c_unlock_bus(adap, I2C_LOCK_SEGMENT); 197391ed5349SWolfram Sang 197491ed5349SWolfram Sang return ret; 197591ed5349SWolfram Sang } else { 197691ed5349SWolfram Sang dev_dbg(&adap->dev, "I2C level transfers not supported\n"); 197791ed5349SWolfram Sang return -EOPNOTSUPP; 197891ed5349SWolfram Sang } 197991ed5349SWolfram Sang } 198091ed5349SWolfram Sang EXPORT_SYMBOL(i2c_transfer); 198191ed5349SWolfram Sang 198291ed5349SWolfram Sang /** 19838a91732bSWolfram Sang * i2c_transfer_buffer_flags - issue a single I2C message transferring data 19848a91732bSWolfram Sang * to/from a buffer 198591ed5349SWolfram Sang * @client: Handle to slave device 19868a91732bSWolfram Sang * @buf: Where the data is stored 19878a91732bSWolfram Sang * @count: How many bytes to transfer, must be less than 64k since msg.len is u16 19888a91732bSWolfram Sang * @flags: The flags to be used for the message, e.g. I2C_M_RD for reads 198991ed5349SWolfram Sang * 19908a91732bSWolfram Sang * Returns negative errno, or else the number of bytes transferred. 199191ed5349SWolfram Sang */ 19928a91732bSWolfram Sang int i2c_transfer_buffer_flags(const struct i2c_client *client, char *buf, 19938a91732bSWolfram Sang int count, u16 flags) 199491ed5349SWolfram Sang { 199591ed5349SWolfram Sang int ret; 19968a91732bSWolfram Sang struct i2c_msg msg = { 19978a91732bSWolfram Sang .addr = client->addr, 19988a91732bSWolfram Sang .flags = flags | (client->flags & I2C_M_TEN), 19998a91732bSWolfram Sang .len = count, 20008a91732bSWolfram Sang .buf = buf, 20018a91732bSWolfram Sang }; 200291ed5349SWolfram Sang 20038a91732bSWolfram Sang ret = i2c_transfer(client->adapter, &msg, 1); 200491ed5349SWolfram Sang 200591ed5349SWolfram Sang /* 20068a91732bSWolfram Sang * If everything went ok (i.e. 1 msg transferred), return #bytes 20078a91732bSWolfram Sang * transferred, else error code. 200891ed5349SWolfram Sang */ 200991ed5349SWolfram Sang return (ret == 1) ? count : ret; 201091ed5349SWolfram Sang } 20118a91732bSWolfram Sang EXPORT_SYMBOL(i2c_transfer_buffer_flags); 201291ed5349SWolfram Sang 2013dde67eb1SPeter Rosin /** 2014dde67eb1SPeter Rosin * i2c_get_device_id - get manufacturer, part id and die revision of a device 2015dde67eb1SPeter Rosin * @client: The device to query 2016dde67eb1SPeter Rosin * @id: The queried information 2017dde67eb1SPeter Rosin * 2018dde67eb1SPeter Rosin * Returns negative errno on error, zero on success. 2019dde67eb1SPeter Rosin */ 2020dde67eb1SPeter Rosin int i2c_get_device_id(const struct i2c_client *client, 2021dde67eb1SPeter Rosin struct i2c_device_identity *id) 2022dde67eb1SPeter Rosin { 2023dde67eb1SPeter Rosin struct i2c_adapter *adap = client->adapter; 2024dde67eb1SPeter Rosin union i2c_smbus_data raw_id; 2025dde67eb1SPeter Rosin int ret; 2026dde67eb1SPeter Rosin 2027dde67eb1SPeter Rosin if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_I2C_BLOCK)) 2028dde67eb1SPeter Rosin return -EOPNOTSUPP; 2029dde67eb1SPeter Rosin 2030dde67eb1SPeter Rosin raw_id.block[0] = 3; 2031dde67eb1SPeter Rosin ret = i2c_smbus_xfer(adap, I2C_ADDR_DEVICE_ID, 0, 2032dde67eb1SPeter Rosin I2C_SMBUS_READ, client->addr << 1, 2033dde67eb1SPeter Rosin I2C_SMBUS_I2C_BLOCK_DATA, &raw_id); 2034dde67eb1SPeter Rosin if (ret) 2035dde67eb1SPeter Rosin return ret; 2036dde67eb1SPeter Rosin 2037dde67eb1SPeter Rosin id->manufacturer_id = (raw_id.block[1] << 4) | (raw_id.block[2] >> 4); 2038dde67eb1SPeter Rosin id->part_id = ((raw_id.block[2] & 0xf) << 5) | (raw_id.block[3] >> 3); 2039dde67eb1SPeter Rosin id->die_revision = raw_id.block[3] & 0x7; 2040dde67eb1SPeter Rosin return 0; 2041dde67eb1SPeter Rosin } 2042dde67eb1SPeter Rosin EXPORT_SYMBOL_GPL(i2c_get_device_id); 2043dde67eb1SPeter Rosin 204491ed5349SWolfram Sang /* ---------------------------------------------------- 204591ed5349SWolfram Sang * the i2c address scanning function 204691ed5349SWolfram Sang * Will not work for 10-bit addresses! 204791ed5349SWolfram Sang * ---------------------------------------------------- 204891ed5349SWolfram Sang */ 204991ed5349SWolfram Sang 205091ed5349SWolfram Sang /* 205191ed5349SWolfram Sang * Legacy default probe function, mostly relevant for SMBus. The default 205291ed5349SWolfram Sang * probe method is a quick write, but it is known to corrupt the 24RF08 205391ed5349SWolfram Sang * EEPROMs due to a state machine bug, and could also irreversibly 205491ed5349SWolfram Sang * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f, 205591ed5349SWolfram Sang * we use a short byte read instead. Also, some bus drivers don't implement 205691ed5349SWolfram Sang * quick write, so we fallback to a byte read in that case too. 205791ed5349SWolfram Sang * On x86, there is another special case for FSC hardware monitoring chips, 205891ed5349SWolfram Sang * which want regular byte reads (address 0x73.) Fortunately, these are the 205991ed5349SWolfram Sang * only known chips using this I2C address on PC hardware. 206091ed5349SWolfram Sang * Returns 1 if probe succeeded, 0 if not. 206191ed5349SWolfram Sang */ 206291ed5349SWolfram Sang static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr) 206391ed5349SWolfram Sang { 206491ed5349SWolfram Sang int err; 206591ed5349SWolfram Sang union i2c_smbus_data dummy; 206691ed5349SWolfram Sang 206791ed5349SWolfram Sang #ifdef CONFIG_X86 206891ed5349SWolfram Sang if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON) 206991ed5349SWolfram Sang && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA)) 207091ed5349SWolfram Sang err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0, 207191ed5349SWolfram Sang I2C_SMBUS_BYTE_DATA, &dummy); 207291ed5349SWolfram Sang else 207391ed5349SWolfram Sang #endif 207491ed5349SWolfram Sang if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50) 207591ed5349SWolfram Sang && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) 207691ed5349SWolfram Sang err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0, 207791ed5349SWolfram Sang I2C_SMBUS_QUICK, NULL); 207891ed5349SWolfram Sang else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) 207991ed5349SWolfram Sang err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0, 208091ed5349SWolfram Sang I2C_SMBUS_BYTE, &dummy); 208191ed5349SWolfram Sang else { 208291ed5349SWolfram Sang dev_warn(&adap->dev, "No suitable probing method supported for address 0x%02X\n", 208391ed5349SWolfram Sang addr); 208491ed5349SWolfram Sang err = -EOPNOTSUPP; 208591ed5349SWolfram Sang } 208691ed5349SWolfram Sang 208791ed5349SWolfram Sang return err >= 0; 208891ed5349SWolfram Sang } 208991ed5349SWolfram Sang 209091ed5349SWolfram Sang static int i2c_detect_address(struct i2c_client *temp_client, 209191ed5349SWolfram Sang struct i2c_driver *driver) 209291ed5349SWolfram Sang { 209391ed5349SWolfram Sang struct i2c_board_info info; 209491ed5349SWolfram Sang struct i2c_adapter *adapter = temp_client->adapter; 209591ed5349SWolfram Sang int addr = temp_client->addr; 209691ed5349SWolfram Sang int err; 209791ed5349SWolfram Sang 209891ed5349SWolfram Sang /* Make sure the address is valid */ 209991ed5349SWolfram Sang err = i2c_check_7bit_addr_validity_strict(addr); 210091ed5349SWolfram Sang if (err) { 210191ed5349SWolfram Sang dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n", 210291ed5349SWolfram Sang addr); 210391ed5349SWolfram Sang return err; 210491ed5349SWolfram Sang } 210591ed5349SWolfram Sang 210691ed5349SWolfram Sang /* Skip if already in use (7 bit, no need to encode flags) */ 210791ed5349SWolfram Sang if (i2c_check_addr_busy(adapter, addr)) 210891ed5349SWolfram Sang return 0; 210991ed5349SWolfram Sang 211091ed5349SWolfram Sang /* Make sure there is something at this address */ 211191ed5349SWolfram Sang if (!i2c_default_probe(adapter, addr)) 211291ed5349SWolfram Sang return 0; 211391ed5349SWolfram Sang 211491ed5349SWolfram Sang /* Finally call the custom detection function */ 211591ed5349SWolfram Sang memset(&info, 0, sizeof(struct i2c_board_info)); 211691ed5349SWolfram Sang info.addr = addr; 211791ed5349SWolfram Sang err = driver->detect(temp_client, &info); 211891ed5349SWolfram Sang if (err) { 211991ed5349SWolfram Sang /* -ENODEV is returned if the detection fails. We catch it 212091ed5349SWolfram Sang here as this isn't an error. */ 212191ed5349SWolfram Sang return err == -ENODEV ? 0 : err; 212291ed5349SWolfram Sang } 212391ed5349SWolfram Sang 212491ed5349SWolfram Sang /* Consistency check */ 212591ed5349SWolfram Sang if (info.type[0] == '\0') { 212691ed5349SWolfram Sang dev_err(&adapter->dev, 212791ed5349SWolfram Sang "%s detection function provided no name for 0x%x\n", 212891ed5349SWolfram Sang driver->driver.name, addr); 212991ed5349SWolfram Sang } else { 213091ed5349SWolfram Sang struct i2c_client *client; 213191ed5349SWolfram Sang 213291ed5349SWolfram Sang /* Detection succeeded, instantiate the device */ 213391ed5349SWolfram Sang if (adapter->class & I2C_CLASS_DEPRECATED) 213491ed5349SWolfram Sang dev_warn(&adapter->dev, 213591ed5349SWolfram Sang "This adapter will soon drop class based instantiation of devices. " 213691ed5349SWolfram Sang "Please make sure client 0x%02x gets instantiated by other means. " 213791ed5349SWolfram Sang "Check 'Documentation/i2c/instantiating-devices' for details.\n", 213891ed5349SWolfram Sang info.addr); 213991ed5349SWolfram Sang 214091ed5349SWolfram Sang dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n", 214191ed5349SWolfram Sang info.type, info.addr); 214291ed5349SWolfram Sang client = i2c_new_device(adapter, &info); 214391ed5349SWolfram Sang if (client) 214491ed5349SWolfram Sang list_add_tail(&client->detected, &driver->clients); 214591ed5349SWolfram Sang else 214691ed5349SWolfram Sang dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n", 214791ed5349SWolfram Sang info.type, info.addr); 214891ed5349SWolfram Sang } 214991ed5349SWolfram Sang return 0; 215091ed5349SWolfram Sang } 215191ed5349SWolfram Sang 215291ed5349SWolfram Sang static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver) 215391ed5349SWolfram Sang { 215491ed5349SWolfram Sang const unsigned short *address_list; 215591ed5349SWolfram Sang struct i2c_client *temp_client; 215691ed5349SWolfram Sang int i, err = 0; 215791ed5349SWolfram Sang int adap_id = i2c_adapter_id(adapter); 215891ed5349SWolfram Sang 215991ed5349SWolfram Sang address_list = driver->address_list; 216091ed5349SWolfram Sang if (!driver->detect || !address_list) 216191ed5349SWolfram Sang return 0; 216291ed5349SWolfram Sang 216391ed5349SWolfram Sang /* Warn that the adapter lost class based instantiation */ 216491ed5349SWolfram Sang if (adapter->class == I2C_CLASS_DEPRECATED) { 216591ed5349SWolfram Sang dev_dbg(&adapter->dev, 216691ed5349SWolfram Sang "This adapter dropped support for I2C classes and won't auto-detect %s devices anymore. " 216791ed5349SWolfram Sang "If you need it, check 'Documentation/i2c/instantiating-devices' for alternatives.\n", 216891ed5349SWolfram Sang driver->driver.name); 216991ed5349SWolfram Sang return 0; 217091ed5349SWolfram Sang } 217191ed5349SWolfram Sang 217291ed5349SWolfram Sang /* Stop here if the classes do not match */ 217391ed5349SWolfram Sang if (!(adapter->class & driver->class)) 217491ed5349SWolfram Sang return 0; 217591ed5349SWolfram Sang 217691ed5349SWolfram Sang /* Set up a temporary client to help detect callback */ 217791ed5349SWolfram Sang temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL); 217891ed5349SWolfram Sang if (!temp_client) 217991ed5349SWolfram Sang return -ENOMEM; 218091ed5349SWolfram Sang temp_client->adapter = adapter; 218191ed5349SWolfram Sang 218291ed5349SWolfram Sang for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) { 218391ed5349SWolfram Sang dev_dbg(&adapter->dev, 218491ed5349SWolfram Sang "found normal entry for adapter %d, addr 0x%02x\n", 218591ed5349SWolfram Sang adap_id, address_list[i]); 218691ed5349SWolfram Sang temp_client->addr = address_list[i]; 218791ed5349SWolfram Sang err = i2c_detect_address(temp_client, driver); 218891ed5349SWolfram Sang if (unlikely(err)) 218991ed5349SWolfram Sang break; 219091ed5349SWolfram Sang } 219191ed5349SWolfram Sang 219291ed5349SWolfram Sang kfree(temp_client); 219391ed5349SWolfram Sang return err; 219491ed5349SWolfram Sang } 219591ed5349SWolfram Sang 219691ed5349SWolfram Sang int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr) 219791ed5349SWolfram Sang { 219891ed5349SWolfram Sang return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0, 219991ed5349SWolfram Sang I2C_SMBUS_QUICK, NULL) >= 0; 220091ed5349SWolfram Sang } 220191ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read); 220291ed5349SWolfram Sang 220391ed5349SWolfram Sang struct i2c_client * 220491ed5349SWolfram Sang i2c_new_probed_device(struct i2c_adapter *adap, 220591ed5349SWolfram Sang struct i2c_board_info *info, 220691ed5349SWolfram Sang unsigned short const *addr_list, 220791ed5349SWolfram Sang int (*probe)(struct i2c_adapter *, unsigned short addr)) 220891ed5349SWolfram Sang { 220991ed5349SWolfram Sang int i; 221091ed5349SWolfram Sang 221191ed5349SWolfram Sang if (!probe) 221291ed5349SWolfram Sang probe = i2c_default_probe; 221391ed5349SWolfram Sang 221491ed5349SWolfram Sang for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) { 221591ed5349SWolfram Sang /* Check address validity */ 221691ed5349SWolfram Sang if (i2c_check_7bit_addr_validity_strict(addr_list[i]) < 0) { 221791ed5349SWolfram Sang dev_warn(&adap->dev, "Invalid 7-bit address 0x%02x\n", 221891ed5349SWolfram Sang addr_list[i]); 221991ed5349SWolfram Sang continue; 222091ed5349SWolfram Sang } 222191ed5349SWolfram Sang 222291ed5349SWolfram Sang /* Check address availability (7 bit, no need to encode flags) */ 222391ed5349SWolfram Sang if (i2c_check_addr_busy(adap, addr_list[i])) { 222491ed5349SWolfram Sang dev_dbg(&adap->dev, 222591ed5349SWolfram Sang "Address 0x%02x already in use, not probing\n", 222691ed5349SWolfram Sang addr_list[i]); 222791ed5349SWolfram Sang continue; 222891ed5349SWolfram Sang } 222991ed5349SWolfram Sang 223091ed5349SWolfram Sang /* Test address responsiveness */ 223191ed5349SWolfram Sang if (probe(adap, addr_list[i])) 223291ed5349SWolfram Sang break; 223391ed5349SWolfram Sang } 223491ed5349SWolfram Sang 223591ed5349SWolfram Sang if (addr_list[i] == I2C_CLIENT_END) { 223691ed5349SWolfram Sang dev_dbg(&adap->dev, "Probing failed, no device found\n"); 223791ed5349SWolfram Sang return NULL; 223891ed5349SWolfram Sang } 223991ed5349SWolfram Sang 224091ed5349SWolfram Sang info->addr = addr_list[i]; 224191ed5349SWolfram Sang return i2c_new_device(adap, info); 224291ed5349SWolfram Sang } 224391ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_new_probed_device); 224491ed5349SWolfram Sang 224591ed5349SWolfram Sang struct i2c_adapter *i2c_get_adapter(int nr) 224691ed5349SWolfram Sang { 224791ed5349SWolfram Sang struct i2c_adapter *adapter; 224891ed5349SWolfram Sang 224991ed5349SWolfram Sang mutex_lock(&core_lock); 225091ed5349SWolfram Sang adapter = idr_find(&i2c_adapter_idr, nr); 225191ed5349SWolfram Sang if (!adapter) 225291ed5349SWolfram Sang goto exit; 225391ed5349SWolfram Sang 225491ed5349SWolfram Sang if (try_module_get(adapter->owner)) 225591ed5349SWolfram Sang get_device(&adapter->dev); 225691ed5349SWolfram Sang else 225791ed5349SWolfram Sang adapter = NULL; 225891ed5349SWolfram Sang 225991ed5349SWolfram Sang exit: 226091ed5349SWolfram Sang mutex_unlock(&core_lock); 226191ed5349SWolfram Sang return adapter; 226291ed5349SWolfram Sang } 226391ed5349SWolfram Sang EXPORT_SYMBOL(i2c_get_adapter); 226491ed5349SWolfram Sang 226591ed5349SWolfram Sang void i2c_put_adapter(struct i2c_adapter *adap) 226691ed5349SWolfram Sang { 226791ed5349SWolfram Sang if (!adap) 226891ed5349SWolfram Sang return; 226991ed5349SWolfram Sang 227091ed5349SWolfram Sang put_device(&adap->dev); 227191ed5349SWolfram Sang module_put(adap->owner); 227291ed5349SWolfram Sang } 227391ed5349SWolfram Sang EXPORT_SYMBOL(i2c_put_adapter); 227491ed5349SWolfram Sang 2275e94bc5d1SWolfram Sang /** 2276e94bc5d1SWolfram Sang * i2c_get_dma_safe_msg_buf() - get a DMA safe buffer for the given i2c_msg 2277e94bc5d1SWolfram Sang * @msg: the message to be checked 2278e94bc5d1SWolfram Sang * @threshold: the minimum number of bytes for which using DMA makes sense 2279e94bc5d1SWolfram Sang * 2280e94bc5d1SWolfram Sang * Return: NULL if a DMA safe buffer was not obtained. Use msg->buf with PIO. 2281e94bc5d1SWolfram Sang * Or a valid pointer to be used with DMA. After use, release it by 2282e94bc5d1SWolfram Sang * calling i2c_release_dma_safe_msg_buf(). 2283e94bc5d1SWolfram Sang * 2284e94bc5d1SWolfram Sang * This function must only be called from process context! 2285e94bc5d1SWolfram Sang */ 2286e94bc5d1SWolfram Sang u8 *i2c_get_dma_safe_msg_buf(struct i2c_msg *msg, unsigned int threshold) 2287e94bc5d1SWolfram Sang { 2288e94bc5d1SWolfram Sang if (msg->len < threshold) 2289e94bc5d1SWolfram Sang return NULL; 2290e94bc5d1SWolfram Sang 2291e94bc5d1SWolfram Sang if (msg->flags & I2C_M_DMA_SAFE) 2292e94bc5d1SWolfram Sang return msg->buf; 2293e94bc5d1SWolfram Sang 2294e94bc5d1SWolfram Sang pr_debug("using bounce buffer for addr=0x%02x, len=%d\n", 2295e94bc5d1SWolfram Sang msg->addr, msg->len); 2296e94bc5d1SWolfram Sang 2297e94bc5d1SWolfram Sang if (msg->flags & I2C_M_RD) 2298e94bc5d1SWolfram Sang return kzalloc(msg->len, GFP_KERNEL); 2299e94bc5d1SWolfram Sang else 2300e94bc5d1SWolfram Sang return kmemdup(msg->buf, msg->len, GFP_KERNEL); 2301e94bc5d1SWolfram Sang } 2302e94bc5d1SWolfram Sang EXPORT_SYMBOL_GPL(i2c_get_dma_safe_msg_buf); 2303e94bc5d1SWolfram Sang 2304e94bc5d1SWolfram Sang /** 2305e94bc5d1SWolfram Sang * i2c_release_dma_safe_msg_buf - release DMA safe buffer and sync with i2c_msg 2306e94bc5d1SWolfram Sang * @msg: the message to be synced with 2307e94bc5d1SWolfram Sang * @buf: the buffer obtained from i2c_get_dma_safe_msg_buf(). May be NULL. 2308e94bc5d1SWolfram Sang */ 2309e94bc5d1SWolfram Sang void i2c_release_dma_safe_msg_buf(struct i2c_msg *msg, u8 *buf) 2310e94bc5d1SWolfram Sang { 2311e94bc5d1SWolfram Sang if (!buf || buf == msg->buf) 2312e94bc5d1SWolfram Sang return; 2313e94bc5d1SWolfram Sang 2314e94bc5d1SWolfram Sang if (msg->flags & I2C_M_RD) 2315e94bc5d1SWolfram Sang memcpy(msg->buf, buf, msg->len); 2316e94bc5d1SWolfram Sang 2317e94bc5d1SWolfram Sang kfree(buf); 2318e94bc5d1SWolfram Sang } 2319e94bc5d1SWolfram Sang EXPORT_SYMBOL_GPL(i2c_release_dma_safe_msg_buf); 2320e94bc5d1SWolfram Sang 232191ed5349SWolfram Sang MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>"); 232291ed5349SWolfram Sang MODULE_DESCRIPTION("I2C-Bus main module"); 232391ed5349SWolfram Sang MODULE_LICENSE("GPL"); 2324