3 * Ben Gray <ben.r.gray@gmail.com>.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by Ben Gray.
17 * 4. The name of the company nor the name of the author may be used to
18 * endorse or promote products derived from this software without specific
19 * prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY BEN GRAY ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL BEN GRAY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
30 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 * Power, Reset and Clock Management Module
36 * This is a very simple driver wrapper around the PRCM set of registers in
37 * the OMAP3 chip. It allows you to turn on and off things like the functional
38 * and interface clocks to the various on-chip modules.
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/module.h>
49 #include <sys/resource.h>
52 #include <sys/mutex.h>
54 #include <machine/bus.h>
55 #include <machine/resource.h>
56 #include <machine/intr.h>
58 #include <arm/ti/ti_cpuid.h>
59 #include <arm/ti/ti_prcm.h>
62 * ti_*_clk_devmap - Array of clock devices, should be defined one per SoC
64 * This array is typically defined in one of the targeted *_prcm_clk.c
65 * files and is specific to the given SoC platform. Each entry in the array
66 * corresponds to an individual clock device.
68 extern struct ti_clock_dev ti_omap4_clk_devmap[];
69 extern struct ti_clock_dev ti_am335x_clk_devmap[];
72 * ti_prcm_clk_dev - returns a pointer to the clock device with given id
73 * @clk: the ID of the clock device to get
75 * Simply iterates through the clk_devmap global array and returns a pointer
76 * to the clock device if found.
82 * The pointer to the clock device on success, on failure NULL is returned.
84 static struct ti_clock_dev *
85 ti_prcm_clk_dev(clk_ident_t clk)
87 struct ti_clock_dev *clk_dev;
89 /* Find the clock within the devmap - it's a bit inefficent having a for
90 * loop for this, but this function should only called when a driver is
91 * being activated so IMHO not a big issue.
97 clk_dev = &(ti_omap4_clk_devmap[0]);
102 clk_dev = &(ti_am335x_clk_devmap[0]);
107 panic("No clock devmap found");
108 while (clk_dev->id != INVALID_CLK_IDENT) {
109 if (clk_dev->id == clk) {
115 /* Sanity check we managed to find the clock */
116 printf("ti_prcm: Failed to find clock device (%d)\n", clk);
121 * ti_prcm_clk_valid - enables a clock for a particular module
122 * @clk: identifier for the module to enable, see ti_prcm.h for a list
123 * of possible modules.
124 * Example: OMAP3_MODULE_MMC1_ICLK or OMAP3_MODULE_GPTIMER10_FCLK.
126 * This function can enable either a functional or interface clock.
128 * The real work done to enable the clock is really done in the callback
129 * function associated with the clock, this function is simply a wrapper
133 * Internally locks the driver context.
136 * Returns 0 on success or positive error code on failure.
139 ti_prcm_clk_valid(clk_ident_t clk)
143 if (ti_prcm_clk_dev(clk) == NULL)
151 * ti_prcm_clk_enable - enables a clock for a particular module
152 * @clk: identifier for the module to enable, see ti_prcm.h for a list
153 * of possible modules.
154 * Example: OMAP3_MODULE_MMC1_ICLK or OMAP3_MODULE_GPTIMER10_FCLK.
156 * This function can enable either a functional or interface clock.
158 * The real work done to enable the clock is really done in the callback
159 * function associated with the clock, this function is simply a wrapper
163 * Internally locks the driver context.
166 * Returns 0 on success or positive error code on failure.
169 ti_prcm_clk_enable(clk_ident_t clk)
171 struct ti_clock_dev *clk_dev;
174 /* Find the clock within the devmap - it's a bit inefficent having a for
175 * loop for this, but this function should only called when a driver is
176 * being activated so IMHO not a big issue.
178 clk_dev = ti_prcm_clk_dev(clk);
180 /* Sanity check we managed to find the clock */
184 /* Activate the clock */
185 if (clk_dev->clk_activate)
186 ret = clk_dev->clk_activate(clk_dev);
195 * ti_prcm_clk_disable - disables a clock for a particular module
196 * @clk: identifier for the module to enable, see ti_prcm.h for a list
197 * of possible modules.
198 * Example: OMAP3_MODULE_MMC1_ICLK or OMAP3_MODULE_GPTIMER10_FCLK.
200 * This function can enable either a functional or interface clock.
202 * The real work done to enable the clock is really done in the callback
203 * function associated with the clock, this function is simply a wrapper
207 * Internally locks the driver context.
210 * Returns 0 on success or positive error code on failure.
213 ti_prcm_clk_disable(clk_ident_t clk)
215 struct ti_clock_dev *clk_dev;
218 /* Find the clock within the devmap - it's a bit inefficent having a for
219 * loop for this, but this function should only called when a driver is
220 * being activated so IMHO not a big issue.
222 clk_dev = ti_prcm_clk_dev(clk);
224 /* Sanity check we managed to find the clock */
228 /* Activate the clock */
229 if (clk_dev->clk_deactivate)
230 ret = clk_dev->clk_deactivate(clk_dev);
238 * ti_prcm_clk_set_source - sets the source
239 * @clk: identifier for the module to enable, see ti_prcm.h for a list
240 * of possible modules.
241 * Example: OMAP3_MODULE_MMC1_ICLK or OMAP3_MODULE_GPTIMER10_FCLK.
243 * This function can enable either a functional or interface clock.
245 * The real work done to enable the clock is really done in the callback
246 * function associated with the clock, this function is simply a wrapper
250 * Internally locks the driver context.
253 * Returns 0 on success or positive error code on failure.
256 ti_prcm_clk_set_source(clk_ident_t clk, clk_src_t clksrc)
258 struct ti_clock_dev *clk_dev;
261 /* Find the clock within the devmap - it's a bit inefficent having a for
262 * loop for this, but this function should only called when a driver is
263 * being activated so IMHO not a big issue.
265 clk_dev = ti_prcm_clk_dev(clk);
267 /* Sanity check we managed to find the clock */
271 /* Activate the clock */
272 if (clk_dev->clk_set_source)
273 ret = clk_dev->clk_set_source(clk_dev, clksrc);
282 * ti_prcm_clk_get_source_freq - gets the source clock frequency
283 * @clk: identifier for the module to enable, see ti_prcm.h for a list
284 * of possible modules.
285 * @freq: pointer to an integer that upon return will contain the src freq
287 * This function returns the frequency of the source clock.
289 * The real work done to enable the clock is really done in the callback
290 * function associated with the clock, this function is simply a wrapper
294 * Internally locks the driver context.
297 * Returns 0 on success or positive error code on failure.
300 ti_prcm_clk_get_source_freq(clk_ident_t clk, unsigned int *freq)
302 struct ti_clock_dev *clk_dev;
305 /* Find the clock within the devmap - it's a bit inefficent having a for
306 * loop for this, but this function should only called when a driver is
307 * being activated so IMHO not a big issue.
309 clk_dev = ti_prcm_clk_dev(clk);
311 /* Sanity check we managed to find the clock */
315 /* Get the source frequency of the clock */
316 if (clk_dev->clk_get_source_freq)
317 ret = clk_dev->clk_get_source_freq(clk_dev, freq);
325 * ti_prcm_clk_set_source_freq - sets the source clock frequency as close to freq as possible
326 * @clk: identifier for the module to enable, see ti_prcm.h for a list
327 * of possible modules.
328 * @freq: requested freq
331 * Internally locks the driver context.
334 * Returns 0 on success or positive error code on failure.
337 ti_prcm_clk_set_source_freq(clk_ident_t clk, unsigned int freq)
339 struct ti_clock_dev *clk_dev;
342 clk_dev = ti_prcm_clk_dev(clk);
344 /* Sanity check we managed to find the clock */
348 /* Get the source frequency of the clock */
349 if (clk_dev->clk_set_source_freq)
350 ret = clk_dev->clk_set_source_freq(clk_dev, freq);