uclass.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579
  1. /*
  2. * Copyright (c) 2013 Google, Inc
  3. *
  4. * (C) Copyright 2012
  5. * Pavel Herrmann <morpheus.ibis@gmail.com>
  6. *
  7. * SPDX-License-Identifier: GPL-2.0+
  8. */
  9. #include <common.h>
  10. #include <errno.h>
  11. #include <malloc.h>
  12. #include <dm/device.h>
  13. #include <dm/device-internal.h>
  14. #include <dm/lists.h>
  15. #include <dm/uclass.h>
  16. #include <dm/uclass-internal.h>
  17. #include <dm/util.h>
  18. DECLARE_GLOBAL_DATA_PTR;
  19. struct uclass *uclass_find(enum uclass_id key)
  20. {
  21. struct uclass *uc;
  22. if (!gd->dm_root)
  23. return NULL;
  24. /*
  25. * TODO(sjg@chromium.org): Optimise this, perhaps moving the found
  26. * node to the start of the list, or creating a linear array mapping
  27. * id to node.
  28. */
  29. list_for_each_entry(uc, &gd->uclass_root, sibling_node) {
  30. if (uc->uc_drv->id == key)
  31. return uc;
  32. }
  33. return NULL;
  34. }
  35. /**
  36. * uclass_add() - Create new uclass in list
  37. * @id: Id number to create
  38. * @ucp: Returns pointer to uclass, or NULL on error
  39. * @return 0 on success, -ve on error
  40. *
  41. * The new uclass is added to the list. There must be only one uclass for
  42. * each id.
  43. */
  44. static int uclass_add(enum uclass_id id, struct uclass **ucp)
  45. {
  46. struct uclass_driver *uc_drv;
  47. struct uclass *uc;
  48. int ret;
  49. *ucp = NULL;
  50. uc_drv = lists_uclass_lookup(id);
  51. if (!uc_drv) {
  52. debug("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n",
  53. id);
  54. /*
  55. * Use a strange error to make this case easier to find. When
  56. * a uclass is not available it can prevent driver model from
  57. * starting up and this failure is otherwise hard to debug.
  58. */
  59. return -EPFNOSUPPORT;
  60. }
  61. uc = calloc(1, sizeof(*uc));
  62. if (!uc)
  63. return -ENOMEM;
  64. if (uc_drv->priv_auto_alloc_size) {
  65. uc->priv = calloc(1, uc_drv->priv_auto_alloc_size);
  66. if (!uc->priv) {
  67. ret = -ENOMEM;
  68. goto fail_mem;
  69. }
  70. }
  71. uc->uc_drv = uc_drv;
  72. INIT_LIST_HEAD(&uc->sibling_node);
  73. INIT_LIST_HEAD(&uc->dev_head);
  74. list_add(&uc->sibling_node, &DM_UCLASS_ROOT_NON_CONST);
  75. if (uc_drv->init) {
  76. ret = uc_drv->init(uc);
  77. if (ret)
  78. goto fail;
  79. }
  80. *ucp = uc;
  81. return 0;
  82. fail:
  83. if (uc_drv->priv_auto_alloc_size) {
  84. free(uc->priv);
  85. uc->priv = NULL;
  86. }
  87. list_del(&uc->sibling_node);
  88. fail_mem:
  89. free(uc);
  90. return ret;
  91. }
  92. int uclass_destroy(struct uclass *uc)
  93. {
  94. struct uclass_driver *uc_drv;
  95. struct udevice *dev;
  96. int ret;
  97. /*
  98. * We cannot use list_for_each_entry_safe() here. If a device in this
  99. * uclass has a child device also in this uclass, it will be also be
  100. * unbound (by the recursion in the call to device_unbind() below).
  101. * We can loop until the list is empty.
  102. */
  103. while (!list_empty(&uc->dev_head)) {
  104. dev = list_first_entry(&uc->dev_head, struct udevice,
  105. uclass_node);
  106. ret = device_remove(dev);
  107. if (ret)
  108. return ret;
  109. ret = device_unbind(dev);
  110. if (ret)
  111. return ret;
  112. }
  113. uc_drv = uc->uc_drv;
  114. if (uc_drv->destroy)
  115. uc_drv->destroy(uc);
  116. list_del(&uc->sibling_node);
  117. if (uc_drv->priv_auto_alloc_size)
  118. free(uc->priv);
  119. free(uc);
  120. return 0;
  121. }
  122. int uclass_get(enum uclass_id id, struct uclass **ucp)
  123. {
  124. struct uclass *uc;
  125. *ucp = NULL;
  126. uc = uclass_find(id);
  127. if (!uc)
  128. return uclass_add(id, ucp);
  129. *ucp = uc;
  130. return 0;
  131. }
  132. const char *uclass_get_name(enum uclass_id id)
  133. {
  134. struct uclass *uc;
  135. if (uclass_get(id, &uc))
  136. return NULL;
  137. return uc->uc_drv->name;
  138. }
  139. int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
  140. {
  141. struct uclass *uc;
  142. struct udevice *dev;
  143. int ret;
  144. *devp = NULL;
  145. ret = uclass_get(id, &uc);
  146. if (ret)
  147. return ret;
  148. if (list_empty(&uc->dev_head))
  149. return -ENODEV;
  150. list_for_each_entry(dev, &uc->dev_head, uclass_node) {
  151. if (!index--) {
  152. *devp = dev;
  153. return 0;
  154. }
  155. }
  156. return -ENODEV;
  157. }
  158. int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
  159. {
  160. struct uclass *uc;
  161. int ret;
  162. *devp = NULL;
  163. ret = uclass_get(id, &uc);
  164. if (ret)
  165. return ret;
  166. if (list_empty(&uc->dev_head))
  167. return 0;
  168. *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
  169. return 0;
  170. }
  171. int uclass_find_next_device(struct udevice **devp)
  172. {
  173. struct udevice *dev = *devp;
  174. *devp = NULL;
  175. if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
  176. return 0;
  177. *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
  178. return 0;
  179. }
  180. int uclass_find_device_by_name(enum uclass_id id, const char *name,
  181. struct udevice **devp)
  182. {
  183. struct uclass *uc;
  184. struct udevice *dev;
  185. int ret;
  186. *devp = NULL;
  187. if (!name)
  188. return -EINVAL;
  189. ret = uclass_get(id, &uc);
  190. if (ret)
  191. return ret;
  192. list_for_each_entry(dev, &uc->dev_head, uclass_node) {
  193. if (!strncmp(dev->name, name, strlen(name))) {
  194. *devp = dev;
  195. return 0;
  196. }
  197. }
  198. return -ENODEV;
  199. }
  200. int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
  201. bool find_req_seq, struct udevice **devp)
  202. {
  203. struct uclass *uc;
  204. struct udevice *dev;
  205. int ret;
  206. *devp = NULL;
  207. debug("%s: %d %d\n", __func__, find_req_seq, seq_or_req_seq);
  208. if (seq_or_req_seq == -1)
  209. return -ENODEV;
  210. ret = uclass_get(id, &uc);
  211. if (ret)
  212. return ret;
  213. list_for_each_entry(dev, &uc->dev_head, uclass_node) {
  214. debug(" - %d %d\n", dev->req_seq, dev->seq);
  215. if ((find_req_seq ? dev->req_seq : dev->seq) ==
  216. seq_or_req_seq) {
  217. *devp = dev;
  218. debug(" - found\n");
  219. return 0;
  220. }
  221. }
  222. debug(" - not found\n");
  223. return -ENODEV;
  224. }
  225. int uclass_find_device_by_of_offset(enum uclass_id id, int node,
  226. struct udevice **devp)
  227. {
  228. struct uclass *uc;
  229. struct udevice *dev;
  230. int ret;
  231. *devp = NULL;
  232. if (node < 0)
  233. return -ENODEV;
  234. ret = uclass_get(id, &uc);
  235. if (ret)
  236. return ret;
  237. list_for_each_entry(dev, &uc->dev_head, uclass_node) {
  238. if (dev->of_offset == node) {
  239. *devp = dev;
  240. return 0;
  241. }
  242. }
  243. return -ENODEV;
  244. }
  245. #if CONFIG_IS_ENABLED(OF_CONTROL)
  246. static int uclass_find_device_by_phandle(enum uclass_id id,
  247. struct udevice *parent,
  248. const char *name,
  249. struct udevice **devp)
  250. {
  251. struct udevice *dev;
  252. struct uclass *uc;
  253. int find_phandle;
  254. int ret;
  255. *devp = NULL;
  256. find_phandle = fdtdec_get_int(gd->fdt_blob, parent->of_offset, name,
  257. -1);
  258. if (find_phandle <= 0)
  259. return -ENOENT;
  260. ret = uclass_get(id, &uc);
  261. if (ret)
  262. return ret;
  263. list_for_each_entry(dev, &uc->dev_head, uclass_node) {
  264. uint phandle = fdt_get_phandle(gd->fdt_blob, dev->of_offset);
  265. if (phandle == find_phandle) {
  266. *devp = dev;
  267. return 0;
  268. }
  269. }
  270. return -ENODEV;
  271. }
  272. #endif
  273. int uclass_get_device_by_driver(enum uclass_id id,
  274. const struct driver *find_drv,
  275. struct udevice **devp)
  276. {
  277. struct udevice *dev;
  278. struct uclass *uc;
  279. int ret;
  280. ret = uclass_get(id, &uc);
  281. if (ret)
  282. return ret;
  283. list_for_each_entry(dev, &uc->dev_head, uclass_node) {
  284. if (dev->driver == find_drv)
  285. return uclass_get_device_tail(dev, 0, devp);
  286. }
  287. return -ENODEV;
  288. }
  289. int uclass_get_device_tail(struct udevice *dev, int ret,
  290. struct udevice **devp)
  291. {
  292. if (ret)
  293. return ret;
  294. assert(dev);
  295. ret = device_probe(dev);
  296. if (ret)
  297. return ret;
  298. *devp = dev;
  299. return 0;
  300. }
  301. int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
  302. {
  303. struct udevice *dev;
  304. int ret;
  305. *devp = NULL;
  306. ret = uclass_find_device(id, index, &dev);
  307. return uclass_get_device_tail(dev, ret, devp);
  308. }
  309. int uclass_get_device_by_name(enum uclass_id id, const char *name,
  310. struct udevice **devp)
  311. {
  312. struct udevice *dev;
  313. int ret;
  314. *devp = NULL;
  315. ret = uclass_find_device_by_name(id, name, &dev);
  316. return uclass_get_device_tail(dev, ret, devp);
  317. }
  318. int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
  319. {
  320. struct udevice *dev;
  321. int ret;
  322. *devp = NULL;
  323. ret = uclass_find_device_by_seq(id, seq, false, &dev);
  324. if (ret == -ENODEV) {
  325. /*
  326. * We didn't find it in probed devices. See if there is one
  327. * that will request this seq if probed.
  328. */
  329. ret = uclass_find_device_by_seq(id, seq, true, &dev);
  330. }
  331. return uclass_get_device_tail(dev, ret, devp);
  332. }
  333. int uclass_get_device_by_of_offset(enum uclass_id id, int node,
  334. struct udevice **devp)
  335. {
  336. struct udevice *dev;
  337. int ret;
  338. *devp = NULL;
  339. ret = uclass_find_device_by_of_offset(id, node, &dev);
  340. return uclass_get_device_tail(dev, ret, devp);
  341. }
  342. #if CONFIG_IS_ENABLED(OF_CONTROL)
  343. int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
  344. const char *name, struct udevice **devp)
  345. {
  346. struct udevice *dev;
  347. int ret;
  348. *devp = NULL;
  349. ret = uclass_find_device_by_phandle(id, parent, name, &dev);
  350. return uclass_get_device_tail(dev, ret, devp);
  351. }
  352. #endif
  353. int uclass_first_device(enum uclass_id id, struct udevice **devp)
  354. {
  355. struct udevice *dev;
  356. int ret;
  357. *devp = NULL;
  358. ret = uclass_find_first_device(id, &dev);
  359. if (!dev)
  360. return 0;
  361. return uclass_get_device_tail(dev, ret, devp);
  362. }
  363. int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
  364. {
  365. int ret;
  366. ret = uclass_first_device(id, devp);
  367. if (ret)
  368. return ret;
  369. else if (!*devp)
  370. return -ENODEV;
  371. return 0;
  372. }
  373. int uclass_next_device(struct udevice **devp)
  374. {
  375. struct udevice *dev = *devp;
  376. int ret;
  377. *devp = NULL;
  378. ret = uclass_find_next_device(&dev);
  379. if (!dev)
  380. return 0;
  381. return uclass_get_device_tail(dev, ret, devp);
  382. }
  383. int uclass_bind_device(struct udevice *dev)
  384. {
  385. struct uclass *uc;
  386. int ret;
  387. uc = dev->uclass;
  388. list_add_tail(&dev->uclass_node, &uc->dev_head);
  389. if (dev->parent) {
  390. struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
  391. if (uc_drv->child_post_bind) {
  392. ret = uc_drv->child_post_bind(dev);
  393. if (ret)
  394. goto err;
  395. }
  396. }
  397. return 0;
  398. err:
  399. /* There is no need to undo the parent's post_bind call */
  400. list_del(&dev->uclass_node);
  401. return ret;
  402. }
  403. #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
  404. int uclass_unbind_device(struct udevice *dev)
  405. {
  406. struct uclass *uc;
  407. int ret;
  408. uc = dev->uclass;
  409. if (uc->uc_drv->pre_unbind) {
  410. ret = uc->uc_drv->pre_unbind(dev);
  411. if (ret)
  412. return ret;
  413. }
  414. list_del(&dev->uclass_node);
  415. return 0;
  416. }
  417. #endif
  418. int uclass_resolve_seq(struct udevice *dev)
  419. {
  420. struct udevice *dup;
  421. int seq;
  422. int ret;
  423. assert(dev->seq == -1);
  424. ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq,
  425. false, &dup);
  426. if (!ret) {
  427. dm_warn("Device '%s': seq %d is in use by '%s'\n",
  428. dev->name, dev->req_seq, dup->name);
  429. } else if (ret == -ENODEV) {
  430. /* Our requested sequence number is available */
  431. if (dev->req_seq != -1)
  432. return dev->req_seq;
  433. } else {
  434. return ret;
  435. }
  436. for (seq = 0; seq < DM_MAX_SEQ; seq++) {
  437. ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq,
  438. false, &dup);
  439. if (ret == -ENODEV)
  440. break;
  441. if (ret)
  442. return ret;
  443. }
  444. return seq;
  445. }
  446. int uclass_pre_probe_device(struct udevice *dev)
  447. {
  448. struct uclass_driver *uc_drv;
  449. int ret;
  450. uc_drv = dev->uclass->uc_drv;
  451. if (uc_drv->pre_probe) {
  452. ret = uc_drv->pre_probe(dev);
  453. if (ret)
  454. return ret;
  455. }
  456. if (!dev->parent)
  457. return 0;
  458. uc_drv = dev->parent->uclass->uc_drv;
  459. if (uc_drv->child_pre_probe)
  460. return uc_drv->child_pre_probe(dev);
  461. return 0;
  462. }
  463. int uclass_post_probe_device(struct udevice *dev)
  464. {
  465. struct uclass_driver *uc_drv = dev->uclass->uc_drv;
  466. if (uc_drv->post_probe)
  467. return uc_drv->post_probe(dev);
  468. return 0;
  469. }
  470. #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
  471. int uclass_pre_remove_device(struct udevice *dev)
  472. {
  473. struct uclass *uc;
  474. int ret;
  475. uc = dev->uclass;
  476. if (uc->uc_drv->pre_remove) {
  477. ret = uc->uc_drv->pre_remove(dev);
  478. if (ret)
  479. return ret;
  480. }
  481. return 0;
  482. }
  483. #endif