Merge branch 'for-linus' of git://neil.brown.name/md
[linux-2.6] / drivers / media / radio / radio-maestro.c
CommitLineData
1da177e4
LT
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 *
4286c6f6 5 * + Frequency control is done digitally
1da177e4
LT
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
b6055d7b
MCC
17 *
18 * Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@infradead.org>
1da177e4
LT
19 */
20
21#include <linux/module.h>
22#include <linux/init.h>
23#include <linux/ioport.h>
24#include <linux/delay.h>
087c6184 25#include <linux/version.h> /* for KERNEL_VERSION MACRO */
1da177e4 26#include <linux/pci.h>
b6055d7b 27#include <linux/videodev2.h>
087c6184 28#include <linux/io.h>
087c6184 29#include <media/v4l2-device.h>
35ea11ff 30#include <media/v4l2-ioctl.h>
3593cab5 31
087c6184
HV
32MODULE_AUTHOR("Adam Tlalka, atlka@pg.gda.pl");
33MODULE_DESCRIPTION("Radio driver for the Maestro PCI sound card radio.");
34MODULE_LICENSE("GPL");
b6055d7b 35
087c6184
HV
36static int radio_nr = -1;
37module_param(radio_nr, int, 0);
38
39#define RADIO_VERSION KERNEL_VERSION(0, 0, 6)
40#define DRIVER_VERSION "0.06"
1da177e4 41
6a2cf8ee 42#define GPIO_DATA 0x60 /* port offset from ESS_IO_BASE */
1da177e4
LT
43
44#define IO_MASK 4 /* mask register offset from GPIO_DATA
45 bits 1=unmask write to given bit */
46#define IO_DIR 8 /* direction register offset from GPIO_DATA
47 bits 0/1=read/write direction */
48
6a2cf8ee
JS
49#define GPIO6 0x0040 /* mask bits for GPIO lines */
50#define GPIO7 0x0080
51#define GPIO8 0x0100
52#define GPIO9 0x0200
1da177e4 53
6a2cf8ee
JS
54#define STR_DATA GPIO6 /* radio TEA5757 pins and GPIO bits */
55#define STR_CLK GPIO7
56#define STR_WREN GPIO8
57#define STR_MOST GPIO9
1da177e4
LT
58
59#define FREQ_LO 50*16000
60#define FREQ_HI 150*16000
61
6a2cf8ee
JS
62#define FREQ_IF 171200 /* 10.7*16000 */
63#define FREQ_STEP 200 /* 12.5*16 */
1da177e4
LT
64
65#define FREQ2BITS(x) ((((unsigned int)(x)+FREQ_IF+(FREQ_STEP<<1))\
66 /(FREQ_STEP<<2))<<2) /* (x==fmhz*16*1000) -> bits */
67
68#define BITS2FREQ(x) ((x) * FREQ_STEP - FREQ_IF)
69
087c6184
HV
70struct maestro {
71 struct v4l2_device v4l2_dev;
72 struct video_device vdev;
73 struct pci_dev *pdev;
74 struct mutex lock;
1da177e4 75
087c6184
HV
76 u16 io; /* base of Maestro card radio io (GPIO_DATA)*/
77 u16 muted; /* VIDEO_AUDIO_MUTE */
78 u16 stereo; /* VIDEO_TUNER_STEREO_ON */
79 u16 tuned; /* signal strength (0 or 0xffff) */
80};
3ca685aa 81
087c6184 82static inline struct maestro *to_maestro(struct v4l2_device *v4l2_dev)
3ca685aa 83{
087c6184 84 return container_of(v4l2_dev, struct maestro, v4l2_dev);
3ca685aa
HV
85}
86
087c6184 87static u32 radio_bits_get(struct maestro *dev)
3ca685aa 88{
087c6184
HV
89 u16 io = dev->io, l, rdata;
90 u32 data = 0;
0eaa21fd 91 u16 omask;
6a2cf8ee 92
1da177e4
LT
93 omask = inw(io + IO_MASK);
94 outw(~(STR_CLK | STR_WREN), io + IO_MASK);
95 outw(0, io);
96 udelay(16);
97
087c6184 98 for (l = 24; l--;) {
1da177e4
LT
99 outw(STR_CLK, io); /* HI state */
100 udelay(2);
087c6184 101 if (!l)
1da177e4
LT
102 dev->tuned = inw(io) & STR_MOST ? 0 : 0xffff;
103 outw(0, io); /* LO state */
104 udelay(2);
105 data <<= 1; /* shift data */
106 rdata = inw(io);
087c6184
HV
107 if (!l)
108 dev->stereo = (rdata & STR_MOST) ? 0 : 1;
109 else if (rdata & STR_DATA)
110 data++;
1da177e4
LT
111 udelay(2);
112 }
6a2cf8ee 113
087c6184 114 if (dev->muted)
1da177e4 115 outw(STR_WREN, io);
6a2cf8ee 116
1da177e4
LT
117 udelay(4);
118 outw(omask, io + IO_MASK);
6a2cf8ee 119
1da177e4
LT
120 return data & 0x3ffe;
121}
122
087c6184 123static void radio_bits_set(struct maestro *dev, u32 data)
1da177e4 124{
087c6184 125 u16 io = dev->io, l, bits;
0eaa21fd 126 u16 omask, odir;
6a2cf8ee 127
1da177e4 128 omask = inw(io + IO_MASK);
087c6184 129 odir = (inw(io + IO_DIR) & ~STR_DATA) | (STR_CLK | STR_WREN);
1da177e4
LT
130 outw(odir | STR_DATA, io + IO_DIR);
131 outw(~(STR_DATA | STR_CLK | STR_WREN), io + IO_MASK);
132 udelay(16);
087c6184
HV
133 for (l = 25; l; l--) {
134 bits = ((data >> 18) & STR_DATA) | STR_WREN;
1da177e4
LT
135 data <<= 1; /* shift data */
136 outw(bits, io); /* start strobe */
137 udelay(2);
138 outw(bits | STR_CLK, io); /* HI level */
139 udelay(2);
140 outw(bits, io); /* LO level */
141 udelay(4);
142 }
6a2cf8ee 143
087c6184 144 if (!dev->muted)
1da177e4 145 outw(0, io);
6a2cf8ee 146
1da177e4
LT
147 udelay(4);
148 outw(omask, io + IO_MASK);
149 outw(odir, io + IO_DIR);
150 msleep(125);
151}
152
d455cf5d
DL
153static int vidioc_querycap(struct file *file, void *priv,
154 struct v4l2_capability *v)
155{
087c6184
HV
156 struct maestro *dev = video_drvdata(file);
157
d455cf5d
DL
158 strlcpy(v->driver, "radio-maestro", sizeof(v->driver));
159 strlcpy(v->card, "Maestro Radio", sizeof(v->card));
087c6184 160 snprintf(v->bus_info, sizeof(v->bus_info), "PCI:%s", pci_name(dev->pdev));
d455cf5d 161 v->version = RADIO_VERSION;
087c6184 162 v->capabilities = V4L2_CAP_TUNER | V4L2_CAP_RADIO;
d455cf5d
DL
163 return 0;
164}
165
166static int vidioc_g_tuner(struct file *file, void *priv,
167 struct v4l2_tuner *v)
1da177e4 168{
087c6184 169 struct maestro *dev = video_drvdata(file);
6a2cf8ee 170
d455cf5d
DL
171 if (v->index > 0)
172 return -EINVAL;
173
087c6184
HV
174 mutex_lock(&dev->lock);
175 radio_bits_get(dev);
d455cf5d 176
087c6184 177 strlcpy(v->name, "FM", sizeof(v->name));
d455cf5d
DL
178 v->type = V4L2_TUNER_RADIO;
179 v->rangelow = FREQ_LO;
180 v->rangehigh = FREQ_HI;
087c6184 181 v->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
d455cf5d 182 v->capability = V4L2_TUNER_CAP_LOW;
087c6184 183 if (dev->stereo)
d455cf5d
DL
184 v->audmode = V4L2_TUNER_MODE_STEREO;
185 else
186 v->audmode = V4L2_TUNER_MODE_MONO;
087c6184
HV
187 v->signal = dev->tuned;
188 mutex_unlock(&dev->lock);
d455cf5d
DL
189 return 0;
190}
b6055d7b 191
d455cf5d
DL
192static int vidioc_s_tuner(struct file *file, void *priv,
193 struct v4l2_tuner *v)
194{
087c6184 195 return v->index ? -EINVAL : 0;
d455cf5d 196}
b6055d7b 197
d455cf5d
DL
198static int vidioc_s_frequency(struct file *file, void *priv,
199 struct v4l2_frequency *f)
200{
087c6184 201 struct maestro *dev = video_drvdata(file);
b6055d7b 202
d455cf5d
DL
203 if (f->frequency < FREQ_LO || f->frequency > FREQ_HI)
204 return -EINVAL;
087c6184
HV
205 mutex_lock(&dev->lock);
206 radio_bits_set(dev, FREQ2BITS(f->frequency));
207 mutex_unlock(&dev->lock);
d455cf5d
DL
208 return 0;
209}
b6055d7b 210
d455cf5d
DL
211static int vidioc_g_frequency(struct file *file, void *priv,
212 struct v4l2_frequency *f)
213{
087c6184 214 struct maestro *dev = video_drvdata(file);
b6055d7b 215
d455cf5d 216 f->type = V4L2_TUNER_RADIO;
087c6184
HV
217 mutex_lock(&dev->lock);
218 f->frequency = BITS2FREQ(radio_bits_get(dev));
219 mutex_unlock(&dev->lock);
d455cf5d
DL
220 return 0;
221}
b6055d7b 222
d455cf5d
DL
223static int vidioc_queryctrl(struct file *file, void *priv,
224 struct v4l2_queryctrl *qc)
225{
087c6184
HV
226 switch (qc->id) {
227 case V4L2_CID_AUDIO_MUTE:
228 return v4l2_ctrl_query_fill(qc, 0, 1, 1, 1);
d455cf5d
DL
229 }
230 return -EINVAL;
231}
b6055d7b 232
d455cf5d
DL
233static int vidioc_g_ctrl(struct file *file, void *priv,
234 struct v4l2_control *ctrl)
235{
087c6184 236 struct maestro *dev = video_drvdata(file);
b6055d7b 237
d455cf5d
DL
238 switch (ctrl->id) {
239 case V4L2_CID_AUDIO_MUTE:
087c6184 240 ctrl->value = dev->muted;
d455cf5d 241 return 0;
1da177e4 242 }
d455cf5d 243 return -EINVAL;
1da177e4
LT
244}
245
d455cf5d
DL
246static int vidioc_s_ctrl(struct file *file, void *priv,
247 struct v4l2_control *ctrl)
1da177e4 248{
087c6184
HV
249 struct maestro *dev = video_drvdata(file);
250 u16 io = dev->io;
251 u16 omask;
d455cf5d
DL
252
253 switch (ctrl->id) {
254 case V4L2_CID_AUDIO_MUTE:
087c6184
HV
255 mutex_lock(&dev->lock);
256 omask = inw(io + IO_MASK);
d455cf5d 257 outw(~STR_WREN, io + IO_MASK);
087c6184
HV
258 dev->muted = ctrl->value;
259 outw(dev->muted ? STR_WREN : 0, io);
d455cf5d
DL
260 udelay(4);
261 outw(omask, io + IO_MASK);
262 msleep(125);
087c6184 263 mutex_unlock(&dev->lock);
d455cf5d
DL
264 return 0;
265 }
266 return -EINVAL;
267}
1da177e4 268
087c6184
HV
269static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
270{
271 *i = 0;
272 return 0;
273}
274
275static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
276{
277 return i ? -EINVAL : 0;
278}
279
d455cf5d
DL
280static int vidioc_g_audio(struct file *file, void *priv,
281 struct v4l2_audio *a)
282{
087c6184
HV
283 a->index = 0;
284 strlcpy(a->name, "Radio", sizeof(a->name));
d455cf5d
DL
285 a->capability = V4L2_AUDCAP_STEREO;
286 return 0;
287}
6a2cf8ee 288
087c6184
HV
289static int vidioc_s_audio(struct file *file, void *priv,
290 struct v4l2_audio *a)
d455cf5d 291{
087c6184 292 return a->index ? -EINVAL : 0;
d455cf5d
DL
293}
294
087c6184
HV
295static const struct v4l2_file_operations maestro_fops = {
296 .owner = THIS_MODULE,
087c6184
HV
297 .ioctl = video_ioctl2,
298};
299
300static const struct v4l2_ioctl_ops maestro_ioctl_ops = {
301 .vidioc_querycap = vidioc_querycap,
302 .vidioc_g_tuner = vidioc_g_tuner,
303 .vidioc_s_tuner = vidioc_s_tuner,
304 .vidioc_g_audio = vidioc_g_audio,
305 .vidioc_s_audio = vidioc_s_audio,
306 .vidioc_g_input = vidioc_g_input,
307 .vidioc_s_input = vidioc_s_input,
308 .vidioc_g_frequency = vidioc_g_frequency,
309 .vidioc_s_frequency = vidioc_s_frequency,
310 .vidioc_queryctrl = vidioc_queryctrl,
311 .vidioc_g_ctrl = vidioc_g_ctrl,
312 .vidioc_s_ctrl = vidioc_s_ctrl,
313};
314
315static u16 __devinit radio_power_on(struct maestro *dev)
1da177e4 316{
0eaa21fd
JS
317 register u16 io = dev->io;
318 register u32 ofreq;
319 u16 omask, odir;
6a2cf8ee 320
1da177e4 321 omask = inw(io + IO_MASK);
6a2cf8ee 322 odir = (inw(io + IO_DIR) & ~STR_DATA) | (STR_CLK | STR_WREN);
1da177e4 323 outw(odir & ~STR_WREN, io + IO_DIR);
b6055d7b 324 dev->muted = inw(io) & STR_WREN ? 0 : 1;
1da177e4
LT
325 outw(odir, io + IO_DIR);
326 outw(~(STR_WREN | STR_CLK), io + IO_MASK);
327 outw(dev->muted ? 0 : STR_WREN, io);
328 udelay(16);
329 outw(omask, io + IO_MASK);
330 ofreq = radio_bits_get(dev);
6a2cf8ee
JS
331
332 if ((ofreq < FREQ2BITS(FREQ_LO)) || (ofreq > FREQ2BITS(FREQ_HI)))
1da177e4
LT
333 ofreq = FREQ2BITS(FREQ_LO);
334 radio_bits_set(dev, ofreq);
6a2cf8ee 335
1da177e4
LT
336 return (ofreq == radio_bits_get(dev));
337}
338
89dad8f0
JS
339static int __devinit maestro_probe(struct pci_dev *pdev,
340 const struct pci_device_id *ent)
1da177e4 341{
087c6184
HV
342 struct maestro *dev;
343 struct v4l2_device *v4l2_dev;
89dad8f0
JS
344 int retval;
345
346 retval = pci_enable_device(pdev);
347 if (retval) {
348 dev_err(&pdev->dev, "enabling pci device failed!\n");
349 goto err;
350 }
351
352 retval = -ENOMEM;
353
087c6184
HV
354 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
355 if (dev == NULL) {
89dad8f0
JS
356 dev_err(&pdev->dev, "not enough memory\n");
357 goto err;
358 }
359
087c6184
HV
360 v4l2_dev = &dev->v4l2_dev;
361 mutex_init(&dev->lock);
362 dev->pdev = pdev;
89dad8f0 363
087c6184
HV
364 strlcpy(v4l2_dev->name, "maestro", sizeof(v4l2_dev->name));
365
366 retval = v4l2_device_register(&pdev->dev, v4l2_dev);
367 if (retval < 0) {
368 v4l2_err(v4l2_dev, "Could not register v4l2_device\n");
89dad8f0
JS
369 goto errfr;
370 }
371
087c6184 372 dev->io = pci_resource_start(pdev, 0) + GPIO_DATA;
89dad8f0 373
087c6184
HV
374 strlcpy(dev->vdev.name, v4l2_dev->name, sizeof(dev->vdev.name));
375 dev->vdev.v4l2_dev = v4l2_dev;
376 dev->vdev.fops = &maestro_fops;
377 dev->vdev.ioctl_ops = &maestro_ioctl_ops;
378 dev->vdev.release = video_device_release_empty;
379 video_set_drvdata(&dev->vdev, dev);
380
381 retval = video_register_device(&dev->vdev, VFL_TYPE_RADIO, radio_nr);
89dad8f0 382 if (retval) {
087c6184 383 v4l2_err(v4l2_dev, "can't register video device!\n");
89dad8f0
JS
384 goto errfr1;
385 }
386
087c6184 387 if (!radio_power_on(dev)) {
89dad8f0
JS
388 retval = -EIO;
389 goto errunr;
390 }
391
087c6184 392 v4l2_info(v4l2_dev, "version " DRIVER_VERSION "\n");
89dad8f0
JS
393
394 return 0;
395errunr:
087c6184 396 video_unregister_device(&dev->vdev);
89dad8f0 397errfr1:
087c6184 398 v4l2_device_unregister(v4l2_dev);
89dad8f0 399errfr:
087c6184 400 kfree(dev);
89dad8f0
JS
401err:
402 return retval;
403
404}
405
406static void __devexit maestro_remove(struct pci_dev *pdev)
407{
087c6184
HV
408 struct v4l2_device *v4l2_dev = dev_get_drvdata(&pdev->dev);
409 struct maestro *dev = to_maestro(v4l2_dev);
89dad8f0 410
087c6184
HV
411 video_unregister_device(&dev->vdev);
412 v4l2_device_unregister(&dev->v4l2_dev);
1da177e4
LT
413}
414
087c6184
HV
415static struct pci_device_id maestro_r_pci_tbl[] = {
416 { PCI_DEVICE(PCI_VENDOR_ID_ESS, PCI_DEVICE_ID_ESS_ESS1968),
417 .class = PCI_CLASS_MULTIMEDIA_AUDIO << 8,
418 .class_mask = 0xffff00 },
419 { PCI_DEVICE(PCI_VENDOR_ID_ESS, PCI_DEVICE_ID_ESS_ESS1978),
420 .class = PCI_CLASS_MULTIMEDIA_AUDIO << 8,
421 .class_mask = 0xffff00 },
422 { 0 }
423};
424MODULE_DEVICE_TABLE(pci, maestro_r_pci_tbl);
425
426static struct pci_driver maestro_r_driver = {
427 .name = "maestro_radio",
428 .id_table = maestro_r_pci_tbl,
429 .probe = maestro_probe,
430 .remove = __devexit_p(maestro_remove),
431};
432
89dad8f0
JS
433static int __init maestro_radio_init(void)
434{
435 int retval = pci_register_driver(&maestro_r_driver);
436
437 if (retval)
438 printk(KERN_ERR "error during registration pci driver\n");
439
440 return retval;
441}
442
443static void __exit maestro_radio_exit(void)
444{
445 pci_unregister_driver(&maestro_r_driver);
446}
447
448module_init(maestro_radio_init);
449module_exit(maestro_radio_exit);