dm: Correct pre_reloc_only parameter description in several APIs' comments

The pre_reloc_only parameter description currently only mentions
drivers with the DM_FLAG_PRE_RELOC flag, but does not mention the
special device tree properties. Correct them.

Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Bin Meng 2018-10-10 22:06:59 -07:00 committed by Simon Glass
parent 8d773c4ab3
commit 6244fc64ce
3 changed files with 13 additions and 12 deletions

View File

@ -74,8 +74,8 @@ int device_bind_with_driver_data(struct udevice *parent,
* tree. * tree.
* *
* @parent: Pointer to device's parent * @parent: Pointer to device's parent
* @pre_reloc_only: If true, bind the driver only if its DM_INIT_F flag is set. * @pre_reloc_only: If true, bind the driver only if its DM_FLAG_PRE_RELOC flag
* If false bind the driver always. * is set. If false bind the driver always.
* @info: Name and platdata for this device * @info: Name and platdata for this device
* @devp: if non-NULL, returns a pointer to the bound device * @devp: if non-NULL, returns a pointer to the bound device
* @return 0 if OK, -ve on error * @return 0 if OK, -ve on error

View File

@ -39,8 +39,8 @@ struct uclass_driver *lists_uclass_lookup(enum uclass_id id);
* each one. The devices will have @parent as their parent. * each one. The devices will have @parent as their parent.
* *
* @parent: parent device (root) * @parent: parent device (root)
* @early_only: If true, bind only drivers with the DM_INIT_F flag. If false * @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC flag.
* bind all drivers. * If false bind all drivers.
*/ */
int lists_bind_drivers(struct udevice *parent, bool pre_reloc_only); int lists_bind_drivers(struct udevice *parent, bool pre_reloc_only);

View File

@ -48,8 +48,8 @@ int dm_scan_platdata(bool pre_reloc_only);
* the top-level subnodes are examined. * 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 nodes with special devicetree properties,
* flag. If false bind all drivers. * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
* @return 0 if OK, -ve on error * @return 0 if OK, -ve on error
*/ */
int dm_scan_fdt(const void *blob, bool pre_reloc_only); int dm_scan_fdt(const void *blob, bool pre_reloc_only);
@ -62,8 +62,8 @@ int dm_scan_fdt(const void *blob, bool pre_reloc_only);
* of "clocks" node. * of "clocks" node.
* *
* @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 nodes with special devicetree properties,
* flag. If false bind all drivers. * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
* @return 0 if OK, -ve on error * @return 0 if OK, -ve on error
*/ */
int dm_extended_scan_fdt(const void *blob, bool pre_reloc_only); int dm_extended_scan_fdt(const void *blob, bool pre_reloc_only);
@ -76,8 +76,9 @@ int dm_extended_scan_fdt(const void *blob, bool pre_reloc_only);
* programmaticaly. They should do this by calling device_bind() on each * programmaticaly. They should do this by calling device_bind() on each
* device. * device.
* *
* @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
* flag. If false bind all drivers. * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
* @return 0 if OK, -ve on error
*/ */
int dm_scan_other(bool pre_reloc_only); int dm_scan_other(bool pre_reloc_only);
@ -88,8 +89,8 @@ int dm_scan_other(bool pre_reloc_only);
* then scans and binds available devices from platform data and the FDT. * then scans and binds available devices from platform data and the FDT.
* This calls dm_init() to set up Driver Model structures. * This calls dm_init() to set up Driver Model structures.
* *
* @pre_reloc_only: If true, bind only drivers with the DM_FLAG_PRE_RELOC * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
* flag. If false bind all drivers. * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
* @return 0 if OK, -ve on error * @return 0 if OK, -ve on error
*/ */
int dm_init_and_scan(bool pre_reloc_only); int dm_init_and_scan(bool pre_reloc_only);