summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2014-07-23 06:55:17 -0600
committerSimon Glass <sjg@chromium.org>2014-07-23 14:07:26 +0100
commit0040b9442947d00a540f6e93742384a14453c37e (patch)
tree2aa741afd34f31f5a2dce02ed547190ca945652c
parent3234aa4babd79bf92239409145db4fda2f505051 (diff)
downloadu-boot-imx-0040b9442947d00a540f6e93742384a14453c37e.zip
u-boot-imx-0040b9442947d00a540f6e93742384a14453c37e.tar.gz
u-boot-imx-0040b9442947d00a540f6e93742384a14453c37e.tar.bz2
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>
-rw-r--r--include/dm/device.h2
-rw-r--r--include/dm/platdata.h10
-rw-r--r--include/dm/root.h3
-rw-r--r--include/dm/uclass-id.h2
-rw-r--r--include/dm/uclass.h2
5 files changed, 13 insertions, 6 deletions
diff --git a/include/dm/device.h b/include/dm/device.h
index 6005e7e..9077490 100644
--- 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 0ef3353..2bc8b14 100644
--- 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 09f9303..02c7788 100644
--- 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 f0e691c..77ff9ea 100644
--- 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 0b5ade6..8d09ecf 100644
--- 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