i2c-core-base.c 62 KB

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