drivers/media/platform/rcar-vin/rcar-csi2.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Driver for Renesas R-Car MIPI CSI-2 Receiver
   4  *
   5  * Copyright (C) 2018 Renesas Electronics Corp.
   6  */
   7
   8 #include <linux/delay.h>
   9 #include <linux/interrupt.h>
  10 #include <linux/io.h>
  11 #include <linux/module.h>
  12 #include <linux/of.h>
  13 #include <linux/of_device.h>
  14 #include <linux/of_graph.h>
  15 #include <linux/platform_device.h>
  16 #include <linux/pm_runtime.h>
  17 #include <linux/sys_soc.h>
  18
  19 #include <media/v4l2-ctrls.h>
  20 #include <media/v4l2-device.h>
  21 #include <media/v4l2-fwnode.h>
  22 #include <media/v4l2-mc.h>
  23 #include <media/v4l2-subdev.h>
  24
  25 struct rcar_csi2;
  26
  27 /* Register offsets and bits */
  28
  29 /* Control Timing Select */
  30 #define TREF_REG                        0x00
  31 #define TREF_TREF                       BIT(0)
  32
  33 /* Software Reset */
  34 #define SRST_REG                        0x04
  35 #define SRST_SRST                       BIT(0)
  36
  37 /* PHY Operation Control */
  38 #define PHYCNT_REG                      0x08
  39 #define PHYCNT_SHUTDOWNZ                BIT(17)
  40 #define PHYCNT_RSTZ                     BIT(16)
  41 #define PHYCNT_ENABLECLK                BIT(4)
  42 #define PHYCNT_ENABLE_3                 BIT(3)
  43 #define PHYCNT_ENABLE_2                 BIT(2)
  44 #define PHYCNT_ENABLE_1                 BIT(1)
  45 #define PHYCNT_ENABLE_0                 BIT(0)
  46
  47 /* Checksum Control */
  48 #define CHKSUM_REG                      0x0c
  49 #define CHKSUM_ECC_EN                   BIT(1)
  50 #define CHKSUM_CRC_EN                   BIT(0)
  51
  52 /*
  53  * Channel Data Type Select
  54  * VCDT[0-15]:  Channel 1 VCDT[16-31]:  Channel 2
  55  * VCDT2[0-15]: Channel 3 VCDT2[16-31]: Channel 4
  56  */
  57 #define VCDT_REG                        0x10
  58 #define VCDT2_REG                       0x14
  59 #define VCDT_VCDTN_EN                   BIT(15)
  60 #define VCDT_SEL_VC(n)                  (((n) & 0x3) << 8)
  61 #define VCDT_SEL_DTN_ON                 BIT(6)
  62 #define VCDT_SEL_DT(n)                  (((n) & 0x3f) << 0)
  63
  64 /* Frame Data Type Select */
  65 #define FRDT_REG                        0x18
  66
  67 /* Field Detection Control */
  68 #define FLD_REG                         0x1c
  69 #define FLD_FLD_NUM(n)                  (((n) & 0xff) << 16)
  70 #define FLD_FLD_EN4                     BIT(3)
  71 #define FLD_FLD_EN3                     BIT(2)
  72 #define FLD_FLD_EN2                     BIT(1)
  73 #define FLD_FLD_EN                      BIT(0)
  74
  75 /* Automatic Standby Control */
  76 #define ASTBY_REG                       0x20
  77
  78 /* Long Data Type Setting 0 */
  79 #define LNGDT0_REG                      0x28
  80
  81 /* Long Data Type Setting 1 */
  82 #define LNGDT1_REG                      0x2c
  83
  84 /* Interrupt Enable */
  85 #define INTEN_REG                       0x30
  86
  87 /* Interrupt Source Mask */
  88 #define INTCLOSE_REG                    0x34
  89
  90 /* Interrupt Status Monitor */
  91 #define INTSTATE_REG                    0x38
  92 #define INTSTATE_INT_ULPS_START         BIT(7)
  93 #define INTSTATE_INT_ULPS_END           BIT(6)
  94
  95 /* Interrupt Error Status Monitor */
  96 #define INTERRSTATE_REG                 0x3c
  97
  98 /* Short Packet Data */
  99 #define SHPDAT_REG                      0x40
 100
 101 /* Short Packet Count */
 102 #define SHPCNT_REG                      0x44
 103
 104 /* LINK Operation Control */
 105 #define LINKCNT_REG                     0x48
 106 #define LINKCNT_MONITOR_EN              BIT(31)
 107 #define LINKCNT_REG_MONI_PACT_EN        BIT(25)
 108 #define LINKCNT_ICLK_NONSTOP            BIT(24)
 109
 110 /* Lane Swap */
 111 #define LSWAP_REG                       0x4c
 112 #define LSWAP_L3SEL(n)                  (((n) & 0x3) << 6)
 113 #define LSWAP_L2SEL(n)                  (((n) & 0x3) << 4)
 114 #define LSWAP_L1SEL(n)                  (((n) & 0x3) << 2)
 115 #define LSWAP_L0SEL(n)                  (((n) & 0x3) << 0)
 116
 117 /* PHY Test Interface Write Register */
 118 #define PHTW_REG                        0x50
 119 #define PHTW_DWEN                       BIT(24)
 120 #define PHTW_TESTDIN_DATA(n)            (((n & 0xff)) << 16)
 121 #define PHTW_CWEN                       BIT(8)
 122 #define PHTW_TESTDIN_CODE(n)            ((n & 0xff))
 123
 124 struct phtw_value {
 125         u16 data;
 126         u16 code;
 127 };
 128
 129 struct rcsi2_mbps_reg {
 130         u16 mbps;
 131         u16 reg;
 132 };
 133
 134 static const struct rcsi2_mbps_reg phtw_mbps_h3_v3h_m3n[] = {
 135         { .mbps =   80, .reg = 0x86 },
 136         { .mbps =   90, .reg = 0x86 },
 137         { .mbps =  100, .reg = 0x87 },
 138         { .mbps =  110, .reg = 0x87 },
 139         { .mbps =  120, .reg = 0x88 },
 140         { .mbps =  130, .reg = 0x88 },
 141         { .mbps =  140, .reg = 0x89 },
 142         { .mbps =  150, .reg = 0x89 },
 143         { .mbps =  160, .reg = 0x8a },
 144         { .mbps =  170, .reg = 0x8a },
 145         { .mbps =  180, .reg = 0x8b },
 146         { .mbps =  190, .reg = 0x8b },
 147         { .mbps =  205, .reg = 0x8c },
 148         { .mbps =  220, .reg = 0x8d },
 149         { .mbps =  235, .reg = 0x8e },
 150         { .mbps =  250, .reg = 0x8e },
 151         { /* sentinel */ },
 152 };
 153
 154 static const struct rcsi2_mbps_reg phtw_mbps_v3m_e3[] = {
 155         { .mbps =   80, .reg = 0x00 },
 156         { .mbps =   90, .reg = 0x20 },
 157         { .mbps =  100, .reg = 0x40 },
 158         { .mbps =  110, .reg = 0x02 },
 159         { .mbps =  130, .reg = 0x22 },
 160         { .mbps =  140, .reg = 0x42 },
 161         { .mbps =  150, .reg = 0x04 },
 162         { .mbps =  170, .reg = 0x24 },
 163         { .mbps =  180, .reg = 0x44 },
 164         { .mbps =  200, .reg = 0x06 },
 165         { .mbps =  220, .reg = 0x26 },
 166         { .mbps =  240, .reg = 0x46 },
 167         { .mbps =  250, .reg = 0x08 },
 168         { .mbps =  270, .reg = 0x28 },
 169         { .mbps =  300, .reg = 0x0a },
 170         { .mbps =  330, .reg = 0x2a },
 171         { .mbps =  360, .reg = 0x4a },
 172         { .mbps =  400, .reg = 0x0c },
 173         { .mbps =  450, .reg = 0x2c },
 174         { .mbps =  500, .reg = 0x0e },
 175         { .mbps =  550, .reg = 0x2e },
 176         { .mbps =  600, .reg = 0x10 },
 177         { .mbps =  650, .reg = 0x30 },
 178         { .mbps =  700, .reg = 0x12 },
 179         { .mbps =  750, .reg = 0x32 },
 180         { .mbps =  800, .reg = 0x52 },
 181         { .mbps =  850, .reg = 0x72 },
 182         { .mbps =  900, .reg = 0x14 },
 183         { .mbps =  950, .reg = 0x34 },
 184         { .mbps = 1000, .reg = 0x54 },
 185         { .mbps = 1050, .reg = 0x74 },
 186         { .mbps = 1125, .reg = 0x16 },
 187         { /* sentinel */ },
 188 };
 189
 190 /* PHY Test Interface Clear */
 191 #define PHTC_REG                        0x58
 192 #define PHTC_TESTCLR                    BIT(0)
 193
 194 /* PHY Frequency Control */
 195 #define PHYPLL_REG                      0x68
 196 #define PHYPLL_HSFREQRANGE(n)           ((n) << 16)
 197
 198 static const struct rcsi2_mbps_reg hsfreqrange_h3_v3h_m3n[] = {
 199         { .mbps =   80, .reg = 0x00 },
 200         { .mbps =   90, .reg = 0x10 },
 201         { .mbps =  100, .reg = 0x20 },
 202         { .mbps =  110, .reg = 0x30 },
 203         { .mbps =  120, .reg = 0x01 },
 204         { .mbps =  130, .reg = 0x11 },
 205         { .mbps =  140, .reg = 0x21 },
 206         { .mbps =  150, .reg = 0x31 },
 207         { .mbps =  160, .reg = 0x02 },
 208         { .mbps =  170, .reg = 0x12 },
 209         { .mbps =  180, .reg = 0x22 },
 210         { .mbps =  190, .reg = 0x32 },
 211         { .mbps =  205, .reg = 0x03 },
 212         { .mbps =  220, .reg = 0x13 },
 213         { .mbps =  235, .reg = 0x23 },
 214         { .mbps =  250, .reg = 0x33 },
 215         { .mbps =  275, .reg = 0x04 },
 216         { .mbps =  300, .reg = 0x14 },
 217         { .mbps =  325, .reg = 0x25 },
 218         { .mbps =  350, .reg = 0x35 },
 219         { .mbps =  400, .reg = 0x05 },
 220         { .mbps =  450, .reg = 0x16 },
 221         { .mbps =  500, .reg = 0x26 },
 222         { .mbps =  550, .reg = 0x37 },
 223         { .mbps =  600, .reg = 0x07 },
 224         { .mbps =  650, .reg = 0x18 },
 225         { .mbps =  700, .reg = 0x28 },
 226         { .mbps =  750, .reg = 0x39 },
 227         { .mbps =  800, .reg = 0x09 },
 228         { .mbps =  850, .reg = 0x19 },
 229         { .mbps =  900, .reg = 0x29 },
 230         { .mbps =  950, .reg = 0x3a },
 231         { .mbps = 1000, .reg = 0x0a },
 232         { .mbps = 1050, .reg = 0x1a },
 233         { .mbps = 1100, .reg = 0x2a },
 234         { .mbps = 1150, .reg = 0x3b },
 235         { .mbps = 1200, .reg = 0x0b },
 236         { .mbps = 1250, .reg = 0x1b },
 237         { .mbps = 1300, .reg = 0x2b },
 238         { .mbps = 1350, .reg = 0x3c },
 239         { .mbps = 1400, .reg = 0x0c },
 240         { .mbps = 1450, .reg = 0x1c },
 241         { .mbps = 1500, .reg = 0x2c },
 242         { /* sentinel */ },
 243 };
 244
 245 static const struct rcsi2_mbps_reg hsfreqrange_m3w_h3es1[] = {
 246         { .mbps =   80, .reg = 0x00 },
 247         { .mbps =   90, .reg = 0x10 },
 248         { .mbps =  100, .reg = 0x20 },
 249         { .mbps =  110, .reg = 0x30 },
 250         { .mbps =  120, .reg = 0x01 },
 251         { .mbps =  130, .reg = 0x11 },
 252         { .mbps =  140, .reg = 0x21 },
 253         { .mbps =  150, .reg = 0x31 },
 254         { .mbps =  160, .reg = 0x02 },
 255         { .mbps =  170, .reg = 0x12 },
 256         { .mbps =  180, .reg = 0x22 },
 257         { .mbps =  190, .reg = 0x32 },
 258         { .mbps =  205, .reg = 0x03 },
 259         { .mbps =  220, .reg = 0x13 },
 260         { .mbps =  235, .reg = 0x23 },
 261         { .mbps =  250, .reg = 0x33 },
 262         { .mbps =  275, .reg = 0x04 },
 263         { .mbps =  300, .reg = 0x14 },
 264         { .mbps =  325, .reg = 0x05 },
 265         { .mbps =  350, .reg = 0x15 },
 266         { .mbps =  400, .reg = 0x25 },
 267         { .mbps =  450, .reg = 0x06 },
 268         { .mbps =  500, .reg = 0x16 },
 269         { .mbps =  550, .reg = 0x07 },
 270         { .mbps =  600, .reg = 0x17 },
 271         { .mbps =  650, .reg = 0x08 },
 272         { .mbps =  700, .reg = 0x18 },
 273         { .mbps =  750, .reg = 0x09 },
 274         { .mbps =  800, .reg = 0x19 },
 275         { .mbps =  850, .reg = 0x29 },
 276         { .mbps =  900, .reg = 0x39 },
 277         { .mbps =  950, .reg = 0x0a },
 278         { .mbps = 1000, .reg = 0x1a },
 279         { .mbps = 1050, .reg = 0x2a },
 280         { .mbps = 1100, .reg = 0x3a },
 281         { .mbps = 1150, .reg = 0x0b },
 282         { .mbps = 1200, .reg = 0x1b },
 283         { .mbps = 1250, .reg = 0x2b },
 284         { .mbps = 1300, .reg = 0x3b },
 285         { .mbps = 1350, .reg = 0x0c },
 286         { .mbps = 1400, .reg = 0x1c },
 287         { .mbps = 1450, .reg = 0x2c },
 288         { .mbps = 1500, .reg = 0x3c },
 289         { /* sentinel */ },
 290 };
 291
 292 /* PHY ESC Error Monitor */
 293 #define PHEERM_REG                      0x74
 294
 295 /* PHY Clock Lane Monitor */
 296 #define PHCLM_REG                       0x78
 297 #define PHCLM_STOPSTATECKL              BIT(0)
 298
 299 /* PHY Data Lane Monitor */
 300 #define PHDLM_REG                       0x7c
 301
 302 /* CSI0CLK Frequency Configuration Preset Register */
 303 #define CSI0CLKFCPR_REG                 0x260
 304 #define CSI0CLKFREQRANGE(n)             ((n & 0x3f) << 16)
 305
 306 struct rcar_csi2_format {
 307         u32 code;
 308         unsigned int datatype;
 309         unsigned int bpp;
 310 };
 311
 312 static const struct rcar_csi2_format rcar_csi2_formats[] = {
 313         { .code = MEDIA_BUS_FMT_RGB888_1X24,    .datatype = 0x24, .bpp = 24 },
 314         { .code = MEDIA_BUS_FMT_UYVY8_1X16,     .datatype = 0x1e, .bpp = 16 },
 315         { .code = MEDIA_BUS_FMT_YUYV8_1X16,     .datatype = 0x1e, .bpp = 16 },
 316         { .code = MEDIA_BUS_FMT_UYVY8_2X8,      .datatype = 0x1e, .bpp = 16 },
 317         { .code = MEDIA_BUS_FMT_YUYV10_2X10,    .datatype = 0x1e, .bpp = 20 },
 318 };
 319
 320 static const struct rcar_csi2_format *rcsi2_code_to_fmt(unsigned int code)
 321 {
 322         unsigned int i;
 323
 324         for (i = 0; i < ARRAY_SIZE(rcar_csi2_formats); i++)
 325                 if (rcar_csi2_formats[i].code == code)
 326                         return &rcar_csi2_formats[i];
 327
 328         return NULL;
 329 }
 330
 331 enum rcar_csi2_pads {
 332         RCAR_CSI2_SINK,
 333         RCAR_CSI2_SOURCE_VC0,
 334         RCAR_CSI2_SOURCE_VC1,
 335         RCAR_CSI2_SOURCE_VC2,
 336         RCAR_CSI2_SOURCE_VC3,
 337         NR_OF_RCAR_CSI2_PAD,
 338 };
 339
 340 struct rcar_csi2_info {
 341         int (*init_phtw)(struct rcar_csi2 *priv, unsigned int mbps);
 342         int (*confirm_start)(struct rcar_csi2 *priv);
 343         const struct rcsi2_mbps_reg *hsfreqrange;
 344         unsigned int csi0clkfreqrange;
 345         bool clear_ulps;
 346 };
 347
 348 struct rcar_csi2 {
 349         struct device *dev;
 350         void __iomem *base;
 351         const struct rcar_csi2_info *info;
 352
 353         struct v4l2_subdev subdev;
 354         struct media_pad pads[NR_OF_RCAR_CSI2_PAD];
 355
 356         struct v4l2_async_notifier notifier;
 357         struct v4l2_async_subdev asd;
 358         struct v4l2_subdev *remote;
 359
 360         struct v4l2_mbus_framefmt mf;
 361
 362         struct mutex lock;
 363         int stream_count;
 364
 365         unsigned short lanes;
 366         unsigned char lane_swap[4];
 367 };
 368
 369 static inline struct rcar_csi2 *sd_to_csi2(struct v4l2_subdev *sd)
 370 {
 371         return container_of(sd, struct rcar_csi2, subdev);
 372 }
 373
 374 static inline struct rcar_csi2 *notifier_to_csi2(struct v4l2_async_notifier *n)
 375 {
 376         return container_of(n, struct rcar_csi2, notifier);
 377 }
 378
 379 static u32 rcsi2_read(struct rcar_csi2 *priv, unsigned int reg)
 380 {
 381         return ioread32(priv->base + reg);
 382 }
 383
 384 static void rcsi2_write(struct rcar_csi2 *priv, unsigned int reg, u32 data)
 385 {
 386         iowrite32(data, priv->base + reg);
 387 }
 388
 389 static void rcsi2_reset(struct rcar_csi2 *priv)
 390 {
 391         rcsi2_write(priv, SRST_REG, SRST_SRST);
 392         usleep_range(100, 150);
 393         rcsi2_write(priv, SRST_REG, 0);
 394 }
 395
 396 static int rcsi2_wait_phy_start(struct rcar_csi2 *priv)
 397 {
 398         unsigned int timeout;
 399
 400         /* Wait for the clock and data lanes to enter LP-11 state. */
 401         for (timeout = 0; timeout <= 20; timeout++) {
 402                 const u32 lane_mask = (1 << priv->lanes) - 1;
 403
 404                 if ((rcsi2_read(priv, PHCLM_REG) & PHCLM_STOPSTATECKL)  &&
 405                     (rcsi2_read(priv, PHDLM_REG) & lane_mask) == lane_mask)
 406                         return 0;
 407
 408                 usleep_range(1000, 2000);
 409         }
 410
 411         dev_err(priv->dev, "Timeout waiting for LP-11 state\n");
 412
 413         return -ETIMEDOUT;
 414 }
 415
 416 static int rcsi2_set_phypll(struct rcar_csi2 *priv, unsigned int mbps)
 417 {
 418         const struct rcsi2_mbps_reg *hsfreq;
 419         const struct rcsi2_mbps_reg *hsfreq_prev = NULL;
 420
 421         for (hsfreq = priv->info->hsfreqrange; hsfreq->mbps != 0; hsfreq++) {
 422                 if (hsfreq->mbps >= mbps)
 423                         break;
 424                 hsfreq_prev = hsfreq;
 425         }
 426
 427         if (!hsfreq->mbps) {
 428                 dev_err(priv->dev, "Unsupported PHY speed (%u Mbps)", mbps);
 429                 return -ERANGE;
 430         }
 431
 432         if (hsfreq_prev &&
 433             ((mbps - hsfreq_prev->mbps) <= (hsfreq->mbps - mbps)))
 434                 hsfreq = hsfreq_prev;
 435
 436         rcsi2_write(priv, PHYPLL_REG, PHYPLL_HSFREQRANGE(hsfreq->reg));
 437
 438         return 0;
 439 }
 440
 441 static int rcsi2_calc_mbps(struct rcar_csi2 *priv, unsigned int bpp)
 442 {
 443         struct v4l2_subdev *source;
 444         struct v4l2_ctrl *ctrl;
 445         u64 mbps;
 446
 447         if (!priv->remote)
 448                 return -ENODEV;
 449
 450         source = priv->remote;
 451
 452         /* Read the pixel rate control from remote. */
 453         ctrl = v4l2_ctrl_find(source->ctrl_handler, V4L2_CID_PIXEL_RATE);
 454         if (!ctrl) {
 455                 dev_err(priv->dev, "no pixel rate control in subdev %s\n",
 456                         source->name);
 457                 return -EINVAL;
 458         }
 459
 460         /*
 461          * Calculate the phypll in mbps.
 462          * link_freq = (pixel_rate * bits_per_sample) / (2 * nr_of_lanes)
 463          * bps = link_freq * 2
 464          */
 465         mbps = v4l2_ctrl_g_ctrl_int64(ctrl) * bpp;
 466         do_div(mbps, priv->lanes * 1000000);
 467
 468         return mbps;
 469 }
 470
 471 static int rcsi2_start(struct rcar_csi2 *priv)
 472 {
 473         const struct rcar_csi2_format *format;
 474         u32 phycnt, vcdt = 0, vcdt2 = 0;
 475         unsigned int i;
 476         int mbps, ret;
 477
 478         dev_dbg(priv->dev, "Input size (%ux%u%c)\n",
 479                 priv->mf.width, priv->mf.height,
 480                 priv->mf.field == V4L2_FIELD_NONE ? 'p' : 'i');
 481
 482         /* Code is validated in set_fmt. */
 483         format = rcsi2_code_to_fmt(priv->mf.code);
 484         if (!format)
 485                 return -EINVAL;
 486
 487         /*
 488          * Enable all Virtual Channels.
 489          *
 490          * NOTE: It's not possible to get individual datatype for each
 491          *       source virtual channel. Once this is possible in V4L2
 492          *       it should be used here.
 493          */
 494         for (i = 0; i < 4; i++) {
 495                 u32 vcdt_part;
 496
 497                 vcdt_part = VCDT_SEL_VC(i) | VCDT_VCDTN_EN | VCDT_SEL_DTN_ON |
 498                         VCDT_SEL_DT(format->datatype);
 499
 500                 /* Store in correct reg and offset. */
 501                 if (i < 2)
 502                         vcdt |= vcdt_part << ((i % 2) * 16);
 503                 else
 504                         vcdt2 |= vcdt_part << ((i % 2) * 16);
 505         }
 506
 507         phycnt = PHYCNT_ENABLECLK;
 508         phycnt |= (1 << priv->lanes) - 1;
 509
 510         mbps = rcsi2_calc_mbps(priv, format->bpp);
 511         if (mbps < 0)
 512                 return mbps;
 513
 514         /* Init */
 515         rcsi2_write(priv, TREF_REG, TREF_TREF);
 516         rcsi2_reset(priv);
 517         rcsi2_write(priv, PHTC_REG, 0);
 518
 519         /* Configure */
 520         rcsi2_write(priv, FLD_REG, FLD_FLD_NUM(2) | FLD_FLD_EN4 |
 521                     FLD_FLD_EN3 | FLD_FLD_EN2 | FLD_FLD_EN);
 522         rcsi2_write(priv, VCDT_REG, vcdt);
 523         rcsi2_write(priv, VCDT2_REG, vcdt2);
 524         /* Lanes are zero indexed. */
 525         rcsi2_write(priv, LSWAP_REG,
 526                     LSWAP_L0SEL(priv->lane_swap[0] - 1) |
 527                     LSWAP_L1SEL(priv->lane_swap[1] - 1) |
 528                     LSWAP_L2SEL(priv->lane_swap[2] - 1) |
 529                     LSWAP_L3SEL(priv->lane_swap[3] - 1));
 530
 531         /* Start */
 532         if (priv->info->init_phtw) {
 533                 ret = priv->info->init_phtw(priv, mbps);
 534                 if (ret)
 535                         return ret;
 536         }
 537
 538         if (priv->info->hsfreqrange) {
 539                 ret = rcsi2_set_phypll(priv, mbps);
 540                 if (ret)
 541                         return ret;
 542         }
 543
 544         if (priv->info->csi0clkfreqrange)
 545                 rcsi2_write(priv, CSI0CLKFCPR_REG,
 546                             CSI0CLKFREQRANGE(priv->info->csi0clkfreqrange));
 547
 548         rcsi2_write(priv, PHYCNT_REG, phycnt);
 549         rcsi2_write(priv, LINKCNT_REG, LINKCNT_MONITOR_EN |
 550                     LINKCNT_REG_MONI_PACT_EN | LINKCNT_ICLK_NONSTOP);
 551         rcsi2_write(priv, PHYCNT_REG, phycnt | PHYCNT_SHUTDOWNZ);
 552         rcsi2_write(priv, PHYCNT_REG, phycnt | PHYCNT_SHUTDOWNZ | PHYCNT_RSTZ);
 553
 554         ret = rcsi2_wait_phy_start(priv);
 555         if (ret)
 556                 return ret;
 557
 558         /* Confirm start */
 559         if (priv->info->confirm_start) {
 560                 ret = priv->info->confirm_start(priv);
 561                 if (ret)
 562                         return ret;
 563         }
 564
 565         /* Clear Ultra Low Power interrupt. */
 566         if (priv->info->clear_ulps)
 567                 rcsi2_write(priv, INTSTATE_REG,
 568                             INTSTATE_INT_ULPS_START |
 569                             INTSTATE_INT_ULPS_END);
 570         return 0;
 571 }
 572
 573 static void rcsi2_stop(struct rcar_csi2 *priv)
 574 {
 575         rcsi2_write(priv, PHYCNT_REG, 0);
 576
 577         rcsi2_reset(priv);
 578
 579         rcsi2_write(priv, PHTC_REG, PHTC_TESTCLR);
 580 }
 581
 582 static int rcsi2_s_stream(struct v4l2_subdev *sd, int enable)
 583 {
 584         struct rcar_csi2 *priv = sd_to_csi2(sd);
 585         struct v4l2_subdev *nextsd;
 586         int ret = 0;
 587
 588         mutex_lock(&priv->lock);
 589
 590         if (!priv->remote) {
 591                 ret = -ENODEV;
 592                 goto out;
 593         }
 594
 595         nextsd = priv->remote;
 596
 597         if (enable && priv->stream_count == 0) {
 598                 pm_runtime_get_sync(priv->dev);
 599
 600                 ret = rcsi2_start(priv);
 601                 if (ret) {
 602                         pm_runtime_put(priv->dev);
 603                         goto out;
 604                 }
 605
 606                 ret = v4l2_subdev_call(nextsd, video, s_stream, 1);
 607                 if (ret) {
 608                         rcsi2_stop(priv);
 609                         pm_runtime_put(priv->dev);
 610                         goto out;
 611                 }
 612         } else if (!enable && priv->stream_count == 1) {
 613                 rcsi2_stop(priv);
 614                 v4l2_subdev_call(nextsd, video, s_stream, 0);
 615                 pm_runtime_put(priv->dev);
 616         }
 617
 618         priv->stream_count += enable ? 1 : -1;
 619 out:
 620         mutex_unlock(&priv->lock);
 621
 622         return ret;
 623 }
 624
 625 static int rcsi2_set_pad_format(struct v4l2_subdev *sd,
 626                                 struct v4l2_subdev_pad_config *cfg,
 627                                 struct v4l2_subdev_format *format)
 628 {
 629         struct rcar_csi2 *priv = sd_to_csi2(sd);
 630         struct v4l2_mbus_framefmt *framefmt;
 631
 632         if (!rcsi2_code_to_fmt(format->format.code))
 633                 format->format.code = rcar_csi2_formats[0].code;
 634
 635         if (format->which == V4L2_SUBDEV_FORMAT_ACTIVE) {
 636                 priv->mf = format->format;
 637         } else {
 638                 framefmt = v4l2_subdev_get_try_format(sd, cfg, 0);
 639                 *framefmt = format->format;
 640         }
 641
 642         return 0;
 643 }
 644
 645 static int rcsi2_get_pad_format(struct v4l2_subdev *sd,
 646                                 struct v4l2_subdev_pad_config *cfg,
 647                                 struct v4l2_subdev_format *format)
 648 {
 649         struct rcar_csi2 *priv = sd_to_csi2(sd);
 650
 651         if (format->which == V4L2_SUBDEV_FORMAT_ACTIVE)
 652                 format->format = priv->mf;
 653         else
 654                 format->format = *v4l2_subdev_get_try_format(sd, cfg, 0);
 655
 656         return 0;
 657 }
 658
 659 static const struct v4l2_subdev_video_ops rcar_csi2_video_ops = {
 660         .s_stream = rcsi2_s_stream,
 661 };
 662
 663 static const struct v4l2_subdev_pad_ops rcar_csi2_pad_ops = {
 664         .set_fmt = rcsi2_set_pad_format,
 665         .get_fmt = rcsi2_get_pad_format,
 666 };
 667
 668 static const struct v4l2_subdev_ops rcar_csi2_subdev_ops = {
 669         .video  = &rcar_csi2_video_ops,
 670         .pad    = &rcar_csi2_pad_ops,
 671 };
 672
 673 /* -----------------------------------------------------------------------------
 674  * Async handling and registration of subdevices and links.
 675  */
 676
 677 static int rcsi2_notify_bound(struct v4l2_async_notifier *notifier,
 678                               struct v4l2_subdev *subdev,
 679                               struct v4l2_async_subdev *asd)
 680 {
 681         struct rcar_csi2 *priv = notifier_to_csi2(notifier);
 682         int pad;
 683
 684         pad = media_entity_get_fwnode_pad(&subdev->entity, asd->match.fwnode,
 685                                           MEDIA_PAD_FL_SOURCE);
 686         if (pad < 0) {
 687                 dev_err(priv->dev, "Failed to find pad for %s\n", subdev->name);
 688                 return pad;
 689         }
 690
 691         priv->remote = subdev;
 692
 693         dev_dbg(priv->dev, "Bound %s pad: %d\n", subdev->name, pad);
 694
 695         return media_create_pad_link(&subdev->entity, pad,
 696                                      &priv->subdev.entity, 0,
 697                                      MEDIA_LNK_FL_ENABLED |
 698                                      MEDIA_LNK_FL_IMMUTABLE);
 699 }
 700
 701 static void rcsi2_notify_unbind(struct v4l2_async_notifier *notifier,
 702                                 struct v4l2_subdev *subdev,
 703                                 struct v4l2_async_subdev *asd)
 704 {
 705         struct rcar_csi2 *priv = notifier_to_csi2(notifier);
 706
 707         priv->remote = NULL;
 708
 709         dev_dbg(priv->dev, "Unbind %s\n", subdev->name);
 710 }
 711
 712 static const struct v4l2_async_notifier_operations rcar_csi2_notify_ops = {
 713         .bound = rcsi2_notify_bound,
 714         .unbind = rcsi2_notify_unbind,
 715 };
 716
 717 static int rcsi2_parse_v4l2(struct rcar_csi2 *priv,
 718                             struct v4l2_fwnode_endpoint *vep)
 719 {
 720         unsigned int i;
 721
 722         /* Only port 0 endpoint 0 is valid. */
 723         if (vep->base.port || vep->base.id)
 724                 return -ENOTCONN;
 725
 726         if (vep->bus_type != V4L2_MBUS_CSI2) {
 727                 dev_err(priv->dev, "Unsupported bus: %u\n", vep->bus_type);
 728                 return -EINVAL;
 729         }
 730
 731         priv->lanes = vep->bus.mipi_csi2.num_data_lanes;
 732         if (priv->lanes != 1 && priv->lanes != 2 && priv->lanes != 4) {
 733                 dev_err(priv->dev, "Unsupported number of data-lanes: %u\n",
 734                         priv->lanes);
 735                 return -EINVAL;
 736         }
 737
 738         for (i = 0; i < ARRAY_SIZE(priv->lane_swap); i++) {
 739                 priv->lane_swap[i] = i < priv->lanes ?
 740                         vep->bus.mipi_csi2.data_lanes[i] : i;
 741
 742                 /* Check for valid lane number. */
 743                 if (priv->lane_swap[i] < 1 || priv->lane_swap[i] > 4) {
 744                         dev_err(priv->dev, "data-lanes must be in 1-4 range\n");
 745                         return -EINVAL;
 746                 }
 747         }
 748
 749         return 0;
 750 }
 751
 752 static int rcsi2_parse_dt(struct rcar_csi2 *priv)
 753 {
 754         struct device_node *ep;
 755         struct v4l2_fwnode_endpoint v4l2_ep;
 756         int ret;
 757
 758         ep = of_graph_get_endpoint_by_regs(priv->dev->of_node, 0, 0);
 759         if (!ep) {
 760                 dev_err(priv->dev, "Not connected to subdevice\n");
 761                 return -EINVAL;
 762         }
 763
 764         ret = v4l2_fwnode_endpoint_parse(of_fwnode_handle(ep), &v4l2_ep);
 765         if (ret) {
 766                 dev_err(priv->dev, "Could not parse v4l2 endpoint\n");
 767                 of_node_put(ep);
 768                 return -EINVAL;
 769         }
 770
 771         ret = rcsi2_parse_v4l2(priv, &v4l2_ep);
 772         if (ret) {
 773                 of_node_put(ep);
 774                 return ret;
 775         }
 776
 777         priv->asd.match.fwnode =
 778                 fwnode_graph_get_remote_endpoint(of_fwnode_handle(ep));
 779         priv->asd.match_type = V4L2_ASYNC_MATCH_FWNODE;
 780
 781         of_node_put(ep);
 782
 783         priv->notifier.subdevs = devm_kzalloc(priv->dev,
 784                                               sizeof(*priv->notifier.subdevs),
 785                                               GFP_KERNEL);
 786         if (!priv->notifier.subdevs)
 787                 return -ENOMEM;
 788
 789         priv->notifier.num_subdevs = 1;
 790         priv->notifier.subdevs[0] = &priv->asd;
 791         priv->notifier.ops = &rcar_csi2_notify_ops;
 792
 793         dev_dbg(priv->dev, "Found '%pOF'\n",
 794                 to_of_node(priv->asd.match.fwnode));
 795
 796         return v4l2_async_subdev_notifier_register(&priv->subdev,
 797                                                    &priv->notifier);
 798 }
 799
 800 /* -----------------------------------------------------------------------------
 801  * PHTW initialization sequences.
 802  *
 803  * NOTE: Magic values are from the datasheet and lack documentation.
 804  */
 805
 806 static int rcsi2_phtw_write(struct rcar_csi2 *priv, u16 data, u16 code)
 807 {
 808         unsigned int timeout;
 809
 810         rcsi2_write(priv, PHTW_REG,
 811                     PHTW_DWEN | PHTW_TESTDIN_DATA(data) |
 812                     PHTW_CWEN | PHTW_TESTDIN_CODE(code));
 813
 814         /* Wait for DWEN and CWEN to be cleared by hardware. */
 815         for (timeout = 0; timeout <= 20; timeout++) {
 816                 if (!(rcsi2_read(priv, PHTW_REG) & (PHTW_DWEN | PHTW_CWEN)))
 817                         return 0;
 818
 819                 usleep_range(1000, 2000);
 820         }
 821
 822         dev_err(priv->dev, "Timeout waiting for PHTW_DWEN and/or PHTW_CWEN\n");
 823
 824         return -ETIMEDOUT;
 825 }
 826
 827 static int rcsi2_phtw_write_array(struct rcar_csi2 *priv,
 828                                   const struct phtw_value *values)
 829 {
 830         const struct phtw_value *value;
 831         int ret;
 832
 833         for (value = values; value->data || value->code; value++) {
 834                 ret = rcsi2_phtw_write(priv, value->data, value->code);
 835                 if (ret)
 836                         return ret;
 837         }
 838
 839         return 0;
 840 }
 841
 842 static int rcsi2_phtw_write_mbps(struct rcar_csi2 *priv, unsigned int mbps,
 843                                  const struct rcsi2_mbps_reg *values, u16 code)
 844 {
 845         const struct rcsi2_mbps_reg *value;
 846         const struct rcsi2_mbps_reg *prev_value = NULL;
 847
 848         for (value = values; value->mbps; value++) {
 849                 if (value->mbps >= mbps)
 850                         break;
 851                 prev_value = value;
 852         }
 853
 854         if (prev_value &&
 855             ((mbps - prev_value->mbps) <= (value->mbps - mbps)))
 856                 value = prev_value;
 857
 858         if (!value->mbps) {
 859                 dev_err(priv->dev, "Unsupported PHY speed (%u Mbps)", mbps);
 860                 return -ERANGE;
 861         }
 862
 863         return rcsi2_phtw_write(priv, value->reg, code);
 864 }
 865
 866 static int rcsi2_init_phtw_h3_v3h_m3n(struct rcar_csi2 *priv, unsigned int mbps)
 867 {
 868         static const struct phtw_value step1[] = {
 869                 { .data = 0xcc, .code = 0xe2 },
 870                 { .data = 0x01, .code = 0xe3 },
 871                 { .data = 0x11, .code = 0xe4 },
 872                 { .data = 0x01, .code = 0xe5 },
 873                 { .data = 0x10, .code = 0x04 },
 874                 { /* sentinel */ },
 875         };
 876
 877         static const struct phtw_value step2[] = {
 878                 { .data = 0x38, .code = 0x08 },
 879                 { .data = 0x01, .code = 0x00 },
 880                 { .data = 0x4b, .code = 0xac },
 881                 { .data = 0x03, .code = 0x00 },
 882                 { .data = 0x80, .code = 0x07 },
 883                 { /* sentinel */ },
 884         };
 885
 886         int ret;
 887
 888         ret = rcsi2_phtw_write_array(priv, step1);
 889         if (ret)
 890                 return ret;
 891
 892         if (mbps <= 250) {
 893                 ret = rcsi2_phtw_write(priv, 0x39, 0x05);
 894                 if (ret)
 895                         return ret;
 896
 897                 ret = rcsi2_phtw_write_mbps(priv, mbps, phtw_mbps_h3_v3h_m3n,
 898                                             0xf1);
 899                 if (ret)
 900                         return ret;
 901         }
 902
 903         return rcsi2_phtw_write_array(priv, step2);
 904 }
 905
 906 static int rcsi2_init_phtw_v3m_e3(struct rcar_csi2 *priv, unsigned int mbps)
 907 {
 908         return rcsi2_phtw_write_mbps(priv, mbps, phtw_mbps_v3m_e3, 0x44);
 909 }
 910
 911 static int rcsi2_confirm_start_v3m_e3(struct rcar_csi2 *priv)
 912 {
 913         static const struct phtw_value step1[] = {
 914                 { .data = 0xed, .code = 0x34 },
 915                 { .data = 0xed, .code = 0x44 },
 916                 { .data = 0xed, .code = 0x54 },
 917                 { .data = 0xed, .code = 0x84 },
 918                 { .data = 0xed, .code = 0x94 },
 919                 { /* sentinel */ },
 920         };
 921
 922         return rcsi2_phtw_write_array(priv, step1);
 923 }
 924
 925 /* -----------------------------------------------------------------------------
 926  * Platform Device Driver.
 927  */
 928
 929 static const struct media_entity_operations rcar_csi2_entity_ops = {
 930         .link_validate = v4l2_subdev_link_validate,
 931 };
 932
 933 static int rcsi2_probe_resources(struct rcar_csi2 *priv,
 934                                  struct platform_device *pdev)
 935 {
 936         struct resource *res;
 937         int irq;
 938
 939         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 940         priv->base = devm_ioremap_resource(&pdev->dev, res);
 941         if (IS_ERR(priv->base))
 942                 return PTR_ERR(priv->base);
 943
 944         irq = platform_get_irq(pdev, 0);
 945         if (irq < 0)
 946                 return irq;
 947
 948         return 0;
 949 }
 950
 951 static const struct rcar_csi2_info rcar_csi2_info_r8a7795 = {
 952         .init_phtw = rcsi2_init_phtw_h3_v3h_m3n,
 953         .hsfreqrange = hsfreqrange_h3_v3h_m3n,
 954         .csi0clkfreqrange = 0x20,
 955         .clear_ulps = true,
 956 };
 957
 958 static const struct rcar_csi2_info rcar_csi2_info_r8a7795es1 = {
 959         .hsfreqrange = hsfreqrange_m3w_h3es1,
 960 };
 961
 962 static const struct rcar_csi2_info rcar_csi2_info_r8a7796 = {
 963         .hsfreqrange = hsfreqrange_m3w_h3es1,
 964 };
 965
 966 static const struct rcar_csi2_info rcar_csi2_info_r8a77965 = {
 967         .init_phtw = rcsi2_init_phtw_h3_v3h_m3n,
 968         .hsfreqrange = hsfreqrange_h3_v3h_m3n,
 969         .csi0clkfreqrange = 0x20,
 970         .clear_ulps = true,
 971 };
 972
 973 static const struct rcar_csi2_info rcar_csi2_info_r8a77970 = {
 974         .init_phtw = rcsi2_init_phtw_v3m_e3,
 975         .confirm_start = rcsi2_confirm_start_v3m_e3,
 976 };
 977
 978 static const struct of_device_id rcar_csi2_of_table[] = {
 979         {
 980                 .compatible = "renesas,r8a7795-csi2",
 981                 .data = &rcar_csi2_info_r8a7795,
 982         },
 983         {
 984                 .compatible = "renesas,r8a7796-csi2",
 985                 .data = &rcar_csi2_info_r8a7796,
 986         },
 987         {
 988                 .compatible = "renesas,r8a77965-csi2",
 989                 .data = &rcar_csi2_info_r8a77965,
 990         },
 991         {
 992                 .compatible = "renesas,r8a77970-csi2",
 993                 .data = &rcar_csi2_info_r8a77970,
 994         },
 995         { /* sentinel */ },
 996 };
 997 MODULE_DEVICE_TABLE(of, rcar_csi2_of_table);
 998
 999 static const struct soc_device_attribute r8a7795es1[] = {
1000         {
1001                 .soc_id = "r8a7795", .revision = "ES1.*",
1002                 .data = &rcar_csi2_info_r8a7795es1,
1003         },
1004         { /* sentinel */ },
1005 };
1006
1007 static int rcsi2_probe(struct platform_device *pdev)
1008 {
1009         const struct soc_device_attribute *attr;
1010         struct rcar_csi2 *priv;
1011         unsigned int i;
1012         int ret;
1013
1014         priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
1015         if (!priv)
1016                 return -ENOMEM;
1017
1018         priv->info = of_device_get_match_data(&pdev->dev);
1019
1020         /*
1021          * r8a7795 ES1.x behaves differently than the ES2.0+ but doesn't
1022          * have it's own compatible string.
1023          */
1024         attr = soc_device_match(r8a7795es1);
1025         if (attr)
1026                 priv->info = attr->data;
1027
1028         priv->dev = &pdev->dev;
1029
1030         mutex_init(&priv->lock);
1031         priv->stream_count = 0;
1032
1033         ret = rcsi2_probe_resources(priv, pdev);
1034         if (ret) {
1035                 dev_err(priv->dev, "Failed to get resources\n");
1036                 return ret;
1037         }
1038
1039         platform_set_drvdata(pdev, priv);
1040
1041         ret = rcsi2_parse_dt(priv);
1042         if (ret)
1043                 return ret;
1044
1045         priv->subdev.owner = THIS_MODULE;
1046         priv->subdev.dev = &pdev->dev;
1047         v4l2_subdev_init(&priv->subdev, &rcar_csi2_subdev_ops);
1048         v4l2_set_subdevdata(&priv->subdev, &pdev->dev);
1049         snprintf(priv->subdev.name, V4L2_SUBDEV_NAME_SIZE, "%s %s",
1050                  KBUILD_MODNAME, dev_name(&pdev->dev));
1051         priv->subdev.flags = V4L2_SUBDEV_FL_HAS_DEVNODE;
1052
1053         priv->subdev.entity.function = MEDIA_ENT_F_PROC_VIDEO_PIXEL_FORMATTER;
1054         priv->subdev.entity.ops = &rcar_csi2_entity_ops;
1055
1056         priv->pads[RCAR_CSI2_SINK].flags = MEDIA_PAD_FL_SINK;
1057         for (i = RCAR_CSI2_SOURCE_VC0; i < NR_OF_RCAR_CSI2_PAD; i++)
1058                 priv->pads[i].flags = MEDIA_PAD_FL_SOURCE;
1059
1060         ret = media_entity_pads_init(&priv->subdev.entity, NR_OF_RCAR_CSI2_PAD,
1061                                      priv->pads);
1062         if (ret)
1063                 goto error;
1064
1065         pm_runtime_enable(&pdev->dev);
1066
1067         ret = v4l2_async_register_subdev(&priv->subdev);
1068         if (ret < 0)
1069                 goto error;
1070
1071         dev_info(priv->dev, "%d lanes found\n", priv->lanes);
1072
1073         return 0;
1074
1075 error:
1076         v4l2_async_notifier_unregister(&priv->notifier);
1077         v4l2_async_notifier_cleanup(&priv->notifier);
1078
1079         return ret;
1080 }
1081
1082 static int rcsi2_remove(struct platform_device *pdev)
1083 {
1084         struct rcar_csi2 *priv = platform_get_drvdata(pdev);
1085
1086         v4l2_async_notifier_unregister(&priv->notifier);
1087         v4l2_async_notifier_cleanup(&priv->notifier);
1088         v4l2_async_unregister_subdev(&priv->subdev);
1089
1090         pm_runtime_disable(&pdev->dev);
1091
1092         return 0;
1093 }
1094
1095 static struct platform_driver rcar_csi2_pdrv = {
1096         .remove = rcsi2_remove,
1097         .probe  = rcsi2_probe,
1098         .driver = {
1099                 .name   = "rcar-csi2",
1100                 .of_match_table = rcar_csi2_of_table,
1101         },
1102 };
1103
1104 module_platform_driver(rcar_csi2_pdrv);
1105
1106 MODULE_AUTHOR("Niklas Söderlund <niklas.soderlund@ragnatech.se>");
1107 MODULE_DESCRIPTION("Renesas R-Car MIPI CSI-2 receiver driver");
1108 MODULE_LICENSE("GPL");