2 * Copyright 2016 Michal Meloun <mmel@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
33 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36 #include <sys/mutex.h>
37 #include <sys/module.h>
39 #include <sys/systm.h>
41 #include <machine/bus.h>
43 #include <dev/ofw/ofw_bus.h>
44 #include <dev/ofw/ofw_bus_subr.h>
45 #include <dev/extres/clk/clk_fixed.h>
47 #define CLK_TYPE_FIXED 1
48 #define CLK_TYPE_FIXED_FACTOR 2
50 static int clknode_fixed_init(struct clknode *clk, device_t dev);
51 static int clknode_fixed_recalc(struct clknode *clk, uint64_t *freq);
52 static int clknode_fixed_set_freq(struct clknode *clk, uint64_t fin,
53 uint64_t *fout, int flags, int *stop);
55 struct clknode_fixed_sc {
62 static clknode_method_t clknode_fixed_methods[] = {
63 /* Device interface */
64 CLKNODEMETHOD(clknode_init, clknode_fixed_init),
65 CLKNODEMETHOD(clknode_recalc_freq, clknode_fixed_recalc),
66 CLKNODEMETHOD(clknode_set_freq, clknode_fixed_set_freq),
69 DEFINE_CLASS_1(clknode_fixed, clknode_fixed_class, clknode_fixed_methods,
70 sizeof(struct clknode_fixed_sc), clknode_class);
73 clknode_fixed_init(struct clknode *clk, device_t dev)
75 struct clknode_fixed_sc *sc;
77 sc = clknode_get_softc(clk);
79 clknode_init_parent_idx(clk, 0);
84 clknode_fixed_recalc(struct clknode *clk, uint64_t *freq)
86 struct clknode_fixed_sc *sc;
88 sc = clknode_get_softc(clk);
90 if ((sc->mult != 0) && (sc->div != 0))
91 *freq = (*freq / sc->div) * sc->mult;
98 clknode_fixed_set_freq(struct clknode *clk, uint64_t fin, uint64_t *fout,
101 struct clknode_fixed_sc *sc;
103 sc = clknode_get_softc(clk);
104 if (sc->mult == 0 || sc->div == 0) {
105 /* Fixed frequency clock. */
107 if (*fout != sc->freq)
111 /* Fixed factor clock. */
113 *fout = (*fout / sc->mult) * sc->div;
118 clknode_fixed_register(struct clkdom *clkdom, struct clk_fixed_def *clkdef)
121 struct clknode_fixed_sc *sc;
123 clk = clknode_create(clkdom, &clknode_fixed_class, &clkdef->clkdef);
127 sc = clknode_get_softc(clk);
128 sc->fixed_flags = clkdef->fixed_flags;
129 sc->freq = clkdef->freq;
130 sc->mult = clkdef->mult;
131 sc->div = clkdef->div;
133 clknode_register(clkdom, clk);
139 static struct ofw_compat_data compat_data[] = {
140 {"fixed-clock", CLK_TYPE_FIXED},
141 {"fixed-factor-clock", CLK_TYPE_FIXED_FACTOR},
145 struct clk_fixed_softc {
147 struct clkdom *clkdom;
151 clk_fixed_probe(device_t dev)
155 clk_type = ofw_bus_search_compatible(dev, compat_data)->ocd_data;
158 device_set_desc(dev, "Fixed clock");
159 return (BUS_PROBE_DEFAULT);
160 case CLK_TYPE_FIXED_FACTOR:
161 device_set_desc(dev, "Fixed factor clock");
162 return (BUS_PROBE_DEFAULT);
169 clk_fixed_init_fixed(struct clk_fixed_softc *sc, phandle_t node,
170 struct clk_fixed_def *def)
176 rv = OF_getencprop(node, "clock-frequency", &freq, sizeof(freq));
184 clk_fixed_init_fixed_factor(struct clk_fixed_softc *sc, phandle_t node,
185 struct clk_fixed_def *def)
191 rv = OF_getencprop(node, "clock-mult", &def->mult, sizeof(def->mult));
194 rv = OF_getencprop(node, "clock-div", &def->div, sizeof(def->div));
197 /* Get name of parent clock */
198 rv = clk_get_by_ofw_index(sc->dev, 0, 0, &parent);
201 def->clkdef.parent_names = malloc(sizeof(char *), M_OFWPROP, M_WAITOK);
202 def->clkdef.parent_names[0] = clk_get_name(parent);
203 def->clkdef.parent_cnt = 1;
209 clk_fixed_attach(device_t dev)
211 struct clk_fixed_softc *sc;
214 struct clk_fixed_def def;
217 sc = device_get_softc(dev);
219 node = ofw_bus_get_node(dev);
220 clk_type = ofw_bus_search_compatible(dev, compat_data)->ocd_data;
222 bzero(&def, sizeof(def));
223 if (clk_type == CLK_TYPE_FIXED)
224 rv = clk_fixed_init_fixed(sc, node, &def);
225 else if (clk_type == CLK_TYPE_FIXED_FACTOR)
226 rv = clk_fixed_init_fixed_factor(sc, node, &def);
230 device_printf(sc->dev, "Cannot FDT parameters.\n");
233 rv = clk_parse_ofw_clk_name(dev, node, &def.clkdef.name);
235 device_printf(sc->dev, "Cannot parse clock name.\n");
238 sc->clkdom = clkdom_create(dev);
239 KASSERT(sc->clkdom != NULL, ("Clock domain is NULL"));
241 rv = clknode_fixed_register(sc->clkdom, &def);
243 device_printf(sc->dev, "Cannot register fixed clock.\n");
248 rv = clkdom_finit(sc->clkdom);
250 device_printf(sc->dev, "Clk domain finit fails.\n");
255 clkdom_dump(sc->clkdom);
257 OF_prop_free(__DECONST(char *, def.clkdef.name));
258 OF_prop_free(def.clkdef.parent_names);
259 return (bus_generic_attach(dev));
262 OF_prop_free(__DECONST(char *, def.clkdef.name));
263 OF_prop_free(def.clkdef.parent_names);
267 static device_method_t clk_fixed_methods[] = {
268 /* Device interface */
269 DEVMETHOD(device_probe, clk_fixed_probe),
270 DEVMETHOD(device_attach, clk_fixed_attach),
275 DEFINE_CLASS_0(clk_fixed, clk_fixed_driver, clk_fixed_methods,
276 sizeof(struct clk_fixed_softc));
277 static devclass_t clk_fixed_devclass;
278 EARLY_DRIVER_MODULE(clk_fixed, simplebus, clk_fixed_driver,
279 clk_fixed_devclass, 0, 0, BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
280 MODULE_VERSION(clk_fixed, 1);