xref: /freebsd/sys/dev/mmc/host/dwmmc_rockchip.c (revision 6419bb52)
1 /*
2  * Copyright 2017 Emmanuel Vadot <manu@freebsd.org>
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
13  *
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
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE
18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
21  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
24  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/bus.h>
33 #include <sys/module.h>
34 #include <sys/queue.h>
35 #include <sys/taskqueue.h>
36 
37 #include <machine/bus.h>
38 
39 #include <dev/mmc/bridge.h>
40 #include <dev/mmc/mmc_fdt_helpers.h>
41 
42 #include <dev/ofw/ofw_bus_subr.h>
43 
44 #ifdef EXT_RESOURCES
45 #include <dev/extres/clk/clk.h>
46 #endif
47 
48 #include <dev/mmc/host/dwmmc_var.h>
49 
50 #include "opt_mmccam.h"
51 
52 enum RKTYPE {
53 	RK2928 = 1,
54 	RK3288,
55 };
56 
57 static struct ofw_compat_data compat_data[] = {
58 	{"rockchip,rk2928-dw-mshc",	RK2928},
59 	{"rockchip,rk3288-dw-mshc",	RK3288},
60 	{NULL,				0},
61 };
62 
63 static int dwmmc_rockchip_update_ios(struct dwmmc_softc *sc, struct mmc_ios *ios);
64 
65 static int
66 rockchip_dwmmc_probe(device_t dev)
67 {
68 
69 	if (!ofw_bus_status_okay(dev))
70 		return (ENXIO);
71 
72 	if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
73 		return (ENXIO);
74 
75 	device_set_desc(dev, "Synopsys DesignWare Mobile "
76 	    "Storage Host Controller (RockChip)");
77 
78 	return (BUS_PROBE_VENDOR);
79 }
80 
81 static int
82 rockchip_dwmmc_attach(device_t dev)
83 {
84 	struct dwmmc_softc *sc;
85 	int type;
86 
87 	sc = device_get_softc(dev);
88 	sc->hwtype = HWTYPE_ROCKCHIP;
89 	type = ofw_bus_search_compatible(dev, compat_data)->ocd_data;
90 
91 	switch (type) {
92 	case RK2928:
93 		sc->use_pio = 1;
94 		break;
95 	}
96 
97 	sc->pwren_inverted = 1;
98 
99 #ifdef EXT_RESOURCES
100 	sc->update_ios = &dwmmc_rockchip_update_ios;
101 #endif
102 
103 	return (dwmmc_attach(dev));
104 }
105 
106 #ifdef EXT_RESOURCES
107 static int
108 dwmmc_rockchip_update_ios(struct dwmmc_softc *sc, struct mmc_ios *ios)
109 {
110 	unsigned int clock;
111 	int error;
112 
113 	if (ios->clock && ios->clock != sc->bus_hz) {
114 		sc->bus_hz = clock = ios->clock;
115 		/* Set the MMC clock. */
116 		if (sc->ciu) {
117 			/*
118 			 * Apparently you need to set the ciu clock to
119 			 * the double of bus_hz
120 			 */
121 			error = clk_set_freq(sc->ciu, clock * 2,
122 			    CLK_SET_ROUND_DOWN);
123 			if (error != 0) {
124 				device_printf(sc->dev,
125 				    "failed to set frequency to %u Hz: %d\n",
126 				    clock, error);
127 				return (error);
128 			}
129 		}
130 	}
131 	return (0);
132 }
133 #endif
134 
135 static device_method_t rockchip_dwmmc_methods[] = {
136 	/* bus interface */
137 	DEVMETHOD(device_probe, rockchip_dwmmc_probe),
138 	DEVMETHOD(device_attach, rockchip_dwmmc_attach),
139 	DEVMETHOD(device_detach, dwmmc_detach),
140 
141 	DEVMETHOD_END
142 };
143 
144 static devclass_t rockchip_dwmmc_devclass;
145 
146 DEFINE_CLASS_1(rockchip_dwmmc, rockchip_dwmmc_driver, rockchip_dwmmc_methods,
147     sizeof(struct dwmmc_softc), dwmmc_driver);
148 
149 DRIVER_MODULE(rockchip_dwmmc, simplebus, rockchip_dwmmc_driver,
150     rockchip_dwmmc_devclass, 0, 0);
151 DRIVER_MODULE(rockchip_dwmmc, ofwbus, rockchip_dwmmc_driver,
152     rockchip_dwmmc_devclass, NULL, NULL);
153 #ifndef MMCCAM
154 MMC_DECLARE_BRIDGE(rockchip_dwmmc);
155 #endif
156