1*8e90f9edSthorpej /* $NetBSD: meson_usbctrl.c,v 1.5 2021/01/27 03:10:18 thorpej Exp $ */
2775d4b67Sryo
3775d4b67Sryo /*
4775d4b67Sryo * Copyright (c) 2021 Ryo Shimizu <ryo@nerv.org>
5775d4b67Sryo * All rights reserved.
6775d4b67Sryo *
7775d4b67Sryo * Redistribution and use in source and binary forms, with or without
8775d4b67Sryo * modification, are permitted provided that the following conditions
9775d4b67Sryo * are met:
10775d4b67Sryo * 1. Redistributions of source code must retain the above copyright
11775d4b67Sryo * notice, this list of conditions and the following disclaimer.
12775d4b67Sryo * 2. Redistributions in binary form must reproduce the above copyright
13775d4b67Sryo * notice, this list of conditions and the following disclaimer in the
14775d4b67Sryo * documentation and/or other materials provided with the distribution.
15775d4b67Sryo *
16775d4b67Sryo * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
17775d4b67Sryo * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18775d4b67Sryo * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19775d4b67Sryo * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20775d4b67Sryo * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21775d4b67Sryo * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22775d4b67Sryo * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23775d4b67Sryo * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24775d4b67Sryo * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
25775d4b67Sryo * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26775d4b67Sryo * POSSIBILITY OF SUCH DAMAGE.
27775d4b67Sryo */
28775d4b67Sryo
29775d4b67Sryo #include <sys/cdefs.h>
30*8e90f9edSthorpej __KERNEL_RCSID(0, "$NetBSD: meson_usbctrl.c,v 1.5 2021/01/27 03:10:18 thorpej Exp $");
31775d4b67Sryo
32775d4b67Sryo #include <sys/param.h>
33775d4b67Sryo #include <sys/types.h>
34775d4b67Sryo #include <sys/bus.h>
35775d4b67Sryo #include <sys/device.h>
36775d4b67Sryo
37775d4b67Sryo #include <dev/fdt/fdtvar.h>
38775d4b67Sryo
39775d4b67Sryo /*
40775d4b67Sryo * USB Glue registers: 0xffe09000
41775d4b67Sryo */
42775d4b67Sryo
43775d4b67Sryo /* usb2 phy ports control registers */
44775d4b67Sryo #define MESONUSBCTRL_MAXPHYS 3
45775d4b67Sryo #define U2P_R0_REG(i) (0x20 * (i) + 0x00)
46775d4b67Sryo #define U2P_R0_DRV_VBUS __BIT(5)
47775d4b67Sryo #define U2P_R0_ID_PULLUP __BIT(4)
48775d4b67Sryo #define U2P_R0_POWER_ON_RESET __BIT(3)
49775d4b67Sryo #define U2P_R0_HAST_MODE __BIT(2)
50775d4b67Sryo #define U2P_R0_POWER_OK __BIT(1)
51775d4b67Sryo #define U2P_R0_HOST_DEVICE __BIT(0)
52775d4b67Sryo #define U2P_R1_REG(i) (0x20 * (i) + 0x04)
53775d4b67Sryo #define U2P_R1_VBUS_VALID __BIT(3)
54775d4b67Sryo #define U2P_R1_OTG_SESSION_VALID __BIT(2)
55775d4b67Sryo #define U2P_R1_ID_DIG __BIT(1)
56775d4b67Sryo #define U2P_R1_PHY_READY __BIT(0)
57775d4b67Sryo
58775d4b67Sryo /* glue registers */
59775d4b67Sryo #define USB_R0_REG 0x80
60775d4b67Sryo #define USB_R0_U2D_ACT __BIT(31)
61775d4b67Sryo #define USB_R0_U2D_SS_SCALEDOWN_MODE_MASK __BITS(30,29)
62775d4b67Sryo #define USB_R0_P30_PCS_RX_LOS_MASK_VAL_MASK __BITS(28,19)
63775d4b67Sryo #define USB_R0_P30_LANE0_EXT_PCLK_REQ __BIT(18)
64775d4b67Sryo #define USB_R0_P30_LANE0_TX2RX_LOOPBACK __BIT(17)
65775d4b67Sryo #define USB_R1_REG 0x84
66775d4b67Sryo #define USB_R1_P30_PCS_TX_SWING_FULL_MASK __BITS(31,25)
67775d4b67Sryo #define USB_R1_U3H_FLADJ_30MHZ_REG_MASK __BITS(24,19)
68775d4b67Sryo #define USB_R1_U3H_HOST_MSI_ENABLE __BIT(18)
69775d4b67Sryo #define USB_R1_U3H_HOST_PORT_POWER_CONTROL_PRESENT __BIT(17)
70775d4b67Sryo #define USB_R1_U3H_HOST_U3_PORT_DISABLE __BIT(16)
71775d4b67Sryo #define USB_R1_U3H_HOST_U2_PORT_DISABLE_MASK __BITS(13,12)
72775d4b67Sryo #define USB_R1_U3H_HUB_PORT_PERM_ATTACH_MASK __BITS(9,7)
73775d4b67Sryo #define USB_R1_U3H_HUB_PORT_OVERCURRENT_MASK __BITS(4,2)
74775d4b67Sryo #define USB_R1_U3H_PME_ENABLE __BIT(1)
75775d4b67Sryo #define USB_R1_U3H_BIGENDIAN_GS __BIT(0)
76775d4b67Sryo #define USB_R2_REG 0x88
77775d4b67Sryo #define USB_R2_P30_PCS_TX_DEEMPH_6DB_MASK __BITS(31,26)
78775d4b67Sryo #define USB_R2_P30_PCS_TX_DEEMPH_3P5DB_MASK __BITS(25,20)
79775d4b67Sryo #define USB_R3_REG 0x8c
80775d4b67Sryo #define USB_R3_P30_REF_SSP_EN __BIT(13)
81775d4b67Sryo #define USB_R3_P30_SSC_REF_CLK_SEL_MASK __BITS(12,4)
82775d4b67Sryo #define USB_R3_P30_SSC_RANGE_MASK __BITS(3,1)
83775d4b67Sryo #define USB_R3_P30_SSC_ENABLE __BIT(0)
84775d4b67Sryo #define USB_R4_REG 0x90
85775d4b67Sryo #define USB_R4_P21_ONLY __BIT(4)
86775d4b67Sryo #define USB_R4_MEM_PD_MASK __BITS(3,2)
87775d4b67Sryo #define USB_R4_P21_SLEEP_M0 __BIT(1)
88775d4b67Sryo #define USB_R4_P21_PORT_RESET_0 __BIT(0)
89775d4b67Sryo #define USB_R5_REG 0x94
90775d4b67Sryo #define USB_R5_ID_DIG_CNT_MASK __BITS(23,16)
91775d4b67Sryo #define USB_R5_ID_DIG_TH_MASK __BITS(15,8)
92775d4b67Sryo #define USB_R5_ID_DIG_IRQ __BIT(7)
93775d4b67Sryo #define USB_R5_ID_DIG_CURR __BIT(6)
94775d4b67Sryo #define USB_R5_ID_DIG_EN_1 __BIT(5)
95775d4b67Sryo #define USB_R5_ID_DIG_EN_0 __BIT(4)
96775d4b67Sryo #define USB_R5_ID_DIG_CFG_MASK __BITS(3,2)
97775d4b67Sryo #define USB_R5_ID_DIG_REG __BIT(1)
98775d4b67Sryo #define USB_R5_ID_DIG_SYNC __BIT(0)
99775d4b67Sryo
100775d4b67Sryo #define USBCTRL_READ_REG(sc, reg) \
101775d4b67Sryo bus_space_read_4((sc)->sc_bst, (sc)->sc_bsh, (reg))
102775d4b67Sryo #define USBCTRL_WRITE_REG(sc, reg, val) \
103775d4b67Sryo bus_space_write_4((sc)->sc_bst, (sc)->sc_bsh, (reg), (val))
104775d4b67Sryo
105775d4b67Sryo struct meson_usbctrl_config {
106775d4b67Sryo int num_phys;
107775d4b67Sryo };
108775d4b67Sryo
109775d4b67Sryo struct meson_usbctrl_config mesong12_conf = {
110775d4b67Sryo .num_phys = 3
111775d4b67Sryo };
112775d4b67Sryo
1130717bee5Sthorpej static const struct device_compatible_entry compat_data[] = {
1140717bee5Sthorpej { .compat = "amlogic,meson-g12a-usb-ctrl", .data = &mesong12_conf },
115d86b4146Sthorpej DEVICE_COMPAT_EOL
116775d4b67Sryo };
117775d4b67Sryo
118775d4b67Sryo struct meson_usbctrl_softc {
119775d4b67Sryo device_t sc_dev;
120775d4b67Sryo bus_space_tag_t sc_bst;
121775d4b67Sryo bus_space_handle_t sc_bsh;
1220717bee5Sthorpej const struct meson_usbctrl_config *sc_conf;
123775d4b67Sryo struct fdtbus_regulator *sc_supply;
124775d4b67Sryo int sc_phandle;
125775d4b67Sryo };
126775d4b67Sryo
127775d4b67Sryo static void
meson_usbctrl_usb2_init(struct meson_usbctrl_softc * sc)128775d4b67Sryo meson_usbctrl_usb2_init(struct meson_usbctrl_softc *sc)
129775d4b67Sryo {
130775d4b67Sryo int i;
131775d4b67Sryo const char *p;
132775d4b67Sryo
133775d4b67Sryo for (i = 0; i < sc->sc_conf->num_phys; i++) {
134775d4b67Sryo /* setup only for usb2 phys */
135775d4b67Sryo p = fdtbus_get_string_index(sc->sc_phandle, "phy-names", i);
136775d4b67Sryo if (p == NULL || strstr(p, "usb2") == NULL)
137775d4b67Sryo continue;
138775d4b67Sryo
139775d4b67Sryo USBCTRL_WRITE_REG(sc, U2P_R0_REG(i),
140775d4b67Sryo USBCTRL_READ_REG(sc, U2P_R0_REG(i)) |
141775d4b67Sryo U2P_R0_POWER_ON_RESET);
142775d4b67Sryo
143775d4b67Sryo /* XXX: OTG not supported. always set HOST_DEVICE mode */
144775d4b67Sryo USBCTRL_WRITE_REG(sc, U2P_R0_REG(i),
145775d4b67Sryo USBCTRL_READ_REG(sc, U2P_R0_REG(i)) |
146775d4b67Sryo U2P_R0_HOST_DEVICE);
147775d4b67Sryo
148775d4b67Sryo USBCTRL_WRITE_REG(sc, U2P_R0_REG(i),
149775d4b67Sryo USBCTRL_READ_REG(sc, U2P_R0_REG(i)) &
150775d4b67Sryo ~U2P_R0_POWER_ON_RESET);
151775d4b67Sryo }
152775d4b67Sryo }
153775d4b67Sryo
154775d4b67Sryo static void
meson_usbctrl_usb_glue_init(struct meson_usbctrl_softc * sc)155775d4b67Sryo meson_usbctrl_usb_glue_init(struct meson_usbctrl_softc *sc)
156775d4b67Sryo {
157775d4b67Sryo uint32_t val;
158775d4b67Sryo
159775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R1_REG);
160775d4b67Sryo val &= ~USB_R1_U3H_FLADJ_30MHZ_REG_MASK;
161775d4b67Sryo val |= __SHIFTIN(0x20, USB_R1_U3H_FLADJ_30MHZ_REG_MASK);
162775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R1_REG, val);
163775d4b67Sryo
164775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R5_REG);
165775d4b67Sryo val |= USB_R5_ID_DIG_EN_0;
166775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R5_REG, val);
167775d4b67Sryo
168775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R5_REG);
169775d4b67Sryo val |= USB_R5_ID_DIG_EN_1;
170775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R5_REG, val);
171775d4b67Sryo
172775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R5_REG);
173775d4b67Sryo val &= ~USB_R5_ID_DIG_TH_MASK;
174775d4b67Sryo val |= __SHIFTIN(0xff, USB_R5_ID_DIG_TH_MASK);
175775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R5_REG, val);
176775d4b67Sryo }
177775d4b67Sryo
178775d4b67Sryo static void
meson_usbctrl_usb3_init(struct meson_usbctrl_softc * sc)179775d4b67Sryo meson_usbctrl_usb3_init(struct meson_usbctrl_softc *sc)
180775d4b67Sryo {
181775d4b67Sryo uint32_t val;
182775d4b67Sryo
183775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R3_REG);
184775d4b67Sryo val &= ~USB_R3_P30_SSC_RANGE_MASK;
185775d4b67Sryo val &= ~USB_R3_P30_SSC_ENABLE;
186775d4b67Sryo val |= __SHIFTIN(2, USB_R3_P30_SSC_RANGE_MASK);
187775d4b67Sryo val |= USB_R3_P30_REF_SSP_EN;
188775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R3_REG, val);
189775d4b67Sryo
190775d4b67Sryo delay(2);
191775d4b67Sryo
192775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R2_REG);
193775d4b67Sryo val &= ~USB_R2_P30_PCS_TX_DEEMPH_3P5DB_MASK;
194775d4b67Sryo val |= __SHIFTIN(0x15, USB_R2_P30_PCS_TX_DEEMPH_3P5DB_MASK);
195775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R2_REG, val);
196775d4b67Sryo
197775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R2_REG);
198775d4b67Sryo val &= ~USB_R2_P30_PCS_TX_DEEMPH_6DB_MASK;
199775d4b67Sryo val |= __SHIFTIN(0x20, USB_R2_P30_PCS_TX_DEEMPH_6DB_MASK);
200775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R2_REG, val);
201775d4b67Sryo
202775d4b67Sryo delay(2);
203775d4b67Sryo
204775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R1_REG);
205775d4b67Sryo val |= USB_R1_U3H_HOST_PORT_POWER_CONTROL_PRESENT;
206775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R1_REG, val);
207775d4b67Sryo
208775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R1_REG);
209775d4b67Sryo val &= ~USB_R1_P30_PCS_TX_SWING_FULL_MASK;
210775d4b67Sryo val |= __SHIFTIN(127, USB_R1_P30_PCS_TX_SWING_FULL_MASK);
211775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R1_REG, val);
212775d4b67Sryo
213775d4b67Sryo /* XXX: force HOST_DEVICE mode */
214775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R0_REG);
215775d4b67Sryo val &= ~USB_R0_U2D_ACT;
216775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R0_REG, val);
217775d4b67Sryo
218775d4b67Sryo val = USBCTRL_READ_REG(sc, USB_R4_REG);
219775d4b67Sryo val &= ~USB_R4_P21_SLEEP_M0;
220775d4b67Sryo USBCTRL_WRITE_REG(sc, USB_R4_REG, val);
221775d4b67Sryo }
222775d4b67Sryo
223775d4b67Sryo static void
meson_usbctrl_enable_usb3_phys(struct meson_usbctrl_softc * sc)224775d4b67Sryo meson_usbctrl_enable_usb3_phys(struct meson_usbctrl_softc *sc)
225775d4b67Sryo {
226775d4b67Sryo struct fdtbus_phy *phy;
227775d4b67Sryo int i;
228775d4b67Sryo const char *phyname;
229775d4b67Sryo
230775d4b67Sryo /*
231775d4b67Sryo * enable only for usb3 phys.
232775d4b67Sryo * node of "snps,dwc3" decl in "amlogic,meson-g12a-usb-ctrl" have
233775d4b67Sryo * no "phys" property, so enable the phy here.
234775d4b67Sryo */
235775d4b67Sryo for (i = 0; i < sc->sc_conf->num_phys; i++) {
236775d4b67Sryo phyname = fdtbus_get_string_index(sc->sc_phandle,
237775d4b67Sryo "phy-names", i);
238775d4b67Sryo if (strstr(phyname, "usb3") == NULL)
239775d4b67Sryo continue;
240775d4b67Sryo
241775d4b67Sryo phy = fdtbus_phy_get_index(sc->sc_phandle, i);
242775d4b67Sryo if (phy == NULL)
243775d4b67Sryo continue;
244775d4b67Sryo if (fdtbus_phy_enable(phy, true) != 0)
245775d4b67Sryo aprint_error_dev(sc->sc_dev, "couldn't enable phy %s\n",
246775d4b67Sryo phyname);
247775d4b67Sryo }
248775d4b67Sryo }
249775d4b67Sryo
250775d4b67Sryo static int
meson_usbctrl_match(device_t parent,cfdata_t cf,void * aux)251775d4b67Sryo meson_usbctrl_match(device_t parent, cfdata_t cf, void *aux)
252775d4b67Sryo {
253775d4b67Sryo struct fdt_attach_args * const faa = aux;
254775d4b67Sryo
255*8e90f9edSthorpej return of_compatible_match(faa->faa_phandle, compat_data);
256775d4b67Sryo }
257775d4b67Sryo
258775d4b67Sryo static void
meson_usbctrl_attach(device_t parent,device_t self,void * aux)259775d4b67Sryo meson_usbctrl_attach(device_t parent, device_t self, void *aux)
260775d4b67Sryo {
261775d4b67Sryo struct meson_usbctrl_softc * const sc = device_private(self);
262775d4b67Sryo struct fdt_attach_args * const faa = aux;
263775d4b67Sryo bus_addr_t addr;
264775d4b67Sryo bus_size_t size;
265775d4b67Sryo int phandle, child;
266775d4b67Sryo
267775d4b67Sryo sc->sc_dev = self;
268775d4b67Sryo sc->sc_bst = faa->faa_bst;
269775d4b67Sryo sc->sc_phandle = phandle = faa->faa_phandle;
270*8e90f9edSthorpej sc->sc_conf = of_compatible_lookup(phandle, compat_data)->data;
271775d4b67Sryo
272775d4b67Sryo if (fdtbus_get_reg(phandle, 0, &addr, &size) != 0) {
273775d4b67Sryo aprint_error(": couldn't get registers\n");
274775d4b67Sryo return;
275775d4b67Sryo }
276775d4b67Sryo if (bus_space_map(sc->sc_bst, addr, size, 0, &sc->sc_bsh) != 0) {
277775d4b67Sryo aprint_error(": couldn't map registers\n");
278775d4b67Sryo return;
279775d4b67Sryo }
280775d4b67Sryo
281775d4b67Sryo aprint_naive("\n");
282775d4b67Sryo aprint_normal(": USB Controllers\n");
283775d4b67Sryo
284775d4b67Sryo sc->sc_supply = fdtbus_regulator_acquire(phandle, "vbus-supply");
285775d4b67Sryo if (sc->sc_supply != NULL)
286775d4b67Sryo fdtbus_regulator_enable(sc->sc_supply); /* USB HOST MODE */
287775d4b67Sryo
288775d4b67Sryo meson_usbctrl_usb2_init(sc);
289775d4b67Sryo meson_usbctrl_usb_glue_init(sc);
290775d4b67Sryo meson_usbctrl_usb3_init(sc);
291775d4b67Sryo meson_usbctrl_enable_usb3_phys(sc);
292775d4b67Sryo
293775d4b67Sryo for (child = OF_child(phandle); child; child = OF_peer(child)) {
294775d4b67Sryo fdt_add_child(parent, child, faa, 0);
295775d4b67Sryo }
296775d4b67Sryo }
297775d4b67Sryo
298775d4b67Sryo CFATTACH_DECL_NEW(meson_usbctrl, sizeof(struct meson_usbctrl_softc),
299775d4b67Sryo meson_usbctrl_match, meson_usbctrl_attach, NULL, NULL);
300