uclass.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Copyright (c) 2013 Google, Inc
  4. *
  5. * (C) Copyright 2012
  6. * Pavel Herrmann <morpheus.ibis@gmail.com>
  7. */
  8. #define LOG_CATEGORY LOGC_DM
  9. #include <common.h>
  10. #include <dm.h>
  11. #include <errno.h>
  12. #include <malloc.h>
  13. #include <dm/device.h>
  14. #include <dm/device-internal.h>
  15. #include <dm/lists.h>
  16. #include <dm/uclass.h>
  17. #include <dm/uclass-internal.h>
  18. #include <dm/util.h>
  19. DECLARE_GLOBAL_DATA_PTR;
  20. struct uclass *uclass_find(enum uclass_id key)
  21. {
  22. struct uclass *uc;
  23. if (!gd->dm_root)
  24. return NULL;
  25. /*
  26. * TODO(sjg@chromium.org): Optimise this, perhaps moving the found
  27. * node to the start of the list, or creating a linear array mapping
  28. * id to node.
  29. */
  30. list_for_each_entry(uc, &gd->uclass_root, sibling_node) {
  31. if (uc->uc_drv->id == key)
  32. return uc;
  33. }
  34. return NULL;
  35. }
  36. /**
  37. * uclass_add() - Create new uclass in list
  38. * @id: Id number to create
  39. * @ucp: Returns pointer to uclass, or NULL on error
  40. * @return 0 on success, -ve on error
  41. *
  42. * The new uclass is added to the list. There must be only one uclass for
  43. * each id.
  44. */
  45. static int uclass_add(enum uclass_id id, struct uclass **ucp)
  46. {
  47. struct uclass_driver *uc_drv;
  48. struct uclass *uc;
  49. int ret;
  50. *ucp = NULL;
  51. uc_drv = lists_uclass_lookup(id);
  52. if (!uc_drv) {
  53. debug("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n",
  54. id);
  55. /*
  56. * Use a strange error to make this case easier to find. When
  57. * a uclass is not available it can prevent driver model from
  58. * starting up and this failure is otherwise hard to debug.
  59. */
  60. return -EPFNOSUPPORT;
  61. }
  62. uc = calloc(1, sizeof(*uc));
  63. if (!uc)
  64. return -ENOMEM;
  65. if (uc_drv->priv_auto_alloc_size) {
  66. uc->priv = calloc(1, uc_drv->priv_auto_alloc_size);
  67. if (!uc->priv) {
  68. ret = -ENOMEM;
  69. goto fail_mem;
  70. }
  71. }
  72. uc->uc_drv = uc_drv;
  73. INIT_LIST_HEAD(&uc->sibling_node);
  74. INIT_LIST_HEAD(&uc->dev_head);
  75. list_add(&uc->sibling_node, &DM_UCLASS_ROOT_NON_CONST);
  76. if (uc_drv->init) {
  77. ret = uc_drv->init(uc);
  78. if (ret)
  79. goto fail;
  80. }
  81. *ucp = uc;
  82. return 0;
  83. fail:
  84. if (uc_drv->priv_auto_alloc_size) {
  85. free(uc->priv);
  86. uc->priv = NULL;
  87. }
  88. list_del(&uc->sibling_node);
  89. fail_mem:
  90. free(uc);
  91. return ret;
  92. }
  93. int uclass_destroy(struct uclass *uc)
  94. {
  95. struct uclass_driver *uc_drv;
  96. struct udevice *dev;
  97. int ret;
  98. /*
  99. * We cannot use list_for_each_entry_safe() here. If a device in this
  100. * uclass has a child device also in this uclass, it will be also be
  101. * unbound (by the recursion in the call to device_unbind() below).
  102. * We can loop until the list is empty.
  103. */
  104. while (!list_empty(&uc->dev_head)) {
  105. dev = list_first_entry(&uc->dev_head, struct udevice,
  106. uclass_node);
  107. ret = device_remove(dev, DM_REMOVE_NORMAL | DM_REMOVE_NO_PD);
  108. if (ret)
  109. return log_msg_ret("remove", ret);
  110. ret = device_unbind(dev);
  111. if (ret)
  112. return log_msg_ret("unbind", ret);
  113. }
  114. uc_drv = uc->uc_drv;
  115. if (uc_drv->destroy)
  116. uc_drv->destroy(uc);
  117. list_del(&uc->sibling_node);
  118. if (uc_drv->priv_auto_alloc_size)
  119. free(uc->priv);
  120. free(uc);
  121. return 0;
  122. }
  123. int uclass_get(enum uclass_id id, struct uclass **ucp)
  124. {
  125. struct uclass *uc;
  126. *ucp = NULL;
  127. uc = uclass_find(id);
  128. if (!uc)
  129. return uclass_add(id, ucp);
  130. *ucp = uc;
  131. return 0;
  132. }
  133. const char *uclass_get_name(enum uclass_id id)
  134. {
  135. struct uclass *uc;
  136. if (uclass_get(id, &uc))
  137. return NULL;
  138. return uc->uc_drv->name;
  139. }
  140. enum uclass_id uclass_get_by_name(const char *name)
  141. {
  142. int i;
  143. for (i = 0; i < UCLASS_COUNT; i++) {
  144. struct uclass_driver *uc_drv = lists_uclass_lookup(i);
  145. if (uc_drv && !strcmp(uc_drv->name, name))
  146. return i;
  147. }
  148. return UCLASS_INVALID;
  149. }
  150. int dev_get_uclass_index(struct udevice *dev, struct uclass **ucp)
  151. {
  152. struct udevice *iter;
  153. struct uclass *uc = dev->uclass;
  154. int i = 0;
  155. if (list_empty(&uc->dev_head))
  156. return -ENODEV;
  157. uclass_foreach_dev(iter, uc) {
  158. if (iter == dev) {
  159. if (ucp)
  160. *ucp = uc;
  161. return i;
  162. }
  163. i++;
  164. }
  165. return -ENODEV;
  166. }
  167. int uclass_find_device(enum uclass_id id, int index, struct udevice **devp)
  168. {
  169. struct uclass *uc;
  170. struct udevice *dev;
  171. int ret;
  172. *devp = NULL;
  173. ret = uclass_get(id, &uc);
  174. if (ret)
  175. return ret;
  176. if (list_empty(&uc->dev_head))
  177. return -ENODEV;
  178. uclass_foreach_dev(dev, uc) {
  179. if (!index--) {
  180. *devp = dev;
  181. return 0;
  182. }
  183. }
  184. return -ENODEV;
  185. }
  186. int uclass_find_first_device(enum uclass_id id, struct udevice **devp)
  187. {
  188. struct uclass *uc;
  189. int ret;
  190. *devp = NULL;
  191. ret = uclass_get(id, &uc);
  192. if (ret)
  193. return ret;
  194. if (list_empty(&uc->dev_head))
  195. return 0;
  196. *devp = list_first_entry(&uc->dev_head, struct udevice, uclass_node);
  197. return 0;
  198. }
  199. int uclass_find_next_device(struct udevice **devp)
  200. {
  201. struct udevice *dev = *devp;
  202. *devp = NULL;
  203. if (list_is_last(&dev->uclass_node, &dev->uclass->dev_head))
  204. return 0;
  205. *devp = list_entry(dev->uclass_node.next, struct udevice, uclass_node);
  206. return 0;
  207. }
  208. int uclass_find_device_by_name(enum uclass_id id, const char *name,
  209. struct udevice **devp)
  210. {
  211. struct uclass *uc;
  212. struct udevice *dev;
  213. int ret;
  214. *devp = NULL;
  215. if (!name)
  216. return -EINVAL;
  217. ret = uclass_get(id, &uc);
  218. if (ret)
  219. return ret;
  220. uclass_foreach_dev(dev, uc) {
  221. if (!strcmp(dev->name, name)) {
  222. *devp = dev;
  223. return 0;
  224. }
  225. }
  226. return -ENODEV;
  227. }
  228. int uclass_find_next_free_req_seq(enum uclass_id id)
  229. {
  230. struct uclass *uc;
  231. struct udevice *dev;
  232. int ret;
  233. int max = -1;
  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->req_seq != -1) && (dev->req_seq > max))
  239. max = dev->req_seq;
  240. }
  241. if (max == -1)
  242. return 0;
  243. return max + 1;
  244. }
  245. int uclass_find_device_by_seq(enum uclass_id id, int seq_or_req_seq,
  246. bool find_req_seq, struct udevice **devp)
  247. {
  248. struct uclass *uc;
  249. struct udevice *dev;
  250. int ret;
  251. *devp = NULL;
  252. log_debug("%d %d\n", find_req_seq, seq_or_req_seq);
  253. if (seq_or_req_seq == -1)
  254. return -ENODEV;
  255. ret = uclass_get(id, &uc);
  256. if (ret)
  257. return ret;
  258. uclass_foreach_dev(dev, uc) {
  259. log_debug(" - %d %d '%s'\n",
  260. dev->req_seq, dev->seq, dev->name);
  261. if ((find_req_seq ? dev->req_seq : dev->seq) ==
  262. seq_or_req_seq) {
  263. *devp = dev;
  264. log_debug(" - found\n");
  265. return 0;
  266. }
  267. }
  268. log_debug(" - not found\n");
  269. return -ENODEV;
  270. }
  271. int uclass_find_device_by_of_offset(enum uclass_id id, int node,
  272. struct udevice **devp)
  273. {
  274. struct uclass *uc;
  275. struct udevice *dev;
  276. int ret;
  277. *devp = NULL;
  278. if (node < 0)
  279. return -ENODEV;
  280. ret = uclass_get(id, &uc);
  281. if (ret)
  282. return ret;
  283. uclass_foreach_dev(dev, uc) {
  284. if (dev_of_offset(dev) == node) {
  285. *devp = dev;
  286. return 0;
  287. }
  288. }
  289. return -ENODEV;
  290. }
  291. int uclass_find_device_by_ofnode(enum uclass_id id, ofnode node,
  292. struct udevice **devp)
  293. {
  294. struct uclass *uc;
  295. struct udevice *dev;
  296. int ret;
  297. log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
  298. *devp = NULL;
  299. if (!ofnode_valid(node))
  300. return -ENODEV;
  301. ret = uclass_get(id, &uc);
  302. if (ret)
  303. return ret;
  304. uclass_foreach_dev(dev, uc) {
  305. log(LOGC_DM, LOGL_DEBUG_CONTENT, " - checking %s\n",
  306. dev->name);
  307. if (ofnode_equal(dev_ofnode(dev), node)) {
  308. *devp = dev;
  309. goto done;
  310. }
  311. }
  312. ret = -ENODEV;
  313. done:
  314. log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
  315. ofnode_get_name(node), *devp ? (*devp)->name : "(none)", ret);
  316. return ret;
  317. }
  318. #if CONFIG_IS_ENABLED(OF_CONTROL)
  319. int uclass_find_device_by_phandle(enum uclass_id id, struct udevice *parent,
  320. const char *name, struct udevice **devp)
  321. {
  322. struct udevice *dev;
  323. struct uclass *uc;
  324. int find_phandle;
  325. int ret;
  326. *devp = NULL;
  327. find_phandle = dev_read_u32_default(parent, name, -1);
  328. if (find_phandle <= 0)
  329. return -ENOENT;
  330. ret = uclass_get(id, &uc);
  331. if (ret)
  332. return ret;
  333. uclass_foreach_dev(dev, uc) {
  334. uint phandle;
  335. phandle = dev_read_phandle(dev);
  336. if (phandle == find_phandle) {
  337. *devp = dev;
  338. return 0;
  339. }
  340. }
  341. return -ENODEV;
  342. }
  343. #endif
  344. int uclass_get_device_by_driver(enum uclass_id id,
  345. const struct driver *find_drv,
  346. struct udevice **devp)
  347. {
  348. struct udevice *dev;
  349. struct uclass *uc;
  350. int ret;
  351. ret = uclass_get(id, &uc);
  352. if (ret)
  353. return ret;
  354. uclass_foreach_dev(dev, uc) {
  355. if (dev->driver == find_drv)
  356. return uclass_get_device_tail(dev, 0, devp);
  357. }
  358. return -ENODEV;
  359. }
  360. int uclass_get_device_tail(struct udevice *dev, int ret, struct udevice **devp)
  361. {
  362. if (ret)
  363. return ret;
  364. assert(dev);
  365. ret = device_probe(dev);
  366. if (ret)
  367. return ret;
  368. *devp = dev;
  369. return 0;
  370. }
  371. int uclass_get_device(enum uclass_id id, int index, struct udevice **devp)
  372. {
  373. struct udevice *dev;
  374. int ret;
  375. *devp = NULL;
  376. ret = uclass_find_device(id, index, &dev);
  377. return uclass_get_device_tail(dev, ret, devp);
  378. }
  379. int uclass_get_device_by_name(enum uclass_id id, const char *name,
  380. struct udevice **devp)
  381. {
  382. struct udevice *dev;
  383. int ret;
  384. *devp = NULL;
  385. ret = uclass_find_device_by_name(id, name, &dev);
  386. return uclass_get_device_tail(dev, ret, devp);
  387. }
  388. int uclass_get_device_by_seq(enum uclass_id id, int seq, struct udevice **devp)
  389. {
  390. struct udevice *dev;
  391. int ret;
  392. *devp = NULL;
  393. ret = uclass_find_device_by_seq(id, seq, false, &dev);
  394. if (ret == -ENODEV) {
  395. /*
  396. * We didn't find it in probed devices. See if there is one
  397. * that will request this seq if probed.
  398. */
  399. ret = uclass_find_device_by_seq(id, seq, true, &dev);
  400. }
  401. return uclass_get_device_tail(dev, ret, devp);
  402. }
  403. int uclass_get_device_by_of_offset(enum uclass_id id, int node,
  404. struct udevice **devp)
  405. {
  406. struct udevice *dev;
  407. int ret;
  408. *devp = NULL;
  409. ret = uclass_find_device_by_of_offset(id, node, &dev);
  410. return uclass_get_device_tail(dev, ret, devp);
  411. }
  412. int uclass_get_device_by_ofnode(enum uclass_id id, ofnode node,
  413. struct udevice **devp)
  414. {
  415. struct udevice *dev;
  416. int ret;
  417. log(LOGC_DM, LOGL_DEBUG, "Looking for %s\n", ofnode_get_name(node));
  418. *devp = NULL;
  419. ret = uclass_find_device_by_ofnode(id, node, &dev);
  420. log(LOGC_DM, LOGL_DEBUG, " - result for %s: %s (ret=%d)\n",
  421. ofnode_get_name(node), dev ? dev->name : "(none)", ret);
  422. return uclass_get_device_tail(dev, ret, devp);
  423. }
  424. #if CONFIG_IS_ENABLED(OF_CONTROL)
  425. int uclass_get_device_by_phandle_id(enum uclass_id id, uint phandle_id,
  426. struct udevice **devp)
  427. {
  428. struct udevice *dev;
  429. struct uclass *uc;
  430. int ret;
  431. *devp = NULL;
  432. ret = uclass_get(id, &uc);
  433. if (ret)
  434. return ret;
  435. uclass_foreach_dev(dev, uc) {
  436. uint phandle;
  437. phandle = dev_read_phandle(dev);
  438. if (phandle == phandle_id) {
  439. *devp = dev;
  440. return uclass_get_device_tail(dev, ret, devp);
  441. }
  442. }
  443. return -ENODEV;
  444. }
  445. int uclass_get_device_by_phandle(enum uclass_id id, struct udevice *parent,
  446. const char *name, struct udevice **devp)
  447. {
  448. struct udevice *dev;
  449. int ret;
  450. *devp = NULL;
  451. ret = uclass_find_device_by_phandle(id, parent, name, &dev);
  452. return uclass_get_device_tail(dev, ret, devp);
  453. }
  454. #endif
  455. int uclass_first_device(enum uclass_id id, struct udevice **devp)
  456. {
  457. struct udevice *dev;
  458. int ret;
  459. *devp = NULL;
  460. ret = uclass_find_first_device(id, &dev);
  461. if (!dev)
  462. return 0;
  463. return uclass_get_device_tail(dev, ret, devp);
  464. }
  465. int uclass_first_device_err(enum uclass_id id, struct udevice **devp)
  466. {
  467. int ret;
  468. ret = uclass_first_device(id, devp);
  469. if (ret)
  470. return ret;
  471. else if (!*devp)
  472. return -ENODEV;
  473. return 0;
  474. }
  475. int uclass_next_device(struct udevice **devp)
  476. {
  477. struct udevice *dev = *devp;
  478. int ret;
  479. *devp = NULL;
  480. ret = uclass_find_next_device(&dev);
  481. if (!dev)
  482. return 0;
  483. return uclass_get_device_tail(dev, ret, devp);
  484. }
  485. int uclass_next_device_err(struct udevice **devp)
  486. {
  487. int ret;
  488. ret = uclass_next_device(devp);
  489. if (ret)
  490. return ret;
  491. else if (!*devp)
  492. return -ENODEV;
  493. return 0;
  494. }
  495. int uclass_first_device_check(enum uclass_id id, struct udevice **devp)
  496. {
  497. int ret;
  498. *devp = NULL;
  499. ret = uclass_find_first_device(id, devp);
  500. if (ret)
  501. return ret;
  502. if (!*devp)
  503. return 0;
  504. return device_probe(*devp);
  505. }
  506. int uclass_next_device_check(struct udevice **devp)
  507. {
  508. int ret;
  509. ret = uclass_find_next_device(devp);
  510. if (ret)
  511. return ret;
  512. if (!*devp)
  513. return 0;
  514. return device_probe(*devp);
  515. }
  516. int uclass_first_device_drvdata(enum uclass_id id, ulong driver_data,
  517. struct udevice **devp)
  518. {
  519. struct udevice *dev;
  520. struct uclass *uc;
  521. uclass_id_foreach_dev(id, dev, uc) {
  522. if (dev_get_driver_data(dev) == driver_data) {
  523. *devp = dev;
  524. return device_probe(dev);
  525. }
  526. }
  527. return -ENODEV;
  528. }
  529. int uclass_bind_device(struct udevice *dev)
  530. {
  531. struct uclass *uc;
  532. int ret;
  533. uc = dev->uclass;
  534. list_add_tail(&dev->uclass_node, &uc->dev_head);
  535. if (dev->parent) {
  536. struct uclass_driver *uc_drv = dev->parent->uclass->uc_drv;
  537. if (uc_drv->child_post_bind) {
  538. ret = uc_drv->child_post_bind(dev);
  539. if (ret)
  540. goto err;
  541. }
  542. }
  543. return 0;
  544. err:
  545. /* There is no need to undo the parent's post_bind call */
  546. list_del(&dev->uclass_node);
  547. return ret;
  548. }
  549. #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
  550. int uclass_unbind_device(struct udevice *dev)
  551. {
  552. struct uclass *uc;
  553. int ret;
  554. uc = dev->uclass;
  555. if (uc->uc_drv->pre_unbind) {
  556. ret = uc->uc_drv->pre_unbind(dev);
  557. if (ret)
  558. return ret;
  559. }
  560. list_del(&dev->uclass_node);
  561. return 0;
  562. }
  563. #endif
  564. int uclass_resolve_seq(struct udevice *dev)
  565. {
  566. struct udevice *dup;
  567. int seq;
  568. int ret;
  569. assert(dev->seq == -1);
  570. ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, dev->req_seq,
  571. false, &dup);
  572. if (!ret) {
  573. dm_warn("Device '%s': seq %d is in use by '%s'\n",
  574. dev->name, dev->req_seq, dup->name);
  575. } else if (ret == -ENODEV) {
  576. /* Our requested sequence number is available */
  577. if (dev->req_seq != -1)
  578. return dev->req_seq;
  579. } else {
  580. return ret;
  581. }
  582. for (seq = 0; seq < DM_MAX_SEQ; seq++) {
  583. ret = uclass_find_device_by_seq(dev->uclass->uc_drv->id, seq,
  584. false, &dup);
  585. if (ret == -ENODEV)
  586. break;
  587. if (ret)
  588. return ret;
  589. }
  590. return seq;
  591. }
  592. int uclass_pre_probe_device(struct udevice *dev)
  593. {
  594. struct uclass_driver *uc_drv;
  595. int ret;
  596. uc_drv = dev->uclass->uc_drv;
  597. if (uc_drv->pre_probe) {
  598. ret = uc_drv->pre_probe(dev);
  599. if (ret)
  600. return ret;
  601. }
  602. if (!dev->parent)
  603. return 0;
  604. uc_drv = dev->parent->uclass->uc_drv;
  605. if (uc_drv->child_pre_probe) {
  606. ret = uc_drv->child_pre_probe(dev);
  607. if (ret)
  608. return ret;
  609. }
  610. return 0;
  611. }
  612. int uclass_post_probe_device(struct udevice *dev)
  613. {
  614. struct uclass_driver *uc_drv;
  615. int ret;
  616. if (dev->parent) {
  617. uc_drv = dev->parent->uclass->uc_drv;
  618. if (uc_drv->child_post_probe) {
  619. ret = uc_drv->child_post_probe(dev);
  620. if (ret)
  621. return ret;
  622. }
  623. }
  624. uc_drv = dev->uclass->uc_drv;
  625. if (uc_drv->post_probe) {
  626. ret = uc_drv->post_probe(dev);
  627. if (ret)
  628. return ret;
  629. }
  630. return 0;
  631. }
  632. #if CONFIG_IS_ENABLED(DM_DEVICE_REMOVE)
  633. int uclass_pre_remove_device(struct udevice *dev)
  634. {
  635. struct uclass *uc;
  636. int ret;
  637. uc = dev->uclass;
  638. if (uc->uc_drv->pre_remove) {
  639. ret = uc->uc_drv->pre_remove(dev);
  640. if (ret)
  641. return ret;
  642. }
  643. return 0;
  644. }
  645. #endif
  646. UCLASS_DRIVER(nop) = {
  647. .id = UCLASS_NOP,
  648. .name = "nop",
  649. };