Skip to content

Commit

Permalink
[PATCH] ARM: Add further explaination for clk_get()
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Russell King committed Apr 27, 2005
1 parent e8108c9 commit ea3f4ea
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions include/asm-arm/hardware/clock.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down

0 comments on commit ea3f4ea

Please sign in to comment.