xref: /freebsd/sys/arm/allwinner/aw_ts.c (revision 2008043f386721d58158e37e0d7e50df8095942d)
1 /*-
2  * Copyright (c) 2016 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  */
25 
26 /*
27  * Allwinner Touch Sreen driver
28  * Touch screen part is not done, only the thermal sensor part is.
29  */
30 
31 #include <sys/cdefs.h>
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/bus.h>
35 #include <sys/kernel.h>
36 #include <sys/module.h>
37 #include <sys/rman.h>
38 #include <sys/sysctl.h>
39 #include <machine/bus.h>
40 
41 #include <dev/ofw/openfirm.h>
42 #include <dev/ofw/ofw_bus.h>
43 #include <dev/ofw/ofw_bus_subr.h>
44 
45 #define	READ(_sc, _r) bus_read_4((_sc)->res[0], (_r))
46 #define	WRITE(_sc, _r, _v) bus_write_4((_sc)->res[0], (_r), (_v))
47 
48 /* Control register 0 */
49 #define	TP_CTRL0	0x00
50 #define	 TP_CTRL0_TACQ(x)	((x & 0xFF) << 0)
51 #define	 TP_CTRL0_FS_DIV(x)	((x & 0xF) << 16)
52 #define	 TP_CTRL0_CLK_DIV(x)	((x & 0x3) << 20)
53 #define	 TP_CTRL0_CLK_SELECT(x)	((x & 0x1) << 22)
54 
55 /* Control register 1 */
56 #define	TP_CTRL1	0x04
57 #define	 TP_CTRL1_MODE_EN	(1 << 4)
58 
59 /* Control register 2 */
60 #define	TP_CTRL2	0x08
61 
62 /* Control register 3 */
63 #define	TP_CTRL3	0x0C
64 
65 /* Int/FIFO control register */
66 #define	TP_FIFOC	0x10
67 #define	 TP_FIFOC_TEMP_IRQ_ENABLE	(1 << 18)
68 
69 /* Int/FIFO status register */
70 #define	TP_FIFOS	0x14
71 #define	 TP_FIFOS_TEMP_IRQ_PENDING	(1 << 18)
72 
73 /* Temperature Period Register */
74 #define	TP_TPR		0x18
75 #define	 TP_TPR_TEMP_EN		(1 << 16)
76 #define	 TP_TPR_TEMP_PERIOD(x)	(x << 0)
77 
78 /* Common data register */
79 #define	TP_CDAT		0x1C
80 
81 /* Temperature data register */
82 #define	TEMP_DATA	0x20
83 
84 /* TP Data register*/
85 #define	TP_DATA		0x24
86 
87 /* TP IO config register */
88 #define	TP_IO_CONFIG	0x28
89 
90 /* TP IO port data register */
91 #define	TP_IO_DATA	0x2C
92 
93 struct aw_ts_softc {
94 	device_t		dev;
95 	struct resource *	res[2];
96 	void *			intrhand;
97 	int			temp_data;
98 	int			temp_offset;
99 	int			temp_step;
100 };
101 
102 static struct resource_spec aw_ts_spec[] = {
103 	{ SYS_RES_MEMORY,	0,	RF_ACTIVE },
104 	{ SYS_RES_IRQ,		0,	RF_ACTIVE | RF_SHAREABLE },
105 	{ -1, 0 }
106 };
107 
108 #define	A10_TS	1
109 #define	A13_TS	2
110 
111 #define	AW_TS_TEMP_SYSCTL	1
112 
113 static struct ofw_compat_data compat_data[] = {
114 	{"allwinner,sun4i-a10-ts", A10_TS},
115 	{"allwinner,sun5i-a13-ts", A13_TS},
116 	{NULL,             0}
117 };
118 
119 static void
120 aw_ts_intr(void *arg)
121 {
122 	struct aw_ts_softc *sc;
123 	int val;
124 
125 	sc= (struct aw_ts_softc *)arg;
126 
127 	val = READ(sc, TP_FIFOS);
128 	if (val & TP_FIFOS_TEMP_IRQ_PENDING) {
129 		/* Convert the value to millicelsius then millikelvin */
130 		sc->temp_data = (READ(sc, TEMP_DATA) * sc->temp_step - sc->temp_offset)
131 			+ 273150;
132 	}
133 
134 	WRITE(sc, TP_FIFOS, val);
135 }
136 
137 static int
138 aw_ts_probe(device_t dev)
139 {
140 
141 	if (!ofw_bus_status_okay(dev))
142 		return (ENXIO);
143 
144 	if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
145 		return (ENXIO);
146 
147 	device_set_desc(dev, "Allwinner Touch Screen controller");
148 	return (BUS_PROBE_DEFAULT);
149 }
150 
151 static int
152 aw_ts_attach(device_t dev)
153 {
154 	struct aw_ts_softc *sc;
155 
156 	sc = device_get_softc(dev);
157 	sc->dev = dev;
158 
159 	if (bus_alloc_resources(dev, aw_ts_spec, sc->res) != 0) {
160 		device_printf(dev, "could not allocate memory resource\n");
161 		return (ENXIO);
162 	}
163 
164 	if (bus_setup_intr(dev, sc->res[1],
165 	    INTR_TYPE_MISC | INTR_MPSAFE, NULL, aw_ts_intr, sc,
166 	    &sc->intrhand)) {
167 		bus_release_resources(dev, aw_ts_spec, sc->res);
168 		device_printf(dev, "cannot setup interrupt handler\n");
169 		return (ENXIO);
170 	}
171 
172 	/*
173 	 * Thoses magic values were taken from linux which take them from
174 	 * the allwinner SDK or found them by deduction
175 	 */
176 	switch (ofw_bus_search_compatible(dev, compat_data)->ocd_data) {
177 	case A10_TS:
178 		sc->temp_offset = 257000;
179 		sc->temp_step = 133;
180 		break;
181 	case A13_TS:
182 		sc->temp_offset = 144700;
183 		sc->temp_step = 100;
184 		break;
185 	}
186 
187 	/* Enable clock and set divisers */
188 	WRITE(sc, TP_CTRL0, TP_CTRL0_CLK_SELECT(0) |
189 	  TP_CTRL0_CLK_DIV(2) |
190 	  TP_CTRL0_FS_DIV(7) |
191 	  TP_CTRL0_TACQ(63));
192 
193 	/* Enable TS module */
194 	WRITE(sc, TP_CTRL1, TP_CTRL1_MODE_EN);
195 
196 	/* Enable Temperature, period is ~2s */
197 	WRITE(sc, TP_TPR, TP_TPR_TEMP_EN | TP_TPR_TEMP_PERIOD(1953));
198 
199 	/* Enable temp irq */
200 	WRITE(sc, TP_FIFOC, TP_FIFOC_TEMP_IRQ_ENABLE);
201 
202 	/* Add sysctl */
203 	SYSCTL_ADD_PROC(device_get_sysctl_ctx(dev),
204 	    SYSCTL_CHILDREN(device_get_sysctl_tree(dev)),
205 	    OID_AUTO, "temperature",
206 	    CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
207 	    &sc->temp_data, 0, sysctl_handle_int,
208 	    "IK3", "CPU Temperature");
209 
210 	return (0);
211 }
212 
213 static device_method_t aw_ts_methods[] = {
214 	DEVMETHOD(device_probe, aw_ts_probe),
215 	DEVMETHOD(device_attach, aw_ts_attach),
216 
217 	DEVMETHOD_END
218 };
219 
220 static driver_t aw_ts_driver = {
221 	"aw_ts",
222 	aw_ts_methods,
223 	sizeof(struct aw_ts_softc),
224 };
225 
226 DRIVER_MODULE(aw_ts, simplebus, aw_ts_driver, 0, 0);
227