Back to home page

OSCL-LXR
 
 

     

0001 // SPDX-License-Identifier: GPL-2.0-only
0002 /*
0003  * Miro PCM20 radio driver for Linux radio support
0004  * (c) 1998 Ruurd Reitsma <R.A.Reitsma@wbmt.tudelft.nl>
0005  * Thanks to Norberto Pellici for the ACI device interface specification
0006  * The API part is based on the radiotrack driver by M. Kirkwood
0007  * This driver relies on the aci mixer provided by the snd-miro
0008  * ALSA driver.
0009  * Look there for further info...
0010  *
0011  * From the original miro RDS sources:
0012  *
0013  *  (c) 2001 Robert Siemer <Robert.Siemer@gmx.de>
0014  *
0015  *  Many thanks to Fred Seidel <seidel@metabox.de>, the
0016  *  designer of the RDS decoder hardware. With his help
0017  *  I was able to code this driver.
0018  *  Thanks also to Norberto Pellicci, Dominic Mounteney
0019  *  <DMounteney@pinnaclesys.com> and www.teleauskunft.de
0020  *  for good hints on finding Fred. It was somewhat hard
0021  *  to locate him here in Germany... [:
0022  *
0023  * This code has been reintroduced and converted to use
0024  * the new V4L2 RDS API by:
0025  *
0026  * Hans Verkuil <hans.verkuil@cisco.com>
0027  */
0028 
0029 #include <linux/module.h>
0030 #include <linux/init.h>
0031 #include <linux/io.h>
0032 #include <linux/delay.h>
0033 #include <linux/videodev2.h>
0034 #include <linux/kthread.h>
0035 #include <media/v4l2-device.h>
0036 #include <media/v4l2-ioctl.h>
0037 #include <media/v4l2-ctrls.h>
0038 #include <media/v4l2-fh.h>
0039 #include <media/v4l2-event.h>
0040 #include <sound/aci.h>
0041 
0042 #define RDS_DATASHIFT          2   /* Bit 2 */
0043 #define RDS_DATAMASK        (1 << RDS_DATASHIFT)
0044 #define RDS_BUSYMASK        0x10   /* Bit 4 */
0045 #define RDS_CLOCKMASK       0x08   /* Bit 3 */
0046 #define RDS_DATA(x)         (((x) >> RDS_DATASHIFT) & 1)
0047 
0048 #define RDS_STATUS      0x01
0049 #define RDS_STATIONNAME 0x02
0050 #define RDS_TEXT        0x03
0051 #define RDS_ALTFREQ     0x04
0052 #define RDS_TIMEDATE    0x05
0053 #define RDS_PI_CODE     0x06
0054 #define RDS_PTYTATP     0x07
0055 #define RDS_RESET       0x08
0056 #define RDS_RXVALUE     0x09
0057 
0058 static int radio_nr = -1;
0059 module_param(radio_nr, int, 0);
0060 MODULE_PARM_DESC(radio_nr, "Set radio device number (/dev/radioX).  Default: -1 (autodetect)");
0061 
0062 struct pcm20 {
0063     struct v4l2_device v4l2_dev;
0064     struct video_device vdev;
0065     struct v4l2_ctrl_handler ctrl_handler;
0066     struct v4l2_ctrl *rds_pty;
0067     struct v4l2_ctrl *rds_ps_name;
0068     struct v4l2_ctrl *rds_radio_test;
0069     struct v4l2_ctrl *rds_ta;
0070     struct v4l2_ctrl *rds_tp;
0071     struct v4l2_ctrl *rds_ms;
0072     /* thread for periodic RDS status checking */
0073     struct task_struct *kthread;
0074     unsigned long freq;
0075     u32 audmode;
0076     struct snd_miro_aci *aci;
0077     struct mutex lock;
0078 };
0079 
0080 static struct pcm20 pcm20_card = {
0081     .freq = 87 * 16000,
0082     .audmode = V4L2_TUNER_MODE_STEREO,
0083 };
0084 
0085 
0086 static int rds_waitread(struct snd_miro_aci *aci)
0087 {
0088     u8 byte;
0089     int i = 2000;
0090 
0091     do {
0092         byte = inb(aci->aci_port + ACI_REG_RDS);
0093         i--;
0094     } while ((byte & RDS_BUSYMASK) && i);
0095 
0096     /*
0097      * It's magic, but without this the data that you read later on
0098      * is unreliable and full of bit errors. With this 1 usec delay
0099      * everything is fine.
0100      */
0101     udelay(1);
0102     return i ? byte : -1;
0103 }
0104 
0105 static int rds_rawwrite(struct snd_miro_aci *aci, u8 byte)
0106 {
0107     if (rds_waitread(aci) >= 0) {
0108         outb(byte, aci->aci_port + ACI_REG_RDS);
0109         return 0;
0110     }
0111     return -1;
0112 }
0113 
0114 static int rds_write(struct snd_miro_aci *aci, u8 byte)
0115 {
0116     u8 sendbuffer[8];
0117     int i;
0118 
0119     for (i = 7; i >= 0; i--)
0120         sendbuffer[7 - i] = (byte & (1 << i)) ? RDS_DATAMASK : 0;
0121     sendbuffer[0] |= RDS_CLOCKMASK;
0122 
0123     for (i = 0; i < 8; i++)
0124         rds_rawwrite(aci, sendbuffer[i]);
0125     return 0;
0126 }
0127 
0128 static int rds_readcycle_nowait(struct snd_miro_aci *aci)
0129 {
0130     outb(0, aci->aci_port + ACI_REG_RDS);
0131     return rds_waitread(aci);
0132 }
0133 
0134 static int rds_readcycle(struct snd_miro_aci *aci)
0135 {
0136     if (rds_rawwrite(aci, 0) < 0)
0137         return -1;
0138     return rds_waitread(aci);
0139 }
0140 
0141 static int rds_ack(struct snd_miro_aci *aci)
0142 {
0143     int i = rds_readcycle(aci);
0144 
0145     if (i < 0)
0146         return -1;
0147     if (i & RDS_DATAMASK)
0148         return 0;  /* ACK  */
0149     return 1;  /* NACK */
0150 }
0151 
0152 static int rds_cmd(struct snd_miro_aci *aci, u8 cmd, u8 databuffer[], u8 datasize)
0153 {
0154     int i, j;
0155 
0156     rds_write(aci, cmd);
0157 
0158     /* RDS_RESET doesn't need further processing */
0159     if (cmd == RDS_RESET)
0160         return 0;
0161     if (rds_ack(aci))
0162         return -EIO;
0163     if (datasize == 0)
0164         return 0;
0165 
0166     /* to be able to use rds_readcycle_nowait()
0167        I have to waitread() here */
0168     if (rds_waitread(aci) < 0)
0169         return -1;
0170 
0171     memset(databuffer, 0, datasize);
0172 
0173     for (i = 0; i < 8 * datasize; i++) {
0174         j = rds_readcycle_nowait(aci);
0175         if (j < 0)
0176             return -EIO;
0177         databuffer[i / 8] |= RDS_DATA(j) << (7 - (i % 8));
0178     }
0179     return 0;
0180 }
0181 
0182 static int pcm20_setfreq(struct pcm20 *dev, unsigned long freq)
0183 {
0184     unsigned char freql;
0185     unsigned char freqh;
0186     struct snd_miro_aci *aci = dev->aci;
0187 
0188     freq /= 160;
0189     if (!(aci->aci_version == 0x07 || aci->aci_version >= 0xb0))
0190         freq /= 10;  /* I don't know exactly which version
0191                   * needs this hack */
0192     freql = freq & 0xff;
0193     freqh = freq >> 8;
0194 
0195     rds_cmd(aci, RDS_RESET, NULL, 0);
0196     return snd_aci_cmd(aci, ACI_WRITE_TUNE, freql, freqh);
0197 }
0198 
0199 static int vidioc_querycap(struct file *file, void *priv,
0200                 struct v4l2_capability *v)
0201 {
0202     struct pcm20 *dev = video_drvdata(file);
0203 
0204     strscpy(v->driver, "Miro PCM20", sizeof(v->driver));
0205     strscpy(v->card, "Miro PCM20", sizeof(v->card));
0206     snprintf(v->bus_info, sizeof(v->bus_info), "ISA:%s", dev->v4l2_dev.name);
0207     return 0;
0208 }
0209 
0210 static bool sanitize(char *p, int size)
0211 {
0212     int i;
0213     bool ret = true;
0214 
0215     for (i = 0; i < size; i++) {
0216         if (p[i] < 32) {
0217             p[i] = ' ';
0218             ret = false;
0219         }
0220     }
0221     return ret;
0222 }
0223 
0224 static int vidioc_g_tuner(struct file *file, void *priv,
0225                 struct v4l2_tuner *v)
0226 {
0227     struct pcm20 *dev = video_drvdata(file);
0228     int res;
0229     u8 buf;
0230 
0231     if (v->index)
0232         return -EINVAL;
0233     strscpy(v->name, "FM", sizeof(v->name));
0234     v->type = V4L2_TUNER_RADIO;
0235     v->rangelow = 87*16000;
0236     v->rangehigh = 108*16000;
0237     res = snd_aci_cmd(dev->aci, ACI_READ_TUNERSTATION, -1, -1);
0238     v->signal = (res & 0x80) ? 0 : 0xffff;
0239     /* Note: stereo detection does not work if the audio is muted,
0240        it will default to mono in that case. */
0241     res = snd_aci_cmd(dev->aci, ACI_READ_TUNERSTEREO, -1, -1);
0242     v->rxsubchans = (res & 0x40) ? V4L2_TUNER_SUB_MONO :
0243                     V4L2_TUNER_SUB_STEREO;
0244     v->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO |
0245             V4L2_TUNER_CAP_RDS | V4L2_TUNER_CAP_RDS_CONTROLS;
0246     v->audmode = dev->audmode;
0247     res = rds_cmd(dev->aci, RDS_RXVALUE, &buf, 1);
0248     if (res >= 0 && buf)
0249         v->rxsubchans |= V4L2_TUNER_SUB_RDS;
0250     return 0;
0251 }
0252 
0253 static int vidioc_s_tuner(struct file *file, void *priv,
0254                 const struct v4l2_tuner *v)
0255 {
0256     struct pcm20 *dev = video_drvdata(file);
0257 
0258     if (v->index)
0259         return -EINVAL;
0260     if (v->audmode > V4L2_TUNER_MODE_STEREO)
0261         dev->audmode = V4L2_TUNER_MODE_STEREO;
0262     else
0263         dev->audmode = v->audmode;
0264     snd_aci_cmd(dev->aci, ACI_SET_TUNERMONO,
0265             dev->audmode == V4L2_TUNER_MODE_MONO, -1);
0266     return 0;
0267 }
0268 
0269 static int vidioc_g_frequency(struct file *file, void *priv,
0270                 struct v4l2_frequency *f)
0271 {
0272     struct pcm20 *dev = video_drvdata(file);
0273 
0274     if (f->tuner != 0)
0275         return -EINVAL;
0276 
0277     f->type = V4L2_TUNER_RADIO;
0278     f->frequency = dev->freq;
0279     return 0;
0280 }
0281 
0282 
0283 static int vidioc_s_frequency(struct file *file, void *priv,
0284                 const struct v4l2_frequency *f)
0285 {
0286     struct pcm20 *dev = video_drvdata(file);
0287 
0288     if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
0289         return -EINVAL;
0290 
0291     dev->freq = clamp_t(u32, f->frequency, 87 * 16000U, 108 * 16000U);
0292     pcm20_setfreq(dev, dev->freq);
0293     return 0;
0294 }
0295 
0296 static int pcm20_s_ctrl(struct v4l2_ctrl *ctrl)
0297 {
0298     struct pcm20 *dev = container_of(ctrl->handler, struct pcm20, ctrl_handler);
0299 
0300     switch (ctrl->id) {
0301     case V4L2_CID_AUDIO_MUTE:
0302         snd_aci_cmd(dev->aci, ACI_SET_TUNERMUTE, ctrl->val, -1);
0303         return 0;
0304     }
0305     return -EINVAL;
0306 }
0307 
0308 static int pcm20_thread(void *data)
0309 {
0310     struct pcm20 *dev = data;
0311     const unsigned no_rds_start_counter = 5;
0312     const unsigned sleep_msecs = 2000;
0313     unsigned no_rds_counter = no_rds_start_counter;
0314 
0315     for (;;) {
0316         char text_buffer[66];
0317         u8 buf;
0318         int res;
0319 
0320         msleep_interruptible(sleep_msecs);
0321 
0322         if (kthread_should_stop())
0323             break;
0324 
0325         res = rds_cmd(dev->aci, RDS_RXVALUE, &buf, 1);
0326         if (res)
0327             continue;
0328         if (buf == 0) {
0329             if (no_rds_counter == 0)
0330                 continue;
0331             no_rds_counter--;
0332             if (no_rds_counter)
0333                 continue;
0334 
0335             /*
0336              * No RDS seen for no_rds_start_counter * sleep_msecs
0337              * milliseconds, clear all RDS controls to their
0338              * default values.
0339              */
0340             v4l2_ctrl_s_ctrl_string(dev->rds_ps_name, "");
0341             v4l2_ctrl_s_ctrl(dev->rds_ms, 1);
0342             v4l2_ctrl_s_ctrl(dev->rds_ta, 0);
0343             v4l2_ctrl_s_ctrl(dev->rds_tp, 0);
0344             v4l2_ctrl_s_ctrl(dev->rds_pty, 0);
0345             v4l2_ctrl_s_ctrl_string(dev->rds_radio_test, "");
0346             continue;
0347         }
0348         no_rds_counter = no_rds_start_counter;
0349 
0350         res = rds_cmd(dev->aci, RDS_STATUS, &buf, 1);
0351         if (res)
0352             continue;
0353         if ((buf >> 3) & 1) {
0354             res = rds_cmd(dev->aci, RDS_STATIONNAME, text_buffer, 8);
0355             text_buffer[8] = 0;
0356             if (!res && sanitize(text_buffer, 8))
0357                 v4l2_ctrl_s_ctrl_string(dev->rds_ps_name, text_buffer);
0358         }
0359         if ((buf >> 6) & 1) {
0360             u8 pty;
0361 
0362             res = rds_cmd(dev->aci, RDS_PTYTATP, &pty, 1);
0363             if (!res) {
0364                 v4l2_ctrl_s_ctrl(dev->rds_ms, !!(pty & 0x01));
0365                 v4l2_ctrl_s_ctrl(dev->rds_ta, !!(pty & 0x02));
0366                 v4l2_ctrl_s_ctrl(dev->rds_tp, !!(pty & 0x80));
0367                 v4l2_ctrl_s_ctrl(dev->rds_pty, (pty >> 2) & 0x1f);
0368             }
0369         }
0370         if ((buf >> 4) & 1) {
0371             res = rds_cmd(dev->aci, RDS_TEXT, text_buffer, 65);
0372             text_buffer[65] = 0;
0373             if (!res && sanitize(text_buffer + 1, 64))
0374                 v4l2_ctrl_s_ctrl_string(dev->rds_radio_test, text_buffer + 1);
0375         }
0376     }
0377     return 0;
0378 }
0379 
0380 static int pcm20_open(struct file *file)
0381 {
0382     struct pcm20 *dev = video_drvdata(file);
0383     int res = v4l2_fh_open(file);
0384 
0385     if (!res && v4l2_fh_is_singular_file(file) &&
0386         IS_ERR_OR_NULL(dev->kthread)) {
0387         dev->kthread = kthread_run(pcm20_thread, dev, "%s",
0388                        dev->v4l2_dev.name);
0389         if (IS_ERR(dev->kthread)) {
0390             v4l2_err(&dev->v4l2_dev, "kernel_thread() failed\n");
0391             v4l2_fh_release(file);
0392             return PTR_ERR(dev->kthread);
0393         }
0394     }
0395     return res;
0396 }
0397 
0398 static int pcm20_release(struct file *file)
0399 {
0400     struct pcm20 *dev = video_drvdata(file);
0401 
0402     if (v4l2_fh_is_singular_file(file) && !IS_ERR_OR_NULL(dev->kthread)) {
0403         kthread_stop(dev->kthread);
0404         dev->kthread = NULL;
0405     }
0406     return v4l2_fh_release(file);
0407 }
0408 
0409 static const struct v4l2_file_operations pcm20_fops = {
0410     .owner      = THIS_MODULE,
0411     .open       = pcm20_open,
0412     .poll       = v4l2_ctrl_poll,
0413     .release    = pcm20_release,
0414     .unlocked_ioctl = video_ioctl2,
0415 };
0416 
0417 static const struct v4l2_ioctl_ops pcm20_ioctl_ops = {
0418     .vidioc_querycap    = vidioc_querycap,
0419     .vidioc_g_tuner     = vidioc_g_tuner,
0420     .vidioc_s_tuner     = vidioc_s_tuner,
0421     .vidioc_g_frequency = vidioc_g_frequency,
0422     .vidioc_s_frequency = vidioc_s_frequency,
0423     .vidioc_log_status  = v4l2_ctrl_log_status,
0424     .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
0425     .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
0426 };
0427 
0428 static const struct v4l2_ctrl_ops pcm20_ctrl_ops = {
0429     .s_ctrl = pcm20_s_ctrl,
0430 };
0431 
0432 static int __init pcm20_init(void)
0433 {
0434     struct pcm20 *dev = &pcm20_card;
0435     struct v4l2_device *v4l2_dev = &dev->v4l2_dev;
0436     struct v4l2_ctrl_handler *hdl;
0437     int res;
0438 
0439     dev->aci = snd_aci_get_aci();
0440     if (dev->aci == NULL) {
0441         v4l2_err(v4l2_dev,
0442              "you must load the snd-miro driver first!\n");
0443         return -ENODEV;
0444     }
0445     strscpy(v4l2_dev->name, "radio-miropcm20", sizeof(v4l2_dev->name));
0446     mutex_init(&dev->lock);
0447 
0448     res = v4l2_device_register(NULL, v4l2_dev);
0449     if (res < 0) {
0450         v4l2_err(v4l2_dev, "could not register v4l2_device\n");
0451         return -EINVAL;
0452     }
0453 
0454     hdl = &dev->ctrl_handler;
0455     v4l2_ctrl_handler_init(hdl, 7);
0456     v4l2_ctrl_new_std(hdl, &pcm20_ctrl_ops,
0457             V4L2_CID_AUDIO_MUTE, 0, 1, 1, 1);
0458     dev->rds_pty = v4l2_ctrl_new_std(hdl, NULL,
0459             V4L2_CID_RDS_RX_PTY, 0, 0x1f, 1, 0);
0460     dev->rds_ps_name = v4l2_ctrl_new_std(hdl, NULL,
0461             V4L2_CID_RDS_RX_PS_NAME, 0, 8, 8, 0);
0462     dev->rds_radio_test = v4l2_ctrl_new_std(hdl, NULL,
0463             V4L2_CID_RDS_RX_RADIO_TEXT, 0, 64, 64, 0);
0464     dev->rds_ta = v4l2_ctrl_new_std(hdl, NULL,
0465             V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT, 0, 1, 1, 0);
0466     dev->rds_tp = v4l2_ctrl_new_std(hdl, NULL,
0467             V4L2_CID_RDS_RX_TRAFFIC_PROGRAM, 0, 1, 1, 0);
0468     dev->rds_ms = v4l2_ctrl_new_std(hdl, NULL,
0469             V4L2_CID_RDS_RX_MUSIC_SPEECH, 0, 1, 1, 1);
0470     v4l2_dev->ctrl_handler = hdl;
0471     if (hdl->error) {
0472         res = hdl->error;
0473         v4l2_err(v4l2_dev, "Could not register control\n");
0474         goto err_hdl;
0475     }
0476     strscpy(dev->vdev.name, v4l2_dev->name, sizeof(dev->vdev.name));
0477     dev->vdev.v4l2_dev = v4l2_dev;
0478     dev->vdev.fops = &pcm20_fops;
0479     dev->vdev.ioctl_ops = &pcm20_ioctl_ops;
0480     dev->vdev.release = video_device_release_empty;
0481     dev->vdev.lock = &dev->lock;
0482     dev->vdev.device_caps = V4L2_CAP_TUNER | V4L2_CAP_RADIO |
0483                 V4L2_CAP_RDS_CAPTURE;
0484     video_set_drvdata(&dev->vdev, dev);
0485     snd_aci_cmd(dev->aci, ACI_SET_TUNERMONO,
0486             dev->audmode == V4L2_TUNER_MODE_MONO, -1);
0487     pcm20_setfreq(dev, dev->freq);
0488 
0489     if (video_register_device(&dev->vdev, VFL_TYPE_RADIO, radio_nr) < 0)
0490         goto err_hdl;
0491 
0492     v4l2_info(v4l2_dev, "Mirosound PCM20 Radio tuner\n");
0493     return 0;
0494 err_hdl:
0495     v4l2_ctrl_handler_free(hdl);
0496     v4l2_device_unregister(v4l2_dev);
0497     return -EINVAL;
0498 }
0499 
0500 MODULE_AUTHOR("Ruurd Reitsma, Krzysztof Helt");
0501 MODULE_DESCRIPTION("A driver for the Miro PCM20 radio card.");
0502 MODULE_LICENSE("GPL");
0503 
0504 static void __exit pcm20_cleanup(void)
0505 {
0506     struct pcm20 *dev = &pcm20_card;
0507 
0508     video_unregister_device(&dev->vdev);
0509     snd_aci_cmd(dev->aci, ACI_SET_TUNERMUTE, 1, -1);
0510     v4l2_ctrl_handler_free(&dev->ctrl_handler);
0511     v4l2_device_unregister(&dev->v4l2_dev);
0512 }
0513 
0514 module_init(pcm20_init);
0515 module_exit(pcm20_cleanup);
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!