drivers/media/radio/radio-sf16fmr2.c

   1 /* SF16FMR2 radio driver for Linux radio support
   2  * heavily based on fmi driver...
   3  * (c) 2000-2002 Ziglio Frediano, freddy77@angelfire.com
   4  *
   5  * Notes on the hardware
   6  *
   7  *  Frequency control is done digitally -- ie out(port,encodefreq(95.8));
   8  *  No volume control - only mute/unmute - you have to use line volume
   9  *
  10  *  For read stereo/mono you must wait 0.1 sec after set frequency and
  11  *  card unmuted so I set frequency on unmute
  12  *  Signal handling seem to work only on autoscanning (not implemented)
  13  *
  14  *  Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@infradead.org>
  15  */
  16
  17 #include <linux/module.h>       /* Modules                      */
  18 #include <linux/init.h>         /* Initdata                     */
  19 #include <linux/ioport.h>       /* request_region               */
  20 #include <linux/delay.h>        /* udelay                       */
  21 #include <linux/videodev2.h>    /* kernel radio structs         */
  22 #include <linux/mutex.h>
  23 #include <linux/version.h>      /* for KERNEL_VERSION MACRO     */
  24 #include <linux/io.h>           /* outb, outb_p                 */
  25 #include <linux/uaccess.h>      /* copy to/from user            */
  26 #include <media/v4l2-device.h>
  27 #include <media/v4l2-ioctl.h>
  28
  29 MODULE_AUTHOR("Ziglio Frediano, freddy77@angelfire.com");
  30 MODULE_DESCRIPTION("A driver for the SF16FMR2 radio.");
  31 MODULE_LICENSE("GPL");
  32
  33 static int io = 0x384;
  34 static int radio_nr = -1;
  35
  36 module_param(io, int, 0);
  37 MODULE_PARM_DESC(io, "I/O address of the SF16FMR2 card (should be 0x384, if do not work try 0x284)");
  38 module_param(radio_nr, int, 0);
  39
  40 #define RADIO_VERSION KERNEL_VERSION(0,0,2)
  41
  42 #define AUD_VOL_INDEX 1
  43
  44 #undef DEBUG
  45 //#define DEBUG 1
  46
  47 #ifdef DEBUG
  48 # define  debug_print(s) printk s
  49 #else
  50 # define  debug_print(s)
  51 #endif
  52
  53 /* this should be static vars for module size */
  54 struct fmr2
  55 {
  56         struct v4l2_device v4l2_dev;
  57         struct video_device vdev;
  58         struct mutex lock;
  59         int io;
  60         int curvol; /* 0-15 */
  61         int mute;
  62         int stereo; /* card is producing stereo audio */
  63         unsigned long curfreq; /* freq in kHz */
  64         int card_type;
  65         u32 flags;
  66 };
  67
  68 static struct fmr2 fmr2_card;
  69
  70 /* hw precision is 12.5 kHz
  71  * It is only useful to give freq in intervall of 200 (=0.0125Mhz),
  72  * other bits will be truncated
  73  */
  74 #define RSF16_ENCODE(x) ((x) / 200 + 856)
  75 #define RSF16_MINFREQ (87 * 16000)
  76 #define RSF16_MAXFREQ (108 * 16000)
  77
  78 static inline void wait(int n, int io)
  79 {
  80         for (; n; --n)
  81                 inb(io);
  82 }
  83
  84 static void outbits(int bits, unsigned int data, int nWait, int io)
  85 {
  86         int bit;
  87
  88         for (; --bits >= 0;) {
  89                 bit = (data >> bits) & 1;
  90                 outb(bit, io);
  91                 wait(nWait, io);
  92                 outb(bit | 2, io);
  93                 wait(nWait, io);
  94                 outb(bit, io);
  95                 wait(nWait, io);
  96         }
  97 }
  98
  99 static inline void fmr2_mute(int io)
 100 {
 101         outb(0x00, io);
 102         wait(4, io);
 103 }
 104
 105 static inline void fmr2_unmute(int io)
 106 {
 107         outb(0x04, io);
 108         wait(4, io);
 109 }
 110
 111 static inline int fmr2_stereo_mode(int io)
 112 {
 113         int n = inb(io);
 114
 115         outb(6, io);
 116         inb(io);
 117         n = ((n >> 3) & 1) ^ 1;
 118         debug_print((KERN_DEBUG "stereo: %d\n", n));
 119         return n;
 120 }
 121
 122 static int fmr2_product_info(struct fmr2 *dev)
 123 {
 124         int n = inb(dev->io);
 125
 126         n &= 0xC1;
 127         if (n == 0) {
 128                 /* this should support volume set */
 129                 dev->card_type = 12;
 130                 return 0;
 131         }
 132         /* not volume (mine is 11) */
 133         dev->card_type = (n == 128) ? 11 : 0;
 134         return n;
 135 }
 136
 137 static inline int fmr2_getsigstr(struct fmr2 *dev)
 138 {
 139         /* !!! works only if scanning freq */
 140         int res = 0xffff;
 141
 142         outb(5, dev->io);
 143         wait(4, dev->io);
 144         if (!(inb(dev->io) & 1))
 145                 res = 0;
 146         debug_print((KERN_DEBUG "signal: %d\n", res));
 147         return res;
 148 }
 149
 150 /* set frequency and unmute card */
 151 static int fmr2_setfreq(struct fmr2 *dev)
 152 {
 153         unsigned long freq = dev->curfreq;
 154
 155         fmr2_mute(dev->io);
 156
 157         /* 0x42 for mono output
 158          * 0x102 forward scanning
 159          * 0x182 scansione avanti
 160          */
 161         outbits(9, 0x2, 3, dev->io);
 162         outbits(16, RSF16_ENCODE(freq), 2, dev->io);
 163
 164         fmr2_unmute(dev->io);
 165
 166         /* wait 0.11 sec */
 167         msleep(110);
 168
 169         /* NOTE if mute this stop radio
 170            you must set freq on unmute */
 171         dev->stereo = fmr2_stereo_mode(dev->io);
 172         return 0;
 173 }
 174
 175 /* !!! not tested, in my card this does't work !!! */
 176 static int fmr2_setvolume(struct fmr2 *dev)
 177 {
 178         int vol[16] = { 0x021, 0x084, 0x090, 0x104,
 179                         0x110, 0x204, 0x210, 0x402,
 180                         0x404, 0x408, 0x410, 0x801,
 181                         0x802, 0x804, 0x808, 0x810 };
 182         int i, a;
 183         int n = vol[dev->curvol & 0x0f];
 184
 185         if (dev->card_type != 11)
 186                 return 1;
 187
 188         for (i = 12; --i >= 0; ) {
 189                 a = ((n >> i) & 1) << 6; /* if (a==0) a = 0; else a = 0x40; */
 190                 outb(a | 4, dev->io);
 191                 wait(4, dev->io);
 192                 outb(a | 0x24, dev->io);
 193                 wait(4, dev->io);
 194                 outb(a | 4, dev->io);
 195                 wait(4, dev->io);
 196         }
 197         for (i = 6; --i >= 0; ) {
 198                 a = ((0x18 >> i) & 1) << 6;
 199                 outb(a | 4, dev->io);
 200                 wait(4, dev->io);
 201                 outb(a | 0x24, dev->io);
 202                 wait(4, dev->io);
 203                 outb(a | 4, dev->io);
 204                 wait(4, dev->io);
 205         }
 206         wait(4, dev->io);
 207         outb(0x14, dev->io);
 208         return 0;
 209 }
 210
 211 static int vidioc_querycap(struct file *file, void  *priv,
 212                                         struct v4l2_capability *v)
 213 {
 214         strlcpy(v->driver, "radio-sf16fmr2", sizeof(v->driver));
 215         strlcpy(v->card, "SF16-FMR2 radio", sizeof(v->card));
 216         strlcpy(v->bus_info, "ISA", sizeof(v->bus_info));
 217         v->version = RADIO_VERSION;
 218         v->capabilities = V4L2_CAP_TUNER | V4L2_CAP_RADIO;
 219         return 0;
 220 }
 221
 222 static int vidioc_g_tuner(struct file *file, void *priv,
 223                                         struct v4l2_tuner *v)
 224 {
 225         int mult;
 226         struct fmr2 *fmr2 = video_drvdata(file);
 227
 228         if (v->index > 0)
 229                 return -EINVAL;
 230
 231         strlcpy(v->name, "FM", sizeof(v->name));
 232         v->type = V4L2_TUNER_RADIO;
 233
 234         mult = (fmr2->flags & V4L2_TUNER_CAP_LOW) ? 1 : 1000;
 235         v->rangelow = RSF16_MINFREQ / mult;
 236         v->rangehigh = RSF16_MAXFREQ / mult;
 237         v->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_MODE_STEREO;
 238         v->capability = fmr2->flags&V4L2_TUNER_CAP_LOW;
 239         v->audmode = fmr2->stereo ? V4L2_TUNER_MODE_STEREO:
 240                                 V4L2_TUNER_MODE_MONO;
 241         mutex_lock(&fmr2->lock);
 242         v->signal = fmr2_getsigstr(fmr2);
 243         mutex_unlock(&fmr2->lock);
 244         return 0;
 245 }
 246
 247 static int vidioc_s_tuner(struct file *file, void *priv,
 248                                         struct v4l2_tuner *v)
 249 {
 250         return v->index ? -EINVAL : 0;
 251 }
 252
 253 static int vidioc_s_frequency(struct file *file, void *priv,
 254                                         struct v4l2_frequency *f)
 255 {
 256         struct fmr2 *fmr2 = video_drvdata(file);
 257
 258         if (!(fmr2->flags & V4L2_TUNER_CAP_LOW))
 259                 f->frequency *= 1000;
 260         if (f->frequency < RSF16_MINFREQ ||
 261                         f->frequency > RSF16_MAXFREQ)
 262                 return -EINVAL;
 263         /* rounding in steps of 200 to match the freq
 264            that will be used */
 265         fmr2->curfreq = (f->frequency / 200) * 200;
 266
 267         /* set card freq (if not muted) */
 268         if (fmr2->curvol && !fmr2->mute) {
 269                 mutex_lock(&fmr2->lock);
 270                 fmr2_setfreq(fmr2);
 271                 mutex_unlock(&fmr2->lock);
 272         }
 273         return 0;
 274 }
 275
 276 static int vidioc_g_frequency(struct file *file, void *priv,
 277                                         struct v4l2_frequency *f)
 278 {
 279         struct fmr2 *fmr2 = video_drvdata(file);
 280
 281         f->type = V4L2_TUNER_RADIO;
 282         f->frequency = fmr2->curfreq;
 283         if (!(fmr2->flags & V4L2_TUNER_CAP_LOW))
 284                 f->frequency /= 1000;
 285         return 0;
 286 }
 287
 288 static int vidioc_queryctrl(struct file *file, void *priv,
 289                                         struct v4l2_queryctrl *qc)
 290 {
 291         struct fmr2 *fmr2 = video_drvdata(file);
 292
 293         switch (qc->id) {
 294         case V4L2_CID_AUDIO_MUTE:
 295                 return v4l2_ctrl_query_fill(qc, 0, 1, 1, 1);
 296         case V4L2_CID_AUDIO_VOLUME:
 297                 /* Only card_type == 11 implements volume */
 298                 if (fmr2->card_type == 11)
 299                         return v4l2_ctrl_query_fill(qc, 0, 15, 1, 0);
 300                 return v4l2_ctrl_query_fill(qc, 0, 1, 1, 0);
 301         }
 302         return -EINVAL;
 303 }
 304
 305 static int vidioc_g_ctrl(struct file *file, void *priv,
 306                                         struct v4l2_control *ctrl)
 307 {
 308         struct fmr2 *fmr2 = video_drvdata(file);
 309
 310         switch (ctrl->id) {
 311         case V4L2_CID_AUDIO_MUTE:
 312                 ctrl->value = fmr2->mute;
 313                 return 0;
 314         case V4L2_CID_AUDIO_VOLUME:
 315                 ctrl->value = fmr2->curvol;
 316                 return 0;
 317         }
 318         return -EINVAL;
 319 }
 320
 321 static int vidioc_s_ctrl(struct file *file, void *priv,
 322                                         struct v4l2_control *ctrl)
 323 {
 324         struct fmr2 *fmr2 = video_drvdata(file);
 325
 326         switch (ctrl->id) {
 327         case V4L2_CID_AUDIO_MUTE:
 328                 fmr2->mute = ctrl->value;
 329                 break;
 330         case V4L2_CID_AUDIO_VOLUME:
 331                 fmr2->curvol = ctrl->value;
 332                 break;
 333         default:
 334                 return -EINVAL;
 335         }
 336
 337 #ifdef DEBUG
 338         if (fmr2->curvol && !fmr2->mute)
 339                 printk(KERN_DEBUG "unmute\n");
 340         else
 341                 printk(KERN_DEBUG "mute\n");
 342 #endif
 343
 344         mutex_lock(&fmr2->lock);
 345         if (fmr2->curvol && !fmr2->mute) {
 346                 fmr2_setvolume(fmr2);
 347                 /* Set frequency and unmute card */
 348                 fmr2_setfreq(fmr2);
 349         } else
 350                 fmr2_mute(fmr2->io);
 351         mutex_unlock(&fmr2->lock);
 352         return 0;
 353 }
 354
 355 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
 356 {
 357         *i = 0;
 358         return 0;
 359 }
 360
 361 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
 362 {
 363         return i ? -EINVAL : 0;
 364 }
 365
 366 static int vidioc_g_audio(struct file *file, void *priv,
 367                                         struct v4l2_audio *a)
 368 {
 369         a->index = 0;
 370         strlcpy(a->name, "Radio", sizeof(a->name));
 371         a->capability = V4L2_AUDCAP_STEREO;
 372         return 0;
 373 }
 374
 375 static int vidioc_s_audio(struct file *file, void *priv,
 376                                         struct v4l2_audio *a)
 377 {
 378         return a->index ? -EINVAL : 0;
 379 }
 380
 381 static int fmr2_open(struct file *file)
 382 {
 383         return 0;
 384 }
 385
 386 static int fmr2_release(struct file *file)
 387 {
 388         return 0;
 389 }
 390
 391 static const struct v4l2_file_operations fmr2_fops = {
 392         .owner          = THIS_MODULE,
 393         .open           = fmr2_open,
 394         .release        = fmr2_release,
 395         .ioctl          = video_ioctl2,
 396 };
 397
 398 static const struct v4l2_ioctl_ops fmr2_ioctl_ops = {
 399         .vidioc_querycap    = vidioc_querycap,
 400         .vidioc_g_tuner     = vidioc_g_tuner,
 401         .vidioc_s_tuner     = vidioc_s_tuner,
 402         .vidioc_g_audio     = vidioc_g_audio,
 403         .vidioc_s_audio     = vidioc_s_audio,
 404         .vidioc_g_input     = vidioc_g_input,
 405         .vidioc_s_input     = vidioc_s_input,
 406         .vidioc_g_frequency = vidioc_g_frequency,
 407         .vidioc_s_frequency = vidioc_s_frequency,
 408         .vidioc_queryctrl   = vidioc_queryctrl,
 409         .vidioc_g_ctrl      = vidioc_g_ctrl,
 410         .vidioc_s_ctrl      = vidioc_s_ctrl,
 411 };
 412
 413 static int __init fmr2_init(void)
 414 {
 415         struct fmr2 *fmr2 = &fmr2_card;
 416         struct v4l2_device *v4l2_dev = &fmr2->v4l2_dev;
 417         int res;
 418
 419         strlcpy(v4l2_dev->name, "sf16fmr2", sizeof(v4l2_dev->name));
 420         fmr2->io = io;
 421         fmr2->stereo = 1;
 422         fmr2->flags = V4L2_TUNER_CAP_LOW;
 423         mutex_init(&fmr2->lock);
 424
 425         if (!request_region(fmr2->io, 2, "sf16fmr2")) {
 426                 v4l2_err(v4l2_dev, "request_region failed!\n");
 427                 return -EBUSY;
 428         }
 429
 430         res = v4l2_device_register(NULL, v4l2_dev);
 431         if (res < 0) {
 432                 release_region(fmr2->io, 2);
 433                 v4l2_err(v4l2_dev, "Could not register v4l2_device\n");
 434                 return res;
 435         }
 436
 437         strlcpy(fmr2->vdev.name, v4l2_dev->name, sizeof(fmr2->vdev.name));
 438         fmr2->vdev.v4l2_dev = v4l2_dev;
 439         fmr2->vdev.fops = &fmr2_fops;
 440         fmr2->vdev.ioctl_ops = &fmr2_ioctl_ops;
 441         fmr2->vdev.release = video_device_release_empty;
 442         video_set_drvdata(&fmr2->vdev, fmr2);
 443
 444         if (video_register_device(&fmr2->vdev, VFL_TYPE_RADIO, radio_nr) < 0) {
 445                 v4l2_device_unregister(v4l2_dev);
 446                 release_region(fmr2->io, 2);
 447                 return -EINVAL;
 448         }
 449
 450         v4l2_info(v4l2_dev, "SF16FMR2 radio card driver at 0x%x.\n", fmr2->io);
 451         /* mute card - prevents noisy bootups */
 452         mutex_lock(&fmr2->lock);
 453         fmr2_mute(fmr2->io);
 454         fmr2_product_info(fmr2);
 455         mutex_unlock(&fmr2->lock);
 456         debug_print((KERN_DEBUG "card_type %d\n", fmr2->card_type));
 457         return 0;
 458 }
 459
 460 static void __exit fmr2_exit(void)
 461 {
 462         struct fmr2 *fmr2 = &fmr2_card;
 463
 464         video_unregister_device(&fmr2->vdev);
 465         v4l2_device_unregister(&fmr2->v4l2_dev);
 466         release_region(fmr2->io, 2);
 467 }
 468
 469 module_init(fmr2_init);
 470 module_exit(fmr2_exit);
 471
 472 #ifndef MODULE
 473
 474 static int __init fmr2_setup_io(char *str)
 475 {
 476         get_option(&str, &io);
 477         return 1;
 478 }
 479
 480 __setup("sf16fmr2=", fmr2_setup_io);
 481
 482 #endif