Home | History | Annotate | Line # | Download | only in isa
sf16fmr2.c revision 1.3
      1 /* $NetBSD: sf16fmr2.c,v 1.3 2002/01/03 18:13:20 augustss 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 (at) oganer.net>,
      7  *                    Vladimir Popov <jumbo (at) 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/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 SF16FMR2_BASE_VALID(x)	(x == 0x384)
     51 #define SF16FMR2_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 #define SF16FMR2_AMPLIFIER	(1 << 7)
     59 #define SF16FMR2_SIGNAL		(1 << 3)
     60 #define SF16FMR2_STEREO		(1 << 3)
     61 
     62 #define SF16FMR2_MUTE		0x00
     63 #define SF16FMR2_UNMUTE		0x04
     64 
     65 #define SF16FMR2_DATA_ON	(1 << 0)
     66 #define SF16FMR2_DATA_OFF	(0 << 0)
     67 
     68 #define SF16FMR2_CLCK_ON	(1 << 1)
     69 #define SF16FMR2_CLCK_OFF	(0 << 1)
     70 
     71 #define SF16FMR2_WREN_ON	(0 << 2)  /* SF16-FMR2 has inverse WREN */
     72 #define SF16FMR2_WREN_OFF	(1 << 2)
     73 
     74 #define SF16FMR2_READ_CLOCK_LOW		\
     75 		SF16FMR2_DATA_ON | SF16FMR2_CLCK_OFF | SF16FMR2_WREN_OFF
     76 
     77 #define SF16FMR2_READ_CLOCK_HIGH	\
     78 		SF16FMR2_DATA_ON | SF16FMR2_CLCK_ON | SF16FMR2_WREN_OFF
     79 
     80 int	sf2r_probe(struct device *, struct cfdata *, void *);
     81 void	sf2r_attach(struct device *, struct device * self, void *);
     82 
     83 int	sf2r_get_info(void *, struct radio_info *);
     84 int	sf2r_set_info(void *, struct radio_info *);
     85 int	sf2r_search(void *, int);
     86 
     87 /* define our interface to the higher level radio driver */
     88 struct radio_hw_if sf2r_hw_if = {
     89 	NULL, /* open */
     90 	NULL, /* close */
     91 	sf2r_get_info,
     92 	sf2r_set_info,
     93 	sf2r_search
     94 };
     95 
     96 struct sf2r_softc {
     97 	struct device	sc_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 sf2r_ca = {
    109 	sizeof(struct sf2r_softc), sf2r_probe, sf2r_attach
    110 };
    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
    122 sf2r_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 = ia->ia_iobase;
    129 
    130 	if (!SF16FMR2_BASE_VALID(iobase)) {
    131 		printf("sf2r: configured iobase 0x%x invalid\n", iobase);
    132 		return 0;
    133 	}
    134 
    135 	if (bus_space_map(iot, iobase, iosize, 0, &ioh))
    136 		return 0;
    137 
    138 	r = sf2r_find(iot, ioh);
    139 
    140 	bus_space_unmap(iot, ioh, iosize);
    141 
    142 	ia->ia_iosize = iosize;
    143 
    144 	return (r != 0);
    145 }
    146 
    147 void
    148 sf2r_attach(struct device *parent, struct device *self, void *aux)
    149 {
    150 	struct sf2r_softc *sc = (void *) self;
    151 	struct isa_attach_args *ia = aux;
    152 
    153 	sc->tea.iot = ia->ia_iot;
    154 	sc->mute = 0;
    155 	sc->vol = 0;
    156 	sc->freq = MIN_FM_FREQ;
    157 	sc->stereo = TEA5757_STEREO;
    158 	sc->lock = TEA5757_S030;
    159 
    160 	/* remap I/O */
    161 	if (bus_space_map(sc->tea.iot, ia->ia_iobase, ia->ia_iosize,
    162 			  0, &sc->tea.ioh))
    163 		panic("sf2rattach: bus_space_map() failed");
    164 
    165 	sc->tea.offset = 0;
    166 
    167 	sc->tea.init = sf2r_init;
    168 	sc->tea.rset = sf2r_rset;
    169 	sc->tea.write_bit = sf2r_write_bit;
    170 	sc->tea.read = sf2r_read_register;
    171 
    172 	printf(": SoundForte RadioLink SF16-FMR2\n");
    173 	tea5757_set_freq(&sc->tea, sc->stereo, sc->lock, sc->freq);
    174 	sf2r_set_mute(sc);
    175 
    176 	radio_attach_mi(&sf2r_hw_if, sc, &sc->sc_dev);
    177 }
    178 
    179 /*
    180  * Mute/unmute the card
    181  */
    182 void
    183 sf2r_set_mute(struct sf2r_softc *sc)
    184 {
    185 	u_int8_t mute;
    186 
    187 	mute = (sc->mute || !sc->vol) ? SF16FMR2_MUTE : SF16FMR2_UNMUTE;
    188 	bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
    189 	DELAY(64);
    190 	bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
    191 }
    192 
    193 void
    194 sf2r_init(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off, u_int32_t d)
    195 {
    196 	bus_space_write_1(iot, ioh, off, SF16FMR2_MUTE);
    197 }
    198 
    199 void
    200 sf2r_rset(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off, u_int32_t d)
    201 {
    202 	bus_space_write_1(iot, ioh, off, SF16FMR2_MUTE);
    203 	bus_space_write_1(iot, ioh, off, SF16FMR2_UNMUTE);
    204 }
    205 
    206 int
    207 sf2r_find(bus_space_tag_t iot, bus_space_handle_t ioh)
    208 {
    209 	struct sf2r_softc sc;
    210 	u_int32_t freq;
    211 
    212 	sc.tea.iot = iot;
    213 	sc.tea.ioh = ioh;
    214 	sc.tea.offset = 0;
    215 	sc.tea.init = sf2r_init;
    216 	sc.tea.rset = sf2r_rset;
    217 	sc.tea.write_bit = sf2r_write_bit;
    218 	sc.tea.read = sf2r_read_register;
    219 	sc.lock = TEA5757_S030;
    220 	sc.stereo = TEA5757_STEREO;
    221 
    222 	if ((bus_space_read_1(iot, ioh, 0) & 0x70) == 0x30) {
    223 		/*
    224 		 * Let's try to write and read a frequency.
    225 		 * If the written and read frequencies are
    226 		 * the same then success.
    227 		 */
    228 		sc.freq = MIN_FM_FREQ;
    229 		tea5757_set_freq(&sc.tea, sc.stereo, sc.lock, sc.freq);
    230 		sf2r_set_mute(&sc);
    231 		freq = sf2r_read_register(iot, ioh, sc.tea.offset);
    232 		if (tea5757_decode_freq(freq) == sc.freq)
    233 			return 1;
    234 	}
    235 
    236 	return 0;
    237 }
    238 
    239 void
    240 sf2r_write_bit(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off, int bit)
    241 {
    242 	u_int8_t data;
    243 
    244 	data = bit ? SF16FMR2_DATA_ON : SF16FMR2_DATA_OFF;
    245 
    246 	bus_space_write_1(iot, ioh, off,
    247 			SF16FMR2_WREN_ON | SF16FMR2_CLCK_OFF | data);
    248 	bus_space_write_1(iot, ioh, off,
    249 			SF16FMR2_WREN_ON | SF16FMR2_CLCK_ON  | data);
    250 	bus_space_write_1(iot, ioh, off,
    251 			SF16FMR2_WREN_ON | SF16FMR2_CLCK_OFF | data);
    252 }
    253 
    254 u_int32_t
    255 sf2r_read_register(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off)
    256 {
    257 	u_int32_t res = 0;
    258 	u_int8_t i, state = 0;
    259 
    260 	bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_LOW);
    261 	DELAY(6);
    262 	bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_HIGH);
    263 
    264 	i = bus_space_read_1(iot, ioh, off);
    265 	DELAY(6);
    266 	/* Amplifier: 0 - not present, 1 - present */
    267 	state = i & SF16FMR2_AMPLIFIER ? (1 << 2) : (0 << 2);
    268 	/* Signal: 0 - not tuned, 1 - tuned */
    269 	state |= i & SF16FMR2_SIGNAL   ? (0 << 1) : (1 << 1);
    270 
    271 	bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_LOW);
    272 	i = bus_space_read_1(iot, ioh, off);
    273 	/* Stereo: 0 - mono, 1 - stereo */
    274 	state |= i & SF16FMR2_STEREO   ? (0 << 0) : (1 << 0);
    275 	res = i & SF16FMR2_DATA_ON;
    276 
    277 	i = 23;
    278 	while ( i-- ) {
    279 		DELAY(6);
    280 		res <<= 1;
    281 		bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_HIGH);
    282 		DELAY(6);
    283 		bus_space_write_1(iot, ioh, off, SF16FMR2_READ_CLOCK_LOW);
    284 		res |= bus_space_read_1(iot, ioh, off) & SF16FMR2_DATA_ON;
    285 	}
    286 
    287 	return res | (state << 24);
    288 }
    289 
    290 int
    291 sf2r_get_info(void *v, struct radio_info *ri)
    292 {
    293 	struct sf2r_softc *sc = v;
    294 	u_int32_t buf;
    295 
    296 	ri->mute = sc->mute;
    297 	ri->volume = sc->vol ? 255 : 0;
    298 	ri->stereo = sc->stereo == TEA5757_STEREO ? 1 : 0;
    299 	ri->caps = SF16FMR2_CAPABILITIES;
    300 	ri->rfreq = 0;
    301 	ri->lock = tea5757_decode_lock(sc->lock);
    302 
    303 	buf = sf2r_read_register(sc->tea.iot, sc->tea.ioh, sc->tea.offset);
    304 	ri->freq  = sc->freq = tea5757_decode_freq(buf);
    305 	ri->info = 3 & (buf >> 24);
    306 
    307 	return (0);
    308 }
    309 
    310 int
    311 sf2r_set_info(void *v, struct radio_info *ri)
    312 {
    313 	struct sf2r_softc *sc = v;
    314 
    315 	sc->mute = ri->mute ? 1 : 0;
    316 	sc->vol = ri->volume ? 255 : 0;
    317 	sc->stereo = ri->stereo ? TEA5757_STEREO: TEA5757_MONO;
    318 	sc->lock = tea5757_encode_lock(ri->lock);
    319 	ri->freq = sc->freq = tea5757_set_freq(&sc->tea,
    320 			sc->lock, sc->stereo, ri->freq);
    321 	sf2r_set_mute(sc);
    322 
    323 	return (0);
    324 }
    325 
    326 int
    327 sf2r_search(void *v, int f)
    328 {
    329 	struct sf2r_softc *sc = v;
    330 
    331 	tea5757_search(&sc->tea, sc->lock, sc->stereo, f);
    332 	sf2r_set_mute(sc);
    333 
    334 	return (0);
    335 }
    336