LM
/
u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Simon Glass 2014-07-23 06:55:17 -06:00
parent 3234aa4bab
commit 0040b94429
5 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/dm/device.h
View File

@ -124,7 +124,7 @@ struct udevice_id {
* This is typically only useful for device-tree-aware drivers (those with * This is typically only useful for device-tree-aware drivers (those with
* an of_match), since drivers which use platdata will have the data * an of_match), since drivers which use platdata will have the data
* provided in the U_BOOT_DEVICE() instantiation. * 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 * pointers defined by the driver, to implement driver functions required by
* the uclass. * the uclass.
* @flags: driver flags - see DM_FLAGS_... * @flags: driver flags - see DM_FLAGS_...

10
include/dm/platdata.h
View File

@ -11,9 +11,15 @@
#ifndef _DM_PLATDATA_H #ifndef _DM_PLATDATA_H
#define _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 { struct driver_info {
const char *name; const char *name;
const void *platdata; const void *platdata;
}; };
#define U_BOOT_DEVICE(__name) \ #define U_BOOT_DEVICE(__name) \

3
include/dm/root.h
View File

@ -35,7 +35,8 @@ int dm_scan_platdata(bool pre_reloc_only);
/** /**
* dm_scan_fdt() - Scan the device tree and bind drivers * 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 * @blob: Pointer to device tree blob
* @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC

2
include/dm/uclass-id.h
View File

@ -19,7 +19,7 @@ enum uclass_id {
UCLASS_TEST_FDT, UCLASS_TEST_FDT,
/* U-Boot uclasses start here */ /* U-Boot uclasses start here */
UCLASS_GPIO, UCLASS_GPIO, /* Bank of general-purpose I/O pins */
UCLASS_COUNT, UCLASS_COUNT,
UCLASS_INVALID = -1, UCLASS_INVALID = -1,

2
include/dm/uclass.h
View File

@ -98,7 +98,7 @@ int uclass_get(enum uclass_id key, struct uclass **ucp);
* *
* The device is probed to activate it ready for use. * 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) * @index: Device number within that uclass (0=first)
* @devp: Returns pointer to device (there is only one per for each ID) * @devp: Returns pointer to device (there is only one per for each ID)
* @return 0 if OK, -ve on error * @return 0 if OK, -ve on error