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