drivers/media/radio/radio-si4713.c

   1 /*
   2  * drivers/media/radio/radio-si4713.c
   3  *
   4  * Platform Driver for Silicon Labs Si4713 FM Radio Transmitter:
   5  *
   6  * Copyright (c) 2008 Instituto Nokia de Tecnologia - INdT
   7  * Contact: Eduardo Valentin <eduardo.valentin@nokia.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  22  */
  23
  24 #include <linux/kernel.h>
  25 #include <linux/module.h>
  26 #include <linux/init.h>
  27 #include <linux/platform_device.h>
  28 #include <linux/i2c.h>
  29 #include <linux/videodev2.h>
  30 #include <linux/slab.h>
  31 #include <media/v4l2-device.h>
  32 #include <media/v4l2-common.h>
  33 #include <media/v4l2-ioctl.h>
  34 #include <media/radio-si4713.h>
  35
  36 /* module parameters */
  37 static int radio_nr = -1;       /* radio device minor (-1 ==> auto assign) */
  38 module_param(radio_nr, int, 0);
  39 MODULE_PARM_DESC(radio_nr,
  40                  "Minor number for radio device (-1 ==> auto assign)");
  41
  42 MODULE_LICENSE("GPL v2");
  43 MODULE_AUTHOR("Eduardo Valentin <eduardo.valentin@nokia.com>");
  44 MODULE_DESCRIPTION("Platform driver for Si4713 FM Radio Transmitter");
  45 MODULE_VERSION("0.0.1");
  46 MODULE_ALIAS("platform:radio-si4713");
  47
  48 /* Driver state struct */
  49 struct radio_si4713_device {
  50         struct v4l2_device              v4l2_dev;
  51         struct video_device             *radio_dev;
  52 };
  53
  54 /* radio_si4713_fops - file operations interface */
  55 static const struct v4l2_file_operations radio_si4713_fops = {
  56         .owner          = THIS_MODULE,
  57         /* Note: locking is done at the subdev level in the i2c driver. */
  58         .unlocked_ioctl = video_ioctl2,
  59 };
  60
  61 /* Video4Linux Interface */
  62 static int radio_si4713_fill_audout(struct v4l2_audioout *vao)
  63 {
  64         /* TODO: check presence of audio output */
  65         strlcpy(vao->name, "FM Modulator Audio Out", 32);
  66
  67         return 0;
  68 }
  69
  70 static int radio_si4713_enumaudout(struct file *file, void *priv,
  71                                                 struct v4l2_audioout *vao)
  72 {
  73         return radio_si4713_fill_audout(vao);
  74 }
  75
  76 static int radio_si4713_g_audout(struct file *file, void *priv,
  77                                         struct v4l2_audioout *vao)
  78 {
  79         int rval = radio_si4713_fill_audout(vao);
  80
  81         vao->index = 0;
  82
  83         return rval;
  84 }
  85
  86 static int radio_si4713_s_audout(struct file *file, void *priv,
  87                                         const struct v4l2_audioout *vao)
  88 {
  89         return vao->index ? -EINVAL : 0;
  90 }
  91
  92 /* radio_si4713_querycap - query device capabilities */
  93 static int radio_si4713_querycap(struct file *file, void *priv,
  94                                         struct v4l2_capability *capability)
  95 {
  96         strlcpy(capability->driver, "radio-si4713", sizeof(capability->driver));
  97         strlcpy(capability->card, "Silicon Labs Si4713 Modulator",
  98                 sizeof(capability->card));
  99         capability->capabilities = V4L2_CAP_MODULATOR | V4L2_CAP_RDS_OUTPUT;
 100
 101         return 0;
 102 }
 103
 104 /* radio_si4713_queryctrl - enumerate control items */
 105 static int radio_si4713_queryctrl(struct file *file, void *priv,
 106                                   struct v4l2_queryctrl *qc)
 107 {
 108         /* Must be sorted from low to high control ID! */
 109         static const u32 user_ctrls[] = {
 110                 V4L2_CID_USER_CLASS,
 111                 V4L2_CID_AUDIO_MUTE,
 112                 0
 113         };
 114
 115         /* Must be sorted from low to high control ID! */
 116         static const u32 fmtx_ctrls[] = {
 117                 V4L2_CID_FM_TX_CLASS,
 118                 V4L2_CID_RDS_TX_DEVIATION,
 119                 V4L2_CID_RDS_TX_PI,
 120                 V4L2_CID_RDS_TX_PTY,
 121                 V4L2_CID_RDS_TX_PS_NAME,
 122                 V4L2_CID_RDS_TX_RADIO_TEXT,
 123                 V4L2_CID_AUDIO_LIMITER_ENABLED,
 124                 V4L2_CID_AUDIO_LIMITER_RELEASE_TIME,
 125                 V4L2_CID_AUDIO_LIMITER_DEVIATION,
 126                 V4L2_CID_AUDIO_COMPRESSION_ENABLED,
 127                 V4L2_CID_AUDIO_COMPRESSION_GAIN,
 128                 V4L2_CID_AUDIO_COMPRESSION_THRESHOLD,
 129                 V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME,
 130                 V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME,
 131                 V4L2_CID_PILOT_TONE_ENABLED,
 132                 V4L2_CID_PILOT_TONE_DEVIATION,
 133                 V4L2_CID_PILOT_TONE_FREQUENCY,
 134                 V4L2_CID_TUNE_PREEMPHASIS,
 135                 V4L2_CID_TUNE_POWER_LEVEL,
 136                 V4L2_CID_TUNE_ANTENNA_CAPACITOR,
 137                 0
 138         };
 139         static const u32 *ctrl_classes[] = {
 140                 user_ctrls,
 141                 fmtx_ctrls,
 142                 NULL
 143         };
 144         struct radio_si4713_device *rsdev;
 145
 146         rsdev = video_get_drvdata(video_devdata(file));
 147
 148         qc->id = v4l2_ctrl_next(ctrl_classes, qc->id);
 149         if (qc->id == 0)
 150                 return -EINVAL;
 151
 152         if (qc->id == V4L2_CID_USER_CLASS || qc->id == V4L2_CID_FM_TX_CLASS)
 153                 return v4l2_ctrl_query_fill(qc, 0, 0, 0, 0);
 154
 155         return v4l2_device_call_until_err(&rsdev->v4l2_dev, 0, core,
 156                                           queryctrl, qc);
 157 }
 158
 159 /*
 160  * v4l2 ioctl call backs.
 161  * we are just a wrapper for v4l2_sub_devs.
 162  */
 163 static inline struct v4l2_device *get_v4l2_dev(struct file *file)
 164 {
 165         return &((struct radio_si4713_device *)video_drvdata(file))->v4l2_dev;
 166 }
 167
 168 static int radio_si4713_g_ext_ctrls(struct file *file, void *p,
 169                                     struct v4l2_ext_controls *vecs)
 170 {
 171         return v4l2_device_call_until_err(get_v4l2_dev(file), 0, core,
 172                                           g_ext_ctrls, vecs);
 173 }
 174
 175 static int radio_si4713_s_ext_ctrls(struct file *file, void *p,
 176                                     struct v4l2_ext_controls *vecs)
 177 {
 178         return v4l2_device_call_until_err(get_v4l2_dev(file), 0, core,
 179                                           s_ext_ctrls, vecs);
 180 }
 181
 182 static int radio_si4713_g_ctrl(struct file *file, void *p,
 183                                struct v4l2_control *vc)
 184 {
 185         return v4l2_device_call_until_err(get_v4l2_dev(file), 0, core,
 186                                           g_ctrl, vc);
 187 }
 188
 189 static int radio_si4713_s_ctrl(struct file *file, void *p,
 190                                struct v4l2_control *vc)
 191 {
 192         return v4l2_device_call_until_err(get_v4l2_dev(file), 0, core,
 193                                           s_ctrl, vc);
 194 }
 195
 196 static int radio_si4713_g_modulator(struct file *file, void *p,
 197                                     struct v4l2_modulator *vm)
 198 {
 199         return v4l2_device_call_until_err(get_v4l2_dev(file), 0, tuner,
 200                                           g_modulator, vm);
 201 }
 202
 203 static int radio_si4713_s_modulator(struct file *file, void *p,
 204                                     const struct v4l2_modulator *vm)
 205 {
 206         return v4l2_device_call_until_err(get_v4l2_dev(file), 0, tuner,
 207                                           s_modulator, vm);
 208 }
 209
 210 static int radio_si4713_g_frequency(struct file *file, void *p,
 211                                     struct v4l2_frequency *vf)
 212 {
 213         return v4l2_device_call_until_err(get_v4l2_dev(file), 0, tuner,
 214                                           g_frequency, vf);
 215 }
 216
 217 static int radio_si4713_s_frequency(struct file *file, void *p,
 218                                     const struct v4l2_frequency *vf)
 219 {
 220         return v4l2_device_call_until_err(get_v4l2_dev(file), 0, tuner,
 221                                           s_frequency, vf);
 222 }
 223
 224 static long radio_si4713_default(struct file *file, void *p,
 225                                  bool valid_prio, int cmd, void *arg)
 226 {
 227         return v4l2_device_call_until_err(get_v4l2_dev(file), 0, core,
 228                                           ioctl, cmd, arg);
 229 }
 230
 231 static struct v4l2_ioctl_ops radio_si4713_ioctl_ops = {
 232         .vidioc_enumaudout      = radio_si4713_enumaudout,
 233         .vidioc_g_audout        = radio_si4713_g_audout,
 234         .vidioc_s_audout        = radio_si4713_s_audout,
 235         .vidioc_querycap        = radio_si4713_querycap,
 236         .vidioc_queryctrl       = radio_si4713_queryctrl,
 237         .vidioc_g_ext_ctrls     = radio_si4713_g_ext_ctrls,
 238         .vidioc_s_ext_ctrls     = radio_si4713_s_ext_ctrls,
 239         .vidioc_g_ctrl          = radio_si4713_g_ctrl,
 240         .vidioc_s_ctrl          = radio_si4713_s_ctrl,
 241         .vidioc_g_modulator     = radio_si4713_g_modulator,
 242         .vidioc_s_modulator     = radio_si4713_s_modulator,
 243         .vidioc_g_frequency     = radio_si4713_g_frequency,
 244         .vidioc_s_frequency     = radio_si4713_s_frequency,
 245         .vidioc_default         = radio_si4713_default,
 246 };
 247
 248 /* radio_si4713_vdev_template - video device interface */
 249 static struct video_device radio_si4713_vdev_template = {
 250         .fops                   = &radio_si4713_fops,
 251         .name                   = "radio-si4713",
 252         .release                = video_device_release,
 253         .ioctl_ops              = &radio_si4713_ioctl_ops,
 254         .vfl_dir                = VFL_DIR_TX,
 255 };
 256
 257 /* Platform driver interface */
 258 /* radio_si4713_pdriver_probe - probe for the device */
 259 static int radio_si4713_pdriver_probe(struct platform_device *pdev)
 260 {
 261         struct radio_si4713_platform_data *pdata = pdev->dev.platform_data;
 262         struct radio_si4713_device *rsdev;
 263         struct i2c_adapter *adapter;
 264         struct v4l2_subdev *sd;
 265         int rval = 0;
 266
 267         if (!pdata) {
 268                 dev_err(&pdev->dev, "Cannot proceed without platform data.\n");
 269                 rval = -EINVAL;
 270                 goto exit;
 271         }
 272
 273         rsdev = devm_kzalloc(&pdev->dev, sizeof(*rsdev), GFP_KERNEL);
 274         if (!rsdev) {
 275                 dev_err(&pdev->dev, "Failed to alloc video device.\n");
 276                 rval = -ENOMEM;
 277                 goto exit;
 278         }
 279
 280         rval = v4l2_device_register(&pdev->dev, &rsdev->v4l2_dev);
 281         if (rval) {
 282                 dev_err(&pdev->dev, "Failed to register v4l2 device.\n");
 283                 goto exit;
 284         }
 285
 286         adapter = i2c_get_adapter(pdata->i2c_bus);
 287         if (!adapter) {
 288                 dev_err(&pdev->dev, "Cannot get i2c adapter %d\n",
 289                         pdata->i2c_bus);
 290                 rval = -ENODEV;
 291                 goto unregister_v4l2_dev;
 292         }
 293
 294         sd = v4l2_i2c_new_subdev_board(&rsdev->v4l2_dev, adapter,
 295                                        pdata->subdev_board_info, NULL);
 296         if (!sd) {
 297                 dev_err(&pdev->dev, "Cannot get v4l2 subdevice\n");
 298                 rval = -ENODEV;
 299                 goto put_adapter;
 300         }
 301
 302         rsdev->radio_dev = video_device_alloc();
 303         if (!rsdev->radio_dev) {
 304                 dev_err(&pdev->dev, "Failed to alloc video device.\n");
 305                 rval = -ENOMEM;
 306                 goto put_adapter;
 307         }
 308
 309         memcpy(rsdev->radio_dev, &radio_si4713_vdev_template,
 310                sizeof(radio_si4713_vdev_template));
 311         video_set_drvdata(rsdev->radio_dev, rsdev);
 312         if (video_register_device(rsdev->radio_dev, VFL_TYPE_RADIO, radio_nr)) {
 313                 dev_err(&pdev->dev, "Could not register video device.\n");
 314                 rval = -EIO;
 315                 goto free_vdev;
 316         }
 317         dev_info(&pdev->dev, "New device successfully probed\n");
 318
 319         goto exit;
 320
 321 free_vdev:
 322         video_device_release(rsdev->radio_dev);
 323 put_adapter:
 324         i2c_put_adapter(adapter);
 325 unregister_v4l2_dev:
 326         v4l2_device_unregister(&rsdev->v4l2_dev);
 327 exit:
 328         return rval;
 329 }
 330
 331 /* radio_si4713_pdriver_remove - remove the device */
 332 static int radio_si4713_pdriver_remove(struct platform_device *pdev)
 333 {
 334         struct v4l2_device *v4l2_dev = platform_get_drvdata(pdev);
 335         struct v4l2_subdev *sd = list_entry(v4l2_dev->subdevs.next,
 336                                             struct v4l2_subdev, list);
 337         struct i2c_client *client = v4l2_get_subdevdata(sd);
 338         struct radio_si4713_device *rsdev;
 339
 340         rsdev = container_of(v4l2_dev, struct radio_si4713_device, v4l2_dev);
 341         video_unregister_device(rsdev->radio_dev);
 342         i2c_put_adapter(client->adapter);
 343         v4l2_device_unregister(&rsdev->v4l2_dev);
 344
 345         return 0;
 346 }
 347
 348 static struct platform_driver radio_si4713_pdriver = {
 349         .driver         = {
 350                 .name   = "radio-si4713",
 351                 .owner  = THIS_MODULE,
 352         },
 353         .probe          = radio_si4713_pdriver_probe,
 354         .remove         = radio_si4713_pdriver_remove,
 355 };
 356
 357 module_platform_driver(radio_si4713_pdriver);