1c942fddfSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later 261e3d0f7SWolfram Sang /* 361e3d0f7SWolfram Sang * Linux I2C core 461e3d0f7SWolfram Sang * 561e3d0f7SWolfram Sang * Copyright (C) 1995-99 Simon G. Vogl 661e3d0f7SWolfram Sang * With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> 761e3d0f7SWolfram Sang * Mux support by Rodolfo Giometti <giometti@enneenne.com> and 861e3d0f7SWolfram Sang * Michael Lawnick <michael.lawnick.ext@nsn.com> 961e3d0f7SWolfram Sang * 102f5a55c5SWolfram Sang * Copyright (C) 2013-2017 Wolfram Sang <wsa@kernel.org> 1191ed5349SWolfram Sang */ 1291ed5349SWolfram Sang 1391ed5349SWolfram Sang #define pr_fmt(fmt) "i2c-core: " fmt 1491ed5349SWolfram Sang 1591ed5349SWolfram Sang #include <dt-bindings/i2c/i2c.h> 1691ed5349SWolfram Sang #include <linux/acpi.h> 1791ed5349SWolfram Sang #include <linux/clk/clk-conf.h> 1891ed5349SWolfram Sang #include <linux/completion.h> 1991ed5349SWolfram Sang #include <linux/delay.h> 2091ed5349SWolfram Sang #include <linux/err.h> 2191ed5349SWolfram Sang #include <linux/errno.h> 2210c9ef04SPhil Reid #include <linux/gpio/consumer.h> 2391ed5349SWolfram Sang #include <linux/i2c.h> 24f8756c67SPhil Reid #include <linux/i2c-smbus.h> 2591ed5349SWolfram Sang #include <linux/idr.h> 2691ed5349SWolfram Sang #include <linux/init.h> 27b64210f2SDmitry Torokhov #include <linux/interrupt.h> 2891ed5349SWolfram Sang #include <linux/irqflags.h> 2991ed5349SWolfram Sang #include <linux/jump_label.h> 3091ed5349SWolfram Sang #include <linux/kernel.h> 3191ed5349SWolfram Sang #include <linux/module.h> 3291ed5349SWolfram Sang #include <linux/mutex.h> 3391ed5349SWolfram Sang #include <linux/of_device.h> 3491ed5349SWolfram Sang #include <linux/of.h> 3591ed5349SWolfram Sang #include <linux/of_irq.h> 3675820314SCodrin Ciubotariu #include <linux/pinctrl/consumer.h> 3791ed5349SWolfram Sang #include <linux/pm_domain.h> 3891ed5349SWolfram Sang #include <linux/pm_runtime.h> 3991ed5349SWolfram Sang #include <linux/pm_wakeirq.h> 4091ed5349SWolfram Sang #include <linux/property.h> 4191ed5349SWolfram Sang #include <linux/rwsem.h> 4291ed5349SWolfram Sang #include <linux/slab.h> 4391ed5349SWolfram Sang 4491ed5349SWolfram Sang #include "i2c-core.h" 4591ed5349SWolfram Sang 4691ed5349SWolfram Sang #define CREATE_TRACE_POINTS 4791ed5349SWolfram Sang #include <trace/events/i2c.h> 4891ed5349SWolfram Sang 4991ed5349SWolfram Sang #define I2C_ADDR_OFFSET_TEN_BIT 0xa000 5091ed5349SWolfram Sang #define I2C_ADDR_OFFSET_SLAVE 0x1000 5191ed5349SWolfram Sang 5291ed5349SWolfram Sang #define I2C_ADDR_7BITS_MAX 0x77 5391ed5349SWolfram Sang #define I2C_ADDR_7BITS_COUNT (I2C_ADDR_7BITS_MAX + 1) 5491ed5349SWolfram Sang 55dde67eb1SPeter Rosin #define I2C_ADDR_DEVICE_ID 0x7c 56dde67eb1SPeter Rosin 5761e3d0f7SWolfram Sang /* 5861e3d0f7SWolfram Sang * core_lock protects i2c_adapter_idr, and guarantees that device detection, 590c36dd37SWolfram Sang * deletion of detected devices are serialized 6061e3d0f7SWolfram Sang */ 6191ed5349SWolfram Sang static DEFINE_MUTEX(core_lock); 6291ed5349SWolfram Sang static DEFINE_IDR(i2c_adapter_idr); 6391ed5349SWolfram Sang 6491ed5349SWolfram Sang static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver); 6591ed5349SWolfram Sang 6650888b01SDavidlohr Bueso static DEFINE_STATIC_KEY_FALSE(i2c_trace_msg_key); 6791ed5349SWolfram Sang static bool is_registered; 6891ed5349SWolfram Sang 6991ed5349SWolfram Sang int i2c_transfer_trace_reg(void) 7091ed5349SWolfram Sang { 7150888b01SDavidlohr Bueso static_branch_inc(&i2c_trace_msg_key); 7291ed5349SWolfram Sang return 0; 7391ed5349SWolfram Sang } 7491ed5349SWolfram Sang 7591ed5349SWolfram Sang void i2c_transfer_trace_unreg(void) 7691ed5349SWolfram Sang { 7750888b01SDavidlohr Bueso static_branch_dec(&i2c_trace_msg_key); 7891ed5349SWolfram Sang } 7991ed5349SWolfram Sang 803b4c747cSYicong Yang const char *i2c_freq_mode_string(u32 bus_freq_hz) 813b4c747cSYicong Yang { 823b4c747cSYicong Yang switch (bus_freq_hz) { 833b4c747cSYicong Yang case I2C_MAX_STANDARD_MODE_FREQ: 843b4c747cSYicong Yang return "Standard Mode (100 kHz)"; 853b4c747cSYicong Yang case I2C_MAX_FAST_MODE_FREQ: 863b4c747cSYicong Yang return "Fast Mode (400 kHz)"; 873b4c747cSYicong Yang case I2C_MAX_FAST_MODE_PLUS_FREQ: 883b4c747cSYicong Yang return "Fast Mode Plus (1.0 MHz)"; 893b4c747cSYicong Yang case I2C_MAX_TURBO_MODE_FREQ: 903b4c747cSYicong Yang return "Turbo Mode (1.4 MHz)"; 913b4c747cSYicong Yang case I2C_MAX_HIGH_SPEED_MODE_FREQ: 923b4c747cSYicong Yang return "High Speed Mode (3.4 MHz)"; 933b4c747cSYicong Yang case I2C_MAX_ULTRA_FAST_MODE_FREQ: 943b4c747cSYicong Yang return "Ultra Fast Mode (5.0 MHz)"; 953b4c747cSYicong Yang default: 963b4c747cSYicong Yang return "Unknown Mode"; 973b4c747cSYicong Yang } 983b4c747cSYicong Yang } 993b4c747cSYicong Yang EXPORT_SYMBOL_GPL(i2c_freq_mode_string); 1003b4c747cSYicong Yang 10191ed5349SWolfram Sang const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id, 10291ed5349SWolfram Sang const struct i2c_client *client) 10391ed5349SWolfram Sang { 10491ed5349SWolfram Sang if (!(id && client)) 10591ed5349SWolfram Sang return NULL; 10691ed5349SWolfram Sang 10791ed5349SWolfram Sang while (id->name[0]) { 10891ed5349SWolfram Sang if (strcmp(client->name, id->name) == 0) 10991ed5349SWolfram Sang return id; 11091ed5349SWolfram Sang id++; 11191ed5349SWolfram Sang } 11291ed5349SWolfram Sang return NULL; 11391ed5349SWolfram Sang } 11491ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_match_id); 11591ed5349SWolfram Sang 11691ed5349SWolfram Sang static int i2c_device_match(struct device *dev, struct device_driver *drv) 11791ed5349SWolfram Sang { 11891ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 11991ed5349SWolfram Sang struct i2c_driver *driver; 12091ed5349SWolfram Sang 12191ed5349SWolfram Sang 12291ed5349SWolfram Sang /* Attempt an OF style match */ 12391ed5349SWolfram Sang if (i2c_of_match_device(drv->of_match_table, client)) 12491ed5349SWolfram Sang return 1; 12591ed5349SWolfram Sang 12691ed5349SWolfram Sang /* Then ACPI style match */ 12791ed5349SWolfram Sang if (acpi_driver_match_device(dev, drv)) 12891ed5349SWolfram Sang return 1; 12991ed5349SWolfram Sang 13091ed5349SWolfram Sang driver = to_i2c_driver(drv); 13191ed5349SWolfram Sang 13291ed5349SWolfram Sang /* Finally an I2C match */ 13391ed5349SWolfram Sang if (i2c_match_id(driver->id_table, client)) 13491ed5349SWolfram Sang return 1; 13591ed5349SWolfram Sang 13691ed5349SWolfram Sang return 0; 13791ed5349SWolfram Sang } 13891ed5349SWolfram Sang 13991ed5349SWolfram Sang static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env) 14091ed5349SWolfram Sang { 14191ed5349SWolfram Sang struct i2c_client *client = to_i2c_client(dev); 14291ed5349SWolfram Sang int rc; 14391ed5349SWolfram Sang 144af503716SJavier Martinez Canillas rc = of_device_uevent_modalias(dev, env); 145af503716SJavier Martinez Canillas if (rc != -ENODEV) 146af503716SJavier Martinez Canillas return rc; 147af503716SJavier Martinez Canillas 14891ed5349SWolfram Sang rc = acpi_device_uevent_modalias(dev, env); 14991ed5349SWolfram Sang if (rc != -ENODEV) 15091ed5349SWolfram Sang return rc; 15191ed5349SWolfram Sang 15291ed5349SWolfram Sang return add_uevent_var(env, "MODALIAS=%s%s", I2C_MODULE_PREFIX, client->name); 15391ed5349SWolfram Sang } 15491ed5349SWolfram Sang 15591ed5349SWolfram Sang /* i2c bus recovery routines */ 15691ed5349SWolfram Sang static int get_scl_gpio_value(struct i2c_adapter *adap) 15791ed5349SWolfram Sang { 1583991c5c8SPhil Reid return gpiod_get_value_cansleep(adap->bus_recovery_info->scl_gpiod); 15991ed5349SWolfram Sang } 16091ed5349SWolfram Sang 16191ed5349SWolfram Sang static void set_scl_gpio_value(struct i2c_adapter *adap, int val) 16291ed5349SWolfram Sang { 1633991c5c8SPhil Reid gpiod_set_value_cansleep(adap->bus_recovery_info->scl_gpiod, val); 16491ed5349SWolfram Sang } 16591ed5349SWolfram Sang 16691ed5349SWolfram Sang static int get_sda_gpio_value(struct i2c_adapter *adap) 16791ed5349SWolfram Sang { 1683991c5c8SPhil Reid return gpiod_get_value_cansleep(adap->bus_recovery_info->sda_gpiod); 16991ed5349SWolfram Sang } 17091ed5349SWolfram Sang 1718092178fSWolfram Sang static void set_sda_gpio_value(struct i2c_adapter *adap, int val) 17291ed5349SWolfram Sang { 1738092178fSWolfram Sang gpiod_set_value_cansleep(adap->bus_recovery_info->sda_gpiod, val); 17491ed5349SWolfram Sang } 17591ed5349SWolfram Sang 1767ca5f6beSWolfram Sang static int i2c_generic_bus_free(struct i2c_adapter *adap) 1777ca5f6beSWolfram Sang { 1787ca5f6beSWolfram Sang struct i2c_bus_recovery_info *bri = adap->bus_recovery_info; 1797ca5f6beSWolfram Sang int ret = -EOPNOTSUPP; 1807ca5f6beSWolfram Sang 1817ca5f6beSWolfram Sang if (bri->get_bus_free) 1827ca5f6beSWolfram Sang ret = bri->get_bus_free(adap); 1837ca5f6beSWolfram Sang else if (bri->get_sda) 1847ca5f6beSWolfram Sang ret = bri->get_sda(adap); 1857ca5f6beSWolfram Sang 1867ca5f6beSWolfram Sang if (ret < 0) 1877ca5f6beSWolfram Sang return ret; 1887ca5f6beSWolfram Sang 1897ca5f6beSWolfram Sang return ret ? 0 : -EBUSY; 1907ca5f6beSWolfram Sang } 1917ca5f6beSWolfram Sang 19291ed5349SWolfram Sang /* 19391ed5349SWolfram Sang * We are generating clock pulses. ndelay() determines durating of clk pulses. 19491ed5349SWolfram Sang * We will generate clock with rate 100 KHz and so duration of both clock levels 19591ed5349SWolfram Sang * is: delay in ns = (10^6 / 100) / 2 19691ed5349SWolfram Sang */ 19791ed5349SWolfram Sang #define RECOVERY_NDELAY 5000 19891ed5349SWolfram Sang #define RECOVERY_CLK_CNT 9 19991ed5349SWolfram Sang 200e1eb7d28SPhil Reid int i2c_generic_scl_recovery(struct i2c_adapter *adap) 20191ed5349SWolfram Sang { 20291ed5349SWolfram Sang struct i2c_bus_recovery_info *bri = adap->bus_recovery_info; 203cf676908SLinus Torvalds int i = 0, scl = 1, ret = 0; 20491ed5349SWolfram Sang 20591ed5349SWolfram Sang if (bri->prepare_recovery) 20691ed5349SWolfram Sang bri->prepare_recovery(adap); 20775820314SCodrin Ciubotariu if (bri->pinctrl) 20875820314SCodrin Ciubotariu pinctrl_select_state(bri->pinctrl, bri->pins_gpio); 20991ed5349SWolfram Sang 210c4ae05b9SWolfram Sang /* 211c4ae05b9SWolfram Sang * If we can set SDA, we will always create a STOP to ensure additional 212c4ae05b9SWolfram Sang * pulses will do no harm. This is achieved by letting SDA follow SCL 213c4ae05b9SWolfram Sang * half a cycle later. Check the 'incomplete_write_byte' fault injector 214cf8ce8b8SRussell King * for details. Note that we must honour tsu:sto, 4us, but lets use 5us 215cf8ce8b8SRussell King * here for simplicity. 216c4ae05b9SWolfram Sang */ 217f7ff75e2SWolfram Sang bri->set_scl(adap, scl); 218cf8ce8b8SRussell King ndelay(RECOVERY_NDELAY); 21972b08fccSWolfram Sang if (bri->set_sda) 220c4ae05b9SWolfram Sang bri->set_sda(adap, scl); 221c4ae05b9SWolfram Sang ndelay(RECOVERY_NDELAY / 2); 22291ed5349SWolfram Sang 22391ed5349SWolfram Sang /* 22491ed5349SWolfram Sang * By this time SCL is high, as we need to give 9 falling-rising edges 22591ed5349SWolfram Sang */ 22691ed5349SWolfram Sang while (i++ < RECOVERY_CLK_CNT * 2) { 227f7ff75e2SWolfram Sang if (scl) { 22891ed5349SWolfram Sang /* SCL shouldn't be low here */ 22991ed5349SWolfram Sang if (!bri->get_scl(adap)) { 23091ed5349SWolfram Sang dev_err(&adap->dev, 23191ed5349SWolfram Sang "SCL is stuck low, exit recovery\n"); 23291ed5349SWolfram Sang ret = -EBUSY; 23391ed5349SWolfram Sang break; 23491ed5349SWolfram Sang } 23591ed5349SWolfram Sang } 23691ed5349SWolfram Sang 237f7ff75e2SWolfram Sang scl = !scl; 238f7ff75e2SWolfram Sang bri->set_scl(adap, scl); 239c4ae05b9SWolfram Sang /* Creating STOP again, see above */ 240cf8ce8b8SRussell King if (scl) { 241cf8ce8b8SRussell King /* Honour minimum tsu:sto */ 242cf8ce8b8SRussell King ndelay(RECOVERY_NDELAY); 243cf8ce8b8SRussell King } else { 244cf8ce8b8SRussell King /* Honour minimum tf and thd:dat */ 245abe41184SWolfram Sang ndelay(RECOVERY_NDELAY / 2); 246cf8ce8b8SRussell King } 247abe41184SWolfram Sang if (bri->set_sda) 248f7ff75e2SWolfram Sang bri->set_sda(adap, scl); 249abe41184SWolfram Sang ndelay(RECOVERY_NDELAY / 2); 2500b71026cSWolfram Sang 251f7ff75e2SWolfram Sang if (scl) { 2527ca5f6beSWolfram Sang ret = i2c_generic_bus_free(adap); 2530b71026cSWolfram Sang if (ret == 0) 2540b71026cSWolfram Sang break; 25591ed5349SWolfram Sang } 25691ed5349SWolfram Sang } 25791ed5349SWolfram Sang 2587ca5f6beSWolfram Sang /* If we can't check bus status, assume recovery worked */ 2597ca5f6beSWolfram Sang if (ret == -EOPNOTSUPP) 2607ca5f6beSWolfram Sang ret = 0; 2612806e6adSWolfram Sang 26291ed5349SWolfram Sang if (bri->unprepare_recovery) 26391ed5349SWolfram Sang bri->unprepare_recovery(adap); 26475820314SCodrin Ciubotariu if (bri->pinctrl) 26575820314SCodrin Ciubotariu pinctrl_select_state(bri->pinctrl, bri->pins_default); 26691ed5349SWolfram Sang 26791ed5349SWolfram Sang return ret; 26891ed5349SWolfram Sang } 26991ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_generic_scl_recovery); 27091ed5349SWolfram Sang 27191ed5349SWolfram Sang int i2c_recover_bus(struct i2c_adapter *adap) 27291ed5349SWolfram Sang { 27391ed5349SWolfram Sang if (!adap->bus_recovery_info) 274c126f7c3SDmitry Osipenko return -EBUSY; 27591ed5349SWolfram Sang 27691ed5349SWolfram Sang dev_dbg(&adap->dev, "Trying i2c bus recovery\n"); 27791ed5349SWolfram Sang return adap->bus_recovery_info->recover_bus(adap); 27891ed5349SWolfram Sang } 27991ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_recover_bus); 28091ed5349SWolfram Sang 28175820314SCodrin Ciubotariu static void i2c_gpio_init_pinctrl_recovery(struct i2c_adapter *adap) 28275820314SCodrin Ciubotariu { 28375820314SCodrin Ciubotariu struct i2c_bus_recovery_info *bri = adap->bus_recovery_info; 28475820314SCodrin Ciubotariu struct device *dev = &adap->dev; 28575820314SCodrin Ciubotariu struct pinctrl *p = bri->pinctrl; 28675820314SCodrin Ciubotariu 28775820314SCodrin Ciubotariu /* 28875820314SCodrin Ciubotariu * we can't change states without pinctrl, so remove the states if 28975820314SCodrin Ciubotariu * populated 29075820314SCodrin Ciubotariu */ 29175820314SCodrin Ciubotariu if (!p) { 29275820314SCodrin Ciubotariu bri->pins_default = NULL; 29375820314SCodrin Ciubotariu bri->pins_gpio = NULL; 29475820314SCodrin Ciubotariu return; 29575820314SCodrin Ciubotariu } 29675820314SCodrin Ciubotariu 29775820314SCodrin Ciubotariu if (!bri->pins_default) { 29875820314SCodrin Ciubotariu bri->pins_default = pinctrl_lookup_state(p, 29975820314SCodrin Ciubotariu PINCTRL_STATE_DEFAULT); 30075820314SCodrin Ciubotariu if (IS_ERR(bri->pins_default)) { 30175820314SCodrin Ciubotariu dev_dbg(dev, PINCTRL_STATE_DEFAULT " state not found for GPIO recovery\n"); 30275820314SCodrin Ciubotariu bri->pins_default = NULL; 30375820314SCodrin Ciubotariu } 30475820314SCodrin Ciubotariu } 30575820314SCodrin Ciubotariu if (!bri->pins_gpio) { 30675820314SCodrin Ciubotariu bri->pins_gpio = pinctrl_lookup_state(p, "gpio"); 30775820314SCodrin Ciubotariu if (IS_ERR(bri->pins_gpio)) 30875820314SCodrin Ciubotariu bri->pins_gpio = pinctrl_lookup_state(p, "recovery"); 30975820314SCodrin Ciubotariu 31075820314SCodrin Ciubotariu if (IS_ERR(bri->pins_gpio)) { 31175820314SCodrin Ciubotariu dev_dbg(dev, "no gpio or recovery state found for GPIO recovery\n"); 31275820314SCodrin Ciubotariu bri->pins_gpio = NULL; 31375820314SCodrin Ciubotariu } 31475820314SCodrin Ciubotariu } 31575820314SCodrin Ciubotariu 31675820314SCodrin Ciubotariu /* for pinctrl state changes, we need all the information */ 31775820314SCodrin Ciubotariu if (bri->pins_default && bri->pins_gpio) { 31875820314SCodrin Ciubotariu dev_info(dev, "using pinctrl states for GPIO recovery"); 31975820314SCodrin Ciubotariu } else { 32075820314SCodrin Ciubotariu bri->pinctrl = NULL; 32175820314SCodrin Ciubotariu bri->pins_default = NULL; 32275820314SCodrin Ciubotariu bri->pins_gpio = NULL; 32375820314SCodrin Ciubotariu } 32475820314SCodrin Ciubotariu } 32575820314SCodrin Ciubotariu 32675820314SCodrin Ciubotariu static int i2c_gpio_init_generic_recovery(struct i2c_adapter *adap) 32775820314SCodrin Ciubotariu { 32875820314SCodrin Ciubotariu struct i2c_bus_recovery_info *bri = adap->bus_recovery_info; 32975820314SCodrin Ciubotariu struct device *dev = &adap->dev; 33075820314SCodrin Ciubotariu struct gpio_desc *gpiod; 33175820314SCodrin Ciubotariu int ret = 0; 33275820314SCodrin Ciubotariu 33375820314SCodrin Ciubotariu /* 33475820314SCodrin Ciubotariu * don't touch the recovery information if the driver is not using 33575820314SCodrin Ciubotariu * generic SCL recovery 33675820314SCodrin Ciubotariu */ 33775820314SCodrin Ciubotariu if (bri->recover_bus && bri->recover_bus != i2c_generic_scl_recovery) 33875820314SCodrin Ciubotariu return 0; 33975820314SCodrin Ciubotariu 34075820314SCodrin Ciubotariu /* 34175820314SCodrin Ciubotariu * pins might be taken as GPIO, so we should inform pinctrl about 34275820314SCodrin Ciubotariu * this and move the state to GPIO 34375820314SCodrin Ciubotariu */ 34475820314SCodrin Ciubotariu if (bri->pinctrl) 34575820314SCodrin Ciubotariu pinctrl_select_state(bri->pinctrl, bri->pins_gpio); 34675820314SCodrin Ciubotariu 34775820314SCodrin Ciubotariu /* 34875820314SCodrin Ciubotariu * if there is incomplete or no recovery information, see if generic 34975820314SCodrin Ciubotariu * GPIO recovery is available 35075820314SCodrin Ciubotariu */ 35175820314SCodrin Ciubotariu if (!bri->scl_gpiod) { 35275820314SCodrin Ciubotariu gpiod = devm_gpiod_get(dev, "scl", GPIOD_OUT_HIGH_OPEN_DRAIN); 35375820314SCodrin Ciubotariu if (PTR_ERR(gpiod) == -EPROBE_DEFER) { 35475820314SCodrin Ciubotariu ret = -EPROBE_DEFER; 35575820314SCodrin Ciubotariu goto cleanup_pinctrl_state; 35675820314SCodrin Ciubotariu } 35775820314SCodrin Ciubotariu if (!IS_ERR(gpiod)) { 35875820314SCodrin Ciubotariu bri->scl_gpiod = gpiod; 35975820314SCodrin Ciubotariu bri->recover_bus = i2c_generic_scl_recovery; 36075820314SCodrin Ciubotariu dev_info(dev, "using generic GPIOs for recovery\n"); 36175820314SCodrin Ciubotariu } 36275820314SCodrin Ciubotariu } 36375820314SCodrin Ciubotariu 36475820314SCodrin Ciubotariu /* SDA GPIOD line is optional, so we care about DEFER only */ 36575820314SCodrin Ciubotariu if (!bri->sda_gpiod) { 36675820314SCodrin Ciubotariu /* 36775820314SCodrin Ciubotariu * We have SCL. Pull SCL low and wait a bit so that SDA glitches 36875820314SCodrin Ciubotariu * have no effect. 36975820314SCodrin Ciubotariu */ 37075820314SCodrin Ciubotariu gpiod_direction_output(bri->scl_gpiod, 0); 37175820314SCodrin Ciubotariu udelay(10); 37275820314SCodrin Ciubotariu gpiod = devm_gpiod_get(dev, "sda", GPIOD_IN); 37375820314SCodrin Ciubotariu 37475820314SCodrin Ciubotariu /* Wait a bit in case of a SDA glitch, and then release SCL. */ 37575820314SCodrin Ciubotariu udelay(10); 37675820314SCodrin Ciubotariu gpiod_direction_output(bri->scl_gpiod, 1); 37775820314SCodrin Ciubotariu 37875820314SCodrin Ciubotariu if (PTR_ERR(gpiod) == -EPROBE_DEFER) { 37975820314SCodrin Ciubotariu ret = -EPROBE_DEFER; 38075820314SCodrin Ciubotariu goto cleanup_pinctrl_state; 38175820314SCodrin Ciubotariu } 38275820314SCodrin Ciubotariu if (!IS_ERR(gpiod)) 38375820314SCodrin Ciubotariu bri->sda_gpiod = gpiod; 38475820314SCodrin Ciubotariu } 38575820314SCodrin Ciubotariu 38675820314SCodrin Ciubotariu cleanup_pinctrl_state: 38775820314SCodrin Ciubotariu /* change the state of the pins back to their default state */ 38875820314SCodrin Ciubotariu if (bri->pinctrl) 38975820314SCodrin Ciubotariu pinctrl_select_state(bri->pinctrl, bri->pins_default); 39075820314SCodrin Ciubotariu 39175820314SCodrin Ciubotariu return ret; 39275820314SCodrin Ciubotariu } 39375820314SCodrin Ciubotariu 39475820314SCodrin Ciubotariu static int i2c_gpio_init_recovery(struct i2c_adapter *adap) 39575820314SCodrin Ciubotariu { 39675820314SCodrin Ciubotariu i2c_gpio_init_pinctrl_recovery(adap); 39775820314SCodrin Ciubotariu return i2c_gpio_init_generic_recovery(adap); 39875820314SCodrin Ciubotariu } 39975820314SCodrin Ciubotariu 40023a698feSCodrin Ciubotariu static int i2c_init_recovery(struct i2c_adapter *adap) 40191ed5349SWolfram Sang { 40291ed5349SWolfram Sang struct i2c_bus_recovery_info *bri = adap->bus_recovery_info; 403cb3c66afSAndy Shevchenko bool is_error_level = true; 404cb3c66afSAndy Shevchenko char *err_str; 40591ed5349SWolfram Sang 40691ed5349SWolfram Sang if (!bri) 40723a698feSCodrin Ciubotariu return 0; 40891ed5349SWolfram Sang 40923a698feSCodrin Ciubotariu if (i2c_gpio_init_recovery(adap) == -EPROBE_DEFER) 41023a698feSCodrin Ciubotariu return -EPROBE_DEFER; 41175820314SCodrin Ciubotariu 41291ed5349SWolfram Sang if (!bri->recover_bus) { 413e409a6a3SWolfram Sang err_str = "no suitable method provided"; 414cb3c66afSAndy Shevchenko is_error_level = false; 41591ed5349SWolfram Sang goto err; 41691ed5349SWolfram Sang } 41791ed5349SWolfram Sang 4183991c5c8SPhil Reid if (bri->scl_gpiod && bri->recover_bus == i2c_generic_scl_recovery) { 41991ed5349SWolfram Sang bri->get_scl = get_scl_gpio_value; 42091ed5349SWolfram Sang bri->set_scl = set_scl_gpio_value; 4218092178fSWolfram Sang if (bri->sda_gpiod) { 4223991c5c8SPhil Reid bri->get_sda = get_sda_gpio_value; 4238092178fSWolfram Sang /* FIXME: add proper flag instead of '0' once available */ 4248092178fSWolfram Sang if (gpiod_get_direction(bri->sda_gpiod) == 0) 4258092178fSWolfram Sang bri->set_sda = set_sda_gpio_value; 4268092178fSWolfram Sang } 42723a698feSCodrin Ciubotariu } else if (bri->recover_bus == i2c_generic_scl_recovery) { 42891ed5349SWolfram Sang /* Generic SCL recovery */ 42991ed5349SWolfram Sang if (!bri->set_scl || !bri->get_scl) { 43091ed5349SWolfram Sang err_str = "no {get|set}_scl() found"; 43191ed5349SWolfram Sang goto err; 43291ed5349SWolfram Sang } 433ffc59c49SWolfram Sang if (!bri->set_sda && !bri->get_sda) { 434ffc59c49SWolfram Sang err_str = "either get_sda() or set_sda() needed"; 435ffc59c49SWolfram Sang goto err; 436ffc59c49SWolfram Sang } 43791ed5349SWolfram Sang } 43891ed5349SWolfram Sang 43923a698feSCodrin Ciubotariu return 0; 44091ed5349SWolfram Sang err: 441cb3c66afSAndy Shevchenko if (is_error_level) 442cb3c66afSAndy Shevchenko dev_err(&adap->dev, "Not using recovery: %s\n", err_str); 443cb3c66afSAndy Shevchenko else 444cb3c66afSAndy Shevchenko dev_dbg(&adap->dev, "Not using recovery: %s\n", err_str); 44591ed5349SWolfram Sang adap->bus_recovery_info = NULL; 44623a698feSCodrin Ciubotariu 44723a698feSCodrin Ciubotariu return -EINVAL; 44891ed5349SWolfram Sang } 44991ed5349SWolfram Sang 45091ed5349SWolfram Sang static int i2c_smbus_host_notify_to_irq(const struct i2c_client *client) 45191ed5349SWolfram Sang { 45291ed5349SWolfram Sang struct i2c_adapter *adap = client->adapter; 45391ed5349SWolfram Sang unsigned int irq; 45491ed5349SWolfram Sang 45591ed5349SWolfram Sang if (!adap->host_notify_domain) 45691ed5349SWolfram Sang return -ENXIO; 45791ed5349SWolfram Sang 45891ed5349SWolfram Sang if (client->flags & I2C_CLIENT_TEN) 45991ed5349SWolfram Sang return -EINVAL; 46091ed5349SWolfram Sang 461b9bb3fdfSCharles Keepax irq = irq_create_mapping(adap->host_notify_domain, client->addr); 46291ed5349SWolfram Sang 46391ed5349SWolfram Sang return irq > 0 ? irq : -ENXIO; 46491ed5349SWolfram Sang } 46591ed5349SWolfram Sang 46691ed5349SWolfram Sang static int i2c_device_probe(struct device *dev) 46791ed5349SWolfram Sang { 46891ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 46991ed5349SWolfram Sang struct i2c_driver *driver; 47091ed5349SWolfram Sang int status; 47191ed5349SWolfram Sang 47291ed5349SWolfram Sang if (!client) 47391ed5349SWolfram Sang return 0; 47491ed5349SWolfram Sang 4756e76cb7dSCharles Keepax client->irq = client->init_irq; 4766e76cb7dSCharles Keepax 4770c2a3493SWolfram Sang if (!client->irq) { 47891ed5349SWolfram Sang int irq = -ENOENT; 47991ed5349SWolfram Sang 48091ed5349SWolfram Sang if (client->flags & I2C_CLIENT_HOST_NOTIFY) { 48191ed5349SWolfram Sang dev_dbg(dev, "Using Host Notify IRQ\n"); 48272bfcee1SJarkko Nikula /* Keep adapter active when Host Notify is required */ 48372bfcee1SJarkko Nikula pm_runtime_get_sync(&client->adapter->dev); 48491ed5349SWolfram Sang irq = i2c_smbus_host_notify_to_irq(client); 48591ed5349SWolfram Sang } else if (dev->of_node) { 48691ed5349SWolfram Sang irq = of_irq_get_byname(dev->of_node, "irq"); 48791ed5349SWolfram Sang if (irq == -EINVAL || irq == -ENODATA) 48891ed5349SWolfram Sang irq = of_irq_get(dev->of_node, 0); 48991ed5349SWolfram Sang } else if (ACPI_COMPANION(dev)) { 49016c9db1dSCharles Keepax irq = i2c_acpi_get_irq(client); 49191ed5349SWolfram Sang } 4923c3dd56fSAlain Volmat if (irq == -EPROBE_DEFER) { 4933c3dd56fSAlain Volmat status = irq; 4943c3dd56fSAlain Volmat goto put_sync_adapter; 4953c3dd56fSAlain Volmat } 49691ed5349SWolfram Sang 49791ed5349SWolfram Sang if (irq < 0) 49891ed5349SWolfram Sang irq = 0; 49991ed5349SWolfram Sang 50091ed5349SWolfram Sang client->irq = irq; 50191ed5349SWolfram Sang } 50291ed5349SWolfram Sang 5030c2a3493SWolfram Sang driver = to_i2c_driver(dev->driver); 5040c2a3493SWolfram Sang 50591ed5349SWolfram Sang /* 506f4b17a14SJavier Martinez Canillas * An I2C ID table is not mandatory, if and only if, a suitable OF 507f4b17a14SJavier Martinez Canillas * or ACPI ID table is supplied for the probing device. 50891ed5349SWolfram Sang */ 50991ed5349SWolfram Sang if (!driver->id_table && 510e3cb82c6SAndy Shevchenko !acpi_driver_match_device(dev, dev->driver) && 5113c3dd56fSAlain Volmat !i2c_of_match_device(dev->driver->of_match_table, client)) { 5123c3dd56fSAlain Volmat status = -ENODEV; 5133c3dd56fSAlain Volmat goto put_sync_adapter; 5143c3dd56fSAlain Volmat } 51591ed5349SWolfram Sang 51691ed5349SWolfram Sang if (client->flags & I2C_CLIENT_WAKE) { 5173e99834cSAndy Shevchenko int wakeirq; 51891ed5349SWolfram Sang 51991ed5349SWolfram Sang wakeirq = of_irq_get_byname(dev->of_node, "wakeup"); 5203c3dd56fSAlain Volmat if (wakeirq == -EPROBE_DEFER) { 5213c3dd56fSAlain Volmat status = wakeirq; 5223c3dd56fSAlain Volmat goto put_sync_adapter; 5233c3dd56fSAlain Volmat } 52491ed5349SWolfram Sang 52591ed5349SWolfram Sang device_init_wakeup(&client->dev, true); 52691ed5349SWolfram Sang 52791ed5349SWolfram Sang if (wakeirq > 0 && wakeirq != client->irq) 52891ed5349SWolfram Sang status = dev_pm_set_dedicated_wake_irq(dev, wakeirq); 52991ed5349SWolfram Sang else if (client->irq > 0) 53091ed5349SWolfram Sang status = dev_pm_set_wake_irq(dev, client->irq); 53191ed5349SWolfram Sang else 53291ed5349SWolfram Sang status = 0; 53391ed5349SWolfram Sang 53491ed5349SWolfram Sang if (status) 53591ed5349SWolfram Sang dev_warn(&client->dev, "failed to set up wakeup irq\n"); 53691ed5349SWolfram Sang } 53791ed5349SWolfram Sang 53891ed5349SWolfram Sang dev_dbg(dev, "probe\n"); 53991ed5349SWolfram Sang 54091ed5349SWolfram Sang status = of_clk_set_defaults(dev->of_node, false); 54191ed5349SWolfram Sang if (status < 0) 54291ed5349SWolfram Sang goto err_clear_wakeup_irq; 54391ed5349SWolfram Sang 544b18c1ad6SSakari Ailus status = dev_pm_domain_attach(&client->dev, 545b18c1ad6SSakari Ailus !i2c_acpi_waive_d0_probe(dev)); 546e6a20b6cSUlf Hansson if (status) 54791ed5349SWolfram Sang goto err_clear_wakeup_irq; 54891ed5349SWolfram Sang 5495b547582SDmitry Torokhov client->devres_group_id = devres_open_group(&client->dev, NULL, 5505b547582SDmitry Torokhov GFP_KERNEL); 5515b547582SDmitry Torokhov if (!client->devres_group_id) { 5525b547582SDmitry Torokhov status = -ENOMEM; 5535b547582SDmitry Torokhov goto err_detach_pm_domain; 5545b547582SDmitry Torokhov } 5555b547582SDmitry Torokhov 55691ed5349SWolfram Sang /* 55791ed5349SWolfram Sang * When there are no more users of probe(), 55891ed5349SWolfram Sang * rename probe_new to probe. 55991ed5349SWolfram Sang */ 56091ed5349SWolfram Sang if (driver->probe_new) 56191ed5349SWolfram Sang status = driver->probe_new(client); 56291ed5349SWolfram Sang else if (driver->probe) 56391ed5349SWolfram Sang status = driver->probe(client, 56491ed5349SWolfram Sang i2c_match_id(driver->id_table, client)); 56591ed5349SWolfram Sang else 56691ed5349SWolfram Sang status = -EINVAL; 56791ed5349SWolfram Sang 5685b547582SDmitry Torokhov /* 5695b547582SDmitry Torokhov * Note that we are not closing the devres group opened above so 5705b547582SDmitry Torokhov * even resources that were attached to the device after probe is 5715b547582SDmitry Torokhov * run are released when i2c_device_remove() is executed. This is 5725b547582SDmitry Torokhov * needed as some drivers would allocate additional resources, 5735b547582SDmitry Torokhov * for example when updating firmware. 5745b547582SDmitry Torokhov */ 5755b547582SDmitry Torokhov 57691ed5349SWolfram Sang if (status) 5775b547582SDmitry Torokhov goto err_release_driver_resources; 57891ed5349SWolfram Sang 57991ed5349SWolfram Sang return 0; 58091ed5349SWolfram Sang 5815b547582SDmitry Torokhov err_release_driver_resources: 5825b547582SDmitry Torokhov devres_release_group(&client->dev, client->devres_group_id); 58391ed5349SWolfram Sang err_detach_pm_domain: 584b18c1ad6SSakari Ailus dev_pm_domain_detach(&client->dev, !i2c_acpi_waive_d0_probe(dev)); 58591ed5349SWolfram Sang err_clear_wakeup_irq: 58691ed5349SWolfram Sang dev_pm_clear_wake_irq(&client->dev); 58791ed5349SWolfram Sang device_init_wakeup(&client->dev, false); 5883c3dd56fSAlain Volmat put_sync_adapter: 5893c3dd56fSAlain Volmat if (client->flags & I2C_CLIENT_HOST_NOTIFY) 5903c3dd56fSAlain Volmat pm_runtime_put_sync(&client->adapter->dev); 5913c3dd56fSAlain Volmat 59291ed5349SWolfram Sang return status; 59391ed5349SWolfram Sang } 59491ed5349SWolfram Sang 595fc7a6209SUwe Kleine-König static void i2c_device_remove(struct device *dev) 59691ed5349SWolfram Sang { 5974e970a0aSUwe Kleine-König struct i2c_client *client = to_i2c_client(dev); 59891ed5349SWolfram Sang struct i2c_driver *driver; 59991ed5349SWolfram Sang 60091ed5349SWolfram Sang driver = to_i2c_driver(dev->driver); 60191ed5349SWolfram Sang if (driver->remove) { 60271637c62SUwe Kleine-König int status; 60371637c62SUwe Kleine-König 60491ed5349SWolfram Sang dev_dbg(dev, "remove\n"); 60571637c62SUwe Kleine-König 60691ed5349SWolfram Sang status = driver->remove(client); 60771637c62SUwe Kleine-König if (status) 60871637c62SUwe Kleine-König dev_warn(dev, "remove failed (%pe), will be ignored\n", ERR_PTR(status)); 60991ed5349SWolfram Sang } 61091ed5349SWolfram Sang 6115b547582SDmitry Torokhov devres_release_group(&client->dev, client->devres_group_id); 6125b547582SDmitry Torokhov 613b18c1ad6SSakari Ailus dev_pm_domain_detach(&client->dev, !i2c_acpi_waive_d0_probe(dev)); 61491ed5349SWolfram Sang 61591ed5349SWolfram Sang dev_pm_clear_wake_irq(&client->dev); 61691ed5349SWolfram Sang device_init_wakeup(&client->dev, false); 61791ed5349SWolfram Sang 6186e76cb7dSCharles Keepax client->irq = 0; 61972bfcee1SJarkko Nikula if (client->flags & I2C_CLIENT_HOST_NOTIFY) 62072bfcee1SJarkko Nikula pm_runtime_put(&client->adapter->dev); 62191ed5349SWolfram Sang } 62291ed5349SWolfram Sang 62391ed5349SWolfram Sang static void i2c_device_shutdown(struct device *dev) 62491ed5349SWolfram Sang { 62591ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 62691ed5349SWolfram Sang struct i2c_driver *driver; 62791ed5349SWolfram Sang 62891ed5349SWolfram Sang if (!client || !dev->driver) 62991ed5349SWolfram Sang return; 63091ed5349SWolfram Sang driver = to_i2c_driver(dev->driver); 63191ed5349SWolfram Sang if (driver->shutdown) 63291ed5349SWolfram Sang driver->shutdown(client); 633b64210f2SDmitry Torokhov else if (client->irq > 0) 634b64210f2SDmitry Torokhov disable_irq(client->irq); 63591ed5349SWolfram Sang } 63691ed5349SWolfram Sang 63791ed5349SWolfram Sang static void i2c_client_dev_release(struct device *dev) 63891ed5349SWolfram Sang { 63991ed5349SWolfram Sang kfree(to_i2c_client(dev)); 64091ed5349SWolfram Sang } 64191ed5349SWolfram Sang 64291ed5349SWolfram Sang static ssize_t 64354a19fd4SGeert Uytterhoeven name_show(struct device *dev, struct device_attribute *attr, char *buf) 64491ed5349SWolfram Sang { 64591ed5349SWolfram Sang return sprintf(buf, "%s\n", dev->type == &i2c_client_type ? 64691ed5349SWolfram Sang to_i2c_client(dev)->name : to_i2c_adapter(dev)->name); 64791ed5349SWolfram Sang } 64854a19fd4SGeert Uytterhoeven static DEVICE_ATTR_RO(name); 64991ed5349SWolfram Sang 65091ed5349SWolfram Sang static ssize_t 65154a19fd4SGeert Uytterhoeven modalias_show(struct device *dev, struct device_attribute *attr, char *buf) 65291ed5349SWolfram Sang { 65391ed5349SWolfram Sang struct i2c_client *client = to_i2c_client(dev); 65491ed5349SWolfram Sang int len; 65591ed5349SWolfram Sang 656af503716SJavier Martinez Canillas len = of_device_modalias(dev, buf, PAGE_SIZE); 657af503716SJavier Martinez Canillas if (len != -ENODEV) 658af503716SJavier Martinez Canillas return len; 659af503716SJavier Martinez Canillas 66091ed5349SWolfram Sang len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1); 66191ed5349SWolfram Sang if (len != -ENODEV) 66291ed5349SWolfram Sang return len; 66391ed5349SWolfram Sang 66491ed5349SWolfram Sang return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name); 66591ed5349SWolfram Sang } 66654a19fd4SGeert Uytterhoeven static DEVICE_ATTR_RO(modalias); 66791ed5349SWolfram Sang 66891ed5349SWolfram Sang static struct attribute *i2c_dev_attrs[] = { 66991ed5349SWolfram Sang &dev_attr_name.attr, 67091ed5349SWolfram Sang /* modalias helps coldplug: modprobe $(cat .../modalias) */ 67191ed5349SWolfram Sang &dev_attr_modalias.attr, 67291ed5349SWolfram Sang NULL 67391ed5349SWolfram Sang }; 67491ed5349SWolfram Sang ATTRIBUTE_GROUPS(i2c_dev); 67591ed5349SWolfram Sang 67691ed5349SWolfram Sang struct bus_type i2c_bus_type = { 67791ed5349SWolfram Sang .name = "i2c", 67891ed5349SWolfram Sang .match = i2c_device_match, 67991ed5349SWolfram Sang .probe = i2c_device_probe, 68091ed5349SWolfram Sang .remove = i2c_device_remove, 68191ed5349SWolfram Sang .shutdown = i2c_device_shutdown, 68291ed5349SWolfram Sang }; 68391ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_bus_type); 68491ed5349SWolfram Sang 68591ed5349SWolfram Sang struct device_type i2c_client_type = { 68691ed5349SWolfram Sang .groups = i2c_dev_groups, 68791ed5349SWolfram Sang .uevent = i2c_device_uevent, 68891ed5349SWolfram Sang .release = i2c_client_dev_release, 68991ed5349SWolfram Sang }; 69091ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_client_type); 69191ed5349SWolfram Sang 69291ed5349SWolfram Sang 69391ed5349SWolfram Sang /** 69491ed5349SWolfram Sang * i2c_verify_client - return parameter as i2c_client, or NULL 69591ed5349SWolfram Sang * @dev: device, probably from some driver model iterator 69691ed5349SWolfram Sang * 69791ed5349SWolfram Sang * When traversing the driver model tree, perhaps using driver model 69891ed5349SWolfram Sang * iterators like @device_for_each_child(), you can't assume very much 69991ed5349SWolfram Sang * about the nodes you find. Use this function to avoid oopses caused 70091ed5349SWolfram Sang * by wrongly treating some non-I2C device as an i2c_client. 70191ed5349SWolfram Sang */ 70291ed5349SWolfram Sang struct i2c_client *i2c_verify_client(struct device *dev) 70391ed5349SWolfram Sang { 70491ed5349SWolfram Sang return (dev->type == &i2c_client_type) 70591ed5349SWolfram Sang ? to_i2c_client(dev) 70691ed5349SWolfram Sang : NULL; 70791ed5349SWolfram Sang } 70891ed5349SWolfram Sang EXPORT_SYMBOL(i2c_verify_client); 70991ed5349SWolfram Sang 71091ed5349SWolfram Sang 71191ed5349SWolfram Sang /* Return a unique address which takes the flags of the client into account */ 71291ed5349SWolfram Sang static unsigned short i2c_encode_flags_to_addr(struct i2c_client *client) 71391ed5349SWolfram Sang { 71491ed5349SWolfram Sang unsigned short addr = client->addr; 71591ed5349SWolfram Sang 71691ed5349SWolfram Sang /* For some client flags, add an arbitrary offset to avoid collisions */ 71791ed5349SWolfram Sang if (client->flags & I2C_CLIENT_TEN) 71891ed5349SWolfram Sang addr |= I2C_ADDR_OFFSET_TEN_BIT; 71991ed5349SWolfram Sang 72091ed5349SWolfram Sang if (client->flags & I2C_CLIENT_SLAVE) 72191ed5349SWolfram Sang addr |= I2C_ADDR_OFFSET_SLAVE; 72291ed5349SWolfram Sang 72391ed5349SWolfram Sang return addr; 72491ed5349SWolfram Sang } 72591ed5349SWolfram Sang 72691ed5349SWolfram Sang /* This is a permissive address validity check, I2C address map constraints 72791ed5349SWolfram Sang * are purposely not enforced, except for the general call address. */ 728398432edSWolfram Sang static int i2c_check_addr_validity(unsigned int addr, unsigned short flags) 72991ed5349SWolfram Sang { 73091ed5349SWolfram Sang if (flags & I2C_CLIENT_TEN) { 73191ed5349SWolfram Sang /* 10-bit address, all values are valid */ 73291ed5349SWolfram Sang if (addr > 0x3ff) 73391ed5349SWolfram Sang return -EINVAL; 73491ed5349SWolfram Sang } else { 73591ed5349SWolfram Sang /* 7-bit address, reject the general call address */ 73691ed5349SWolfram Sang if (addr == 0x00 || addr > 0x7f) 73791ed5349SWolfram Sang return -EINVAL; 73891ed5349SWolfram Sang } 73991ed5349SWolfram Sang return 0; 74091ed5349SWolfram Sang } 74191ed5349SWolfram Sang 74291ed5349SWolfram Sang /* And this is a strict address validity check, used when probing. If a 74391ed5349SWolfram Sang * device uses a reserved address, then it shouldn't be probed. 7-bit 74491ed5349SWolfram Sang * addressing is assumed, 10-bit address devices are rare and should be 74591ed5349SWolfram Sang * explicitly enumerated. */ 746e4991ecdSWolfram Sang int i2c_check_7bit_addr_validity_strict(unsigned short addr) 74791ed5349SWolfram Sang { 74891ed5349SWolfram Sang /* 74991ed5349SWolfram Sang * Reserved addresses per I2C specification: 75091ed5349SWolfram Sang * 0x00 General call address / START byte 75191ed5349SWolfram Sang * 0x01 CBUS address 75291ed5349SWolfram Sang * 0x02 Reserved for different bus format 75391ed5349SWolfram Sang * 0x03 Reserved for future purposes 75491ed5349SWolfram Sang * 0x04-0x07 Hs-mode master code 75591ed5349SWolfram Sang * 0x78-0x7b 10-bit slave addressing 75691ed5349SWolfram Sang * 0x7c-0x7f Reserved for future purposes 75791ed5349SWolfram Sang */ 75891ed5349SWolfram Sang if (addr < 0x08 || addr > 0x77) 75991ed5349SWolfram Sang return -EINVAL; 76091ed5349SWolfram Sang return 0; 76191ed5349SWolfram Sang } 76291ed5349SWolfram Sang 76391ed5349SWolfram Sang static int __i2c_check_addr_busy(struct device *dev, void *addrp) 76491ed5349SWolfram Sang { 76591ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 76691ed5349SWolfram Sang int addr = *(int *)addrp; 76791ed5349SWolfram Sang 76891ed5349SWolfram Sang if (client && i2c_encode_flags_to_addr(client) == addr) 76991ed5349SWolfram Sang return -EBUSY; 77091ed5349SWolfram Sang return 0; 77191ed5349SWolfram Sang } 77291ed5349SWolfram Sang 77391ed5349SWolfram Sang /* walk up mux tree */ 77491ed5349SWolfram Sang static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr) 77591ed5349SWolfram Sang { 77691ed5349SWolfram Sang struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter); 77791ed5349SWolfram Sang int result; 77891ed5349SWolfram Sang 77991ed5349SWolfram Sang result = device_for_each_child(&adapter->dev, &addr, 78091ed5349SWolfram Sang __i2c_check_addr_busy); 78191ed5349SWolfram Sang 78291ed5349SWolfram Sang if (!result && parent) 78391ed5349SWolfram Sang result = i2c_check_mux_parents(parent, addr); 78491ed5349SWolfram Sang 78591ed5349SWolfram Sang return result; 78691ed5349SWolfram Sang } 78791ed5349SWolfram Sang 78891ed5349SWolfram Sang /* recurse down mux tree */ 78991ed5349SWolfram Sang static int i2c_check_mux_children(struct device *dev, void *addrp) 79091ed5349SWolfram Sang { 79191ed5349SWolfram Sang int result; 79291ed5349SWolfram Sang 79391ed5349SWolfram Sang if (dev->type == &i2c_adapter_type) 79491ed5349SWolfram Sang result = device_for_each_child(dev, addrp, 79591ed5349SWolfram Sang i2c_check_mux_children); 79691ed5349SWolfram Sang else 79791ed5349SWolfram Sang result = __i2c_check_addr_busy(dev, addrp); 79891ed5349SWolfram Sang 79991ed5349SWolfram Sang return result; 80091ed5349SWolfram Sang } 80191ed5349SWolfram Sang 80291ed5349SWolfram Sang static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr) 80391ed5349SWolfram Sang { 80491ed5349SWolfram Sang struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter); 80591ed5349SWolfram Sang int result = 0; 80691ed5349SWolfram Sang 80791ed5349SWolfram Sang if (parent) 80891ed5349SWolfram Sang result = i2c_check_mux_parents(parent, addr); 80991ed5349SWolfram Sang 81091ed5349SWolfram Sang if (!result) 81191ed5349SWolfram Sang result = device_for_each_child(&adapter->dev, &addr, 81291ed5349SWolfram Sang i2c_check_mux_children); 81391ed5349SWolfram Sang 81491ed5349SWolfram Sang return result; 81591ed5349SWolfram Sang } 81691ed5349SWolfram Sang 81791ed5349SWolfram Sang /** 81891ed5349SWolfram Sang * i2c_adapter_lock_bus - Get exclusive access to an I2C bus segment 81991ed5349SWolfram Sang * @adapter: Target I2C bus segment 82091ed5349SWolfram Sang * @flags: I2C_LOCK_ROOT_ADAPTER locks the root i2c adapter, I2C_LOCK_SEGMENT 82191ed5349SWolfram Sang * locks only this branch in the adapter tree 82291ed5349SWolfram Sang */ 82391ed5349SWolfram Sang static void i2c_adapter_lock_bus(struct i2c_adapter *adapter, 82491ed5349SWolfram Sang unsigned int flags) 82591ed5349SWolfram Sang { 8267b94ea50SPeter Rosin rt_mutex_lock_nested(&adapter->bus_lock, i2c_adapter_depth(adapter)); 82791ed5349SWolfram Sang } 82891ed5349SWolfram Sang 82991ed5349SWolfram Sang /** 83091ed5349SWolfram Sang * i2c_adapter_trylock_bus - Try to get exclusive access to an I2C bus segment 83191ed5349SWolfram Sang * @adapter: Target I2C bus segment 83291ed5349SWolfram Sang * @flags: I2C_LOCK_ROOT_ADAPTER trylocks the root i2c adapter, I2C_LOCK_SEGMENT 83391ed5349SWolfram Sang * trylocks only this branch in the adapter tree 83491ed5349SWolfram Sang */ 83591ed5349SWolfram Sang static int i2c_adapter_trylock_bus(struct i2c_adapter *adapter, 83691ed5349SWolfram Sang unsigned int flags) 83791ed5349SWolfram Sang { 83891ed5349SWolfram Sang return rt_mutex_trylock(&adapter->bus_lock); 83991ed5349SWolfram Sang } 84091ed5349SWolfram Sang 84191ed5349SWolfram Sang /** 84291ed5349SWolfram Sang * i2c_adapter_unlock_bus - Release exclusive access to an I2C bus segment 84391ed5349SWolfram Sang * @adapter: Target I2C bus segment 84491ed5349SWolfram Sang * @flags: I2C_LOCK_ROOT_ADAPTER unlocks the root i2c adapter, I2C_LOCK_SEGMENT 84591ed5349SWolfram Sang * unlocks only this branch in the adapter tree 84691ed5349SWolfram Sang */ 84791ed5349SWolfram Sang static void i2c_adapter_unlock_bus(struct i2c_adapter *adapter, 84891ed5349SWolfram Sang unsigned int flags) 84991ed5349SWolfram Sang { 85091ed5349SWolfram Sang rt_mutex_unlock(&adapter->bus_lock); 85191ed5349SWolfram Sang } 85291ed5349SWolfram Sang 85391ed5349SWolfram Sang static void i2c_dev_set_name(struct i2c_adapter *adap, 854728fe6ceSHans de Goede struct i2c_client *client, 855728fe6ceSHans de Goede struct i2c_board_info const *info) 85691ed5349SWolfram Sang { 85791ed5349SWolfram Sang struct acpi_device *adev = ACPI_COMPANION(&client->dev); 85891ed5349SWolfram Sang 859728fe6ceSHans de Goede if (info && info->dev_name) { 860728fe6ceSHans de Goede dev_set_name(&client->dev, "i2c-%s", info->dev_name); 861728fe6ceSHans de Goede return; 862728fe6ceSHans de Goede } 863728fe6ceSHans de Goede 86491ed5349SWolfram Sang if (adev) { 86591ed5349SWolfram Sang dev_set_name(&client->dev, "i2c-%s", acpi_dev_name(adev)); 86691ed5349SWolfram Sang return; 86791ed5349SWolfram Sang } 86891ed5349SWolfram Sang 86991ed5349SWolfram Sang dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap), 87091ed5349SWolfram Sang i2c_encode_flags_to_addr(client)); 87191ed5349SWolfram Sang } 87291ed5349SWolfram Sang 8731d7534b6SCharles Keepax int i2c_dev_irq_from_resources(const struct resource *resources, 87491ed5349SWolfram Sang unsigned int num_resources) 87591ed5349SWolfram Sang { 87691ed5349SWolfram Sang struct irq_data *irqd; 87791ed5349SWolfram Sang int i; 87891ed5349SWolfram Sang 87991ed5349SWolfram Sang for (i = 0; i < num_resources; i++) { 88091ed5349SWolfram Sang const struct resource *r = &resources[i]; 88191ed5349SWolfram Sang 88291ed5349SWolfram Sang if (resource_type(r) != IORESOURCE_IRQ) 88391ed5349SWolfram Sang continue; 88491ed5349SWolfram Sang 88591ed5349SWolfram Sang if (r->flags & IORESOURCE_BITS) { 88691ed5349SWolfram Sang irqd = irq_get_irq_data(r->start); 88791ed5349SWolfram Sang if (!irqd) 88891ed5349SWolfram Sang break; 88991ed5349SWolfram Sang 89091ed5349SWolfram Sang irqd_set_trigger_type(irqd, r->flags & IORESOURCE_BITS); 89191ed5349SWolfram Sang } 89291ed5349SWolfram Sang 89391ed5349SWolfram Sang return r->start; 89491ed5349SWolfram Sang } 89591ed5349SWolfram Sang 89691ed5349SWolfram Sang return 0; 89791ed5349SWolfram Sang } 89891ed5349SWolfram Sang 89991ed5349SWolfram Sang /** 9007159dbdaSHeiner Kallweit * i2c_new_client_device - instantiate an i2c device 90191ed5349SWolfram Sang * @adap: the adapter managing the device 90291ed5349SWolfram Sang * @info: describes one I2C device; bus_num is ignored 90391ed5349SWolfram Sang * Context: can sleep 90491ed5349SWolfram Sang * 90591ed5349SWolfram Sang * Create an i2c device. Binding is handled through driver model 90691ed5349SWolfram Sang * probe()/remove() methods. A driver may be bound to this device when we 90791ed5349SWolfram Sang * return from this function, or any later moment (e.g. maybe hotplugging will 90891ed5349SWolfram Sang * load the driver module). This call is not appropriate for use by mainboard 90991ed5349SWolfram Sang * initialization logic, which usually runs during an arch_initcall() long 91091ed5349SWolfram Sang * before any i2c_adapter could exist. 91191ed5349SWolfram Sang * 91291ed5349SWolfram Sang * This returns the new i2c client, which may be saved for later use with 9137159dbdaSHeiner Kallweit * i2c_unregister_device(); or an ERR_PTR to describe the error. 91491ed5349SWolfram Sang */ 915550113d4SWolfram Sang struct i2c_client * 9167159dbdaSHeiner Kallweit i2c_new_client_device(struct i2c_adapter *adap, struct i2c_board_info const *info) 91791ed5349SWolfram Sang { 91891ed5349SWolfram Sang struct i2c_client *client; 91991ed5349SWolfram Sang int status; 92091ed5349SWolfram Sang 92191ed5349SWolfram Sang client = kzalloc(sizeof *client, GFP_KERNEL); 92291ed5349SWolfram Sang if (!client) 9237159dbdaSHeiner Kallweit return ERR_PTR(-ENOMEM); 92491ed5349SWolfram Sang 92591ed5349SWolfram Sang client->adapter = adap; 92691ed5349SWolfram Sang 92791ed5349SWolfram Sang client->dev.platform_data = info->platform_data; 92891ed5349SWolfram Sang client->flags = info->flags; 92991ed5349SWolfram Sang client->addr = info->addr; 93091ed5349SWolfram Sang 93193b6604cSJim Broadus client->init_irq = info->irq; 93293b6604cSJim Broadus if (!client->init_irq) 93393b6604cSJim Broadus client->init_irq = i2c_dev_irq_from_resources(info->resources, 93491ed5349SWolfram Sang info->num_resources); 93591ed5349SWolfram Sang 93691ed5349SWolfram Sang strlcpy(client->name, info->type, sizeof(client->name)); 93791ed5349SWolfram Sang 93891ed5349SWolfram Sang status = i2c_check_addr_validity(client->addr, client->flags); 93991ed5349SWolfram Sang if (status) { 94091ed5349SWolfram Sang dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n", 94191ed5349SWolfram Sang client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr); 94291ed5349SWolfram Sang goto out_err_silent; 94391ed5349SWolfram Sang } 94491ed5349SWolfram Sang 94591ed5349SWolfram Sang /* Check for address business */ 94691ed5349SWolfram Sang status = i2c_check_addr_busy(adap, i2c_encode_flags_to_addr(client)); 94791ed5349SWolfram Sang if (status) 94891ed5349SWolfram Sang goto out_err; 94991ed5349SWolfram Sang 95091ed5349SWolfram Sang client->dev.parent = &client->adapter->dev; 95191ed5349SWolfram Sang client->dev.bus = &i2c_bus_type; 95291ed5349SWolfram Sang client->dev.type = &i2c_client_type; 95304782265SBoris Brezillon client->dev.of_node = of_node_get(info->of_node); 95491ed5349SWolfram Sang client->dev.fwnode = info->fwnode; 95591ed5349SWolfram Sang 956172d9319SDerek Basehore device_enable_async_suspend(&client->dev); 957728fe6ceSHans de Goede i2c_dev_set_name(adap, client, info); 95891ed5349SWolfram Sang 959714638e0SHeikki Krogerus if (info->swnode) { 960714638e0SHeikki Krogerus status = device_add_software_node(&client->dev, info->swnode); 96191ed5349SWolfram Sang if (status) { 96291ed5349SWolfram Sang dev_err(&adap->dev, 963714638e0SHeikki Krogerus "Failed to add software node to client %s: %d\n", 96491ed5349SWolfram Sang client->name, status); 96504782265SBoris Brezillon goto out_err_put_of_node; 96691ed5349SWolfram Sang } 96791ed5349SWolfram Sang } 96891ed5349SWolfram Sang 96991ed5349SWolfram Sang status = device_register(&client->dev); 97091ed5349SWolfram Sang if (status) 971714638e0SHeikki Krogerus goto out_remove_swnode; 97291ed5349SWolfram Sang 97391ed5349SWolfram Sang dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n", 97491ed5349SWolfram Sang client->name, dev_name(&client->dev)); 97591ed5349SWolfram Sang 97691ed5349SWolfram Sang return client; 97791ed5349SWolfram Sang 978714638e0SHeikki Krogerus out_remove_swnode: 979714638e0SHeikki Krogerus device_remove_software_node(&client->dev); 98004782265SBoris Brezillon out_err_put_of_node: 98104782265SBoris Brezillon of_node_put(info->of_node); 98291ed5349SWolfram Sang out_err: 98391ed5349SWolfram Sang dev_err(&adap->dev, 98491ed5349SWolfram Sang "Failed to register i2c client %s at 0x%02x (%d)\n", 98591ed5349SWolfram Sang client->name, client->addr, status); 98691ed5349SWolfram Sang out_err_silent: 98791ed5349SWolfram Sang kfree(client); 9887159dbdaSHeiner Kallweit return ERR_PTR(status); 9897159dbdaSHeiner Kallweit } 9907159dbdaSHeiner Kallweit EXPORT_SYMBOL_GPL(i2c_new_client_device); 9917159dbdaSHeiner Kallweit 9927159dbdaSHeiner Kallweit /** 99387e07437SWolfram Sang * i2c_unregister_device - reverse effect of i2c_new_*_device() 99487e07437SWolfram Sang * @client: value returned from i2c_new_*_device() 99591ed5349SWolfram Sang * Context: can sleep 99691ed5349SWolfram Sang */ 99791ed5349SWolfram Sang void i2c_unregister_device(struct i2c_client *client) 99891ed5349SWolfram Sang { 999689f5358SWolfram Sang if (IS_ERR_OR_NULL(client)) 10007b43dd19SAndy Shevchenko return; 1001e0638fa4SLixin Wang 1002e0638fa4SLixin Wang if (client->dev.of_node) { 100391ed5349SWolfram Sang of_node_clear_flag(client->dev.of_node, OF_POPULATED); 1004e0638fa4SLixin Wang of_node_put(client->dev.of_node); 1005e0638fa4SLixin Wang } 1006e0638fa4SLixin Wang 100791ed5349SWolfram Sang if (ACPI_COMPANION(&client->dev)) 100891ed5349SWolfram Sang acpi_device_clear_enumerated(ACPI_COMPANION(&client->dev)); 1009714638e0SHeikki Krogerus device_remove_software_node(&client->dev); 101091ed5349SWolfram Sang device_unregister(&client->dev); 101191ed5349SWolfram Sang } 101291ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_unregister_device); 101391ed5349SWolfram Sang 101491ed5349SWolfram Sang 101591ed5349SWolfram Sang static const struct i2c_device_id dummy_id[] = { 101691ed5349SWolfram Sang { "dummy", 0 }, 101791ed5349SWolfram Sang { }, 101891ed5349SWolfram Sang }; 101991ed5349SWolfram Sang 102091ed5349SWolfram Sang static int dummy_probe(struct i2c_client *client, 102191ed5349SWolfram Sang const struct i2c_device_id *id) 102291ed5349SWolfram Sang { 102391ed5349SWolfram Sang return 0; 102491ed5349SWolfram Sang } 102591ed5349SWolfram Sang 102691ed5349SWolfram Sang static struct i2c_driver dummy_driver = { 102791ed5349SWolfram Sang .driver.name = "dummy", 102891ed5349SWolfram Sang .probe = dummy_probe, 102991ed5349SWolfram Sang .id_table = dummy_id, 103091ed5349SWolfram Sang }; 103191ed5349SWolfram Sang 103291ed5349SWolfram Sang /** 10337159dbdaSHeiner Kallweit * i2c_new_dummy_device - return a new i2c device bound to a dummy driver 103491ed5349SWolfram Sang * @adapter: the adapter managing the device 103591ed5349SWolfram Sang * @address: seven bit address to be used 103691ed5349SWolfram Sang * Context: can sleep 103791ed5349SWolfram Sang * 103891ed5349SWolfram Sang * This returns an I2C client bound to the "dummy" driver, intended for use 103991ed5349SWolfram Sang * with devices that consume multiple addresses. Examples of such chips 104091ed5349SWolfram Sang * include various EEPROMS (like 24c04 and 24c08 models). 104191ed5349SWolfram Sang * 104291ed5349SWolfram Sang * These dummy devices have two main uses. First, most I2C and SMBus calls 104391ed5349SWolfram Sang * except i2c_transfer() need a client handle; the dummy will be that handle. 104491ed5349SWolfram Sang * And second, this prevents the specified address from being bound to a 104591ed5349SWolfram Sang * different driver. 104691ed5349SWolfram Sang * 104791ed5349SWolfram Sang * This returns the new i2c client, which should be saved for later use with 10487159dbdaSHeiner Kallweit * i2c_unregister_device(); or an ERR_PTR to describe the error. 104991ed5349SWolfram Sang */ 1050550113d4SWolfram Sang struct i2c_client *i2c_new_dummy_device(struct i2c_adapter *adapter, u16 address) 105191ed5349SWolfram Sang { 105291ed5349SWolfram Sang struct i2c_board_info info = { 105391ed5349SWolfram Sang I2C_BOARD_INFO("dummy", address), 105491ed5349SWolfram Sang }; 105591ed5349SWolfram Sang 10567159dbdaSHeiner Kallweit return i2c_new_client_device(adapter, &info); 10577159dbdaSHeiner Kallweit } 10587159dbdaSHeiner Kallweit EXPORT_SYMBOL_GPL(i2c_new_dummy_device); 10597159dbdaSHeiner Kallweit 1060bb7f086bSYicong Yang static void devm_i2c_release_dummy(void *client) 1061b8f5fe3bSHeiner Kallweit { 1062bb7f086bSYicong Yang i2c_unregister_device(client); 1063b8f5fe3bSHeiner Kallweit } 1064b8f5fe3bSHeiner Kallweit 1065b8f5fe3bSHeiner Kallweit /** 1066b8f5fe3bSHeiner Kallweit * devm_i2c_new_dummy_device - return a new i2c device bound to a dummy driver 1067b8f5fe3bSHeiner Kallweit * @dev: device the managed resource is bound to 1068b8f5fe3bSHeiner Kallweit * @adapter: the adapter managing the device 1069b8f5fe3bSHeiner Kallweit * @address: seven bit address to be used 1070b8f5fe3bSHeiner Kallweit * Context: can sleep 1071b8f5fe3bSHeiner Kallweit * 1072b8f5fe3bSHeiner Kallweit * This is the device-managed version of @i2c_new_dummy_device. It returns the 1073b8f5fe3bSHeiner Kallweit * new i2c client or an ERR_PTR in case of an error. 1074b8f5fe3bSHeiner Kallweit */ 1075b8f5fe3bSHeiner Kallweit struct i2c_client *devm_i2c_new_dummy_device(struct device *dev, 1076b8f5fe3bSHeiner Kallweit struct i2c_adapter *adapter, 1077b8f5fe3bSHeiner Kallweit u16 address) 1078b8f5fe3bSHeiner Kallweit { 1079b8f5fe3bSHeiner Kallweit struct i2c_client *client; 1080bb7f086bSYicong Yang int ret; 1081b8f5fe3bSHeiner Kallweit 1082b8f5fe3bSHeiner Kallweit client = i2c_new_dummy_device(adapter, address); 1083bb7f086bSYicong Yang if (IS_ERR(client)) 1084bb7f086bSYicong Yang return client; 1085bb7f086bSYicong Yang 1086bb7f086bSYicong Yang ret = devm_add_action_or_reset(dev, devm_i2c_release_dummy, client); 1087bb7f086bSYicong Yang if (ret) 1088bb7f086bSYicong Yang return ERR_PTR(ret); 1089b8f5fe3bSHeiner Kallweit 1090b8f5fe3bSHeiner Kallweit return client; 1091b8f5fe3bSHeiner Kallweit } 1092b8f5fe3bSHeiner Kallweit EXPORT_SYMBOL_GPL(devm_i2c_new_dummy_device); 1093b8f5fe3bSHeiner Kallweit 109491ed5349SWolfram Sang /** 1095af80559bSWolfram Sang * i2c_new_ancillary_device - Helper to get the instantiated secondary address 109691ed5349SWolfram Sang * and create the associated device 109791ed5349SWolfram Sang * @client: Handle to the primary client 109891ed5349SWolfram Sang * @name: Handle to specify which secondary address to get 109991ed5349SWolfram Sang * @default_addr: Used as a fallback if no secondary address was specified 110091ed5349SWolfram Sang * Context: can sleep 110191ed5349SWolfram Sang * 110291ed5349SWolfram Sang * I2C clients can be composed of multiple I2C slaves bound together in a single 110391ed5349SWolfram Sang * component. The I2C client driver then binds to the master I2C slave and needs 110491ed5349SWolfram Sang * to create I2C dummy clients to communicate with all the other slaves. 110591ed5349SWolfram Sang * 110691ed5349SWolfram Sang * This function creates and returns an I2C dummy client whose I2C address is 110791ed5349SWolfram Sang * retrieved from the platform firmware based on the given slave name. If no 110891ed5349SWolfram Sang * address is specified by the firmware default_addr is used. 110991ed5349SWolfram Sang * 111091ed5349SWolfram Sang * On DT-based platforms the address is retrieved from the "reg" property entry 111191ed5349SWolfram Sang * cell whose "reg-names" value matches the slave name. 111291ed5349SWolfram Sang * 111391ed5349SWolfram Sang * This returns the new i2c client, which should be saved for later use with 1114af80559bSWolfram Sang * i2c_unregister_device(); or an ERR_PTR to describe the error. 111591ed5349SWolfram Sang */ 1116af80559bSWolfram Sang struct i2c_client *i2c_new_ancillary_device(struct i2c_client *client, 111791ed5349SWolfram Sang const char *name, 111891ed5349SWolfram Sang u16 default_addr) 111991ed5349SWolfram Sang { 112091ed5349SWolfram Sang struct device_node *np = client->dev.of_node; 112191ed5349SWolfram Sang u32 addr = default_addr; 112291ed5349SWolfram Sang int i; 112391ed5349SWolfram Sang 112491ed5349SWolfram Sang if (np) { 112591ed5349SWolfram Sang i = of_property_match_string(np, "reg-names", name); 112691ed5349SWolfram Sang if (i >= 0) 112791ed5349SWolfram Sang of_property_read_u32_index(np, "reg", i, &addr); 112891ed5349SWolfram Sang } 112991ed5349SWolfram Sang 113091ed5349SWolfram Sang dev_dbg(&client->adapter->dev, "Address for %s : 0x%x\n", name, addr); 1131af80559bSWolfram Sang return i2c_new_dummy_device(client->adapter, addr); 113291ed5349SWolfram Sang } 1133af80559bSWolfram Sang EXPORT_SYMBOL_GPL(i2c_new_ancillary_device); 113491ed5349SWolfram Sang 113591ed5349SWolfram Sang /* ------------------------------------------------------------------------- */ 113691ed5349SWolfram Sang 113791ed5349SWolfram Sang /* I2C bus adapters -- one roots each I2C or SMBUS segment */ 113891ed5349SWolfram Sang 113991ed5349SWolfram Sang static void i2c_adapter_dev_release(struct device *dev) 114091ed5349SWolfram Sang { 114191ed5349SWolfram Sang struct i2c_adapter *adap = to_i2c_adapter(dev); 114291ed5349SWolfram Sang complete(&adap->dev_released); 114391ed5349SWolfram Sang } 114491ed5349SWolfram Sang 114591ed5349SWolfram Sang unsigned int i2c_adapter_depth(struct i2c_adapter *adapter) 114691ed5349SWolfram Sang { 114791ed5349SWolfram Sang unsigned int depth = 0; 114891ed5349SWolfram Sang 114991ed5349SWolfram Sang while ((adapter = i2c_parent_is_i2c_adapter(adapter))) 115091ed5349SWolfram Sang depth++; 115191ed5349SWolfram Sang 115291ed5349SWolfram Sang WARN_ONCE(depth >= MAX_LOCKDEP_SUBCLASSES, 115391ed5349SWolfram Sang "adapter depth exceeds lockdep subclass limit\n"); 115491ed5349SWolfram Sang 115591ed5349SWolfram Sang return depth; 115691ed5349SWolfram Sang } 115791ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_adapter_depth); 115891ed5349SWolfram Sang 115991ed5349SWolfram Sang /* 116091ed5349SWolfram Sang * Let users instantiate I2C devices through sysfs. This can be used when 116191ed5349SWolfram Sang * platform initialization code doesn't contain the proper data for 116291ed5349SWolfram Sang * whatever reason. Also useful for drivers that do device detection and 116391ed5349SWolfram Sang * detection fails, either because the device uses an unexpected address, 116491ed5349SWolfram Sang * or this is a compatible device with different ID register values. 116591ed5349SWolfram Sang * 116691ed5349SWolfram Sang * Parameter checking may look overzealous, but we really don't want 116791ed5349SWolfram Sang * the user to provide incorrect parameters. 116891ed5349SWolfram Sang */ 116991ed5349SWolfram Sang static ssize_t 117054a19fd4SGeert Uytterhoeven new_device_store(struct device *dev, struct device_attribute *attr, 117191ed5349SWolfram Sang const char *buf, size_t count) 117291ed5349SWolfram Sang { 117391ed5349SWolfram Sang struct i2c_adapter *adap = to_i2c_adapter(dev); 117491ed5349SWolfram Sang struct i2c_board_info info; 117591ed5349SWolfram Sang struct i2c_client *client; 117691ed5349SWolfram Sang char *blank, end; 117791ed5349SWolfram Sang int res; 117891ed5349SWolfram Sang 117991ed5349SWolfram Sang memset(&info, 0, sizeof(struct i2c_board_info)); 118091ed5349SWolfram Sang 118191ed5349SWolfram Sang blank = strchr(buf, ' '); 118291ed5349SWolfram Sang if (!blank) { 118391ed5349SWolfram Sang dev_err(dev, "%s: Missing parameters\n", "new_device"); 118491ed5349SWolfram Sang return -EINVAL; 118591ed5349SWolfram Sang } 118691ed5349SWolfram Sang if (blank - buf > I2C_NAME_SIZE - 1) { 118791ed5349SWolfram Sang dev_err(dev, "%s: Invalid device name\n", "new_device"); 118891ed5349SWolfram Sang return -EINVAL; 118991ed5349SWolfram Sang } 119091ed5349SWolfram Sang memcpy(info.type, buf, blank - buf); 119191ed5349SWolfram Sang 119291ed5349SWolfram Sang /* Parse remaining parameters, reject extra parameters */ 119391ed5349SWolfram Sang res = sscanf(++blank, "%hi%c", &info.addr, &end); 119491ed5349SWolfram Sang if (res < 1) { 119591ed5349SWolfram Sang dev_err(dev, "%s: Can't parse I2C address\n", "new_device"); 119691ed5349SWolfram Sang return -EINVAL; 119791ed5349SWolfram Sang } 119891ed5349SWolfram Sang if (res > 1 && end != '\n') { 119991ed5349SWolfram Sang dev_err(dev, "%s: Extra parameters\n", "new_device"); 120091ed5349SWolfram Sang return -EINVAL; 120191ed5349SWolfram Sang } 120291ed5349SWolfram Sang 120391ed5349SWolfram Sang if ((info.addr & I2C_ADDR_OFFSET_TEN_BIT) == I2C_ADDR_OFFSET_TEN_BIT) { 120491ed5349SWolfram Sang info.addr &= ~I2C_ADDR_OFFSET_TEN_BIT; 120591ed5349SWolfram Sang info.flags |= I2C_CLIENT_TEN; 120691ed5349SWolfram Sang } 120791ed5349SWolfram Sang 120891ed5349SWolfram Sang if (info.addr & I2C_ADDR_OFFSET_SLAVE) { 120991ed5349SWolfram Sang info.addr &= ~I2C_ADDR_OFFSET_SLAVE; 121091ed5349SWolfram Sang info.flags |= I2C_CLIENT_SLAVE; 121191ed5349SWolfram Sang } 121291ed5349SWolfram Sang 12137159dbdaSHeiner Kallweit client = i2c_new_client_device(adap, &info); 12147159dbdaSHeiner Kallweit if (IS_ERR(client)) 12157159dbdaSHeiner Kallweit return PTR_ERR(client); 121691ed5349SWolfram Sang 121791ed5349SWolfram Sang /* Keep track of the added device */ 121891ed5349SWolfram Sang mutex_lock(&adap->userspace_clients_lock); 121991ed5349SWolfram Sang list_add_tail(&client->detected, &adap->userspace_clients); 122091ed5349SWolfram Sang mutex_unlock(&adap->userspace_clients_lock); 122191ed5349SWolfram Sang dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device", 122291ed5349SWolfram Sang info.type, info.addr); 122391ed5349SWolfram Sang 122491ed5349SWolfram Sang return count; 122591ed5349SWolfram Sang } 122654a19fd4SGeert Uytterhoeven static DEVICE_ATTR_WO(new_device); 122791ed5349SWolfram Sang 122891ed5349SWolfram Sang /* 122991ed5349SWolfram Sang * And of course let the users delete the devices they instantiated, if 123091ed5349SWolfram Sang * they got it wrong. This interface can only be used to delete devices 123191ed5349SWolfram Sang * instantiated by i2c_sysfs_new_device above. This guarantees that we 123291ed5349SWolfram Sang * don't delete devices to which some kernel code still has references. 123391ed5349SWolfram Sang * 123491ed5349SWolfram Sang * Parameter checking may look overzealous, but we really don't want 123591ed5349SWolfram Sang * the user to delete the wrong device. 123691ed5349SWolfram Sang */ 123791ed5349SWolfram Sang static ssize_t 123854a19fd4SGeert Uytterhoeven delete_device_store(struct device *dev, struct device_attribute *attr, 123991ed5349SWolfram Sang const char *buf, size_t count) 124091ed5349SWolfram Sang { 124191ed5349SWolfram Sang struct i2c_adapter *adap = to_i2c_adapter(dev); 124291ed5349SWolfram Sang struct i2c_client *client, *next; 124391ed5349SWolfram Sang unsigned short addr; 124491ed5349SWolfram Sang char end; 124591ed5349SWolfram Sang int res; 124691ed5349SWolfram Sang 124791ed5349SWolfram Sang /* Parse parameters, reject extra parameters */ 124891ed5349SWolfram Sang res = sscanf(buf, "%hi%c", &addr, &end); 124991ed5349SWolfram Sang if (res < 1) { 125091ed5349SWolfram Sang dev_err(dev, "%s: Can't parse I2C address\n", "delete_device"); 125191ed5349SWolfram Sang return -EINVAL; 125291ed5349SWolfram Sang } 125391ed5349SWolfram Sang if (res > 1 && end != '\n') { 125491ed5349SWolfram Sang dev_err(dev, "%s: Extra parameters\n", "delete_device"); 125591ed5349SWolfram Sang return -EINVAL; 125691ed5349SWolfram Sang } 125791ed5349SWolfram Sang 125891ed5349SWolfram Sang /* Make sure the device was added through sysfs */ 125991ed5349SWolfram Sang res = -ENOENT; 126091ed5349SWolfram Sang mutex_lock_nested(&adap->userspace_clients_lock, 126191ed5349SWolfram Sang i2c_adapter_depth(adap)); 126291ed5349SWolfram Sang list_for_each_entry_safe(client, next, &adap->userspace_clients, 126391ed5349SWolfram Sang detected) { 126491ed5349SWolfram Sang if (i2c_encode_flags_to_addr(client) == addr) { 126591ed5349SWolfram Sang dev_info(dev, "%s: Deleting device %s at 0x%02hx\n", 126691ed5349SWolfram Sang "delete_device", client->name, client->addr); 126791ed5349SWolfram Sang 126891ed5349SWolfram Sang list_del(&client->detected); 126991ed5349SWolfram Sang i2c_unregister_device(client); 127091ed5349SWolfram Sang res = count; 127191ed5349SWolfram Sang break; 127291ed5349SWolfram Sang } 127391ed5349SWolfram Sang } 127491ed5349SWolfram Sang mutex_unlock(&adap->userspace_clients_lock); 127591ed5349SWolfram Sang 127691ed5349SWolfram Sang if (res < 0) 127791ed5349SWolfram Sang dev_err(dev, "%s: Can't find device in list\n", 127891ed5349SWolfram Sang "delete_device"); 127991ed5349SWolfram Sang return res; 128091ed5349SWolfram Sang } 128191ed5349SWolfram Sang static DEVICE_ATTR_IGNORE_LOCKDEP(delete_device, S_IWUSR, NULL, 128254a19fd4SGeert Uytterhoeven delete_device_store); 128391ed5349SWolfram Sang 128491ed5349SWolfram Sang static struct attribute *i2c_adapter_attrs[] = { 128591ed5349SWolfram Sang &dev_attr_name.attr, 128691ed5349SWolfram Sang &dev_attr_new_device.attr, 128791ed5349SWolfram Sang &dev_attr_delete_device.attr, 128891ed5349SWolfram Sang NULL 128991ed5349SWolfram Sang }; 129091ed5349SWolfram Sang ATTRIBUTE_GROUPS(i2c_adapter); 129191ed5349SWolfram Sang 129291ed5349SWolfram Sang struct device_type i2c_adapter_type = { 129391ed5349SWolfram Sang .groups = i2c_adapter_groups, 129491ed5349SWolfram Sang .release = i2c_adapter_dev_release, 129591ed5349SWolfram Sang }; 129691ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_adapter_type); 129791ed5349SWolfram Sang 129891ed5349SWolfram Sang /** 129991ed5349SWolfram Sang * i2c_verify_adapter - return parameter as i2c_adapter or NULL 130091ed5349SWolfram Sang * @dev: device, probably from some driver model iterator 130191ed5349SWolfram Sang * 130291ed5349SWolfram Sang * When traversing the driver model tree, perhaps using driver model 130391ed5349SWolfram Sang * iterators like @device_for_each_child(), you can't assume very much 130491ed5349SWolfram Sang * about the nodes you find. Use this function to avoid oopses caused 130591ed5349SWolfram Sang * by wrongly treating some non-I2C device as an i2c_adapter. 130691ed5349SWolfram Sang */ 130791ed5349SWolfram Sang struct i2c_adapter *i2c_verify_adapter(struct device *dev) 130891ed5349SWolfram Sang { 130991ed5349SWolfram Sang return (dev->type == &i2c_adapter_type) 131091ed5349SWolfram Sang ? to_i2c_adapter(dev) 131191ed5349SWolfram Sang : NULL; 131291ed5349SWolfram Sang } 131391ed5349SWolfram Sang EXPORT_SYMBOL(i2c_verify_adapter); 131491ed5349SWolfram Sang 131591ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 131691ed5349SWolfram Sang static struct class_compat *i2c_adapter_compat_class; 131791ed5349SWolfram Sang #endif 131891ed5349SWolfram Sang 131991ed5349SWolfram Sang static void i2c_scan_static_board_info(struct i2c_adapter *adapter) 132091ed5349SWolfram Sang { 132191ed5349SWolfram Sang struct i2c_devinfo *devinfo; 132291ed5349SWolfram Sang 132391ed5349SWolfram Sang down_read(&__i2c_board_lock); 132491ed5349SWolfram Sang list_for_each_entry(devinfo, &__i2c_board_list, list) { 132587e07437SWolfram Sang if (devinfo->busnum == adapter->nr && 132687e07437SWolfram Sang IS_ERR(i2c_new_client_device(adapter, &devinfo->board_info))) 132791ed5349SWolfram Sang dev_err(&adapter->dev, 132891ed5349SWolfram Sang "Can't create device at 0x%02x\n", 132991ed5349SWolfram Sang devinfo->board_info.addr); 133091ed5349SWolfram Sang } 133191ed5349SWolfram Sang up_read(&__i2c_board_lock); 133291ed5349SWolfram Sang } 133391ed5349SWolfram Sang 133491ed5349SWolfram Sang static int i2c_do_add_adapter(struct i2c_driver *driver, 133591ed5349SWolfram Sang struct i2c_adapter *adap) 133691ed5349SWolfram Sang { 133791ed5349SWolfram Sang /* Detect supported devices on that bus, and instantiate them */ 133891ed5349SWolfram Sang i2c_detect(adap, driver); 133991ed5349SWolfram Sang 134091ed5349SWolfram Sang return 0; 134191ed5349SWolfram Sang } 134291ed5349SWolfram Sang 134391ed5349SWolfram Sang static int __process_new_adapter(struct device_driver *d, void *data) 134491ed5349SWolfram Sang { 134591ed5349SWolfram Sang return i2c_do_add_adapter(to_i2c_driver(d), data); 134691ed5349SWolfram Sang } 134791ed5349SWolfram Sang 134891ed5349SWolfram Sang static const struct i2c_lock_operations i2c_adapter_lock_ops = { 134991ed5349SWolfram Sang .lock_bus = i2c_adapter_lock_bus, 135091ed5349SWolfram Sang .trylock_bus = i2c_adapter_trylock_bus, 135191ed5349SWolfram Sang .unlock_bus = i2c_adapter_unlock_bus, 135291ed5349SWolfram Sang }; 135391ed5349SWolfram Sang 135491ed5349SWolfram Sang static void i2c_host_notify_irq_teardown(struct i2c_adapter *adap) 135591ed5349SWolfram Sang { 135691ed5349SWolfram Sang struct irq_domain *domain = adap->host_notify_domain; 135791ed5349SWolfram Sang irq_hw_number_t hwirq; 135891ed5349SWolfram Sang 135991ed5349SWolfram Sang if (!domain) 136091ed5349SWolfram Sang return; 136191ed5349SWolfram Sang 136291ed5349SWolfram Sang for (hwirq = 0 ; hwirq < I2C_ADDR_7BITS_COUNT ; hwirq++) 136391ed5349SWolfram Sang irq_dispose_mapping(irq_find_mapping(domain, hwirq)); 136491ed5349SWolfram Sang 136591ed5349SWolfram Sang irq_domain_remove(domain); 136691ed5349SWolfram Sang adap->host_notify_domain = NULL; 136791ed5349SWolfram Sang } 136891ed5349SWolfram Sang 136991ed5349SWolfram Sang static int i2c_host_notify_irq_map(struct irq_domain *h, 137091ed5349SWolfram Sang unsigned int virq, 137191ed5349SWolfram Sang irq_hw_number_t hw_irq_num) 137291ed5349SWolfram Sang { 137391ed5349SWolfram Sang irq_set_chip_and_handler(virq, &dummy_irq_chip, handle_simple_irq); 137491ed5349SWolfram Sang 137591ed5349SWolfram Sang return 0; 137691ed5349SWolfram Sang } 137791ed5349SWolfram Sang 137891ed5349SWolfram Sang static const struct irq_domain_ops i2c_host_notify_irq_ops = { 137991ed5349SWolfram Sang .map = i2c_host_notify_irq_map, 138091ed5349SWolfram Sang }; 138191ed5349SWolfram Sang 138291ed5349SWolfram Sang static int i2c_setup_host_notify_irq_domain(struct i2c_adapter *adap) 138391ed5349SWolfram Sang { 138491ed5349SWolfram Sang struct irq_domain *domain; 138591ed5349SWolfram Sang 138691ed5349SWolfram Sang if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_HOST_NOTIFY)) 138791ed5349SWolfram Sang return 0; 138891ed5349SWolfram Sang 13898682dc12SWolfram Sang domain = irq_domain_create_linear(adap->dev.parent->fwnode, 139091ed5349SWolfram Sang I2C_ADDR_7BITS_COUNT, 139191ed5349SWolfram Sang &i2c_host_notify_irq_ops, adap); 139291ed5349SWolfram Sang if (!domain) 139391ed5349SWolfram Sang return -ENOMEM; 139491ed5349SWolfram Sang 139591ed5349SWolfram Sang adap->host_notify_domain = domain; 139691ed5349SWolfram Sang 139791ed5349SWolfram Sang return 0; 139891ed5349SWolfram Sang } 139991ed5349SWolfram Sang 140091ed5349SWolfram Sang /** 140191ed5349SWolfram Sang * i2c_handle_smbus_host_notify - Forward a Host Notify event to the correct 140291ed5349SWolfram Sang * I2C client. 140391ed5349SWolfram Sang * @adap: the adapter 140491ed5349SWolfram Sang * @addr: the I2C address of the notifying device 140591ed5349SWolfram Sang * Context: can't sleep 140691ed5349SWolfram Sang * 140791ed5349SWolfram Sang * Helper function to be called from an I2C bus driver's interrupt 140891ed5349SWolfram Sang * handler. It will schedule the Host Notify IRQ. 140991ed5349SWolfram Sang */ 141091ed5349SWolfram Sang int i2c_handle_smbus_host_notify(struct i2c_adapter *adap, unsigned short addr) 141191ed5349SWolfram Sang { 141291ed5349SWolfram Sang int irq; 141391ed5349SWolfram Sang 141491ed5349SWolfram Sang if (!adap) 141591ed5349SWolfram Sang return -EINVAL; 141691ed5349SWolfram Sang 141791ed5349SWolfram Sang irq = irq_find_mapping(adap->host_notify_domain, addr); 141891ed5349SWolfram Sang if (irq <= 0) 141991ed5349SWolfram Sang return -ENXIO; 142091ed5349SWolfram Sang 142168ea1b2cSSebastian Andrzej Siewior generic_handle_irq_safe(irq); 142291ed5349SWolfram Sang 142391ed5349SWolfram Sang return 0; 142491ed5349SWolfram Sang } 142591ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_handle_smbus_host_notify); 142691ed5349SWolfram Sang 142791ed5349SWolfram Sang static int i2c_register_adapter(struct i2c_adapter *adap) 142891ed5349SWolfram Sang { 142991ed5349SWolfram Sang int res = -EINVAL; 143091ed5349SWolfram Sang 143191ed5349SWolfram Sang /* Can't register until after driver model init */ 143291ed5349SWolfram Sang if (WARN_ON(!is_registered)) { 143391ed5349SWolfram Sang res = -EAGAIN; 143491ed5349SWolfram Sang goto out_list; 143591ed5349SWolfram Sang } 143691ed5349SWolfram Sang 143791ed5349SWolfram Sang /* Sanity checks */ 143891ed5349SWolfram Sang if (WARN(!adap->name[0], "i2c adapter has no name")) 143991ed5349SWolfram Sang goto out_list; 144091ed5349SWolfram Sang 144191ed5349SWolfram Sang if (!adap->algo) { 144291ed5349SWolfram Sang pr_err("adapter '%s': no algo supplied!\n", adap->name); 144391ed5349SWolfram Sang goto out_list; 144491ed5349SWolfram Sang } 144591ed5349SWolfram Sang 144691ed5349SWolfram Sang if (!adap->lock_ops) 144791ed5349SWolfram Sang adap->lock_ops = &i2c_adapter_lock_ops; 144891ed5349SWolfram Sang 14499ac6cb5fSWolfram Sang adap->locked_flags = 0; 145091ed5349SWolfram Sang rt_mutex_init(&adap->bus_lock); 145191ed5349SWolfram Sang rt_mutex_init(&adap->mux_lock); 145291ed5349SWolfram Sang mutex_init(&adap->userspace_clients_lock); 145391ed5349SWolfram Sang INIT_LIST_HEAD(&adap->userspace_clients); 145491ed5349SWolfram Sang 145591ed5349SWolfram Sang /* Set default timeout to 1 second if not already set */ 145691ed5349SWolfram Sang if (adap->timeout == 0) 145791ed5349SWolfram Sang adap->timeout = HZ; 145891ed5349SWolfram Sang 145991ed5349SWolfram Sang /* register soft irqs for Host Notify */ 146091ed5349SWolfram Sang res = i2c_setup_host_notify_irq_domain(adap); 146191ed5349SWolfram Sang if (res) { 146291ed5349SWolfram Sang pr_err("adapter '%s': can't create Host Notify IRQs (%d)\n", 146391ed5349SWolfram Sang adap->name, res); 146491ed5349SWolfram Sang goto out_list; 146591ed5349SWolfram Sang } 146691ed5349SWolfram Sang 146791ed5349SWolfram Sang dev_set_name(&adap->dev, "i2c-%d", adap->nr); 146891ed5349SWolfram Sang adap->dev.bus = &i2c_bus_type; 146991ed5349SWolfram Sang adap->dev.type = &i2c_adapter_type; 147091ed5349SWolfram Sang res = device_register(&adap->dev); 147191ed5349SWolfram Sang if (res) { 147291ed5349SWolfram Sang pr_err("adapter '%s': can't register device (%d)\n", adap->name, res); 147391ed5349SWolfram Sang goto out_list; 147491ed5349SWolfram Sang } 147591ed5349SWolfram Sang 1476a263a840SAkhil R res = i2c_setup_smbus_alert(adap); 1477f8756c67SPhil Reid if (res) 1478f8756c67SPhil Reid goto out_reg; 1479f8756c67SPhil Reid 1480d320ec7aSRajat Jain device_enable_async_suspend(&adap->dev); 148191ed5349SWolfram Sang pm_runtime_no_callbacks(&adap->dev); 148291ed5349SWolfram Sang pm_suspend_ignore_children(&adap->dev, true); 148391ed5349SWolfram Sang pm_runtime_enable(&adap->dev); 148491ed5349SWolfram Sang 148523a698feSCodrin Ciubotariu res = i2c_init_recovery(adap); 148623a698feSCodrin Ciubotariu if (res == -EPROBE_DEFER) 148723a698feSCodrin Ciubotariu goto out_reg; 148823a698feSCodrin Ciubotariu 148923a698feSCodrin Ciubotariu dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name); 149023a698feSCodrin Ciubotariu 149191ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 149291ed5349SWolfram Sang res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev, 149391ed5349SWolfram Sang adap->dev.parent); 149491ed5349SWolfram Sang if (res) 149591ed5349SWolfram Sang dev_warn(&adap->dev, 149691ed5349SWolfram Sang "Failed to create compatibility class link\n"); 149791ed5349SWolfram Sang #endif 149891ed5349SWolfram Sang 149991ed5349SWolfram Sang /* create pre-declared device nodes */ 150091ed5349SWolfram Sang of_i2c_register_devices(adap); 150191ed5349SWolfram Sang i2c_acpi_install_space_handler(adap); 150221653a41SHans de Goede i2c_acpi_register_devices(adap); 150391ed5349SWolfram Sang 150491ed5349SWolfram Sang if (adap->nr < __i2c_first_dynamic_bus_num) 150591ed5349SWolfram Sang i2c_scan_static_board_info(adap); 150691ed5349SWolfram Sang 150791ed5349SWolfram Sang /* Notify drivers */ 150891ed5349SWolfram Sang mutex_lock(&core_lock); 150991ed5349SWolfram Sang bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter); 151091ed5349SWolfram Sang mutex_unlock(&core_lock); 151191ed5349SWolfram Sang 151291ed5349SWolfram Sang return 0; 151391ed5349SWolfram Sang 1514f8756c67SPhil Reid out_reg: 1515f8756c67SPhil Reid init_completion(&adap->dev_released); 1516f8756c67SPhil Reid device_unregister(&adap->dev); 1517f8756c67SPhil Reid wait_for_completion(&adap->dev_released); 151891ed5349SWolfram Sang out_list: 151991ed5349SWolfram Sang mutex_lock(&core_lock); 152091ed5349SWolfram Sang idr_remove(&i2c_adapter_idr, adap->nr); 152191ed5349SWolfram Sang mutex_unlock(&core_lock); 152291ed5349SWolfram Sang return res; 152391ed5349SWolfram Sang } 152491ed5349SWolfram Sang 152591ed5349SWolfram Sang /** 152691ed5349SWolfram Sang * __i2c_add_numbered_adapter - i2c_add_numbered_adapter where nr is never -1 152791ed5349SWolfram Sang * @adap: the adapter to register (with adap->nr initialized) 152891ed5349SWolfram Sang * Context: can sleep 152991ed5349SWolfram Sang * 153091ed5349SWolfram Sang * See i2c_add_numbered_adapter() for details. 153191ed5349SWolfram Sang */ 153291ed5349SWolfram Sang static int __i2c_add_numbered_adapter(struct i2c_adapter *adap) 153391ed5349SWolfram Sang { 153491ed5349SWolfram Sang int id; 153591ed5349SWolfram Sang 153691ed5349SWolfram Sang mutex_lock(&core_lock); 153791ed5349SWolfram Sang id = idr_alloc(&i2c_adapter_idr, adap, adap->nr, adap->nr + 1, GFP_KERNEL); 153891ed5349SWolfram Sang mutex_unlock(&core_lock); 153991ed5349SWolfram Sang if (WARN(id < 0, "couldn't get idr")) 154091ed5349SWolfram Sang return id == -ENOSPC ? -EBUSY : id; 154191ed5349SWolfram Sang 154291ed5349SWolfram Sang return i2c_register_adapter(adap); 154391ed5349SWolfram Sang } 154491ed5349SWolfram Sang 154591ed5349SWolfram Sang /** 154691ed5349SWolfram Sang * i2c_add_adapter - declare i2c adapter, use dynamic bus number 154791ed5349SWolfram Sang * @adapter: the adapter to add 154891ed5349SWolfram Sang * Context: can sleep 154991ed5349SWolfram Sang * 155091ed5349SWolfram Sang * This routine is used to declare an I2C adapter when its bus number 155191ed5349SWolfram Sang * doesn't matter or when its bus number is specified by an dt alias. 155291ed5349SWolfram Sang * Examples of bases when the bus number doesn't matter: I2C adapters 155391ed5349SWolfram Sang * dynamically added by USB links or PCI plugin cards. 155491ed5349SWolfram Sang * 155591ed5349SWolfram Sang * When this returns zero, a new bus number was allocated and stored 155691ed5349SWolfram Sang * in adap->nr, and the specified adapter became available for clients. 155791ed5349SWolfram Sang * Otherwise, a negative errno value is returned. 155891ed5349SWolfram Sang */ 155991ed5349SWolfram Sang int i2c_add_adapter(struct i2c_adapter *adapter) 156091ed5349SWolfram Sang { 156191ed5349SWolfram Sang struct device *dev = &adapter->dev; 156291ed5349SWolfram Sang int id; 156391ed5349SWolfram Sang 156491ed5349SWolfram Sang if (dev->of_node) { 156591ed5349SWolfram Sang id = of_alias_get_id(dev->of_node, "i2c"); 156691ed5349SWolfram Sang if (id >= 0) { 156791ed5349SWolfram Sang adapter->nr = id; 156891ed5349SWolfram Sang return __i2c_add_numbered_adapter(adapter); 156991ed5349SWolfram Sang } 157091ed5349SWolfram Sang } 157191ed5349SWolfram Sang 157291ed5349SWolfram Sang mutex_lock(&core_lock); 157391ed5349SWolfram Sang id = idr_alloc(&i2c_adapter_idr, adapter, 157491ed5349SWolfram Sang __i2c_first_dynamic_bus_num, 0, GFP_KERNEL); 157591ed5349SWolfram Sang mutex_unlock(&core_lock); 157691ed5349SWolfram Sang if (WARN(id < 0, "couldn't get idr")) 157791ed5349SWolfram Sang return id; 157891ed5349SWolfram Sang 157991ed5349SWolfram Sang adapter->nr = id; 158091ed5349SWolfram Sang 158191ed5349SWolfram Sang return i2c_register_adapter(adapter); 158291ed5349SWolfram Sang } 158391ed5349SWolfram Sang EXPORT_SYMBOL(i2c_add_adapter); 158491ed5349SWolfram Sang 158591ed5349SWolfram Sang /** 158691ed5349SWolfram Sang * i2c_add_numbered_adapter - declare i2c adapter, use static bus number 158791ed5349SWolfram Sang * @adap: the adapter to register (with adap->nr initialized) 158891ed5349SWolfram Sang * Context: can sleep 158991ed5349SWolfram Sang * 159091ed5349SWolfram Sang * This routine is used to declare an I2C adapter when its bus number 159191ed5349SWolfram Sang * matters. For example, use it for I2C adapters from system-on-chip CPUs, 159291ed5349SWolfram Sang * or otherwise built in to the system's mainboard, and where i2c_board_info 159391ed5349SWolfram Sang * is used to properly configure I2C devices. 159491ed5349SWolfram Sang * 159591ed5349SWolfram Sang * If the requested bus number is set to -1, then this function will behave 159691ed5349SWolfram Sang * identically to i2c_add_adapter, and will dynamically assign a bus number. 159791ed5349SWolfram Sang * 159891ed5349SWolfram Sang * If no devices have pre-been declared for this bus, then be sure to 159991ed5349SWolfram Sang * register the adapter before any dynamically allocated ones. Otherwise 160091ed5349SWolfram Sang * the required bus ID may not be available. 160191ed5349SWolfram Sang * 160291ed5349SWolfram Sang * When this returns zero, the specified adapter became available for 160391ed5349SWolfram Sang * clients using the bus number provided in adap->nr. Also, the table 160491ed5349SWolfram Sang * of I2C devices pre-declared using i2c_register_board_info() is scanned, 160591ed5349SWolfram Sang * and the appropriate driver model device nodes are created. Otherwise, a 160691ed5349SWolfram Sang * negative errno value is returned. 160791ed5349SWolfram Sang */ 160891ed5349SWolfram Sang int i2c_add_numbered_adapter(struct i2c_adapter *adap) 160991ed5349SWolfram Sang { 161091ed5349SWolfram Sang if (adap->nr == -1) /* -1 means dynamically assign bus id */ 161191ed5349SWolfram Sang return i2c_add_adapter(adap); 161291ed5349SWolfram Sang 161391ed5349SWolfram Sang return __i2c_add_numbered_adapter(adap); 161491ed5349SWolfram Sang } 161591ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter); 161691ed5349SWolfram Sang 161791ed5349SWolfram Sang static void i2c_do_del_adapter(struct i2c_driver *driver, 161891ed5349SWolfram Sang struct i2c_adapter *adapter) 161991ed5349SWolfram Sang { 162091ed5349SWolfram Sang struct i2c_client *client, *_n; 162191ed5349SWolfram Sang 162291ed5349SWolfram Sang /* Remove the devices we created ourselves as the result of hardware 162391ed5349SWolfram Sang * probing (using a driver's detect method) */ 162491ed5349SWolfram Sang list_for_each_entry_safe(client, _n, &driver->clients, detected) { 162591ed5349SWolfram Sang if (client->adapter == adapter) { 162691ed5349SWolfram Sang dev_dbg(&adapter->dev, "Removing %s at 0x%x\n", 162791ed5349SWolfram Sang client->name, client->addr); 162891ed5349SWolfram Sang list_del(&client->detected); 162991ed5349SWolfram Sang i2c_unregister_device(client); 163091ed5349SWolfram Sang } 163191ed5349SWolfram Sang } 163291ed5349SWolfram Sang } 163391ed5349SWolfram Sang 163491ed5349SWolfram Sang static int __unregister_client(struct device *dev, void *dummy) 163591ed5349SWolfram Sang { 163691ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 163791ed5349SWolfram Sang if (client && strcmp(client->name, "dummy")) 163891ed5349SWolfram Sang i2c_unregister_device(client); 163991ed5349SWolfram Sang return 0; 164091ed5349SWolfram Sang } 164191ed5349SWolfram Sang 164291ed5349SWolfram Sang static int __unregister_dummy(struct device *dev, void *dummy) 164391ed5349SWolfram Sang { 164491ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 164591ed5349SWolfram Sang i2c_unregister_device(client); 164691ed5349SWolfram Sang return 0; 164791ed5349SWolfram Sang } 164891ed5349SWolfram Sang 164991ed5349SWolfram Sang static int __process_removed_adapter(struct device_driver *d, void *data) 165091ed5349SWolfram Sang { 165191ed5349SWolfram Sang i2c_do_del_adapter(to_i2c_driver(d), data); 165291ed5349SWolfram Sang return 0; 165391ed5349SWolfram Sang } 165491ed5349SWolfram Sang 165591ed5349SWolfram Sang /** 165691ed5349SWolfram Sang * i2c_del_adapter - unregister I2C adapter 165791ed5349SWolfram Sang * @adap: the adapter being unregistered 165891ed5349SWolfram Sang * Context: can sleep 165991ed5349SWolfram Sang * 166091ed5349SWolfram Sang * This unregisters an I2C adapter which was previously registered 166191ed5349SWolfram Sang * by @i2c_add_adapter or @i2c_add_numbered_adapter. 166291ed5349SWolfram Sang */ 166391ed5349SWolfram Sang void i2c_del_adapter(struct i2c_adapter *adap) 166491ed5349SWolfram Sang { 166591ed5349SWolfram Sang struct i2c_adapter *found; 166691ed5349SWolfram Sang struct i2c_client *client, *next; 166791ed5349SWolfram Sang 166891ed5349SWolfram Sang /* First make sure that this adapter was ever added */ 166991ed5349SWolfram Sang mutex_lock(&core_lock); 167091ed5349SWolfram Sang found = idr_find(&i2c_adapter_idr, adap->nr); 167191ed5349SWolfram Sang mutex_unlock(&core_lock); 167291ed5349SWolfram Sang if (found != adap) { 167391ed5349SWolfram Sang pr_debug("attempting to delete unregistered adapter [%s]\n", adap->name); 167491ed5349SWolfram Sang return; 167591ed5349SWolfram Sang } 167691ed5349SWolfram Sang 167791ed5349SWolfram Sang i2c_acpi_remove_space_handler(adap); 167891ed5349SWolfram Sang /* Tell drivers about this removal */ 167991ed5349SWolfram Sang mutex_lock(&core_lock); 168091ed5349SWolfram Sang bus_for_each_drv(&i2c_bus_type, NULL, adap, 168191ed5349SWolfram Sang __process_removed_adapter); 168291ed5349SWolfram Sang mutex_unlock(&core_lock); 168391ed5349SWolfram Sang 168491ed5349SWolfram Sang /* Remove devices instantiated from sysfs */ 168591ed5349SWolfram Sang mutex_lock_nested(&adap->userspace_clients_lock, 168691ed5349SWolfram Sang i2c_adapter_depth(adap)); 168791ed5349SWolfram Sang list_for_each_entry_safe(client, next, &adap->userspace_clients, 168891ed5349SWolfram Sang detected) { 168991ed5349SWolfram Sang dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name, 169091ed5349SWolfram Sang client->addr); 169191ed5349SWolfram Sang list_del(&client->detected); 169291ed5349SWolfram Sang i2c_unregister_device(client); 169391ed5349SWolfram Sang } 169491ed5349SWolfram Sang mutex_unlock(&adap->userspace_clients_lock); 169591ed5349SWolfram Sang 169691ed5349SWolfram Sang /* Detach any active clients. This can't fail, thus we do not 169791ed5349SWolfram Sang * check the returned value. This is a two-pass process, because 169891ed5349SWolfram Sang * we can't remove the dummy devices during the first pass: they 169991ed5349SWolfram Sang * could have been instantiated by real devices wishing to clean 170091ed5349SWolfram Sang * them up properly, so we give them a chance to do that first. */ 170191ed5349SWolfram Sang device_for_each_child(&adap->dev, NULL, __unregister_client); 170291ed5349SWolfram Sang device_for_each_child(&adap->dev, NULL, __unregister_dummy); 170391ed5349SWolfram Sang 170491ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 170591ed5349SWolfram Sang class_compat_remove_link(i2c_adapter_compat_class, &adap->dev, 170691ed5349SWolfram Sang adap->dev.parent); 170791ed5349SWolfram Sang #endif 170891ed5349SWolfram Sang 170991ed5349SWolfram Sang /* device name is gone after device_unregister */ 171091ed5349SWolfram Sang dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name); 171191ed5349SWolfram Sang 171291ed5349SWolfram Sang pm_runtime_disable(&adap->dev); 171391ed5349SWolfram Sang 171491ed5349SWolfram Sang i2c_host_notify_irq_teardown(adap); 171591ed5349SWolfram Sang 171691ed5349SWolfram Sang /* wait until all references to the device are gone 171791ed5349SWolfram Sang * 171891ed5349SWolfram Sang * FIXME: This is old code and should ideally be replaced by an 171991ed5349SWolfram Sang * alternative which results in decoupling the lifetime of the struct 172091ed5349SWolfram Sang * device from the i2c_adapter, like spi or netdev do. Any solution 172191ed5349SWolfram Sang * should be thoroughly tested with DEBUG_KOBJECT_RELEASE enabled! 172291ed5349SWolfram Sang */ 172391ed5349SWolfram Sang init_completion(&adap->dev_released); 172491ed5349SWolfram Sang device_unregister(&adap->dev); 172591ed5349SWolfram Sang wait_for_completion(&adap->dev_released); 172691ed5349SWolfram Sang 172791ed5349SWolfram Sang /* free bus id */ 172891ed5349SWolfram Sang mutex_lock(&core_lock); 172991ed5349SWolfram Sang idr_remove(&i2c_adapter_idr, adap->nr); 173091ed5349SWolfram Sang mutex_unlock(&core_lock); 173191ed5349SWolfram Sang 173291ed5349SWolfram Sang /* Clear the device structure in case this adapter is ever going to be 173391ed5349SWolfram Sang added again */ 173491ed5349SWolfram Sang memset(&adap->dev, 0, sizeof(adap->dev)); 173591ed5349SWolfram Sang } 173691ed5349SWolfram Sang EXPORT_SYMBOL(i2c_del_adapter); 173791ed5349SWolfram Sang 173807740c92SYicong Yang static void devm_i2c_del_adapter(void *adapter) 173907740c92SYicong Yang { 174007740c92SYicong Yang i2c_del_adapter(adapter); 174107740c92SYicong Yang } 174207740c92SYicong Yang 174307740c92SYicong Yang /** 174407740c92SYicong Yang * devm_i2c_add_adapter - device-managed variant of i2c_add_adapter() 174507740c92SYicong Yang * @dev: managing device for adding this I2C adapter 174607740c92SYicong Yang * @adapter: the adapter to add 174707740c92SYicong Yang * Context: can sleep 174807740c92SYicong Yang * 174907740c92SYicong Yang * Add adapter with dynamic bus number, same with i2c_add_adapter() 175007740c92SYicong Yang * but the adapter will be auto deleted on driver detach. 175107740c92SYicong Yang */ 175207740c92SYicong Yang int devm_i2c_add_adapter(struct device *dev, struct i2c_adapter *adapter) 175307740c92SYicong Yang { 175407740c92SYicong Yang int ret; 175507740c92SYicong Yang 175607740c92SYicong Yang ret = i2c_add_adapter(adapter); 175707740c92SYicong Yang if (ret) 175807740c92SYicong Yang return ret; 175907740c92SYicong Yang 176007740c92SYicong Yang return devm_add_action_or_reset(dev, devm_i2c_del_adapter, adapter); 176107740c92SYicong Yang } 176207740c92SYicong Yang EXPORT_SYMBOL_GPL(devm_i2c_add_adapter); 176307740c92SYicong Yang 1764def00b32SWolfram Sang static void i2c_parse_timing(struct device *dev, char *prop_name, u32 *cur_val_p, 1765def00b32SWolfram Sang u32 def_val, bool use_def) 1766def00b32SWolfram Sang { 1767def00b32SWolfram Sang int ret; 1768def00b32SWolfram Sang 1769def00b32SWolfram Sang ret = device_property_read_u32(dev, prop_name, cur_val_p); 1770def00b32SWolfram Sang if (ret && use_def) 1771def00b32SWolfram Sang *cur_val_p = def_val; 1772def00b32SWolfram Sang 1773def00b32SWolfram Sang dev_dbg(dev, "%s: %u\n", prop_name, *cur_val_p); 1774def00b32SWolfram Sang } 1775def00b32SWolfram Sang 177691ed5349SWolfram Sang /** 177791ed5349SWolfram Sang * i2c_parse_fw_timings - get I2C related timing parameters from firmware 177891ed5349SWolfram Sang * @dev: The device to scan for I2C timing properties 177991ed5349SWolfram Sang * @t: the i2c_timings struct to be filled with values 178091ed5349SWolfram Sang * @use_defaults: bool to use sane defaults derived from the I2C specification 1781263a5646SAndy Shevchenko * when properties are not found, otherwise don't update 178291ed5349SWolfram Sang * 178391ed5349SWolfram Sang * Scan the device for the generic I2C properties describing timing parameters 178491ed5349SWolfram Sang * for the signal and fill the given struct with the results. If a property was 178591ed5349SWolfram Sang * not found and use_defaults was true, then maximum timings are assumed which 178691ed5349SWolfram Sang * are derived from the I2C specification. If use_defaults is not used, the 1787263a5646SAndy Shevchenko * results will be as before, so drivers can apply their own defaults before 1788263a5646SAndy Shevchenko * calling this helper. The latter is mainly intended for avoiding regressions 1789263a5646SAndy Shevchenko * of existing drivers which want to switch to this function. New drivers 1790263a5646SAndy Shevchenko * almost always should use the defaults. 179191ed5349SWolfram Sang */ 179291ed5349SWolfram Sang void i2c_parse_fw_timings(struct device *dev, struct i2c_timings *t, bool use_defaults) 179391ed5349SWolfram Sang { 1794def00b32SWolfram Sang bool u = use_defaults; 1795def00b32SWolfram Sang u32 d; 179691ed5349SWolfram Sang 1797def00b32SWolfram Sang i2c_parse_timing(dev, "clock-frequency", &t->bus_freq_hz, 1798def00b32SWolfram Sang I2C_MAX_STANDARD_MODE_FREQ, u); 179991ed5349SWolfram Sang 1800def00b32SWolfram Sang d = t->bus_freq_hz <= I2C_MAX_STANDARD_MODE_FREQ ? 1000 : 1801def00b32SWolfram Sang t->bus_freq_hz <= I2C_MAX_FAST_MODE_FREQ ? 300 : 120; 1802def00b32SWolfram Sang i2c_parse_timing(dev, "i2c-scl-rising-time-ns", &t->scl_rise_ns, d, u); 180391ed5349SWolfram Sang 1804def00b32SWolfram Sang d = t->bus_freq_hz <= I2C_MAX_FAST_MODE_FREQ ? 300 : 120; 1805def00b32SWolfram Sang i2c_parse_timing(dev, "i2c-scl-falling-time-ns", &t->scl_fall_ns, d, u); 180691ed5349SWolfram Sang 1807def00b32SWolfram Sang i2c_parse_timing(dev, "i2c-scl-internal-delay-ns", 1808def00b32SWolfram Sang &t->scl_int_delay_ns, 0, u); 1809def00b32SWolfram Sang i2c_parse_timing(dev, "i2c-sda-falling-time-ns", &t->sda_fall_ns, 1810def00b32SWolfram Sang t->scl_fall_ns, u); 1811def00b32SWolfram Sang i2c_parse_timing(dev, "i2c-sda-hold-time-ns", &t->sda_hold_ns, 0, u); 1812def00b32SWolfram Sang i2c_parse_timing(dev, "i2c-digital-filter-width-ns", 1813def00b32SWolfram Sang &t->digital_filter_width_ns, 0, u); 1814def00b32SWolfram Sang i2c_parse_timing(dev, "i2c-analog-filter-cutoff-frequency", 1815def00b32SWolfram Sang &t->analog_filter_cutoff_freq_hz, 0, u); 181691ed5349SWolfram Sang } 181791ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_parse_fw_timings); 181891ed5349SWolfram Sang 181991ed5349SWolfram Sang /* ------------------------------------------------------------------------- */ 182091ed5349SWolfram Sang 1821edd7a563SWolfram Sang int i2c_for_each_dev(void *data, int (*fn)(struct device *dev, void *data)) 182291ed5349SWolfram Sang { 182391ed5349SWolfram Sang int res; 182491ed5349SWolfram Sang 182591ed5349SWolfram Sang mutex_lock(&core_lock); 182691ed5349SWolfram Sang res = bus_for_each_dev(&i2c_bus_type, NULL, data, fn); 182791ed5349SWolfram Sang mutex_unlock(&core_lock); 182891ed5349SWolfram Sang 182991ed5349SWolfram Sang return res; 183091ed5349SWolfram Sang } 183191ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_for_each_dev); 183291ed5349SWolfram Sang 183391ed5349SWolfram Sang static int __process_new_driver(struct device *dev, void *data) 183491ed5349SWolfram Sang { 183591ed5349SWolfram Sang if (dev->type != &i2c_adapter_type) 183691ed5349SWolfram Sang return 0; 183791ed5349SWolfram Sang return i2c_do_add_adapter(data, to_i2c_adapter(dev)); 183891ed5349SWolfram Sang } 183991ed5349SWolfram Sang 184091ed5349SWolfram Sang /* 184191ed5349SWolfram Sang * An i2c_driver is used with one or more i2c_client (device) nodes to access 184291ed5349SWolfram Sang * i2c slave chips, on a bus instance associated with some i2c_adapter. 184391ed5349SWolfram Sang */ 184491ed5349SWolfram Sang 184591ed5349SWolfram Sang int i2c_register_driver(struct module *owner, struct i2c_driver *driver) 184691ed5349SWolfram Sang { 184791ed5349SWolfram Sang int res; 184891ed5349SWolfram Sang 184991ed5349SWolfram Sang /* Can't register until after driver model init */ 185091ed5349SWolfram Sang if (WARN_ON(!is_registered)) 185191ed5349SWolfram Sang return -EAGAIN; 185291ed5349SWolfram Sang 185391ed5349SWolfram Sang /* add the driver to the list of i2c drivers in the driver core */ 185491ed5349SWolfram Sang driver->driver.owner = owner; 185591ed5349SWolfram Sang driver->driver.bus = &i2c_bus_type; 185691ed5349SWolfram Sang INIT_LIST_HEAD(&driver->clients); 185791ed5349SWolfram Sang 185891ed5349SWolfram Sang /* When registration returns, the driver core 185991ed5349SWolfram Sang * will have called probe() for all matching-but-unbound devices. 186091ed5349SWolfram Sang */ 186191ed5349SWolfram Sang res = driver_register(&driver->driver); 186291ed5349SWolfram Sang if (res) 186391ed5349SWolfram Sang return res; 186491ed5349SWolfram Sang 186591ed5349SWolfram Sang pr_debug("driver [%s] registered\n", driver->driver.name); 186691ed5349SWolfram Sang 186791ed5349SWolfram Sang /* Walk the adapters that are already present */ 186891ed5349SWolfram Sang i2c_for_each_dev(driver, __process_new_driver); 186991ed5349SWolfram Sang 187091ed5349SWolfram Sang return 0; 187191ed5349SWolfram Sang } 187291ed5349SWolfram Sang EXPORT_SYMBOL(i2c_register_driver); 187391ed5349SWolfram Sang 187491ed5349SWolfram Sang static int __process_removed_driver(struct device *dev, void *data) 187591ed5349SWolfram Sang { 187691ed5349SWolfram Sang if (dev->type == &i2c_adapter_type) 187791ed5349SWolfram Sang i2c_do_del_adapter(data, to_i2c_adapter(dev)); 187891ed5349SWolfram Sang return 0; 187991ed5349SWolfram Sang } 188091ed5349SWolfram Sang 188191ed5349SWolfram Sang /** 188291ed5349SWolfram Sang * i2c_del_driver - unregister I2C driver 188391ed5349SWolfram Sang * @driver: the driver being unregistered 188491ed5349SWolfram Sang * Context: can sleep 188591ed5349SWolfram Sang */ 188691ed5349SWolfram Sang void i2c_del_driver(struct i2c_driver *driver) 188791ed5349SWolfram Sang { 188891ed5349SWolfram Sang i2c_for_each_dev(driver, __process_removed_driver); 188991ed5349SWolfram Sang 189091ed5349SWolfram Sang driver_unregister(&driver->driver); 189191ed5349SWolfram Sang pr_debug("driver [%s] unregistered\n", driver->driver.name); 189291ed5349SWolfram Sang } 189391ed5349SWolfram Sang EXPORT_SYMBOL(i2c_del_driver); 189491ed5349SWolfram Sang 189591ed5349SWolfram Sang /* ------------------------------------------------------------------------- */ 189691ed5349SWolfram Sang 189791ed5349SWolfram Sang struct i2c_cmd_arg { 189891ed5349SWolfram Sang unsigned cmd; 189991ed5349SWolfram Sang void *arg; 190091ed5349SWolfram Sang }; 190191ed5349SWolfram Sang 190291ed5349SWolfram Sang static int i2c_cmd(struct device *dev, void *_arg) 190391ed5349SWolfram Sang { 190491ed5349SWolfram Sang struct i2c_client *client = i2c_verify_client(dev); 190591ed5349SWolfram Sang struct i2c_cmd_arg *arg = _arg; 190691ed5349SWolfram Sang struct i2c_driver *driver; 190791ed5349SWolfram Sang 190891ed5349SWolfram Sang if (!client || !client->dev.driver) 190991ed5349SWolfram Sang return 0; 191091ed5349SWolfram Sang 191191ed5349SWolfram Sang driver = to_i2c_driver(client->dev.driver); 191291ed5349SWolfram Sang if (driver->command) 191391ed5349SWolfram Sang driver->command(client, arg->cmd, arg->arg); 191491ed5349SWolfram Sang return 0; 191591ed5349SWolfram Sang } 191691ed5349SWolfram Sang 191791ed5349SWolfram Sang void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg) 191891ed5349SWolfram Sang { 191991ed5349SWolfram Sang struct i2c_cmd_arg cmd_arg; 192091ed5349SWolfram Sang 192191ed5349SWolfram Sang cmd_arg.cmd = cmd; 192291ed5349SWolfram Sang cmd_arg.arg = arg; 192391ed5349SWolfram Sang device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd); 192491ed5349SWolfram Sang } 192591ed5349SWolfram Sang EXPORT_SYMBOL(i2c_clients_command); 192691ed5349SWolfram Sang 192791ed5349SWolfram Sang static int __init i2c_init(void) 192891ed5349SWolfram Sang { 192991ed5349SWolfram Sang int retval; 193091ed5349SWolfram Sang 193191ed5349SWolfram Sang retval = of_alias_get_highest_id("i2c"); 193291ed5349SWolfram Sang 193391ed5349SWolfram Sang down_write(&__i2c_board_lock); 193491ed5349SWolfram Sang if (retval >= __i2c_first_dynamic_bus_num) 193591ed5349SWolfram Sang __i2c_first_dynamic_bus_num = retval + 1; 193691ed5349SWolfram Sang up_write(&__i2c_board_lock); 193791ed5349SWolfram Sang 193891ed5349SWolfram Sang retval = bus_register(&i2c_bus_type); 193991ed5349SWolfram Sang if (retval) 194091ed5349SWolfram Sang return retval; 194191ed5349SWolfram Sang 194291ed5349SWolfram Sang is_registered = true; 194391ed5349SWolfram Sang 194491ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 194591ed5349SWolfram Sang i2c_adapter_compat_class = class_compat_register("i2c-adapter"); 194691ed5349SWolfram Sang if (!i2c_adapter_compat_class) { 194791ed5349SWolfram Sang retval = -ENOMEM; 194891ed5349SWolfram Sang goto bus_err; 194991ed5349SWolfram Sang } 195091ed5349SWolfram Sang #endif 195191ed5349SWolfram Sang retval = i2c_add_driver(&dummy_driver); 195291ed5349SWolfram Sang if (retval) 195391ed5349SWolfram Sang goto class_err; 195491ed5349SWolfram Sang 195591ed5349SWolfram Sang if (IS_ENABLED(CONFIG_OF_DYNAMIC)) 195691ed5349SWolfram Sang WARN_ON(of_reconfig_notifier_register(&i2c_of_notifier)); 195791ed5349SWolfram Sang if (IS_ENABLED(CONFIG_ACPI)) 195891ed5349SWolfram Sang WARN_ON(acpi_reconfig_notifier_register(&i2c_acpi_notifier)); 195991ed5349SWolfram Sang 196091ed5349SWolfram Sang return 0; 196191ed5349SWolfram Sang 196291ed5349SWolfram Sang class_err: 196391ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 196491ed5349SWolfram Sang class_compat_unregister(i2c_adapter_compat_class); 196591ed5349SWolfram Sang bus_err: 196691ed5349SWolfram Sang #endif 196791ed5349SWolfram Sang is_registered = false; 196891ed5349SWolfram Sang bus_unregister(&i2c_bus_type); 196991ed5349SWolfram Sang return retval; 197091ed5349SWolfram Sang } 197191ed5349SWolfram Sang 197291ed5349SWolfram Sang static void __exit i2c_exit(void) 197391ed5349SWolfram Sang { 197491ed5349SWolfram Sang if (IS_ENABLED(CONFIG_ACPI)) 197591ed5349SWolfram Sang WARN_ON(acpi_reconfig_notifier_unregister(&i2c_acpi_notifier)); 197691ed5349SWolfram Sang if (IS_ENABLED(CONFIG_OF_DYNAMIC)) 197791ed5349SWolfram Sang WARN_ON(of_reconfig_notifier_unregister(&i2c_of_notifier)); 197891ed5349SWolfram Sang i2c_del_driver(&dummy_driver); 197991ed5349SWolfram Sang #ifdef CONFIG_I2C_COMPAT 198091ed5349SWolfram Sang class_compat_unregister(i2c_adapter_compat_class); 198191ed5349SWolfram Sang #endif 198291ed5349SWolfram Sang bus_unregister(&i2c_bus_type); 198391ed5349SWolfram Sang tracepoint_synchronize_unregister(); 198491ed5349SWolfram Sang } 198591ed5349SWolfram Sang 198691ed5349SWolfram Sang /* We must initialize early, because some subsystems register i2c drivers 198791ed5349SWolfram Sang * in subsys_initcall() code, but are linked (and initialized) before i2c. 198891ed5349SWolfram Sang */ 198991ed5349SWolfram Sang postcore_initcall(i2c_init); 199091ed5349SWolfram Sang module_exit(i2c_exit); 199191ed5349SWolfram Sang 199291ed5349SWolfram Sang /* ---------------------------------------------------- 199391ed5349SWolfram Sang * the functional interface to the i2c busses. 199491ed5349SWolfram Sang * ---------------------------------------------------- 199591ed5349SWolfram Sang */ 199691ed5349SWolfram Sang 199791ed5349SWolfram Sang /* Check if val is exceeding the quirk IFF quirk is non 0 */ 199891ed5349SWolfram Sang #define i2c_quirk_exceeded(val, quirk) ((quirk) && ((val) > (quirk))) 199991ed5349SWolfram Sang 200091ed5349SWolfram Sang static int i2c_quirk_error(struct i2c_adapter *adap, struct i2c_msg *msg, char *err_msg) 200191ed5349SWolfram Sang { 200291ed5349SWolfram Sang dev_err_ratelimited(&adap->dev, "adapter quirk: %s (addr 0x%04x, size %u, %s)\n", 200391ed5349SWolfram Sang err_msg, msg->addr, msg->len, 200491ed5349SWolfram Sang msg->flags & I2C_M_RD ? "read" : "write"); 200591ed5349SWolfram Sang return -EOPNOTSUPP; 200691ed5349SWolfram Sang } 200791ed5349SWolfram Sang 200891ed5349SWolfram Sang static int i2c_check_for_quirks(struct i2c_adapter *adap, struct i2c_msg *msgs, int num) 200991ed5349SWolfram Sang { 201091ed5349SWolfram Sang const struct i2c_adapter_quirks *q = adap->quirks; 201191ed5349SWolfram Sang int max_num = q->max_num_msgs, i; 201291ed5349SWolfram Sang bool do_len_check = true; 201391ed5349SWolfram Sang 201491ed5349SWolfram Sang if (q->flags & I2C_AQ_COMB) { 201591ed5349SWolfram Sang max_num = 2; 201691ed5349SWolfram Sang 201791ed5349SWolfram Sang /* special checks for combined messages */ 201891ed5349SWolfram Sang if (num == 2) { 201991ed5349SWolfram Sang if (q->flags & I2C_AQ_COMB_WRITE_FIRST && msgs[0].flags & I2C_M_RD) 202091ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[0], "1st comb msg must be write"); 202191ed5349SWolfram Sang 202291ed5349SWolfram Sang if (q->flags & I2C_AQ_COMB_READ_SECOND && !(msgs[1].flags & I2C_M_RD)) 202391ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[1], "2nd comb msg must be read"); 202491ed5349SWolfram Sang 202591ed5349SWolfram Sang if (q->flags & I2C_AQ_COMB_SAME_ADDR && msgs[0].addr != msgs[1].addr) 202691ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[0], "comb msg only to same addr"); 202791ed5349SWolfram Sang 202891ed5349SWolfram Sang if (i2c_quirk_exceeded(msgs[0].len, q->max_comb_1st_msg_len)) 202991ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[0], "msg too long"); 203091ed5349SWolfram Sang 203191ed5349SWolfram Sang if (i2c_quirk_exceeded(msgs[1].len, q->max_comb_2nd_msg_len)) 203291ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[1], "msg too long"); 203391ed5349SWolfram Sang 203491ed5349SWolfram Sang do_len_check = false; 203591ed5349SWolfram Sang } 203691ed5349SWolfram Sang } 203791ed5349SWolfram Sang 203891ed5349SWolfram Sang if (i2c_quirk_exceeded(num, max_num)) 203991ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[0], "too many messages"); 204091ed5349SWolfram Sang 204191ed5349SWolfram Sang for (i = 0; i < num; i++) { 204291ed5349SWolfram Sang u16 len = msgs[i].len; 204391ed5349SWolfram Sang 204491ed5349SWolfram Sang if (msgs[i].flags & I2C_M_RD) { 204591ed5349SWolfram Sang if (do_len_check && i2c_quirk_exceeded(len, q->max_read_len)) 204691ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[i], "msg too long"); 2047d9cfe2ceSWolfram Sang 2048d9cfe2ceSWolfram Sang if (q->flags & I2C_AQ_NO_ZERO_LEN_READ && len == 0) 2049d9cfe2ceSWolfram Sang return i2c_quirk_error(adap, &msgs[i], "no zero length"); 205091ed5349SWolfram Sang } else { 205191ed5349SWolfram Sang if (do_len_check && i2c_quirk_exceeded(len, q->max_write_len)) 205291ed5349SWolfram Sang return i2c_quirk_error(adap, &msgs[i], "msg too long"); 2053d9cfe2ceSWolfram Sang 2054d9cfe2ceSWolfram Sang if (q->flags & I2C_AQ_NO_ZERO_LEN_WRITE && len == 0) 2055d9cfe2ceSWolfram Sang return i2c_quirk_error(adap, &msgs[i], "no zero length"); 205691ed5349SWolfram Sang } 205791ed5349SWolfram Sang } 205891ed5349SWolfram Sang 205991ed5349SWolfram Sang return 0; 206091ed5349SWolfram Sang } 206191ed5349SWolfram Sang 206291ed5349SWolfram Sang /** 206391ed5349SWolfram Sang * __i2c_transfer - unlocked flavor of i2c_transfer 206491ed5349SWolfram Sang * @adap: Handle to I2C bus 206591ed5349SWolfram Sang * @msgs: One or more messages to execute before STOP is issued to 206691ed5349SWolfram Sang * terminate the operation; each message begins with a START. 206791ed5349SWolfram Sang * @num: Number of messages to be executed. 206891ed5349SWolfram Sang * 206991ed5349SWolfram Sang * Returns negative errno, else the number of messages executed. 207091ed5349SWolfram Sang * 207191ed5349SWolfram Sang * Adapter lock must be held when calling this function. No debug logging 207291ed5349SWolfram Sang * takes place. adap->algo->master_xfer existence isn't checked. 207391ed5349SWolfram Sang */ 207491ed5349SWolfram Sang int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num) 207591ed5349SWolfram Sang { 207691ed5349SWolfram Sang unsigned long orig_jiffies; 207791ed5349SWolfram Sang int ret, try; 207891ed5349SWolfram Sang 20791eace834SArd Biesheuvel if (WARN_ON(!msgs || num < 1)) 20801eace834SArd Biesheuvel return -EINVAL; 20815d756112SWolfram Sang 20825d756112SWolfram Sang ret = __i2c_check_suspended(adap); 20835d756112SWolfram Sang if (ret) 20845d756112SWolfram Sang return ret; 20851eace834SArd Biesheuvel 208691ed5349SWolfram Sang if (adap->quirks && i2c_check_for_quirks(adap, msgs, num)) 208791ed5349SWolfram Sang return -EOPNOTSUPP; 208891ed5349SWolfram Sang 208950888b01SDavidlohr Bueso /* 209050888b01SDavidlohr Bueso * i2c_trace_msg_key gets enabled when tracepoint i2c_transfer gets 209191ed5349SWolfram Sang * enabled. This is an efficient way of keeping the for-loop from 209291ed5349SWolfram Sang * being executed when not needed. 209391ed5349SWolfram Sang */ 209450888b01SDavidlohr Bueso if (static_branch_unlikely(&i2c_trace_msg_key)) { 209591ed5349SWolfram Sang int i; 209691ed5349SWolfram Sang for (i = 0; i < num; i++) 209791ed5349SWolfram Sang if (msgs[i].flags & I2C_M_RD) 209891ed5349SWolfram Sang trace_i2c_read(adap, &msgs[i], i); 209991ed5349SWolfram Sang else 210091ed5349SWolfram Sang trace_i2c_write(adap, &msgs[i], i); 210191ed5349SWolfram Sang } 210291ed5349SWolfram Sang 210391ed5349SWolfram Sang /* Retry automatically on arbitration loss */ 210491ed5349SWolfram Sang orig_jiffies = jiffies; 210591ed5349SWolfram Sang for (ret = 0, try = 0; try <= adap->retries; try++) { 210663b96983SWolfram Sang if (i2c_in_atomic_xfer_mode() && adap->algo->master_xfer_atomic) 210763b96983SWolfram Sang ret = adap->algo->master_xfer_atomic(adap, msgs, num); 210863b96983SWolfram Sang else 210991ed5349SWolfram Sang ret = adap->algo->master_xfer(adap, msgs, num); 211063b96983SWolfram Sang 211191ed5349SWolfram Sang if (ret != -EAGAIN) 211291ed5349SWolfram Sang break; 211391ed5349SWolfram Sang if (time_after(jiffies, orig_jiffies + adap->timeout)) 211491ed5349SWolfram Sang break; 211591ed5349SWolfram Sang } 211691ed5349SWolfram Sang 211750888b01SDavidlohr Bueso if (static_branch_unlikely(&i2c_trace_msg_key)) { 211891ed5349SWolfram Sang int i; 211991ed5349SWolfram Sang for (i = 0; i < ret; i++) 212091ed5349SWolfram Sang if (msgs[i].flags & I2C_M_RD) 212191ed5349SWolfram Sang trace_i2c_reply(adap, &msgs[i], i); 21224a3f7691SAhbong Chang trace_i2c_result(adap, num, ret); 212391ed5349SWolfram Sang } 212491ed5349SWolfram Sang 212591ed5349SWolfram Sang return ret; 212691ed5349SWolfram Sang } 212791ed5349SWolfram Sang EXPORT_SYMBOL(__i2c_transfer); 212891ed5349SWolfram Sang 212991ed5349SWolfram Sang /** 213091ed5349SWolfram Sang * i2c_transfer - execute a single or combined I2C message 213191ed5349SWolfram Sang * @adap: Handle to I2C bus 213291ed5349SWolfram Sang * @msgs: One or more messages to execute before STOP is issued to 213391ed5349SWolfram Sang * terminate the operation; each message begins with a START. 213491ed5349SWolfram Sang * @num: Number of messages to be executed. 213591ed5349SWolfram Sang * 213691ed5349SWolfram Sang * Returns negative errno, else the number of messages executed. 213791ed5349SWolfram Sang * 213891ed5349SWolfram Sang * Note that there is no requirement that each message be sent to 213991ed5349SWolfram Sang * the same slave address, although that is the most common model. 214091ed5349SWolfram Sang */ 214191ed5349SWolfram Sang int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num) 214291ed5349SWolfram Sang { 214391ed5349SWolfram Sang int ret; 214491ed5349SWolfram Sang 2145cc52612eSWolfram Sang if (!adap->algo->master_xfer) { 2146cc52612eSWolfram Sang dev_dbg(&adap->dev, "I2C level transfers not supported\n"); 2147cc52612eSWolfram Sang return -EOPNOTSUPP; 2148cc52612eSWolfram Sang } 2149cc52612eSWolfram Sang 215091ed5349SWolfram Sang /* REVISIT the fault reporting model here is weak: 215191ed5349SWolfram Sang * 215291ed5349SWolfram Sang * - When we get an error after receiving N bytes from a slave, 215391ed5349SWolfram Sang * there is no way to report "N". 215491ed5349SWolfram Sang * 215591ed5349SWolfram Sang * - When we get a NAK after transmitting N bytes to a slave, 215691ed5349SWolfram Sang * there is no way to report "N" ... or to let the master 215791ed5349SWolfram Sang * continue executing the rest of this combined message, if 215891ed5349SWolfram Sang * that's the appropriate response. 215991ed5349SWolfram Sang * 216091ed5349SWolfram Sang * - When for example "num" is two and we successfully complete 216191ed5349SWolfram Sang * the first message but get an error part way through the 216291ed5349SWolfram Sang * second, it's unclear whether that should be reported as 216391ed5349SWolfram Sang * one (discarding status on the second message) or errno 216491ed5349SWolfram Sang * (discarding status on the first one). 216591ed5349SWolfram Sang */ 216683c42212SWolfram Sang ret = __i2c_lock_bus_helper(adap); 216783c42212SWolfram Sang if (ret) 216883c42212SWolfram Sang return ret; 216991ed5349SWolfram Sang 217091ed5349SWolfram Sang ret = __i2c_transfer(adap, msgs, num); 217191ed5349SWolfram Sang i2c_unlock_bus(adap, I2C_LOCK_SEGMENT); 217291ed5349SWolfram Sang 217391ed5349SWolfram Sang return ret; 217491ed5349SWolfram Sang } 217591ed5349SWolfram Sang EXPORT_SYMBOL(i2c_transfer); 217691ed5349SWolfram Sang 217791ed5349SWolfram Sang /** 21788a91732bSWolfram Sang * i2c_transfer_buffer_flags - issue a single I2C message transferring data 21798a91732bSWolfram Sang * to/from a buffer 218091ed5349SWolfram Sang * @client: Handle to slave device 21818a91732bSWolfram Sang * @buf: Where the data is stored 21828a91732bSWolfram Sang * @count: How many bytes to transfer, must be less than 64k since msg.len is u16 21838a91732bSWolfram Sang * @flags: The flags to be used for the message, e.g. I2C_M_RD for reads 218491ed5349SWolfram Sang * 21858a91732bSWolfram Sang * Returns negative errno, or else the number of bytes transferred. 218691ed5349SWolfram Sang */ 21878a91732bSWolfram Sang int i2c_transfer_buffer_flags(const struct i2c_client *client, char *buf, 21888a91732bSWolfram Sang int count, u16 flags) 218991ed5349SWolfram Sang { 219091ed5349SWolfram Sang int ret; 21918a91732bSWolfram Sang struct i2c_msg msg = { 21928a91732bSWolfram Sang .addr = client->addr, 21938a91732bSWolfram Sang .flags = flags | (client->flags & I2C_M_TEN), 21948a91732bSWolfram Sang .len = count, 21958a91732bSWolfram Sang .buf = buf, 21968a91732bSWolfram Sang }; 219791ed5349SWolfram Sang 21988a91732bSWolfram Sang ret = i2c_transfer(client->adapter, &msg, 1); 219991ed5349SWolfram Sang 220091ed5349SWolfram Sang /* 22018a91732bSWolfram Sang * If everything went ok (i.e. 1 msg transferred), return #bytes 22028a91732bSWolfram Sang * transferred, else error code. 220391ed5349SWolfram Sang */ 220491ed5349SWolfram Sang return (ret == 1) ? count : ret; 220591ed5349SWolfram Sang } 22068a91732bSWolfram Sang EXPORT_SYMBOL(i2c_transfer_buffer_flags); 220791ed5349SWolfram Sang 2208dde67eb1SPeter Rosin /** 2209dde67eb1SPeter Rosin * i2c_get_device_id - get manufacturer, part id and die revision of a device 2210dde67eb1SPeter Rosin * @client: The device to query 2211dde67eb1SPeter Rosin * @id: The queried information 2212dde67eb1SPeter Rosin * 2213dde67eb1SPeter Rosin * Returns negative errno on error, zero on success. 2214dde67eb1SPeter Rosin */ 2215dde67eb1SPeter Rosin int i2c_get_device_id(const struct i2c_client *client, 2216dde67eb1SPeter Rosin struct i2c_device_identity *id) 2217dde67eb1SPeter Rosin { 2218dde67eb1SPeter Rosin struct i2c_adapter *adap = client->adapter; 2219dde67eb1SPeter Rosin union i2c_smbus_data raw_id; 2220dde67eb1SPeter Rosin int ret; 2221dde67eb1SPeter Rosin 2222dde67eb1SPeter Rosin if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_I2C_BLOCK)) 2223dde67eb1SPeter Rosin return -EOPNOTSUPP; 2224dde67eb1SPeter Rosin 2225dde67eb1SPeter Rosin raw_id.block[0] = 3; 2226dde67eb1SPeter Rosin ret = i2c_smbus_xfer(adap, I2C_ADDR_DEVICE_ID, 0, 2227dde67eb1SPeter Rosin I2C_SMBUS_READ, client->addr << 1, 2228dde67eb1SPeter Rosin I2C_SMBUS_I2C_BLOCK_DATA, &raw_id); 2229dde67eb1SPeter Rosin if (ret) 2230dde67eb1SPeter Rosin return ret; 2231dde67eb1SPeter Rosin 2232dde67eb1SPeter Rosin id->manufacturer_id = (raw_id.block[1] << 4) | (raw_id.block[2] >> 4); 2233dde67eb1SPeter Rosin id->part_id = ((raw_id.block[2] & 0xf) << 5) | (raw_id.block[3] >> 3); 2234dde67eb1SPeter Rosin id->die_revision = raw_id.block[3] & 0x7; 2235dde67eb1SPeter Rosin return 0; 2236dde67eb1SPeter Rosin } 2237dde67eb1SPeter Rosin EXPORT_SYMBOL_GPL(i2c_get_device_id); 2238dde67eb1SPeter Rosin 223991ed5349SWolfram Sang /* ---------------------------------------------------- 224091ed5349SWolfram Sang * the i2c address scanning function 224191ed5349SWolfram Sang * Will not work for 10-bit addresses! 224291ed5349SWolfram Sang * ---------------------------------------------------- 224391ed5349SWolfram Sang */ 224491ed5349SWolfram Sang 224591ed5349SWolfram Sang /* 224691ed5349SWolfram Sang * Legacy default probe function, mostly relevant for SMBus. The default 224791ed5349SWolfram Sang * probe method is a quick write, but it is known to corrupt the 24RF08 224891ed5349SWolfram Sang * EEPROMs due to a state machine bug, and could also irreversibly 224991ed5349SWolfram Sang * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f, 225091ed5349SWolfram Sang * we use a short byte read instead. Also, some bus drivers don't implement 225191ed5349SWolfram Sang * quick write, so we fallback to a byte read in that case too. 225291ed5349SWolfram Sang * On x86, there is another special case for FSC hardware monitoring chips, 225391ed5349SWolfram Sang * which want regular byte reads (address 0x73.) Fortunately, these are the 225491ed5349SWolfram Sang * only known chips using this I2C address on PC hardware. 225591ed5349SWolfram Sang * Returns 1 if probe succeeded, 0 if not. 225691ed5349SWolfram Sang */ 225791ed5349SWolfram Sang static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr) 225891ed5349SWolfram Sang { 225991ed5349SWolfram Sang int err; 226091ed5349SWolfram Sang union i2c_smbus_data dummy; 226191ed5349SWolfram Sang 226291ed5349SWolfram Sang #ifdef CONFIG_X86 226391ed5349SWolfram Sang if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON) 226491ed5349SWolfram Sang && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA)) 226591ed5349SWolfram Sang err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0, 226691ed5349SWolfram Sang I2C_SMBUS_BYTE_DATA, &dummy); 226791ed5349SWolfram Sang else 226891ed5349SWolfram Sang #endif 226991ed5349SWolfram Sang if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50) 227091ed5349SWolfram Sang && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK)) 227191ed5349SWolfram Sang err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0, 227291ed5349SWolfram Sang I2C_SMBUS_QUICK, NULL); 227391ed5349SWolfram Sang else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE)) 227491ed5349SWolfram Sang err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0, 227591ed5349SWolfram Sang I2C_SMBUS_BYTE, &dummy); 227691ed5349SWolfram Sang else { 227791ed5349SWolfram Sang dev_warn(&adap->dev, "No suitable probing method supported for address 0x%02X\n", 227891ed5349SWolfram Sang addr); 227991ed5349SWolfram Sang err = -EOPNOTSUPP; 228091ed5349SWolfram Sang } 228191ed5349SWolfram Sang 228291ed5349SWolfram Sang return err >= 0; 228391ed5349SWolfram Sang } 228491ed5349SWolfram Sang 228591ed5349SWolfram Sang static int i2c_detect_address(struct i2c_client *temp_client, 228691ed5349SWolfram Sang struct i2c_driver *driver) 228791ed5349SWolfram Sang { 228891ed5349SWolfram Sang struct i2c_board_info info; 228991ed5349SWolfram Sang struct i2c_adapter *adapter = temp_client->adapter; 229091ed5349SWolfram Sang int addr = temp_client->addr; 229191ed5349SWolfram Sang int err; 229291ed5349SWolfram Sang 229391ed5349SWolfram Sang /* Make sure the address is valid */ 229491ed5349SWolfram Sang err = i2c_check_7bit_addr_validity_strict(addr); 229591ed5349SWolfram Sang if (err) { 229691ed5349SWolfram Sang dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n", 229791ed5349SWolfram Sang addr); 229891ed5349SWolfram Sang return err; 229991ed5349SWolfram Sang } 230091ed5349SWolfram Sang 230191ed5349SWolfram Sang /* Skip if already in use (7 bit, no need to encode flags) */ 230291ed5349SWolfram Sang if (i2c_check_addr_busy(adapter, addr)) 230391ed5349SWolfram Sang return 0; 230491ed5349SWolfram Sang 230591ed5349SWolfram Sang /* Make sure there is something at this address */ 230691ed5349SWolfram Sang if (!i2c_default_probe(adapter, addr)) 230791ed5349SWolfram Sang return 0; 230891ed5349SWolfram Sang 230991ed5349SWolfram Sang /* Finally call the custom detection function */ 231091ed5349SWolfram Sang memset(&info, 0, sizeof(struct i2c_board_info)); 231191ed5349SWolfram Sang info.addr = addr; 231291ed5349SWolfram Sang err = driver->detect(temp_client, &info); 231391ed5349SWolfram Sang if (err) { 231491ed5349SWolfram Sang /* -ENODEV is returned if the detection fails. We catch it 231591ed5349SWolfram Sang here as this isn't an error. */ 231691ed5349SWolfram Sang return err == -ENODEV ? 0 : err; 231791ed5349SWolfram Sang } 231891ed5349SWolfram Sang 231991ed5349SWolfram Sang /* Consistency check */ 232091ed5349SWolfram Sang if (info.type[0] == '\0') { 232191ed5349SWolfram Sang dev_err(&adapter->dev, 232291ed5349SWolfram Sang "%s detection function provided no name for 0x%x\n", 232391ed5349SWolfram Sang driver->driver.name, addr); 232491ed5349SWolfram Sang } else { 232591ed5349SWolfram Sang struct i2c_client *client; 232691ed5349SWolfram Sang 232791ed5349SWolfram Sang /* Detection succeeded, instantiate the device */ 232891ed5349SWolfram Sang if (adapter->class & I2C_CLASS_DEPRECATED) 232991ed5349SWolfram Sang dev_warn(&adapter->dev, 233091ed5349SWolfram Sang "This adapter will soon drop class based instantiation of devices. " 233191ed5349SWolfram Sang "Please make sure client 0x%02x gets instantiated by other means. " 2332ccf988b6SMauro Carvalho Chehab "Check 'Documentation/i2c/instantiating-devices.rst' for details.\n", 233391ed5349SWolfram Sang info.addr); 233491ed5349SWolfram Sang 233591ed5349SWolfram Sang dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n", 233691ed5349SWolfram Sang info.type, info.addr); 233787e07437SWolfram Sang client = i2c_new_client_device(adapter, &info); 233887e07437SWolfram Sang if (!IS_ERR(client)) 233991ed5349SWolfram Sang list_add_tail(&client->detected, &driver->clients); 234091ed5349SWolfram Sang else 234191ed5349SWolfram Sang dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n", 234291ed5349SWolfram Sang info.type, info.addr); 234391ed5349SWolfram Sang } 234491ed5349SWolfram Sang return 0; 234591ed5349SWolfram Sang } 234691ed5349SWolfram Sang 234791ed5349SWolfram Sang static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver) 234891ed5349SWolfram Sang { 234991ed5349SWolfram Sang const unsigned short *address_list; 235091ed5349SWolfram Sang struct i2c_client *temp_client; 235191ed5349SWolfram Sang int i, err = 0; 235291ed5349SWolfram Sang 235391ed5349SWolfram Sang address_list = driver->address_list; 235491ed5349SWolfram Sang if (!driver->detect || !address_list) 235591ed5349SWolfram Sang return 0; 235691ed5349SWolfram Sang 235791ed5349SWolfram Sang /* Warn that the adapter lost class based instantiation */ 235891ed5349SWolfram Sang if (adapter->class == I2C_CLASS_DEPRECATED) { 235991ed5349SWolfram Sang dev_dbg(&adapter->dev, 236091ed5349SWolfram Sang "This adapter dropped support for I2C classes and won't auto-detect %s devices anymore. " 2361ccf988b6SMauro Carvalho Chehab "If you need it, check 'Documentation/i2c/instantiating-devices.rst' for alternatives.\n", 236291ed5349SWolfram Sang driver->driver.name); 236391ed5349SWolfram Sang return 0; 236491ed5349SWolfram Sang } 236591ed5349SWolfram Sang 236691ed5349SWolfram Sang /* Stop here if the classes do not match */ 236791ed5349SWolfram Sang if (!(adapter->class & driver->class)) 236891ed5349SWolfram Sang return 0; 236991ed5349SWolfram Sang 237091ed5349SWolfram Sang /* Set up a temporary client to help detect callback */ 237191ed5349SWolfram Sang temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL); 237291ed5349SWolfram Sang if (!temp_client) 237391ed5349SWolfram Sang return -ENOMEM; 237491ed5349SWolfram Sang temp_client->adapter = adapter; 237591ed5349SWolfram Sang 237691ed5349SWolfram Sang for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) { 237791ed5349SWolfram Sang dev_dbg(&adapter->dev, 237891ed5349SWolfram Sang "found normal entry for adapter %d, addr 0x%02x\n", 2379dd4f2ca9SWolfram Sang i2c_adapter_id(adapter), address_list[i]); 238091ed5349SWolfram Sang temp_client->addr = address_list[i]; 238191ed5349SWolfram Sang err = i2c_detect_address(temp_client, driver); 238291ed5349SWolfram Sang if (unlikely(err)) 238391ed5349SWolfram Sang break; 238491ed5349SWolfram Sang } 238591ed5349SWolfram Sang 238691ed5349SWolfram Sang kfree(temp_client); 238791ed5349SWolfram Sang return err; 238891ed5349SWolfram Sang } 238991ed5349SWolfram Sang 239091ed5349SWolfram Sang int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr) 239191ed5349SWolfram Sang { 239291ed5349SWolfram Sang return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0, 239391ed5349SWolfram Sang I2C_SMBUS_QUICK, NULL) >= 0; 239491ed5349SWolfram Sang } 239591ed5349SWolfram Sang EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read); 239691ed5349SWolfram Sang 239791ed5349SWolfram Sang struct i2c_client * 2398c1d08475SWolfram Sang i2c_new_scanned_device(struct i2c_adapter *adap, 239991ed5349SWolfram Sang struct i2c_board_info *info, 240091ed5349SWolfram Sang unsigned short const *addr_list, 2401edd7a563SWolfram Sang int (*probe)(struct i2c_adapter *adap, unsigned short addr)) 240291ed5349SWolfram Sang { 240391ed5349SWolfram Sang int i; 240491ed5349SWolfram Sang 240591ed5349SWolfram Sang if (!probe) 240691ed5349SWolfram Sang probe = i2c_default_probe; 240791ed5349SWolfram Sang 240891ed5349SWolfram Sang for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) { 240991ed5349SWolfram Sang /* Check address validity */ 241091ed5349SWolfram Sang if (i2c_check_7bit_addr_validity_strict(addr_list[i]) < 0) { 241191ed5349SWolfram Sang dev_warn(&adap->dev, "Invalid 7-bit address 0x%02x\n", 241291ed5349SWolfram Sang addr_list[i]); 241391ed5349SWolfram Sang continue; 241491ed5349SWolfram Sang } 241591ed5349SWolfram Sang 241691ed5349SWolfram Sang /* Check address availability (7 bit, no need to encode flags) */ 241791ed5349SWolfram Sang if (i2c_check_addr_busy(adap, addr_list[i])) { 241891ed5349SWolfram Sang dev_dbg(&adap->dev, 241991ed5349SWolfram Sang "Address 0x%02x already in use, not probing\n", 242091ed5349SWolfram Sang addr_list[i]); 242191ed5349SWolfram Sang continue; 242291ed5349SWolfram Sang } 242391ed5349SWolfram Sang 242491ed5349SWolfram Sang /* Test address responsiveness */ 242591ed5349SWolfram Sang if (probe(adap, addr_list[i])) 242691ed5349SWolfram Sang break; 242791ed5349SWolfram Sang } 242891ed5349SWolfram Sang 242991ed5349SWolfram Sang if (addr_list[i] == I2C_CLIENT_END) { 243091ed5349SWolfram Sang dev_dbg(&adap->dev, "Probing failed, no device found\n"); 2431c1d08475SWolfram Sang return ERR_PTR(-ENODEV); 243291ed5349SWolfram Sang } 243391ed5349SWolfram Sang 243491ed5349SWolfram Sang info->addr = addr_list[i]; 2435c1d08475SWolfram Sang return i2c_new_client_device(adap, info); 2436c1d08475SWolfram Sang } 2437c1d08475SWolfram Sang EXPORT_SYMBOL_GPL(i2c_new_scanned_device); 2438c1d08475SWolfram Sang 243991ed5349SWolfram Sang struct i2c_adapter *i2c_get_adapter(int nr) 244091ed5349SWolfram Sang { 244191ed5349SWolfram Sang struct i2c_adapter *adapter; 244291ed5349SWolfram Sang 244391ed5349SWolfram Sang mutex_lock(&core_lock); 244491ed5349SWolfram Sang adapter = idr_find(&i2c_adapter_idr, nr); 244591ed5349SWolfram Sang if (!adapter) 244691ed5349SWolfram Sang goto exit; 244791ed5349SWolfram Sang 244891ed5349SWolfram Sang if (try_module_get(adapter->owner)) 244991ed5349SWolfram Sang get_device(&adapter->dev); 245091ed5349SWolfram Sang else 245191ed5349SWolfram Sang adapter = NULL; 245291ed5349SWolfram Sang 245391ed5349SWolfram Sang exit: 245491ed5349SWolfram Sang mutex_unlock(&core_lock); 245591ed5349SWolfram Sang return adapter; 245691ed5349SWolfram Sang } 245791ed5349SWolfram Sang EXPORT_SYMBOL(i2c_get_adapter); 245891ed5349SWolfram Sang 245991ed5349SWolfram Sang void i2c_put_adapter(struct i2c_adapter *adap) 246091ed5349SWolfram Sang { 246191ed5349SWolfram Sang if (!adap) 246291ed5349SWolfram Sang return; 246391ed5349SWolfram Sang 246491ed5349SWolfram Sang module_put(adap->owner); 2465*e4c72c06SXu Wang /* Should be last, otherwise we risk use-after-free with 'adap' */ 2466*e4c72c06SXu Wang put_device(&adap->dev); 246791ed5349SWolfram Sang } 246891ed5349SWolfram Sang EXPORT_SYMBOL(i2c_put_adapter); 246991ed5349SWolfram Sang 2470e94bc5d1SWolfram Sang /** 2471e94bc5d1SWolfram Sang * i2c_get_dma_safe_msg_buf() - get a DMA safe buffer for the given i2c_msg 2472e94bc5d1SWolfram Sang * @msg: the message to be checked 2473bf263c35SWolfram Sang * @threshold: the minimum number of bytes for which using DMA makes sense. 2474bf263c35SWolfram Sang * Should at least be 1. 2475e94bc5d1SWolfram Sang * 2476e94bc5d1SWolfram Sang * Return: NULL if a DMA safe buffer was not obtained. Use msg->buf with PIO. 2477e94bc5d1SWolfram Sang * Or a valid pointer to be used with DMA. After use, release it by 247834d1b82cSStephen Boyd * calling i2c_put_dma_safe_msg_buf(). 2479e94bc5d1SWolfram Sang * 2480e94bc5d1SWolfram Sang * This function must only be called from process context! 2481e94bc5d1SWolfram Sang */ 2482e94bc5d1SWolfram Sang u8 *i2c_get_dma_safe_msg_buf(struct i2c_msg *msg, unsigned int threshold) 2483e94bc5d1SWolfram Sang { 2484bf263c35SWolfram Sang /* also skip 0-length msgs for bogus thresholds of 0 */ 2485bf263c35SWolfram Sang if (!threshold) 2486bf263c35SWolfram Sang pr_debug("DMA buffer for addr=0x%02x with length 0 is bogus\n", 2487bf263c35SWolfram Sang msg->addr); 2488bf263c35SWolfram Sang if (msg->len < threshold || msg->len == 0) 2489e94bc5d1SWolfram Sang return NULL; 2490e94bc5d1SWolfram Sang 2491e94bc5d1SWolfram Sang if (msg->flags & I2C_M_DMA_SAFE) 2492e94bc5d1SWolfram Sang return msg->buf; 2493e94bc5d1SWolfram Sang 2494e94bc5d1SWolfram Sang pr_debug("using bounce buffer for addr=0x%02x, len=%d\n", 2495e94bc5d1SWolfram Sang msg->addr, msg->len); 2496e94bc5d1SWolfram Sang 2497e94bc5d1SWolfram Sang if (msg->flags & I2C_M_RD) 2498e94bc5d1SWolfram Sang return kzalloc(msg->len, GFP_KERNEL); 2499e94bc5d1SWolfram Sang else 2500e94bc5d1SWolfram Sang return kmemdup(msg->buf, msg->len, GFP_KERNEL); 2501e94bc5d1SWolfram Sang } 2502e94bc5d1SWolfram Sang EXPORT_SYMBOL_GPL(i2c_get_dma_safe_msg_buf); 2503e94bc5d1SWolfram Sang 2504e94bc5d1SWolfram Sang /** 250582fe39a6SWolfram Sang * i2c_put_dma_safe_msg_buf - release DMA safe buffer and sync with i2c_msg 2506e94bc5d1SWolfram Sang * @buf: the buffer obtained from i2c_get_dma_safe_msg_buf(). May be NULL. 250782fe39a6SWolfram Sang * @msg: the message which the buffer corresponds to 250882fe39a6SWolfram Sang * @xferred: bool saying if the message was transferred 2509e94bc5d1SWolfram Sang */ 251082fe39a6SWolfram Sang void i2c_put_dma_safe_msg_buf(u8 *buf, struct i2c_msg *msg, bool xferred) 2511e94bc5d1SWolfram Sang { 2512e94bc5d1SWolfram Sang if (!buf || buf == msg->buf) 2513e94bc5d1SWolfram Sang return; 2514e94bc5d1SWolfram Sang 251582fe39a6SWolfram Sang if (xferred && msg->flags & I2C_M_RD) 2516e94bc5d1SWolfram Sang memcpy(msg->buf, buf, msg->len); 2517e94bc5d1SWolfram Sang 2518e94bc5d1SWolfram Sang kfree(buf); 2519e94bc5d1SWolfram Sang } 252082fe39a6SWolfram Sang EXPORT_SYMBOL_GPL(i2c_put_dma_safe_msg_buf); 2521e94bc5d1SWolfram Sang 252291ed5349SWolfram Sang MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>"); 252391ed5349SWolfram Sang MODULE_DESCRIPTION("I2C-Bus main module"); 252491ed5349SWolfram Sang MODULE_LICENSE("GPL"); 2525