diff mbox series

[08/12] dm: Add comments to dt-structs contents

Message ID 20210807132413.3513724-9-sjg@chromium.org
State Accepted
Commit 4ee0cc89dbbeb2d6b08e702afc1332f7dec8a38f
Delegated to: Simon Glass
Headers show
Series dm: Expand of-platdata support to GPIOs and clean up | expand

Commit Message

Simon Glass Aug. 7, 2021, 1:24 p.m. UTC 
These structs do not have comments at present. Add them.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 include/dt-structs.h | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

Comments

Simon Glass Sept. 26, 2021, 6:40 p.m. UTC | #1 
These structs do not have comments at present. Add them.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 include/dt-structs.h | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

Applied to u-boot-dm/next, thanks!
diff mbox series

Patch

diff --git a/include/dt-structs.h b/include/dt-structs.h
index f9ccaf56a46..fa1622cb1dc 100644
--- a/include/dt-structs.h
+++ b/include/dt-structs.h
@@ -10,16 +10,43 @@ 
 #if CONFIG_IS_ENABLED(OF_PLATDATA)
 struct driver_info;
 
+/**
+ * struct phandle_0_arg - hold a phandle record with no arguments
+ *
+ * This holds a phandle pointing to another device. See 'Indexes' in the
+ * of-plat-rst documentation.
+ *
+ * @idx: udevice index (or driver_info index if !OF_PLATDATA_INST)
+ * @arg: arguments
+ */
 struct phandle_0_arg {
 	uint idx;
 	int arg[0];
 };
 
+/**
+ * struct phandle_2_arg - hold a phandle record with up to one argument
+ *
+ * This holds a phandle pointing to another device. See 'Indexes' in the
+ * of-plat-rst documentation.
+ *
+ * @idx: udevice index (or driver_info index if !OF_PLATDATA_INST)
+ * @arg: arguments
+ */
 struct phandle_1_arg {
 	uint idx;
 	int arg[1];
 };
 
+/**
+ * struct phandle_2_arg - hold a phandle record with up to two arguments
+ *
+ * This holds a phandle pointing to another device. See 'Indexes' in the
+ * of-plat-rst documentation.
+ *
+ * @idx: udevice index (or driver_info index if !OF_PLATDATA_INST)
+ * @arg: arguments
+ */
 struct phandle_2_arg {
 	uint idx;
 	int arg[2];