2 * Framework for ISA radio drivers.
3 * This takes care of all the V4L2 scaffolding, allowing the ISA drivers
4 * to concentrate on the actual hardware operation.
6 * Copyright (C) 2012 Hans Verkuil <hans.verkuil@cisco.com>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
23 #include <linux/module.h>
24 #include <linux/init.h>
25 #include <linux/ioport.h>
26 #include <linux/delay.h>
27 #include <linux/videodev2.h>
29 #include <linux/slab.h>
30 #include <media/v4l2-device.h>
31 #include <media/v4l2-ioctl.h>
32 #include <media/v4l2-fh.h>
33 #include <media/v4l2-ctrls.h>
34 #include <media/v4l2-event.h>
36 #include "radio-isa.h"
38 MODULE_AUTHOR("Hans Verkuil");
39 MODULE_DESCRIPTION("A framework for ISA radio drivers.");
40 MODULE_LICENSE("GPL");
42 #define FREQ_LOW (87U * 16000U)
43 #define FREQ_HIGH (108U * 16000U)
45 static int radio_isa_querycap(struct file *file, void *priv,
46 struct v4l2_capability *v)
48 struct radio_isa_card *isa = video_drvdata(file);
50 strlcpy(v->driver, isa->drv->driver.driver.name, sizeof(v->driver));
51 strlcpy(v->card, isa->drv->card, sizeof(v->card));
52 snprintf(v->bus_info, sizeof(v->bus_info), "ISA:%s", isa->v4l2_dev.name);
54 v->capabilities = V4L2_CAP_TUNER | V4L2_CAP_RADIO;
55 v->device_caps = v->capabilities | V4L2_CAP_DEVICE_CAPS;
59 static int radio_isa_g_tuner(struct file *file, void *priv,
62 struct radio_isa_card *isa = video_drvdata(file);
63 const struct radio_isa_ops *ops = isa->drv->ops;
68 strlcpy(v->name, "FM", sizeof(v->name));
69 v->type = V4L2_TUNER_RADIO;
70 v->rangelow = FREQ_LOW;
71 v->rangehigh = FREQ_HIGH;
72 v->capability = V4L2_TUNER_CAP_LOW;
73 if (isa->drv->has_stereo)
74 v->capability |= V4L2_TUNER_CAP_STEREO;
76 if (ops->g_rxsubchans)
77 v->rxsubchans = ops->g_rxsubchans(isa);
79 v->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
80 v->audmode = isa->stereo ? V4L2_TUNER_MODE_STEREO : V4L2_TUNER_MODE_MONO;
82 v->signal = ops->g_signal(isa);
84 v->signal = (v->rxsubchans & V4L2_TUNER_SUB_STEREO) ?
89 static int radio_isa_s_tuner(struct file *file, void *priv,
92 struct radio_isa_card *isa = video_drvdata(file);
93 const struct radio_isa_ops *ops = isa->drv->ops;
98 isa->stereo = (v->audmode == V4L2_TUNER_MODE_STEREO);
99 return ops->s_stereo(isa, isa->stereo);
104 static int radio_isa_s_frequency(struct file *file, void *priv,
105 struct v4l2_frequency *f)
107 struct radio_isa_card *isa = video_drvdata(file);
110 if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
112 f->frequency = clamp(f->frequency, FREQ_LOW, FREQ_HIGH);
113 res = isa->drv->ops->s_frequency(isa, f->frequency);
115 isa->freq = f->frequency;
119 static int radio_isa_g_frequency(struct file *file, void *priv,
120 struct v4l2_frequency *f)
122 struct radio_isa_card *isa = video_drvdata(file);
126 f->type = V4L2_TUNER_RADIO;
127 f->frequency = isa->freq;
131 static int radio_isa_s_ctrl(struct v4l2_ctrl *ctrl)
133 struct radio_isa_card *isa =
134 container_of(ctrl->handler, struct radio_isa_card, hdl);
137 case V4L2_CID_AUDIO_MUTE:
138 return isa->drv->ops->s_mute_volume(isa, ctrl->val,
139 isa->volume ? isa->volume->val : 0);
144 static int radio_isa_log_status(struct file *file, void *priv)
146 struct radio_isa_card *isa = video_drvdata(file);
148 v4l2_info(&isa->v4l2_dev, "I/O Port = 0x%03x\n", isa->io);
149 v4l2_ctrl_handler_log_status(&isa->hdl, isa->v4l2_dev.name);
153 static int radio_isa_subscribe_event(struct v4l2_fh *fh,
154 struct v4l2_event_subscription *sub)
156 if (sub->type == V4L2_EVENT_CTRL)
157 return v4l2_event_subscribe(fh, sub, 0);
161 static const struct v4l2_ctrl_ops radio_isa_ctrl_ops = {
162 .s_ctrl = radio_isa_s_ctrl,
165 static const struct v4l2_file_operations radio_isa_fops = {
166 .owner = THIS_MODULE,
167 .open = v4l2_fh_open,
168 .release = v4l2_fh_release,
169 .poll = v4l2_ctrl_poll,
170 .unlocked_ioctl = video_ioctl2,
173 static const struct v4l2_ioctl_ops radio_isa_ioctl_ops = {
174 .vidioc_querycap = radio_isa_querycap,
175 .vidioc_g_tuner = radio_isa_g_tuner,
176 .vidioc_s_tuner = radio_isa_s_tuner,
177 .vidioc_g_frequency = radio_isa_g_frequency,
178 .vidioc_s_frequency = radio_isa_s_frequency,
179 .vidioc_log_status = radio_isa_log_status,
180 .vidioc_subscribe_event = radio_isa_subscribe_event,
181 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
184 int radio_isa_match(struct device *pdev, unsigned int dev)
186 struct radio_isa_driver *drv = pdev->platform_data;
188 return drv->probe || drv->io_params[dev] >= 0;
190 EXPORT_SYMBOL_GPL(radio_isa_match);
192 static bool radio_isa_valid_io(const struct radio_isa_driver *drv, int io)
196 for (i = 0; i < drv->num_of_io_ports; i++)
197 if (drv->io_ports[i] == io)
202 struct radio_isa_card *radio_isa_alloc(struct radio_isa_driver *drv,
205 struct v4l2_device *v4l2_dev;
206 struct radio_isa_card *isa = drv->ops->alloc();
210 dev_set_drvdata(pdev, isa);
212 v4l2_dev = &isa->v4l2_dev;
213 strlcpy(v4l2_dev->name, dev_name(pdev), sizeof(v4l2_dev->name));
218 int radio_isa_common_probe(struct radio_isa_card *isa, struct device *pdev,
219 int radio_nr, unsigned region_size)
221 const struct radio_isa_driver *drv = isa->drv;
222 const struct radio_isa_ops *ops = drv->ops;
223 struct v4l2_device *v4l2_dev = &isa->v4l2_dev;
226 if (!request_region(isa->io, region_size, v4l2_dev->name)) {
227 v4l2_err(v4l2_dev, "port 0x%x already in use\n", isa->io);
232 res = v4l2_device_register(pdev, v4l2_dev);
234 v4l2_err(v4l2_dev, "Could not register v4l2_device\n");
238 v4l2_ctrl_handler_init(&isa->hdl, 1);
239 isa->mute = v4l2_ctrl_new_std(&isa->hdl, &radio_isa_ctrl_ops,
240 V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
242 isa->volume = v4l2_ctrl_new_std(&isa->hdl, &radio_isa_ctrl_ops,
243 V4L2_CID_AUDIO_VOLUME, 0, drv->max_volume, 1,
245 v4l2_dev->ctrl_handler = &isa->hdl;
246 if (isa->hdl.error) {
247 res = isa->hdl.error;
248 v4l2_err(v4l2_dev, "Could not register controls\n");
252 v4l2_ctrl_cluster(2, &isa->mute);
253 v4l2_dev->ctrl_handler = &isa->hdl;
255 mutex_init(&isa->lock);
256 isa->vdev.lock = &isa->lock;
257 strlcpy(isa->vdev.name, v4l2_dev->name, sizeof(isa->vdev.name));
258 isa->vdev.v4l2_dev = v4l2_dev;
259 isa->vdev.fops = &radio_isa_fops;
260 isa->vdev.ioctl_ops = &radio_isa_ioctl_ops;
261 isa->vdev.release = video_device_release_empty;
262 set_bit(V4L2_FL_USE_FH_PRIO, &isa->vdev.flags);
263 video_set_drvdata(&isa->vdev, isa);
264 isa->freq = FREQ_LOW;
265 isa->stereo = drv->has_stereo;
268 res = ops->init(isa);
270 res = v4l2_ctrl_handler_setup(&isa->hdl);
272 res = ops->s_frequency(isa, isa->freq);
273 if (!res && ops->s_stereo)
274 res = ops->s_stereo(isa, isa->stereo);
276 v4l2_err(v4l2_dev, "Could not setup card\n");
279 res = video_register_device(&isa->vdev, VFL_TYPE_RADIO, radio_nr);
282 v4l2_err(v4l2_dev, "Could not register device node\n");
286 v4l2_info(v4l2_dev, "Initialized radio card %s on port 0x%03x\n",
291 v4l2_ctrl_handler_free(&isa->hdl);
293 release_region(isa->io, region_size);
298 int radio_isa_common_remove(struct radio_isa_card *isa, unsigned region_size)
300 const struct radio_isa_ops *ops = isa->drv->ops;
302 ops->s_mute_volume(isa, true, isa->volume ? isa->volume->cur.val : 0);
303 video_unregister_device(&isa->vdev);
304 v4l2_ctrl_handler_free(&isa->hdl);
305 v4l2_device_unregister(&isa->v4l2_dev);
306 release_region(isa->io, region_size);
307 v4l2_info(&isa->v4l2_dev, "Removed radio card %s\n", isa->drv->card);
312 int radio_isa_probe(struct device *pdev, unsigned int dev)
314 struct radio_isa_driver *drv = pdev->platform_data;
315 const struct radio_isa_ops *ops = drv->ops;
316 struct v4l2_device *v4l2_dev;
317 struct radio_isa_card *isa;
319 isa = radio_isa_alloc(drv, pdev);
322 isa->io = drv->io_params[dev];
323 v4l2_dev = &isa->v4l2_dev;
325 if (drv->probe && ops->probe) {
328 for (i = 0; i < drv->num_of_io_ports; ++i) {
329 int io = drv->io_ports[i];
331 if (request_region(io, drv->region_size, v4l2_dev->name)) {
332 bool found = ops->probe(isa, io);
334 release_region(io, drv->region_size);
343 if (!radio_isa_valid_io(drv, isa->io)) {
348 v4l2_err(v4l2_dev, "you must set an I/O address with io=0x%03x",
350 for (i = 1; i < drv->num_of_io_ports; i++)
351 printk(KERN_CONT "/0x%03x", drv->io_ports[i]);
352 printk(KERN_CONT ".\n");
357 return radio_isa_common_probe(isa, pdev, drv->radio_nr_params[dev],
360 EXPORT_SYMBOL_GPL(radio_isa_probe);
362 int radio_isa_remove(struct device *pdev, unsigned int dev)
364 struct radio_isa_card *isa = dev_get_drvdata(pdev);
366 return radio_isa_common_remove(isa, isa->drv->region_size);
368 EXPORT_SYMBOL_GPL(radio_isa_remove);
371 int radio_isa_pnp_probe(struct pnp_dev *dev, const struct pnp_device_id *dev_id)
373 struct pnp_driver *pnp_drv = to_pnp_driver(dev->dev.driver);
374 struct radio_isa_driver *drv = container_of(pnp_drv,
375 struct radio_isa_driver, pnp_driver);
376 struct radio_isa_card *isa;
378 if (!pnp_port_valid(dev, 0))
381 isa = radio_isa_alloc(drv, &dev->dev);
385 isa->io = pnp_port_start(dev, 0);
387 return radio_isa_common_probe(isa, &dev->dev, drv->radio_nr_params[0],
388 pnp_port_len(dev, 0));
390 EXPORT_SYMBOL_GPL(radio_isa_pnp_probe);
392 void radio_isa_pnp_remove(struct pnp_dev *dev)
394 struct radio_isa_card *isa = dev_get_drvdata(&dev->dev);
396 radio_isa_common_remove(isa, pnp_port_len(dev, 0));
398 EXPORT_SYMBOL_GPL(radio_isa_pnp_remove);