i2c-core-base.c 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314
  1. /*
  2. * Linux I2C core
  3. *
  4. * Copyright (C) 1995-99 Simon G. Vogl
  5. * With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi>
  6. * Mux support by Rodolfo Giometti <giometti@enneenne.com> and
  7. * Michael Lawnick <michael.lawnick.ext@nsn.com>
  8. *
  9. * Copyright (C) 2013-2017 Wolfram Sang <wsa@the-dreams.de>
  10. *
  11. * This program is free software; you can redistribute it and/or modify it
  12. * under the terms of the GNU General Public License as published by the Free
  13. * Software Foundation; either version 2 of the License, or (at your option)
  14. * any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful, but WITHOUT
  17. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  18. * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  19. */
  20. #define pr_fmt(fmt) "i2c-core: " fmt
  21. #include <dt-bindings/i2c/i2c.h>
  22. #include <linux/acpi.h>
  23. #include <linux/clk/clk-conf.h>
  24. #include <linux/completion.h>
  25. #include <linux/delay.h>
  26. #include <linux/err.h>
  27. #include <linux/errno.h>
  28. #include <linux/gpio/consumer.h>
  29. #include <linux/i2c.h>
  30. #include <linux/i2c-smbus.h>
  31. #include <linux/idr.h>
  32. #include <linux/init.h>
  33. #include <linux/irqflags.h>
  34. #include <linux/jump_label.h>
  35. #include <linux/kernel.h>
  36. #include <linux/module.h>
  37. #include <linux/mutex.h>
  38. #include <linux/of_device.h>
  39. #include <linux/of.h>
  40. #include <linux/of_irq.h>
  41. #include <linux/pm_domain.h>
  42. #include <linux/pm_runtime.h>
  43. #include <linux/pm_wakeirq.h>
  44. #include <linux/property.h>
  45. #include <linux/rwsem.h>
  46. #include <linux/slab.h>
  47. #include "i2c-core.h"
  48. #define CREATE_TRACE_POINTS
  49. #include <trace/events/i2c.h>
  50. #define I2C_ADDR_OFFSET_TEN_BIT 0xa000
  51. #define I2C_ADDR_OFFSET_SLAVE 0x1000
  52. #define I2C_ADDR_7BITS_MAX 0x77
  53. #define I2C_ADDR_7BITS_COUNT (I2C_ADDR_7BITS_MAX + 1)
  54. #define I2C_ADDR_DEVICE_ID 0x7c
  55. /*
  56. * core_lock protects i2c_adapter_idr, and guarantees that device detection,
  57. * deletion of detected devices are serialized
  58. */
  59. static DEFINE_MUTEX(core_lock);
  60. static DEFINE_IDR(i2c_adapter_idr);
  61. static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver);
  62. static DEFINE_STATIC_KEY_FALSE(i2c_trace_msg_key);
  63. static bool is_registered;
  64. int i2c_transfer_trace_reg(void)
  65. {
  66. static_branch_inc(&i2c_trace_msg_key);
  67. return 0;
  68. }
  69. void i2c_transfer_trace_unreg(void)
  70. {
  71. static_branch_dec(&i2c_trace_msg_key);
  72. }
  73. const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
  74. const struct i2c_client *client)
  75. {
  76. if (!(id && client))
  77. return NULL;
  78. while (id->name[0]) {
  79. if (strcmp(client->name, id->name) == 0)
  80. return id;
  81. id++;
  82. }
  83. return NULL;
  84. }
  85. EXPORT_SYMBOL_GPL(i2c_match_id);
  86. static int i2c_device_match(struct device *dev, struct device_driver *drv)
  87. {
  88. struct i2c_client *client = i2c_verify_client(dev);
  89. struct i2c_driver *driver;
  90. /* Attempt an OF style match */
  91. if (i2c_of_match_device(drv->of_match_table, client))
  92. return 1;
  93. /* Then ACPI style match */
  94. if (acpi_driver_match_device(dev, drv))
  95. return 1;
  96. driver = to_i2c_driver(drv);
  97. /* Finally an I2C match */
  98. if (i2c_match_id(driver->id_table, client))
  99. return 1;
  100. return 0;
  101. }
  102. static int i2c_device_uevent(struct device *dev, struct kobj_uevent_env *env)
  103. {
  104. struct i2c_client *client = to_i2c_client(dev);
  105. int rc;
  106. rc = of_device_uevent_modalias(dev, env);
  107. if (rc != -ENODEV)
  108. return rc;
  109. rc = acpi_device_uevent_modalias(dev, env);
  110. if (rc != -ENODEV)
  111. return rc;
  112. return add_uevent_var(env, "MODALIAS=%s%s", I2C_MODULE_PREFIX, client->name);
  113. }
  114. /* i2c bus recovery routines */
  115. static int get_scl_gpio_value(struct i2c_adapter *adap)
  116. {
  117. return gpiod_get_value_cansleep(adap->bus_recovery_info->scl_gpiod);
  118. }
  119. static void set_scl_gpio_value(struct i2c_adapter *adap, int val)
  120. {
  121. gpiod_set_value_cansleep(adap->bus_recovery_info->scl_gpiod, val);
  122. }
  123. static int get_sda_gpio_value(struct i2c_adapter *adap)
  124. {
  125. return gpiod_get_value_cansleep(adap->bus_recovery_info->sda_gpiod);
  126. }
  127. static void set_sda_gpio_value(struct i2c_adapter *adap, int val)
  128. {
  129. gpiod_set_value_cansleep(adap->bus_recovery_info->sda_gpiod, val);
  130. }
  131. static int i2c_generic_bus_free(struct i2c_adapter *adap)
  132. {
  133. struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
  134. int ret = -EOPNOTSUPP;
  135. if (bri->get_bus_free)
  136. ret = bri->get_bus_free(adap);
  137. else if (bri->get_sda)
  138. ret = bri->get_sda(adap);
  139. if (ret < 0)
  140. return ret;
  141. return ret ? 0 : -EBUSY;
  142. }
  143. /*
  144. * We are generating clock pulses. ndelay() determines durating of clk pulses.
  145. * We will generate clock with rate 100 KHz and so duration of both clock levels
  146. * is: delay in ns = (10^6 / 100) / 2
  147. */
  148. #define RECOVERY_NDELAY 5000
  149. #define RECOVERY_CLK_CNT 9
  150. int i2c_generic_scl_recovery(struct i2c_adapter *adap)
  151. {
  152. struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
  153. int i = 0, scl = 1, ret;
  154. if (bri->prepare_recovery)
  155. bri->prepare_recovery(adap);
  156. /*
  157. * If we can set SDA, we will always create a STOP to ensure additional
  158. * pulses will do no harm. This is achieved by letting SDA follow SCL
  159. * half a cycle later. Check the 'incomplete_write_byte' fault injector
  160. * for details.
  161. */
  162. bri->set_scl(adap, scl);
  163. ndelay(RECOVERY_NDELAY / 2);
  164. if (bri->set_sda)
  165. bri->set_sda(adap, scl);
  166. ndelay(RECOVERY_NDELAY / 2);
  167. /*
  168. * By this time SCL is high, as we need to give 9 falling-rising edges
  169. */
  170. while (i++ < RECOVERY_CLK_CNT * 2) {
  171. if (scl) {
  172. /* SCL shouldn't be low here */
  173. if (!bri->get_scl(adap)) {
  174. dev_err(&adap->dev,
  175. "SCL is stuck low, exit recovery\n");
  176. ret = -EBUSY;
  177. break;
  178. }
  179. }
  180. scl = !scl;
  181. bri->set_scl(adap, scl);
  182. /* Creating STOP again, see above */
  183. ndelay(RECOVERY_NDELAY / 2);
  184. if (bri->set_sda)
  185. bri->set_sda(adap, scl);
  186. ndelay(RECOVERY_NDELAY / 2);
  187. if (scl) {
  188. ret = i2c_generic_bus_free(adap);
  189. if (ret == 0)
  190. break;
  191. }
  192. }
  193. /* If we can't check bus status, assume recovery worked */
  194. if (ret == -EOPNOTSUPP)
  195. ret = 0;
  196. if (bri->unprepare_recovery)
  197. bri->unprepare_recovery(adap);
  198. return ret;
  199. }
  200. EXPORT_SYMBOL_GPL(i2c_generic_scl_recovery);
  201. int i2c_recover_bus(struct i2c_adapter *adap)
  202. {
  203. if (!adap->bus_recovery_info)
  204. return -EOPNOTSUPP;
  205. dev_dbg(&adap->dev, "Trying i2c bus recovery\n");
  206. return adap->bus_recovery_info->recover_bus(adap);
  207. }
  208. EXPORT_SYMBOL_GPL(i2c_recover_bus);
  209. static void i2c_init_recovery(struct i2c_adapter *adap)
  210. {
  211. struct i2c_bus_recovery_info *bri = adap->bus_recovery_info;
  212. char *err_str;
  213. if (!bri)
  214. return;
  215. if (!bri->recover_bus) {
  216. err_str = "no recover_bus() found";
  217. goto err;
  218. }
  219. if (bri->scl_gpiod && bri->recover_bus == i2c_generic_scl_recovery) {
  220. bri->get_scl = get_scl_gpio_value;
  221. bri->set_scl = set_scl_gpio_value;
  222. if (bri->sda_gpiod) {
  223. bri->get_sda = get_sda_gpio_value;
  224. /* FIXME: add proper flag instead of '0' once available */
  225. if (gpiod_get_direction(bri->sda_gpiod) == 0)
  226. bri->set_sda = set_sda_gpio_value;
  227. }
  228. return;
  229. }
  230. if (bri->recover_bus == i2c_generic_scl_recovery) {
  231. /* Generic SCL recovery */
  232. if (!bri->set_scl || !bri->get_scl) {
  233. err_str = "no {get|set}_scl() found";
  234. goto err;
  235. }
  236. if (!bri->set_sda && !bri->get_sda) {
  237. err_str = "either get_sda() or set_sda() needed";
  238. goto err;
  239. }
  240. }
  241. return;
  242. err:
  243. dev_err(&adap->dev, "Not using recovery: %s\n", err_str);
  244. adap->bus_recovery_info = NULL;
  245. }
  246. static int i2c_smbus_host_notify_to_irq(const struct i2c_client *client)
  247. {
  248. struct i2c_adapter *adap = client->adapter;
  249. unsigned int irq;
  250. if (!adap->host_notify_domain)
  251. return -ENXIO;
  252. if (client->flags & I2C_CLIENT_TEN)
  253. return -EINVAL;
  254. irq = irq_find_mapping(adap->host_notify_domain, client->addr);
  255. if (!irq)
  256. irq = irq_create_mapping(adap->host_notify_domain,
  257. client->addr);
  258. return irq > 0 ? irq : -ENXIO;
  259. }
  260. static int i2c_device_probe(struct device *dev)
  261. {
  262. struct i2c_client *client = i2c_verify_client(dev);
  263. struct i2c_driver *driver;
  264. int status;
  265. if (!client)
  266. return 0;
  267. driver = to_i2c_driver(dev->driver);
  268. if (!client->irq && !driver->disable_i2c_core_irq_mapping) {
  269. int irq = -ENOENT;
  270. if (client->flags & I2C_CLIENT_HOST_NOTIFY) {
  271. dev_dbg(dev, "Using Host Notify IRQ\n");
  272. irq = i2c_smbus_host_notify_to_irq(client);
  273. } else if (dev->of_node) {
  274. irq = of_irq_get_byname(dev->of_node, "irq");
  275. if (irq == -EINVAL || irq == -ENODATA)
  276. irq = of_irq_get(dev->of_node, 0);
  277. } else if (ACPI_COMPANION(dev)) {
  278. irq = acpi_dev_gpio_irq_get(ACPI_COMPANION(dev), 0);
  279. }
  280. if (irq == -EPROBE_DEFER)
  281. return irq;
  282. if (irq < 0)
  283. irq = 0;
  284. client->irq = irq;
  285. }
  286. /*
  287. * An I2C ID table is not mandatory, if and only if, a suitable OF
  288. * or ACPI ID table is supplied for the probing device.
  289. */
  290. if (!driver->id_table &&
  291. !i2c_acpi_match_device(dev->driver->acpi_match_table, client) &&
  292. !i2c_of_match_device(dev->driver->of_match_table, client))
  293. return -ENODEV;
  294. if (client->flags & I2C_CLIENT_WAKE) {
  295. int wakeirq = -ENOENT;
  296. if (dev->of_node) {
  297. wakeirq = of_irq_get_byname(dev->of_node, "wakeup");
  298. if (wakeirq == -EPROBE_DEFER)
  299. return wakeirq;
  300. }
  301. device_init_wakeup(&client->dev, true);
  302. if (wakeirq > 0 && wakeirq != client->irq)
  303. status = dev_pm_set_dedicated_wake_irq(dev, wakeirq);
  304. else if (client->irq > 0)
  305. status = dev_pm_set_wake_irq(dev, client->irq);
  306. else
  307. status = 0;
  308. if (status)
  309. dev_warn(&client->dev, "failed to set up wakeup irq\n");
  310. }
  311. dev_dbg(dev, "probe\n");
  312. status = of_clk_set_defaults(dev->of_node, false);
  313. if (status < 0)
  314. goto err_clear_wakeup_irq;
  315. status = dev_pm_domain_attach(&client->dev, true);
  316. if (status)
  317. goto err_clear_wakeup_irq;
  318. /*
  319. * When there are no more users of probe(),
  320. * rename probe_new to probe.
  321. */
  322. if (driver->probe_new)
  323. status = driver->probe_new(client);
  324. else if (driver->probe)
  325. status = driver->probe(client,
  326. i2c_match_id(driver->id_table, client));
  327. else
  328. status = -EINVAL;
  329. if (status)
  330. goto err_detach_pm_domain;
  331. return 0;
  332. err_detach_pm_domain:
  333. dev_pm_domain_detach(&client->dev, true);
  334. err_clear_wakeup_irq:
  335. dev_pm_clear_wake_irq(&client->dev);
  336. device_init_wakeup(&client->dev, false);
  337. return status;
  338. }
  339. static int i2c_device_remove(struct device *dev)
  340. {
  341. struct i2c_client *client = i2c_verify_client(dev);
  342. struct i2c_driver *driver;
  343. int status = 0;
  344. if (!client || !dev->driver)
  345. return 0;
  346. driver = to_i2c_driver(dev->driver);
  347. if (driver->remove) {
  348. dev_dbg(dev, "remove\n");
  349. status = driver->remove(client);
  350. }
  351. dev_pm_domain_detach(&client->dev, true);
  352. dev_pm_clear_wake_irq(&client->dev);
  353. device_init_wakeup(&client->dev, false);
  354. return status;
  355. }
  356. static void i2c_device_shutdown(struct device *dev)
  357. {
  358. struct i2c_client *client = i2c_verify_client(dev);
  359. struct i2c_driver *driver;
  360. if (!client || !dev->driver)
  361. return;
  362. driver = to_i2c_driver(dev->driver);
  363. if (driver->shutdown)
  364. driver->shutdown(client);
  365. }
  366. static void i2c_client_dev_release(struct device *dev)
  367. {
  368. kfree(to_i2c_client(dev));
  369. }
  370. static ssize_t
  371. show_name(struct device *dev, struct device_attribute *attr, char *buf)
  372. {
  373. return sprintf(buf, "%s\n", dev->type == &i2c_client_type ?
  374. to_i2c_client(dev)->name : to_i2c_adapter(dev)->name);
  375. }
  376. static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
  377. static ssize_t
  378. show_modalias(struct device *dev, struct device_attribute *attr, char *buf)
  379. {
  380. struct i2c_client *client = to_i2c_client(dev);
  381. int len;
  382. len = of_device_modalias(dev, buf, PAGE_SIZE);
  383. if (len != -ENODEV)
  384. return len;
  385. len = acpi_device_modalias(dev, buf, PAGE_SIZE -1);
  386. if (len != -ENODEV)
  387. return len;
  388. return sprintf(buf, "%s%s\n", I2C_MODULE_PREFIX, client->name);
  389. }
  390. static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
  391. static struct attribute *i2c_dev_attrs[] = {
  392. &dev_attr_name.attr,
  393. /* modalias helps coldplug: modprobe $(cat .../modalias) */
  394. &dev_attr_modalias.attr,
  395. NULL
  396. };
  397. ATTRIBUTE_GROUPS(i2c_dev);
  398. struct bus_type i2c_bus_type = {
  399. .name = "i2c",
  400. .match = i2c_device_match,
  401. .probe = i2c_device_probe,
  402. .remove = i2c_device_remove,
  403. .shutdown = i2c_device_shutdown,
  404. };
  405. EXPORT_SYMBOL_GPL(i2c_bus_type);
  406. struct device_type i2c_client_type = {
  407. .groups = i2c_dev_groups,
  408. .uevent = i2c_device_uevent,
  409. .release = i2c_client_dev_release,
  410. };
  411. EXPORT_SYMBOL_GPL(i2c_client_type);
  412. /**
  413. * i2c_verify_client - return parameter as i2c_client, or NULL
  414. * @dev: device, probably from some driver model iterator
  415. *
  416. * When traversing the driver model tree, perhaps using driver model
  417. * iterators like @device_for_each_child(), you can't assume very much
  418. * about the nodes you find. Use this function to avoid oopses caused
  419. * by wrongly treating some non-I2C device as an i2c_client.
  420. */
  421. struct i2c_client *i2c_verify_client(struct device *dev)
  422. {
  423. return (dev->type == &i2c_client_type)
  424. ? to_i2c_client(dev)
  425. : NULL;
  426. }
  427. EXPORT_SYMBOL(i2c_verify_client);
  428. /* Return a unique address which takes the flags of the client into account */
  429. static unsigned short i2c_encode_flags_to_addr(struct i2c_client *client)
  430. {
  431. unsigned short addr = client->addr;
  432. /* For some client flags, add an arbitrary offset to avoid collisions */
  433. if (client->flags & I2C_CLIENT_TEN)
  434. addr |= I2C_ADDR_OFFSET_TEN_BIT;
  435. if (client->flags & I2C_CLIENT_SLAVE)
  436. addr |= I2C_ADDR_OFFSET_SLAVE;
  437. return addr;
  438. }
  439. /* This is a permissive address validity check, I2C address map constraints
  440. * are purposely not enforced, except for the general call address. */
  441. static int i2c_check_addr_validity(unsigned int addr, unsigned short flags)
  442. {
  443. if (flags & I2C_CLIENT_TEN) {
  444. /* 10-bit address, all values are valid */
  445. if (addr > 0x3ff)
  446. return -EINVAL;
  447. } else {
  448. /* 7-bit address, reject the general call address */
  449. if (addr == 0x00 || addr > 0x7f)
  450. return -EINVAL;
  451. }
  452. return 0;
  453. }
  454. /* And this is a strict address validity check, used when probing. If a
  455. * device uses a reserved address, then it shouldn't be probed. 7-bit
  456. * addressing is assumed, 10-bit address devices are rare and should be
  457. * explicitly enumerated. */
  458. int i2c_check_7bit_addr_validity_strict(unsigned short addr)
  459. {
  460. /*
  461. * Reserved addresses per I2C specification:
  462. * 0x00 General call address / START byte
  463. * 0x01 CBUS address
  464. * 0x02 Reserved for different bus format
  465. * 0x03 Reserved for future purposes
  466. * 0x04-0x07 Hs-mode master code
  467. * 0x78-0x7b 10-bit slave addressing
  468. * 0x7c-0x7f Reserved for future purposes
  469. */
  470. if (addr < 0x08 || addr > 0x77)
  471. return -EINVAL;
  472. return 0;
  473. }
  474. static int __i2c_check_addr_busy(struct device *dev, void *addrp)
  475. {
  476. struct i2c_client *client = i2c_verify_client(dev);
  477. int addr = *(int *)addrp;
  478. if (client && i2c_encode_flags_to_addr(client) == addr)
  479. return -EBUSY;
  480. return 0;
  481. }
  482. /* walk up mux tree */
  483. static int i2c_check_mux_parents(struct i2c_adapter *adapter, int addr)
  484. {
  485. struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
  486. int result;
  487. result = device_for_each_child(&adapter->dev, &addr,
  488. __i2c_check_addr_busy);
  489. if (!result && parent)
  490. result = i2c_check_mux_parents(parent, addr);
  491. return result;
  492. }
  493. /* recurse down mux tree */
  494. static int i2c_check_mux_children(struct device *dev, void *addrp)
  495. {
  496. int result;
  497. if (dev->type == &i2c_adapter_type)
  498. result = device_for_each_child(dev, addrp,
  499. i2c_check_mux_children);
  500. else
  501. result = __i2c_check_addr_busy(dev, addrp);
  502. return result;
  503. }
  504. static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr)
  505. {
  506. struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
  507. int result = 0;
  508. if (parent)
  509. result = i2c_check_mux_parents(parent, addr);
  510. if (!result)
  511. result = device_for_each_child(&adapter->dev, &addr,
  512. i2c_check_mux_children);
  513. return result;
  514. }
  515. /**
  516. * i2c_adapter_lock_bus - Get exclusive access to an I2C bus segment
  517. * @adapter: Target I2C bus segment
  518. * @flags: I2C_LOCK_ROOT_ADAPTER locks the root i2c adapter, I2C_LOCK_SEGMENT
  519. * locks only this branch in the adapter tree
  520. */
  521. static void i2c_adapter_lock_bus(struct i2c_adapter *adapter,
  522. unsigned int flags)
  523. {
  524. rt_mutex_lock_nested(&adapter->bus_lock, i2c_adapter_depth(adapter));
  525. }
  526. /**
  527. * i2c_adapter_trylock_bus - Try to get exclusive access to an I2C bus segment
  528. * @adapter: Target I2C bus segment
  529. * @flags: I2C_LOCK_ROOT_ADAPTER trylocks the root i2c adapter, I2C_LOCK_SEGMENT
  530. * trylocks only this branch in the adapter tree
  531. */
  532. static int i2c_adapter_trylock_bus(struct i2c_adapter *adapter,
  533. unsigned int flags)
  534. {
  535. return rt_mutex_trylock(&adapter->bus_lock);
  536. }
  537. /**
  538. * i2c_adapter_unlock_bus - Release exclusive access to an I2C bus segment
  539. * @adapter: Target I2C bus segment
  540. * @flags: I2C_LOCK_ROOT_ADAPTER unlocks the root i2c adapter, I2C_LOCK_SEGMENT
  541. * unlocks only this branch in the adapter tree
  542. */
  543. static void i2c_adapter_unlock_bus(struct i2c_adapter *adapter,
  544. unsigned int flags)
  545. {
  546. rt_mutex_unlock(&adapter->bus_lock);
  547. }
  548. static void i2c_dev_set_name(struct i2c_adapter *adap,
  549. struct i2c_client *client,
  550. struct i2c_board_info const *info)
  551. {
  552. struct acpi_device *adev = ACPI_COMPANION(&client->dev);
  553. if (info && info->dev_name) {
  554. dev_set_name(&client->dev, "i2c-%s", info->dev_name);
  555. return;
  556. }
  557. if (adev) {
  558. dev_set_name(&client->dev, "i2c-%s", acpi_dev_name(adev));
  559. return;
  560. }
  561. dev_set_name(&client->dev, "%d-%04x", i2c_adapter_id(adap),
  562. i2c_encode_flags_to_addr(client));
  563. }
  564. static int i2c_dev_irq_from_resources(const struct resource *resources,
  565. unsigned int num_resources)
  566. {
  567. struct irq_data *irqd;
  568. int i;
  569. for (i = 0; i < num_resources; i++) {
  570. const struct resource *r = &resources[i];
  571. if (resource_type(r) != IORESOURCE_IRQ)
  572. continue;
  573. if (r->flags & IORESOURCE_BITS) {
  574. irqd = irq_get_irq_data(r->start);
  575. if (!irqd)
  576. break;
  577. irqd_set_trigger_type(irqd, r->flags & IORESOURCE_BITS);
  578. }
  579. return r->start;
  580. }
  581. return 0;
  582. }
  583. /**
  584. * i2c_new_device - instantiate an i2c device
  585. * @adap: the adapter managing the device
  586. * @info: describes one I2C device; bus_num is ignored
  587. * Context: can sleep
  588. *
  589. * Create an i2c device. Binding is handled through driver model
  590. * probe()/remove() methods. A driver may be bound to this device when we
  591. * return from this function, or any later moment (e.g. maybe hotplugging will
  592. * load the driver module). This call is not appropriate for use by mainboard
  593. * initialization logic, which usually runs during an arch_initcall() long
  594. * before any i2c_adapter could exist.
  595. *
  596. * This returns the new i2c client, which may be saved for later use with
  597. * i2c_unregister_device(); or NULL to indicate an error.
  598. */
  599. struct i2c_client *
  600. i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info)
  601. {
  602. struct i2c_client *client;
  603. int status;
  604. client = kzalloc(sizeof *client, GFP_KERNEL);
  605. if (!client)
  606. return NULL;
  607. client->adapter = adap;
  608. client->dev.platform_data = info->platform_data;
  609. client->flags = info->flags;
  610. client->addr = info->addr;
  611. client->irq = info->irq;
  612. if (!client->irq)
  613. client->irq = i2c_dev_irq_from_resources(info->resources,
  614. info->num_resources);
  615. strlcpy(client->name, info->type, sizeof(client->name));
  616. status = i2c_check_addr_validity(client->addr, client->flags);
  617. if (status) {
  618. dev_err(&adap->dev, "Invalid %d-bit I2C address 0x%02hx\n",
  619. client->flags & I2C_CLIENT_TEN ? 10 : 7, client->addr);
  620. goto out_err_silent;
  621. }
  622. /* Check for address business */
  623. status = i2c_check_addr_busy(adap, i2c_encode_flags_to_addr(client));
  624. if (status)
  625. goto out_err;
  626. client->dev.parent = &client->adapter->dev;
  627. client->dev.bus = &i2c_bus_type;
  628. client->dev.type = &i2c_client_type;
  629. client->dev.of_node = of_node_get(info->of_node);
  630. client->dev.fwnode = info->fwnode;
  631. i2c_dev_set_name(adap, client, info);
  632. if (info->properties) {
  633. status = device_add_properties(&client->dev, info->properties);
  634. if (status) {
  635. dev_err(&adap->dev,
  636. "Failed to add properties to client %s: %d\n",
  637. client->name, status);
  638. goto out_err_put_of_node;
  639. }
  640. }
  641. status = device_register(&client->dev);
  642. if (status)
  643. goto out_free_props;
  644. dev_dbg(&adap->dev, "client [%s] registered with bus id %s\n",
  645. client->name, dev_name(&client->dev));
  646. return client;
  647. out_free_props:
  648. if (info->properties)
  649. device_remove_properties(&client->dev);
  650. out_err_put_of_node:
  651. of_node_put(info->of_node);
  652. out_err:
  653. dev_err(&adap->dev,
  654. "Failed to register i2c client %s at 0x%02x (%d)\n",
  655. client->name, client->addr, status);
  656. out_err_silent:
  657. kfree(client);
  658. return NULL;
  659. }
  660. EXPORT_SYMBOL_GPL(i2c_new_device);
  661. /**
  662. * i2c_unregister_device - reverse effect of i2c_new_device()
  663. * @client: value returned from i2c_new_device()
  664. * Context: can sleep
  665. */
  666. void i2c_unregister_device(struct i2c_client *client)
  667. {
  668. if (!client)
  669. return;
  670. if (client->dev.of_node) {
  671. of_node_clear_flag(client->dev.of_node, OF_POPULATED);
  672. of_node_put(client->dev.of_node);
  673. }
  674. if (ACPI_COMPANION(&client->dev))
  675. acpi_device_clear_enumerated(ACPI_COMPANION(&client->dev));
  676. device_unregister(&client->dev);
  677. }
  678. EXPORT_SYMBOL_GPL(i2c_unregister_device);
  679. static const struct i2c_device_id dummy_id[] = {
  680. { "dummy", 0 },
  681. { },
  682. };
  683. static int dummy_probe(struct i2c_client *client,
  684. const struct i2c_device_id *id)
  685. {
  686. return 0;
  687. }
  688. static int dummy_remove(struct i2c_client *client)
  689. {
  690. return 0;
  691. }
  692. static struct i2c_driver dummy_driver = {
  693. .driver.name = "dummy",
  694. .probe = dummy_probe,
  695. .remove = dummy_remove,
  696. .id_table = dummy_id,
  697. };
  698. /**
  699. * i2c_new_dummy - return a new i2c device bound to a dummy driver
  700. * @adapter: the adapter managing the device
  701. * @address: seven bit address to be used
  702. * Context: can sleep
  703. *
  704. * This returns an I2C client bound to the "dummy" driver, intended for use
  705. * with devices that consume multiple addresses. Examples of such chips
  706. * include various EEPROMS (like 24c04 and 24c08 models).
  707. *
  708. * These dummy devices have two main uses. First, most I2C and SMBus calls
  709. * except i2c_transfer() need a client handle; the dummy will be that handle.
  710. * And second, this prevents the specified address from being bound to a
  711. * different driver.
  712. *
  713. * This returns the new i2c client, which should be saved for later use with
  714. * i2c_unregister_device(); or NULL to indicate an error.
  715. */
  716. struct i2c_client *i2c_new_dummy(struct i2c_adapter *adapter, u16 address)
  717. {
  718. struct i2c_board_info info = {
  719. I2C_BOARD_INFO("dummy", address),
  720. };
  721. return i2c_new_device(adapter, &info);
  722. }
  723. EXPORT_SYMBOL_GPL(i2c_new_dummy);
  724. /**
  725. * i2c_new_secondary_device - Helper to get the instantiated secondary address
  726. * and create the associated device
  727. * @client: Handle to the primary client
  728. * @name: Handle to specify which secondary address to get
  729. * @default_addr: Used as a fallback if no secondary address was specified
  730. * Context: can sleep
  731. *
  732. * I2C clients can be composed of multiple I2C slaves bound together in a single
  733. * component. The I2C client driver then binds to the master I2C slave and needs
  734. * to create I2C dummy clients to communicate with all the other slaves.
  735. *
  736. * This function creates and returns an I2C dummy client whose I2C address is
  737. * retrieved from the platform firmware based on the given slave name. If no
  738. * address is specified by the firmware default_addr is used.
  739. *
  740. * On DT-based platforms the address is retrieved from the "reg" property entry
  741. * cell whose "reg-names" value matches the slave name.
  742. *
  743. * This returns the new i2c client, which should be saved for later use with
  744. * i2c_unregister_device(); or NULL to indicate an error.
  745. */
  746. struct i2c_client *i2c_new_secondary_device(struct i2c_client *client,
  747. const char *name,
  748. u16 default_addr)
  749. {
  750. struct device_node *np = client->dev.of_node;
  751. u32 addr = default_addr;
  752. int i;
  753. if (np) {
  754. i = of_property_match_string(np, "reg-names", name);
  755. if (i >= 0)
  756. of_property_read_u32_index(np, "reg", i, &addr);
  757. }
  758. dev_dbg(&client->adapter->dev, "Address for %s : 0x%x\n", name, addr);
  759. return i2c_new_dummy(client->adapter, addr);
  760. }
  761. EXPORT_SYMBOL_GPL(i2c_new_secondary_device);
  762. /* ------------------------------------------------------------------------- */
  763. /* I2C bus adapters -- one roots each I2C or SMBUS segment */
  764. static void i2c_adapter_dev_release(struct device *dev)
  765. {
  766. struct i2c_adapter *adap = to_i2c_adapter(dev);
  767. complete(&adap->dev_released);
  768. }
  769. unsigned int i2c_adapter_depth(struct i2c_adapter *adapter)
  770. {
  771. unsigned int depth = 0;
  772. while ((adapter = i2c_parent_is_i2c_adapter(adapter)))
  773. depth++;
  774. WARN_ONCE(depth >= MAX_LOCKDEP_SUBCLASSES,
  775. "adapter depth exceeds lockdep subclass limit\n");
  776. return depth;
  777. }
  778. EXPORT_SYMBOL_GPL(i2c_adapter_depth);
  779. /*
  780. * Let users instantiate I2C devices through sysfs. This can be used when
  781. * platform initialization code doesn't contain the proper data for
  782. * whatever reason. Also useful for drivers that do device detection and
  783. * detection fails, either because the device uses an unexpected address,
  784. * or this is a compatible device with different ID register values.
  785. *
  786. * Parameter checking may look overzealous, but we really don't want
  787. * the user to provide incorrect parameters.
  788. */
  789. static ssize_t
  790. i2c_sysfs_new_device(struct device *dev, struct device_attribute *attr,
  791. const char *buf, size_t count)
  792. {
  793. struct i2c_adapter *adap = to_i2c_adapter(dev);
  794. struct i2c_board_info info;
  795. struct i2c_client *client;
  796. char *blank, end;
  797. int res;
  798. memset(&info, 0, sizeof(struct i2c_board_info));
  799. blank = strchr(buf, ' ');
  800. if (!blank) {
  801. dev_err(dev, "%s: Missing parameters\n", "new_device");
  802. return -EINVAL;
  803. }
  804. if (blank - buf > I2C_NAME_SIZE - 1) {
  805. dev_err(dev, "%s: Invalid device name\n", "new_device");
  806. return -EINVAL;
  807. }
  808. memcpy(info.type, buf, blank - buf);
  809. /* Parse remaining parameters, reject extra parameters */
  810. res = sscanf(++blank, "%hi%c", &info.addr, &end);
  811. if (res < 1) {
  812. dev_err(dev, "%s: Can't parse I2C address\n", "new_device");
  813. return -EINVAL;
  814. }
  815. if (res > 1 && end != '\n') {
  816. dev_err(dev, "%s: Extra parameters\n", "new_device");
  817. return -EINVAL;
  818. }
  819. if ((info.addr & I2C_ADDR_OFFSET_TEN_BIT) == I2C_ADDR_OFFSET_TEN_BIT) {
  820. info.addr &= ~I2C_ADDR_OFFSET_TEN_BIT;
  821. info.flags |= I2C_CLIENT_TEN;
  822. }
  823. if (info.addr & I2C_ADDR_OFFSET_SLAVE) {
  824. info.addr &= ~I2C_ADDR_OFFSET_SLAVE;
  825. info.flags |= I2C_CLIENT_SLAVE;
  826. }
  827. client = i2c_new_device(adap, &info);
  828. if (!client)
  829. return -EINVAL;
  830. /* Keep track of the added device */
  831. mutex_lock(&adap->userspace_clients_lock);
  832. list_add_tail(&client->detected, &adap->userspace_clients);
  833. mutex_unlock(&adap->userspace_clients_lock);
  834. dev_info(dev, "%s: Instantiated device %s at 0x%02hx\n", "new_device",
  835. info.type, info.addr);
  836. return count;
  837. }
  838. static DEVICE_ATTR(new_device, S_IWUSR, NULL, i2c_sysfs_new_device);
  839. /*
  840. * And of course let the users delete the devices they instantiated, if
  841. * they got it wrong. This interface can only be used to delete devices
  842. * instantiated by i2c_sysfs_new_device above. This guarantees that we
  843. * don't delete devices to which some kernel code still has references.
  844. *
  845. * Parameter checking may look overzealous, but we really don't want
  846. * the user to delete the wrong device.
  847. */
  848. static ssize_t
  849. i2c_sysfs_delete_device(struct device *dev, struct device_attribute *attr,
  850. const char *buf, size_t count)
  851. {
  852. struct i2c_adapter *adap = to_i2c_adapter(dev);
  853. struct i2c_client *client, *next;
  854. unsigned short addr;
  855. char end;
  856. int res;
  857. /* Parse parameters, reject extra parameters */
  858. res = sscanf(buf, "%hi%c", &addr, &end);
  859. if (res < 1) {
  860. dev_err(dev, "%s: Can't parse I2C address\n", "delete_device");
  861. return -EINVAL;
  862. }
  863. if (res > 1 && end != '\n') {
  864. dev_err(dev, "%s: Extra parameters\n", "delete_device");
  865. return -EINVAL;
  866. }
  867. /* Make sure the device was added through sysfs */
  868. res = -ENOENT;
  869. mutex_lock_nested(&adap->userspace_clients_lock,
  870. i2c_adapter_depth(adap));
  871. list_for_each_entry_safe(client, next, &adap->userspace_clients,
  872. detected) {
  873. if (i2c_encode_flags_to_addr(client) == addr) {
  874. dev_info(dev, "%s: Deleting device %s at 0x%02hx\n",
  875. "delete_device", client->name, client->addr);
  876. list_del(&client->detected);
  877. i2c_unregister_device(client);
  878. res = count;
  879. break;
  880. }
  881. }
  882. mutex_unlock(&adap->userspace_clients_lock);
  883. if (res < 0)
  884. dev_err(dev, "%s: Can't find device in list\n",
  885. "delete_device");
  886. return res;
  887. }
  888. static DEVICE_ATTR_IGNORE_LOCKDEP(delete_device, S_IWUSR, NULL,
  889. i2c_sysfs_delete_device);
  890. static struct attribute *i2c_adapter_attrs[] = {
  891. &dev_attr_name.attr,
  892. &dev_attr_new_device.attr,
  893. &dev_attr_delete_device.attr,
  894. NULL
  895. };
  896. ATTRIBUTE_GROUPS(i2c_adapter);
  897. struct device_type i2c_adapter_type = {
  898. .groups = i2c_adapter_groups,
  899. .release = i2c_adapter_dev_release,
  900. };
  901. EXPORT_SYMBOL_GPL(i2c_adapter_type);
  902. /**
  903. * i2c_verify_adapter - return parameter as i2c_adapter or NULL
  904. * @dev: device, probably from some driver model iterator
  905. *
  906. * When traversing the driver model tree, perhaps using driver model
  907. * iterators like @device_for_each_child(), you can't assume very much
  908. * about the nodes you find. Use this function to avoid oopses caused
  909. * by wrongly treating some non-I2C device as an i2c_adapter.
  910. */
  911. struct i2c_adapter *i2c_verify_adapter(struct device *dev)
  912. {
  913. return (dev->type == &i2c_adapter_type)
  914. ? to_i2c_adapter(dev)
  915. : NULL;
  916. }
  917. EXPORT_SYMBOL(i2c_verify_adapter);
  918. #ifdef CONFIG_I2C_COMPAT
  919. static struct class_compat *i2c_adapter_compat_class;
  920. #endif
  921. static void i2c_scan_static_board_info(struct i2c_adapter *adapter)
  922. {
  923. struct i2c_devinfo *devinfo;
  924. down_read(&__i2c_board_lock);
  925. list_for_each_entry(devinfo, &__i2c_board_list, list) {
  926. if (devinfo->busnum == adapter->nr
  927. && !i2c_new_device(adapter,
  928. &devinfo->board_info))
  929. dev_err(&adapter->dev,
  930. "Can't create device at 0x%02x\n",
  931. devinfo->board_info.addr);
  932. }
  933. up_read(&__i2c_board_lock);
  934. }
  935. static int i2c_do_add_adapter(struct i2c_driver *driver,
  936. struct i2c_adapter *adap)
  937. {
  938. /* Detect supported devices on that bus, and instantiate them */
  939. i2c_detect(adap, driver);
  940. return 0;
  941. }
  942. static int __process_new_adapter(struct device_driver *d, void *data)
  943. {
  944. return i2c_do_add_adapter(to_i2c_driver(d), data);
  945. }
  946. static const struct i2c_lock_operations i2c_adapter_lock_ops = {
  947. .lock_bus = i2c_adapter_lock_bus,
  948. .trylock_bus = i2c_adapter_trylock_bus,
  949. .unlock_bus = i2c_adapter_unlock_bus,
  950. };
  951. static void i2c_host_notify_irq_teardown(struct i2c_adapter *adap)
  952. {
  953. struct irq_domain *domain = adap->host_notify_domain;
  954. irq_hw_number_t hwirq;
  955. if (!domain)
  956. return;
  957. for (hwirq = 0 ; hwirq < I2C_ADDR_7BITS_COUNT ; hwirq++)
  958. irq_dispose_mapping(irq_find_mapping(domain, hwirq));
  959. irq_domain_remove(domain);
  960. adap->host_notify_domain = NULL;
  961. }
  962. static int i2c_host_notify_irq_map(struct irq_domain *h,
  963. unsigned int virq,
  964. irq_hw_number_t hw_irq_num)
  965. {
  966. irq_set_chip_and_handler(virq, &dummy_irq_chip, handle_simple_irq);
  967. return 0;
  968. }
  969. static const struct irq_domain_ops i2c_host_notify_irq_ops = {
  970. .map = i2c_host_notify_irq_map,
  971. };
  972. static int i2c_setup_host_notify_irq_domain(struct i2c_adapter *adap)
  973. {
  974. struct irq_domain *domain;
  975. if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_HOST_NOTIFY))
  976. return 0;
  977. domain = irq_domain_create_linear(adap->dev.fwnode,
  978. I2C_ADDR_7BITS_COUNT,
  979. &i2c_host_notify_irq_ops, adap);
  980. if (!domain)
  981. return -ENOMEM;
  982. adap->host_notify_domain = domain;
  983. return 0;
  984. }
  985. /**
  986. * i2c_handle_smbus_host_notify - Forward a Host Notify event to the correct
  987. * I2C client.
  988. * @adap: the adapter
  989. * @addr: the I2C address of the notifying device
  990. * Context: can't sleep
  991. *
  992. * Helper function to be called from an I2C bus driver's interrupt
  993. * handler. It will schedule the Host Notify IRQ.
  994. */
  995. int i2c_handle_smbus_host_notify(struct i2c_adapter *adap, unsigned short addr)
  996. {
  997. int irq;
  998. if (!adap)
  999. return -EINVAL;
  1000. irq = irq_find_mapping(adap->host_notify_domain, addr);
  1001. if (irq <= 0)
  1002. return -ENXIO;
  1003. generic_handle_irq(irq);
  1004. return 0;
  1005. }
  1006. EXPORT_SYMBOL_GPL(i2c_handle_smbus_host_notify);
  1007. static int i2c_register_adapter(struct i2c_adapter *adap)
  1008. {
  1009. int res = -EINVAL;
  1010. /* Can't register until after driver model init */
  1011. if (WARN_ON(!is_registered)) {
  1012. res = -EAGAIN;
  1013. goto out_list;
  1014. }
  1015. /* Sanity checks */
  1016. if (WARN(!adap->name[0], "i2c adapter has no name"))
  1017. goto out_list;
  1018. if (!adap->algo) {
  1019. pr_err("adapter '%s': no algo supplied!\n", adap->name);
  1020. goto out_list;
  1021. }
  1022. if (!adap->lock_ops)
  1023. adap->lock_ops = &i2c_adapter_lock_ops;
  1024. rt_mutex_init(&adap->bus_lock);
  1025. rt_mutex_init(&adap->mux_lock);
  1026. mutex_init(&adap->userspace_clients_lock);
  1027. INIT_LIST_HEAD(&adap->userspace_clients);
  1028. /* Set default timeout to 1 second if not already set */
  1029. if (adap->timeout == 0)
  1030. adap->timeout = HZ;
  1031. /* register soft irqs for Host Notify */
  1032. res = i2c_setup_host_notify_irq_domain(adap);
  1033. if (res) {
  1034. pr_err("adapter '%s': can't create Host Notify IRQs (%d)\n",
  1035. adap->name, res);
  1036. goto out_list;
  1037. }
  1038. dev_set_name(&adap->dev, "i2c-%d", adap->nr);
  1039. adap->dev.bus = &i2c_bus_type;
  1040. adap->dev.type = &i2c_adapter_type;
  1041. res = device_register(&adap->dev);
  1042. if (res) {
  1043. pr_err("adapter '%s': can't register device (%d)\n", adap->name, res);
  1044. goto out_list;
  1045. }
  1046. res = of_i2c_setup_smbus_alert(adap);
  1047. if (res)
  1048. goto out_reg;
  1049. dev_dbg(&adap->dev, "adapter [%s] registered\n", adap->name);
  1050. pm_runtime_no_callbacks(&adap->dev);
  1051. pm_suspend_ignore_children(&adap->dev, true);
  1052. pm_runtime_enable(&adap->dev);
  1053. #ifdef CONFIG_I2C_COMPAT
  1054. res = class_compat_create_link(i2c_adapter_compat_class, &adap->dev,
  1055. adap->dev.parent);
  1056. if (res)
  1057. dev_warn(&adap->dev,
  1058. "Failed to create compatibility class link\n");
  1059. #endif
  1060. i2c_init_recovery(adap);
  1061. /* create pre-declared device nodes */
  1062. of_i2c_register_devices(adap);
  1063. i2c_acpi_register_devices(adap);
  1064. i2c_acpi_install_space_handler(adap);
  1065. if (adap->nr < __i2c_first_dynamic_bus_num)
  1066. i2c_scan_static_board_info(adap);
  1067. /* Notify drivers */
  1068. mutex_lock(&core_lock);
  1069. bus_for_each_drv(&i2c_bus_type, NULL, adap, __process_new_adapter);
  1070. mutex_unlock(&core_lock);
  1071. return 0;
  1072. out_reg:
  1073. init_completion(&adap->dev_released);
  1074. device_unregister(&adap->dev);
  1075. wait_for_completion(&adap->dev_released);
  1076. out_list:
  1077. mutex_lock(&core_lock);
  1078. idr_remove(&i2c_adapter_idr, adap->nr);
  1079. mutex_unlock(&core_lock);
  1080. return res;
  1081. }
  1082. /**
  1083. * __i2c_add_numbered_adapter - i2c_add_numbered_adapter where nr is never -1
  1084. * @adap: the adapter to register (with adap->nr initialized)
  1085. * Context: can sleep
  1086. *
  1087. * See i2c_add_numbered_adapter() for details.
  1088. */
  1089. static int __i2c_add_numbered_adapter(struct i2c_adapter *adap)
  1090. {
  1091. int id;
  1092. mutex_lock(&core_lock);
  1093. id = idr_alloc(&i2c_adapter_idr, adap, adap->nr, adap->nr + 1, GFP_KERNEL);
  1094. mutex_unlock(&core_lock);
  1095. if (WARN(id < 0, "couldn't get idr"))
  1096. return id == -ENOSPC ? -EBUSY : id;
  1097. return i2c_register_adapter(adap);
  1098. }
  1099. /**
  1100. * i2c_add_adapter - declare i2c adapter, use dynamic bus number
  1101. * @adapter: the adapter to add
  1102. * Context: can sleep
  1103. *
  1104. * This routine is used to declare an I2C adapter when its bus number
  1105. * doesn't matter or when its bus number is specified by an dt alias.
  1106. * Examples of bases when the bus number doesn't matter: I2C adapters
  1107. * dynamically added by USB links or PCI plugin cards.
  1108. *
  1109. * When this returns zero, a new bus number was allocated and stored
  1110. * in adap->nr, and the specified adapter became available for clients.
  1111. * Otherwise, a negative errno value is returned.
  1112. */
  1113. int i2c_add_adapter(struct i2c_adapter *adapter)
  1114. {
  1115. struct device *dev = &adapter->dev;
  1116. int id;
  1117. if (dev->of_node) {
  1118. id = of_alias_get_id(dev->of_node, "i2c");
  1119. if (id >= 0) {
  1120. adapter->nr = id;
  1121. return __i2c_add_numbered_adapter(adapter);
  1122. }
  1123. }
  1124. mutex_lock(&core_lock);
  1125. id = idr_alloc(&i2c_adapter_idr, adapter,
  1126. __i2c_first_dynamic_bus_num, 0, GFP_KERNEL);
  1127. mutex_unlock(&core_lock);
  1128. if (WARN(id < 0, "couldn't get idr"))
  1129. return id;
  1130. adapter->nr = id;
  1131. return i2c_register_adapter(adapter);
  1132. }
  1133. EXPORT_SYMBOL(i2c_add_adapter);
  1134. /**
  1135. * i2c_add_numbered_adapter - declare i2c adapter, use static bus number
  1136. * @adap: the adapter to register (with adap->nr initialized)
  1137. * Context: can sleep
  1138. *
  1139. * This routine is used to declare an I2C adapter when its bus number
  1140. * matters. For example, use it for I2C adapters from system-on-chip CPUs,
  1141. * or otherwise built in to the system's mainboard, and where i2c_board_info
  1142. * is used to properly configure I2C devices.
  1143. *
  1144. * If the requested bus number is set to -1, then this function will behave
  1145. * identically to i2c_add_adapter, and will dynamically assign a bus number.
  1146. *
  1147. * If no devices have pre-been declared for this bus, then be sure to
  1148. * register the adapter before any dynamically allocated ones. Otherwise
  1149. * the required bus ID may not be available.
  1150. *
  1151. * When this returns zero, the specified adapter became available for
  1152. * clients using the bus number provided in adap->nr. Also, the table
  1153. * of I2C devices pre-declared using i2c_register_board_info() is scanned,
  1154. * and the appropriate driver model device nodes are created. Otherwise, a
  1155. * negative errno value is returned.
  1156. */
  1157. int i2c_add_numbered_adapter(struct i2c_adapter *adap)
  1158. {
  1159. if (adap->nr == -1) /* -1 means dynamically assign bus id */
  1160. return i2c_add_adapter(adap);
  1161. return __i2c_add_numbered_adapter(adap);
  1162. }
  1163. EXPORT_SYMBOL_GPL(i2c_add_numbered_adapter);
  1164. static void i2c_do_del_adapter(struct i2c_driver *driver,
  1165. struct i2c_adapter *adapter)
  1166. {
  1167. struct i2c_client *client, *_n;
  1168. /* Remove the devices we created ourselves as the result of hardware
  1169. * probing (using a driver's detect method) */
  1170. list_for_each_entry_safe(client, _n, &driver->clients, detected) {
  1171. if (client->adapter == adapter) {
  1172. dev_dbg(&adapter->dev, "Removing %s at 0x%x\n",
  1173. client->name, client->addr);
  1174. list_del(&client->detected);
  1175. i2c_unregister_device(client);
  1176. }
  1177. }
  1178. }
  1179. static int __unregister_client(struct device *dev, void *dummy)
  1180. {
  1181. struct i2c_client *client = i2c_verify_client(dev);
  1182. if (client && strcmp(client->name, "dummy"))
  1183. i2c_unregister_device(client);
  1184. return 0;
  1185. }
  1186. static int __unregister_dummy(struct device *dev, void *dummy)
  1187. {
  1188. struct i2c_client *client = i2c_verify_client(dev);
  1189. i2c_unregister_device(client);
  1190. return 0;
  1191. }
  1192. static int __process_removed_adapter(struct device_driver *d, void *data)
  1193. {
  1194. i2c_do_del_adapter(to_i2c_driver(d), data);
  1195. return 0;
  1196. }
  1197. /**
  1198. * i2c_del_adapter - unregister I2C adapter
  1199. * @adap: the adapter being unregistered
  1200. * Context: can sleep
  1201. *
  1202. * This unregisters an I2C adapter which was previously registered
  1203. * by @i2c_add_adapter or @i2c_add_numbered_adapter.
  1204. */
  1205. void i2c_del_adapter(struct i2c_adapter *adap)
  1206. {
  1207. struct i2c_adapter *found;
  1208. struct i2c_client *client, *next;
  1209. /* First make sure that this adapter was ever added */
  1210. mutex_lock(&core_lock);
  1211. found = idr_find(&i2c_adapter_idr, adap->nr);
  1212. mutex_unlock(&core_lock);
  1213. if (found != adap) {
  1214. pr_debug("attempting to delete unregistered adapter [%s]\n", adap->name);
  1215. return;
  1216. }
  1217. i2c_acpi_remove_space_handler(adap);
  1218. /* Tell drivers about this removal */
  1219. mutex_lock(&core_lock);
  1220. bus_for_each_drv(&i2c_bus_type, NULL, adap,
  1221. __process_removed_adapter);
  1222. mutex_unlock(&core_lock);
  1223. /* Remove devices instantiated from sysfs */
  1224. mutex_lock_nested(&adap->userspace_clients_lock,
  1225. i2c_adapter_depth(adap));
  1226. list_for_each_entry_safe(client, next, &adap->userspace_clients,
  1227. detected) {
  1228. dev_dbg(&adap->dev, "Removing %s at 0x%x\n", client->name,
  1229. client->addr);
  1230. list_del(&client->detected);
  1231. i2c_unregister_device(client);
  1232. }
  1233. mutex_unlock(&adap->userspace_clients_lock);
  1234. /* Detach any active clients. This can't fail, thus we do not
  1235. * check the returned value. This is a two-pass process, because
  1236. * we can't remove the dummy devices during the first pass: they
  1237. * could have been instantiated by real devices wishing to clean
  1238. * them up properly, so we give them a chance to do that first. */
  1239. device_for_each_child(&adap->dev, NULL, __unregister_client);
  1240. device_for_each_child(&adap->dev, NULL, __unregister_dummy);
  1241. #ifdef CONFIG_I2C_COMPAT
  1242. class_compat_remove_link(i2c_adapter_compat_class, &adap->dev,
  1243. adap->dev.parent);
  1244. #endif
  1245. /* device name is gone after device_unregister */
  1246. dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
  1247. pm_runtime_disable(&adap->dev);
  1248. i2c_host_notify_irq_teardown(adap);
  1249. /* wait until all references to the device are gone
  1250. *
  1251. * FIXME: This is old code and should ideally be replaced by an
  1252. * alternative which results in decoupling the lifetime of the struct
  1253. * device from the i2c_adapter, like spi or netdev do. Any solution
  1254. * should be thoroughly tested with DEBUG_KOBJECT_RELEASE enabled!
  1255. */
  1256. init_completion(&adap->dev_released);
  1257. device_unregister(&adap->dev);
  1258. wait_for_completion(&adap->dev_released);
  1259. /* free bus id */
  1260. mutex_lock(&core_lock);
  1261. idr_remove(&i2c_adapter_idr, adap->nr);
  1262. mutex_unlock(&core_lock);
  1263. /* Clear the device structure in case this adapter is ever going to be
  1264. added again */
  1265. memset(&adap->dev, 0, sizeof(adap->dev));
  1266. }
  1267. EXPORT_SYMBOL(i2c_del_adapter);
  1268. /**
  1269. * i2c_parse_fw_timings - get I2C related timing parameters from firmware
  1270. * @dev: The device to scan for I2C timing properties
  1271. * @t: the i2c_timings struct to be filled with values
  1272. * @use_defaults: bool to use sane defaults derived from the I2C specification
  1273. * when properties are not found, otherwise use 0
  1274. *
  1275. * Scan the device for the generic I2C properties describing timing parameters
  1276. * for the signal and fill the given struct with the results. If a property was
  1277. * not found and use_defaults was true, then maximum timings are assumed which
  1278. * are derived from the I2C specification. If use_defaults is not used, the
  1279. * results will be 0, so drivers can apply their own defaults later. The latter
  1280. * is mainly intended for avoiding regressions of existing drivers which want
  1281. * to switch to this function. New drivers almost always should use the defaults.
  1282. */
  1283. void i2c_parse_fw_timings(struct device *dev, struct i2c_timings *t, bool use_defaults)
  1284. {
  1285. int ret;
  1286. memset(t, 0, sizeof(*t));
  1287. ret = device_property_read_u32(dev, "clock-frequency", &t->bus_freq_hz);
  1288. if (ret && use_defaults)
  1289. t->bus_freq_hz = 100000;
  1290. ret = device_property_read_u32(dev, "i2c-scl-rising-time-ns", &t->scl_rise_ns);
  1291. if (ret && use_defaults) {
  1292. if (t->bus_freq_hz <= 100000)
  1293. t->scl_rise_ns = 1000;
  1294. else if (t->bus_freq_hz <= 400000)
  1295. t->scl_rise_ns = 300;
  1296. else
  1297. t->scl_rise_ns = 120;
  1298. }
  1299. ret = device_property_read_u32(dev, "i2c-scl-falling-time-ns", &t->scl_fall_ns);
  1300. if (ret && use_defaults) {
  1301. if (t->bus_freq_hz <= 400000)
  1302. t->scl_fall_ns = 300;
  1303. else
  1304. t->scl_fall_ns = 120;
  1305. }
  1306. device_property_read_u32(dev, "i2c-scl-internal-delay-ns", &t->scl_int_delay_ns);
  1307. ret = device_property_read_u32(dev, "i2c-sda-falling-time-ns", &t->sda_fall_ns);
  1308. if (ret && use_defaults)
  1309. t->sda_fall_ns = t->scl_fall_ns;
  1310. device_property_read_u32(dev, "i2c-sda-hold-time-ns", &t->sda_hold_ns);
  1311. }
  1312. EXPORT_SYMBOL_GPL(i2c_parse_fw_timings);
  1313. /* ------------------------------------------------------------------------- */
  1314. int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *))
  1315. {
  1316. int res;
  1317. mutex_lock(&core_lock);
  1318. res = bus_for_each_dev(&i2c_bus_type, NULL, data, fn);
  1319. mutex_unlock(&core_lock);
  1320. return res;
  1321. }
  1322. EXPORT_SYMBOL_GPL(i2c_for_each_dev);
  1323. static int __process_new_driver(struct device *dev, void *data)
  1324. {
  1325. if (dev->type != &i2c_adapter_type)
  1326. return 0;
  1327. return i2c_do_add_adapter(data, to_i2c_adapter(dev));
  1328. }
  1329. /*
  1330. * An i2c_driver is used with one or more i2c_client (device) nodes to access
  1331. * i2c slave chips, on a bus instance associated with some i2c_adapter.
  1332. */
  1333. int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
  1334. {
  1335. int res;
  1336. /* Can't register until after driver model init */
  1337. if (WARN_ON(!is_registered))
  1338. return -EAGAIN;
  1339. /* add the driver to the list of i2c drivers in the driver core */
  1340. driver->driver.owner = owner;
  1341. driver->driver.bus = &i2c_bus_type;
  1342. INIT_LIST_HEAD(&driver->clients);
  1343. /* When registration returns, the driver core
  1344. * will have called probe() for all matching-but-unbound devices.
  1345. */
  1346. res = driver_register(&driver->driver);
  1347. if (res)
  1348. return res;
  1349. pr_debug("driver [%s] registered\n", driver->driver.name);
  1350. /* Walk the adapters that are already present */
  1351. i2c_for_each_dev(driver, __process_new_driver);
  1352. return 0;
  1353. }
  1354. EXPORT_SYMBOL(i2c_register_driver);
  1355. static int __process_removed_driver(struct device *dev, void *data)
  1356. {
  1357. if (dev->type == &i2c_adapter_type)
  1358. i2c_do_del_adapter(data, to_i2c_adapter(dev));
  1359. return 0;
  1360. }
  1361. /**
  1362. * i2c_del_driver - unregister I2C driver
  1363. * @driver: the driver being unregistered
  1364. * Context: can sleep
  1365. */
  1366. void i2c_del_driver(struct i2c_driver *driver)
  1367. {
  1368. i2c_for_each_dev(driver, __process_removed_driver);
  1369. driver_unregister(&driver->driver);
  1370. pr_debug("driver [%s] unregistered\n", driver->driver.name);
  1371. }
  1372. EXPORT_SYMBOL(i2c_del_driver);
  1373. /* ------------------------------------------------------------------------- */
  1374. /**
  1375. * i2c_use_client - increments the reference count of the i2c client structure
  1376. * @client: the client being referenced
  1377. *
  1378. * Each live reference to a client should be refcounted. The driver model does
  1379. * that automatically as part of driver binding, so that most drivers don't
  1380. * need to do this explicitly: they hold a reference until they're unbound
  1381. * from the device.
  1382. *
  1383. * A pointer to the client with the incremented reference counter is returned.
  1384. */
  1385. struct i2c_client *i2c_use_client(struct i2c_client *client)
  1386. {
  1387. if (client && get_device(&client->dev))
  1388. return client;
  1389. return NULL;
  1390. }
  1391. EXPORT_SYMBOL(i2c_use_client);
  1392. /**
  1393. * i2c_release_client - release a use of the i2c client structure
  1394. * @client: the client being no longer referenced
  1395. *
  1396. * Must be called when a user of a client is finished with it.
  1397. */
  1398. void i2c_release_client(struct i2c_client *client)
  1399. {
  1400. if (client)
  1401. put_device(&client->dev);
  1402. }
  1403. EXPORT_SYMBOL(i2c_release_client);
  1404. struct i2c_cmd_arg {
  1405. unsigned cmd;
  1406. void *arg;
  1407. };
  1408. static int i2c_cmd(struct device *dev, void *_arg)
  1409. {
  1410. struct i2c_client *client = i2c_verify_client(dev);
  1411. struct i2c_cmd_arg *arg = _arg;
  1412. struct i2c_driver *driver;
  1413. if (!client || !client->dev.driver)
  1414. return 0;
  1415. driver = to_i2c_driver(client->dev.driver);
  1416. if (driver->command)
  1417. driver->command(client, arg->cmd, arg->arg);
  1418. return 0;
  1419. }
  1420. void i2c_clients_command(struct i2c_adapter *adap, unsigned int cmd, void *arg)
  1421. {
  1422. struct i2c_cmd_arg cmd_arg;
  1423. cmd_arg.cmd = cmd;
  1424. cmd_arg.arg = arg;
  1425. device_for_each_child(&adap->dev, &cmd_arg, i2c_cmd);
  1426. }
  1427. EXPORT_SYMBOL(i2c_clients_command);
  1428. static int __init i2c_init(void)
  1429. {
  1430. int retval;
  1431. retval = of_alias_get_highest_id("i2c");
  1432. down_write(&__i2c_board_lock);
  1433. if (retval >= __i2c_first_dynamic_bus_num)
  1434. __i2c_first_dynamic_bus_num = retval + 1;
  1435. up_write(&__i2c_board_lock);
  1436. retval = bus_register(&i2c_bus_type);
  1437. if (retval)
  1438. return retval;
  1439. is_registered = true;
  1440. #ifdef CONFIG_I2C_COMPAT
  1441. i2c_adapter_compat_class = class_compat_register("i2c-adapter");
  1442. if (!i2c_adapter_compat_class) {
  1443. retval = -ENOMEM;
  1444. goto bus_err;
  1445. }
  1446. #endif
  1447. retval = i2c_add_driver(&dummy_driver);
  1448. if (retval)
  1449. goto class_err;
  1450. if (IS_ENABLED(CONFIG_OF_DYNAMIC))
  1451. WARN_ON(of_reconfig_notifier_register(&i2c_of_notifier));
  1452. if (IS_ENABLED(CONFIG_ACPI))
  1453. WARN_ON(acpi_reconfig_notifier_register(&i2c_acpi_notifier));
  1454. return 0;
  1455. class_err:
  1456. #ifdef CONFIG_I2C_COMPAT
  1457. class_compat_unregister(i2c_adapter_compat_class);
  1458. bus_err:
  1459. #endif
  1460. is_registered = false;
  1461. bus_unregister(&i2c_bus_type);
  1462. return retval;
  1463. }
  1464. static void __exit i2c_exit(void)
  1465. {
  1466. if (IS_ENABLED(CONFIG_ACPI))
  1467. WARN_ON(acpi_reconfig_notifier_unregister(&i2c_acpi_notifier));
  1468. if (IS_ENABLED(CONFIG_OF_DYNAMIC))
  1469. WARN_ON(of_reconfig_notifier_unregister(&i2c_of_notifier));
  1470. i2c_del_driver(&dummy_driver);
  1471. #ifdef CONFIG_I2C_COMPAT
  1472. class_compat_unregister(i2c_adapter_compat_class);
  1473. #endif
  1474. bus_unregister(&i2c_bus_type);
  1475. tracepoint_synchronize_unregister();
  1476. }
  1477. /* We must initialize early, because some subsystems register i2c drivers
  1478. * in subsys_initcall() code, but are linked (and initialized) before i2c.
  1479. */
  1480. postcore_initcall(i2c_init);
  1481. module_exit(i2c_exit);
  1482. /* ----------------------------------------------------
  1483. * the functional interface to the i2c busses.
  1484. * ----------------------------------------------------
  1485. */
  1486. /* Check if val is exceeding the quirk IFF quirk is non 0 */
  1487. #define i2c_quirk_exceeded(val, quirk) ((quirk) && ((val) > (quirk)))
  1488. static int i2c_quirk_error(struct i2c_adapter *adap, struct i2c_msg *msg, char *err_msg)
  1489. {
  1490. dev_err_ratelimited(&adap->dev, "adapter quirk: %s (addr 0x%04x, size %u, %s)\n",
  1491. err_msg, msg->addr, msg->len,
  1492. msg->flags & I2C_M_RD ? "read" : "write");
  1493. return -EOPNOTSUPP;
  1494. }
  1495. static int i2c_check_for_quirks(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
  1496. {
  1497. const struct i2c_adapter_quirks *q = adap->quirks;
  1498. int max_num = q->max_num_msgs, i;
  1499. bool do_len_check = true;
  1500. if (q->flags & I2C_AQ_COMB) {
  1501. max_num = 2;
  1502. /* special checks for combined messages */
  1503. if (num == 2) {
  1504. if (q->flags & I2C_AQ_COMB_WRITE_FIRST && msgs[0].flags & I2C_M_RD)
  1505. return i2c_quirk_error(adap, &msgs[0], "1st comb msg must be write");
  1506. if (q->flags & I2C_AQ_COMB_READ_SECOND && !(msgs[1].flags & I2C_M_RD))
  1507. return i2c_quirk_error(adap, &msgs[1], "2nd comb msg must be read");
  1508. if (q->flags & I2C_AQ_COMB_SAME_ADDR && msgs[0].addr != msgs[1].addr)
  1509. return i2c_quirk_error(adap, &msgs[0], "comb msg only to same addr");
  1510. if (i2c_quirk_exceeded(msgs[0].len, q->max_comb_1st_msg_len))
  1511. return i2c_quirk_error(adap, &msgs[0], "msg too long");
  1512. if (i2c_quirk_exceeded(msgs[1].len, q->max_comb_2nd_msg_len))
  1513. return i2c_quirk_error(adap, &msgs[1], "msg too long");
  1514. do_len_check = false;
  1515. }
  1516. }
  1517. if (i2c_quirk_exceeded(num, max_num))
  1518. return i2c_quirk_error(adap, &msgs[0], "too many messages");
  1519. for (i = 0; i < num; i++) {
  1520. u16 len = msgs[i].len;
  1521. if (msgs[i].flags & I2C_M_RD) {
  1522. if (do_len_check && i2c_quirk_exceeded(len, q->max_read_len))
  1523. return i2c_quirk_error(adap, &msgs[i], "msg too long");
  1524. if (q->flags & I2C_AQ_NO_ZERO_LEN_READ && len == 0)
  1525. return i2c_quirk_error(adap, &msgs[i], "no zero length");
  1526. } else {
  1527. if (do_len_check && i2c_quirk_exceeded(len, q->max_write_len))
  1528. return i2c_quirk_error(adap, &msgs[i], "msg too long");
  1529. if (q->flags & I2C_AQ_NO_ZERO_LEN_WRITE && len == 0)
  1530. return i2c_quirk_error(adap, &msgs[i], "no zero length");
  1531. }
  1532. }
  1533. return 0;
  1534. }
  1535. /**
  1536. * __i2c_transfer - unlocked flavor of i2c_transfer
  1537. * @adap: Handle to I2C bus
  1538. * @msgs: One or more messages to execute before STOP is issued to
  1539. * terminate the operation; each message begins with a START.
  1540. * @num: Number of messages to be executed.
  1541. *
  1542. * Returns negative errno, else the number of messages executed.
  1543. *
  1544. * Adapter lock must be held when calling this function. No debug logging
  1545. * takes place. adap->algo->master_xfer existence isn't checked.
  1546. */
  1547. int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
  1548. {
  1549. unsigned long orig_jiffies;
  1550. int ret, try;
  1551. if (WARN_ON(!msgs || num < 1))
  1552. return -EINVAL;
  1553. if (adap->quirks && i2c_check_for_quirks(adap, msgs, num))
  1554. return -EOPNOTSUPP;
  1555. /*
  1556. * i2c_trace_msg_key gets enabled when tracepoint i2c_transfer gets
  1557. * enabled. This is an efficient way of keeping the for-loop from
  1558. * being executed when not needed.
  1559. */
  1560. if (static_branch_unlikely(&i2c_trace_msg_key)) {
  1561. int i;
  1562. for (i = 0; i < num; i++)
  1563. if (msgs[i].flags & I2C_M_RD)
  1564. trace_i2c_read(adap, &msgs[i], i);
  1565. else
  1566. trace_i2c_write(adap, &msgs[i], i);
  1567. }
  1568. /* Retry automatically on arbitration loss */
  1569. orig_jiffies = jiffies;
  1570. for (ret = 0, try = 0; try <= adap->retries; try++) {
  1571. ret = adap->algo->master_xfer(adap, msgs, num);
  1572. if (ret != -EAGAIN)
  1573. break;
  1574. if (time_after(jiffies, orig_jiffies + adap->timeout))
  1575. break;
  1576. }
  1577. if (static_branch_unlikely(&i2c_trace_msg_key)) {
  1578. int i;
  1579. for (i = 0; i < ret; i++)
  1580. if (msgs[i].flags & I2C_M_RD)
  1581. trace_i2c_reply(adap, &msgs[i], i);
  1582. trace_i2c_result(adap, num, ret);
  1583. }
  1584. return ret;
  1585. }
  1586. EXPORT_SYMBOL(__i2c_transfer);
  1587. /**
  1588. * i2c_transfer - execute a single or combined I2C message
  1589. * @adap: Handle to I2C bus
  1590. * @msgs: One or more messages to execute before STOP is issued to
  1591. * terminate the operation; each message begins with a START.
  1592. * @num: Number of messages to be executed.
  1593. *
  1594. * Returns negative errno, else the number of messages executed.
  1595. *
  1596. * Note that there is no requirement that each message be sent to
  1597. * the same slave address, although that is the most common model.
  1598. */
  1599. int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
  1600. {
  1601. int ret;
  1602. /* REVISIT the fault reporting model here is weak:
  1603. *
  1604. * - When we get an error after receiving N bytes from a slave,
  1605. * there is no way to report "N".
  1606. *
  1607. * - When we get a NAK after transmitting N bytes to a slave,
  1608. * there is no way to report "N" ... or to let the master
  1609. * continue executing the rest of this combined message, if
  1610. * that's the appropriate response.
  1611. *
  1612. * - When for example "num" is two and we successfully complete
  1613. * the first message but get an error part way through the
  1614. * second, it's unclear whether that should be reported as
  1615. * one (discarding status on the second message) or errno
  1616. * (discarding status on the first one).
  1617. */
  1618. if (adap->algo->master_xfer) {
  1619. #ifdef DEBUG
  1620. for (ret = 0; ret < num; ret++) {
  1621. dev_dbg(&adap->dev,
  1622. "master_xfer[%d] %c, addr=0x%02x, len=%d%s\n",
  1623. ret, (msgs[ret].flags & I2C_M_RD) ? 'R' : 'W',
  1624. msgs[ret].addr, msgs[ret].len,
  1625. (msgs[ret].flags & I2C_M_RECV_LEN) ? "+" : "");
  1626. }
  1627. #endif
  1628. if (in_atomic() || irqs_disabled()) {
  1629. ret = i2c_trylock_bus(adap, I2C_LOCK_SEGMENT);
  1630. if (!ret)
  1631. /* I2C activity is ongoing. */
  1632. return -EAGAIN;
  1633. } else {
  1634. i2c_lock_bus(adap, I2C_LOCK_SEGMENT);
  1635. }
  1636. ret = __i2c_transfer(adap, msgs, num);
  1637. i2c_unlock_bus(adap, I2C_LOCK_SEGMENT);
  1638. return ret;
  1639. } else {
  1640. dev_dbg(&adap->dev, "I2C level transfers not supported\n");
  1641. return -EOPNOTSUPP;
  1642. }
  1643. }
  1644. EXPORT_SYMBOL(i2c_transfer);
  1645. /**
  1646. * i2c_transfer_buffer_flags - issue a single I2C message transferring data
  1647. * to/from a buffer
  1648. * @client: Handle to slave device
  1649. * @buf: Where the data is stored
  1650. * @count: How many bytes to transfer, must be less than 64k since msg.len is u16
  1651. * @flags: The flags to be used for the message, e.g. I2C_M_RD for reads
  1652. *
  1653. * Returns negative errno, or else the number of bytes transferred.
  1654. */
  1655. int i2c_transfer_buffer_flags(const struct i2c_client *client, char *buf,
  1656. int count, u16 flags)
  1657. {
  1658. int ret;
  1659. struct i2c_msg msg = {
  1660. .addr = client->addr,
  1661. .flags = flags | (client->flags & I2C_M_TEN),
  1662. .len = count,
  1663. .buf = buf,
  1664. };
  1665. ret = i2c_transfer(client->adapter, &msg, 1);
  1666. /*
  1667. * If everything went ok (i.e. 1 msg transferred), return #bytes
  1668. * transferred, else error code.
  1669. */
  1670. return (ret == 1) ? count : ret;
  1671. }
  1672. EXPORT_SYMBOL(i2c_transfer_buffer_flags);
  1673. /**
  1674. * i2c_get_device_id - get manufacturer, part id and die revision of a device
  1675. * @client: The device to query
  1676. * @id: The queried information
  1677. *
  1678. * Returns negative errno on error, zero on success.
  1679. */
  1680. int i2c_get_device_id(const struct i2c_client *client,
  1681. struct i2c_device_identity *id)
  1682. {
  1683. struct i2c_adapter *adap = client->adapter;
  1684. union i2c_smbus_data raw_id;
  1685. int ret;
  1686. if (!i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_I2C_BLOCK))
  1687. return -EOPNOTSUPP;
  1688. raw_id.block[0] = 3;
  1689. ret = i2c_smbus_xfer(adap, I2C_ADDR_DEVICE_ID, 0,
  1690. I2C_SMBUS_READ, client->addr << 1,
  1691. I2C_SMBUS_I2C_BLOCK_DATA, &raw_id);
  1692. if (ret)
  1693. return ret;
  1694. id->manufacturer_id = (raw_id.block[1] << 4) | (raw_id.block[2] >> 4);
  1695. id->part_id = ((raw_id.block[2] & 0xf) << 5) | (raw_id.block[3] >> 3);
  1696. id->die_revision = raw_id.block[3] & 0x7;
  1697. return 0;
  1698. }
  1699. EXPORT_SYMBOL_GPL(i2c_get_device_id);
  1700. /* ----------------------------------------------------
  1701. * the i2c address scanning function
  1702. * Will not work for 10-bit addresses!
  1703. * ----------------------------------------------------
  1704. */
  1705. /*
  1706. * Legacy default probe function, mostly relevant for SMBus. The default
  1707. * probe method is a quick write, but it is known to corrupt the 24RF08
  1708. * EEPROMs due to a state machine bug, and could also irreversibly
  1709. * write-protect some EEPROMs, so for address ranges 0x30-0x37 and 0x50-0x5f,
  1710. * we use a short byte read instead. Also, some bus drivers don't implement
  1711. * quick write, so we fallback to a byte read in that case too.
  1712. * On x86, there is another special case for FSC hardware monitoring chips,
  1713. * which want regular byte reads (address 0x73.) Fortunately, these are the
  1714. * only known chips using this I2C address on PC hardware.
  1715. * Returns 1 if probe succeeded, 0 if not.
  1716. */
  1717. static int i2c_default_probe(struct i2c_adapter *adap, unsigned short addr)
  1718. {
  1719. int err;
  1720. union i2c_smbus_data dummy;
  1721. #ifdef CONFIG_X86
  1722. if (addr == 0x73 && (adap->class & I2C_CLASS_HWMON)
  1723. && i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE_DATA))
  1724. err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
  1725. I2C_SMBUS_BYTE_DATA, &dummy);
  1726. else
  1727. #endif
  1728. if (!((addr & ~0x07) == 0x30 || (addr & ~0x0f) == 0x50)
  1729. && i2c_check_functionality(adap, I2C_FUNC_SMBUS_QUICK))
  1730. err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_WRITE, 0,
  1731. I2C_SMBUS_QUICK, NULL);
  1732. else if (i2c_check_functionality(adap, I2C_FUNC_SMBUS_READ_BYTE))
  1733. err = i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
  1734. I2C_SMBUS_BYTE, &dummy);
  1735. else {
  1736. dev_warn(&adap->dev, "No suitable probing method supported for address 0x%02X\n",
  1737. addr);
  1738. err = -EOPNOTSUPP;
  1739. }
  1740. return err >= 0;
  1741. }
  1742. static int i2c_detect_address(struct i2c_client *temp_client,
  1743. struct i2c_driver *driver)
  1744. {
  1745. struct i2c_board_info info;
  1746. struct i2c_adapter *adapter = temp_client->adapter;
  1747. int addr = temp_client->addr;
  1748. int err;
  1749. /* Make sure the address is valid */
  1750. err = i2c_check_7bit_addr_validity_strict(addr);
  1751. if (err) {
  1752. dev_warn(&adapter->dev, "Invalid probe address 0x%02x\n",
  1753. addr);
  1754. return err;
  1755. }
  1756. /* Skip if already in use (7 bit, no need to encode flags) */
  1757. if (i2c_check_addr_busy(adapter, addr))
  1758. return 0;
  1759. /* Make sure there is something at this address */
  1760. if (!i2c_default_probe(adapter, addr))
  1761. return 0;
  1762. /* Finally call the custom detection function */
  1763. memset(&info, 0, sizeof(struct i2c_board_info));
  1764. info.addr = addr;
  1765. err = driver->detect(temp_client, &info);
  1766. if (err) {
  1767. /* -ENODEV is returned if the detection fails. We catch it
  1768. here as this isn't an error. */
  1769. return err == -ENODEV ? 0 : err;
  1770. }
  1771. /* Consistency check */
  1772. if (info.type[0] == '\0') {
  1773. dev_err(&adapter->dev,
  1774. "%s detection function provided no name for 0x%x\n",
  1775. driver->driver.name, addr);
  1776. } else {
  1777. struct i2c_client *client;
  1778. /* Detection succeeded, instantiate the device */
  1779. if (adapter->class & I2C_CLASS_DEPRECATED)
  1780. dev_warn(&adapter->dev,
  1781. "This adapter will soon drop class based instantiation of devices. "
  1782. "Please make sure client 0x%02x gets instantiated by other means. "
  1783. "Check 'Documentation/i2c/instantiating-devices' for details.\n",
  1784. info.addr);
  1785. dev_dbg(&adapter->dev, "Creating %s at 0x%02x\n",
  1786. info.type, info.addr);
  1787. client = i2c_new_device(adapter, &info);
  1788. if (client)
  1789. list_add_tail(&client->detected, &driver->clients);
  1790. else
  1791. dev_err(&adapter->dev, "Failed creating %s at 0x%02x\n",
  1792. info.type, info.addr);
  1793. }
  1794. return 0;
  1795. }
  1796. static int i2c_detect(struct i2c_adapter *adapter, struct i2c_driver *driver)
  1797. {
  1798. const unsigned short *address_list;
  1799. struct i2c_client *temp_client;
  1800. int i, err = 0;
  1801. int adap_id = i2c_adapter_id(adapter);
  1802. address_list = driver->address_list;
  1803. if (!driver->detect || !address_list)
  1804. return 0;
  1805. /* Warn that the adapter lost class based instantiation */
  1806. if (adapter->class == I2C_CLASS_DEPRECATED) {
  1807. dev_dbg(&adapter->dev,
  1808. "This adapter dropped support for I2C classes and won't auto-detect %s devices anymore. "
  1809. "If you need it, check 'Documentation/i2c/instantiating-devices' for alternatives.\n",
  1810. driver->driver.name);
  1811. return 0;
  1812. }
  1813. /* Stop here if the classes do not match */
  1814. if (!(adapter->class & driver->class))
  1815. return 0;
  1816. /* Set up a temporary client to help detect callback */
  1817. temp_client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
  1818. if (!temp_client)
  1819. return -ENOMEM;
  1820. temp_client->adapter = adapter;
  1821. for (i = 0; address_list[i] != I2C_CLIENT_END; i += 1) {
  1822. dev_dbg(&adapter->dev,
  1823. "found normal entry for adapter %d, addr 0x%02x\n",
  1824. adap_id, address_list[i]);
  1825. temp_client->addr = address_list[i];
  1826. err = i2c_detect_address(temp_client, driver);
  1827. if (unlikely(err))
  1828. break;
  1829. }
  1830. kfree(temp_client);
  1831. return err;
  1832. }
  1833. int i2c_probe_func_quick_read(struct i2c_adapter *adap, unsigned short addr)
  1834. {
  1835. return i2c_smbus_xfer(adap, addr, 0, I2C_SMBUS_READ, 0,
  1836. I2C_SMBUS_QUICK, NULL) >= 0;
  1837. }
  1838. EXPORT_SYMBOL_GPL(i2c_probe_func_quick_read);
  1839. struct i2c_client *
  1840. i2c_new_probed_device(struct i2c_adapter *adap,
  1841. struct i2c_board_info *info,
  1842. unsigned short const *addr_list,
  1843. int (*probe)(struct i2c_adapter *, unsigned short addr))
  1844. {
  1845. int i;
  1846. if (!probe)
  1847. probe = i2c_default_probe;
  1848. for (i = 0; addr_list[i] != I2C_CLIENT_END; i++) {
  1849. /* Check address validity */
  1850. if (i2c_check_7bit_addr_validity_strict(addr_list[i]) < 0) {
  1851. dev_warn(&adap->dev, "Invalid 7-bit address 0x%02x\n",
  1852. addr_list[i]);
  1853. continue;
  1854. }
  1855. /* Check address availability (7 bit, no need to encode flags) */
  1856. if (i2c_check_addr_busy(adap, addr_list[i])) {
  1857. dev_dbg(&adap->dev,
  1858. "Address 0x%02x already in use, not probing\n",
  1859. addr_list[i]);
  1860. continue;
  1861. }
  1862. /* Test address responsiveness */
  1863. if (probe(adap, addr_list[i]))
  1864. break;
  1865. }
  1866. if (addr_list[i] == I2C_CLIENT_END) {
  1867. dev_dbg(&adap->dev, "Probing failed, no device found\n");
  1868. return NULL;
  1869. }
  1870. info->addr = addr_list[i];
  1871. return i2c_new_device(adap, info);
  1872. }
  1873. EXPORT_SYMBOL_GPL(i2c_new_probed_device);
  1874. struct i2c_adapter *i2c_get_adapter(int nr)
  1875. {
  1876. struct i2c_adapter *adapter;
  1877. mutex_lock(&core_lock);
  1878. adapter = idr_find(&i2c_adapter_idr, nr);
  1879. if (!adapter)
  1880. goto exit;
  1881. if (try_module_get(adapter->owner))
  1882. get_device(&adapter->dev);
  1883. else
  1884. adapter = NULL;
  1885. exit:
  1886. mutex_unlock(&core_lock);
  1887. return adapter;
  1888. }
  1889. EXPORT_SYMBOL(i2c_get_adapter);
  1890. void i2c_put_adapter(struct i2c_adapter *adap)
  1891. {
  1892. if (!adap)
  1893. return;
  1894. put_device(&adap->dev);
  1895. module_put(adap->owner);
  1896. }
  1897. EXPORT_SYMBOL(i2c_put_adapter);
  1898. /**
  1899. * i2c_get_dma_safe_msg_buf() - get a DMA safe buffer for the given i2c_msg
  1900. * @msg: the message to be checked
  1901. * @threshold: the minimum number of bytes for which using DMA makes sense
  1902. *
  1903. * Return: NULL if a DMA safe buffer was not obtained. Use msg->buf with PIO.
  1904. * Or a valid pointer to be used with DMA. After use, release it by
  1905. * calling i2c_release_dma_safe_msg_buf().
  1906. *
  1907. * This function must only be called from process context!
  1908. */
  1909. u8 *i2c_get_dma_safe_msg_buf(struct i2c_msg *msg, unsigned int threshold)
  1910. {
  1911. if (msg->len < threshold)
  1912. return NULL;
  1913. if (msg->flags & I2C_M_DMA_SAFE)
  1914. return msg->buf;
  1915. pr_debug("using bounce buffer for addr=0x%02x, len=%d\n",
  1916. msg->addr, msg->len);
  1917. if (msg->flags & I2C_M_RD)
  1918. return kzalloc(msg->len, GFP_KERNEL);
  1919. else
  1920. return kmemdup(msg->buf, msg->len, GFP_KERNEL);
  1921. }
  1922. EXPORT_SYMBOL_GPL(i2c_get_dma_safe_msg_buf);
  1923. /**
  1924. * i2c_release_dma_safe_msg_buf - release DMA safe buffer and sync with i2c_msg
  1925. * @msg: the message to be synced with
  1926. * @buf: the buffer obtained from i2c_get_dma_safe_msg_buf(). May be NULL.
  1927. */
  1928. void i2c_release_dma_safe_msg_buf(struct i2c_msg *msg, u8 *buf)
  1929. {
  1930. if (!buf || buf == msg->buf)
  1931. return;
  1932. if (msg->flags & I2C_M_RD)
  1933. memcpy(msg->buf, buf, msg->len);
  1934. kfree(buf);
  1935. }
  1936. EXPORT_SYMBOL_GPL(i2c_release_dma_safe_msg_buf);
  1937. MODULE_AUTHOR("Simon G. Vogl <simon@tk.uni-linz.ac.at>");
  1938. MODULE_DESCRIPTION("I2C-Bus main module");
  1939. MODULE_LICENSE("GPL");