xref: /netbsd-src/sys/dev/isa/sf16fmr2.c (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /* $NetBSD: sf16fmr2.c,v 1.15 2009/05/12 09:10:16 cegger Exp $ */
2 /* $OpenBSD: sf16fmr2.c,v 1.3 2001/12/18 18:48:08 mickey Exp $ */
3 /* $RuOBSD: sf16fmr2.c,v 1.12 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 /* SoundForte RadioLink SF16-FMR2 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: sf16fmr2.c,v 1.15 2009/05/12 09:10:16 cegger 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 SF16FMR2_BASE_VALID(x)	(x == 0x384)
54 #define SF16FMR2_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 #define SF16FMR2_AMPLIFIER	(1 << 7)
62 #define SF16FMR2_SIGNAL		(1 << 3)
63 #define SF16FMR2_STEREO		(1 << 3)
64 
65 #define SF16FMR2_MUTE		0x00
66 #define SF16FMR2_UNMUTE		0x04
67 
68 #define SF16FMR2_DATA_ON	(1 << 0)
69 #define SF16FMR2_DATA_OFF	(0 << 0)
70 
71 #define SF16FMR2_CLCK_ON	(1 << 1)
72 #define SF16FMR2_CLCK_OFF	(0 << 1)
73 
74 #define SF16FMR2_WREN_ON	(0 << 2)  /* SF16-FMR2 has inverse WREN */
75 #define SF16FMR2_WREN_OFF	(1 << 2)
76 
77 #define SF16FMR2_READ_CLOCK_LOW		\
78 		SF16FMR2_DATA_ON | SF16FMR2_CLCK_OFF | SF16FMR2_WREN_OFF
79 
80 #define SF16FMR2_READ_CLOCK_HIGH	\
81 		SF16FMR2_DATA_ON | SF16FMR2_CLCK_ON | SF16FMR2_WREN_OFF
82 
83 int	sf2r_probe(device_t, cfdata_t, void *);
84 void	sf2r_attach(device_t, device_t  self, void *);
85 
86 int	sf2r_get_info(void *, struct radio_info *);
87 int	sf2r_set_info(void *, struct radio_info *);
88 int	sf2r_search(void *, int);
89 
90 /* define our interface to the higher level radio driver */
91 const struct radio_hw_if sf2r_hw_if = {
92 	NULL, /* open */
93 	NULL, /* close */
94 	sf2r_get_info,
95 	sf2r_set_info,
96 	sf2r_search
97 };
98 
99 struct sf2r_softc {
100 	struct device	sc_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(sf2r, sizeof(struct sf2r_softc),
112     sf2r_probe, sf2r_attach, NULL, NULL);
113 
114 void	sf2r_set_mute(struct sf2r_softc *);
115 int	sf2r_find(bus_space_tag_t, bus_space_handle_t);
116 
117 u_int32_t	sf2r_read_register(bus_space_tag_t, bus_space_handle_t, bus_size_t);
118 
119 void	sf2r_init(bus_space_tag_t, bus_space_handle_t, bus_size_t, u_int32_t);
120 void	sf2r_rset(bus_space_tag_t, bus_space_handle_t, bus_size_t, u_int32_t);
121 void	sf2r_write_bit(bus_space_tag_t, bus_space_handle_t, bus_size_t, int);
122 
123 int
124 sf2r_probe(device_t parent, cfdata_t cf, void *aux)
125 {
126 	struct isa_attach_args *ia = aux;
127 	bus_space_tag_t iot = ia->ia_iot;
128 	bus_space_handle_t ioh;
129 	u_int r;
130 	int iosize = 1, iobase;
131 
132 	if (ISA_DIRECT_CONFIG(ia))
133 		return 0;
134 
135 	if (ia->ia_nio < 1)
136 		return 0;
137 
138 	iobase = ia->ia_io[0].ir_addr;
139 
140 	if (!SF16FMR2_BASE_VALID(iobase)) {
141 		printf("sf2r: configured iobase 0x%x invalid\n", iobase);
142 		return 0;
143 	}
144 
145 	if (bus_space_map(iot, iobase, iosize, 0, &ioh))
146 		return 0;
147 
148 	r = sf2r_find(iot, ioh);
149 
150 	bus_space_unmap(iot, ioh, iosize);
151 
152 	if (r != 0) {
153 		ia->ia_nio = 1;
154 		ia->ia_io[0].ir_size = iosize;
155 
156 		ia->ia_niomem = 0;
157 		ia->ia_nirq = 0;
158 		ia->ia_ndrq = 0;
159 
160 		return (1);
161 	}
162 
163 	return (0);
164 }
165 
166 void
167 sf2r_attach(device_t parent, device_t self, void *aux)
168 {
169 	struct sf2r_softc *sc = (void *) self;
170 	struct isa_attach_args *ia = aux;
171 
172 	sc->tea.iot = ia->ia_iot;
173 	sc->tea.flags = 0;
174 	sc->mute = 0;
175 	sc->vol = 0;
176 	sc->freq = MIN_FM_FREQ;
177 	sc->stereo = TEA5757_STEREO;
178 	sc->lock = TEA5757_S030;
179 
180 	/* remap I/O */
181 	if (bus_space_map(sc->tea.iot, ia->ia_io[0].ir_addr,
182 	    ia->ia_io[0].ir_size, 0, &sc->tea.ioh))
183 		panic("sf2rattach: bus_space_map() failed");
184 
185 	sc->tea.offset = 0;
186 
187 	sc->tea.init = sf2r_init;
188 	sc->tea.rset = sf2r_rset;
189 	sc->tea.write_bit = sf2r_write_bit;
190 	sc->tea.read = sf2r_read_register;
191 
192 	printf(": SoundForte RadioLink SF16-FMR2\n");
193 	tea5757_set_freq(&sc->tea, sc->stereo, sc->lock, sc->freq);
194 	sf2r_set_mute(sc);
195 
196 	radio_attach_mi(&sf2r_hw_if, sc, &sc->sc_dev);
197 }
198 
199 /*
200  * Mute/unmute the card
201  */
202 void
203 sf2r_set_mute(struct sf2r_softc *sc)
204 {
205 	u_int8_t mute;
206 
207 	mute = (sc->mute || !sc->vol) ? SF16FMR2_MUTE : SF16FMR2_UNMUTE;
208 	bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
209 	DELAY(64);
210 	bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
211 }
212 
213 void
214 sf2r_init(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off,
215     u_int32_t d)
216 {
217 	bus_space_write_1(iot, ioh, off, SF16FMR2_MUTE);
218 }
219 
220 void
221 sf2r_rset(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off,
222     u_int32_t d)
223 {
224 	bus_space_write_1(iot, ioh, off, SF16FMR2_MUTE);
225 	bus_space_write_1(iot, ioh, off, SF16FMR2_UNMUTE);
226 }
227 
228 int
229 sf2r_find(bus_space_tag_t iot, bus_space_handle_t ioh)
230 {
231 	struct sf2r_softc sc;
232 	u_int32_t freq;
233 
234 	sc.tea.iot = iot;
235 	sc.tea.ioh = ioh;
236 	sc.tea.offset = 0;
237 	sc.tea.init = sf2r_init;
238 	sc.tea.rset = sf2r_rset;
239 	sc.tea.write_bit = sf2r_write_bit;
240 	sc.tea.read = sf2r_read_register;
241 	sc.lock = TEA5757_S030;
242 	sc.stereo = TEA5757_STEREO;
243 
244 	if ((bus_space_read_1(iot, ioh, 0) & 0x70) == 0x30) {
245 		/*
246 		 * Let's try to write and read a frequency.
247 		 * If the written and read frequencies are
248 		 * the same then success.
249 		 */
250 		sc.freq = MIN_FM_FREQ;
251 		tea5757_set_freq(&sc.tea, sc.stereo, sc.lock, sc.freq);
252 		sf2r_set_mute(&sc);
253 		freq = sf2r_read_register(iot, ioh, sc.tea.offset);
254 		if (tea5757_decode_freq(freq, 0) == sc.freq)
255 			return 1;
256 	}
257 
258 	return 0;
259 }
260 
261 void
262 sf2r_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 ? SF16FMR2_DATA_ON : SF16FMR2_DATA_OFF;
267 
268 	bus_space_write_1(iot, ioh, off,
269 			SF16FMR2_WREN_ON | SF16FMR2_CLCK_OFF | data);
270 	bus_space_write_1(iot, ioh, off,
271 			SF16FMR2_WREN_ON | SF16FMR2_CLCK_ON  | data);
272 	bus_space_write_1(iot, ioh, off,
273 			SF16FMR2_WREN_ON | SF16FMR2_CLCK_OFF | data);
274 }
275 
276 u_int32_t
277 sf2r_read_register(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off)
278 {
279 	u_int32_t res = 0;
280 	u_int8_t i, state = 0;
281 
282 	bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_LOW);
283 	DELAY(6);
284 	bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_HIGH);
285 
286 	i = bus_space_read_1(iot, ioh, off);
287 	DELAY(6);
288 	/* Amplifier: 0 - not present, 1 - present */
289 	state = i & SF16FMR2_AMPLIFIER ? (1 << 2) : (0 << 2);
290 	/* Signal: 0 - not tuned, 1 - tuned */
291 	state |= i & SF16FMR2_SIGNAL   ? (0 << 1) : (1 << 1);
292 
293 	bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_LOW);
294 	i = bus_space_read_1(iot, ioh, off);
295 	/* Stereo: 0 - mono, 1 - stereo */
296 	state |= i & SF16FMR2_STEREO   ? (0 << 0) : (1 << 0);
297 	res = i & SF16FMR2_DATA_ON;
298 
299 	i = 23;
300 	while ( i-- ) {
301 		DELAY(6);
302 		res <<= 1;
303 		bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_HIGH);
304 		DELAY(6);
305 		bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_LOW);
306 		res |= bus_space_read_1(iot, ioh, off) & SF16FMR2_DATA_ON;
307 	}
308 
309 	return res | (state << 24);
310 }
311 
312 int
313 sf2r_get_info(void *v, struct radio_info *ri)
314 {
315 	struct sf2r_softc *sc = v;
316 	u_int32_t buf;
317 
318 	ri->mute = sc->mute;
319 	ri->volume = sc->vol ? 255 : 0;
320 	ri->stereo = sc->stereo == TEA5757_STEREO ? 1 : 0;
321 	ri->caps = SF16FMR2_CAPABILITIES;
322 	ri->rfreq = 0;
323 	ri->lock = tea5757_decode_lock(sc->lock);
324 
325 	buf = sf2r_read_register(sc->tea.iot, sc->tea.ioh, sc->tea.offset);
326 	ri->freq  = sc->freq = tea5757_decode_freq(buf, 0);
327 	ri->info = 3 & (buf >> 24);
328 
329 	return (0);
330 }
331 
332 int
333 sf2r_set_info(void *v, struct radio_info *ri)
334 {
335 	struct sf2r_softc *sc = v;
336 
337 	sc->mute = ri->mute ? 1 : 0;
338 	sc->vol = ri->volume ? 255 : 0;
339 	sc->stereo = ri->stereo ? TEA5757_STEREO: TEA5757_MONO;
340 	sc->lock = tea5757_encode_lock(ri->lock);
341 	ri->freq = sc->freq = tea5757_set_freq(&sc->tea,
342 			sc->lock, sc->stereo, ri->freq);
343 	sf2r_set_mute(sc);
344 
345 	return (0);
346 }
347 
348 int
349 sf2r_search(void *v, int f)
350 {
351 	struct sf2r_softc *sc = v;
352 
353 	tea5757_search(&sc->tea, sc->lock, sc->stereo, f);
354 	sf2r_set_mute(sc);
355 
356 	return (0);
357 }
358