sys/dev/isa/radiotrack2.c

   1 /* $NetBSD: radiotrack2.c,v 1.14 2009/05/12 08:44:19 cegger 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.14 2009/05/12 08:44:19 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 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(device_t, cfdata_t, void *);
  84 void    rtii_attach(device_t, device_t  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(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 (!RTII_BASE_VALID(iobase)) {
 141                 printf("rtii: 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 = rtii_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 rtii_attach(device_t parent, device_t self, void *aux)
 168 {
 169         struct rtii_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("rtiiattach: bus_space_map() failed");
 184
 185         sc->tea.offset = 0;
 186
 187         sc->tea.init = rtii_init;
 188         sc->tea.rset = rtii_rset;
 189         sc->tea.write_bit = rtii_write_bit;
 190         sc->tea.read = rtii_hw_read;
 191
 192         printf(": AIMS Lab Radiotrack II\n");
 193         tea5757_set_freq(&sc->tea, sc->stereo, sc->lock, sc->freq);
 194         rtii_set_mute(sc);
 195
 196         radio_attach_mi(&rtii_hw_if, sc, &sc->dev);
 197 }
 198
 199 /*
 200  * Mute/unmute the card
 201  */
 202 void
 203 rtii_set_mute(struct rtii_softc *sc)
 204 {
 205         u_int8_t mute;
 206
 207         mute = (sc->mute || !sc->vol) ? RTII_MUTE : RTII_UNMUTE;
 208         bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
 209         DELAY(6);
 210         bus_space_write_1(sc->tea.iot, sc->tea.ioh, 0, mute);
 211 }
 212
 213 void
 214 rtii_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, RTII_RESET | RTII_WREN_OFF);
 218         bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_ON);
 219         bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_ON);
 220 }
 221
 222 void
 223 rtii_rset(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off,
 224     u_int32_t d)
 225 {
 226         bus_space_write_1(iot, ioh, off, RTII_RESET | RTII_WREN_OFF);
 227 }
 228
 229 int
 230 rtii_find(bus_space_tag_t iot, bus_space_handle_t ioh)
 231 {
 232         struct rtii_softc sc;
 233         u_int32_t freq;
 234
 235         sc.tea.iot = iot;
 236         sc.tea.ioh = ioh;
 237         sc.tea.offset = 0;
 238         sc.tea.init = rtii_init;
 239         sc.tea.rset = rtii_rset;
 240         sc.tea.write_bit = rtii_write_bit;
 241         sc.tea.read = rtii_hw_read;
 242         sc.lock = TEA5757_S030;
 243         sc.stereo = TEA5757_STEREO;
 244
 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         rtii_set_mute(&sc);
 253         freq = rtii_hw_read(iot, ioh, sc.tea.offset);
 254         if (tea5757_decode_freq(freq, 0) == sc.freq)
 255                 return 1;
 256
 257         return 0;
 258 }
 259
 260 void
 261 rtii_write_bit(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off, int bit)
 262 {
 263         u_int8_t data;
 264
 265         data = bit ? RTII_DATA_ON : RTII_DATA_OFF;
 266
 267         bus_space_write_1(iot, ioh, off, RTII_WREN_ON | RTII_CLCK_OFF | data);
 268         bus_space_write_1(iot, ioh, off, RTII_WREN_ON | RTII_CLCK_ON  | data);
 269         bus_space_write_1(iot, ioh, off, RTII_WREN_ON | RTII_CLCK_OFF | data);
 270 }
 271
 272 u_int32_t
 273 rtii_hw_read(bus_space_tag_t iot, bus_space_handle_t ioh, bus_size_t off)
 274 {
 275         u_int8_t i;
 276         u_int32_t res = 0;
 277
 278         bus_space_write_1(iot, ioh, off, RTII_READ_CLOCK_LOW);
 279         DELAY(6);
 280
 281         i = 24;
 282         while ( i-- ) {
 283                 bus_space_write_1(iot, ioh, off, RTII_READ_CLOCK_HIGH);
 284                 DELAY(6);
 285                 bus_space_write_1(iot, ioh, off, RTII_READ_CLOCK_LOW);
 286                 res |= bus_space_read_1(iot, ioh, off) & RTII_DATA_ON ? 1 : 0;
 287                 DELAY(6);
 288                 res <<= 1;
 289         }
 290
 291         return (res & (TEA5757_DATA | TEA5757_FREQ)) >> 1;
 292 }
 293
 294 int
 295 rtii_get_info(void *v, struct radio_info *ri)
 296 {
 297         struct rtii_softc *sc = v;
 298
 299         ri->mute = sc->mute;
 300         ri->volume = sc->vol ? 255 : 0;
 301         ri->stereo = sc->stereo == TEA5757_STEREO ? 1 : 0;
 302         ri->caps = RTII_CAPABILITIES;
 303         ri->rfreq = 0;
 304         ri->lock = tea5757_decode_lock(sc->lock);
 305
 306         ri->freq  = sc->freq = tea5757_decode_freq(rtii_hw_read(sc->tea.iot,
 307                                 sc->tea.ioh, sc->tea.offset), 0);
 308
 309         switch (bus_space_read_1(sc->tea.iot, sc->tea.ioh, 0)) {
 310         case 0xFD:
 311                 ri->info = RADIO_INFO_SIGNAL | RADIO_INFO_STEREO;
 312                 break;
 313         case 0xFF:
 314                 ri->info = 0;
 315                 break;
 316         default:
 317                 ri->info = RADIO_INFO_SIGNAL;
 318         }
 319
 320         return (0);
 321 }
 322
 323 int
 324 rtii_set_info(void *v, struct radio_info *ri)
 325 {
 326         struct rtii_softc *sc = v;
 327
 328         sc->mute = ri->mute ? 1 : 0;
 329         sc->vol = ri->volume ? 255 : 0;
 330         sc->stereo = ri->stereo ? TEA5757_STEREO: TEA5757_MONO;
 331         sc->lock = tea5757_encode_lock(ri->lock);
 332         ri->freq = sc->freq = tea5757_set_freq(&sc->tea,
 333                         sc->lock, sc->stereo, ri->freq);
 334         rtii_set_mute(sc);
 335
 336         return (0);
 337 }
 338
 339 int
 340 rtii_search(void *v, int f)
 341 {
 342         struct rtii_softc *sc = v;
 343
 344         tea5757_search(&sc->tea, sc->lock, sc->stereo, f);
 345         rtii_set_mute(sc);
 346
 347         return (0);
 348 }