xref: /netbsd-src/sys/dev/isa/radiotrack2.c (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /* $NetBSD: radiotrack2.c,v 1.13 2006/11/16 01:33:00 christos Exp $ */
2 /* $OpenBSD: radiotrack2.c,v 1.1 2001/12/05 10:27:06 mickey Exp $ */
3 /* $RuOBSD: radiotrack2.c,v 1.2 2001/10/18 16:51:36 pva Exp $ */
4 
5 /*
6  * Copyright (c) 2001 Maxim Tsyplakov <tm@oganer.net>,
7  *                    Vladimir Popov <jumbo@narod.ru>
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /* AIMS Lab Radiotrack II FM Radio Card device driver */
32 
33 /*
34  * Philips TEA5757H AM/FM Self Tuned Radio:
35  *	http://www.semiconductors.philips.com/pip/TEA5757H
36  */
37 
38 #include <sys/cdefs.h>
39 __KERNEL_RCSID(0, "$NetBSD: radiotrack2.c,v 1.13 2006/11/16 01:33:00 christos Exp $");
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/proc.h>
44 #include <sys/errno.h>
45 #include <sys/ioctl.h>
46 #include <sys/device.h>
47 #include <sys/radioio.h>
48 
49 #include <dev/isa/isavar.h>
50 #include <dev/radio_if.h>
51 #include <dev/ic/tea5757.h>
52 
53 #define RTII_BASE_VALID(x)	((x == 0x20C) || (x == 0x30C))
54 #define RTII_CAPABILITIES	RADIO_CAPS_DETECT_STEREO |		\
55 				RADIO_CAPS_DETECT_SIGNAL |		\
56 				RADIO_CAPS_SET_MONO |			\
57 				RADIO_CAPS_LOCK_SENSITIVITY |		\
58 				RADIO_CAPS_HW_AFC |			\
59 				RADIO_CAPS_HW_SEARCH
60 
61 #if 0
62 #define RTII_SIGNAL		(1 << 3)
63 #define RTII_STEREO		(1 << 3)
64 #endif /* 0 */
65 
66 #define RTII_MUTE		0x01
67 #define RTII_UNMUTE		0x00
68 
69 #define RTII_RESET		0xC8
70 
71 #define RTII_DATA_ON		(1 << 2)
72 #define RTII_DATA_OFF		(0 << 2)
73 
74 #define RTII_CLCK_ON		(1 << 1)
75 #define RTII_CLCK_OFF		(0 << 1)
76 
77 #define RTII_WREN_ON		(0 << 0)
78 #define RTII_WREN_OFF		(1 << 0)
79 
80 #define RTII_READ_CLOCK_LOW	(RTII_DATA_ON | RTII_CLCK_OFF | RTII_WREN_OFF)
81 #define RTII_READ_CLOCK_HIGH	(RTII_DATA_ON | RTII_CLCK_ON | RTII_WREN_OFF)
82 
83 int	rtii_probe(struct device *, struct cfdata *, void *);
84 void	rtii_attach(struct device *, struct device * self, void *);
85 
86 int	rtii_get_info(void *, struct radio_info *);
87 int	rtii_set_info(void *, struct radio_info *);
88 int	rtii_search(void *, int);
89 
90 /* define our interface to the higher level radio driver */
91 const struct radio_hw_if rtii_hw_if = {
92 	NULL,	/* open */
93 	NULL,	/* close */
94 	rtii_get_info,
95 	rtii_set_info,
96 	rtii_search
97 };
98 
99 struct rtii_softc {
100 	struct device	dev;
101 
102 	u_int32_t	freq;
103 	u_int32_t	stereo;
104 	u_int32_t	lock;
105 	u_int8_t	vol;
106 	int	mute;
107 
108 	struct tea5757_t	tea;
109 };
110 
111 CFATTACH_DECL(rtii, sizeof(struct rtii_softc),
112     rtii_probe, rtii_attach, NULL, NULL);
113 
114 void	rtii_set_mute(struct rtii_softc *);
115 int	rtii_find(bus_space_tag_t, bus_space_handle_t);
116 
117 u_int32_t	rtii_hw_read(bus_space_tag_t, bus_space_handle_t, bus_size_t);
118 
119 void	rtii_init(bus_space_tag_t, bus_space_handle_t, bus_size_t, u_int32_t);
120 void	rtii_rset(bus_space_tag_t, bus_space_handle_t, bus_size_t, u_int32_t);
121 void	rtii_write_bit(bus_space_tag_t, bus_space_handle_t, bus_size_t, int);
122 
123 int
124 rtii_probe(struct device *parent, struct cfdata *cf,
125     void *aux)
126 {
127 	struct isa_attach_args *ia = aux;
128 	bus_space_tag_t iot = ia->ia_iot;
129 	bus_space_handle_t ioh;
130 	u_int r;
131 	int iosize = 1, iobase;
132 
133 	if (ISA_DIRECT_CONFIG(ia))
134 		return 0;
135 
136 	if (ia->ia_nio < 1)
137 		return 0;
138 
139 	iobase = ia->ia_io[0].ir_addr;
140 
141 	if (!RTII_BASE_VALID(iobase)) {
142 		printf("rtii: configured iobase 0x%x invalid\n", iobase);
143 		return 0;
144 	}
145 
146 	if (bus_space_map(iot, iobase, iosize, 0, &ioh))
147 		return 0;
148 
149 	r = rtii_find(iot, ioh);
150 
151 	bus_space_unmap(iot, ioh, iosize);
152 
153 	if (r != 0) {
154 		ia->ia_nio = 1;
155 		ia->ia_io[0].ir_size = iosize;
156 
157 		ia->ia_niomem = 0;
158 		ia->ia_nirq = 0;
159 		ia->ia_ndrq = 0;
160 
161 		return (1);
162 	}
163 
164 	return (0);
165 }
166 
167 void
168 rtii_attach(struct device *parent, struct device *self, void *aux)
169 {
170 	struct rtii_softc *sc = (void *) self;
171 	struct isa_attach_args *ia = aux;
172 
173 	sc->tea.iot = ia->ia_iot;
174 	sc->tea.flags = 0;
175 	sc->mute = 0;
176 	sc->vol = 0;
177 	sc->freq = MIN_FM_FREQ;
178 	sc->stereo = TEA5757_STEREO;
179 	sc->lock = TEA5757_S030;
180 
181 	/* remap I/O */
182 	if (bus_space_map(sc->tea.iot, ia->ia_io[0].ir_addr,
183 	    ia->ia_io[0].ir_size, 0, &sc->tea.ioh))
184 		panic("rtiiattach: bus_space_map() failed");
185 
186 	sc->tea.offset = 0;
187 
188 	sc->tea.init = rtii_init;
189 	sc->tea.rset = rtii_rset;
190 	sc->tea.write_bit = rtii_write_bit;
191 	sc->tea.read = rtii_hw_read;
192 
193 	printf(": AIMS Lab Radiotrack II\n");
194 	tea5757_set_freq(&sc->tea, sc->stereo, sc->lock, sc->freq);
195 	rtii_set_mute(sc);
196 
197 	radio_attach_mi(&rtii_hw_if, sc, &sc->dev);
198 }
199 
200 /*
201  * Mute/unmute the card
202  */
203 void
204 rtii_set_mute(struct rtii_softc *sc)
205 {
206 	u_int8_t mute;
207 
208 	mute = (sc->mute || !sc->vol) ? RTII_MUTE : RTII_UNMUTE;
209 	bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
210 	DELAY(6);
211 	bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
212 }
213 
214 void
215 rtii_init(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off,
216     u_int32_t d)
217 {
218 	bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_OFF);
219 	bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_ON);
220 	bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_ON);
221 }
222 
223 void
224 rtii_rset(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off,
225     u_int32_t d)
226 {
227 	bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_OFF);
228 }
229 
230 int
231 rtii_find(bus_space_tag_t iot, bus_space_handle_t ioh)
232 {
233 	struct rtii_softc sc;
234 	u_int32_t freq;
235 
236 	sc.tea.iot = iot;
237 	sc.tea.ioh = ioh;
238 	sc.tea.offset = 0;
239 	sc.tea.init = rtii_init;
240 	sc.tea.rset = rtii_rset;
241 	sc.tea.write_bit = rtii_write_bit;
242 	sc.tea.read = rtii_hw_read;
243 	sc.lock = TEA5757_S030;
244 	sc.stereo = TEA5757_STEREO;
245 
246 	/*
247 	 * Let's try to write and read a frequency.
248 	 * If the written and read frequencies are
249 	 * the same then success.
250 	 */
251 	sc.freq = MIN_FM_FREQ;
252 	tea5757_set_freq(&sc.tea, sc.stereo, sc.lock, sc.freq);
253 	rtii_set_mute(&sc);
254 	freq = rtii_hw_read(iot, ioh, sc.tea.offset);
255 	if (tea5757_decode_freq(freq, 0) == sc.freq)
256 		return 1;
257 
258 	return 0;
259 }
260 
261 void
262 rtii_write_bit(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off, int bit)
263 {
264 	u_int8_t data;
265 
266 	data = bit ? RTII_DATA_ON : RTII_DATA_OFF;
267 
268 	bus_space_write_1(iot, ioh, off, RTII_WREN_ON | RTII_CLCK_OFF | data);
269 	bus_space_write_1(iot, ioh, off, RTII_WREN_ON | RTII_CLCK_ON  | data);
270 	bus_space_write_1(iot, ioh, off, RTII_WREN_ON | RTII_CLCK_OFF | data);
271 }
272 
273 u_int32_t
274 rtii_hw_read(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off)
275 {
276 	u_int8_t i;
277 	u_int32_t res = 0;
278 
279 	bus_space_write_1(iot, ioh, off, RTII_READ_CLOCK_LOW);
280 	DELAY(6);
281 
282 	i = 24;
283 	while ( i-- ) {
284 		bus_space_write_1(iot, ioh, off, RTII_READ_CLOCK_HIGH);
285 		DELAY(6);
286 		bus_space_write_1(iot, ioh, off, RTII_READ_CLOCK_LOW);
287 		res |= bus_space_read_1(iot, ioh, off) & RTII_DATA_ON ? 1 : 0;
288 		DELAY(6);
289 		res <<= 1;
290 	}
291 
292 	return (res & (TEA5757_DATA | TEA5757_FREQ)) >> 1;
293 }
294 
295 int
296 rtii_get_info(void *v, struct radio_info *ri)
297 {
298 	struct rtii_softc *sc = v;
299 
300 	ri->mute = sc->mute;
301 	ri->volume = sc->vol ? 255 : 0;
302 	ri->stereo = sc->stereo == TEA5757_STEREO ? 1 : 0;
303 	ri->caps = RTII_CAPABILITIES;
304 	ri->rfreq = 0;
305 	ri->lock = tea5757_decode_lock(sc->lock);
306 
307 	ri->freq  = sc->freq = tea5757_decode_freq(rtii_hw_read(sc->tea.iot,
308 				sc->tea.ioh, sc->tea.offset), 0);
309 
310 	switch (bus_space_read_1(sc->tea.iot, sc->tea.ioh, 0)) {
311 	case 0xFD:
312 		ri->info = RADIO_INFO_SIGNAL | RADIO_INFO_STEREO;
313 		break;
314 	case 0xFF:
315 		ri->info = 0;
316 		break;
317 	default:
318 		ri->info = RADIO_INFO_SIGNAL;
319 	}
320 
321 	return (0);
322 }
323 
324 int
325 rtii_set_info(void *v, struct radio_info *ri)
326 {
327 	struct rtii_softc *sc = v;
328 
329 	sc->mute = ri->mute ? 1 : 0;
330 	sc->vol = ri->volume ? 255 : 0;
331 	sc->stereo = ri->stereo ? TEA5757_STEREO: TEA5757_MONO;
332 	sc->lock = tea5757_encode_lock(ri->lock);
333 	ri->freq = sc->freq = tea5757_set_freq(&sc->tea,
334 			sc->lock, sc->stereo, ri->freq);
335 	rtii_set_mute(sc);
336 
337 	return (0);
338 }
339 
340 int
341 rtii_search(void *v, int f)
342 {
343 	struct rtii_softc *sc = v;
344 
345 	tea5757_search(&sc->tea, sc->lock, sc->stereo, f);
346 	rtii_set_mute(sc);
347 
348 	return (0);
349 }
350