clock.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:3k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  *  linux/include/asm-arm/hardware/clock.h
  3.  *
  4.  *  Copyright (C) 2004 ARM Limited.
  5.  *  Written by Deep Blue Solutions Limited.
  6.  *
  7.  * This program is free software; you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License version 2 as
  9.  * published by the Free Software Foundation.
  10.  */
  11. #ifndef ASMARM_CLOCK_H
  12. #define ASMARM_CLOCK_H
  13. struct device;
  14. /*
  15.  * The base API.
  16.  */
  17. /*
  18.  * struct clk - an machine class defined object / cookie.
  19.  */
  20. struct clk;
  21. /**
  22.  * clk_get - lookup and obtain a reference to a clock producer.
  23.  * @dev: device for clock "consumer"
  24.  * @id: clock comsumer ID
  25.  *
  26.  * Returns a struct clk corresponding to the clock producer, or
  27.  * valid IS_ERR() condition containing errno.  The implementation
  28.  * uses @dev and @id to determine the clock consumer, and thereby
  29.  * the clock producer.  (IOW, @id may be identical strings, but
  30.  * clk_get may return different clock producers depending on @dev.)
  31.  */
  32. struct clk *clk_get(struct device *dev, const char *id);
  33. /**
  34.  * clk_enable - inform the system when the clock source should be running.
  35.  * @clk: clock source
  36.  *
  37.  * If the clock can not be enabled/disabled, this should return success.
  38.  *
  39.  * Returns success (0) or negative errno.
  40.  */
  41. int clk_enable(struct clk *clk);
  42. /**
  43.  * clk_disable - inform the system when the clock source is no longer required.
  44.  * @clk: clock source
  45.  */
  46. void clk_disable(struct clk *clk);
  47. /**
  48.  * clk_use - increment the use count
  49.  * @clk: clock source
  50.  *
  51.  * Returns success (0) or negative errno.
  52.  */
  53. int clk_use(struct clk *clk);
  54. /**
  55.  * clk_unuse - decrement the use count
  56.  * @clk: clock source
  57.  */
  58. void clk_unuse(struct clk *clk);
  59. /**
  60.  * clk_get_rate - obtain the current clock rate (in Hz) for a clock source.
  61.  *   This is only valid once the clock source has been enabled.
  62.  * @clk: clock source
  63.  */
  64. unsigned long clk_get_rate(struct clk *clk);
  65. /**
  66.  * clk_put - "free" the clock source
  67.  * @clk: clock source
  68.  */
  69. void clk_put(struct clk *clk);
  70. /*
  71.  * The remaining APIs are optional for machine class support.
  72.  */
  73. /**
  74.  * clk_round_rate - adjust a rate to the exact rate a clock can provide
  75.  * @clk: clock source
  76.  * @rate: desired clock rate in Hz
  77.  *
  78.  * Returns rounded clock rate in Hz, or negative errno.
  79.  */
  80. long clk_round_rate(struct clk *clk, unsigned long rate);
  81.  
  82. /**
  83.  * clk_set_rate - set the clock rate for a clock source
  84.  * @clk: clock source
  85.  * @rate: desired clock rate in Hz
  86.  *
  87.  * Returns success (0) or negative errno.
  88.  */
  89. int clk_set_rate(struct clk *clk, unsigned long rate);
  90.  
  91. /**
  92.  * clk_set_parent - set the parent clock source for this clock
  93.  * @clk: clock source
  94.  * @parent: parent clock source
  95.  *
  96.  * Returns success (0) or negative errno.
  97.  */
  98. int clk_set_parent(struct clk *clk, struct clk *parent);
  99. /**
  100.  * clk_get_parent - get the parent clock source for this clock
  101.  * @clk: clock source
  102.  *
  103.  * Returns struct clk corresponding to parent clock source, or
  104.  * valid IS_ERR() condition containing errno.
  105.  */
  106. struct clk *clk_get_parent(struct clk *clk);
  107. #endif