diff options
| author | Russell King <rmk@dyn-67.arm.linux.org.uk> | 2005-04-27 19:19:55 +0200 |
|---|---|---|
| committer | Russell King <rmk@dyn-67.arm.linux.org.uk> | 2005-04-27 19:19:55 +0200 |
| commit | ea3f4eaca09de1bcc80e922e56a6dabba5882f56 (patch) | |
| tree | 7b798a53b5306ddf45e969eb03badd6aa10d8064 /include/asm-arm | |
| parent | [PATCH] PC300 pci_enable_device fix (diff) | |
| download | linux-ea3f4eaca09de1bcc80e922e56a6dabba5882f56.tar.xz linux-ea3f4eaca09de1bcc80e922e56a6dabba5882f56.zip | |
[PATCH] ARM: Add further explaination for clk_get()
clk_get() comments can be confusing. Add extra explaination of
the dev and id parameters to ensure correct usage.
Signed-off-by: Russell King <rmk@arm.linux.org.uk>
Diffstat (limited to 'include/asm-arm')
| -rw-r--r-- | include/asm-arm/hardware/clock.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/include/asm-arm/hardware/clock.h b/include/asm-arm/hardware/clock.h index 4983449ff2c7..19da861e523d 100644 --- a/include/asm-arm/hardware/clock.h +++ b/include/asm-arm/hardware/clock.h @@ -26,10 +26,13 @@ struct clk; /** * clk_get - lookup and obtain a reference to a clock producer. * @dev: device for clock "consumer" - * @id: device ID + * @id: clock comsumer ID * * Returns a struct clk corresponding to the clock producer, or - * valid IS_ERR() condition containing errno. + * valid IS_ERR() condition containing errno. The implementation + * uses @dev and @id to determine the clock consumer, and thereby + * the clock producer. (IOW, @id may be identical strings, but + * clk_get may return different clock producers depending on @dev.) */ struct clk *clk_get(struct device *dev, const char *id); |