drivers/media/radio/radio-aimslab.c

   1 /* radiotrack (radioreveal) driver for Linux radio support
   2  * (c) 1997 M. Kirkwood
   3  * Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@infradead.org>
   4  * Converted to new API by Alan Cox <Alan.Cox@linux.org>
   5  * Various bugfixes and enhancements by Russell Kroll <rkroll@exploits.org>
   6  *
   7  * History:
   8  * 1999-02-24   Russell Kroll <rkroll@exploits.org>
   9  *              Fine tuning/VIDEO_TUNER_LOW
  10  *              Frequency range expanded to start at 87 MHz
  11  *
  12  * TODO: Allow for more than one of these foolish entities :-)
  13  *
  14  * Notes on the hardware (reverse engineered from other peoples'
  15  * reverse engineering of AIMS' code :-)
  16  *
  17  *  Frequency control is done digitally -- ie out(port,encodefreq(95.8));
  18  *
  19  *  The signal strength query is unsurprisingly inaccurate.  And it seems
  20  *  to indicate that (on my card, at least) the frequency setting isn't
  21  *  too great.  (I have to tune up .025MHz from what the freq should be
  22  *  to get a report that the thing is tuned.)
  23  *
  24  *  Volume control is (ugh) analogue:
  25  *   out(port, start_increasing_volume);
  26  *   wait(a_wee_while);
  27  *   out(port, stop_changing_the_volume);
  28  *
  29  */
  30
  31 #include <linux/module.h>       /* Modules                      */
  32 #include <linux/init.h>         /* Initdata                     */
  33 #include <linux/ioport.h>       /* request_region               */
  34 #include <linux/delay.h>        /* udelay                       */
  35 #include <asm/io.h>             /* outb, outb_p                 */
  36 #include <asm/uaccess.h>        /* copy to/from user            */
  37 #include <linux/videodev2.h>    /* kernel radio structs         */
  38 #include <media/v4l2-common.h>
  39 #include <asm/semaphore.h>      /* Lock for the I/O             */
  40
  41 #include <linux/version.h>      /* for KERNEL_VERSION MACRO     */
  42 #define RADIO_VERSION KERNEL_VERSION(0,0,2)
  43
  44 #ifndef CONFIG_RADIO_RTRACK_PORT
  45 #define CONFIG_RADIO_RTRACK_PORT -1
  46 #endif
  47
  48 static int io = CONFIG_RADIO_RTRACK_PORT;
  49 static int radio_nr = -1;
  50 static struct mutex lock;
  51
  52 struct rt_device
  53 {
  54         int port;
  55         int curvol;
  56         unsigned long curfreq;
  57         int muted;
  58 };
  59
  60
  61 /* local things */
  62
  63 static void sleep_delay(long n)
  64 {
  65         /* Sleep nicely for 'n' uS */
  66         int d=n/(1000000/HZ);
  67         if(!d)
  68                 udelay(n);
  69         else
  70                 msleep(jiffies_to_msecs(d));
  71 }
  72
  73 static void rt_decvol(void)
  74 {
  75         outb(0x58, io);         /* volume down + sigstr + on    */
  76         sleep_delay(100000);
  77         outb(0xd8, io);         /* volume steady + sigstr + on  */
  78 }
  79
  80 static void rt_incvol(void)
  81 {
  82         outb(0x98, io);         /* volume up + sigstr + on      */
  83         sleep_delay(100000);
  84         outb(0xd8, io);         /* volume steady + sigstr + on  */
  85 }
  86
  87 static void rt_mute(struct rt_device *dev)
  88 {
  89         dev->muted = 1;
  90         mutex_lock(&lock);
  91         outb(0xd0, io);                 /* volume steady, off           */
  92         mutex_unlock(&lock);
  93 }
  94
  95 static int rt_setvol(struct rt_device *dev, int vol)
  96 {
  97         int i;
  98
  99         mutex_lock(&lock);
 100
 101         if(vol == dev->curvol) {        /* requested volume = current */
 102                 if (dev->muted) {       /* user is unmuting the card  */
 103                         dev->muted = 0;
 104                         outb (0xd8, io);        /* enable card */
 105                 }
 106                 mutex_unlock(&lock);
 107                 return 0;
 108         }
 109
 110         if(vol == 0) {                  /* volume = 0 means mute the card */
 111                 outb(0x48, io);         /* volume down but still "on"   */
 112                 sleep_delay(2000000);   /* make sure it's totally down  */
 113                 outb(0xd0, io);         /* volume steady, off           */
 114                 dev->curvol = 0;        /* track the volume state!      */
 115                 mutex_unlock(&lock);
 116                 return 0;
 117         }
 118
 119         dev->muted = 0;
 120         if(vol > dev->curvol)
 121                 for(i = dev->curvol; i < vol; i++)
 122                         rt_incvol();
 123         else
 124                 for(i = dev->curvol; i > vol; i--)
 125                         rt_decvol();
 126
 127         dev->curvol = vol;
 128         mutex_unlock(&lock);
 129         return 0;
 130 }
 131
 132 /* the 128+64 on these outb's is to keep the volume stable while tuning
 133  * without them, the volume _will_ creep up with each frequency change
 134  * and bit 4 (+16) is to keep the signal strength meter enabled
 135  */
 136
 137 static void send_0_byte(int port, struct rt_device *dev)
 138 {
 139         if ((dev->curvol == 0) || (dev->muted)) {
 140                 outb_p(128+64+16+  1, port);   /* wr-enable + data low */
 141                 outb_p(128+64+16+2+1, port);   /* clock */
 142         }
 143         else {
 144                 outb_p(128+64+16+8+  1, port);  /* on + wr-enable + data low */
 145                 outb_p(128+64+16+8+2+1, port);  /* clock */
 146         }
 147         sleep_delay(1000);
 148 }
 149
 150 static void send_1_byte(int port, struct rt_device *dev)
 151 {
 152         if ((dev->curvol == 0) || (dev->muted)) {
 153                 outb_p(128+64+16+4  +1, port);   /* wr-enable+data high */
 154                 outb_p(128+64+16+4+2+1, port);   /* clock */
 155         }
 156         else {
 157                 outb_p(128+64+16+8+4  +1, port); /* on+wr-enable+data high */
 158                 outb_p(128+64+16+8+4+2+1, port); /* clock */
 159         }
 160
 161         sleep_delay(1000);
 162 }
 163
 164 static int rt_setfreq(struct rt_device *dev, unsigned long freq)
 165 {
 166         int i;
 167
 168         /* adapted from radio-aztech.c */
 169
 170         /* now uses VIDEO_TUNER_LOW for fine tuning */
 171
 172         freq += 171200;                 /* Add 10.7 MHz IF              */
 173         freq /= 800;                    /* Convert to 50 kHz units      */
 174
 175         mutex_lock(&lock);                      /* Stop other ops interfering */
 176
 177         send_0_byte (io, dev);          /*  0: LSB of frequency         */
 178
 179         for (i = 0; i < 13; i++)        /*   : frequency bits (1-13)    */
 180                 if (freq & (1 << i))
 181                         send_1_byte (io, dev);
 182                 else
 183                         send_0_byte (io, dev);
 184
 185         send_0_byte (io, dev);          /* 14: test bit - always 0    */
 186         send_0_byte (io, dev);          /* 15: test bit - always 0    */
 187
 188         send_0_byte (io, dev);          /* 16: band data 0 - always 0 */
 189         send_0_byte (io, dev);          /* 17: band data 1 - always 0 */
 190         send_0_byte (io, dev);          /* 18: band data 2 - always 0 */
 191         send_0_byte (io, dev);          /* 19: time base - always 0   */
 192
 193         send_0_byte (io, dev);          /* 20: spacing (0 = 25 kHz)   */
 194         send_1_byte (io, dev);          /* 21: spacing (1 = 25 kHz)   */
 195         send_0_byte (io, dev);          /* 22: spacing (0 = 25 kHz)   */
 196         send_1_byte (io, dev);          /* 23: AM/FM (FM = 1, always) */
 197
 198         if ((dev->curvol == 0) || (dev->muted))
 199                 outb (0xd0, io);        /* volume steady + sigstr */
 200         else
 201                 outb (0xd8, io);        /* volume steady + sigstr + on */
 202
 203         mutex_unlock(&lock);
 204
 205         return 0;
 206 }
 207
 208 static int rt_getsigstr(struct rt_device *dev)
 209 {
 210         if (inb(io) & 2)        /* bit set = no signal present  */
 211                 return 0;
 212         return 1;               /* signal present               */
 213 }
 214
 215 static struct v4l2_queryctrl radio_qctrl[] = {
 216         {
 217                 .id            = V4L2_CID_AUDIO_MUTE,
 218                 .name          = "Mute",
 219                 .minimum       = 0,
 220                 .maximum       = 1,
 221                 .default_value = 1,
 222                 .type          = V4L2_CTRL_TYPE_BOOLEAN,
 223         },{
 224                 .id            = V4L2_CID_AUDIO_VOLUME,
 225                 .name          = "Volume",
 226                 .minimum       = 0,
 227                 .maximum       = 0xff,
 228                 .step          = 1,
 229                 .default_value = 0xff,
 230                 .type          = V4L2_CTRL_TYPE_INTEGER,
 231         }
 232 };
 233
 234 static int rt_do_ioctl(struct inode *inode, struct file *file,
 235                        unsigned int cmd, void *arg)
 236 {
 237         struct video_device *dev = video_devdata(file);
 238         struct rt_device *rt=dev->priv;
 239
 240         switch(cmd)
 241         {
 242                 case VIDIOC_QUERYCAP:
 243                 {
 244                         struct v4l2_capability *v = arg;
 245                         memset(v,0,sizeof(*v));
 246                         strlcpy(v->driver, "radio-aimslab", sizeof (v->driver));
 247                         strlcpy(v->card, "RadioTrack", sizeof (v->card));
 248                         sprintf(v->bus_info,"ISA");
 249                         v->version = RADIO_VERSION;
 250                         v->capabilities = V4L2_CAP_TUNER;
 251
 252                         return 0;
 253                 }
 254                 case VIDIOC_G_TUNER:
 255                 {
 256                         struct v4l2_tuner *v = arg;
 257
 258                         if (v->index > 0)
 259                                 return -EINVAL;
 260
 261                         memset(v,0,sizeof(*v));
 262                         strcpy(v->name, "FM");
 263                         v->type = V4L2_TUNER_RADIO;
 264
 265                         v->rangelow=(87*16000);
 266                         v->rangehigh=(108*16000);
 267                         v->rxsubchans =V4L2_TUNER_SUB_MONO;
 268                         v->capability=V4L2_TUNER_CAP_LOW;
 269                         v->audmode = V4L2_TUNER_MODE_MONO;
 270                         v->signal=0xFFFF*rt_getsigstr(rt);
 271
 272                         return 0;
 273                 }
 274                 case VIDIOC_S_TUNER:
 275                 {
 276                         struct v4l2_tuner *v = arg;
 277
 278                         if (v->index > 0)
 279                                 return -EINVAL;
 280
 281                         return 0;
 282                 }
 283                 case VIDIOC_S_FREQUENCY:
 284                 {
 285                         struct v4l2_frequency *f = arg;
 286
 287                         rt->curfreq = f->frequency;
 288                         rt_setfreq(rt, rt->curfreq);
 289                         return 0;
 290                 }
 291                 case VIDIOC_G_FREQUENCY:
 292                 {
 293                         struct v4l2_frequency *f = arg;
 294
 295                         f->type = V4L2_TUNER_RADIO;
 296                         f->frequency = rt->curfreq;
 297
 298                         return 0;
 299                 }
 300                 case VIDIOC_QUERYCTRL:
 301                 {
 302                         struct v4l2_queryctrl *qc = arg;
 303                         int i;
 304
 305                         for (i = 0; i < ARRAY_SIZE(radio_qctrl); i++) {
 306                                 if (qc->id && qc->id == radio_qctrl[i].id) {
 307                                         memcpy(qc, &(radio_qctrl[i]),
 308                                                                 sizeof(*qc));
 309                                         return (0);
 310                                 }
 311                         }
 312                         return -EINVAL;
 313                 }
 314                 case VIDIOC_G_CTRL:
 315                 {
 316                         struct v4l2_control *ctrl= arg;
 317
 318                         switch (ctrl->id) {
 319                                 case V4L2_CID_AUDIO_MUTE:
 320                                         ctrl->value=rt->muted;
 321                                         return (0);
 322                                 case V4L2_CID_AUDIO_VOLUME:
 323                                         ctrl->value=rt->curvol * 6554;
 324                                         return (0);
 325                         }
 326                         return -EINVAL;
 327                 }
 328                 case VIDIOC_S_CTRL:
 329                 {
 330                         struct v4l2_control *ctrl= arg;
 331
 332                         switch (ctrl->id) {
 333                                 case V4L2_CID_AUDIO_MUTE:
 334                                         if (ctrl->value) {
 335                                                 rt_mute(rt);
 336                                         } else {
 337                                                 rt_setvol(rt,rt->curvol);
 338                                         }
 339                                         return (0);
 340                                 case V4L2_CID_AUDIO_VOLUME:
 341                                         rt_setvol(rt,ctrl->value);
 342                                         return (0);
 343                         }
 344                         return -EINVAL;
 345                 }
 346
 347                 default:
 348                         return v4l_compat_translate_ioctl(inode,file,cmd,arg,
 349                                                           rt_do_ioctl);
 350         }
 351 }
 352
 353 static int rt_ioctl(struct inode *inode, struct file *file,
 354                     unsigned int cmd, unsigned long arg)
 355 {
 356         return video_usercopy(inode, file, cmd, arg, rt_do_ioctl);
 357 }
 358
 359 static struct rt_device rtrack_unit;
 360
 361 static const struct file_operations rtrack_fops = {
 362         .owner          = THIS_MODULE,
 363         .open           = video_exclusive_open,
 364         .release        = video_exclusive_release,
 365         .ioctl          = rt_ioctl,
 366         .compat_ioctl   = v4l_compat_ioctl32,
 367         .llseek         = no_llseek,
 368 };
 369
 370 static struct video_device rtrack_radio=
 371 {
 372         .owner          = THIS_MODULE,
 373         .name           = "RadioTrack radio",
 374         .type           = VID_TYPE_TUNER,
 375         .hardware       = 0,
 376         .fops           = &rtrack_fops,
 377 };
 378
 379 static int __init rtrack_init(void)
 380 {
 381         if(io==-1)
 382         {
 383                 printk(KERN_ERR "You must set an I/O address with io=0x???\n");
 384                 return -EINVAL;
 385         }
 386
 387         if (!request_region(io, 2, "rtrack"))
 388         {
 389                 printk(KERN_ERR "rtrack: port 0x%x already in use\n", io);
 390                 return -EBUSY;
 391         }
 392
 393         rtrack_radio.priv=&rtrack_unit;
 394
 395         if(video_register_device(&rtrack_radio, VFL_TYPE_RADIO, radio_nr)==-1)
 396         {
 397                 release_region(io, 2);
 398                 return -EINVAL;
 399         }
 400         printk(KERN_INFO "AIMSlab RadioTrack/RadioReveal card driver.\n");
 401
 402         /* Set up the I/O locking */
 403
 404         mutex_init(&lock);
 405
 406         /* mute card - prevents noisy bootups */
 407
 408         /* this ensures that the volume is all the way down  */
 409         outb(0x48, io);         /* volume down but still "on"   */
 410         sleep_delay(2000000);   /* make sure it's totally down  */
 411         outb(0xc0, io);         /* steady volume, mute card     */
 412         rtrack_unit.curvol = 0;
 413
 414         return 0;
 415 }
 416
 417 MODULE_AUTHOR("M.Kirkwood");
 418 MODULE_DESCRIPTION("A driver for the RadioTrack/RadioReveal radio card.");
 419 MODULE_LICENSE("GPL");
 420
 421 module_param(io, int, 0);
 422 MODULE_PARM_DESC(io, "I/O address of the RadioTrack card (0x20f or 0x30f)");
 423 module_param(radio_nr, int, 0);
 424
 425 static void __exit cleanup_rtrack_module(void)
 426 {
 427         video_unregister_device(&rtrack_radio);
 428         release_region(io,2);
 429 }
 430
 431 module_init(rtrack_init);
 432 module_exit(cleanup_rtrack_module);
 433