xref: /netbsd-src/sys/dev/isa/radiotrack2.c (revision 08c81a9c2dc8c7300e893321eb65c0925d60871c)
1 /* $NetBSD: radiotrack2.c,v 1.5 2002/09/03 18:53:41 augustss 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/param.h>
39 #include <sys/systm.h>
40 #include <sys/proc.h>
41 #include <sys/errno.h>
42 #include <sys/ioctl.h>
43 #include <sys/device.h>
44 #include <sys/radioio.h>
45 
46 #include <dev/isa/isavar.h>
47 #include <dev/radio_if.h>
48 #include <dev/ic/tea5757.h>
49 
50 #define RTII_BASE_VALID(x)	((x == 0x20C) || (x == 0x30C))
51 #define RTII_CAPABILITIES	RADIO_CAPS_DETECT_STEREO |		\
52 				RADIO_CAPS_DETECT_SIGNAL |		\
53 				RADIO_CAPS_SET_MONO |			\
54 				RADIO_CAPS_LOCK_SENSITIVITY |		\
55 				RADIO_CAPS_HW_AFC |			\
56 				RADIO_CAPS_HW_SEARCH
57 
58 #if 0
59 #define RTII_SIGNAL		(1 << 3)
60 #define RTII_STEREO		(1 << 3)
61 #endif /* 0 */
62 
63 #define RTII_MUTE		0x01
64 #define RTII_UNMUTE		0x00
65 
66 #define RTII_RESET		0xC8
67 
68 #define RTII_DATA_ON		(1 << 2)
69 #define RTII_DATA_OFF		(0 << 2)
70 
71 #define RTII_CLCK_ON		(1 << 1)
72 #define RTII_CLCK_OFF		(0 << 1)
73 
74 #define RTII_WREN_ON		(0 << 0)
75 #define RTII_WREN_OFF		(1 << 0)
76 
77 #define RTII_READ_CLOCK_LOW	(RTII_DATA_ON | RTII_CLCK_OFF | RTII_WREN_OFF)
78 #define RTII_READ_CLOCK_HIGH	(RTII_DATA_ON | RTII_CLCK_ON | RTII_WREN_OFF)
79 
80 int	rtii_probe(struct device *, struct cfdata *, void *);
81 void	rtii_attach(struct device *, struct device * self, void *);
82 
83 int	rtii_get_info(void *, struct radio_info *);
84 int	rtii_set_info(void *, struct radio_info *);
85 int	rtii_search(void *, int);
86 
87 /* define our interface to the higher level radio driver */
88 struct radio_hw_if rtii_hw_if = {
89 	NULL,	/* open */
90 	NULL,	/* close */
91 	rtii_get_info,
92 	rtii_set_info,
93 	rtii_search
94 };
95 
96 struct rtii_softc {
97 	struct device	dev;
98 
99 	u_int32_t	freq;
100 	u_int32_t	stereo;
101 	u_int32_t	lock;
102 	u_int8_t	vol;
103 	int	mute;
104 
105 	struct tea5757_t	tea;
106 };
107 
108 struct cfattach rtii_ca = {
109 	sizeof(struct rtii_softc), rtii_probe, rtii_attach
110 };
111 
112 void	rtii_set_mute(struct rtii_softc *);
113 int	rtii_find(bus_space_tag_t, bus_space_handle_t);
114 
115 u_int32_t	rtii_hw_read(bus_space_tag_t, bus_space_handle_t, bus_size_t);
116 
117 void	rtii_init(bus_space_tag_t, bus_space_handle_t, bus_size_t, u_int32_t);
118 void	rtii_rset(bus_space_tag_t, bus_space_handle_t, bus_size_t, u_int32_t);
119 void	rtii_write_bit(bus_space_tag_t, bus_space_handle_t, bus_size_t, int);
120 
121 int
122 rtii_probe(struct device *parent, struct cfdata *cf, void *aux)
123 {
124 	struct isa_attach_args *ia = aux;
125 	bus_space_tag_t iot = ia->ia_iot;
126 	bus_space_handle_t ioh;
127 	u_int r;
128 	int iosize = 1, iobase;
129 
130 	if (ISA_DIRECT_CONFIG(ia))
131 		return 0;
132 
133 	if (ia->ia_nio < 1)
134 		return 0;
135 
136 	iobase = ia->ia_io[0].ir_addr;
137 
138 	if (!RTII_BASE_VALID(iobase)) {
139 		printf("rtii: configured iobase 0x%x invalid\n", iobase);
140 		return 0;
141 	}
142 
143 	if (bus_space_map(iot, iobase, iosize, 0, &ioh))
144 		return 0;
145 
146 	r = rtii_find(iot, ioh);
147 
148 	bus_space_unmap(iot, ioh, iosize);
149 
150 	if (r != 0) {
151 		ia->ia_nio = 1;
152 		ia->ia_io[0].ir_size = iosize;
153 
154 		ia->ia_niomem = 0;
155 		ia->ia_nirq = 0;
156 		ia->ia_ndrq = 0;
157 
158 		return (1);
159 	}
160 
161 	return (0);
162 }
163 
164 void
165 rtii_attach(struct device *parent, struct device *self, void *aux)
166 {
167 	struct rtii_softc *sc = (void *) self;
168 	struct isa_attach_args *ia = aux;
169 
170 	sc->tea.iot = ia->ia_iot;
171 	sc->tea.flags = 0;
172 	sc->mute = 0;
173 	sc->vol = 0;
174 	sc->freq = MIN_FM_FREQ;
175 	sc->stereo = TEA5757_STEREO;
176 	sc->lock = TEA5757_S030;
177 
178 	/* remap I/O */
179 	if (bus_space_map(sc->tea.iot, ia->ia_io[0].ir_addr,
180 	    ia->ia_io[0].ir_size, 0, &sc->tea.ioh))
181 		panic("rtiiattach: bus_space_map() failed");
182 
183 	sc->tea.offset = 0;
184 
185 	sc->tea.init = rtii_init;
186 	sc->tea.rset = rtii_rset;
187 	sc->tea.write_bit = rtii_write_bit;
188 	sc->tea.read = rtii_hw_read;
189 
190 	printf(": AIMS Lab Radiotrack II\n");
191 	tea5757_set_freq(&sc->tea, sc->stereo, sc->lock, sc->freq);
192 	rtii_set_mute(sc);
193 
194 	radio_attach_mi(&rtii_hw_if, sc, &sc->dev);
195 }
196 
197 /*
198  * Mute/unmute the card
199  */
200 void
201 rtii_set_mute(struct rtii_softc *sc)
202 {
203 	u_int8_t mute;
204 
205 	mute = (sc->mute || !sc->vol) ? RTII_MUTE : RTII_UNMUTE;
206 	bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
207 	DELAY(6);
208 	bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
209 }
210 
211 void
212 rtii_init(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off, u_int32_t d)
213 {
214 	bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_OFF);
215 	bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_ON);
216 	bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_ON);
217 }
218 
219 void
220 rtii_rset(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off, u_int32_t d)
221 {
222 	bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_OFF);
223 }
224 
225 int
226 rtii_find(bus_space_tag_t iot, bus_space_handle_t ioh)
227 {
228 	struct rtii_softc sc;
229 	u_int32_t freq;
230 
231 	sc.tea.iot = iot;
232 	sc.tea.ioh = ioh;
233 	sc.tea.offset = 0;
234 	sc.tea.init = rtii_init;
235 	sc.tea.rset = rtii_rset;
236 	sc.tea.write_bit = rtii_write_bit;
237 	sc.tea.read = rtii_hw_read;
238 	sc.lock = TEA5757_S030;
239 	sc.stereo = TEA5757_STEREO;
240 
241 	/*
242 	 * Let's try to write and read a frequency.
243 	 * If the written and read frequencies are
244 	 * the same then success.
245 	 */
246 	sc.freq = MIN_FM_FREQ;
247 	tea5757_set_freq(&sc.tea, sc.stereo, sc.lock, sc.freq);
248 	rtii_set_mute(&sc);
249 	freq = rtii_hw_read(iot, ioh, sc.tea.offset);
250 	if (tea5757_decode_freq(freq) == sc.freq)
251 		return 1;
252 
253 	return 0;
254 }
255 
256 void
257 rtii_write_bit(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off, int bit)
258 {
259 	u_int8_t data;
260 
261 	data = bit ? RTII_DATA_ON : RTII_DATA_OFF;
262 
263 	bus_space_write_1(iot, ioh, off, RTII_WREN_ON | RTII_CLCK_OFF | data);
264 	bus_space_write_1(iot, ioh, off, RTII_WREN_ON | RTII_CLCK_ON  | data);
265 	bus_space_write_1(iot, ioh, off, RTII_WREN_ON | RTII_CLCK_OFF | data);
266 }
267 
268 u_int32_t
269 rtii_hw_read(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off)
270 {
271 	u_int8_t i;
272 	u_int32_t res = 0;
273 
274 	bus_space_write_1(iot, ioh, off, RTII_READ_CLOCK_LOW);
275 	DELAY(6);
276 
277 	i = 24;
278 	while ( i-- ) {
279 		bus_space_write_1(iot, ioh, off, RTII_READ_CLOCK_HIGH);
280 		DELAY(6);
281 		bus_space_write_1(iot, ioh, off, RTII_READ_CLOCK_LOW);
282 		res |= bus_space_read_1(iot, ioh, off) & RTII_DATA_ON ? 1 : 0;
283 		DELAY(6);
284 		res <<= 1;
285 	}
286 
287 	return (res & (TEA5757_DATA | TEA5757_FREQ)) >> 1;
288 }
289 
290 int
291 rtii_get_info(void *v, struct radio_info *ri)
292 {
293 	struct rtii_softc *sc = v;
294 
295 	ri->mute = sc->mute;
296 	ri->volume = sc->vol ? 255 : 0;
297 	ri->stereo = sc->stereo == TEA5757_STEREO ? 1 : 0;
298 	ri->caps = RTII_CAPABILITIES;
299 	ri->rfreq = 0;
300 	ri->lock = tea5757_decode_lock(sc->lock);
301 
302 	ri->freq  = sc->freq = tea5757_decode_freq(rtii_hw_read(sc->tea.iot,
303 				sc->tea.ioh, sc->tea.offset));
304 
305 	switch (bus_space_read_1(sc->tea.iot, sc->tea.ioh, 0)) {
306 	case 0xFD:
307 		ri->info = RADIO_INFO_SIGNAL | RADIO_INFO_STEREO;
308 		break;
309 	case 0xFF:
310 		ri->info = 0;
311 		break;
312 	default:
313 		ri->info = RADIO_INFO_SIGNAL;
314 	}
315 
316 	return (0);
317 }
318 
319 int
320 rtii_set_info(void *v, struct radio_info *ri)
321 {
322 	struct rtii_softc *sc = v;
323 
324 	sc->mute = ri->mute ? 1 : 0;
325 	sc->vol = ri->volume ? 255 : 0;
326 	sc->stereo = ri->stereo ? TEA5757_STEREO: TEA5757_MONO;
327 	sc->lock = tea5757_encode_lock(ri->lock);
328 	ri->freq = sc->freq = tea5757_set_freq(&sc->tea,
329 			sc->lock, sc->stereo, ri->freq);
330 	rtii_set_mute(sc);
331 
332 	return (0);
333 }
334 
335 int
336 rtii_search(void *v, int f)
337 {
338 	struct rtii_softc *sc = v;
339 
340 	tea5757_search(&sc->tea, sc->lock, sc->stereo, f);
341 	rtii_set_mute(sc);
342 
343 	return (0);
344 }
345