Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ea3f4eac authored by Russell King's avatar Russell King
Browse files

[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: default avatarRussell King <rmk@arm.linux.org.uk>
parent e8108c98
Loading
Loading
Loading
Loading
+5 −2
Original line number Diff line number Diff line
@@ -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);