1/* $NetBSD: ehci_fdt.c,v 1.8 2021/08/07 16:19:10 thorpej Exp $ */
2
3/*-
4 * Copyright (c) 2015-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: ehci_fdt.c,v 1.8 2021/08/07 16:19:10 thorpej Exp $");
31
32#include <sys/param.h>
33#include <sys/bus.h>
34#include <sys/device.h>
35#include <sys/intr.h>
36#include <sys/systm.h>
37#include <sys/kernel.h>
38
39#include <dev/usb/usb.h>
40#include <dev/usb/usbdi.h>
41#include <dev/usb/usbdivar.h>
42#include <dev/usb/usb_mem.h>
43#include <dev/usb/ehcireg.h>
44#include <dev/usb/ehcivar.h>
45
46#include <dev/fdt/fdtvar.h>
47
48static int	ehci_fdt_match(device_t, cfdata_t, void *);
49static void	ehci_fdt_attach(device_t, device_t, void *);
50
51CFATTACH_DECL2_NEW(ehci_fdt, sizeof(struct ehci_softc),
52	ehci_fdt_match, ehci_fdt_attach, NULL,
53	ehci_activate, NULL, ehci_childdet);
54
55static const struct device_compatible_entry compat_data[] = {
56	{ .compat = "generic-ehci" },
57	DEVICE_COMPAT_EOL
58};
59
60static int
61ehci_fdt_match(device_t parent, cfdata_t cf, void *aux)
62{
63	struct fdt_attach_args * const faa = aux;
64
65	return of_compatible_match(faa->faa_phandle, compat_data);
66}
67
68static void
69ehci_fdt_attach(device_t parent, device_t self, void *aux)
70{
71	struct ehci_softc * const sc = device_private(self);
72	struct fdt_attach_args * const faa = aux;
73	const int phandle = faa->faa_phandle;
74	struct fdtbus_reset *rst;
75	struct fdtbus_phy *phy;
76	struct clk *clk;
77	char intrstr[128];
78	bus_addr_t addr;
79	bus_size_t size;
80	int error;
81	void *ih;
82	u_int n;
83
84	if (fdtbus_get_reg(phandle, 0, &addr, &size) != 0) {
85		aprint_error(": couldn't get registers\n");
86		return;
87	}
88
89	/* Enable clocks */
90	for (n = 0; (clk = fdtbus_clock_get_index(phandle, n)) != NULL; n++)
91		if (clk_enable(clk) != 0) {
92			aprint_error(": couldn't enable clock #%d\n", n);
93			return;
94		}
95	/* De-assert resets */
96	for (n = 0; (rst = fdtbus_reset_get_index(phandle, n)) != NULL; n++)
97		if (fdtbus_reset_deassert(rst) != 0) {
98			aprint_error(": couldn't de-assert reset #%d\n", n);
99			return;
100		}
101
102	/* Enable optional phy */
103	phy = fdtbus_phy_get(phandle, "usb");
104	if (phy && fdtbus_phy_enable(phy, true) != 0) {
105		aprint_error(": couldn't enable phy\n");
106		return;
107	}
108
109	sc->sc_dev = self;
110	sc->sc_bus.ub_hcpriv = sc;
111	sc->sc_bus.ub_dmatag = faa->faa_dmat;
112	sc->sc_bus.ub_revision = USBREV_2_0;
113	if (of_hasprop(phandle, "has-transaction-translator"))
114		sc->sc_flags |= EHCIF_ETTF;
115	else
116		sc->sc_ncomp = 1;
117	sc->sc_size = size;
118	sc->iot = faa->faa_bst;
119	if (bus_space_map(sc->iot, addr, size, 0, &sc->ioh) != 0) {
120		aprint_error(": couldn't map registers\n");
121		return;
122	}
123
124	aprint_naive("\n");
125	aprint_normal(": EHCI\n");
126
127	/* Disable interrupts */
128	sc->sc_offs = EREAD1(sc, EHCI_CAPLENGTH);
129	EOWRITE4(sc, EHCI_USBINTR, 0);
130
131	if (!fdtbus_intr_str(phandle, 0, intrstr, sizeof(intrstr))) {
132		aprint_error_dev(self, "failed to decode interrupt\n");
133		return;
134	}
135
136	ih = fdtbus_intr_establish_xname(phandle, 0, IPL_USB, FDT_INTR_MPSAFE,
137	    ehci_intr, sc, device_xname(self));
138	if (ih == NULL) {
139		aprint_error_dev(self, "couldn't establish interrupt on %s\n",
140		    intrstr);
141		return;
142	}
143	aprint_normal_dev(self, "interrupting on %s\n", intrstr);
144
145	error = ehci_init(sc);
146	if (error) {
147		aprint_error_dev(self, "init failed, error = %d\n", error);
148		return;
149	}
150
151	pmf_device_register1(self, NULL, NULL, ehci_shutdown);
152
153	sc->sc_child = config_found(self, &sc->sc_bus, usbctlprint, CFARGS_NONE);
154}
155