xref: /netbsd-src/sys/arch/arm/sunxi/sunxi_gmacclk.c (revision cef8759bd76c1b621f8eab8faa6f208faabc2e15)
1 /* $NetBSD: sunxi_gmacclk.c,v 1.2 2018/09/09 07:21:18 aymeric Exp $ */
2 
3 /*-
4  * Copyright (c) 2017 Jared McNeill <jmcneill@invisible.ca>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __KERNEL_RCSID(0, "$NetBSD: sunxi_gmacclk.c,v 1.2 2018/09/09 07:21:18 aymeric Exp $");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/device.h>
35 #include <sys/kmem.h>
36 #include <sys/bus.h>
37 
38 #include <dev/clk/clk_backend.h>
39 
40 #include <dev/fdt/fdtvar.h>
41 
42 #define	GMAC_CLK_PIT		__BIT(2)
43 #define	 GMAC_CLK_PIT_MII	0
44 #define	 GMAC_CLK_PIT_RGMII	1
45 #define	GMAC_CLK_SRC		__BITS(1,0)
46 #define	 GMAC_CLK_SRC_MII	0
47 #define	 GMAC_CLK_SRC_EXT_RGMII	1
48 #define	 GMAC_CLK_SRC_RGMII	2
49 
50 static int	sunxi_gmacclk_match(device_t, cfdata_t, void *);
51 static void	sunxi_gmacclk_attach(device_t, device_t, void *);
52 
53 static struct clk *sunxi_gmacclk_decode(device_t, int, const void *, size_t);
54 
55 static const struct fdtbus_clock_controller_func sunxi_gmacclk_fdt_funcs = {
56 	.decode = sunxi_gmacclk_decode
57 };
58 
59 static struct clk *sunxi_gmacclk_get(void *, const char *);
60 static void	sunxi_gmacclk_put(void *, struct clk *);
61 static int	sunxi_gmacclk_set_rate(void *, struct clk *, u_int);
62 static u_int	sunxi_gmacclk_get_rate(void *, struct clk *);
63 static struct clk *sunxi_gmacclk_get_parent(void *, struct clk *);
64 
65 static const struct clk_funcs sunxi_gmacclk_clk_funcs = {
66 	.get = sunxi_gmacclk_get,
67 	.put = sunxi_gmacclk_put,
68 	.set_rate = sunxi_gmacclk_set_rate,
69 	.get_rate = sunxi_gmacclk_get_rate,
70 	.get_parent = sunxi_gmacclk_get_parent,
71 };
72 
73 struct sunxi_gmacclk_softc {
74 	device_t		sc_dev;
75 	int			sc_phandle;
76 	bus_space_tag_t		sc_bst;
77 	bus_space_handle_t	sc_bsh;
78 
79 	struct clk_domain	sc_clkdom;
80 	struct clk		sc_clk;
81 	struct clk		*sc_parent[2];
82 };
83 
84 #define	RD4(sc, reg)			\
85 	bus_space_read_4((sc)->sc_bst, (sc)->sc_bsh, (reg))
86 #define	WR4(sc, reg, val)		\
87 	bus_space_write_4((sc)->sc_bst, (sc)->sc_bsh, (reg), (val))
88 
89 CFATTACH_DECL_NEW(sunxi_gmacclk, sizeof(struct sunxi_gmacclk_softc),
90     sunxi_gmacclk_match, sunxi_gmacclk_attach, NULL, NULL);
91 
92 static int
93 sunxi_gmacclk_match(device_t parent, cfdata_t cf, void *aux)
94 {
95 	const char * const compatible[] = { "allwinner,sun7i-a20-gmac-clk", NULL };
96 	const struct fdt_attach_args *faa = aux;
97 
98 	return of_match_compatible(faa->faa_phandle, compatible);
99 }
100 
101 static void
102 sunxi_gmacclk_attach(device_t parent, device_t self, void *aux)
103 {
104 	struct sunxi_gmacclk_softc * const sc = device_private(self);
105 	const struct fdt_attach_args *faa = aux;
106 	const int phandle = faa->faa_phandle;
107 	bus_addr_t addr;
108 	bus_size_t size;
109 
110 	if (fdtbus_get_reg(phandle, 0, &addr, &size) != 0) {
111 		aprint_error(": couldn't get registers\n");
112 		return;
113 	}
114 
115 	sc->sc_dev = self;
116 	sc->sc_phandle = phandle;
117 	sc->sc_bst = faa->faa_bst;
118 	if (bus_space_map(sc->sc_bst, addr, size, 0, &sc->sc_bsh) != 0) {
119 		aprint_error(": couldn't map registers\n");
120 		return;
121 	}
122 	sc->sc_parent[0] = fdtbus_clock_get_index(phandle, 0);
123 	sc->sc_parent[1] = fdtbus_clock_get_index(phandle, 1);
124 	if (sc->sc_parent[0] == NULL || sc->sc_parent[1] == NULL) {
125 		aprint_error(": couldn't get parent clocks\n");
126 		return;
127 	}
128 
129 	sc->sc_clkdom.funcs = &sunxi_gmacclk_clk_funcs;
130 	sc->sc_clkdom.priv = sc;
131 
132 	sc->sc_clk.domain = &sc->sc_clkdom;
133 	sc->sc_clk.name = kmem_asprintf("%s", faa->faa_name);
134 
135 	aprint_naive("\n");
136 	aprint_normal(": GMAC MII/RGMII clock mux\n");
137 
138 	fdtbus_register_clock_controller(self, phandle, &sunxi_gmacclk_fdt_funcs);
139 }
140 
141 static struct clk *
142 sunxi_gmacclk_decode(device_t dev, int cc_phandle, const void *data,
143 		     size_t len)
144 {
145 	struct sunxi_gmacclk_softc * const sc = device_private(dev);
146 
147 	if (len != 0)
148 		return NULL;
149 
150 	return &sc->sc_clk;
151 }
152 
153 static struct clk *
154 sunxi_gmacclk_get(void *priv, const char *name)
155 {
156 	struct sunxi_gmacclk_softc * const sc = priv;
157 
158 	if (strcmp(name, sc->sc_clk.name) != 0)
159 		return NULL;
160 
161 	return &sc->sc_clk;
162 }
163 
164 static void
165 sunxi_gmacclk_put(void *priv, struct clk *clk)
166 {
167 }
168 
169 static int
170 sunxi_gmacclk_set_rate(void *priv, struct clk *clk, u_int rate)
171 {
172 	struct sunxi_gmacclk_softc * const sc = priv;
173 	uint32_t val;
174 
175 	val = RD4(sc, 0);
176 	val &= ~(GMAC_CLK_PIT|GMAC_CLK_SRC);
177 	if (rate == clk_get_rate(sc->sc_parent[GMAC_CLK_PIT_MII])) {
178 		/* MII clock */
179 		val |= __SHIFTIN(GMAC_CLK_PIT_MII, GMAC_CLK_PIT);
180 		val |= __SHIFTIN(GMAC_CLK_SRC_MII, GMAC_CLK_SRC);
181 	} else if (rate == clk_get_rate(sc->sc_parent[GMAC_CLK_PIT_RGMII])) {
182 		/* RGMII clock */
183 		val |= __SHIFTIN(GMAC_CLK_PIT_RGMII, GMAC_CLK_PIT);
184 		val |= __SHIFTIN(GMAC_CLK_SRC_RGMII, GMAC_CLK_SRC);
185 	} else {
186 		return ENXIO;
187 	}
188 	WR4(sc, 0, val);
189 
190 	return 0;
191 }
192 
193 static u_int
194 sunxi_gmacclk_get_rate(void *priv, struct clk *clk)
195 {
196 	struct clk *clk_parent = clk_get_parent(clk);
197 
198 	return clk_get_rate(clk_parent);
199 }
200 
201 static struct clk *
202 sunxi_gmacclk_get_parent(void *priv, struct clk *clk)
203 {
204 	struct sunxi_gmacclk_softc * const sc = priv;
205 	uint32_t val;
206 	u_int sel;
207 
208 	val = RD4(sc, 0);
209 	sel = __SHIFTOUT(val, GMAC_CLK_PIT);
210 
211 	return sc->sc_parent[sel];
212 }
213