kernel/drivers/media/radio/radio-aimslab.c

   1 /*
   2  * AimsLab RadioTrack (aka RadioVeveal) driver
   3  *
   4  * Copyright 1997 M. Kirkwood
   5  *
   6  * Converted to the radio-isa framework by Hans Verkuil <hans.verkuil@cisco.com>
   7  * Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@infradead.org>
   8  * Converted to new API by Alan Cox <alan@lxorguk.ukuu.org.uk>
   9  * Various bugfixes and enhancements by Russell Kroll <rkroll@exploits.org>
  10  *
  11  * Notes on the hardware (reverse engineered from other peoples'
  12  * reverse engineering of AIMS' code :-)
  13  *
  14  *  Frequency control is done digitally -- ie out(port,encodefreq(95.8));
  15  *
  16  *  The signal strength query is unsurprisingly inaccurate.  And it seems
  17  *  to indicate that (on my card, at least) the frequency setting isn't
  18  *  too great.  (I have to tune up .025MHz from what the freq should be
  19  *  to get a report that the thing is tuned.)
  20  *
  21  *  Volume control is (ugh) analogue:
  22  *   out(port, start_increasing_volume);
  23  *   wait(a_wee_while);
  24  *   out(port, stop_changing_the_volume);
  25  *
  26  * Fully tested with the Keene USB FM Transmitter and the v4l2-compliance tool.
  27  */
  28
  29 #include <linux/module.h>       /* Modules                      */
  30 #include <linux/init.h>         /* Initdata                     */
  31 #include <linux/ioport.h>       /* request_region               */
  32 #include <linux/delay.h>        /* msleep                       */
  33 #include <linux/videodev2.h>    /* kernel radio structs         */
  34 #include <linux/io.h>           /* outb, outb_p                 */
  35 #include <linux/slab.h>
  36 #include <media/v4l2-device.h>
  37 #include <media/v4l2-ioctl.h>
  38 #include <media/v4l2-ctrls.h>
  39 #include "radio-isa.h"
  40 #include "lm7000.h"
  41
  42 MODULE_AUTHOR("M. Kirkwood");
  43 MODULE_DESCRIPTION("A driver for the RadioTrack/RadioReveal radio card.");
  44 MODULE_LICENSE("GPL");
  45 MODULE_VERSION("1.0.0");
  46
  47 #ifndef CONFIG_RADIO_RTRACK_PORT
  48 #define CONFIG_RADIO_RTRACK_PORT -1
  49 #endif
  50
  51 #define RTRACK_MAX 2
  52
  53 static int io[RTRACK_MAX] = { [0] = CONFIG_RADIO_RTRACK_PORT,
  54                               [1 ... (RTRACK_MAX - 1)] = -1 };
  55 static int radio_nr[RTRACK_MAX] = { [0 ... (RTRACK_MAX - 1)] = -1 };
  56
  57 module_param_array(io, int, NULL, 0444);
  58 MODULE_PARM_DESC(io, "I/O addresses of the RadioTrack card (0x20f or 0x30f)");
  59 module_param_array(radio_nr, int, NULL, 0444);
  60 MODULE_PARM_DESC(radio_nr, "Radio device numbers");
  61
  62 struct rtrack {
  63         struct radio_isa_card isa;
  64         int curvol;
  65 };
  66
  67 static struct radio_isa_card *rtrack_alloc(void)
  68 {
  69         struct rtrack *rt = kzalloc(sizeof(struct rtrack), GFP_KERNEL);
  70
  71         if (rt)
  72                 rt->curvol = 0xff;
  73         return rt ? &rt->isa : NULL;
  74 }
  75
  76 #define AIMS_BIT_TUN_CE         (1 << 0)
  77 #define AIMS_BIT_TUN_CLK        (1 << 1)
  78 #define AIMS_BIT_TUN_DATA       (1 << 2)
  79 #define AIMS_BIT_VOL_CE         (1 << 3)
  80 #define AIMS_BIT_TUN_STRQ       (1 << 4)
  81 /* bit 5 is not connected */
  82 #define AIMS_BIT_VOL_UP         (1 << 6)        /* active low */
  83 #define AIMS_BIT_VOL_DN         (1 << 7)        /* active low */
  84
  85 static void rtrack_set_pins(void *handle, u8 pins)
  86 {
  87         struct radio_isa_card *isa = handle;
  88         struct rtrack *rt = container_of(isa, struct rtrack, isa);
  89         u8 bits = AIMS_BIT_VOL_DN | AIMS_BIT_VOL_UP | AIMS_BIT_TUN_STRQ;
  90
  91         if (!v4l2_ctrl_g_ctrl(rt->isa.mute))
  92                 bits |= AIMS_BIT_VOL_CE;
  93
  94         if (pins & LM7000_DATA)
  95                 bits |= AIMS_BIT_TUN_DATA;
  96         if (pins & LM7000_CLK)
  97                 bits |= AIMS_BIT_TUN_CLK;
  98         if (pins & LM7000_CE)
  99                 bits |= AIMS_BIT_TUN_CE;
 100
 101         outb_p(bits, rt->isa.io);
 102 }
 103
 104 static int rtrack_s_frequency(struct radio_isa_card *isa, u32 freq)
 105 {
 106         lm7000_set_freq(freq, isa, rtrack_set_pins);
 107
 108         return 0;
 109 }
 110
 111 static u32 rtrack_g_signal(struct radio_isa_card *isa)
 112 {
 113         /* bit set = no signal present */
 114         return 0xffff * !(inb(isa->io) & 2);
 115 }
 116
 117 static int rtrack_s_mute_volume(struct radio_isa_card *isa, bool mute, int vol)
 118 {
 119         struct rtrack *rt = container_of(isa, struct rtrack, isa);
 120         int curvol = rt->curvol;
 121
 122         if (mute) {
 123                 outb(0xd0, isa->io);    /* volume steady + sigstr + off */
 124                 return 0;
 125         }
 126         if (vol == 0) {                 /* volume = 0 means mute the card */
 127                 outb(0x48, isa->io);    /* volume down but still "on"   */
 128                 msleep(curvol * 3);     /* make sure it's totally down  */
 129         } else if (curvol < vol) {
 130                 outb(0x98, isa->io);    /* volume up + sigstr + on      */
 131                 for (; curvol < vol; curvol++)
 132                         mdelay(3);
 133         } else if (curvol > vol) {
 134                 outb(0x58, isa->io);    /* volume down + sigstr + on    */
 135                 for (; curvol > vol; curvol--)
 136                         mdelay(3);
 137         }
 138         outb(0xd8, isa->io);            /* volume steady + sigstr + on  */
 139         rt->curvol = vol;
 140         return 0;
 141 }
 142
 143 /* Mute card - prevents noisy bootups */
 144 static int rtrack_initialize(struct radio_isa_card *isa)
 145 {
 146         /* this ensures that the volume is all the way up  */
 147         outb(0x90, isa->io);    /* volume up but still "on"     */
 148         msleep(3000);           /* make sure it's totally up    */
 149         outb(0xc0, isa->io);    /* steady volume, mute card     */
 150         return 0;
 151 }
 152
 153 static const struct radio_isa_ops rtrack_ops = {
 154         .alloc = rtrack_alloc,
 155         .init = rtrack_initialize,
 156         .s_mute_volume = rtrack_s_mute_volume,
 157         .s_frequency = rtrack_s_frequency,
 158         .g_signal = rtrack_g_signal,
 159 };
 160
 161 static const int rtrack_ioports[] = { 0x20f, 0x30f };
 162
 163 static struct radio_isa_driver rtrack_driver = {
 164         .driver = {
 165                 .match          = radio_isa_match,
 166                 .probe          = radio_isa_probe,
 167                 .remove         = radio_isa_remove,
 168                 .driver         = {
 169                         .name   = "radio-aimslab",
 170                 },
 171         },
 172         .io_params = io,
 173         .radio_nr_params = radio_nr,
 174         .io_ports = rtrack_ioports,
 175         .num_of_io_ports = ARRAY_SIZE(rtrack_ioports),
 176         .region_size = 2,
 177         .card = "AIMSlab RadioTrack/RadioReveal",
 178         .ops = &rtrack_ops,
 179         .has_stereo = true,
 180         .max_volume = 0xff,
 181 };
 182
 183 static int __init rtrack_init(void)
 184 {
 185         return isa_register_driver(&rtrack_driver.driver, RTRACK_MAX);
 186 }
 187
 188 static void __exit rtrack_exit(void)
 189 {
 190         isa_unregister_driver(&rtrack_driver.driver);
 191 }
 192
 193 module_init(rtrack_init);
 194 module_exit(rtrack_exit);