drivers/media/radio/radio-gemtek-pci.c

   1 /*
   2  ***************************************************************************
   3  *
   4  *     radio-gemtek-pci.c - Gemtek PCI Radio driver
   5  *     (C) 2001 Vladimir Shebordaev <vshebordaev@mail.ru>
   6  *
   7  ***************************************************************************
   8  *
   9  *     This program is free software; you can redistribute it and/or
  10  *     modify it under the terms of the GNU General Public License as
  11  *     published by the Free Software Foundation; either version 2 of
  12  *     the License, or (at your option) any later version.
  13  *
  14  *     This program is distributed in the hope that it will be useful,
  15  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *     GNU General Public License for more details.
  18  *
  19  *     You should have received a copy of the GNU General Public
  20  *     License along with this program; if not, write to the Free
  21  *     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
  22  *     USA.
  23  *
  24  ***************************************************************************
  25  *
  26  *     Gemtek Corp still silently refuses to release any specifications
  27  *     of their multimedia devices, so the protocol still has to be
  28  *     reverse engineered.
  29  *
  30  *     The v4l code was inspired by Jonas Munsin's  Gemtek serial line
  31  *     radio device driver.
  32  *
  33  *     Please, let me know if this piece of code was useful :)
  34  *
  35  *     TODO: multiple device support and portability were not tested
  36  *
  37  *     Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@infradead.org>
  38  *
  39  ***************************************************************************
  40  */
  41
  42 #include <linux/types.h>
  43 #include <linux/list.h>
  44 #include <linux/module.h>
  45 #include <linux/init.h>
  46 #include <linux/pci.h>
  47 #include <linux/videodev2.h>
  48 #include <media/v4l2-common.h>
  49 #include <linux/errno.h>
  50
  51 #include <linux/version.h>      /* for KERNEL_VERSION MACRO     */
  52 #define RADIO_VERSION KERNEL_VERSION(0,0,2)
  53
  54 static struct v4l2_queryctrl radio_qctrl[] = {
  55         {
  56                 .id            = V4L2_CID_AUDIO_MUTE,
  57                 .name          = "Mute",
  58                 .minimum       = 0,
  59                 .maximum       = 1,
  60                 .default_value = 1,
  61                 .type          = V4L2_CTRL_TYPE_BOOLEAN,
  62         },{
  63                 .id            = V4L2_CID_AUDIO_VOLUME,
  64                 .name          = "Volume",
  65                 .minimum       = 0,
  66                 .maximum       = 65535,
  67                 .step          = 65535,
  68                 .default_value = 0xff,
  69                 .type          = V4L2_CTRL_TYPE_INTEGER,
  70         }
  71 };
  72
  73 #include <asm/io.h>
  74 #include <asm/uaccess.h>
  75
  76 #ifndef PCI_VENDOR_ID_GEMTEK
  77 #define PCI_VENDOR_ID_GEMTEK 0x5046
  78 #endif
  79
  80 #ifndef PCI_DEVICE_ID_GEMTEK_PR103
  81 #define PCI_DEVICE_ID_GEMTEK_PR103 0x1001
  82 #endif
  83
  84 #ifndef GEMTEK_PCI_RANGE_LOW
  85 #define GEMTEK_PCI_RANGE_LOW (87*16000)
  86 #endif
  87
  88 #ifndef GEMTEK_PCI_RANGE_HIGH
  89 #define GEMTEK_PCI_RANGE_HIGH (108*16000)
  90 #endif
  91
  92 struct gemtek_pci_card {
  93         struct video_device *videodev;
  94
  95         u32 iobase;
  96         u32 length;
  97         u16 model;
  98
  99         u32 current_frequency;
 100         u8  mute;
 101 };
 102
 103 static const char rcsid[] = "$Id: radio-gemtek-pci.c,v 1.1 2001/07/23 08:08:16 ted Exp ted $";
 104
 105 static int nr_radio = -1;
 106
 107 static inline u8 gemtek_pci_out( u16 value, u32 port )
 108 {
 109         outw( value, port );
 110
 111         return (u8)value;
 112 }
 113
 114 #define _b0( v ) *((u8 *)&v)
 115 static void __gemtek_pci_cmd( u16 value, u32 port, u8 *last_byte, int keep )
 116 {
 117         register u8 byte = *last_byte;
 118
 119         if ( !value ) {
 120                 if ( !keep )
 121                         value = (u16)port;
 122                 byte &= 0xfd;
 123         } else
 124                 byte |= 2;
 125
 126         _b0( value ) = byte;
 127         outw( value, port );
 128         byte |= 1;
 129         _b0( value ) = byte;
 130         outw( value, port );
 131         byte &= 0xfe;
 132         _b0( value ) = byte;
 133         outw( value, port );
 134
 135         *last_byte = byte;
 136 }
 137
 138 static inline void gemtek_pci_nil( u32 port, u8 *last_byte )
 139 {
 140         __gemtek_pci_cmd( 0x00, port, last_byte, false );
 141 }
 142
 143 static inline void gemtek_pci_cmd( u16 cmd, u32 port, u8 *last_byte )
 144 {
 145         __gemtek_pci_cmd( cmd, port, last_byte, true );
 146 }
 147
 148 static void gemtek_pci_setfrequency( struct gemtek_pci_card *card, unsigned long frequency )
 149 {
 150         register int i;
 151         register u32 value = frequency / 200 + 856;
 152         register u16 mask = 0x8000;
 153         u8 last_byte;
 154         u32 port = card->iobase;
 155
 156         last_byte = gemtek_pci_out( 0x06, port );
 157
 158         i = 0;
 159         do {
 160                 gemtek_pci_nil( port, &last_byte );
 161                 i++;
 162         } while ( i < 9 );
 163
 164         i = 0;
 165         do {
 166                 gemtek_pci_cmd( value & mask, port, &last_byte );
 167                 mask >>= 1;
 168                 i++;
 169         } while ( i < 16 );
 170
 171         outw( 0x10, port );
 172 }
 173
 174
 175 static inline void gemtek_pci_mute( struct gemtek_pci_card *card )
 176 {
 177         outb( 0x1f, card->iobase );
 178         card->mute = true;
 179 }
 180
 181 static inline void gemtek_pci_unmute( struct gemtek_pci_card *card )
 182 {
 183         if ( card->mute ) {
 184                 gemtek_pci_setfrequency( card, card->current_frequency );
 185                 card->mute = false;
 186         }
 187 }
 188
 189 static inline unsigned int gemtek_pci_getsignal( struct gemtek_pci_card *card )
 190 {
 191         return ( inb( card->iobase ) & 0x08 ) ? 0 : 1;
 192 }
 193
 194 static int vidioc_querycap(struct file *file, void *priv,
 195                                         struct v4l2_capability *v)
 196 {
 197         strlcpy(v->driver, "radio-gemtek-pci", sizeof(v->driver));
 198         strlcpy(v->card, "GemTek PCI Radio", sizeof(v->card));
 199         sprintf(v->bus_info, "ISA");
 200         v->version = RADIO_VERSION;
 201         v->capabilities = V4L2_CAP_TUNER;
 202         return 0;
 203 }
 204
 205 static int vidioc_g_tuner(struct file *file, void *priv,
 206                                         struct v4l2_tuner *v)
 207 {
 208         struct video_device *dev = video_devdata(file);
 209         struct gemtek_pci_card *card = dev->priv;
 210
 211         if (v->index > 0)
 212                 return -EINVAL;
 213
 214         strcpy(v->name, "FM");
 215         v->type = V4L2_TUNER_RADIO;
 216         v->rangelow = GEMTEK_PCI_RANGE_LOW;
 217         v->rangehigh = GEMTEK_PCI_RANGE_HIGH;
 218         v->rxsubchans = V4L2_TUNER_SUB_MONO;
 219         v->capability = V4L2_TUNER_CAP_LOW;
 220         v->audmode = V4L2_TUNER_MODE_MONO;
 221         v->signal = 0xffff * gemtek_pci_getsignal(card);
 222         return 0;
 223 }
 224
 225 static int vidioc_s_tuner(struct file *file, void *priv,
 226                                         struct v4l2_tuner *v)
 227 {
 228         if (v->index > 0)
 229                 return -EINVAL;
 230         return 0;
 231 }
 232
 233 static int vidioc_s_frequency(struct file *file, void *priv,
 234                                         struct v4l2_frequency *f)
 235 {
 236         struct video_device *dev = video_devdata(file);
 237         struct gemtek_pci_card *card = dev->priv;
 238
 239         if ( (f->frequency < GEMTEK_PCI_RANGE_LOW) ||
 240                         (f->frequency > GEMTEK_PCI_RANGE_HIGH) )
 241                 return -EINVAL;
 242         gemtek_pci_setfrequency(card, f->frequency);
 243         card->current_frequency = f->frequency;
 244         card->mute = false;
 245         return 0;
 246 }
 247
 248 static int vidioc_g_frequency(struct file *file, void *priv,
 249                                         struct v4l2_frequency *f)
 250 {
 251         struct video_device *dev = video_devdata(file);
 252         struct gemtek_pci_card *card = dev->priv;
 253
 254         f->type = V4L2_TUNER_RADIO;
 255         f->frequency = card->current_frequency;
 256         return 0;
 257 }
 258
 259 static int vidioc_queryctrl(struct file *file, void *priv,
 260                                         struct v4l2_queryctrl *qc)
 261 {
 262         int i;
 263         for (i = 0; i < ARRAY_SIZE(radio_qctrl); i++) {
 264                 if (qc->id && qc->id == radio_qctrl[i].id) {
 265                         memcpy(qc, &(radio_qctrl[i]),
 266                                                 sizeof(*qc));
 267                         return 0;
 268                 }
 269         }
 270         return -EINVAL;
 271 }
 272
 273 static int vidioc_g_ctrl(struct file *file, void *priv,
 274                                         struct v4l2_control *ctrl)
 275 {
 276         struct video_device *dev = video_devdata(file);
 277         struct gemtek_pci_card *card = dev->priv;
 278
 279         switch (ctrl->id) {
 280         case V4L2_CID_AUDIO_MUTE:
 281                 ctrl->value = card->mute;
 282                 return 0;
 283         case V4L2_CID_AUDIO_VOLUME:
 284                 if (card->mute)
 285                         ctrl->value = 0;
 286                 else
 287                         ctrl->value = 65535;
 288                 return 0;
 289         }
 290         return -EINVAL;
 291 }
 292
 293 static int vidioc_s_ctrl(struct file *file, void *priv,
 294                                         struct v4l2_control *ctrl)
 295 {
 296         struct video_device *dev = video_devdata(file);
 297         struct gemtek_pci_card *card = dev->priv;
 298
 299         switch (ctrl->id) {
 300         case V4L2_CID_AUDIO_MUTE:
 301                 if (ctrl->value)
 302                         gemtek_pci_mute(card);
 303                 else
 304                         gemtek_pci_unmute(card);
 305                 return 0;
 306         case V4L2_CID_AUDIO_VOLUME:
 307                 if (ctrl->value)
 308                         gemtek_pci_unmute(card);
 309                 else
 310                         gemtek_pci_mute(card);
 311                 return 0;
 312         }
 313         return -EINVAL;
 314 }
 315
 316 static int vidioc_g_audio(struct file *file, void *priv,
 317                                         struct v4l2_audio *a)
 318 {
 319         if (a->index > 1)
 320                 return -EINVAL;
 321
 322         strcpy(a->name, "Radio");
 323         a->capability = V4L2_AUDCAP_STEREO;
 324         return 0;
 325 }
 326
 327 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
 328 {
 329         *i = 0;
 330         return 0;
 331 }
 332
 333 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
 334 {
 335         if (i != 0)
 336                 return -EINVAL;
 337         return 0;
 338 }
 339
 340 static int vidioc_s_audio(struct file *file, void *priv,
 341                                         struct v4l2_audio *a)
 342 {
 343         if (a->index != 0)
 344                 return -EINVAL;
 345         return 0;
 346 }
 347
 348 enum {
 349         GEMTEK_PR103
 350 };
 351
 352 static char *card_names[] __devinitdata = {
 353         "GEMTEK_PR103"
 354 };
 355
 356 static struct pci_device_id gemtek_pci_id[] =
 357 {
 358         { PCI_VENDOR_ID_GEMTEK, PCI_DEVICE_ID_GEMTEK_PR103,
 359           PCI_ANY_ID, PCI_ANY_ID, 0, 0, GEMTEK_PR103 },
 360         { 0 }
 361 };
 362
 363 MODULE_DEVICE_TABLE( pci, gemtek_pci_id );
 364
 365 static int mx = 1;
 366
 367 static const struct file_operations gemtek_pci_fops = {
 368         .owner          = THIS_MODULE,
 369         .open           = video_exclusive_open,
 370         .release        = video_exclusive_release,
 371         .ioctl          = video_ioctl2,
 372         .compat_ioctl   = v4l_compat_ioctl32,
 373         .llseek         = no_llseek,
 374 };
 375
 376 static struct video_device vdev_template = {
 377         .owner         = THIS_MODULE,
 378         .name          = "Gemtek PCI Radio",
 379         .type          = VID_TYPE_TUNER,
 380         .hardware      = 0,
 381         .fops          = &gemtek_pci_fops,
 382         .vidioc_querycap    = vidioc_querycap,
 383         .vidioc_g_tuner     = vidioc_g_tuner,
 384         .vidioc_s_tuner     = vidioc_s_tuner,
 385         .vidioc_g_audio     = vidioc_g_audio,
 386         .vidioc_s_audio     = vidioc_s_audio,
 387         .vidioc_g_input     = vidioc_g_input,
 388         .vidioc_s_input     = vidioc_s_input,
 389         .vidioc_g_frequency = vidioc_g_frequency,
 390         .vidioc_s_frequency = vidioc_s_frequency,
 391         .vidioc_queryctrl   = vidioc_queryctrl,
 392         .vidioc_g_ctrl      = vidioc_g_ctrl,
 393         .vidioc_s_ctrl      = vidioc_s_ctrl,
 394 };
 395
 396 static int __devinit gemtek_pci_probe( struct pci_dev *pci_dev, const struct pci_device_id *pci_id )
 397 {
 398         struct gemtek_pci_card *card;
 399         struct video_device *devradio;
 400
 401         if ( (card = kzalloc( sizeof( struct gemtek_pci_card ), GFP_KERNEL )) == NULL ) {
 402                 printk( KERN_ERR "gemtek_pci: out of memory\n" );
 403                 return -ENOMEM;
 404         }
 405
 406         if ( pci_enable_device( pci_dev ) )
 407                 goto err_pci;
 408
 409         card->iobase = pci_resource_start( pci_dev, 0 );
 410         card->length = pci_resource_len( pci_dev, 0 );
 411
 412         if ( request_region( card->iobase, card->length, card_names[pci_id->driver_data] ) == NULL ) {
 413                 printk( KERN_ERR "gemtek_pci: i/o port already in use\n" );
 414                 goto err_pci;
 415         }
 416
 417         pci_read_config_word( pci_dev, PCI_SUBSYSTEM_ID, &card->model );
 418
 419         pci_set_drvdata( pci_dev, card );
 420
 421         if ( (devradio = kmalloc( sizeof( struct video_device ), GFP_KERNEL )) == NULL ) {
 422                 printk( KERN_ERR "gemtek_pci: out of memory\n" );
 423                 goto err_video;
 424         }
 425         *devradio = vdev_template;
 426
 427         if ( video_register_device( devradio, VFL_TYPE_RADIO , nr_radio) == -1 ) {
 428                 kfree( devradio );
 429                 goto err_video;
 430         }
 431
 432         card->videodev = devradio;
 433         devradio->priv = card;
 434         gemtek_pci_mute( card );
 435
 436         printk( KERN_INFO "Gemtek PCI Radio (rev. %d) found at 0x%04x-0x%04x.\n",
 437                 pci_dev->revision, card->iobase, card->iobase + card->length - 1 );
 438
 439         return 0;
 440
 441 err_video:
 442         release_region( card->iobase, card->length );
 443
 444 err_pci:
 445         kfree( card );
 446         return -ENODEV;
 447 }
 448
 449 static void __devexit gemtek_pci_remove( struct pci_dev *pci_dev )
 450 {
 451         struct gemtek_pci_card *card = pci_get_drvdata( pci_dev );
 452
 453         video_unregister_device( card->videodev );
 454         kfree( card->videodev );
 455
 456         release_region( card->iobase, card->length );
 457
 458         if ( mx )
 459                 gemtek_pci_mute( card );
 460
 461         kfree( card );
 462
 463         pci_set_drvdata( pci_dev, NULL );
 464 }
 465
 466 static struct pci_driver gemtek_pci_driver =
 467 {
 468         .name           = "gemtek_pci",
 469         .id_table       = gemtek_pci_id,
 470         .probe          = gemtek_pci_probe,
 471         .remove         = __devexit_p(gemtek_pci_remove),
 472 };
 473
 474 static int __init gemtek_pci_init_module( void )
 475 {
 476         return pci_register_driver( &gemtek_pci_driver );
 477 }
 478
 479 static void __exit gemtek_pci_cleanup_module( void )
 480 {
 481         pci_unregister_driver(&gemtek_pci_driver);
 482 }
 483
 484 MODULE_AUTHOR( "Vladimir Shebordaev <vshebordaev@mail.ru>" );
 485 MODULE_DESCRIPTION( "The video4linux driver for the Gemtek PCI Radio Card" );
 486 MODULE_LICENSE("GPL");
 487
 488 module_param(mx, bool, 0);
 489 MODULE_PARM_DESC( mx, "single digit: 1 - turn off the turner upon module exit (default), 0 - do not" );
 490 module_param(nr_radio, int, 0);
 491 MODULE_PARM_DESC( nr_radio, "video4linux device number to use");
 492
 493 module_init( gemtek_pci_init_module );
 494 module_exit( gemtek_pci_cleanup_module );
 495