b96fafe1f9da21407c647aab4862caf87f3e64ee
[linux-2.6.git] / 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 <asm/io.h>             /* outb, outb_p                 */
22 #include <asm/uaccess.h>        /* copy to/from user            */
23 #include <linux/videodev2.h>    /* kernel radio structs         */
24 #include <media/v4l2-common.h>
25 #include <linux/mutex.h>
26
27 static struct mutex lock;
28
29 #include <linux/version.h>      /* for KERNEL_VERSION MACRO     */
30 #define RADIO_VERSION KERNEL_VERSION(0,0,2)
31
32 static struct v4l2_queryctrl radio_qctrl[] = {
33         {
34                 .id            = V4L2_CID_AUDIO_MUTE,
35                 .name          = "Mute",
36                 .minimum       = 0,
37                 .maximum       = 1,
38                 .default_value = 1,
39                 .type          = V4L2_CTRL_TYPE_BOOLEAN,
40         },{
41                 .id            = V4L2_CID_AUDIO_VOLUME,
42                 .name          = "Volume",
43                 .minimum       = 0,
44                 .maximum       = 65535,
45                 .step          = 1<<12,
46                 .default_value = 0xff,
47                 .type          = V4L2_CTRL_TYPE_INTEGER,
48         }
49 };
50
51 #undef DEBUG
52 //#define DEBUG 1
53
54 #ifdef DEBUG
55 # define  debug_print(s) printk s
56 #else
57 # define  debug_print(s)
58 #endif
59
60 /* this should be static vars for module size */
61 struct fmr2_device
62 {
63         int port;
64         int curvol; /* 0-65535, if not volume 0 or 65535 */
65         int mute;
66         int stereo; /* card is producing stereo audio */
67         unsigned long curfreq; /* freq in kHz */
68         int card_type;
69         __u32 flags;
70 };
71
72 static int io = 0x384;
73 static int radio_nr = -1;
74
75 /* hw precision is 12.5 kHz
76  * It is only useful to give freq in intervall of 200 (=0.0125Mhz),
77  * other bits will be truncated
78  */
79 #define RSF16_ENCODE(x) ((x)/200+856)
80 #define RSF16_MINFREQ 87*16000
81 #define RSF16_MAXFREQ 108*16000
82
83 static inline void wait(int n,int port)
84 {
85         for (;n;--n) inb(port);
86 }
87
88 static void outbits(int bits, unsigned int data, int nWait, int port)
89 {
90         int bit;
91         for(;--bits>=0;) {
92                 bit = (data>>bits) & 1;
93                 outb(bit,port);
94                 wait(nWait,port);
95                 outb(bit|2,port);
96                 wait(nWait,port);
97                 outb(bit,port);
98                 wait(nWait,port);
99         }
100 }
101
102 static inline void fmr2_mute(int port)
103 {
104         outb(0x00, port);
105         wait(4,port);
106 }
107
108 static inline void fmr2_unmute(int port)
109 {
110         outb(0x04, port);
111         wait(4,port);
112 }
113
114 static inline int fmr2_stereo_mode(int port)
115 {
116         int n = inb(port);
117         outb(6,port);
118         inb(port);
119         n = ((n>>3)&1)^1;
120         debug_print((KERN_DEBUG "stereo: %d\n", n));
121         return n;
122 }
123
124 static int fmr2_product_info(struct fmr2_device *dev)
125 {
126         int n = inb(dev->port);
127         n &= 0xC1;
128         if (n == 0)
129         {
130                 /* this should support volume set */
131                 dev->card_type = 12;
132                 return 0;
133         }
134         /* not volume (mine is 11) */
135         dev->card_type = (n==128)?11:0;
136         return n;
137 }
138
139 static inline int fmr2_getsigstr(struct fmr2_device *dev)
140 {
141         /* !!! work only if scanning freq */
142         int port = dev->port, res = 0xffff;
143         outb(5,port);
144         wait(4,port);
145         if (!(inb(port)&1)) 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_device *dev)
152 {
153         int port = dev->port;
154         unsigned long freq = dev->curfreq;
155
156         fmr2_mute(port);
157
158         /* 0x42 for mono output
159          * 0x102 forward scanning
160          * 0x182 scansione avanti
161          */
162         outbits(9,0x2,3,port);
163         outbits(16,RSF16_ENCODE(freq),2,port);
164
165         fmr2_unmute(port);
166
167         /* wait 0.11 sec */
168         msleep(110);
169
170         /* NOTE if mute this stop radio
171            you must set freq on unmute */
172         dev->stereo = fmr2_stereo_mode(port);
173         return 0;
174 }
175
176 /* !!! not tested, in my card this does't work !!! */
177 static int fmr2_setvolume(struct fmr2_device *dev)
178 {
179         int i,a,n, port = dev->port;
180
181         if (dev->card_type != 11) return 1;
182
183         switch( (dev->curvol+(1<<11)) >> 12 )
184         {
185         case 0: case 1: n = 0x21; break;
186         case 2: n = 0x84; break;
187         case 3: n = 0x90; break;
188         case 4: n = 0x104; break;
189         case 5: n = 0x110; break;
190         case 6: n = 0x204; break;
191         case 7: n = 0x210; break;
192         case 8: n = 0x402; break;
193         case 9: n = 0x404; break;
194         default:
195         case 10: n = 0x408; break;
196         case 11: n = 0x410; break;
197         case 12: n = 0x801; break;
198         case 13: n = 0x802; break;
199         case 14: n = 0x804; break;
200         case 15: n = 0x808; break;
201         case 16: n = 0x810; break;
202         }
203         for(i=12;--i>=0;)
204         {
205                 a = ((n >> i) & 1) << 6; /* if (a=0) a= 0; else a= 0x40; */
206                 outb(a|4, port);
207                 wait(4,port);
208                 outb(a|0x24, port);
209                 wait(4,port);
210                 outb(a|4, port);
211                 wait(4,port);
212         }
213         for(i=6;--i>=0;)
214         {
215                 a = ((0x18 >> i) & 1) << 6;
216                 outb(a|4, port);
217                 wait(4,port);
218                 outb(a|0x24, port);
219                 wait(4,port);
220                 outb(a|4, port);
221                 wait(4,port);
222         }
223         wait(4,port);
224         outb(0x14, port);
225
226         return 0;
227 }
228
229 static int fmr2_do_ioctl(struct inode *inode, struct file *file,
230                       unsigned int cmd, void *arg)
231 {
232         struct video_device *dev = video_devdata(file);
233         struct fmr2_device *fmr2 = dev->priv;
234         debug_print((KERN_DEBUG "freq %ld flags %d vol %d mute %d "
235                 "stereo %d type %d\n",
236                 fmr2->curfreq, fmr2->flags, fmr2->curvol, fmr2->mute,
237                 fmr2->stereo, fmr2->card_type));
238
239         switch(cmd)
240         {
241                 case VIDIOC_QUERYCAP:
242                 {
243                         struct v4l2_capability *v = arg;
244                         memset(v,0,sizeof(*v));
245                         strlcpy(v->driver, "radio-sf16fmr2", sizeof (v->driver));
246                         strlcpy(v->card, "SF16-FMR2 radio", sizeof (v->card));
247                         sprintf(v->bus_info,"ISA");
248                         v->version = RADIO_VERSION;
249                         v->capabilities = V4L2_CAP_TUNER;
250
251                         return 0;
252                 }
253                 case VIDIOC_G_TUNER:
254                 {
255                         struct v4l2_tuner *v = arg;
256                         int mult;
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                         mult = (fmr2->flags & V4L2_TUNER_CAP_LOW) ? 1 : 1000;
266                         v->rangelow = RSF16_MINFREQ/mult;
267                         v->rangehigh = RSF16_MAXFREQ/mult;
268                         v->rxsubchans =V4L2_TUNER_SUB_MONO | V4L2_TUNER_MODE_STEREO;
269                         v->capability=fmr2->flags&V4L2_TUNER_CAP_LOW;
270
271                         v->audmode = fmr2->stereo ? V4L2_TUNER_MODE_STEREO:
272                                                     V4L2_TUNER_MODE_MONO;
273                         mutex_lock(&lock);
274                         v->signal = fmr2_getsigstr(fmr2);
275                         mutex_unlock(&lock);
276
277                         return 0;
278                 }
279                 case VIDIOC_S_TUNER:
280                 {
281                         struct v4l2_tuner *v = arg;
282
283                         if (v->index > 0)
284                                 return -EINVAL;
285
286                         return 0;
287                 }
288                 case VIDIOC_S_FREQUENCY:
289                 {
290                         struct v4l2_frequency *f = arg;
291
292                         if (!(fmr2->flags & V4L2_TUNER_CAP_LOW))
293                                 f->frequency *= 1000;
294                         if (f->frequency < RSF16_MINFREQ ||
295                                         f->frequency > RSF16_MAXFREQ )
296                                 return -EINVAL;
297                         /*rounding in steps of 200 to match th freq
298                           that will be used */
299                         fmr2->curfreq = (f->frequency/200)*200;
300
301                         /* set card freq (if not muted) */
302                         if (fmr2->curvol && !fmr2->mute)
303                         {
304                                 mutex_lock(&lock);
305                                 fmr2_setfreq(fmr2);
306                                 mutex_unlock(&lock);
307                         }
308
309                         return 0;
310                 }
311                 case VIDIOC_G_FREQUENCY:
312                 {
313                         struct v4l2_frequency *f = arg;
314
315                         f->type = V4L2_TUNER_RADIO;
316                         f->frequency = fmr2->curfreq;
317                         if (!(fmr2->flags & V4L2_TUNER_CAP_LOW))
318                                 f->frequency /= 1000;
319
320                         return 0;
321                 }
322                 case VIDIOC_QUERYCTRL:
323                 {
324                         struct v4l2_queryctrl *qc = arg;
325                         int i;
326
327                         for (i = 0; i < ARRAY_SIZE(radio_qctrl); i++) {
328                                 if ((fmr2->card_type != 11)
329                                                 && V4L2_CID_AUDIO_VOLUME)
330                                         radio_qctrl[i].step=65535;
331                                 if (qc->id && qc->id == radio_qctrl[i].id) {
332                                         memcpy(qc, &(radio_qctrl[i]),
333                                                                 sizeof(*qc));
334                                         return (0);
335                                 }
336                         }
337                         return -EINVAL;
338                 }
339                 case VIDIOC_G_CTRL:
340                 {
341                         struct v4l2_control *ctrl= arg;
342
343                         switch (ctrl->id) {
344                                 case V4L2_CID_AUDIO_MUTE:
345                                         ctrl->value=fmr2->mute;
346                                         return (0);
347                                 case V4L2_CID_AUDIO_VOLUME:
348                                         ctrl->value=fmr2->curvol;
349                                         return (0);
350                         }
351                         return -EINVAL;
352                 }
353                 case VIDIOC_S_CTRL:
354                 {
355                         struct v4l2_control *ctrl= arg;
356
357                         switch (ctrl->id) {
358                                 case V4L2_CID_AUDIO_MUTE:
359                                         fmr2->mute=ctrl->value;
360                                         if (fmr2->card_type != 11) {
361                                                 if (!fmr2->mute) {
362                                                         fmr2->curvol = 65535;
363                                                 } else {
364                                                         fmr2->curvol = 0;
365                                                 }
366                                         }
367                                         break;
368                                 case V4L2_CID_AUDIO_VOLUME:
369                                         fmr2->curvol = ctrl->value;
370                                         if (fmr2->card_type != 11) {
371                                                 if (fmr2->curvol) {
372                                                         fmr2->curvol = 65535;
373                                                         fmr2->mute = 0;
374                                                 } else {
375                                                         fmr2->curvol = 0;
376                                                         fmr2->mute = 1;
377                                                 }
378                                         }
379                                         break;
380                                 default:
381                                         return -EINVAL;
382                         }
383 #ifdef DEBUG
384                         if (fmr2->curvol && !fmr2->mute)
385                                 printk(KERN_DEBUG "unmute\n");
386                         else
387                                 printk(KERN_DEBUG "mute\n");
388 #endif
389                         mutex_lock(&lock);
390                         if (fmr2->curvol && !fmr2->mute) {
391                                 fmr2_setvolume(fmr2);
392                                 fmr2_setfreq(fmr2);
393                         } else
394                                 fmr2_mute(fmr2->port);
395                         mutex_unlock(&lock);
396                         return (0);
397                 }
398                 default:
399                         return v4l_compat_translate_ioctl(inode,file,cmd,arg,
400                                                           fmr2_do_ioctl);
401
402         }
403 }
404
405 static int fmr2_ioctl(struct inode *inode, struct file *file,
406                       unsigned int cmd, unsigned long arg)
407  {
408         return video_usercopy(inode, file, cmd, arg, fmr2_do_ioctl);
409 }
410
411 static struct fmr2_device fmr2_unit;
412
413 static const struct file_operations fmr2_fops = {
414         .owner          = THIS_MODULE,
415         .open           = video_exclusive_open,
416         .release        = video_exclusive_release,
417         .ioctl          = fmr2_ioctl,
418         .compat_ioctl   = v4l_compat_ioctl32,
419         .llseek         = no_llseek,
420 };
421
422 static struct video_device fmr2_radio=
423 {
424         .owner          = THIS_MODULE,
425         .name           = "SF16FMR2 radio",
426         . type          = VID_TYPE_TUNER,
427         .hardware       = 0,
428         .fops           = &fmr2_fops,
429 };
430
431 static int __init fmr2_init(void)
432 {
433         fmr2_unit.port = io;
434         fmr2_unit.curvol = 0;
435         fmr2_unit.mute = 0;
436         fmr2_unit.curfreq = 0;
437         fmr2_unit.stereo = 1;
438         fmr2_unit.flags = V4L2_TUNER_CAP_LOW;
439         fmr2_unit.card_type = 0;
440         fmr2_radio.priv = &fmr2_unit;
441
442         mutex_init(&lock);
443
444         if (request_region(io, 2, "sf16fmr2"))
445         {
446                 printk(KERN_ERR "fmr2: port 0x%x already in use\n", io);
447                 return -EBUSY;
448         }
449
450         if(video_register_device(&fmr2_radio, VFL_TYPE_RADIO, radio_nr)==-1)
451         {
452                 release_region(io, 2);
453                 return -EINVAL;
454         }
455
456         printk(KERN_INFO "SF16FMR2 radio card driver at 0x%x.\n", io);
457         /* mute card - prevents noisy bootups */
458         mutex_lock(&lock);
459         fmr2_mute(io);
460         fmr2_product_info(&fmr2_unit);
461         mutex_unlock(&lock);
462         debug_print((KERN_DEBUG "card_type %d\n", fmr2_unit.card_type));
463         return 0;
464 }
465
466 MODULE_AUTHOR("Ziglio Frediano, freddy77@angelfire.com");
467 MODULE_DESCRIPTION("A driver for the SF16FMR2 radio.");
468 MODULE_LICENSE("GPL");
469
470 module_param(io, int, 0);
471 MODULE_PARM_DESC(io, "I/O address of the SF16FMR2 card (should be 0x384, if do not work try 0x284)");
472 module_param(radio_nr, int, 0);
473
474 static void __exit fmr2_cleanup_module(void)
475 {
476         video_unregister_device(&fmr2_radio);
477         release_region(io,2);
478 }
479
480 module_init(fmr2_init);
481 module_exit(fmr2_cleanup_module);
482
483 #ifndef MODULE
484
485 static int __init fmr2_setup_io(char *str)
486 {
487         get_option(&str, &io);
488         return 1;
489 }
490
491 __setup("sf16fmr2=", fmr2_setup_io);
492
493 #endif