dm: Tidy up some header file comments

Fix up the style of a few comments and add/clarify a few others.

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

diff --git a/include/dm/device.h b/include/dm/device.h
index 6005e7eeb5ab9e6d2b48de323c747482d0806c63..9077490901e6dffd745c5e964dde1c625457fb48 100644 (file)
--- a/include/dm/device.h
+++ b/include/dm/device.h
@@ -124,7 +124,7 @@ struct udevice_id {
  * This is typically only useful for device-tree-aware drivers (those with
  * an of_match), since drivers which use platdata will have the data
  * provided in the U_BOOT_DEVICE() instantiation.
- * ops: Driver-specific operations. This is typically a list of function
+ * @ops: Driver-specific operations. This is typically a list of function
  * pointers defined by the driver, to implement driver functions required by
  * the uclass.
  * @flags: driver flags - see DM_FLAGS_...

diff --git a/include/dm/platdata.h b/include/dm/platdata.h
index 0ef3353e74651e1e9b60066f43ee90ab9a48a021..2bc8b147edfed01f152c1ca5e310ba8248637534 100644 (file)
--- a/include/dm/platdata.h
+++ b/include/dm/platdata.h
@@ -11,9 +11,15 @@
 #ifndef _DM_PLATDATA_H
 #define _DM_PLATDATA_H
 
+/**
+ * struct driver_info - Information required to instantiate a device
+ *
+ * @name:      Device name
+ * @platdata:  Driver-specific platform data
+ */
 struct driver_info {
-       const char      *name;
-       const void      *platdata;
+       const char *name;
+       const void *platdata;
 };
 
 #define U_BOOT_DEVICE(__name)                                          \

diff --git a/include/dm/root.h b/include/dm/root.h
index 09f930377403e91d7939f80de14d37bd9b4ac7a6..02c7788da0508077b8c720d13836ea4c476cc54b 100644 (file)
--- a/include/dm/root.h
+++ b/include/dm/root.h
@@ -35,7 +35,8 @@ int dm_scan_platdata(bool pre_reloc_only);
 /**
  * dm_scan_fdt() - Scan the device tree and bind drivers
  *
- * This scans the device tree and creates a driver for each node
+ * This scans the device tree and creates a driver for each node. Only
+ * the top-level subnodes are examined.
  *
  * @blob: Pointer to device tree blob
  * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC

diff --git a/include/dm/uclass-id.h b/include/dm/uclass-id.h
index f0e691c18c8950fd7a3401100222954a11b07980..77ff9eae904ab817aaa18206edd77606ae84ff50 100644 (file)
--- a/include/dm/uclass-id.h
+++ b/include/dm/uclass-id.h
@@ -19,7 +19,7 @@ enum uclass_id {
        UCLASS_TEST_FDT,
 
        /* U-Boot uclasses start here */
-       UCLASS_GPIO,
+       UCLASS_GPIO,            /* Bank of general-purpose I/O pins */
 
        UCLASS_COUNT,
        UCLASS_INVALID = -1,

diff --git a/include/dm/uclass.h b/include/dm/uclass.h
index 0b5ade6d68c2c1fe9d5d57b22799ca6147828b9d..8d09ecff7b4e0c0c4590792391303f0eeea7f2f6 100644 (file)
--- a/include/dm/uclass.h
+++ b/include/dm/uclass.h
@@ -98,7 +98,7 @@ int uclass_get(enum uclass_id key, struct uclass **ucp);
  *
  * The device is probed to activate it ready for use.
  *
- * id: ID to look up
+ * @id: ID to look up
  * @index: Device number within that uclass (0=first)
  * @devp: Returns pointer to device (there is only one per for each ID)
  * @return 0 if OK, -ve on error