device.h 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900
  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. * Marek Vasut <marex@denx.de>
  8. */
  9. #ifndef _DM_DEVICE_H
  10. #define _DM_DEVICE_H
  11. #include <dm/ofnode.h>
  12. #include <dm/uclass-id.h>
  13. #include <fdtdec.h>
  14. #include <linker_lists.h>
  15. #include <linux/kernel.h>
  16. #include <linux/list.h>
  17. #include <linux/printk.h>
  18. struct driver_info;
  19. /* Driver is active (probed). Cleared when it is removed */
  20. #define DM_FLAG_ACTIVATED (1 << 0)
  21. /* DM is responsible for allocating and freeing plat */
  22. #define DM_FLAG_ALLOC_PDATA (1 << 1)
  23. /* DM should init this device prior to relocation */
  24. #define DM_FLAG_PRE_RELOC (1 << 2)
  25. /* DM is responsible for allocating and freeing parent_plat */
  26. #define DM_FLAG_ALLOC_PARENT_PDATA (1 << 3)
  27. /* DM is responsible for allocating and freeing uclass_plat */
  28. #define DM_FLAG_ALLOC_UCLASS_PDATA (1 << 4)
  29. /* Allocate driver private data on a DMA boundary */
  30. #define DM_FLAG_ALLOC_PRIV_DMA (1 << 5)
  31. /* Device is bound */
  32. #define DM_FLAG_BOUND (1 << 6)
  33. /* Device name is allocated and should be freed on unbind() */
  34. #define DM_FLAG_NAME_ALLOCED (1 << 7)
  35. /* Device has platform data provided by of-platdata */
  36. #define DM_FLAG_OF_PLATDATA (1 << 8)
  37. /*
  38. * Call driver remove function to stop currently active DMA transfers or
  39. * give DMA buffers back to the HW / controller. This may be needed for
  40. * some drivers to do some final stage cleanup before the OS is called
  41. * (U-Boot exit)
  42. */
  43. #define DM_FLAG_ACTIVE_DMA (1 << 9)
  44. /*
  45. * Call driver remove function to do some final configuration, before
  46. * U-Boot exits and the OS is started
  47. */
  48. #define DM_FLAG_OS_PREPARE (1 << 10)
  49. /* DM does not enable/disable the power domains corresponding to this device */
  50. #define DM_FLAG_DEFAULT_PD_CTRL_OFF (1 << 11)
  51. /* Driver plat has been read. Cleared when the device is removed */
  52. #define DM_FLAG_PLATDATA_VALID (1 << 12)
  53. /*
  54. * Device is removed without switching off its power domain. This might
  55. * be required, i. e. for serial console (debug) output when booting OS.
  56. */
  57. #define DM_FLAG_REMOVE_WITH_PD_ON (1 << 13)
  58. /*
  59. * One or multiple of these flags are passed to device_remove() so that
  60. * a selective device removal as specified by the remove-stage and the
  61. * driver flags can be done.
  62. */
  63. enum {
  64. /* Normal remove, remove all devices */
  65. DM_REMOVE_NORMAL = 1 << 0,
  66. /* Remove devices with active DMA */
  67. DM_REMOVE_ACTIVE_DMA = DM_FLAG_ACTIVE_DMA,
  68. /* Remove devices which need some final OS preparation steps */
  69. DM_REMOVE_OS_PREPARE = DM_FLAG_OS_PREPARE,
  70. /* Add more use cases here */
  71. /* Remove devices with any active flag */
  72. DM_REMOVE_ACTIVE_ALL = DM_REMOVE_ACTIVE_DMA | DM_REMOVE_OS_PREPARE,
  73. /* Don't power down any attached power domains */
  74. DM_REMOVE_NO_PD = 1 << 1,
  75. };
  76. /**
  77. * struct udevice - An instance of a driver
  78. *
  79. * This holds information about a device, which is a driver bound to a
  80. * particular port or peripheral (essentially a driver instance).
  81. *
  82. * A device will come into existence through a 'bind' call, either due to
  83. * a U_BOOT_DEVICE() macro (in which case plat is non-NULL) or a node
  84. * in the device tree (in which case of_offset is >= 0). In the latter case
  85. * we translate the device tree information into plat in a function
  86. * implemented by the driver of_to_plat method (called just before the
  87. * probe method if the device has a device tree node.
  88. *
  89. * All three of plat, priv and uclass_priv can be allocated by the
  90. * driver, or you can use the auto_alloc_size members of struct driver and
  91. * struct uclass_driver to have driver model do this automatically.
  92. *
  93. * @driver: The driver used by this device
  94. * @name: Name of device, typically the FDT node name
  95. * @plat_: Configuration data for this device (do not access outside driver
  96. * model)
  97. * @parent_plat_: The parent bus's configuration data for this device (do not
  98. * access outside driver model)
  99. * @uclass_plat_: The uclass's configuration data for this device (do not access
  100. * outside driver model)
  101. * @node: Reference to device tree node for this device
  102. * @driver_data: Driver data word for the entry that matched this device with
  103. * its driver
  104. * @parent: Parent of this device, or NULL for the top level device
  105. * @priv_: Private data for this device (do not access outside driver model)
  106. * @uclass: Pointer to uclass for this device
  107. * @uclass_priv_: The uclass's private data for this device (do not access
  108. * outside driver model)
  109. * @parent_priv_: The parent's private data for this device (do not access
  110. * outside driver model)
  111. * @uclass_node: Used by uclass to link its devices
  112. * @child_head: List of children of this device
  113. * @sibling_node: Next device in list of all devices
  114. * @flags_: Flags for this device DM_FLAG_... (do not access outside driver
  115. * model)
  116. * @seq_: Allocated sequence number for this device (-1 = none). This is set up
  117. * when the device is bound and is unique within the device's uclass. If the
  118. * device has an alias in the devicetree then that is used to set the sequence
  119. * number. Otherwise, the next available number is used. Sequence numbers are
  120. * used by certain commands that need device to be numbered (e.g. 'mmc dev').
  121. * (do not access outside driver model)
  122. * @devres_head: List of memory allocations associated with this device.
  123. * When CONFIG_DEVRES is enabled, devm_kmalloc() and friends will
  124. * add to this list. Memory so-allocated will be freed
  125. * automatically when the device is removed / unbound
  126. */
  127. struct udevice {
  128. const struct driver *driver;
  129. const char *name;
  130. void *plat_;
  131. void *parent_plat_;
  132. void *uclass_plat_;
  133. ofnode node;
  134. ulong driver_data;
  135. struct udevice *parent;
  136. void *priv_;
  137. struct uclass *uclass;
  138. void *uclass_priv_;
  139. void *parent_priv_;
  140. struct list_head uclass_node;
  141. struct list_head child_head;
  142. struct list_head sibling_node;
  143. u32 flags_;
  144. int seq_;
  145. #ifdef CONFIG_DEVRES
  146. struct list_head devres_head;
  147. #endif
  148. };
  149. /* Maximum sequence number supported */
  150. #define DM_MAX_SEQ 999
  151. /* Returns the operations for a device */
  152. #define device_get_ops(dev) (dev->driver->ops)
  153. static inline u32 dev_get_flags(const struct udevice *dev)
  154. {
  155. return dev->flags_;
  156. }
  157. static inline void dev_or_flags(struct udevice *dev, u32 or)
  158. {
  159. dev->flags_ |= or;
  160. }
  161. static inline void dev_bic_flags(struct udevice *dev, u32 bic)
  162. {
  163. dev->flags_ &= ~bic;
  164. }
  165. /**
  166. * dev_ofnode() - get the DT node reference associated with a udevice
  167. *
  168. * @dev: device to check
  169. * @return reference of the the device's DT node
  170. */
  171. static inline ofnode dev_ofnode(const struct udevice *dev)
  172. {
  173. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  174. return dev->node;
  175. #else
  176. return ofnode_null();
  177. #endif
  178. }
  179. /* Returns non-zero if the device is active (probed and not removed) */
  180. #define device_active(dev) (dev_get_flags(dev) & DM_FLAG_ACTIVATED)
  181. static inline int dev_of_offset(const struct udevice *dev)
  182. {
  183. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  184. return ofnode_to_offset(dev_ofnode(dev));
  185. #else
  186. return -1;
  187. #endif
  188. }
  189. static inline bool dev_has_ofnode(const struct udevice *dev)
  190. {
  191. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  192. return ofnode_valid(dev_ofnode(dev));
  193. #else
  194. return false;
  195. #endif
  196. }
  197. static inline void dev_set_ofnode(struct udevice *dev, ofnode node)
  198. {
  199. #if !CONFIG_IS_ENABLED(OF_PLATDATA)
  200. dev->node = node;
  201. #endif
  202. }
  203. static inline int dev_seq(const struct udevice *dev)
  204. {
  205. return dev->seq_;
  206. }
  207. /**
  208. * struct udevice_id - Lists the compatible strings supported by a driver
  209. * @compatible: Compatible string
  210. * @data: Data for this compatible string
  211. */
  212. struct udevice_id {
  213. const char *compatible;
  214. ulong data;
  215. };
  216. #if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
  217. #define of_match_ptr(_ptr) (_ptr)
  218. #else
  219. #define of_match_ptr(_ptr) NULL
  220. #endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
  221. /**
  222. * struct driver - A driver for a feature or peripheral
  223. *
  224. * This holds methods for setting up a new device, and also removing it.
  225. * The device needs information to set itself up - this is provided either
  226. * by plat or a device tree node (which we find by looking up
  227. * matching compatible strings with of_match).
  228. *
  229. * Drivers all belong to a uclass, representing a class of devices of the
  230. * same type. Common elements of the drivers can be implemented in the uclass,
  231. * or the uclass can provide a consistent interface to the drivers within
  232. * it.
  233. *
  234. * @name: Device name
  235. * @id: Identifies the uclass we belong to
  236. * @of_match: List of compatible strings to match, and any identifying data
  237. * for each.
  238. * @bind: Called to bind a device to its driver
  239. * @probe: Called to probe a device, i.e. activate it
  240. * @remove: Called to remove a device, i.e. de-activate it
  241. * @unbind: Called to unbind a device from its driver
  242. * @of_to_plat: Called before probe to decode device tree data
  243. * @child_post_bind: Called after a new child has been bound
  244. * @child_pre_probe: Called before a child device is probed. The device has
  245. * memory allocated but it has not yet been probed.
  246. * @child_post_remove: Called after a child device is removed. The device
  247. * has memory allocated but its device_remove() method has been called.
  248. * @priv_auto: If non-zero this is the size of the private data
  249. * to be allocated in the device's ->priv pointer. If zero, then the driver
  250. * is responsible for allocating any data required.
  251. * @plat_auto: If non-zero this is the size of the
  252. * platform data to be allocated in the device's ->plat pointer.
  253. * This is typically only useful for device-tree-aware drivers (those with
  254. * an of_match), since drivers which use plat will have the data
  255. * provided in the U_BOOT_DEVICE() instantiation.
  256. * @per_child_auto: Each device can hold private data owned by
  257. * its parent. If required this will be automatically allocated if this
  258. * value is non-zero.
  259. * @per_child_plat_auto: A bus likes to store information about
  260. * its children. If non-zero this is the size of this data, to be allocated
  261. * in the child's parent_plat pointer.
  262. * @ops: Driver-specific operations. This is typically a list of function
  263. * pointers defined by the driver, to implement driver functions required by
  264. * the uclass.
  265. * @flags: driver flags - see DM_FLAGS_...
  266. * @acpi_ops: Advanced Configuration and Power Interface (ACPI) operations,
  267. * allowing the device to add things to the ACPI tables passed to Linux
  268. */
  269. struct driver {
  270. char *name;
  271. enum uclass_id id;
  272. const struct udevice_id *of_match;
  273. int (*bind)(struct udevice *dev);
  274. int (*probe)(struct udevice *dev);
  275. int (*remove)(struct udevice *dev);
  276. int (*unbind)(struct udevice *dev);
  277. int (*of_to_plat)(struct udevice *dev);
  278. int (*child_post_bind)(struct udevice *dev);
  279. int (*child_pre_probe)(struct udevice *dev);
  280. int (*child_post_remove)(struct udevice *dev);
  281. int priv_auto;
  282. int plat_auto;
  283. int per_child_auto;
  284. int per_child_plat_auto;
  285. const void *ops; /* driver-specific operations */
  286. uint32_t flags;
  287. #if CONFIG_IS_ENABLED(ACPIGEN)
  288. struct acpi_ops *acpi_ops;
  289. #endif
  290. };
  291. /* Declare a new U-Boot driver */
  292. #define U_BOOT_DRIVER(__name) \
  293. ll_entry_declare(struct driver, __name, driver)
  294. /* Get a pointer to a given driver */
  295. #define DM_GET_DRIVER(__name) \
  296. ll_entry_get(struct driver, __name, driver)
  297. /**
  298. * Declare a macro to state a alias for a driver name. This macro will
  299. * produce no code but its information will be parsed by tools like
  300. * dtoc
  301. */
  302. #define U_BOOT_DRIVER_ALIAS(__name, __alias)
  303. /**
  304. * dev_get_plat() - Get the platform data for a device
  305. *
  306. * This checks that dev is not NULL, but no other checks for now
  307. *
  308. * @dev Device to check
  309. * @return platform data, or NULL if none
  310. */
  311. void *dev_get_plat(const struct udevice *dev);
  312. /**
  313. * dev_get_parent_plat() - Get the parent platform data for a device
  314. *
  315. * This checks that dev is not NULL, but no other checks for now
  316. *
  317. * @dev Device to check
  318. * @return parent's platform data, or NULL if none
  319. */
  320. void *dev_get_parent_plat(const struct udevice *dev);
  321. /**
  322. * dev_get_uclass_plat() - Get the uclass platform data for a device
  323. *
  324. * This checks that dev is not NULL, but no other checks for now
  325. *
  326. * @dev Device to check
  327. * @return uclass's platform data, or NULL if none
  328. */
  329. void *dev_get_uclass_plat(const struct udevice *dev);
  330. /**
  331. * dev_get_priv() - Get the private data for a device
  332. *
  333. * This checks that dev is not NULL, but no other checks for now
  334. *
  335. * @dev Device to check
  336. * @return private data, or NULL if none
  337. */
  338. void *dev_get_priv(const struct udevice *dev);
  339. /**
  340. * dev_get_parent_priv() - Get the parent private data for a device
  341. *
  342. * The parent private data is data stored in the device but owned by the
  343. * parent. For example, a USB device may have parent data which contains
  344. * information about how to talk to the device over USB.
  345. *
  346. * This checks that dev is not NULL, but no other checks for now
  347. *
  348. * @dev Device to check
  349. * @return parent data, or NULL if none
  350. */
  351. void *dev_get_parent_priv(const struct udevice *dev);
  352. /**
  353. * dev_get_uclass_priv() - Get the private uclass data for a device
  354. *
  355. * This checks that dev is not NULL, but no other checks for now
  356. *
  357. * @dev Device to check
  358. * @return private uclass data for this device, or NULL if none
  359. */
  360. void *dev_get_uclass_priv(const struct udevice *dev);
  361. /**
  362. * struct dev_get_parent() - Get the parent of a device
  363. *
  364. * @child: Child to check
  365. * @return parent of child, or NULL if this is the root device
  366. */
  367. struct udevice *dev_get_parent(const struct udevice *child);
  368. /**
  369. * dev_get_driver_data() - get the driver data used to bind a device
  370. *
  371. * When a device is bound using a device tree node, it matches a
  372. * particular compatible string in struct udevice_id. This function
  373. * returns the associated data value for that compatible string. This is
  374. * the 'data' field in struct udevice_id.
  375. *
  376. * As an example, consider this structure:
  377. * static const struct udevice_id tegra_i2c_ids[] = {
  378. * { .compatible = "nvidia,tegra114-i2c", .data = TYPE_114 },
  379. * { .compatible = "nvidia,tegra20-i2c", .data = TYPE_STD },
  380. * { .compatible = "nvidia,tegra20-i2c-dvc", .data = TYPE_DVC },
  381. * { }
  382. * };
  383. *
  384. * When driver model finds a driver for this it will store the 'data' value
  385. * corresponding to the compatible string it matches. This function returns
  386. * that value. This allows the driver to handle several variants of a device.
  387. *
  388. * For USB devices, this is the driver_info field in struct usb_device_id.
  389. *
  390. * @dev: Device to check
  391. * @return driver data (0 if none is provided)
  392. */
  393. ulong dev_get_driver_data(const struct udevice *dev);
  394. /**
  395. * dev_get_driver_ops() - get the device's driver's operations
  396. *
  397. * This checks that dev is not NULL, and returns the pointer to device's
  398. * driver's operations.
  399. *
  400. * @dev: Device to check
  401. * @return void pointer to driver's operations or NULL for NULL-dev or NULL-ops
  402. */
  403. const void *dev_get_driver_ops(const struct udevice *dev);
  404. /**
  405. * device_get_uclass_id() - return the uclass ID of a device
  406. *
  407. * @dev: Device to check
  408. * @return uclass ID for the device
  409. */
  410. enum uclass_id device_get_uclass_id(const struct udevice *dev);
  411. /**
  412. * dev_get_uclass_name() - return the uclass name of a device
  413. *
  414. * This checks that dev is not NULL.
  415. *
  416. * @dev: Device to check
  417. * @return pointer to the uclass name for the device
  418. */
  419. const char *dev_get_uclass_name(const struct udevice *dev);
  420. /**
  421. * device_get_child() - Get the child of a device by index
  422. *
  423. * Returns the numbered child, 0 being the first. This does not use
  424. * sequence numbers, only the natural order.
  425. *
  426. * @dev: Parent device to check
  427. * @index: Child index
  428. * @devp: Returns pointer to device
  429. * @return 0 if OK, -ENODEV if no such device, other error if the device fails
  430. * to probe
  431. */
  432. int device_get_child(const struct udevice *parent, int index,
  433. struct udevice **devp);
  434. /**
  435. * device_get_child_count() - Get the available child count of a device
  436. *
  437. * Returns the number of children to a device.
  438. *
  439. * @parent: Parent device to check
  440. */
  441. int device_get_child_count(const struct udevice *parent);
  442. /**
  443. * device_find_child_by_seq() - Find a child device based on a sequence
  444. *
  445. * This searches for a device with the given seq.
  446. *
  447. * @parent: Parent device
  448. * @seq: Sequence number to find (0=first)
  449. * @devp: Returns pointer to device (there is only one per for each seq).
  450. * Set to NULL if none is found
  451. * @return 0 if OK, -ENODEV if not found
  452. */
  453. int device_find_child_by_seq(const struct udevice *parent, int seq,
  454. struct udevice **devp);
  455. /**
  456. * device_get_child_by_seq() - Get a child device based on a sequence
  457. *
  458. * If an active device has this sequence it will be returned. If there is no
  459. * such device then this will check for a device that is requesting this
  460. * sequence.
  461. *
  462. * The device is probed to activate it ready for use.
  463. *
  464. * @parent: Parent device
  465. * @seq: Sequence number to find (0=first)
  466. * @devp: Returns pointer to device (there is only one per for each seq)
  467. * Set to NULL if none is found
  468. * @return 0 if OK, -ve on error
  469. */
  470. int device_get_child_by_seq(const struct udevice *parent, int seq,
  471. struct udevice **devp);
  472. /**
  473. * device_find_child_by_of_offset() - Find a child device based on FDT offset
  474. *
  475. * Locates a child device by its device tree offset.
  476. *
  477. * @parent: Parent device
  478. * @of_offset: Device tree offset to find
  479. * @devp: Returns pointer to device if found, otherwise this is set to NULL
  480. * @return 0 if OK, -ve on error
  481. */
  482. int device_find_child_by_of_offset(const struct udevice *parent, int of_offset,
  483. struct udevice **devp);
  484. /**
  485. * device_get_child_by_of_offset() - Get a child device based on FDT offset
  486. *
  487. * Locates a child device by its device tree offset.
  488. *
  489. * The device is probed to activate it ready for use.
  490. *
  491. * @parent: Parent device
  492. * @of_offset: Device tree offset to find
  493. * @devp: Returns pointer to device if found, otherwise this is set to NULL
  494. * @return 0 if OK, -ve on error
  495. */
  496. int device_get_child_by_of_offset(const struct udevice *parent, int of_offset,
  497. struct udevice **devp);
  498. /**
  499. * device_find_global_by_ofnode() - Get a device based on ofnode
  500. *
  501. * Locates a device by its device tree ofnode, searching globally throughout
  502. * the all driver model devices.
  503. *
  504. * The device is NOT probed
  505. *
  506. * @node: Device tree ofnode to find
  507. * @devp: Returns pointer to device if found, otherwise this is set to NULL
  508. * @return 0 if OK, -ve on error
  509. */
  510. int device_find_global_by_ofnode(ofnode node, struct udevice **devp);
  511. /**
  512. * device_get_global_by_ofnode() - Get a device based on ofnode
  513. *
  514. * Locates a device by its device tree ofnode, searching globally throughout
  515. * the all driver model devices.
  516. *
  517. * The device is probed to activate it ready for use.
  518. *
  519. * @node: Device tree ofnode to find
  520. * @devp: Returns pointer to device if found, otherwise this is set to NULL
  521. * @return 0 if OK, -ve on error
  522. */
  523. int device_get_global_by_ofnode(ofnode node, struct udevice **devp);
  524. /**
  525. * device_get_by_driver_info() - Get a device based on driver_info
  526. *
  527. * Locates a device by its struct driver_info, by using its reference which
  528. * is updated during the bind process.
  529. *
  530. * The device is probed to activate it ready for use.
  531. *
  532. * @info: Struct driver_info
  533. * @devp: Returns pointer to device if found, otherwise this is set to NULL
  534. * @return 0 if OK, -ve on error
  535. */
  536. int device_get_by_driver_info(const struct driver_info *info,
  537. struct udevice **devp);
  538. /**
  539. * device_get_by_driver_info_idx() - Get a device based on driver_info index
  540. *
  541. * Locates a device by its struct driver_info, by using its index number which
  542. * is written into the idx field of struct phandle_1_arg, etc.
  543. *
  544. * The device is probed to activate it ready for use.
  545. *
  546. * @idx: Index number of the driver_info structure (0=first)
  547. * @devp: Returns pointer to device if found, otherwise this is set to NULL
  548. * @return 0 if OK, -ve on error
  549. */
  550. int device_get_by_driver_info_idx(uint idx, struct udevice **devp);
  551. /**
  552. * device_find_first_child() - Find the first child of a device
  553. *
  554. * @parent: Parent device to search
  555. * @devp: Returns first child device, or NULL if none
  556. * @return 0
  557. */
  558. int device_find_first_child(const struct udevice *parent,
  559. struct udevice **devp);
  560. /**
  561. * device_find_next_child() - Find the next child of a device
  562. *
  563. * @devp: Pointer to previous child device on entry. Returns pointer to next
  564. * child device, or NULL if none
  565. * @return 0
  566. */
  567. int device_find_next_child(struct udevice **devp);
  568. /**
  569. * device_find_first_inactive_child() - Find the first inactive child
  570. *
  571. * This is used to locate an existing child of a device which is of a given
  572. * uclass.
  573. *
  574. * The device is NOT probed
  575. *
  576. * @parent: Parent device to search
  577. * @uclass_id: Uclass to look for
  578. * @devp: Returns device found, if any
  579. * @return 0 if found, else -ENODEV
  580. */
  581. int device_find_first_inactive_child(const struct udevice *parent,
  582. enum uclass_id uclass_id,
  583. struct udevice **devp);
  584. /**
  585. * device_find_first_child_by_uclass() - Find the first child of a device in uc
  586. *
  587. * @parent: Parent device to search
  588. * @uclass_id: Uclass to look for
  589. * @devp: Returns first child device in that uclass, if any
  590. * @return 0 if found, else -ENODEV
  591. */
  592. int device_find_first_child_by_uclass(const struct udevice *parent,
  593. enum uclass_id uclass_id,
  594. struct udevice **devp);
  595. /**
  596. * device_find_child_by_name() - Find a child by device name
  597. *
  598. * @parent: Parent device to search
  599. * @name: Name to look for
  600. * @devp: Returns device found, if any
  601. * @return 0 if found, else -ENODEV
  602. */
  603. int device_find_child_by_name(const struct udevice *parent, const char *name,
  604. struct udevice **devp);
  605. /**
  606. * device_first_child_ofdata_err() - Find the first child and reads its plat
  607. *
  608. * The of_to_plat() method is called on the child before it is returned,
  609. * but the child is not probed.
  610. *
  611. * @parent: Parent to check
  612. * @devp: Returns child that was found, if any
  613. * @return 0 on success, -ENODEV if no children, other -ve on error
  614. */
  615. int device_first_child_ofdata_err(struct udevice *parent,
  616. struct udevice **devp);
  617. /*
  618. * device_next_child_ofdata_err() - Find the next child and read its plat
  619. *
  620. * The of_to_plat() method is called on the child before it is returned,
  621. * but the child is not probed.
  622. *
  623. * @devp: On entry, points to the previous child; on exit returns the child that
  624. * was found, if any
  625. * @return 0 on success, -ENODEV if no children, other -ve on error
  626. */
  627. int device_next_child_ofdata_err(struct udevice **devp);
  628. /**
  629. * device_first_child_err() - Get the first child of a device
  630. *
  631. * The device returned is probed if necessary, and ready for use
  632. *
  633. * @parent: Parent device to search
  634. * @devp: Returns device found, if any
  635. * @return 0 if found, -ENODEV if not, -ve error if device failed to probe
  636. */
  637. int device_first_child_err(struct udevice *parent, struct udevice **devp);
  638. /**
  639. * device_next_child_err() - Get the next child of a parent device
  640. *
  641. * The device returned is probed if necessary, and ready for use
  642. *
  643. * @devp: On entry, pointer to device to lookup. On exit, returns pointer
  644. * to the next sibling if no error occurred
  645. * @return 0 if found, -ENODEV if not, -ve error if device failed to probe
  646. */
  647. int device_next_child_err(struct udevice **devp);
  648. /**
  649. * device_has_children() - check if a device has any children
  650. *
  651. * @dev: Device to check
  652. * @return true if the device has one or more children
  653. */
  654. bool device_has_children(const struct udevice *dev);
  655. /**
  656. * device_has_active_children() - check if a device has any active children
  657. *
  658. * @dev: Device to check
  659. * @return true if the device has one or more children and at least one of
  660. * them is active (probed).
  661. */
  662. bool device_has_active_children(const struct udevice *dev);
  663. /**
  664. * device_is_last_sibling() - check if a device is the last sibling
  665. *
  666. * This function can be useful for display purposes, when special action needs
  667. * to be taken when displaying the last sibling. This can happen when a tree
  668. * view of devices is being displayed.
  669. *
  670. * @dev: Device to check
  671. * @return true if there are no more siblings after this one - i.e. is it
  672. * last in the list.
  673. */
  674. bool device_is_last_sibling(const struct udevice *dev);
  675. /**
  676. * device_set_name() - set the name of a device
  677. *
  678. * This must be called in the device's bind() method and no later. Normally
  679. * this is unnecessary but for probed devices which don't get a useful name
  680. * this function can be helpful.
  681. *
  682. * The name is allocated and will be freed automatically when the device is
  683. * unbound.
  684. *
  685. * @dev: Device to update
  686. * @name: New name (this string is allocated new memory and attached to
  687. * the device)
  688. * @return 0 if OK, -ENOMEM if there is not enough memory to allocate the
  689. * string
  690. */
  691. int device_set_name(struct udevice *dev, const char *name);
  692. /**
  693. * device_set_name_alloced() - note that a device name is allocated
  694. *
  695. * This sets the DM_FLAG_NAME_ALLOCED flag for the device, so that when it is
  696. * unbound the name will be freed. This avoids memory leaks.
  697. *
  698. * @dev: Device to update
  699. */
  700. void device_set_name_alloced(struct udevice *dev);
  701. /**
  702. * device_is_compatible() - check if the device is compatible with the compat
  703. *
  704. * This allows to check whether the device is comaptible with the compat.
  705. *
  706. * @dev: udevice pointer for which compatible needs to be verified.
  707. * @compat: Compatible string which needs to verified in the given
  708. * device
  709. * @return true if OK, false if the compatible is not found
  710. */
  711. bool device_is_compatible(const struct udevice *dev, const char *compat);
  712. /**
  713. * of_machine_is_compatible() - check if the machine is compatible with
  714. * the compat
  715. *
  716. * This allows to check whether the machine is comaptible with the compat.
  717. *
  718. * @compat: Compatible string which needs to verified
  719. * @return true if OK, false if the compatible is not found
  720. */
  721. bool of_machine_is_compatible(const char *compat);
  722. /**
  723. * dev_disable_by_path() - Disable a device given its device tree path
  724. *
  725. * @path: The device tree path identifying the device to be disabled
  726. * @return 0 on success, -ve on error
  727. */
  728. int dev_disable_by_path(const char *path);
  729. /**
  730. * dev_enable_by_path() - Enable a device given its device tree path
  731. *
  732. * @path: The device tree path identifying the device to be enabled
  733. * @return 0 on success, -ve on error
  734. */
  735. int dev_enable_by_path(const char *path);
  736. /**
  737. * device_is_on_pci_bus - Test if a device is on a PCI bus
  738. *
  739. * @dev: device to test
  740. * @return: true if it is on a PCI bus, false otherwise
  741. */
  742. static inline bool device_is_on_pci_bus(const struct udevice *dev)
  743. {
  744. return dev->parent && device_get_uclass_id(dev->parent) == UCLASS_PCI;
  745. }
  746. /**
  747. * device_foreach_child_safe() - iterate through child devices safely
  748. *
  749. * This allows the @pos child to be removed in the loop if required.
  750. *
  751. * @pos: struct udevice * for the current device
  752. * @next: struct udevice * for the next device
  753. * @parent: parent device to scan
  754. */
  755. #define device_foreach_child_safe(pos, next, parent) \
  756. list_for_each_entry_safe(pos, next, &parent->child_head, sibling_node)
  757. /**
  758. * device_foreach_child() - iterate through child devices
  759. *
  760. * @pos: struct udevice * for the current device
  761. * @parent: parent device to scan
  762. */
  763. #define device_foreach_child(pos, parent) \
  764. list_for_each_entry(pos, &parent->child_head, sibling_node)
  765. /**
  766. * device_foreach_child_of_to_plat() - iterate through children
  767. *
  768. * This stops when it gets an error, with @pos set to the device that failed to
  769. * read ofdata.
  770. * This creates a for() loop which works through the available children of
  771. * a device in order from start to end. Device ofdata is read by calling
  772. * device_of_to_plat() on each one. The devices are not probed.
  773. *
  774. * @pos: struct udevice * for the current device
  775. * @parent: parent device to scan
  776. */
  777. #define device_foreach_child_of_to_plat(pos, parent) \
  778. for (int _ret = device_first_child_ofdata_err(parent, &dev); !_ret; \
  779. _ret = device_next_child_ofdata_err(&dev))
  780. /**
  781. * device_foreach_child_probe() - iterate through children, probing them
  782. *
  783. * This creates a for() loop which works through the available children of
  784. * a device in order from start to end. Devices are probed if necessary,
  785. * and ready for use.
  786. *
  787. * This stops when it gets an error, with @pos set to the device that failed to
  788. * probe
  789. *
  790. * @pos: struct udevice * for the current device
  791. * @parent: parent device to scan
  792. */
  793. #define device_foreach_child_probe(pos, parent) \
  794. for (int _ret = device_first_child_err(parent, &dev); !_ret; \
  795. _ret = device_next_child_err(&dev))
  796. /**
  797. * dm_scan_fdt_dev() - Bind child device in the device tree
  798. *
  799. * This handles device which have sub-nodes in the device tree. It scans all
  800. * sub-nodes and binds drivers for each node where a driver can be found.
  801. *
  802. * If this is called prior to relocation, only pre-relocation devices will be
  803. * bound (those marked with u-boot,dm-pre-reloc in the device tree, or where
  804. * the driver has the DM_FLAG_PRE_RELOC flag set). Otherwise, all devices will
  805. * be bound.
  806. *
  807. * @dev: Device to scan
  808. * @return 0 if OK, -ve on error
  809. */
  810. int dm_scan_fdt_dev(struct udevice *dev);
  811. #endif