182b433981ca69d97e65533279181785a01b38a7
[linux-2.6.git] / drivers / media / radio / radio-maestro.c
1 /* Maestro PCI sound card radio driver for Linux support
2  * (c) 2000 A. Tlalka, atlka@pg.gda.pl
3  * Notes on the hardware
4  *
5  *  + Frequency control is done digitally
6  *  + No volume control - only mute/unmute - you have to use Aux line volume
7  *  control on Maestro card to set the volume
8  *  + Radio status (tuned/not_tuned and stereo/mono) is valid some time after
9  *  frequency setting (>100ms) and only when the radio is unmuted.
10  *  version 0.02
11  *  + io port is automatically detected - only the first radio is used
12  *  version 0.03
13  *  + thread access locking additions
14  *  version 0.04
15  * + code improvements
16  * + VIDEO_TUNER_LOW is permanent
17  *
18  * Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@infradead.org>
19  */
20
21 #include <linux/module.h>
22 #include <linux/init.h>
23 #include <linux/ioport.h>
24 #include <linux/delay.h>
25 #include <asm/io.h>
26 #include <asm/uaccess.h>
27 #include <linux/pci.h>
28 #include <linux/videodev2.h>
29 #include <media/v4l2-common.h>
30 #include <media/v4l2-ioctl.h>
31
32 #include <linux/version.h>      /* for KERNEL_VERSION MACRO     */
33 #define RADIO_VERSION KERNEL_VERSION(0,0,6)
34 #define DRIVER_VERSION  "0.06"
35
36 static struct v4l2_queryctrl radio_qctrl[] = {
37         {
38                 .id            = V4L2_CID_AUDIO_MUTE,
39                 .name          = "Mute",
40                 .minimum       = 0,
41                 .maximum       = 1,
42                 .default_value = 1,
43                 .type          = V4L2_CTRL_TYPE_BOOLEAN,
44         }
45 };
46
47 #define GPIO_DATA       0x60   /* port offset from ESS_IO_BASE */
48
49 #define IO_MASK         4      /* mask      register offset from GPIO_DATA
50                                 bits 1=unmask write to given bit */
51 #define IO_DIR          8      /* direction register offset from GPIO_DATA
52                                 bits 0/1=read/write direction */
53
54 #define GPIO6           0x0040 /* mask bits for GPIO lines */
55 #define GPIO7           0x0080
56 #define GPIO8           0x0100
57 #define GPIO9           0x0200
58
59 #define STR_DATA        GPIO6  /* radio TEA5757 pins and GPIO bits */
60 #define STR_CLK         GPIO7
61 #define STR_WREN        GPIO8
62 #define STR_MOST        GPIO9
63
64 #define FREQ_LO          50*16000
65 #define FREQ_HI         150*16000
66
67 #define FREQ_IF         171200 /* 10.7*16000   */
68 #define FREQ_STEP       200    /* 12.5*16      */
69
70 #define FREQ2BITS(x)    ((((unsigned int)(x)+FREQ_IF+(FREQ_STEP<<1))\
71                         /(FREQ_STEP<<2))<<2) /* (x==fmhz*16*1000) -> bits */
72
73 #define BITS2FREQ(x)    ((x) * FREQ_STEP - FREQ_IF)
74
75 static int radio_nr = -1;
76 module_param(radio_nr, int, 0);
77
78 static unsigned long in_use;
79
80 static int maestro_probe(struct pci_dev *pdev, const struct pci_device_id *ent);
81
82 static int maestro_exclusive_open(struct inode *inode, struct file *file)
83 {
84         return test_and_set_bit(0, &in_use) ? -EBUSY : 0;
85 }
86
87 static int maestro_exclusive_release(struct inode *inode, struct file *file)
88 {
89         clear_bit(0, &in_use);
90         return 0;
91 }
92
93 static void maestro_remove(struct pci_dev *pdev);
94
95 static struct pci_device_id maestro_r_pci_tbl[] = {
96         { PCI_DEVICE(PCI_VENDOR_ID_ESS, PCI_DEVICE_ID_ESS_ESS1968),
97                 .class = PCI_CLASS_MULTIMEDIA_AUDIO << 8,
98                 .class_mask = 0xffff00 },
99         { PCI_DEVICE(PCI_VENDOR_ID_ESS, PCI_DEVICE_ID_ESS_ESS1978),
100                 .class = PCI_CLASS_MULTIMEDIA_AUDIO << 8,
101                 .class_mask = 0xffff00 },
102         { 0 }
103 };
104 MODULE_DEVICE_TABLE(pci, maestro_r_pci_tbl);
105
106 static struct pci_driver maestro_r_driver = {
107         .name           = "maestro_radio",
108         .id_table       = maestro_r_pci_tbl,
109         .probe          = maestro_probe,
110         .remove         = __devexit_p(maestro_remove),
111 };
112
113 static const struct file_operations maestro_fops = {
114         .owner          = THIS_MODULE,
115         .open           = maestro_exclusive_open,
116         .release        = maestro_exclusive_release,
117         .ioctl          = video_ioctl2,
118 #ifdef CONFIG_COMPAT
119         .compat_ioctl   = v4l_compat_ioctl32,
120 #endif
121         .llseek         = no_llseek,
122 };
123
124 struct radio_device {
125         u16     io,     /* base of Maestro card radio io (GPIO_DATA)*/
126                 muted,  /* VIDEO_AUDIO_MUTE */
127                 stereo, /* VIDEO_TUNER_STEREO_ON */
128                 tuned;  /* signal strength (0 or 0xffff) */
129 };
130
131 static u32 radio_bits_get(struct radio_device *dev)
132 {
133         register u16 io=dev->io, l, rdata;
134         register u32 data=0;
135         u16 omask;
136
137         omask = inw(io + IO_MASK);
138         outw(~(STR_CLK | STR_WREN), io + IO_MASK);
139         outw(0, io);
140         udelay(16);
141
142         for (l=24;l--;) {
143                 outw(STR_CLK, io);              /* HI state */
144                 udelay(2);
145                 if(!l)
146                         dev->tuned = inw(io) & STR_MOST ? 0 : 0xffff;
147                 outw(0, io);                    /* LO state */
148                 udelay(2);
149                 data <<= 1;                     /* shift data */
150                 rdata = inw(io);
151                 if(!l)
152                         dev->stereo =  rdata & STR_MOST ?
153                         0 : 1;
154                 else
155                         if(rdata & STR_DATA)
156                                 data++;
157                 udelay(2);
158         }
159
160         if(dev->muted)
161                 outw(STR_WREN, io);
162
163         udelay(4);
164         outw(omask, io + IO_MASK);
165
166         return data & 0x3ffe;
167 }
168
169 static void radio_bits_set(struct radio_device *dev, u32 data)
170 {
171         register u16 io=dev->io, l, bits;
172         u16 omask, odir;
173
174         omask = inw(io + IO_MASK);
175         odir  = (inw(io + IO_DIR) & ~STR_DATA) | (STR_CLK | STR_WREN);
176         outw(odir | STR_DATA, io + IO_DIR);
177         outw(~(STR_DATA | STR_CLK | STR_WREN), io + IO_MASK);
178         udelay(16);
179         for (l=25;l;l--) {
180                 bits = ((data >> 18) & STR_DATA) | STR_WREN ;
181                 data <<= 1;                     /* shift data */
182                 outw(bits, io);                 /* start strobe */
183                 udelay(2);
184                 outw(bits | STR_CLK, io);       /* HI level */
185                 udelay(2);
186                 outw(bits, io);                 /* LO level */
187                 udelay(4);
188         }
189
190         if(!dev->muted)
191                 outw(0, io);
192
193         udelay(4);
194         outw(omask, io + IO_MASK);
195         outw(odir, io + IO_DIR);
196         msleep(125);
197 }
198
199 static int vidioc_querycap(struct file *file, void  *priv,
200                                         struct v4l2_capability *v)
201 {
202         strlcpy(v->driver, "radio-maestro", sizeof(v->driver));
203         strlcpy(v->card, "Maestro Radio", sizeof(v->card));
204         sprintf(v->bus_info, "PCI");
205         v->version = RADIO_VERSION;
206         v->capabilities = V4L2_CAP_TUNER;
207         return 0;
208 }
209
210 static int vidioc_g_tuner(struct file *file, void *priv,
211                                         struct v4l2_tuner *v)
212 {
213         struct video_device *dev = video_devdata(file);
214         struct radio_device *card = video_get_drvdata(dev);
215
216         if (v->index > 0)
217                 return -EINVAL;
218
219         (void)radio_bits_get(card);
220
221         strcpy(v->name, "FM");
222         v->type = V4L2_TUNER_RADIO;
223         v->rangelow = FREQ_LO;
224         v->rangehigh = FREQ_HI;
225         v->rxsubchans = V4L2_TUNER_SUB_MONO|V4L2_TUNER_SUB_STEREO;
226         v->capability = V4L2_TUNER_CAP_LOW;
227         if(card->stereo)
228                 v->audmode = V4L2_TUNER_MODE_STEREO;
229         else
230                 v->audmode = V4L2_TUNER_MODE_MONO;
231         v->signal = card->tuned;
232         return 0;
233 }
234
235 static int vidioc_s_tuner(struct file *file, void *priv,
236                                         struct v4l2_tuner *v)
237 {
238         if (v->index > 0)
239                 return -EINVAL;
240         return 0;
241 }
242
243 static int vidioc_s_frequency(struct file *file, void *priv,
244                                         struct v4l2_frequency *f)
245 {
246         struct video_device *dev = video_devdata(file);
247         struct radio_device *card = video_get_drvdata(dev);
248
249         if (f->frequency < FREQ_LO || f->frequency > FREQ_HI)
250                 return -EINVAL;
251         radio_bits_set(card, FREQ2BITS(f->frequency));
252         return 0;
253 }
254
255 static int vidioc_g_frequency(struct file *file, void *priv,
256                                         struct v4l2_frequency *f)
257 {
258         struct video_device *dev = video_devdata(file);
259         struct radio_device *card = video_get_drvdata(dev);
260
261         f->type = V4L2_TUNER_RADIO;
262         f->frequency = BITS2FREQ(radio_bits_get(card));
263         return 0;
264 }
265
266 static int vidioc_queryctrl(struct file *file, void *priv,
267                                         struct v4l2_queryctrl *qc)
268 {
269         int i;
270
271         for (i = 0; i < ARRAY_SIZE(radio_qctrl); i++) {
272                 if (qc->id && qc->id == radio_qctrl[i].id) {
273                         memcpy(qc, &(radio_qctrl[i]),
274                                                 sizeof(*qc));
275                         return 0;
276                 }
277         }
278         return -EINVAL;
279 }
280
281 static int vidioc_g_ctrl(struct file *file, void *priv,
282                                         struct v4l2_control *ctrl)
283 {
284         struct video_device *dev = video_devdata(file);
285         struct radio_device *card = video_get_drvdata(dev);
286
287         switch (ctrl->id) {
288         case V4L2_CID_AUDIO_MUTE:
289                 ctrl->value = card->muted;
290                 return 0;
291         }
292         return -EINVAL;
293 }
294
295 static int vidioc_s_ctrl(struct file *file, void *priv,
296                                         struct v4l2_control *ctrl)
297 {
298         struct video_device *dev = video_devdata(file);
299         struct radio_device *card = video_get_drvdata(dev);
300         register u16 io = card->io;
301         register u16 omask = inw(io + IO_MASK);
302
303         switch (ctrl->id) {
304         case V4L2_CID_AUDIO_MUTE:
305                 outw(~STR_WREN, io + IO_MASK);
306                 outw((card->muted = ctrl->value ) ?
307                                 STR_WREN : 0, io);
308                 udelay(4);
309                 outw(omask, io + IO_MASK);
310                 msleep(125);
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 static u16 __devinit radio_power_on(struct radio_device *dev)
349 {
350         register u16 io = dev->io;
351         register u32 ofreq;
352         u16 omask, odir;
353
354         omask = inw(io + IO_MASK);
355         odir = (inw(io + IO_DIR) & ~STR_DATA) | (STR_CLK | STR_WREN);
356         outw(odir & ~STR_WREN, io + IO_DIR);
357         dev->muted = inw(io) & STR_WREN ? 0 : 1;
358         outw(odir, io + IO_DIR);
359         outw(~(STR_WREN | STR_CLK), io + IO_MASK);
360         outw(dev->muted ? 0 : STR_WREN, io);
361         udelay(16);
362         outw(omask, io + IO_MASK);
363         ofreq = radio_bits_get(dev);
364
365         if ((ofreq < FREQ2BITS(FREQ_LO)) || (ofreq > FREQ2BITS(FREQ_HI)))
366                 ofreq = FREQ2BITS(FREQ_LO);
367         radio_bits_set(dev, ofreq);
368
369         return (ofreq == radio_bits_get(dev));
370 }
371
372 static const struct v4l2_ioctl_ops maestro_ioctl_ops = {
373         .vidioc_querycap    = vidioc_querycap,
374         .vidioc_g_tuner     = vidioc_g_tuner,
375         .vidioc_s_tuner     = vidioc_s_tuner,
376         .vidioc_g_audio     = vidioc_g_audio,
377         .vidioc_s_audio     = vidioc_s_audio,
378         .vidioc_g_input     = vidioc_g_input,
379         .vidioc_s_input     = vidioc_s_input,
380         .vidioc_g_frequency = vidioc_g_frequency,
381         .vidioc_s_frequency = vidioc_s_frequency,
382         .vidioc_queryctrl   = vidioc_queryctrl,
383         .vidioc_g_ctrl      = vidioc_g_ctrl,
384         .vidioc_s_ctrl      = vidioc_s_ctrl,
385 };
386
387 static struct video_device maestro_radio = {
388         .name           = "Maestro radio",
389         .fops           = &maestro_fops,
390         .ioctl_ops      = &maestro_ioctl_ops,
391         .release        = video_device_release,
392 };
393
394 static int __devinit maestro_probe(struct pci_dev *pdev,
395         const struct pci_device_id *ent)
396 {
397         struct radio_device *radio_unit;
398         struct video_device *maestro_radio_inst;
399         int retval;
400
401         retval = pci_enable_device(pdev);
402         if (retval) {
403                 dev_err(&pdev->dev, "enabling pci device failed!\n");
404                 goto err;
405         }
406
407         retval = -ENOMEM;
408
409         radio_unit = kzalloc(sizeof(*radio_unit), GFP_KERNEL);
410         if (radio_unit == NULL) {
411                 dev_err(&pdev->dev, "not enough memory\n");
412                 goto err;
413         }
414
415         radio_unit->io = pci_resource_start(pdev, 0) + GPIO_DATA;
416
417         maestro_radio_inst = video_device_alloc();
418         if (maestro_radio_inst == NULL) {
419                 dev_err(&pdev->dev, "not enough memory\n");
420                 goto errfr;
421         }
422
423         memcpy(maestro_radio_inst, &maestro_radio, sizeof(maestro_radio));
424         video_set_drvdata(maestro_radio_inst, radio_unit);
425         pci_set_drvdata(pdev, maestro_radio_inst);
426
427         retval = video_register_device(maestro_radio_inst, VFL_TYPE_RADIO, radio_nr);
428         if (retval) {
429                 printk(KERN_ERR "can't register video device!\n");
430                 goto errfr1;
431         }
432
433         if (!radio_power_on(radio_unit)) {
434                 retval = -EIO;
435                 goto errunr;
436         }
437
438         dev_info(&pdev->dev, "version " DRIVER_VERSION " time " __TIME__ "  "
439                  __DATE__ "\n");
440         dev_info(&pdev->dev, "radio chip initialized\n");
441
442         return 0;
443 errunr:
444         video_unregister_device(maestro_radio_inst);
445 errfr1:
446         video_device_release(maestro_radio_inst);
447 errfr:
448         kfree(radio_unit);
449 err:
450         return retval;
451
452 }
453
454 static void __devexit maestro_remove(struct pci_dev *pdev)
455 {
456         struct video_device *vdev = pci_get_drvdata(pdev);
457
458         video_unregister_device(vdev);
459 }
460
461 static int __init maestro_radio_init(void)
462 {
463         int retval = pci_register_driver(&maestro_r_driver);
464
465         if (retval)
466                 printk(KERN_ERR "error during registration pci driver\n");
467
468         return retval;
469 }
470
471 static void __exit maestro_radio_exit(void)
472 {
473         pci_unregister_driver(&maestro_r_driver);
474 }
475
476 module_init(maestro_radio_init);
477 module_exit(maestro_radio_exit);
478
479 MODULE_AUTHOR("Adam Tlalka, atlka@pg.gda.pl");
480 MODULE_DESCRIPTION("Radio driver for the Maestro PCI sound card radio.");
481 MODULE_LICENSE("GPL");