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>

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>
Simon Glass
1 parent 22cc069160
Showing 1 changed file with 4 additions and 0 deletions Side-by-side Diff
include/dm/uclass.h
@@ -141,6 +141,8 @@
 /**
  * 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
  * @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
@@ -149,6 +151,8 @@
  
 /**
  * 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
  * to the next device in the same uclass, or NULL if none
...	...	@@ -141,6 +141,8 @@
141	141	/**
142	142	* uclass_first_device() - Get the first device in a uclass
143	143	*
	144	+ * The device returned is probed if necessary, and ready for use
	145	+ *
144	146	* @id: Uclass ID to look up
145	147	* @devp: Returns pointer to the first device in that uclass, or NULL if none
146	148	* @return 0 if OK (found or not found), -1 on error
...	...	@@ -149,6 +151,8 @@
149	151
150	152	/**
151	153	* uclass_next_device() - Get the next device in a uclass
	154	+ *
	155	+ * The device returned is probed if necessary, and ready for use
152	156	*
153	157	* @devp: On entry, pointer to device to lookup. On exit, returns pointer
154	158	* to the next device in the same uclass, or NULL if none