Merge tag 'ntb-5.8' of git://github.com/jonmason/ntb
[linux-2.6-microblaze.git] / drivers / media / i2c / imx219.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * A V4L2 driver for Sony IMX219 cameras.
4  * Copyright (C) 2019, Raspberry Pi (Trading) Ltd
5  *
6  * Based on Sony imx258 camera driver
7  * Copyright (C) 2018 Intel Corporation
8  *
9  * DT / fwnode changes, and regulator / GPIO control taken from imx214 driver
10  * Copyright 2018 Qtechnology A/S
11  *
12  * Flip handling taken from the Sony IMX319 driver.
13  * Copyright (C) 2018 Intel Corporation
14  *
15  */
16
17 #include <linux/clk.h>
18 #include <linux/delay.h>
19 #include <linux/gpio/consumer.h>
20 #include <linux/i2c.h>
21 #include <linux/module.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/regulator/consumer.h>
24 #include <media/v4l2-ctrls.h>
25 #include <media/v4l2-device.h>
26 #include <media/v4l2-event.h>
27 #include <media/v4l2-fwnode.h>
28 #include <media/v4l2-mediabus.h>
29 #include <asm/unaligned.h>
30
31 #define IMX219_REG_VALUE_08BIT          1
32 #define IMX219_REG_VALUE_16BIT          2
33
34 #define IMX219_REG_MODE_SELECT          0x0100
35 #define IMX219_MODE_STANDBY             0x00
36 #define IMX219_MODE_STREAMING           0x01
37
38 /* Chip ID */
39 #define IMX219_REG_CHIP_ID              0x0000
40 #define IMX219_CHIP_ID                  0x0219
41
42 /* External clock frequency is 24.0M */
43 #define IMX219_XCLK_FREQ                24000000
44
45 /* Pixel rate is fixed at 182.4M for all the modes */
46 #define IMX219_PIXEL_RATE               182400000
47
48 #define IMX219_DEFAULT_LINK_FREQ        456000000
49
50 /* V_TIMING internal */
51 #define IMX219_REG_VTS                  0x0160
52 #define IMX219_VTS_15FPS                0x0dc6
53 #define IMX219_VTS_30FPS_1080P          0x06e3
54 #define IMX219_VTS_30FPS_BINNED         0x06e3
55 #define IMX219_VTS_30FPS_640x480        0x06e3
56 #define IMX219_VTS_MAX                  0xffff
57
58 #define IMX219_VBLANK_MIN               4
59
60 /*Frame Length Line*/
61 #define IMX219_FLL_MIN                  0x08a6
62 #define IMX219_FLL_MAX                  0xffff
63 #define IMX219_FLL_STEP                 1
64 #define IMX219_FLL_DEFAULT              0x0c98
65
66 /* HBLANK control - read only */
67 #define IMX219_PPL_DEFAULT              3448
68
69 /* Exposure control */
70 #define IMX219_REG_EXPOSURE             0x015a
71 #define IMX219_EXPOSURE_MIN             4
72 #define IMX219_EXPOSURE_STEP            1
73 #define IMX219_EXPOSURE_DEFAULT         0x640
74 #define IMX219_EXPOSURE_MAX             65535
75
76 /* Analog gain control */
77 #define IMX219_REG_ANALOG_GAIN          0x0157
78 #define IMX219_ANA_GAIN_MIN             0
79 #define IMX219_ANA_GAIN_MAX             232
80 #define IMX219_ANA_GAIN_STEP            1
81 #define IMX219_ANA_GAIN_DEFAULT         0x0
82
83 /* Digital gain control */
84 #define IMX219_REG_DIGITAL_GAIN         0x0158
85 #define IMX219_DGTL_GAIN_MIN            0x0100
86 #define IMX219_DGTL_GAIN_MAX            0x0fff
87 #define IMX219_DGTL_GAIN_DEFAULT        0x0100
88 #define IMX219_DGTL_GAIN_STEP           1
89
90 #define IMX219_REG_ORIENTATION          0x0172
91
92 /* Test Pattern Control */
93 #define IMX219_REG_TEST_PATTERN         0x0600
94 #define IMX219_TEST_PATTERN_DISABLE     0
95 #define IMX219_TEST_PATTERN_SOLID_COLOR 1
96 #define IMX219_TEST_PATTERN_COLOR_BARS  2
97 #define IMX219_TEST_PATTERN_GREY_COLOR  3
98 #define IMX219_TEST_PATTERN_PN9         4
99
100 /* Test pattern colour components */
101 #define IMX219_REG_TESTP_RED            0x0602
102 #define IMX219_REG_TESTP_GREENR         0x0604
103 #define IMX219_REG_TESTP_BLUE           0x0606
104 #define IMX219_REG_TESTP_GREENB         0x0608
105 #define IMX219_TESTP_COLOUR_MIN         0
106 #define IMX219_TESTP_COLOUR_MAX         0x03ff
107 #define IMX219_TESTP_COLOUR_STEP        1
108 #define IMX219_TESTP_RED_DEFAULT        IMX219_TESTP_COLOUR_MAX
109 #define IMX219_TESTP_GREENR_DEFAULT     0
110 #define IMX219_TESTP_BLUE_DEFAULT       0
111 #define IMX219_TESTP_GREENB_DEFAULT     0
112
113 /* IMX219 native and active pixel array size. */
114 #define IMX219_NATIVE_WIDTH             3296U
115 #define IMX219_NATIVE_HEIGHT            2480U
116 #define IMX219_PIXEL_ARRAY_LEFT         8U
117 #define IMX219_PIXEL_ARRAY_TOP          8U
118 #define IMX219_PIXEL_ARRAY_WIDTH        3280U
119 #define IMX219_PIXEL_ARRAY_HEIGHT       2464U
120
121 struct imx219_reg {
122         u16 address;
123         u8 val;
124 };
125
126 struct imx219_reg_list {
127         unsigned int num_of_regs;
128         const struct imx219_reg *regs;
129 };
130
131 /* Mode : resolution and related config&values */
132 struct imx219_mode {
133         /* Frame width */
134         unsigned int width;
135         /* Frame height */
136         unsigned int height;
137
138         /* Analog crop rectangle. */
139         struct v4l2_rect crop;
140
141         /* V-timing */
142         unsigned int vts_def;
143
144         /* Default register values */
145         struct imx219_reg_list reg_list;
146 };
147
148 /*
149  * Register sets lifted off the i2C interface from the Raspberry Pi firmware
150  * driver.
151  * 3280x2464 = mode 2, 1920x1080 = mode 1, 1640x1232 = mode 4, 640x480 = mode 7.
152  */
153 static const struct imx219_reg mode_3280x2464_regs[] = {
154         {0x0100, 0x00},
155         {0x30eb, 0x0c},
156         {0x30eb, 0x05},
157         {0x300a, 0xff},
158         {0x300b, 0xff},
159         {0x30eb, 0x05},
160         {0x30eb, 0x09},
161         {0x0114, 0x01},
162         {0x0128, 0x00},
163         {0x012a, 0x18},
164         {0x012b, 0x00},
165         {0x0164, 0x00},
166         {0x0165, 0x00},
167         {0x0166, 0x0c},
168         {0x0167, 0xcf},
169         {0x0168, 0x00},
170         {0x0169, 0x00},
171         {0x016a, 0x09},
172         {0x016b, 0x9f},
173         {0x016c, 0x0c},
174         {0x016d, 0xd0},
175         {0x016e, 0x09},
176         {0x016f, 0xa0},
177         {0x0170, 0x01},
178         {0x0171, 0x01},
179         {0x0174, 0x00},
180         {0x0175, 0x00},
181         {0x0301, 0x05},
182         {0x0303, 0x01},
183         {0x0304, 0x03},
184         {0x0305, 0x03},
185         {0x0306, 0x00},
186         {0x0307, 0x39},
187         {0x030b, 0x01},
188         {0x030c, 0x00},
189         {0x030d, 0x72},
190         {0x0624, 0x0c},
191         {0x0625, 0xd0},
192         {0x0626, 0x09},
193         {0x0627, 0xa0},
194         {0x455e, 0x00},
195         {0x471e, 0x4b},
196         {0x4767, 0x0f},
197         {0x4750, 0x14},
198         {0x4540, 0x00},
199         {0x47b4, 0x14},
200         {0x4713, 0x30},
201         {0x478b, 0x10},
202         {0x478f, 0x10},
203         {0x4793, 0x10},
204         {0x4797, 0x0e},
205         {0x479b, 0x0e},
206         {0x0162, 0x0d},
207         {0x0163, 0x78},
208 };
209
210 static const struct imx219_reg mode_1920_1080_regs[] = {
211         {0x0100, 0x00},
212         {0x30eb, 0x05},
213         {0x30eb, 0x0c},
214         {0x300a, 0xff},
215         {0x300b, 0xff},
216         {0x30eb, 0x05},
217         {0x30eb, 0x09},
218         {0x0114, 0x01},
219         {0x0128, 0x00},
220         {0x012a, 0x18},
221         {0x012b, 0x00},
222         {0x0162, 0x0d},
223         {0x0163, 0x78},
224         {0x0164, 0x02},
225         {0x0165, 0xa8},
226         {0x0166, 0x0a},
227         {0x0167, 0x27},
228         {0x0168, 0x02},
229         {0x0169, 0xb4},
230         {0x016a, 0x06},
231         {0x016b, 0xeb},
232         {0x016c, 0x07},
233         {0x016d, 0x80},
234         {0x016e, 0x04},
235         {0x016f, 0x38},
236         {0x0170, 0x01},
237         {0x0171, 0x01},
238         {0x0174, 0x00},
239         {0x0175, 0x00},
240         {0x0301, 0x05},
241         {0x0303, 0x01},
242         {0x0304, 0x03},
243         {0x0305, 0x03},
244         {0x0306, 0x00},
245         {0x0307, 0x39},
246         {0x030b, 0x01},
247         {0x030c, 0x00},
248         {0x030d, 0x72},
249         {0x0624, 0x07},
250         {0x0625, 0x80},
251         {0x0626, 0x04},
252         {0x0627, 0x38},
253         {0x455e, 0x00},
254         {0x471e, 0x4b},
255         {0x4767, 0x0f},
256         {0x4750, 0x14},
257         {0x4540, 0x00},
258         {0x47b4, 0x14},
259         {0x4713, 0x30},
260         {0x478b, 0x10},
261         {0x478f, 0x10},
262         {0x4793, 0x10},
263         {0x4797, 0x0e},
264         {0x479b, 0x0e},
265         {0x0162, 0x0d},
266         {0x0163, 0x78},
267 };
268
269 static const struct imx219_reg mode_1640_1232_regs[] = {
270         {0x0100, 0x00},
271         {0x30eb, 0x0c},
272         {0x30eb, 0x05},
273         {0x300a, 0xff},
274         {0x300b, 0xff},
275         {0x30eb, 0x05},
276         {0x30eb, 0x09},
277         {0x0114, 0x01},
278         {0x0128, 0x00},
279         {0x012a, 0x18},
280         {0x012b, 0x00},
281         {0x0164, 0x00},
282         {0x0165, 0x00},
283         {0x0166, 0x0c},
284         {0x0167, 0xcf},
285         {0x0168, 0x00},
286         {0x0169, 0x00},
287         {0x016a, 0x09},
288         {0x016b, 0x9f},
289         {0x016c, 0x06},
290         {0x016d, 0x68},
291         {0x016e, 0x04},
292         {0x016f, 0xd0},
293         {0x0170, 0x01},
294         {0x0171, 0x01},
295         {0x0174, 0x01},
296         {0x0175, 0x01},
297         {0x0301, 0x05},
298         {0x0303, 0x01},
299         {0x0304, 0x03},
300         {0x0305, 0x03},
301         {0x0306, 0x00},
302         {0x0307, 0x39},
303         {0x030b, 0x01},
304         {0x030c, 0x00},
305         {0x030d, 0x72},
306         {0x0624, 0x06},
307         {0x0625, 0x68},
308         {0x0626, 0x04},
309         {0x0627, 0xd0},
310         {0x455e, 0x00},
311         {0x471e, 0x4b},
312         {0x4767, 0x0f},
313         {0x4750, 0x14},
314         {0x4540, 0x00},
315         {0x47b4, 0x14},
316         {0x4713, 0x30},
317         {0x478b, 0x10},
318         {0x478f, 0x10},
319         {0x4793, 0x10},
320         {0x4797, 0x0e},
321         {0x479b, 0x0e},
322         {0x0162, 0x0d},
323         {0x0163, 0x78},
324 };
325
326 static const struct imx219_reg mode_640_480_regs[] = {
327         {0x0100, 0x00},
328         {0x30eb, 0x05},
329         {0x30eb, 0x0c},
330         {0x300a, 0xff},
331         {0x300b, 0xff},
332         {0x30eb, 0x05},
333         {0x30eb, 0x09},
334         {0x0114, 0x01},
335         {0x0128, 0x00},
336         {0x012a, 0x18},
337         {0x012b, 0x00},
338         {0x0162, 0x0d},
339         {0x0163, 0x78},
340         {0x0164, 0x03},
341         {0x0165, 0xe8},
342         {0x0166, 0x08},
343         {0x0167, 0xe7},
344         {0x0168, 0x02},
345         {0x0169, 0xf0},
346         {0x016a, 0x06},
347         {0x016b, 0xaf},
348         {0x016c, 0x02},
349         {0x016d, 0x80},
350         {0x016e, 0x01},
351         {0x016f, 0xe0},
352         {0x0170, 0x01},
353         {0x0171, 0x01},
354         {0x0174, 0x03},
355         {0x0175, 0x03},
356         {0x0301, 0x05},
357         {0x0303, 0x01},
358         {0x0304, 0x03},
359         {0x0305, 0x03},
360         {0x0306, 0x00},
361         {0x0307, 0x39},
362         {0x030b, 0x01},
363         {0x030c, 0x00},
364         {0x030d, 0x72},
365         {0x0624, 0x06},
366         {0x0625, 0x68},
367         {0x0626, 0x04},
368         {0x0627, 0xd0},
369         {0x455e, 0x00},
370         {0x471e, 0x4b},
371         {0x4767, 0x0f},
372         {0x4750, 0x14},
373         {0x4540, 0x00},
374         {0x47b4, 0x14},
375         {0x4713, 0x30},
376         {0x478b, 0x10},
377         {0x478f, 0x10},
378         {0x4793, 0x10},
379         {0x4797, 0x0e},
380         {0x479b, 0x0e},
381 };
382
383 static const struct imx219_reg raw8_framefmt_regs[] = {
384         {0x018c, 0x08},
385         {0x018d, 0x08},
386         {0x0309, 0x08},
387 };
388
389 static const struct imx219_reg raw10_framefmt_regs[] = {
390         {0x018c, 0x0a},
391         {0x018d, 0x0a},
392         {0x0309, 0x0a},
393 };
394
395 static const char * const imx219_test_pattern_menu[] = {
396         "Disabled",
397         "Color Bars",
398         "Solid Color",
399         "Grey Color Bars",
400         "PN9"
401 };
402
403 static const int imx219_test_pattern_val[] = {
404         IMX219_TEST_PATTERN_DISABLE,
405         IMX219_TEST_PATTERN_COLOR_BARS,
406         IMX219_TEST_PATTERN_SOLID_COLOR,
407         IMX219_TEST_PATTERN_GREY_COLOR,
408         IMX219_TEST_PATTERN_PN9,
409 };
410
411 /* regulator supplies */
412 static const char * const imx219_supply_name[] = {
413         /* Supplies can be enabled in any order */
414         "VANA",  /* Analog (2.8V) supply */
415         "VDIG",  /* Digital Core (1.8V) supply */
416         "VDDL",  /* IF (1.2V) supply */
417 };
418
419 #define IMX219_NUM_SUPPLIES ARRAY_SIZE(imx219_supply_name)
420
421 /*
422  * The supported formats.
423  * This table MUST contain 4 entries per format, to cover the various flip
424  * combinations in the order
425  * - no flip
426  * - h flip
427  * - v flip
428  * - h&v flips
429  */
430 static const u32 codes[] = {
431         MEDIA_BUS_FMT_SRGGB10_1X10,
432         MEDIA_BUS_FMT_SGRBG10_1X10,
433         MEDIA_BUS_FMT_SGBRG10_1X10,
434         MEDIA_BUS_FMT_SBGGR10_1X10,
435
436         MEDIA_BUS_FMT_SRGGB8_1X8,
437         MEDIA_BUS_FMT_SGRBG8_1X8,
438         MEDIA_BUS_FMT_SGBRG8_1X8,
439         MEDIA_BUS_FMT_SBGGR8_1X8,
440 };
441
442 /*
443  * Initialisation delay between XCLR low->high and the moment when the sensor
444  * can start capture (i.e. can leave software stanby) must be not less than:
445  *   t4 + max(t5, t6 + <time to initialize the sensor register over I2C>)
446  * where
447  *   t4 is fixed, and is max 200uS,
448  *   t5 is fixed, and is 6000uS,
449  *   t6 depends on the sensor external clock, and is max 32000 clock periods.
450  * As per sensor datasheet, the external clock must be from 6MHz to 27MHz.
451  * So for any acceptable external clock t6 is always within the range of
452  * 1185 to 5333 uS, and is always less than t5.
453  * For this reason this is always safe to wait (t4 + t5) = 6200 uS, then
454  * initialize the sensor over I2C, and then exit the software standby.
455  *
456  * This start-up time can be optimized a bit more, if we start the writes
457  * over I2C after (t4+t6), but before (t4+t5) expires. But then sensor
458  * initialization over I2C may complete before (t4+t5) expires, and we must
459  * ensure that capture is not started before (t4+t5).
460  *
461  * This delay doesn't account for the power supply startup time. If needed,
462  * this should be taken care of via the regulator framework. E.g. in the
463  * case of DT for regulator-fixed one should define the startup-delay-us
464  * property.
465  */
466 #define IMX219_XCLR_MIN_DELAY_US        6200
467 #define IMX219_XCLR_DELAY_RANGE_US      1000
468
469 /* Mode configs */
470 static const struct imx219_mode supported_modes[] = {
471         {
472                 /* 8MPix 15fps mode */
473                 .width = 3280,
474                 .height = 2464,
475                 .crop = {
476                         .left = 0,
477                         .top = 0,
478                         .width = 3280,
479                         .height = 2464
480                 },
481                 .vts_def = IMX219_VTS_15FPS,
482                 .reg_list = {
483                         .num_of_regs = ARRAY_SIZE(mode_3280x2464_regs),
484                         .regs = mode_3280x2464_regs,
485                 },
486         },
487         {
488                 /* 1080P 30fps cropped */
489                 .width = 1920,
490                 .height = 1080,
491                 .crop = {
492                         .left = 680,
493                         .top = 692,
494                         .width = 1920,
495                         .height = 1080
496                 },
497                 .vts_def = IMX219_VTS_30FPS_1080P,
498                 .reg_list = {
499                         .num_of_regs = ARRAY_SIZE(mode_1920_1080_regs),
500                         .regs = mode_1920_1080_regs,
501                 },
502         },
503         {
504                 /* 2x2 binned 30fps mode */
505                 .width = 1640,
506                 .height = 1232,
507                 .crop = {
508                         .left = 0,
509                         .top = 0,
510                         .width = 3280,
511                         .height = 2464
512                 },
513                 .vts_def = IMX219_VTS_30FPS_BINNED,
514                 .reg_list = {
515                         .num_of_regs = ARRAY_SIZE(mode_1640_1232_regs),
516                         .regs = mode_1640_1232_regs,
517                 },
518         },
519         {
520                 /* 640x480 30fps mode */
521                 .width = 640,
522                 .height = 480,
523                 .crop = {
524                         .left = 1000,
525                         .top = 752,
526                         .width = 1280,
527                         .height = 960
528                 },
529                 .vts_def = IMX219_VTS_30FPS_640x480,
530                 .reg_list = {
531                         .num_of_regs = ARRAY_SIZE(mode_640_480_regs),
532                         .regs = mode_640_480_regs,
533                 },
534         },
535 };
536
537 struct imx219 {
538         struct v4l2_subdev sd;
539         struct media_pad pad;
540
541         struct v4l2_mbus_framefmt fmt;
542
543         struct clk *xclk; /* system clock to IMX219 */
544         u32 xclk_freq;
545
546         struct gpio_desc *reset_gpio;
547         struct regulator_bulk_data supplies[IMX219_NUM_SUPPLIES];
548
549         struct v4l2_ctrl_handler ctrl_handler;
550         /* V4L2 Controls */
551         struct v4l2_ctrl *pixel_rate;
552         struct v4l2_ctrl *exposure;
553         struct v4l2_ctrl *vflip;
554         struct v4l2_ctrl *hflip;
555         struct v4l2_ctrl *vblank;
556         struct v4l2_ctrl *hblank;
557
558         /* Current mode */
559         const struct imx219_mode *mode;
560
561         /*
562          * Mutex for serialized access:
563          * Protect sensor module set pad format and start/stop streaming safely.
564          */
565         struct mutex mutex;
566
567         /* Streaming on/off */
568         bool streaming;
569 };
570
571 static inline struct imx219 *to_imx219(struct v4l2_subdev *_sd)
572 {
573         return container_of(_sd, struct imx219, sd);
574 }
575
576 /* Read registers up to 2 at a time */
577 static int imx219_read_reg(struct imx219 *imx219, u16 reg, u32 len, u32 *val)
578 {
579         struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
580         struct i2c_msg msgs[2];
581         u8 addr_buf[2] = { reg >> 8, reg & 0xff };
582         u8 data_buf[4] = { 0, };
583         int ret;
584
585         if (len > 4)
586                 return -EINVAL;
587
588         /* Write register address */
589         msgs[0].addr = client->addr;
590         msgs[0].flags = 0;
591         msgs[0].len = ARRAY_SIZE(addr_buf);
592         msgs[0].buf = addr_buf;
593
594         /* Read data from register */
595         msgs[1].addr = client->addr;
596         msgs[1].flags = I2C_M_RD;
597         msgs[1].len = len;
598         msgs[1].buf = &data_buf[4 - len];
599
600         ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
601         if (ret != ARRAY_SIZE(msgs))
602                 return -EIO;
603
604         *val = get_unaligned_be32(data_buf);
605
606         return 0;
607 }
608
609 /* Write registers up to 2 at a time */
610 static int imx219_write_reg(struct imx219 *imx219, u16 reg, u32 len, u32 val)
611 {
612         struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
613         u8 buf[6];
614
615         if (len > 4)
616                 return -EINVAL;
617
618         put_unaligned_be16(reg, buf);
619         put_unaligned_be32(val << (8 * (4 - len)), buf + 2);
620         if (i2c_master_send(client, buf, len + 2) != len + 2)
621                 return -EIO;
622
623         return 0;
624 }
625
626 /* Write a list of registers */
627 static int imx219_write_regs(struct imx219 *imx219,
628                              const struct imx219_reg *regs, u32 len)
629 {
630         struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
631         unsigned int i;
632         int ret;
633
634         for (i = 0; i < len; i++) {
635                 ret = imx219_write_reg(imx219, regs[i].address, 1, regs[i].val);
636                 if (ret) {
637                         dev_err_ratelimited(&client->dev,
638                                             "Failed to write reg 0x%4.4x. error = %d\n",
639                                             regs[i].address, ret);
640
641                         return ret;
642                 }
643         }
644
645         return 0;
646 }
647
648 /* Get bayer order based on flip setting. */
649 static u32 imx219_get_format_code(struct imx219 *imx219, u32 code)
650 {
651         unsigned int i;
652
653         lockdep_assert_held(&imx219->mutex);
654
655         for (i = 0; i < ARRAY_SIZE(codes); i++)
656                 if (codes[i] == code)
657                         break;
658
659         if (i >= ARRAY_SIZE(codes))
660                 i = 0;
661
662         i = (i & ~3) | (imx219->vflip->val ? 2 : 0) |
663             (imx219->hflip->val ? 1 : 0);
664
665         return codes[i];
666 }
667
668 static void imx219_set_default_format(struct imx219 *imx219)
669 {
670         struct v4l2_mbus_framefmt *fmt;
671
672         fmt = &imx219->fmt;
673         fmt->code = MEDIA_BUS_FMT_SRGGB10_1X10;
674         fmt->colorspace = V4L2_COLORSPACE_SRGB;
675         fmt->ycbcr_enc = V4L2_MAP_YCBCR_ENC_DEFAULT(fmt->colorspace);
676         fmt->quantization = V4L2_MAP_QUANTIZATION_DEFAULT(true,
677                                                           fmt->colorspace,
678                                                           fmt->ycbcr_enc);
679         fmt->xfer_func = V4L2_MAP_XFER_FUNC_DEFAULT(fmt->colorspace);
680         fmt->width = supported_modes[0].width;
681         fmt->height = supported_modes[0].height;
682         fmt->field = V4L2_FIELD_NONE;
683 }
684
685 static int imx219_open(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
686 {
687         struct imx219 *imx219 = to_imx219(sd);
688         struct v4l2_mbus_framefmt *try_fmt =
689                 v4l2_subdev_get_try_format(sd, fh->pad, 0);
690         struct v4l2_rect *try_crop;
691
692         mutex_lock(&imx219->mutex);
693
694         /* Initialize try_fmt */
695         try_fmt->width = supported_modes[0].width;
696         try_fmt->height = supported_modes[0].height;
697         try_fmt->code = imx219_get_format_code(imx219,
698                                                MEDIA_BUS_FMT_SRGGB10_1X10);
699         try_fmt->field = V4L2_FIELD_NONE;
700
701         /* Initialize try_crop rectangle. */
702         try_crop = v4l2_subdev_get_try_crop(sd, fh->pad, 0);
703         try_crop->top = IMX219_PIXEL_ARRAY_TOP;
704         try_crop->left = IMX219_PIXEL_ARRAY_LEFT;
705         try_crop->width = IMX219_PIXEL_ARRAY_WIDTH;
706         try_crop->height = IMX219_PIXEL_ARRAY_HEIGHT;
707
708         mutex_unlock(&imx219->mutex);
709
710         return 0;
711 }
712
713 static int imx219_set_ctrl(struct v4l2_ctrl *ctrl)
714 {
715         struct imx219 *imx219 =
716                 container_of(ctrl->handler, struct imx219, ctrl_handler);
717         struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
718         int ret;
719
720         if (ctrl->id == V4L2_CID_VBLANK) {
721                 int exposure_max, exposure_def;
722
723                 /* Update max exposure while meeting expected vblanking */
724                 exposure_max = imx219->mode->height + ctrl->val - 4;
725                 exposure_def = (exposure_max < IMX219_EXPOSURE_DEFAULT) ?
726                         exposure_max : IMX219_EXPOSURE_DEFAULT;
727                 __v4l2_ctrl_modify_range(imx219->exposure,
728                                          imx219->exposure->minimum,
729                                          exposure_max, imx219->exposure->step,
730                                          exposure_def);
731         }
732
733         /*
734          * Applying V4L2 control value only happens
735          * when power is up for streaming
736          */
737         if (pm_runtime_get_if_in_use(&client->dev) == 0)
738                 return 0;
739
740         switch (ctrl->id) {
741         case V4L2_CID_ANALOGUE_GAIN:
742                 ret = imx219_write_reg(imx219, IMX219_REG_ANALOG_GAIN,
743                                        IMX219_REG_VALUE_08BIT, ctrl->val);
744                 break;
745         case V4L2_CID_EXPOSURE:
746                 ret = imx219_write_reg(imx219, IMX219_REG_EXPOSURE,
747                                        IMX219_REG_VALUE_16BIT, ctrl->val);
748                 break;
749         case V4L2_CID_DIGITAL_GAIN:
750                 ret = imx219_write_reg(imx219, IMX219_REG_DIGITAL_GAIN,
751                                        IMX219_REG_VALUE_16BIT, ctrl->val);
752                 break;
753         case V4L2_CID_TEST_PATTERN:
754                 ret = imx219_write_reg(imx219, IMX219_REG_TEST_PATTERN,
755                                        IMX219_REG_VALUE_16BIT,
756                                        imx219_test_pattern_val[ctrl->val]);
757                 break;
758         case V4L2_CID_HFLIP:
759         case V4L2_CID_VFLIP:
760                 ret = imx219_write_reg(imx219, IMX219_REG_ORIENTATION, 1,
761                                        imx219->hflip->val |
762                                        imx219->vflip->val << 1);
763                 break;
764         case V4L2_CID_VBLANK:
765                 ret = imx219_write_reg(imx219, IMX219_REG_VTS,
766                                        IMX219_REG_VALUE_16BIT,
767                                        imx219->mode->height + ctrl->val);
768                 break;
769         case V4L2_CID_TEST_PATTERN_RED:
770                 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_RED,
771                                        IMX219_REG_VALUE_16BIT, ctrl->val);
772                 break;
773         case V4L2_CID_TEST_PATTERN_GREENR:
774                 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_GREENR,
775                                        IMX219_REG_VALUE_16BIT, ctrl->val);
776                 break;
777         case V4L2_CID_TEST_PATTERN_BLUE:
778                 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_BLUE,
779                                        IMX219_REG_VALUE_16BIT, ctrl->val);
780                 break;
781         case V4L2_CID_TEST_PATTERN_GREENB:
782                 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_GREENB,
783                                        IMX219_REG_VALUE_16BIT, ctrl->val);
784                 break;
785         default:
786                 dev_info(&client->dev,
787                          "ctrl(id:0x%x,val:0x%x) is not handled\n",
788                          ctrl->id, ctrl->val);
789                 ret = -EINVAL;
790                 break;
791         }
792
793         pm_runtime_put(&client->dev);
794
795         return ret;
796 }
797
798 static const struct v4l2_ctrl_ops imx219_ctrl_ops = {
799         .s_ctrl = imx219_set_ctrl,
800 };
801
802 static int imx219_enum_mbus_code(struct v4l2_subdev *sd,
803                                  struct v4l2_subdev_pad_config *cfg,
804                                  struct v4l2_subdev_mbus_code_enum *code)
805 {
806         struct imx219 *imx219 = to_imx219(sd);
807
808         if (code->index >= (ARRAY_SIZE(codes) / 4))
809                 return -EINVAL;
810
811         code->code = imx219_get_format_code(imx219, codes[code->index * 4]);
812
813         return 0;
814 }
815
816 static int imx219_enum_frame_size(struct v4l2_subdev *sd,
817                                   struct v4l2_subdev_pad_config *cfg,
818                                   struct v4l2_subdev_frame_size_enum *fse)
819 {
820         struct imx219 *imx219 = to_imx219(sd);
821
822         if (fse->index >= ARRAY_SIZE(supported_modes))
823                 return -EINVAL;
824
825         if (fse->code != imx219_get_format_code(imx219, fse->code))
826                 return -EINVAL;
827
828         fse->min_width = supported_modes[fse->index].width;
829         fse->max_width = fse->min_width;
830         fse->min_height = supported_modes[fse->index].height;
831         fse->max_height = fse->min_height;
832
833         return 0;
834 }
835
836 static void imx219_reset_colorspace(struct v4l2_mbus_framefmt *fmt)
837 {
838         fmt->colorspace = V4L2_COLORSPACE_SRGB;
839         fmt->ycbcr_enc = V4L2_MAP_YCBCR_ENC_DEFAULT(fmt->colorspace);
840         fmt->quantization = V4L2_MAP_QUANTIZATION_DEFAULT(true,
841                                                           fmt->colorspace,
842                                                           fmt->ycbcr_enc);
843         fmt->xfer_func = V4L2_MAP_XFER_FUNC_DEFAULT(fmt->colorspace);
844 }
845
846 static void imx219_update_pad_format(struct imx219 *imx219,
847                                      const struct imx219_mode *mode,
848                                      struct v4l2_subdev_format *fmt)
849 {
850         fmt->format.width = mode->width;
851         fmt->format.height = mode->height;
852         fmt->format.field = V4L2_FIELD_NONE;
853         imx219_reset_colorspace(&fmt->format);
854 }
855
856 static int __imx219_get_pad_format(struct imx219 *imx219,
857                                    struct v4l2_subdev_pad_config *cfg,
858                                    struct v4l2_subdev_format *fmt)
859 {
860         if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
861                 struct v4l2_mbus_framefmt *try_fmt =
862                         v4l2_subdev_get_try_format(&imx219->sd, cfg, fmt->pad);
863                 /* update the code which could change due to vflip or hflip: */
864                 try_fmt->code = imx219_get_format_code(imx219, try_fmt->code);
865                 fmt->format = *try_fmt;
866         } else {
867                 imx219_update_pad_format(imx219, imx219->mode, fmt);
868                 fmt->format.code = imx219_get_format_code(imx219,
869                                                           imx219->fmt.code);
870         }
871
872         return 0;
873 }
874
875 static int imx219_get_pad_format(struct v4l2_subdev *sd,
876                                  struct v4l2_subdev_pad_config *cfg,
877                                  struct v4l2_subdev_format *fmt)
878 {
879         struct imx219 *imx219 = to_imx219(sd);
880         int ret;
881
882         mutex_lock(&imx219->mutex);
883         ret = __imx219_get_pad_format(imx219, cfg, fmt);
884         mutex_unlock(&imx219->mutex);
885
886         return ret;
887 }
888
889 static int imx219_set_pad_format(struct v4l2_subdev *sd,
890                                  struct v4l2_subdev_pad_config *cfg,
891                                  struct v4l2_subdev_format *fmt)
892 {
893         struct imx219 *imx219 = to_imx219(sd);
894         const struct imx219_mode *mode;
895         struct v4l2_mbus_framefmt *framefmt;
896         int exposure_max, exposure_def, hblank;
897         unsigned int i;
898
899         mutex_lock(&imx219->mutex);
900
901         for (i = 0; i < ARRAY_SIZE(codes); i++)
902                 if (codes[i] == fmt->format.code)
903                         break;
904         if (i >= ARRAY_SIZE(codes))
905                 i = 0;
906
907         /* Bayer order varies with flips */
908         fmt->format.code = imx219_get_format_code(imx219, codes[i]);
909
910         mode = v4l2_find_nearest_size(supported_modes,
911                                       ARRAY_SIZE(supported_modes),
912                                       width, height,
913                                       fmt->format.width, fmt->format.height);
914         imx219_update_pad_format(imx219, mode, fmt);
915         if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
916                 framefmt = v4l2_subdev_get_try_format(sd, cfg, fmt->pad);
917                 *framefmt = fmt->format;
918         } else if (imx219->mode != mode ||
919                    imx219->fmt.code != fmt->format.code) {
920                 imx219->fmt = fmt->format;
921                 imx219->mode = mode;
922                 /* Update limits and set FPS to default */
923                 __v4l2_ctrl_modify_range(imx219->vblank, IMX219_VBLANK_MIN,
924                                          IMX219_VTS_MAX - mode->height, 1,
925                                          mode->vts_def - mode->height);
926                 __v4l2_ctrl_s_ctrl(imx219->vblank,
927                                    mode->vts_def - mode->height);
928                 /* Update max exposure while meeting expected vblanking */
929                 exposure_max = mode->vts_def - 4;
930                 exposure_def = (exposure_max < IMX219_EXPOSURE_DEFAULT) ?
931                         exposure_max : IMX219_EXPOSURE_DEFAULT;
932                 __v4l2_ctrl_modify_range(imx219->exposure,
933                                          imx219->exposure->minimum,
934                                          exposure_max, imx219->exposure->step,
935                                          exposure_def);
936                 /*
937                  * Currently PPL is fixed to IMX219_PPL_DEFAULT, so hblank
938                  * depends on mode->width only, and is not changeble in any
939                  * way other than changing the mode.
940                  */
941                 hblank = IMX219_PPL_DEFAULT - mode->width;
942                 __v4l2_ctrl_modify_range(imx219->hblank, hblank, hblank, 1,
943                                          hblank);
944         }
945
946         mutex_unlock(&imx219->mutex);
947
948         return 0;
949 }
950
951 static int imx219_set_framefmt(struct imx219 *imx219)
952 {
953         switch (imx219->fmt.code) {
954         case MEDIA_BUS_FMT_SRGGB8_1X8:
955         case MEDIA_BUS_FMT_SGRBG8_1X8:
956         case MEDIA_BUS_FMT_SGBRG8_1X8:
957         case MEDIA_BUS_FMT_SBGGR8_1X8:
958                 return imx219_write_regs(imx219, raw8_framefmt_regs,
959                                         ARRAY_SIZE(raw8_framefmt_regs));
960
961         case MEDIA_BUS_FMT_SRGGB10_1X10:
962         case MEDIA_BUS_FMT_SGRBG10_1X10:
963         case MEDIA_BUS_FMT_SGBRG10_1X10:
964         case MEDIA_BUS_FMT_SBGGR10_1X10:
965                 return imx219_write_regs(imx219, raw10_framefmt_regs,
966                                         ARRAY_SIZE(raw10_framefmt_regs));
967         }
968
969         return -EINVAL;
970 }
971
972 static const struct v4l2_rect *
973 __imx219_get_pad_crop(struct imx219 *imx219, struct v4l2_subdev_pad_config *cfg,
974                       unsigned int pad, enum v4l2_subdev_format_whence which)
975 {
976         switch (which) {
977         case V4L2_SUBDEV_FORMAT_TRY:
978                 return v4l2_subdev_get_try_crop(&imx219->sd, cfg, pad);
979         case V4L2_SUBDEV_FORMAT_ACTIVE:
980                 return &imx219->mode->crop;
981         }
982
983         return NULL;
984 }
985
986 static int imx219_get_selection(struct v4l2_subdev *sd,
987                                 struct v4l2_subdev_pad_config *cfg,
988                                 struct v4l2_subdev_selection *sel)
989 {
990         switch (sel->target) {
991         case V4L2_SEL_TGT_CROP: {
992                 struct imx219 *imx219 = to_imx219(sd);
993
994                 mutex_lock(&imx219->mutex);
995                 sel->r = *__imx219_get_pad_crop(imx219, cfg, sel->pad,
996                                                 sel->which);
997                 mutex_unlock(&imx219->mutex);
998
999                 return 0;
1000         }
1001
1002         case V4L2_SEL_TGT_NATIVE_SIZE:
1003                 sel->r.top = 0;
1004                 sel->r.left = 0;
1005                 sel->r.width = IMX219_NATIVE_WIDTH;
1006                 sel->r.height = IMX219_NATIVE_HEIGHT;
1007
1008                 return 0;
1009
1010         case V4L2_SEL_TGT_CROP_DEFAULT:
1011                 sel->r.top = IMX219_PIXEL_ARRAY_TOP;
1012                 sel->r.left = IMX219_PIXEL_ARRAY_LEFT;
1013                 sel->r.width = IMX219_PIXEL_ARRAY_WIDTH;
1014                 sel->r.height = IMX219_PIXEL_ARRAY_HEIGHT;
1015
1016                 return 0;
1017         }
1018
1019         return -EINVAL;
1020 }
1021
1022 static int imx219_start_streaming(struct imx219 *imx219)
1023 {
1024         struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1025         const struct imx219_reg_list *reg_list;
1026         int ret;
1027
1028         /* Apply default values of current mode */
1029         reg_list = &imx219->mode->reg_list;
1030         ret = imx219_write_regs(imx219, reg_list->regs, reg_list->num_of_regs);
1031         if (ret) {
1032                 dev_err(&client->dev, "%s failed to set mode\n", __func__);
1033                 return ret;
1034         }
1035
1036         ret = imx219_set_framefmt(imx219);
1037         if (ret) {
1038                 dev_err(&client->dev, "%s failed to set frame format: %d\n",
1039                         __func__, ret);
1040                 return ret;
1041         }
1042
1043         /* Apply customized values from user */
1044         ret =  __v4l2_ctrl_handler_setup(imx219->sd.ctrl_handler);
1045         if (ret)
1046                 return ret;
1047
1048         /* set stream on register */
1049         return imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
1050                                 IMX219_REG_VALUE_08BIT, IMX219_MODE_STREAMING);
1051 }
1052
1053 static void imx219_stop_streaming(struct imx219 *imx219)
1054 {
1055         struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1056         int ret;
1057
1058         /* set stream off register */
1059         ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
1060                                IMX219_REG_VALUE_08BIT, IMX219_MODE_STANDBY);
1061         if (ret)
1062                 dev_err(&client->dev, "%s failed to set stream\n", __func__);
1063 }
1064
1065 static int imx219_set_stream(struct v4l2_subdev *sd, int enable)
1066 {
1067         struct imx219 *imx219 = to_imx219(sd);
1068         struct i2c_client *client = v4l2_get_subdevdata(sd);
1069         int ret = 0;
1070
1071         mutex_lock(&imx219->mutex);
1072         if (imx219->streaming == enable) {
1073                 mutex_unlock(&imx219->mutex);
1074                 return 0;
1075         }
1076
1077         if (enable) {
1078                 ret = pm_runtime_get_sync(&client->dev);
1079                 if (ret < 0) {
1080                         pm_runtime_put_noidle(&client->dev);
1081                         goto err_unlock;
1082                 }
1083
1084                 /*
1085                  * Apply default & customized values
1086                  * and then start streaming.
1087                  */
1088                 ret = imx219_start_streaming(imx219);
1089                 if (ret)
1090                         goto err_rpm_put;
1091         } else {
1092                 imx219_stop_streaming(imx219);
1093                 pm_runtime_put(&client->dev);
1094         }
1095
1096         imx219->streaming = enable;
1097
1098         /* vflip and hflip cannot change during streaming */
1099         __v4l2_ctrl_grab(imx219->vflip, enable);
1100         __v4l2_ctrl_grab(imx219->hflip, enable);
1101
1102         mutex_unlock(&imx219->mutex);
1103
1104         return ret;
1105
1106 err_rpm_put:
1107         pm_runtime_put(&client->dev);
1108 err_unlock:
1109         mutex_unlock(&imx219->mutex);
1110
1111         return ret;
1112 }
1113
1114 /* Power/clock management functions */
1115 static int imx219_power_on(struct device *dev)
1116 {
1117         struct i2c_client *client = to_i2c_client(dev);
1118         struct v4l2_subdev *sd = i2c_get_clientdata(client);
1119         struct imx219 *imx219 = to_imx219(sd);
1120         int ret;
1121
1122         ret = regulator_bulk_enable(IMX219_NUM_SUPPLIES,
1123                                     imx219->supplies);
1124         if (ret) {
1125                 dev_err(&client->dev, "%s: failed to enable regulators\n",
1126                         __func__);
1127                 return ret;
1128         }
1129
1130         ret = clk_prepare_enable(imx219->xclk);
1131         if (ret) {
1132                 dev_err(&client->dev, "%s: failed to enable clock\n",
1133                         __func__);
1134                 goto reg_off;
1135         }
1136
1137         gpiod_set_value_cansleep(imx219->reset_gpio, 1);
1138         usleep_range(IMX219_XCLR_MIN_DELAY_US,
1139                      IMX219_XCLR_MIN_DELAY_US + IMX219_XCLR_DELAY_RANGE_US);
1140
1141         return 0;
1142
1143 reg_off:
1144         regulator_bulk_disable(IMX219_NUM_SUPPLIES, imx219->supplies);
1145
1146         return ret;
1147 }
1148
1149 static int imx219_power_off(struct device *dev)
1150 {
1151         struct i2c_client *client = to_i2c_client(dev);
1152         struct v4l2_subdev *sd = i2c_get_clientdata(client);
1153         struct imx219 *imx219 = to_imx219(sd);
1154
1155         gpiod_set_value_cansleep(imx219->reset_gpio, 0);
1156         regulator_bulk_disable(IMX219_NUM_SUPPLIES, imx219->supplies);
1157         clk_disable_unprepare(imx219->xclk);
1158
1159         return 0;
1160 }
1161
1162 static int __maybe_unused imx219_suspend(struct device *dev)
1163 {
1164         struct i2c_client *client = to_i2c_client(dev);
1165         struct v4l2_subdev *sd = i2c_get_clientdata(client);
1166         struct imx219 *imx219 = to_imx219(sd);
1167
1168         if (imx219->streaming)
1169                 imx219_stop_streaming(imx219);
1170
1171         return 0;
1172 }
1173
1174 static int __maybe_unused imx219_resume(struct device *dev)
1175 {
1176         struct i2c_client *client = to_i2c_client(dev);
1177         struct v4l2_subdev *sd = i2c_get_clientdata(client);
1178         struct imx219 *imx219 = to_imx219(sd);
1179         int ret;
1180
1181         if (imx219->streaming) {
1182                 ret = imx219_start_streaming(imx219);
1183                 if (ret)
1184                         goto error;
1185         }
1186
1187         return 0;
1188
1189 error:
1190         imx219_stop_streaming(imx219);
1191         imx219->streaming = 0;
1192
1193         return ret;
1194 }
1195
1196 static int imx219_get_regulators(struct imx219 *imx219)
1197 {
1198         struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1199         unsigned int i;
1200
1201         for (i = 0; i < IMX219_NUM_SUPPLIES; i++)
1202                 imx219->supplies[i].supply = imx219_supply_name[i];
1203
1204         return devm_regulator_bulk_get(&client->dev,
1205                                        IMX219_NUM_SUPPLIES,
1206                                        imx219->supplies);
1207 }
1208
1209 /* Verify chip ID */
1210 static int imx219_identify_module(struct imx219 *imx219)
1211 {
1212         struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1213         int ret;
1214         u32 val;
1215
1216         ret = imx219_read_reg(imx219, IMX219_REG_CHIP_ID,
1217                               IMX219_REG_VALUE_16BIT, &val);
1218         if (ret) {
1219                 dev_err(&client->dev, "failed to read chip id %x\n",
1220                         IMX219_CHIP_ID);
1221                 return ret;
1222         }
1223
1224         if (val != IMX219_CHIP_ID) {
1225                 dev_err(&client->dev, "chip id mismatch: %x!=%x\n",
1226                         IMX219_CHIP_ID, val);
1227                 return -EIO;
1228         }
1229
1230         return 0;
1231 }
1232
1233 static const struct v4l2_subdev_core_ops imx219_core_ops = {
1234         .subscribe_event = v4l2_ctrl_subdev_subscribe_event,
1235         .unsubscribe_event = v4l2_event_subdev_unsubscribe,
1236 };
1237
1238 static const struct v4l2_subdev_video_ops imx219_video_ops = {
1239         .s_stream = imx219_set_stream,
1240 };
1241
1242 static const struct v4l2_subdev_pad_ops imx219_pad_ops = {
1243         .enum_mbus_code = imx219_enum_mbus_code,
1244         .get_fmt = imx219_get_pad_format,
1245         .set_fmt = imx219_set_pad_format,
1246         .get_selection = imx219_get_selection,
1247         .enum_frame_size = imx219_enum_frame_size,
1248 };
1249
1250 static const struct v4l2_subdev_ops imx219_subdev_ops = {
1251         .core = &imx219_core_ops,
1252         .video = &imx219_video_ops,
1253         .pad = &imx219_pad_ops,
1254 };
1255
1256 static const struct v4l2_subdev_internal_ops imx219_internal_ops = {
1257         .open = imx219_open,
1258 };
1259
1260 /* Initialize control handlers */
1261 static int imx219_init_controls(struct imx219 *imx219)
1262 {
1263         struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1264         struct v4l2_ctrl_handler *ctrl_hdlr;
1265         unsigned int height = imx219->mode->height;
1266         struct v4l2_fwnode_device_properties props;
1267         int exposure_max, exposure_def, hblank;
1268         int i, ret;
1269
1270         ctrl_hdlr = &imx219->ctrl_handler;
1271         ret = v4l2_ctrl_handler_init(ctrl_hdlr, 11);
1272         if (ret)
1273                 return ret;
1274
1275         mutex_init(&imx219->mutex);
1276         ctrl_hdlr->lock = &imx219->mutex;
1277
1278         /* By default, PIXEL_RATE is read only */
1279         imx219->pixel_rate = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1280                                                V4L2_CID_PIXEL_RATE,
1281                                                IMX219_PIXEL_RATE,
1282                                                IMX219_PIXEL_RATE, 1,
1283                                                IMX219_PIXEL_RATE);
1284
1285         /* Initial vblank/hblank/exposure parameters based on current mode */
1286         imx219->vblank = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1287                                            V4L2_CID_VBLANK, IMX219_VBLANK_MIN,
1288                                            IMX219_VTS_MAX - height, 1,
1289                                            imx219->mode->vts_def - height);
1290         hblank = IMX219_PPL_DEFAULT - imx219->mode->width;
1291         imx219->hblank = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1292                                            V4L2_CID_HBLANK, hblank, hblank,
1293                                            1, hblank);
1294         if (imx219->hblank)
1295                 imx219->hblank->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1296         exposure_max = imx219->mode->vts_def - 4;
1297         exposure_def = (exposure_max < IMX219_EXPOSURE_DEFAULT) ?
1298                 exposure_max : IMX219_EXPOSURE_DEFAULT;
1299         imx219->exposure = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1300                                              V4L2_CID_EXPOSURE,
1301                                              IMX219_EXPOSURE_MIN, exposure_max,
1302                                              IMX219_EXPOSURE_STEP,
1303                                              exposure_def);
1304
1305         v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops, V4L2_CID_ANALOGUE_GAIN,
1306                           IMX219_ANA_GAIN_MIN, IMX219_ANA_GAIN_MAX,
1307                           IMX219_ANA_GAIN_STEP, IMX219_ANA_GAIN_DEFAULT);
1308
1309         v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops, V4L2_CID_DIGITAL_GAIN,
1310                           IMX219_DGTL_GAIN_MIN, IMX219_DGTL_GAIN_MAX,
1311                           IMX219_DGTL_GAIN_STEP, IMX219_DGTL_GAIN_DEFAULT);
1312
1313         imx219->hflip = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1314                                           V4L2_CID_HFLIP, 0, 1, 1, 0);
1315         if (imx219->hflip)
1316                 imx219->hflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
1317
1318         imx219->vflip = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1319                                           V4L2_CID_VFLIP, 0, 1, 1, 0);
1320         if (imx219->vflip)
1321                 imx219->vflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
1322
1323         v4l2_ctrl_new_std_menu_items(ctrl_hdlr, &imx219_ctrl_ops,
1324                                      V4L2_CID_TEST_PATTERN,
1325                                      ARRAY_SIZE(imx219_test_pattern_menu) - 1,
1326                                      0, 0, imx219_test_pattern_menu);
1327         for (i = 0; i < 4; i++) {
1328                 /*
1329                  * The assumption is that
1330                  * V4L2_CID_TEST_PATTERN_GREENR == V4L2_CID_TEST_PATTERN_RED + 1
1331                  * V4L2_CID_TEST_PATTERN_BLUE   == V4L2_CID_TEST_PATTERN_RED + 2
1332                  * V4L2_CID_TEST_PATTERN_GREENB == V4L2_CID_TEST_PATTERN_RED + 3
1333                  */
1334                 v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1335                                   V4L2_CID_TEST_PATTERN_RED + i,
1336                                   IMX219_TESTP_COLOUR_MIN,
1337                                   IMX219_TESTP_COLOUR_MAX,
1338                                   IMX219_TESTP_COLOUR_STEP,
1339                                   IMX219_TESTP_COLOUR_MAX);
1340                 /* The "Solid color" pattern is white by default */
1341         }
1342
1343         if (ctrl_hdlr->error) {
1344                 ret = ctrl_hdlr->error;
1345                 dev_err(&client->dev, "%s control init failed (%d)\n",
1346                         __func__, ret);
1347                 goto error;
1348         }
1349
1350         ret = v4l2_fwnode_device_parse(&client->dev, &props);
1351         if (ret)
1352                 goto error;
1353
1354         ret = v4l2_ctrl_new_fwnode_properties(ctrl_hdlr, &imx219_ctrl_ops,
1355                                               &props);
1356         if (ret)
1357                 goto error;
1358
1359         imx219->sd.ctrl_handler = ctrl_hdlr;
1360
1361         return 0;
1362
1363 error:
1364         v4l2_ctrl_handler_free(ctrl_hdlr);
1365         mutex_destroy(&imx219->mutex);
1366
1367         return ret;
1368 }
1369
1370 static void imx219_free_controls(struct imx219 *imx219)
1371 {
1372         v4l2_ctrl_handler_free(imx219->sd.ctrl_handler);
1373         mutex_destroy(&imx219->mutex);
1374 }
1375
1376 static int imx219_check_hwcfg(struct device *dev)
1377 {
1378         struct fwnode_handle *endpoint;
1379         struct v4l2_fwnode_endpoint ep_cfg = {
1380                 .bus_type = V4L2_MBUS_CSI2_DPHY
1381         };
1382         int ret = -EINVAL;
1383
1384         endpoint = fwnode_graph_get_next_endpoint(dev_fwnode(dev), NULL);
1385         if (!endpoint) {
1386                 dev_err(dev, "endpoint node not found\n");
1387                 return -EINVAL;
1388         }
1389
1390         if (v4l2_fwnode_endpoint_alloc_parse(endpoint, &ep_cfg)) {
1391                 dev_err(dev, "could not parse endpoint\n");
1392                 goto error_out;
1393         }
1394
1395         /* Check the number of MIPI CSI2 data lanes */
1396         if (ep_cfg.bus.mipi_csi2.num_data_lanes != 2) {
1397                 dev_err(dev, "only 2 data lanes are currently supported\n");
1398                 goto error_out;
1399         }
1400
1401         /* Check the link frequency set in device tree */
1402         if (!ep_cfg.nr_of_link_frequencies) {
1403                 dev_err(dev, "link-frequency property not found in DT\n");
1404                 goto error_out;
1405         }
1406
1407         if (ep_cfg.nr_of_link_frequencies != 1 ||
1408             ep_cfg.link_frequencies[0] != IMX219_DEFAULT_LINK_FREQ) {
1409                 dev_err(dev, "Link frequency not supported: %lld\n",
1410                         ep_cfg.link_frequencies[0]);
1411                 goto error_out;
1412         }
1413
1414         ret = 0;
1415
1416 error_out:
1417         v4l2_fwnode_endpoint_free(&ep_cfg);
1418         fwnode_handle_put(endpoint);
1419
1420         return ret;
1421 }
1422
1423 static int imx219_probe(struct i2c_client *client)
1424 {
1425         struct device *dev = &client->dev;
1426         struct imx219 *imx219;
1427         int ret;
1428
1429         imx219 = devm_kzalloc(&client->dev, sizeof(*imx219), GFP_KERNEL);
1430         if (!imx219)
1431                 return -ENOMEM;
1432
1433         v4l2_i2c_subdev_init(&imx219->sd, client, &imx219_subdev_ops);
1434
1435         /* Check the hardware configuration in device tree */
1436         if (imx219_check_hwcfg(dev))
1437                 return -EINVAL;
1438
1439         /* Get system clock (xclk) */
1440         imx219->xclk = devm_clk_get(dev, NULL);
1441         if (IS_ERR(imx219->xclk)) {
1442                 dev_err(dev, "failed to get xclk\n");
1443                 return PTR_ERR(imx219->xclk);
1444         }
1445
1446         imx219->xclk_freq = clk_get_rate(imx219->xclk);
1447         if (imx219->xclk_freq != IMX219_XCLK_FREQ) {
1448                 dev_err(dev, "xclk frequency not supported: %d Hz\n",
1449                         imx219->xclk_freq);
1450                 return -EINVAL;
1451         }
1452
1453         ret = imx219_get_regulators(imx219);
1454         if (ret) {
1455                 dev_err(dev, "failed to get regulators\n");
1456                 return ret;
1457         }
1458
1459         /* Request optional enable pin */
1460         imx219->reset_gpio = devm_gpiod_get_optional(dev, "reset",
1461                                                      GPIOD_OUT_HIGH);
1462
1463         /*
1464          * The sensor must be powered for imx219_identify_module()
1465          * to be able to read the CHIP_ID register
1466          */
1467         ret = imx219_power_on(dev);
1468         if (ret)
1469                 return ret;
1470
1471         ret = imx219_identify_module(imx219);
1472         if (ret)
1473                 goto error_power_off;
1474
1475         /* Set default mode to max resolution */
1476         imx219->mode = &supported_modes[0];
1477
1478         /* sensor doesn't enter LP-11 state upon power up until and unless
1479          * streaming is started, so upon power up switch the modes to:
1480          * streaming -> standby
1481          */
1482         ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
1483                                IMX219_REG_VALUE_08BIT, IMX219_MODE_STREAMING);
1484         if (ret < 0)
1485                 goto error_power_off;
1486         usleep_range(100, 110);
1487
1488         /* put sensor back to standby mode */
1489         ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
1490                                IMX219_REG_VALUE_08BIT, IMX219_MODE_STANDBY);
1491         if (ret < 0)
1492                 goto error_power_off;
1493         usleep_range(100, 110);
1494
1495         ret = imx219_init_controls(imx219);
1496         if (ret)
1497                 goto error_power_off;
1498
1499         /* Initialize subdev */
1500         imx219->sd.internal_ops = &imx219_internal_ops;
1501         imx219->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
1502         imx219->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
1503
1504         /* Initialize source pad */
1505         imx219->pad.flags = MEDIA_PAD_FL_SOURCE;
1506
1507         /* Initialize default format */
1508         imx219_set_default_format(imx219);
1509
1510         ret = media_entity_pads_init(&imx219->sd.entity, 1, &imx219->pad);
1511         if (ret) {
1512                 dev_err(dev, "failed to init entity pads: %d\n", ret);
1513                 goto error_handler_free;
1514         }
1515
1516         ret = v4l2_async_register_subdev_sensor_common(&imx219->sd);
1517         if (ret < 0) {
1518                 dev_err(dev, "failed to register sensor sub-device: %d\n", ret);
1519                 goto error_media_entity;
1520         }
1521
1522         /* Enable runtime PM and turn off the device */
1523         pm_runtime_set_active(dev);
1524         pm_runtime_enable(dev);
1525         pm_runtime_idle(dev);
1526
1527         return 0;
1528
1529 error_media_entity:
1530         media_entity_cleanup(&imx219->sd.entity);
1531
1532 error_handler_free:
1533         imx219_free_controls(imx219);
1534
1535 error_power_off:
1536         imx219_power_off(dev);
1537
1538         return ret;
1539 }
1540
1541 static int imx219_remove(struct i2c_client *client)
1542 {
1543         struct v4l2_subdev *sd = i2c_get_clientdata(client);
1544         struct imx219 *imx219 = to_imx219(sd);
1545
1546         v4l2_async_unregister_subdev(sd);
1547         media_entity_cleanup(&sd->entity);
1548         imx219_free_controls(imx219);
1549
1550         pm_runtime_disable(&client->dev);
1551         if (!pm_runtime_status_suspended(&client->dev))
1552                 imx219_power_off(&client->dev);
1553         pm_runtime_set_suspended(&client->dev);
1554
1555         return 0;
1556 }
1557
1558 static const struct of_device_id imx219_dt_ids[] = {
1559         { .compatible = "sony,imx219" },
1560         { /* sentinel */ }
1561 };
1562 MODULE_DEVICE_TABLE(of, imx219_dt_ids);
1563
1564 static const struct dev_pm_ops imx219_pm_ops = {
1565         SET_SYSTEM_SLEEP_PM_OPS(imx219_suspend, imx219_resume)
1566         SET_RUNTIME_PM_OPS(imx219_power_off, imx219_power_on, NULL)
1567 };
1568
1569 static struct i2c_driver imx219_i2c_driver = {
1570         .driver = {
1571                 .name = "imx219",
1572                 .of_match_table = imx219_dt_ids,
1573                 .pm = &imx219_pm_ops,
1574         },
1575         .probe_new = imx219_probe,
1576         .remove = imx219_remove,
1577 };
1578
1579 module_i2c_driver(imx219_i2c_driver);
1580
1581 MODULE_AUTHOR("Dave Stevenson <dave.stevenson@raspberrypi.com");
1582 MODULE_DESCRIPTION("Sony IMX219 sensor driver");
1583 MODULE_LICENSE("GPL v2");