1 /* $NetBSD: sf16fmr2.c,v 1.16 2012/10/27 17:18:25 chs 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.16 2012/10/27 17:18:25 chs 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 u_int32_t freq;
101 u_int32_t stereo;
102 u_int32_t lock;
103 u_int8_t vol;
104 int mute;
105
106 struct tea5757_t tea;
107 };
108
109 CFATTACH_DECL_NEW(sf2r, sizeof(struct sf2r_softc),
110 sf2r_probe, sf2r_attach, NULL, NULL);
111
112 void sf2r_set_mute(struct sf2r_softc *);
113 int sf2r_find(bus_space_tag_t, bus_space_handle_t);
114
115 u_int32_t sf2r_read_register(bus_space_tag_t, bus_space_handle_t, bus_size_t);
116
117 void sf2r_init(bus_space_tag_t, bus_space_handle_t, bus_size_t, u_int32_t);
118 void sf2r_rset(bus_space_tag_t, bus_space_handle_t, bus_size_t, u_int32_t);
119 void sf2r_write_bit(bus_space_tag_t, bus_space_handle_t, bus_size_t, int);
120
121 int
sf2r_probe(device_t parent,cfdata_t cf,void * aux)122 sf2r_probe(device_t parent, cfdata_t 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 (!SF16FMR2_BASE_VALID(iobase)) {
139 printf("sf2r: 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 = sf2r_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
sf2r_attach(device_t parent,device_t self,void * aux)165 sf2r_attach(device_t parent, device_t self, void *aux)
166 {
167 struct sf2r_softc *sc = device_private(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("sf2rattach: bus_space_map() failed");
182
183 sc->tea.offset = 0;
184
185 sc->tea.init = sf2r_init;
186 sc->tea.rset = sf2r_rset;
187 sc->tea.write_bit = sf2r_write_bit;
188 sc->tea.read = sf2r_read_register;
189
190 printf(": SoundForte RadioLink SF16-FMR2\n");
191 tea5757_set_freq(&sc->tea, sc->stereo, sc->lock, sc->freq);
192 sf2r_set_mute(sc);
193
194 radio_attach_mi(&sf2r_hw_if, sc, self);
195 }
196
197 /*
198 * Mute/unmute the card
199 */
200 void
sf2r_set_mute(struct sf2r_softc * sc)201 sf2r_set_mute(struct sf2r_softc *sc)
202 {
203 u_int8_t mute;
204
205 mute = (sc->mute || !sc->vol) ? SF16FMR2_MUTE : SF16FMR2_UNMUTE;
206 bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
207 DELAY(64);
208 bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
209 }
210
211 void
sf2r_init(bus_space_tag_t iot,bus_space_handle_t ioh,bus_size_t off,u_int32_t d)212 sf2r_init(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off,
213 u_int32_t d)
214 {
215 bus_space_write_1(iot, ioh, off, SF16FMR2_MUTE);
216 }
217
218 void
sf2r_rset(bus_space_tag_t iot,bus_space_handle_t ioh,bus_size_t off,u_int32_t d)219 sf2r_rset(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off,
220 u_int32_t d)
221 {
222 bus_space_write_1(iot, ioh, off, SF16FMR2_MUTE);
223 bus_space_write_1(iot, ioh, off, SF16FMR2_UNMUTE);
224 }
225
226 int
sf2r_find(bus_space_tag_t iot,bus_space_handle_t ioh)227 sf2r_find(bus_space_tag_t iot, bus_space_handle_t ioh)
228 {
229 struct sf2r_softc sc;
230 u_int32_t freq;
231
232 sc.tea.iot = iot;
233 sc.tea.ioh = ioh;
234 sc.tea.offset = 0;
235 sc.tea.init = sf2r_init;
236 sc.tea.rset = sf2r_rset;
237 sc.tea.write_bit = sf2r_write_bit;
238 sc.tea.read = sf2r_read_register;
239 sc.lock = TEA5757_S030;
240 sc.stereo = TEA5757_STEREO;
241
242 if ((bus_space_read_1(iot, ioh, 0) & 0x70) == 0x30) {
243 /*
244 * Let's try to write and read a frequency.
245 * If the written and read frequencies are
246 * the same then success.
247 */
248 sc.freq = MIN_FM_FREQ;
249 tea5757_set_freq(&sc.tea, sc.stereo, sc.lock, sc.freq);
250 sf2r_set_mute(&sc);
251 freq = sf2r_read_register(iot, ioh, sc.tea.offset);
252 if (tea5757_decode_freq(freq, 0) == sc.freq)
253 return 1;
254 }
255
256 return 0;
257 }
258
259 void
sf2r_write_bit(bus_space_tag_t iot,bus_space_handle_t ioh,bus_size_t off,int bit)260 sf2r_write_bit(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off, int bit)
261 {
262 u_int8_t data;
263
264 data = bit ? SF16FMR2_DATA_ON : SF16FMR2_DATA_OFF;
265
266 bus_space_write_1(iot, ioh, off,
267 SF16FMR2_WREN_ON | SF16FMR2_CLCK_OFF | data);
268 bus_space_write_1(iot, ioh, off,
269 SF16FMR2_WREN_ON | SF16FMR2_CLCK_ON | data);
270 bus_space_write_1(iot, ioh, off,
271 SF16FMR2_WREN_ON | SF16FMR2_CLCK_OFF | data);
272 }
273
274 u_int32_t
sf2r_read_register(bus_space_tag_t iot,bus_space_handle_t ioh,bus_size_t off)275 sf2r_read_register(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off)
276 {
277 u_int32_t res = 0;
278 u_int8_t i, state = 0;
279
280 bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_LOW);
281 DELAY(6);
282 bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_HIGH);
283
284 i = bus_space_read_1(iot, ioh, off);
285 DELAY(6);
286 /* Amplifier: 0 - not present, 1 - present */
287 state = i & SF16FMR2_AMPLIFIER ? (1 << 2) : (0 << 2);
288 /* Signal: 0 - not tuned, 1 - tuned */
289 state |= i & SF16FMR2_SIGNAL ? (0 << 1) : (1 << 1);
290
291 bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_LOW);
292 i = bus_space_read_1(iot, ioh, off);
293 /* Stereo: 0 - mono, 1 - stereo */
294 state |= i & SF16FMR2_STEREO ? (0 << 0) : (1 << 0);
295 res = i & SF16FMR2_DATA_ON;
296
297 i = 23;
298 while ( i-- ) {
299 DELAY(6);
300 res <<= 1;
301 bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_HIGH);
302 DELAY(6);
303 bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_LOW);
304 res |= bus_space_read_1(iot, ioh, off) & SF16FMR2_DATA_ON;
305 }
306
307 return res | (state << 24);
308 }
309
310 int
sf2r_get_info(void * v,struct radio_info * ri)311 sf2r_get_info(void *v, struct radio_info *ri)
312 {
313 struct sf2r_softc *sc = v;
314 u_int32_t buf;
315
316 ri->mute = sc->mute;
317 ri->volume = sc->vol ? 255 : 0;
318 ri->stereo = sc->stereo == TEA5757_STEREO ? 1 : 0;
319 ri->caps = SF16FMR2_CAPABILITIES;
320 ri->rfreq = 0;
321 ri->lock = tea5757_decode_lock(sc->lock);
322
323 buf = sf2r_read_register(sc->tea.iot, sc->tea.ioh, sc->tea.offset);
324 ri->freq = sc->freq = tea5757_decode_freq(buf, 0);
325 ri->info = 3 & (buf >> 24);
326
327 return (0);
328 }
329
330 int
sf2r_set_info(void * v,struct radio_info * ri)331 sf2r_set_info(void *v, struct radio_info *ri)
332 {
333 struct sf2r_softc *sc = v;
334
335 sc->mute = ri->mute ? 1 : 0;
336 sc->vol = ri->volume ? 255 : 0;
337 sc->stereo = ri->stereo ? TEA5757_STEREO: TEA5757_MONO;
338 sc->lock = tea5757_encode_lock(ri->lock);
339 ri->freq = sc->freq = tea5757_set_freq(&sc->tea,
340 sc->lock, sc->stereo, ri->freq);
341 sf2r_set_mute(sc);
342
343 return (0);
344 }
345
346 int
sf2r_search(void * v,int f)347 sf2r_search(void *v, int f)
348 {
349 struct sf2r_softc *sc = v;
350
351 tea5757_search(&sc->tea, sc->lock, sc->stereo, f);
352 sf2r_set_mute(sc);
353
354 return (0);
355 }
356