1 /* Maestro PCI sound card radio driver for Linux support
2 * (c) 2000 A. Tlalka, atlka@pg.gda.pl
3 * Notes on the hardware
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.
11 * + io port is automatically detected - only the first radio is used
13 * + thread access locking additions
16 * + VIDEO_TUNER_LOW is permanent
18 * Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@infradead.org>
21 #include <linux/module.h>
22 #include <linux/init.h>
23 #include <linux/ioport.h>
24 #include <linux/delay.h>
25 #include <linux/version.h> /* for KERNEL_VERSION MACRO */
26 #include <linux/pci.h>
27 #include <linux/videodev2.h>
29 #include <media/v4l2-device.h>
30 #include <media/v4l2-ioctl.h>
32 MODULE_AUTHOR("Adam Tlalka, atlka@pg.gda.pl");
33 MODULE_DESCRIPTION("Radio driver for the Maestro PCI sound card radio.");
34 MODULE_LICENSE("GPL");
36 static int radio_nr = -1;
37 module_param(radio_nr, int, 0);
39 #define RADIO_VERSION KERNEL_VERSION(0, 0, 6)
40 #define DRIVER_VERSION "0.06"
42 #define GPIO_DATA 0x60 /* port offset from ESS_IO_BASE */
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 */
49 #define GPIO6 0x0040 /* mask bits for GPIO lines */
54 #define STR_DATA GPIO6 /* radio TEA5757 pins and GPIO bits */
56 #define STR_WREN GPIO8
57 #define STR_MOST GPIO9
59 #define FREQ_LO 50*16000
60 #define FREQ_HI 150*16000
62 #define FREQ_IF 171200 /* 10.7*16000 */
63 #define FREQ_STEP 200 /* 12.5*16 */
65 #define FREQ2BITS(x) ((((unsigned int)(x)+FREQ_IF+(FREQ_STEP<<1))\
66 /(FREQ_STEP<<2))<<2) /* (x==fmhz*16*1000) -> bits */
68 #define BITS2FREQ(x) ((x) * FREQ_STEP - FREQ_IF)
71 struct v4l2_device v4l2_dev;
72 struct video_device vdev;
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) */
82 static inline struct maestro *to_maestro(struct v4l2_device *v4l2_dev)
84 return container_of(v4l2_dev, struct maestro, v4l2_dev);
87 static u32 radio_bits_get(struct maestro *dev)
89 u16 io = dev->io, l, rdata;
93 omask = inw(io + IO_MASK);
94 outw(~(STR_CLK | STR_WREN), io + IO_MASK);
99 outw(STR_CLK, io); /* HI state */
102 dev->tuned = inw(io) & STR_MOST ? 0 : 0xffff;
103 outw(0, io); /* LO state */
105 data <<= 1; /* shift data */
108 dev->stereo = (rdata & STR_MOST) ? 0 : 1;
109 else if (rdata & STR_DATA)
118 outw(omask, io + IO_MASK);
120 return data & 0x3ffe;
123 static void radio_bits_set(struct maestro *dev, u32 data)
125 u16 io = dev->io, l, bits;
128 omask = inw(io + IO_MASK);
129 odir = (inw(io + IO_DIR) & ~STR_DATA) | (STR_CLK | STR_WREN);
130 outw(odir | STR_DATA, io + IO_DIR);
131 outw(~(STR_DATA | STR_CLK | STR_WREN), io + IO_MASK);
133 for (l = 25; l; l--) {
134 bits = ((data >> 18) & STR_DATA) | STR_WREN;
135 data <<= 1; /* shift data */
136 outw(bits, io); /* start strobe */
138 outw(bits | STR_CLK, io); /* HI level */
140 outw(bits, io); /* LO level */
148 outw(omask, io + IO_MASK);
149 outw(odir, io + IO_DIR);
153 static int vidioc_querycap(struct file *file, void *priv,
154 struct v4l2_capability *v)
156 struct maestro *dev = video_drvdata(file);
158 strlcpy(v->driver, "radio-maestro", sizeof(v->driver));
159 strlcpy(v->card, "Maestro Radio", sizeof(v->card));
160 snprintf(v->bus_info, sizeof(v->bus_info), "PCI:%s", pci_name(dev->pdev));
161 v->version = RADIO_VERSION;
162 v->capabilities = V4L2_CAP_TUNER | V4L2_CAP_RADIO;
166 static int vidioc_g_tuner(struct file *file, void *priv,
167 struct v4l2_tuner *v)
169 struct maestro *dev = video_drvdata(file);
174 mutex_lock(&dev->lock);
177 strlcpy(v->name, "FM", sizeof(v->name));
178 v->type = V4L2_TUNER_RADIO;
179 v->rangelow = FREQ_LO;
180 v->rangehigh = FREQ_HI;
181 v->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
182 v->capability = V4L2_TUNER_CAP_LOW;
184 v->audmode = V4L2_TUNER_MODE_STEREO;
186 v->audmode = V4L2_TUNER_MODE_MONO;
187 v->signal = dev->tuned;
188 mutex_unlock(&dev->lock);
192 static int vidioc_s_tuner(struct file *file, void *priv,
193 struct v4l2_tuner *v)
195 return v->index ? -EINVAL : 0;
198 static int vidioc_s_frequency(struct file *file, void *priv,
199 struct v4l2_frequency *f)
201 struct maestro *dev = video_drvdata(file);
203 if (f->frequency < FREQ_LO || f->frequency > FREQ_HI)
205 mutex_lock(&dev->lock);
206 radio_bits_set(dev, FREQ2BITS(f->frequency));
207 mutex_unlock(&dev->lock);
211 static int vidioc_g_frequency(struct file *file, void *priv,
212 struct v4l2_frequency *f)
214 struct maestro *dev = video_drvdata(file);
216 f->type = V4L2_TUNER_RADIO;
217 mutex_lock(&dev->lock);
218 f->frequency = BITS2FREQ(radio_bits_get(dev));
219 mutex_unlock(&dev->lock);
223 static int vidioc_queryctrl(struct file *file, void *priv,
224 struct v4l2_queryctrl *qc)
227 case V4L2_CID_AUDIO_MUTE:
228 return v4l2_ctrl_query_fill(qc, 0, 1, 1, 1);
233 static int vidioc_g_ctrl(struct file *file, void *priv,
234 struct v4l2_control *ctrl)
236 struct maestro *dev = video_drvdata(file);
239 case V4L2_CID_AUDIO_MUTE:
240 ctrl->value = dev->muted;
246 static int vidioc_s_ctrl(struct file *file, void *priv,
247 struct v4l2_control *ctrl)
249 struct maestro *dev = video_drvdata(file);
254 case V4L2_CID_AUDIO_MUTE:
255 mutex_lock(&dev->lock);
256 omask = inw(io + IO_MASK);
257 outw(~STR_WREN, io + IO_MASK);
258 dev->muted = ctrl->value;
259 outw(dev->muted ? STR_WREN : 0, io);
261 outw(omask, io + IO_MASK);
263 mutex_unlock(&dev->lock);
269 static int vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
275 static int vidioc_s_input(struct file *filp, void *priv, unsigned int i)
277 return i ? -EINVAL : 0;
280 static int vidioc_g_audio(struct file *file, void *priv,
281 struct v4l2_audio *a)
284 strlcpy(a->name, "Radio", sizeof(a->name));
285 a->capability = V4L2_AUDCAP_STEREO;
289 static int vidioc_s_audio(struct file *file, void *priv,
290 struct v4l2_audio *a)
292 return a->index ? -EINVAL : 0;
295 static int maestro_open(struct file *file)
300 static int maestro_release(struct file *file)
305 static const struct v4l2_file_operations maestro_fops = {
306 .owner = THIS_MODULE,
307 .open = maestro_open,
308 .release = maestro_release,
309 .ioctl = video_ioctl2,
312 static const struct v4l2_ioctl_ops maestro_ioctl_ops = {
313 .vidioc_querycap = vidioc_querycap,
314 .vidioc_g_tuner = vidioc_g_tuner,
315 .vidioc_s_tuner = vidioc_s_tuner,
316 .vidioc_g_audio = vidioc_g_audio,
317 .vidioc_s_audio = vidioc_s_audio,
318 .vidioc_g_input = vidioc_g_input,
319 .vidioc_s_input = vidioc_s_input,
320 .vidioc_g_frequency = vidioc_g_frequency,
321 .vidioc_s_frequency = vidioc_s_frequency,
322 .vidioc_queryctrl = vidioc_queryctrl,
323 .vidioc_g_ctrl = vidioc_g_ctrl,
324 .vidioc_s_ctrl = vidioc_s_ctrl,
327 static u16 __devinit radio_power_on(struct maestro *dev)
329 register u16 io = dev->io;
333 omask = inw(io + IO_MASK);
334 odir = (inw(io + IO_DIR) & ~STR_DATA) | (STR_CLK | STR_WREN);
335 outw(odir & ~STR_WREN, io + IO_DIR);
336 dev->muted = inw(io) & STR_WREN ? 0 : 1;
337 outw(odir, io + IO_DIR);
338 outw(~(STR_WREN | STR_CLK), io + IO_MASK);
339 outw(dev->muted ? 0 : STR_WREN, io);
341 outw(omask, io + IO_MASK);
342 ofreq = radio_bits_get(dev);
344 if ((ofreq < FREQ2BITS(FREQ_LO)) || (ofreq > FREQ2BITS(FREQ_HI)))
345 ofreq = FREQ2BITS(FREQ_LO);
346 radio_bits_set(dev, ofreq);
348 return (ofreq == radio_bits_get(dev));
351 static int __devinit maestro_probe(struct pci_dev *pdev,
352 const struct pci_device_id *ent)
355 struct v4l2_device *v4l2_dev;
358 retval = pci_enable_device(pdev);
360 dev_err(&pdev->dev, "enabling pci device failed!\n");
366 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
368 dev_err(&pdev->dev, "not enough memory\n");
372 v4l2_dev = &dev->v4l2_dev;
373 mutex_init(&dev->lock);
376 strlcpy(v4l2_dev->name, "maestro", sizeof(v4l2_dev->name));
378 retval = v4l2_device_register(&pdev->dev, v4l2_dev);
380 v4l2_err(v4l2_dev, "Could not register v4l2_device\n");
384 dev->io = pci_resource_start(pdev, 0) + GPIO_DATA;
386 strlcpy(dev->vdev.name, v4l2_dev->name, sizeof(dev->vdev.name));
387 dev->vdev.v4l2_dev = v4l2_dev;
388 dev->vdev.fops = &maestro_fops;
389 dev->vdev.ioctl_ops = &maestro_ioctl_ops;
390 dev->vdev.release = video_device_release_empty;
391 video_set_drvdata(&dev->vdev, dev);
393 retval = video_register_device(&dev->vdev, VFL_TYPE_RADIO, radio_nr);
395 v4l2_err(v4l2_dev, "can't register video device!\n");
399 if (!radio_power_on(dev)) {
404 v4l2_info(v4l2_dev, "version " DRIVER_VERSION "\n");
408 video_unregister_device(&dev->vdev);
410 v4l2_device_unregister(v4l2_dev);
418 static void __devexit maestro_remove(struct pci_dev *pdev)
420 struct v4l2_device *v4l2_dev = dev_get_drvdata(&pdev->dev);
421 struct maestro *dev = to_maestro(v4l2_dev);
423 video_unregister_device(&dev->vdev);
424 v4l2_device_unregister(&dev->v4l2_dev);
427 static struct pci_device_id maestro_r_pci_tbl[] = {
428 { PCI_DEVICE(PCI_VENDOR_ID_ESS, PCI_DEVICE_ID_ESS_ESS1968),
429 .class = PCI_CLASS_MULTIMEDIA_AUDIO << 8,
430 .class_mask = 0xffff00 },
431 { PCI_DEVICE(PCI_VENDOR_ID_ESS, PCI_DEVICE_ID_ESS_ESS1978),
432 .class = PCI_CLASS_MULTIMEDIA_AUDIO << 8,
433 .class_mask = 0xffff00 },
436 MODULE_DEVICE_TABLE(pci, maestro_r_pci_tbl);
438 static struct pci_driver maestro_r_driver = {
439 .name = "maestro_radio",
440 .id_table = maestro_r_pci_tbl,
441 .probe = maestro_probe,
442 .remove = __devexit_p(maestro_remove),
445 static int __init maestro_radio_init(void)
447 int retval = pci_register_driver(&maestro_r_driver);
450 printk(KERN_ERR "error during registration pci driver\n");
455 static void __exit maestro_radio_exit(void)
457 pci_unregister_driver(&maestro_r_driver);
460 module_init(maestro_radio_init);
461 module_exit(maestro_radio_exit);