device.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823
  1. /*
  2. * Copyright (c) 2013 Google, Inc
  3. *
  4. * (C) Copyright 2012
  5. * Pavel Herrmann <morpheus.ibis@gmail.com>
  6. * Marek Vasut <marex@denx.de>
  7. *
  8. * SPDX-License-Identifier: GPL-2.0+
  9. */
  10. #ifndef _DM_DEVICE_H
  11. #define _DM_DEVICE_H
  12. #include <dm/uclass-id.h>
  13. #include <fdtdec.h>
  14. #include <linker_lists.h>
  15. #include <linux/compat.h>
  16. #include <linux/kernel.h>
  17. #include <linux/list.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 platdata */
  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_platdata */
  26. #define DM_FLAG_ALLOC_PARENT_PDATA (1 << 3)
  27. /* DM is responsible for allocating and freeing uclass_platdata */
  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. /**
  34. * struct udevice - An instance of a driver
  35. *
  36. * This holds information about a device, which is a driver bound to a
  37. * particular port or peripheral (essentially a driver instance).
  38. *
  39. * A device will come into existence through a 'bind' call, either due to
  40. * a U_BOOT_DEVICE() macro (in which case platdata is non-NULL) or a node
  41. * in the device tree (in which case of_offset is >= 0). In the latter case
  42. * we translate the device tree information into platdata in a function
  43. * implemented by the driver ofdata_to_platdata method (called just before the
  44. * probe method if the device has a device tree node.
  45. *
  46. * All three of platdata, priv and uclass_priv can be allocated by the
  47. * driver, or you can use the auto_alloc_size members of struct driver and
  48. * struct uclass_driver to have driver model do this automatically.
  49. *
  50. * @driver: The driver used by this device
  51. * @name: Name of device, typically the FDT node name
  52. * @platdata: Configuration data for this device
  53. * @parent_platdata: The parent bus's configuration data for this device
  54. * @uclass_platdata: The uclass's configuration data for this device
  55. * @of_offset: Device tree node offset for this device (- for none)
  56. * @driver_data: Driver data word for the entry that matched this device with
  57. * its driver
  58. * @parent: Parent of this device, or NULL for the top level device
  59. * @priv: Private data for this device
  60. * @uclass: Pointer to uclass for this device
  61. * @uclass_priv: The uclass's private data for this device
  62. * @parent_priv: The parent's private data for this device
  63. * @uclass_node: Used by uclass to link its devices
  64. * @child_head: List of children of this device
  65. * @sibling_node: Next device in list of all devices
  66. * @flags: Flags for this device DM_FLAG_...
  67. * @req_seq: Requested sequence number for this device (-1 = any)
  68. * @seq: Allocated sequence number for this device (-1 = none). This is set up
  69. * when the device is probed and will be unique within the device's uclass.
  70. * @devres_head: List of memory allocations associated with this device.
  71. * When CONFIG_DEVRES is enabled, devm_kmalloc() and friends will
  72. * add to this list. Memory so-allocated will be freed
  73. * automatically when the device is removed / unbound
  74. */
  75. struct udevice {
  76. const struct driver *driver;
  77. const char *name;
  78. void *platdata;
  79. void *parent_platdata;
  80. void *uclass_platdata;
  81. int of_offset;
  82. ulong driver_data;
  83. struct udevice *parent;
  84. void *priv;
  85. struct uclass *uclass;
  86. void *uclass_priv;
  87. void *parent_priv;
  88. struct list_head uclass_node;
  89. struct list_head child_head;
  90. struct list_head sibling_node;
  91. uint32_t flags;
  92. int req_seq;
  93. int seq;
  94. #ifdef CONFIG_DEVRES
  95. struct list_head devres_head;
  96. #endif
  97. };
  98. /* Maximum sequence number supported */
  99. #define DM_MAX_SEQ 999
  100. /* Returns the operations for a device */
  101. #define device_get_ops(dev) (dev->driver->ops)
  102. /* Returns non-zero if the device is active (probed and not removed) */
  103. #define device_active(dev) ((dev)->flags & DM_FLAG_ACTIVATED)
  104. /**
  105. * struct udevice_id - Lists the compatible strings supported by a driver
  106. * @compatible: Compatible string
  107. * @data: Data for this compatible string
  108. */
  109. struct udevice_id {
  110. const char *compatible;
  111. ulong data;
  112. };
  113. #if CONFIG_IS_ENABLED(OF_CONTROL)
  114. #define of_match_ptr(_ptr) (_ptr)
  115. #else
  116. #define of_match_ptr(_ptr) NULL
  117. #endif /* CONFIG_IS_ENABLED(OF_CONTROL) */
  118. /**
  119. * struct driver - A driver for a feature or peripheral
  120. *
  121. * This holds methods for setting up a new device, and also removing it.
  122. * The device needs information to set itself up - this is provided either
  123. * by platdata or a device tree node (which we find by looking up
  124. * matching compatible strings with of_match).
  125. *
  126. * Drivers all belong to a uclass, representing a class of devices of the
  127. * same type. Common elements of the drivers can be implemented in the uclass,
  128. * or the uclass can provide a consistent interface to the drivers within
  129. * it.
  130. *
  131. * @name: Device name
  132. * @id: Identiies the uclass we belong to
  133. * @of_match: List of compatible strings to match, and any identifying data
  134. * for each.
  135. * @bind: Called to bind a device to its driver
  136. * @probe: Called to probe a device, i.e. activate it
  137. * @remove: Called to remove a device, i.e. de-activate it
  138. * @unbind: Called to unbind a device from its driver
  139. * @ofdata_to_platdata: Called before probe to decode device tree data
  140. * @child_post_bind: Called after a new child has been bound
  141. * @child_pre_probe: Called before a child device is probed. The device has
  142. * memory allocated but it has not yet been probed.
  143. * @child_post_remove: Called after a child device is removed. The device
  144. * has memory allocated but its device_remove() method has been called.
  145. * @priv_auto_alloc_size: If non-zero this is the size of the private data
  146. * to be allocated in the device's ->priv pointer. If zero, then the driver
  147. * is responsible for allocating any data required.
  148. * @platdata_auto_alloc_size: If non-zero this is the size of the
  149. * platform data to be allocated in the device's ->platdata pointer.
  150. * This is typically only useful for device-tree-aware drivers (those with
  151. * an of_match), since drivers which use platdata will have the data
  152. * provided in the U_BOOT_DEVICE() instantiation.
  153. * @per_child_auto_alloc_size: Each device can hold private data owned by
  154. * its parent. If required this will be automatically allocated if this
  155. * value is non-zero.
  156. * @per_child_platdata_auto_alloc_size: A bus likes to store information about
  157. * its children. If non-zero this is the size of this data, to be allocated
  158. * in the child's parent_platdata pointer.
  159. * @ops: Driver-specific operations. This is typically a list of function
  160. * pointers defined by the driver, to implement driver functions required by
  161. * the uclass.
  162. * @flags: driver flags - see DM_FLAGS_...
  163. */
  164. struct driver {
  165. char *name;
  166. enum uclass_id id;
  167. const struct udevice_id *of_match;
  168. int (*bind)(struct udevice *dev);
  169. int (*probe)(struct udevice *dev);
  170. int (*remove)(struct udevice *dev);
  171. int (*unbind)(struct udevice *dev);
  172. int (*ofdata_to_platdata)(struct udevice *dev);
  173. int (*child_post_bind)(struct udevice *dev);
  174. int (*child_pre_probe)(struct udevice *dev);
  175. int (*child_post_remove)(struct udevice *dev);
  176. int priv_auto_alloc_size;
  177. int platdata_auto_alloc_size;
  178. int per_child_auto_alloc_size;
  179. int per_child_platdata_auto_alloc_size;
  180. const void *ops; /* driver-specific operations */
  181. uint32_t flags;
  182. };
  183. /* Declare a new U-Boot driver */
  184. #define U_BOOT_DRIVER(__name) \
  185. ll_entry_declare(struct driver, __name, driver)
  186. /**
  187. * dev_get_platdata() - Get the platform data for a device
  188. *
  189. * This checks that dev is not NULL, but no other checks for now
  190. *
  191. * @dev Device to check
  192. * @return platform data, or NULL if none
  193. */
  194. void *dev_get_platdata(struct udevice *dev);
  195. /**
  196. * dev_get_parent_platdata() - Get the parent platform data for a device
  197. *
  198. * This checks that dev is not NULL, but no other checks for now
  199. *
  200. * @dev Device to check
  201. * @return parent's platform data, or NULL if none
  202. */
  203. void *dev_get_parent_platdata(struct udevice *dev);
  204. /**
  205. * dev_get_uclass_platdata() - Get the uclass platform data for a device
  206. *
  207. * This checks that dev is not NULL, but no other checks for now
  208. *
  209. * @dev Device to check
  210. * @return uclass's platform data, or NULL if none
  211. */
  212. void *dev_get_uclass_platdata(struct udevice *dev);
  213. /**
  214. * dev_get_priv() - Get the private data for a device
  215. *
  216. * This checks that dev is not NULL, but no other checks for now
  217. *
  218. * @dev Device to check
  219. * @return private data, or NULL if none
  220. */
  221. void *dev_get_priv(struct udevice *dev);
  222. /**
  223. * dev_get_parent_priv() - Get the parent private data for a device
  224. *
  225. * The parent private data is data stored in the device but owned by the
  226. * parent. For example, a USB device may have parent data which contains
  227. * information about how to talk to the device over USB.
  228. *
  229. * This checks that dev is not NULL, but no other checks for now
  230. *
  231. * @dev Device to check
  232. * @return parent data, or NULL if none
  233. */
  234. void *dev_get_parent_priv(struct udevice *dev);
  235. /**
  236. * dev_get_uclass_priv() - Get the private uclass data for a device
  237. *
  238. * This checks that dev is not NULL, but no other checks for now
  239. *
  240. * @dev Device to check
  241. * @return private uclass data for this device, or NULL if none
  242. */
  243. void *dev_get_uclass_priv(struct udevice *dev);
  244. /**
  245. * struct dev_get_parent() - Get the parent of a device
  246. *
  247. * @child: Child to check
  248. * @return parent of child, or NULL if this is the root device
  249. */
  250. struct udevice *dev_get_parent(struct udevice *child);
  251. /**
  252. * dev_get_driver_data() - get the driver data used to bind a device
  253. *
  254. * When a device is bound using a device tree node, it matches a
  255. * particular compatible string in struct udevice_id. This function
  256. * returns the associated data value for that compatible string. This is
  257. * the 'data' field in struct udevice_id.
  258. *
  259. * As an example, consider this structure:
  260. * static const struct udevice_id tegra_i2c_ids[] = {
  261. * { .compatible = "nvidia,tegra114-i2c", .data = TYPE_114 },
  262. * { .compatible = "nvidia,tegra20-i2c", .data = TYPE_STD },
  263. * { .compatible = "nvidia,tegra20-i2c-dvc", .data = TYPE_DVC },
  264. * { }
  265. * };
  266. *
  267. * When driver model finds a driver for this it will store the 'data' value
  268. * corresponding to the compatible string it matches. This function returns
  269. * that value. This allows the driver to handle several variants of a device.
  270. *
  271. * For USB devices, this is the driver_info field in struct usb_device_id.
  272. *
  273. * @dev: Device to check
  274. * @return driver data (0 if none is provided)
  275. */
  276. ulong dev_get_driver_data(struct udevice *dev);
  277. /**
  278. * dev_get_driver_ops() - get the device's driver's operations
  279. *
  280. * This checks that dev is not NULL, and returns the pointer to device's
  281. * driver's operations.
  282. *
  283. * @dev: Device to check
  284. * @return void pointer to driver's operations or NULL for NULL-dev or NULL-ops
  285. */
  286. const void *dev_get_driver_ops(struct udevice *dev);
  287. /**
  288. * device_get_uclass_id() - return the uclass ID of a device
  289. *
  290. * @dev: Device to check
  291. * @return uclass ID for the device
  292. */
  293. enum uclass_id device_get_uclass_id(struct udevice *dev);
  294. /**
  295. * dev_get_uclass_name() - return the uclass name of a device
  296. *
  297. * This checks that dev is not NULL.
  298. *
  299. * @dev: Device to check
  300. * @return pointer to the uclass name for the device
  301. */
  302. const char *dev_get_uclass_name(struct udevice *dev);
  303. /**
  304. * device_get_child() - Get the child of a device by index
  305. *
  306. * Returns the numbered child, 0 being the first. This does not use
  307. * sequence numbers, only the natural order.
  308. *
  309. * @dev: Parent device to check
  310. * @index: Child index
  311. * @devp: Returns pointer to device
  312. * @return 0 if OK, -ENODEV if no such device, other error if the device fails
  313. * to probe
  314. */
  315. int device_get_child(struct udevice *parent, int index, struct udevice **devp);
  316. /**
  317. * device_find_child_by_seq() - Find a child device based on a sequence
  318. *
  319. * This searches for a device with the given seq or req_seq.
  320. *
  321. * For seq, if an active device has this sequence it will be returned.
  322. * If there is no such device then this will return -ENODEV.
  323. *
  324. * For req_seq, if a device (whether activated or not) has this req_seq
  325. * value, that device will be returned. This is a strong indication that
  326. * the device will receive that sequence when activated.
  327. *
  328. * @parent: Parent device
  329. * @seq_or_req_seq: Sequence number to find (0=first)
  330. * @find_req_seq: true to find req_seq, false to find seq
  331. * @devp: Returns pointer to device (there is only one per for each seq).
  332. * Set to NULL if none is found
  333. * @return 0 if OK, -ve on error
  334. */
  335. int device_find_child_by_seq(struct udevice *parent, int seq_or_req_seq,
  336. bool find_req_seq, struct udevice **devp);
  337. /**
  338. * device_get_child_by_seq() - Get a child device based on a sequence
  339. *
  340. * If an active device has this sequence it will be returned. If there is no
  341. * such device then this will check for a device that is requesting this
  342. * sequence.
  343. *
  344. * The device is probed to activate it ready for use.
  345. *
  346. * @parent: Parent device
  347. * @seq: Sequence number to find (0=first)
  348. * @devp: Returns pointer to device (there is only one per for each seq)
  349. * Set to NULL if none is found
  350. * @return 0 if OK, -ve on error
  351. */
  352. int device_get_child_by_seq(struct udevice *parent, int seq,
  353. struct udevice **devp);
  354. /**
  355. * device_find_child_by_of_offset() - Find a child device based on FDT offset
  356. *
  357. * Locates a child device by its device tree offset.
  358. *
  359. * @parent: Parent device
  360. * @of_offset: Device tree offset to find
  361. * @devp: Returns pointer to device if found, otherwise this is set to NULL
  362. * @return 0 if OK, -ve on error
  363. */
  364. int device_find_child_by_of_offset(struct udevice *parent, int of_offset,
  365. struct udevice **devp);
  366. /**
  367. * device_get_child_by_of_offset() - Get a child device based on FDT offset
  368. *
  369. * Locates a child device by its device tree offset.
  370. *
  371. * The device is probed to activate it ready for use.
  372. *
  373. * @parent: Parent device
  374. * @of_offset: Device tree offset to find
  375. * @devp: Returns pointer to device if found, otherwise this is set to NULL
  376. * @return 0 if OK, -ve on error
  377. */
  378. int device_get_child_by_of_offset(struct udevice *parent, int of_offset,
  379. struct udevice **devp);
  380. /**
  381. * device_get_global_by_of_offset() - Get a device based on FDT offset
  382. *
  383. * Locates a device by its device tree offset, searching globally throughout
  384. * the all driver model devices.
  385. *
  386. * The device is probed to activate it ready for use.
  387. *
  388. * @of_offset: Device tree offset to find
  389. * @devp: Returns pointer to device if found, otherwise this is set to NULL
  390. * @return 0 if OK, -ve on error
  391. */
  392. int device_get_global_by_of_offset(int of_offset, struct udevice **devp);
  393. /**
  394. * device_find_first_child() - Find the first child of a device
  395. *
  396. * @parent: Parent device to search
  397. * @devp: Returns first child device, or NULL if none
  398. * @return 0
  399. */
  400. int device_find_first_child(struct udevice *parent, struct udevice **devp);
  401. /**
  402. * device_find_next_child() - Find the next child of a device
  403. *
  404. * @devp: Pointer to previous child device on entry. Returns pointer to next
  405. * child device, or NULL if none
  406. * @return 0
  407. */
  408. int device_find_next_child(struct udevice **devp);
  409. /**
  410. * dev_get_addr() - Get the reg property of a device
  411. *
  412. * @dev: Pointer to a device
  413. *
  414. * @return addr
  415. */
  416. fdt_addr_t dev_get_addr(struct udevice *dev);
  417. /**
  418. * dev_get_addr_index() - Get the indexed reg property of a device
  419. *
  420. * @dev: Pointer to a device
  421. * @index: the 'reg' property can hold a list of <addr, size> pairs
  422. * and @index is used to select which one is required
  423. *
  424. * @return addr
  425. */
  426. fdt_addr_t dev_get_addr_index(struct udevice *dev, int index);
  427. /**
  428. * dev_get_addr_name() - Get the reg property of a device, indexed by name
  429. *
  430. * @dev: Pointer to a device
  431. * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
  432. * 'reg-names' property providing named-based identification. @index
  433. * indicates the value to search for in 'reg-names'.
  434. *
  435. * @return addr
  436. */
  437. fdt_addr_t dev_get_addr_name(struct udevice *dev, const char *name);
  438. /**
  439. * device_has_children() - check if a device has any children
  440. *
  441. * @dev: Device to check
  442. * @return true if the device has one or more children
  443. */
  444. bool device_has_children(struct udevice *dev);
  445. /**
  446. * device_has_active_children() - check if a device has any active children
  447. *
  448. * @dev: Device to check
  449. * @return true if the device has one or more children and at least one of
  450. * them is active (probed).
  451. */
  452. bool device_has_active_children(struct udevice *dev);
  453. /**
  454. * device_is_last_sibling() - check if a device is the last sibling
  455. *
  456. * This function can be useful for display purposes, when special action needs
  457. * to be taken when displaying the last sibling. This can happen when a tree
  458. * view of devices is being displayed.
  459. *
  460. * @dev: Device to check
  461. * @return true if there are no more siblings after this one - i.e. is it
  462. * last in the list.
  463. */
  464. bool device_is_last_sibling(struct udevice *dev);
  465. /**
  466. * device_set_name() - set the name of a device
  467. *
  468. * This must be called in the device's bind() method and no later. Normally
  469. * this is unnecessary but for probed devices which don't get a useful name
  470. * this function can be helpful.
  471. *
  472. * @dev: Device to update
  473. * @name: New name (this string is allocated new memory and attached to
  474. * the device)
  475. * @return 0 if OK, -ENOMEM if there is not enough memory to allocate the
  476. * string
  477. */
  478. int device_set_name(struct udevice *dev, const char *name);
  479. /**
  480. * device_is_on_pci_bus - Test if a device is on a PCI bus
  481. *
  482. * @dev: device to test
  483. * @return: true if it is on a PCI bus, false otherwise
  484. */
  485. static inline bool device_is_on_pci_bus(struct udevice *dev)
  486. {
  487. return device_get_uclass_id(dev->parent) == UCLASS_PCI;
  488. }
  489. /**
  490. * device_foreach_child_safe() - iterate through child devices safely
  491. *
  492. * This allows the @pos child to be removed in the loop if required.
  493. *
  494. * @pos: struct udevice * for the current device
  495. * @next: struct udevice * for the next device
  496. * @parent: parent device to scan
  497. */
  498. #define device_foreach_child_safe(pos, next, parent) \
  499. list_for_each_entry_safe(pos, next, &parent->child_head, sibling_node)
  500. /* device resource management */
  501. typedef void (*dr_release_t)(struct udevice *dev, void *res);
  502. typedef int (*dr_match_t)(struct udevice *dev, void *res, void *match_data);
  503. #ifdef CONFIG_DEVRES
  504. #ifdef CONFIG_DEBUG_DEVRES
  505. void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
  506. const char *name);
  507. #define _devres_alloc(release, size, gfp) \
  508. __devres_alloc(release, size, gfp, #release)
  509. #else
  510. void *_devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
  511. #endif
  512. /**
  513. * devres_alloc() - Allocate device resource data
  514. * @release: Release function devres will be associated with
  515. * @size: Allocation size
  516. * @gfp: Allocation flags
  517. *
  518. * Allocate devres of @size bytes. The allocated area is associated
  519. * with @release. The returned pointer can be passed to
  520. * other devres_*() functions.
  521. *
  522. * RETURNS:
  523. * Pointer to allocated devres on success, NULL on failure.
  524. */
  525. #define devres_alloc(release, size, gfp) \
  526. _devres_alloc(release, size, gfp | __GFP_ZERO)
  527. /**
  528. * devres_free() - Free device resource data
  529. * @res: Pointer to devres data to free
  530. *
  531. * Free devres created with devres_alloc().
  532. */
  533. void devres_free(void *res);
  534. /**
  535. * devres_add() - Register device resource
  536. * @dev: Device to add resource to
  537. * @res: Resource to register
  538. *
  539. * Register devres @res to @dev. @res should have been allocated
  540. * using devres_alloc(). On driver detach, the associated release
  541. * function will be invoked and devres will be freed automatically.
  542. */
  543. void devres_add(struct udevice *dev, void *res);
  544. /**
  545. * devres_find() - Find device resource
  546. * @dev: Device to lookup resource from
  547. * @release: Look for resources associated with this release function
  548. * @match: Match function (optional)
  549. * @match_data: Data for the match function
  550. *
  551. * Find the latest devres of @dev which is associated with @release
  552. * and for which @match returns 1. If @match is NULL, it's considered
  553. * to match all.
  554. *
  555. * @return pointer to found devres, NULL if not found.
  556. */
  557. void *devres_find(struct udevice *dev, dr_release_t release,
  558. dr_match_t match, void *match_data);
  559. /**
  560. * devres_get() - Find devres, if non-existent, add one atomically
  561. * @dev: Device to lookup or add devres for
  562. * @new_res: Pointer to new initialized devres to add if not found
  563. * @match: Match function (optional)
  564. * @match_data: Data for the match function
  565. *
  566. * Find the latest devres of @dev which has the same release function
  567. * as @new_res and for which @match return 1. If found, @new_res is
  568. * freed; otherwise, @new_res is added atomically.
  569. *
  570. * @return ointer to found or added devres.
  571. */
  572. void *devres_get(struct udevice *dev, void *new_res,
  573. dr_match_t match, void *match_data);
  574. /**
  575. * devres_remove() - Find a device resource and remove it
  576. * @dev: Device to find resource from
  577. * @release: Look for resources associated with this release function
  578. * @match: Match function (optional)
  579. * @match_data: Data for the match function
  580. *
  581. * Find the latest devres of @dev associated with @release and for
  582. * which @match returns 1. If @match is NULL, it's considered to
  583. * match all. If found, the resource is removed atomically and
  584. * returned.
  585. *
  586. * @return ointer to removed devres on success, NULL if not found.
  587. */
  588. void *devres_remove(struct udevice *dev, dr_release_t release,
  589. dr_match_t match, void *match_data);
  590. /**
  591. * devres_destroy() - Find a device resource and destroy it
  592. * @dev: Device to find resource from
  593. * @release: Look for resources associated with this release function
  594. * @match: Match function (optional)
  595. * @match_data: Data for the match function
  596. *
  597. * Find the latest devres of @dev associated with @release and for
  598. * which @match returns 1. If @match is NULL, it's considered to
  599. * match all. If found, the resource is removed atomically and freed.
  600. *
  601. * Note that the release function for the resource will not be called,
  602. * only the devres-allocated data will be freed. The caller becomes
  603. * responsible for freeing any other data.
  604. *
  605. * @return 0 if devres is found and freed, -ENOENT if not found.
  606. */
  607. int devres_destroy(struct udevice *dev, dr_release_t release,
  608. dr_match_t match, void *match_data);
  609. /**
  610. * devres_release() - Find a device resource and destroy it, calling release
  611. * @dev: Device to find resource from
  612. * @release: Look for resources associated with this release function
  613. * @match: Match function (optional)
  614. * @match_data: Data for the match function
  615. *
  616. * Find the latest devres of @dev associated with @release and for
  617. * which @match returns 1. If @match is NULL, it's considered to
  618. * match all. If found, the resource is removed atomically, the
  619. * release function called and the resource freed.
  620. *
  621. * @return 0 if devres is found and freed, -ENOENT if not found.
  622. */
  623. int devres_release(struct udevice *dev, dr_release_t release,
  624. dr_match_t match, void *match_data);
  625. /* managed devm_k.alloc/kfree for device drivers */
  626. /**
  627. * devm_kmalloc() - Resource-managed kmalloc
  628. * @dev: Device to allocate memory for
  629. * @size: Allocation size
  630. * @gfp: Allocation gfp flags
  631. *
  632. * Managed kmalloc. Memory allocated with this function is
  633. * automatically freed on driver detach. Like all other devres
  634. * resources, guaranteed alignment is unsigned long long.
  635. *
  636. * @return pointer to allocated memory on success, NULL on failure.
  637. */
  638. void *devm_kmalloc(struct udevice *dev, size_t size, gfp_t gfp);
  639. static inline void *devm_kzalloc(struct udevice *dev, size_t size, gfp_t gfp)
  640. {
  641. return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
  642. }
  643. static inline void *devm_kmalloc_array(struct udevice *dev,
  644. size_t n, size_t size, gfp_t flags)
  645. {
  646. if (size != 0 && n > SIZE_MAX / size)
  647. return NULL;
  648. return devm_kmalloc(dev, n * size, flags);
  649. }
  650. static inline void *devm_kcalloc(struct udevice *dev,
  651. size_t n, size_t size, gfp_t flags)
  652. {
  653. return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
  654. }
  655. /**
  656. * devm_kfree() - Resource-managed kfree
  657. * @dev: Device this memory belongs to
  658. * @ptr: Memory to free
  659. *
  660. * Free memory allocated with devm_kmalloc().
  661. */
  662. void devm_kfree(struct udevice *dev, void *ptr);
  663. #else /* ! CONFIG_DEVRES */
  664. static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
  665. {
  666. return kzalloc(size, gfp);
  667. }
  668. static inline void devres_free(void *res)
  669. {
  670. kfree(res);
  671. }
  672. static inline void devres_add(struct udevice *dev, void *res)
  673. {
  674. }
  675. static inline void *devres_find(struct udevice *dev, dr_release_t release,
  676. dr_match_t match, void *match_data)
  677. {
  678. return NULL;
  679. }
  680. static inline void *devres_get(struct udevice *dev, void *new_res,
  681. dr_match_t match, void *match_data)
  682. {
  683. return NULL;
  684. }
  685. static inline void *devres_remove(struct udevice *dev, dr_release_t release,
  686. dr_match_t match, void *match_data)
  687. {
  688. return NULL;
  689. }
  690. static inline int devres_destroy(struct udevice *dev, dr_release_t release,
  691. dr_match_t match, void *match_data)
  692. {
  693. return 0;
  694. }
  695. static inline int devres_release(struct udevice *dev, dr_release_t release,
  696. dr_match_t match, void *match_data)
  697. {
  698. return 0;
  699. }
  700. static inline void *devm_kmalloc(struct udevice *dev, size_t size, gfp_t gfp)
  701. {
  702. return kmalloc(size, gfp);
  703. }
  704. static inline void *devm_kzalloc(struct udevice *dev, size_t size, gfp_t gfp)
  705. {
  706. return kzalloc(size, gfp);
  707. }
  708. static inline void *devm_kmaloc_array(struct udevice *dev,
  709. size_t n, size_t size, gfp_t flags)
  710. {
  711. /* TODO: add kmalloc_array() to linux/compat.h */
  712. if (size != 0 && n > SIZE_MAX / size)
  713. return NULL;
  714. return kmalloc(n * size, flags);
  715. }
  716. static inline void *devm_kcalloc(struct udevice *dev,
  717. size_t n, size_t size, gfp_t flags)
  718. {
  719. /* TODO: add kcalloc() to linux/compat.h */
  720. return kmalloc(n * size, flags | __GFP_ZERO);
  721. }
  722. static inline void devm_kfree(struct udevice *dev, void *ptr)
  723. {
  724. kfree(ptr);
  725. }
  726. #endif /* ! CONFIG_DEVRES */
  727. /**
  728. * dm_set_translation_offset() - Set translation offset
  729. * @offs: Translation offset
  730. *
  731. * Some platforms need a special address translation. Those
  732. * platforms (e.g. mvebu in SPL) can configure a translation
  733. * offset in the DM by calling this function. It will be
  734. * added to all addresses returned in dev_get_addr().
  735. */
  736. void dm_set_translation_offset(fdt_addr_t offs);
  737. /**
  738. * dm_get_translation_offset() - Get translation offset
  739. *
  740. * This function returns the translation offset that can
  741. * be configured by calling dm_set_translation_offset().
  742. *
  743. * @return translation offset for the device address (0 as default).
  744. */
  745. fdt_addr_t dm_get_translation_offset(void);
  746. #endif