From: Simon Glass <sjg@chromium.org>
Date: Sat, 7 Aug 2021 13:24:08 +0000 (-0600)
Subject: dm: Add comments to dt-structs contents
X-Git-Tag: v2025.01-rc5-pxa1908~1694^2~9^2~7
X-Git-Url: http://git.dujemihanovic.xyz/img/sics.gif?a=commitdiff_plain;h=4ee0cc89dbbeb2d6b08e702afc1332f7dec8a38f;p=u-boot.git

dm: Add comments to dt-structs contents

These structs do not have comments at present. Add them.

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

diff --git a/include/dt-structs.h b/include/dt-structs.h
index f9ccaf56a4..fa1622cb1d 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];