leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: add include/dm/root.h to the HTML documentation

Browse Source 
Correct Sphinx style comments in include/dm/devres.h
and add the associated driver model API to the HTML documentation.

Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Patrick Delaunay 2022-01-12 10:53:43 +01:00 committed by Heinrich Schuchardt
parent 797b2a2ed4
commit 0cdd7ded88
2 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/api/dm.rst
View File

@ -7,3 +7,4 @@ Uclass and Driver
-----------------
.. kernel-doc:: include/dm/uclass.h
.. kernel-doc:: include/dm/root.h

20
include/dm/root.h
View File

@ -19,7 +19,7 @@ extern struct list_head uclass_head;
*
* This function returns pointer to the root node of the driver tree,
*
* @return pointer to root device, or NULL if not inited yet
* Return: pointer to root device, or NULL if not inited yet
*/
struct udevice *dm_root(void);
@ -27,6 +27,8 @@ struct global_data;
/**
* dm_fixup_for_gd_move() - Handle global_data moving to a new place
*
* @new_gd: Pointer to the new global data
*
* The uclass list is part of global_data. Due to the way lists work, moving
* the list will cause it to become invalid. This function fixes that up so
* that the uclass list will work correctly.
@ -40,7 +42,7 @@ void dm_fixup_for_gd_move(struct global_data *new_gd);
*
* @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC
* flag. If false bind all drivers.
* @return 0 if OK, -ve on error
* Return: 0 if OK, -ve on error
*/
int dm_scan_plat(bool pre_reloc_only);
@ -52,7 +54,7 @@ int dm_scan_plat(bool pre_reloc_only);
*
* @pre_reloc_only: If true, bind only nodes with special devicetree properties,
* or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
* @return 0 if OK, -ve on error
* Return: 0 if OK, -ve on error
*/
int dm_scan_fdt(bool pre_reloc_only);
@ -65,7 +67,7 @@ int dm_scan_fdt(bool pre_reloc_only);
*
* @pre_reloc_only: If true, bind only nodes with special devicetree properties,
* or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
* @return 0 if OK, -ve on error
* Return: 0 if OK, -ve on error
*/
int dm_extended_scan(bool pre_reloc_only);
@ -79,7 +81,7 @@ int dm_extended_scan(bool pre_reloc_only);
*
* @pre_reloc_only: If true, bind only nodes with special devicetree properties,
* or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
* @return 0 if OK, -ve on error
* Return: 0 if OK, -ve on error
*/
int dm_scan_other(bool pre_reloc_only);
@ -92,7 +94,7 @@ int dm_scan_other(bool pre_reloc_only);
*
* @pre_reloc_only: If true, bind only nodes with special devicetree properties,
* or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
* @return 0 if OK, -ve on error
* Return: 0 if OK, -ve on error
*/
int dm_init_and_scan(bool pre_reloc_only);
@ -103,7 +105,7 @@ int dm_init_and_scan(bool pre_reloc_only);
* This needs to be called before anything uses the DM
*
* @of_live: Enable live device tree
* @return 0 if OK, -ve on error
* Return: 0 if OK, -ve on error
*/
int dm_init(bool of_live);
@ -111,7 +113,7 @@ int dm_init(bool of_live);
* dm_uninit - Uninitialise Driver Model structures
*
* All devices will be removed and unbound
* @return 0 if OK, -ve on error
* Return: 0 if OK, -ve on error
*/
int dm_uninit(void);
@ -124,7 +126,7 @@ int dm_uninit(void);
* All devices with the matching flags set will be removed
*
* @flags: Flags for selective device removal
* @return 0 if OK, -ve on error
* Return: 0 if OK, -ve on error
*/
int dm_remove_devices_flags(uint flags);
#else