dm: core: Improve comments for uclass_first/next_device()

Mention that the devices are probed ready for use.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass 2015-01-25 08:26:57 -07:00
parent 22cc069160
commit 040b69af72

View File

@ -141,6 +141,8 @@ int uclass_get_device_by_of_offset(enum uclass_id id, int node,
/** /**
* uclass_first_device() - Get the first device in a uclass * uclass_first_device() - Get the first device in a uclass
* *
* The device returned is probed if necessary, and ready for use
*
* @id: Uclass ID to look up * @id: Uclass ID to look up
* @devp: Returns pointer to the first device in that uclass, or NULL if none * @devp: Returns pointer to the first device in that uclass, or NULL if none
* @return 0 if OK (found or not found), -1 on error * @return 0 if OK (found or not found), -1 on error
@ -150,6 +152,8 @@ int uclass_first_device(enum uclass_id id, struct udevice **devp);
/** /**
* uclass_next_device() - Get the next device in a uclass * uclass_next_device() - Get the next device in a uclass
* *
* The device returned is probed if necessary, and ready for use
*
* @devp: On entry, pointer to device to lookup. On exit, returns pointer * @devp: On entry, pointer to device to lookup. On exit, returns pointer
* to the next device in the same uclass, or NULL if none * to the next device in the same uclass, or NULL if none
* @return 0 if OK (found or not found), -1 on error * @return 0 if OK (found or not found), -1 on error