ti_prcm.h revision 1.1.2.2 1 1.1.2.2 jdolecek /* $NetBSD: ti_prcm.h,v 1.1.2.2 2017/12/03 11:35:56 jdolecek Exp $ */
2 1.1.2.2 jdolecek
3 1.1.2.2 jdolecek /*-
4 1.1.2.2 jdolecek * Copyright (c) 2017 Jared McNeill <jmcneill (at) invisible.ca>
5 1.1.2.2 jdolecek * All rights reserved.
6 1.1.2.2 jdolecek *
7 1.1.2.2 jdolecek * Redistribution and use in source and binary forms, with or without
8 1.1.2.2 jdolecek * modification, are permitted provided that the following conditions
9 1.1.2.2 jdolecek * are met:
10 1.1.2.2 jdolecek * 1. Redistributions of source code must retain the above copyright
11 1.1.2.2 jdolecek * notice, this list of conditions and the following disclaimer.
12 1.1.2.2 jdolecek * 2. Redistributions in binary form must reproduce the above copyright
13 1.1.2.2 jdolecek * notice, this list of conditions and the following disclaimer in the
14 1.1.2.2 jdolecek * documentation and/or other materials provided with the distribution.
15 1.1.2.2 jdolecek *
16 1.1.2.2 jdolecek * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 1.1.2.2 jdolecek * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 1.1.2.2 jdolecek * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 1.1.2.2 jdolecek * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 1.1.2.2 jdolecek * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 1.1.2.2 jdolecek * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 1.1.2.2 jdolecek * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 1.1.2.2 jdolecek * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 1.1.2.2 jdolecek * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 1.1.2.2 jdolecek * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 1.1.2.2 jdolecek * SUCH DAMAGE.
27 1.1.2.2 jdolecek */
28 1.1.2.2 jdolecek
29 1.1.2.2 jdolecek #ifndef _ARM_TI_PRCM_H
30 1.1.2.2 jdolecek #define _ARM_TI_PRCM_H
31 1.1.2.2 jdolecek
32 1.1.2.2 jdolecek #ifdef TI_PRCM_PRIVATE
33 1.1.2.2 jdolecek
34 1.1.2.2 jdolecek #include <dev/clk/clk_backend.h>
35 1.1.2.2 jdolecek
36 1.1.2.2 jdolecek struct ti_prcm_clk;
37 1.1.2.2 jdolecek struct ti_prcm_softc;
38 1.1.2.2 jdolecek
39 1.1.2.2 jdolecek enum ti_prcm_clktype {
40 1.1.2.2 jdolecek TI_PRCM_UNKNOWN,
41 1.1.2.2 jdolecek TI_PRCM_FIXED,
42 1.1.2.2 jdolecek TI_PRCM_FIXED_FACTOR,
43 1.1.2.2 jdolecek TI_PRCM_HWMOD,
44 1.1.2.2 jdolecek };
45 1.1.2.2 jdolecek
46 1.1.2.2 jdolecek struct ti_prcm_fixed {
47 1.1.2.2 jdolecek u_int rate;
48 1.1.2.2 jdolecek };
49 1.1.2.2 jdolecek
50 1.1.2.2 jdolecek struct ti_prcm_fixed_factor {
51 1.1.2.2 jdolecek u_int mult;
52 1.1.2.2 jdolecek u_int div;
53 1.1.2.2 jdolecek const char *parent;
54 1.1.2.2 jdolecek };
55 1.1.2.2 jdolecek
56 1.1.2.2 jdolecek struct ti_prcm_hwmod {
57 1.1.2.2 jdolecek bus_size_t reg;
58 1.1.2.2 jdolecek const char *parent;
59 1.1.2.2 jdolecek };
60 1.1.2.2 jdolecek
61 1.1.2.2 jdolecek struct ti_prcm_clk {
62 1.1.2.2 jdolecek struct clk base;
63 1.1.2.2 jdolecek enum ti_prcm_clktype type;
64 1.1.2.2 jdolecek union {
65 1.1.2.2 jdolecek struct ti_prcm_fixed fixed;
66 1.1.2.2 jdolecek struct ti_prcm_fixed_factor fixed_factor;
67 1.1.2.2 jdolecek struct ti_prcm_hwmod hwmod;
68 1.1.2.2 jdolecek } u;
69 1.1.2.2 jdolecek
70 1.1.2.2 jdolecek int (*enable)(struct ti_prcm_softc *,
71 1.1.2.2 jdolecek struct ti_prcm_clk *, int);
72 1.1.2.2 jdolecek u_int (*get_rate)(struct ti_prcm_softc *,
73 1.1.2.2 jdolecek struct ti_prcm_clk *);
74 1.1.2.2 jdolecek int (*set_rate)(struct ti_prcm_softc *,
75 1.1.2.2 jdolecek struct ti_prcm_clk *, u_int);
76 1.1.2.2 jdolecek const char * (*get_parent)(struct ti_prcm_softc *,
77 1.1.2.2 jdolecek struct ti_prcm_clk *);
78 1.1.2.2 jdolecek int (*set_parent)(struct ti_prcm_softc *,
79 1.1.2.2 jdolecek struct ti_prcm_clk *,
80 1.1.2.2 jdolecek const char *);
81 1.1.2.2 jdolecek };
82 1.1.2.2 jdolecek
83 1.1.2.2 jdolecek int ti_prcm_attach(struct ti_prcm_softc *);
84 1.1.2.2 jdolecek struct ti_prcm_clk *ti_prcm_clock_find(struct ti_prcm_softc *, const char *);
85 1.1.2.2 jdolecek
86 1.1.2.2 jdolecek static inline u_int
87 1.1.2.2 jdolecek ti_prcm_fixed_get_rate(struct ti_prcm_softc *sc, struct ti_prcm_clk *tc)
88 1.1.2.2 jdolecek {
89 1.1.2.2 jdolecek KASSERT(tc->type == TI_PRCM_FIXED);
90 1.1.2.2 jdolecek return tc->u.fixed.rate;
91 1.1.2.2 jdolecek }
92 1.1.2.2 jdolecek
93 1.1.2.2 jdolecek #define TI_PRCM_FIXED(_name, _rate) \
94 1.1.2.2 jdolecek { \
95 1.1.2.2 jdolecek .type = TI_PRCM_FIXED, .base.name = (_name), \
96 1.1.2.2 jdolecek .u.fixed.rate = (_rate), \
97 1.1.2.2 jdolecek .get_rate = ti_prcm_fixed_get_rate, \
98 1.1.2.2 jdolecek }
99 1.1.2.2 jdolecek
100 1.1.2.2 jdolecek static inline u_int
101 1.1.2.2 jdolecek ti_prcm_fixed_factor_get_rate(struct ti_prcm_softc *sc, struct ti_prcm_clk *tc)
102 1.1.2.2 jdolecek {
103 1.1.2.2 jdolecek KASSERT(tc->type == TI_PRCM_FIXED_FACTOR);
104 1.1.2.2 jdolecek struct ti_prcm_clk *tc_parent;
105 1.1.2.2 jdolecek
106 1.1.2.2 jdolecek tc_parent = ti_prcm_clock_find(sc, tc->u.fixed_factor.parent);
107 1.1.2.2 jdolecek KASSERT(tc_parent != NULL);
108 1.1.2.2 jdolecek
109 1.1.2.2 jdolecek const u_int mult = tc->u.fixed_factor.mult;
110 1.1.2.2 jdolecek const u_int div = tc->u.fixed_factor.div;
111 1.1.2.2 jdolecek
112 1.1.2.2 jdolecek return (clk_get_rate(&tc_parent->base) * mult) / div;
113 1.1.2.2 jdolecek }
114 1.1.2.2 jdolecek
115 1.1.2.2 jdolecek static inline const char *
116 1.1.2.2 jdolecek ti_prcm_fixed_factor_get_parent(struct ti_prcm_softc *sc, struct ti_prcm_clk *tc)
117 1.1.2.2 jdolecek {
118 1.1.2.2 jdolecek KASSERT(tc->type == TI_PRCM_FIXED_FACTOR);
119 1.1.2.2 jdolecek return tc->u.fixed_factor.parent;
120 1.1.2.2 jdolecek }
121 1.1.2.2 jdolecek
122 1.1.2.2 jdolecek #define TI_PRCM_FIXED_FACTOR(_name, _mult, _div, _parent) \
123 1.1.2.2 jdolecek { \
124 1.1.2.2 jdolecek .type = TI_PRCM_FIXED_FACTOR, .base.name = (_name), \
125 1.1.2.2 jdolecek .u.fixed_factor.mult = (_mult), \
126 1.1.2.2 jdolecek .u.fixed_factor.div = (_div), \
127 1.1.2.2 jdolecek .u.fixed_factor.parent = (_parent), \
128 1.1.2.2 jdolecek .get_rate = ti_prcm_fixed_factor_get_rate, \
129 1.1.2.2 jdolecek .get_parent = ti_prcm_fixed_factor_get_parent, \
130 1.1.2.2 jdolecek }
131 1.1.2.2 jdolecek
132 1.1.2.2 jdolecek static inline const char *
133 1.1.2.2 jdolecek ti_prcm_hwmod_get_parent(struct ti_prcm_softc *sc, struct ti_prcm_clk *tc)
134 1.1.2.2 jdolecek {
135 1.1.2.2 jdolecek KASSERT(tc->type == TI_PRCM_HWMOD);
136 1.1.2.2 jdolecek return tc->u.hwmod.parent;
137 1.1.2.2 jdolecek }
138 1.1.2.2 jdolecek
139 1.1.2.2 jdolecek #define TI_PRCM_HWMOD(_name, _reg, _parent, _enable) \
140 1.1.2.2 jdolecek { \
141 1.1.2.2 jdolecek .type = TI_PRCM_HWMOD, .base.name = (_name), \
142 1.1.2.2 jdolecek .u.hwmod.reg = (_reg), \
143 1.1.2.2 jdolecek .u.hwmod.parent = (_parent), \
144 1.1.2.2 jdolecek .enable = (_enable), \
145 1.1.2.2 jdolecek .get_parent = ti_prcm_hwmod_get_parent, \
146 1.1.2.2 jdolecek }
147 1.1.2.2 jdolecek
148 1.1.2.2 jdolecek struct ti_prcm_softc {
149 1.1.2.2 jdolecek device_t sc_dev;
150 1.1.2.2 jdolecek int sc_phandle;
151 1.1.2.2 jdolecek bus_space_tag_t sc_bst;
152 1.1.2.2 jdolecek bus_space_handle_t sc_bsh;
153 1.1.2.2 jdolecek
154 1.1.2.2 jdolecek struct clk_domain sc_clkdom;
155 1.1.2.2 jdolecek
156 1.1.2.2 jdolecek struct ti_prcm_clk *sc_clks;
157 1.1.2.2 jdolecek u_int sc_nclks;
158 1.1.2.2 jdolecek };
159 1.1.2.2 jdolecek
160 1.1.2.2 jdolecek #define PRCM_READ(sc, reg) \
161 1.1.2.2 jdolecek bus_space_read_4((sc)->sc_bst, (sc)->sc_bsh, (reg))
162 1.1.2.2 jdolecek #define PRCM_WRITE(sc, reg, val) \
163 1.1.2.2 jdolecek bus_space_write_4((sc)->sc_bst, (sc)->sc_bsh, (reg), (val))
164 1.1.2.2 jdolecek
165 1.1.2.2 jdolecek #endif /* !TI_PRCM_PRIVATE */
166 1.1.2.2 jdolecek
167 1.1.2.2 jdolecek struct clk * ti_prcm_get_hwmod(const int, u_int);
168 1.1.2.2 jdolecek
169 1.1.2.2 jdolecek #endif /* !_ARM_TI_PRCM_H */
170