diff options
author | Simon Glass <sjg@chromium.org> | 2020-10-03 11:31:24 -0600 |
---|---|---|
committer | Simon Glass <sjg@chromium.org> | 2020-10-29 14:42:17 -0600 |
commit | e4fb5faa044ffc66170f8776794386e5e11e13a2 (patch) | |
tree | 135bca2a338f1154fe5aadc9d9d89cb5ef48a2c9 /tools | |
parent | c14732984759d64634350d01d58daca8cf44d23f (diff) | |
download | u-boot-e4fb5faa044ffc66170f8776794386e5e11e13a2.zip u-boot-e4fb5faa044ffc66170f8776794386e5e11e13a2.tar.gz u-boot-e4fb5faa044ffc66170f8776794386e5e11e13a2.tar.bz2 |
dtoc: Document the return value of scan_structs()
Add documentation to this function as well as generate_structs(), where
the return value is ultimately passed in.
Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'tools')
-rw-r--r-- | tools/dtoc/dtb_platdata.py | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/tools/dtoc/dtb_platdata.py b/tools/dtoc/dtb_platdata.py index 1b52198..72725bb 100644 --- a/tools/dtoc/dtb_platdata.py +++ b/tools/dtoc/dtb_platdata.py @@ -466,6 +466,13 @@ class DtbPlatdata(object): Once the widest property is determined, all other properties are updated to match that width. + + Returns: + dict containing structures: + key (str): Node name, as a C identifier + value: dict containing structure fields: + key (str): Field name + value: Prop object with field information """ structs = {} for node in self._valid_nodes: @@ -536,6 +543,14 @@ class DtbPlatdata(object): This writes out the body of a header file consisting of structure definitions for node in self._valid_nodes. See the documentation in doc/driver-model/of-plat.rst for more information. + + Args: + structs: dict containing structures: + key (str): Node name, as a C identifier + value: dict containing structure fields: + key (str): Field name + value: Prop object with field information + """ self.out_header() self.out('#include <stdbool.h>\n') |