mirrors/u-boot
0
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2024-12-02 00:53:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

dm: core: Document the livetree structures properly

Browse Source 
Clarify the data structure so it is easier for people to understand,
particularly the corner cases.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass 2022-09-06 20:27:01 -06:00 committed by Tom Rini
parent 62d638386c
commit 5ecba3ba40
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
include/dm/of.h
View File

@ -31,10 +31,21 @@ struct property {
/** /**
* struct device_node: Device tree node * struct device_node: Device tree node
* *
* @name: Node name * The top of this tree is typically gd->of_root which points to the root node.
*
* The head of the list of children for the root node (and any other node) is
* in @child, with @sibling providing a link to the next child.
*
* Each child has a pointer to its parent in @parent.
*
* A node may have properties in which case the head of the list of properties
* @properties pointers to the first one, with struct property->@next pointing
* to the next one.
*
* @name: Node name, "" for the root node
* @type: Node type (value of device_type property) or "<NULL>" if none * @type: Node type (value of device_type property) or "<NULL>" if none
* @phandle: Phandle value of this none, or 0 if none * @phandle: Phandle value of this none, or 0 if none
* @full_name: Full path to node, e.g. "/bus@1/spi@1100" * @full_name: Full path to node, e.g. "/bus@1/spi@1100" ("/" for the root node)
* @properties: Pointer to head of list of properties, or NULL if none * @properties: Pointer to head of list of properties, or NULL if none
* @parent: Pointer to parent node, or NULL if this is the root node * @parent: Pointer to parent node, or NULL if this is the root node
* @child: Pointer to head of child node list, or NULL if no children * @child: Pointer to head of child node list, or NULL if no children