Skip to content

Commit

Permalink
[ARM] Add additional documentation to the clock source framework
Browse files Browse the repository at this point in the history
It seems that there's some confusion over how the clock source
framework should be used.  Add some additional comments to explain
the ambiguous areas.

Signed-off-by: Russell King <rmk+kernel@arm.linux.org.uk>
  • Loading branch information
Russell King authored and Russell King committed Jan 3, 2006
1 parent 78ff18a commit f47fc0a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions include/asm-arm/hardware/clock.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ struct clk;
* 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.)
*
* Drivers must assume that the clock source is not enabled.
*/
struct clk *clk_get(struct device *dev, const char *id);

Expand All @@ -49,6 +51,14 @@ int clk_enable(struct clk *clk);
/**
* clk_disable - inform the system when the clock source is no longer required.
* @clk: clock source
*
* Inform the system that a clock source is no longer required by
* a driver and may be shut down.
*
* Implementation detail: if the clock source is shared between
* multiple drivers, clk_enable() calls must be balanced by the
* same number of clk_disable() calls for the clock source to be
* disabled.
*/
void clk_disable(struct clk *clk);

Expand Down Expand Up @@ -76,6 +86,10 @@ unsigned long clk_get_rate(struct clk *clk);
/**
* clk_put - "free" the clock source
* @clk: clock source
*
* Note: drivers must ensure that all clk_enable calls made on this
* clock source are balanced by clk_disable calls prior to calling
* this function.
*/
void clk_put(struct clk *clk);

Expand Down

0 comments on commit f47fc0a

Please sign in to comment.