drivers/media/platform/s5p-tv/sdo_drv.c

   1 /*
   2  * Samsung Standard Definition Output (SDO) driver
   3  *
   4  * Copyright (c) 2010-2011 Samsung Electronics Co., Ltd.
   5  *
   6  * Tomasz Stanislawski, <t.stanislaws@samsung.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published
  10  * by the Free Software Foundiation. either version 2 of the License,
  11  * or (at your option) any later version
  12  */
  13
  14 #include <linux/clk.h>
  15 #include <linux/delay.h>
  16 #include <linux/kernel.h>
  17 #include <linux/module.h>
  18 #include <linux/interrupt.h>
  19 #include <linux/io.h>
  20 #include <linux/irq.h>
  21 #include <linux/platform_device.h>
  22 #include <linux/pm_runtime.h>
  23 #include <linux/regulator/consumer.h>
  24 #include <linux/slab.h>
  25
  26 #include <media/v4l2-subdev.h>
  27
  28 #include "regs-sdo.h"
  29
  30 MODULE_AUTHOR("Tomasz Stanislawski, <t.stanislaws@samsung.com>");
  31 MODULE_DESCRIPTION("Samsung Standard Definition Output (SDO)");
  32 MODULE_LICENSE("GPL");
  33
  34 #define SDO_DEFAULT_STD V4L2_STD_PAL
  35
  36 struct sdo_format {
  37         v4l2_std_id id;
  38         /* all modes are 720 pixels wide */
  39         unsigned int height;
  40         unsigned int cookie;
  41 };
  42
  43 struct sdo_device {
  44         /** pointer to device parent */
  45         struct device *dev;
  46         /** base address of SDO registers */
  47         void __iomem *regs;
  48         /** SDO interrupt */
  49         unsigned int irq;
  50         /** DAC source clock */
  51         struct clk *sclk_dac;
  52         /** DAC clock */
  53         struct clk *dac;
  54         /** DAC physical interface */
  55         struct clk *dacphy;
  56         /** clock for control of VPLL */
  57         struct clk *fout_vpll;
  58         /** regulator for SDO IP power */
  59         struct regulator *vdac;
  60         /** regulator for SDO plug detection */
  61         struct regulator *vdet;
  62         /** subdev used as device interface */
  63         struct v4l2_subdev sd;
  64         /** current format */
  65         const struct sdo_format *fmt;
  66 };
  67
  68 static inline struct sdo_device *sd_to_sdev(struct v4l2_subdev *sd)
  69 {
  70         return container_of(sd, struct sdo_device, sd);
  71 }
  72
  73 static inline
  74 void sdo_write_mask(struct sdo_device *sdev, u32 reg_id, u32 value, u32 mask)
  75 {
  76         u32 old = readl(sdev->regs + reg_id);
  77         value = (value & mask) | (old & ~mask);
  78         writel(value, sdev->regs + reg_id);
  79 }
  80
  81 static inline
  82 void sdo_write(struct sdo_device *sdev, u32 reg_id, u32 value)
  83 {
  84         writel(value, sdev->regs + reg_id);
  85 }
  86
  87 static inline
  88 u32 sdo_read(struct sdo_device *sdev, u32 reg_id)
  89 {
  90         return readl(sdev->regs + reg_id);
  91 }
  92
  93 static irqreturn_t sdo_irq_handler(int irq, void *dev_data)
  94 {
  95         struct sdo_device *sdev = dev_data;
  96
  97         /* clear interrupt */
  98         sdo_write_mask(sdev, SDO_IRQ, ~0, SDO_VSYNC_IRQ_PEND);
  99         return IRQ_HANDLED;
 100 }
 101
 102 static void sdo_reg_debug(struct sdo_device *sdev)
 103 {
 104 #define DBGREG(reg_id) \
 105         dev_info(sdev->dev, #reg_id " = %08x\n", \
 106                 sdo_read(sdev, reg_id))
 107
 108         DBGREG(SDO_CLKCON);
 109         DBGREG(SDO_CONFIG);
 110         DBGREG(SDO_VBI);
 111         DBGREG(SDO_DAC);
 112         DBGREG(SDO_IRQ);
 113         DBGREG(SDO_IRQMASK);
 114         DBGREG(SDO_VERSION);
 115 }
 116
 117 static const struct sdo_format sdo_format[] = {
 118         { V4L2_STD_PAL_N,       .height = 576, .cookie = SDO_PAL_N },
 119         { V4L2_STD_PAL_Nc,      .height = 576, .cookie = SDO_PAL_NC },
 120         { V4L2_STD_PAL_M,       .height = 480, .cookie = SDO_PAL_M },
 121         { V4L2_STD_PAL_60,      .height = 480, .cookie = SDO_PAL_60 },
 122         { V4L2_STD_NTSC_443,    .height = 480, .cookie = SDO_NTSC_443 },
 123         { V4L2_STD_PAL,         .height = 576, .cookie = SDO_PAL_BGHID },
 124         { V4L2_STD_NTSC_M,      .height = 480, .cookie = SDO_NTSC_M },
 125 };
 126
 127 static const struct sdo_format *sdo_find_format(v4l2_std_id id)
 128 {
 129         int i;
 130         for (i = 0; i < ARRAY_SIZE(sdo_format); ++i)
 131                 if (sdo_format[i].id & id)
 132                         return &sdo_format[i];
 133         return NULL;
 134 }
 135
 136 static int sdo_g_tvnorms_output(struct v4l2_subdev *sd, v4l2_std_id *std)
 137 {
 138         *std = V4L2_STD_NTSC_M | V4L2_STD_PAL_M | V4L2_STD_PAL |
 139                 V4L2_STD_PAL_N | V4L2_STD_PAL_Nc |
 140                 V4L2_STD_NTSC_443 | V4L2_STD_PAL_60;
 141         return 0;
 142 }
 143
 144 static int sdo_s_std_output(struct v4l2_subdev *sd, v4l2_std_id std)
 145 {
 146         struct sdo_device *sdev = sd_to_sdev(sd);
 147         const struct sdo_format *fmt;
 148         fmt = sdo_find_format(std);
 149         if (fmt == NULL)
 150                 return -EINVAL;
 151         sdev->fmt = fmt;
 152         return 0;
 153 }
 154
 155 static int sdo_g_std_output(struct v4l2_subdev *sd, v4l2_std_id *std)
 156 {
 157         *std = sd_to_sdev(sd)->fmt->id;
 158         return 0;
 159 }
 160
 161 static int sdo_g_mbus_fmt(struct v4l2_subdev *sd,
 162         struct v4l2_mbus_framefmt *fmt)
 163 {
 164         struct sdo_device *sdev = sd_to_sdev(sd);
 165
 166         if (!sdev->fmt)
 167                 return -ENXIO;
 168         /* all modes are 720 pixels wide */
 169         fmt->width = 720;
 170         fmt->height = sdev->fmt->height;
 171         fmt->code = V4L2_MBUS_FMT_FIXED;
 172         fmt->field = V4L2_FIELD_INTERLACED;
 173         fmt->colorspace = V4L2_COLORSPACE_JPEG;
 174         return 0;
 175 }
 176
 177 static int sdo_s_power(struct v4l2_subdev *sd, int on)
 178 {
 179         struct sdo_device *sdev = sd_to_sdev(sd);
 180         struct device *dev = sdev->dev;
 181         int ret;
 182
 183         dev_info(dev, "sdo_s_power(%d)\n", on);
 184
 185         if (on)
 186                 ret = pm_runtime_get_sync(dev);
 187         else
 188                 ret = pm_runtime_put_sync(dev);
 189
 190         /* only values < 0 indicate errors */
 191         return IS_ERR_VALUE(ret) ? ret : 0;
 192 }
 193
 194 static int sdo_streamon(struct sdo_device *sdev)
 195 {
 196         /* set proper clock for Timing Generator */
 197         clk_set_rate(sdev->fout_vpll, 54000000);
 198         dev_info(sdev->dev, "fout_vpll.rate = %lu\n",
 199         clk_get_rate(sdev->fout_vpll));
 200         /* enable clock in SDO */
 201         sdo_write_mask(sdev, SDO_CLKCON, ~0, SDO_TVOUT_CLOCK_ON);
 202         clk_enable(sdev->dacphy);
 203         /* enable DAC */
 204         sdo_write_mask(sdev, SDO_DAC, ~0, SDO_POWER_ON_DAC);
 205         sdo_reg_debug(sdev);
 206         return 0;
 207 }
 208
 209 static int sdo_streamoff(struct sdo_device *sdev)
 210 {
 211         int tries;
 212
 213         sdo_write_mask(sdev, SDO_DAC, 0, SDO_POWER_ON_DAC);
 214         clk_disable(sdev->dacphy);
 215         sdo_write_mask(sdev, SDO_CLKCON, 0, SDO_TVOUT_CLOCK_ON);
 216         for (tries = 100; tries; --tries) {
 217                 if (sdo_read(sdev, SDO_CLKCON) & SDO_TVOUT_CLOCK_READY)
 218                         break;
 219                 mdelay(1);
 220         }
 221         if (tries == 0)
 222                 dev_err(sdev->dev, "failed to stop streaming\n");
 223         return tries ? 0 : -EIO;
 224 }
 225
 226 static int sdo_s_stream(struct v4l2_subdev *sd, int on)
 227 {
 228         struct sdo_device *sdev = sd_to_sdev(sd);
 229         return on ? sdo_streamon(sdev) : sdo_streamoff(sdev);
 230 }
 231
 232 static const struct v4l2_subdev_core_ops sdo_sd_core_ops = {
 233         .s_power = sdo_s_power,
 234 };
 235
 236 static const struct v4l2_subdev_video_ops sdo_sd_video_ops = {
 237         .s_std_output = sdo_s_std_output,
 238         .g_std_output = sdo_g_std_output,
 239         .g_tvnorms_output = sdo_g_tvnorms_output,
 240         .g_mbus_fmt = sdo_g_mbus_fmt,
 241         .s_stream = sdo_s_stream,
 242 };
 243
 244 static const struct v4l2_subdev_ops sdo_sd_ops = {
 245         .core = &sdo_sd_core_ops,
 246         .video = &sdo_sd_video_ops,
 247 };
 248
 249 static int sdo_runtime_suspend(struct device *dev)
 250 {
 251         struct v4l2_subdev *sd = dev_get_drvdata(dev);
 252         struct sdo_device *sdev = sd_to_sdev(sd);
 253
 254         dev_info(dev, "suspend\n");
 255         regulator_disable(sdev->vdet);
 256         regulator_disable(sdev->vdac);
 257         clk_disable(sdev->sclk_dac);
 258         return 0;
 259 }
 260
 261 static int sdo_runtime_resume(struct device *dev)
 262 {
 263         struct v4l2_subdev *sd = dev_get_drvdata(dev);
 264         struct sdo_device *sdev = sd_to_sdev(sd);
 265         int ret;
 266
 267         dev_info(dev, "resume\n");
 268
 269         ret = clk_enable(sdev->sclk_dac);
 270         if (ret < 0)
 271                 return ret;
 272
 273         ret = regulator_enable(sdev->vdac);
 274         if (ret < 0)
 275                 goto dac_clk_dis;
 276
 277         ret = regulator_enable(sdev->vdet);
 278         if (ret < 0)
 279                 goto vdac_r_dis;
 280
 281         /* software reset */
 282         sdo_write_mask(sdev, SDO_CLKCON, ~0, SDO_TVOUT_SW_RESET);
 283         mdelay(10);
 284         sdo_write_mask(sdev, SDO_CLKCON, 0, SDO_TVOUT_SW_RESET);
 285
 286         /* setting TV mode */
 287         sdo_write_mask(sdev, SDO_CONFIG, sdev->fmt->cookie, SDO_STANDARD_MASK);
 288         /* XXX: forcing interlaced mode using undocumented bit */
 289         sdo_write_mask(sdev, SDO_CONFIG, 0, SDO_PROGRESSIVE);
 290         /* turn all VBI off */
 291         sdo_write_mask(sdev, SDO_VBI, 0, SDO_CVBS_WSS_INS |
 292                 SDO_CVBS_CLOSED_CAPTION_MASK);
 293         /* turn all post processing off */
 294         sdo_write_mask(sdev, SDO_CCCON, ~0, SDO_COMPENSATION_BHS_ADJ_OFF |
 295                 SDO_COMPENSATION_CVBS_COMP_OFF);
 296         sdo_reg_debug(sdev);
 297         return 0;
 298
 299 vdac_r_dis:
 300         regulator_disable(sdev->vdac);
 301 dac_clk_dis:
 302         clk_disable(sdev->sclk_dac);
 303         return ret;
 304 }
 305
 306 static const struct dev_pm_ops sdo_pm_ops = {
 307         .runtime_suspend = sdo_runtime_suspend,
 308         .runtime_resume  = sdo_runtime_resume,
 309 };
 310
 311 static int sdo_probe(struct platform_device *pdev)
 312 {
 313         struct device *dev = &pdev->dev;
 314         struct sdo_device *sdev;
 315         struct resource *res;
 316         int ret = 0;
 317         struct clk *sclk_vpll;
 318
 319         dev_info(dev, "probe start\n");
 320         sdev = devm_kzalloc(&pdev->dev, sizeof(*sdev), GFP_KERNEL);
 321         if (!sdev) {
 322                 dev_err(dev, "not enough memory.\n");
 323                 ret = -ENOMEM;
 324                 goto fail;
 325         }
 326         sdev->dev = dev;
 327
 328         /* mapping registers */
 329         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 330         if (res == NULL) {
 331                 dev_err(dev, "get memory resource failed.\n");
 332                 ret = -ENXIO;
 333                 goto fail;
 334         }
 335
 336         sdev->regs = devm_ioremap(&pdev->dev, res->start, resource_size(res));
 337         if (sdev->regs == NULL) {
 338                 dev_err(dev, "register mapping failed.\n");
 339                 ret = -ENXIO;
 340                 goto fail;
 341         }
 342
 343         /* acquiring interrupt */
 344         res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 345         if (res == NULL) {
 346                 dev_err(dev, "get interrupt resource failed.\n");
 347                 ret = -ENXIO;
 348                 goto fail;
 349         }
 350         ret = devm_request_irq(&pdev->dev, res->start, sdo_irq_handler, 0,
 351                                "s5p-sdo", sdev);
 352         if (ret) {
 353                 dev_err(dev, "request interrupt failed.\n");
 354                 goto fail;
 355         }
 356         sdev->irq = res->start;
 357
 358         /* acquire clocks */
 359         sdev->sclk_dac = clk_get(dev, "sclk_dac");
 360         if (IS_ERR(sdev->sclk_dac)) {
 361                 dev_err(dev, "failed to get clock 'sclk_dac'\n");
 362                 ret = PTR_ERR(sdev->sclk_dac);
 363                 goto fail;
 364         }
 365         sdev->dac = clk_get(dev, "dac");
 366         if (IS_ERR(sdev->dac)) {
 367                 dev_err(dev, "failed to get clock 'dac'\n");
 368                 ret = PTR_ERR(sdev->dac);
 369                 goto fail_sclk_dac;
 370         }
 371         sdev->dacphy = clk_get(dev, "dacphy");
 372         if (IS_ERR(sdev->dacphy)) {
 373                 dev_err(dev, "failed to get clock 'dacphy'\n");
 374                 ret = PTR_ERR(sdev->dacphy);
 375                 goto fail_dac;
 376         }
 377         sclk_vpll = clk_get(dev, "sclk_vpll");
 378         if (IS_ERR(sclk_vpll)) {
 379                 dev_err(dev, "failed to get clock 'sclk_vpll'\n");
 380                 ret = PTR_ERR(sclk_vpll);
 381                 goto fail_dacphy;
 382         }
 383         clk_set_parent(sdev->sclk_dac, sclk_vpll);
 384         clk_put(sclk_vpll);
 385         sdev->fout_vpll = clk_get(dev, "fout_vpll");
 386         if (IS_ERR(sdev->fout_vpll)) {
 387                 dev_err(dev, "failed to get clock 'fout_vpll'\n");
 388                 ret = PTR_ERR(sdev->fout_vpll);
 389                 goto fail_dacphy;
 390         }
 391         dev_info(dev, "fout_vpll.rate = %lu\n", clk_get_rate(sclk_vpll));
 392
 393         /* acquire regulator */
 394         sdev->vdac = devm_regulator_get(dev, "vdd33a_dac");
 395         if (IS_ERR(sdev->vdac)) {
 396                 dev_err(dev, "failed to get regulator 'vdac'\n");
 397                 ret = PTR_ERR(sdev->vdac);
 398                 goto fail_fout_vpll;
 399         }
 400         sdev->vdet = devm_regulator_get(dev, "vdet");
 401         if (IS_ERR(sdev->vdet)) {
 402                 dev_err(dev, "failed to get regulator 'vdet'\n");
 403                 ret = PTR_ERR(sdev->vdet);
 404                 goto fail_fout_vpll;
 405         }
 406
 407         /* enable gate for dac clock, because mixer uses it */
 408         clk_enable(sdev->dac);
 409
 410         /* configure power management */
 411         pm_runtime_enable(dev);
 412
 413         /* configuration of interface subdevice */
 414         v4l2_subdev_init(&sdev->sd, &sdo_sd_ops);
 415         sdev->sd.owner = THIS_MODULE;
 416         strlcpy(sdev->sd.name, "s5p-sdo", sizeof(sdev->sd.name));
 417
 418         /* set default format */
 419         sdev->fmt = sdo_find_format(SDO_DEFAULT_STD);
 420         BUG_ON(sdev->fmt == NULL);
 421
 422         /* keeping subdev in device's private for use by other drivers */
 423         dev_set_drvdata(dev, &sdev->sd);
 424
 425         dev_info(dev, "probe succeeded\n");
 426         return 0;
 427
 428 fail_fout_vpll:
 429         clk_put(sdev->fout_vpll);
 430 fail_dacphy:
 431         clk_put(sdev->dacphy);
 432 fail_dac:
 433         clk_put(sdev->dac);
 434 fail_sclk_dac:
 435         clk_put(sdev->sclk_dac);
 436 fail:
 437         dev_info(dev, "probe failed\n");
 438         return ret;
 439 }
 440
 441 static int sdo_remove(struct platform_device *pdev)
 442 {
 443         struct v4l2_subdev *sd = dev_get_drvdata(&pdev->dev);
 444         struct sdo_device *sdev = sd_to_sdev(sd);
 445
 446         pm_runtime_disable(&pdev->dev);
 447         clk_disable(sdev->dac);
 448         clk_put(sdev->fout_vpll);
 449         clk_put(sdev->dacphy);
 450         clk_put(sdev->dac);
 451         clk_put(sdev->sclk_dac);
 452
 453         dev_info(&pdev->dev, "remove successful\n");
 454         return 0;
 455 }
 456
 457 static struct platform_driver sdo_driver __refdata = {
 458         .probe = sdo_probe,
 459         .remove = sdo_remove,
 460         .driver = {
 461                 .name = "s5p-sdo",
 462                 .owner = THIS_MODULE,
 463                 .pm = &sdo_pm_ops,
 464         }
 465 };
 466
 467 module_platform_driver(sdo_driver);