xref: /linux/drivers/media/i2c/hi556.c (revision 0cdee263bc5e7b20f657ea09f9272f50c568f35b)
1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (c) 2019 Intel Corporation.
3 
4 #include <linux/unaligned.h>
5 #include <linux/acpi.h>
6 #include <linux/clk.h>
7 #include <linux/delay.h>
8 #include <linux/gpio/consumer.h>
9 #include <linux/i2c.h>
10 #include <linux/module.h>
11 #include <linux/pm_runtime.h>
12 #include <linux/regulator/consumer.h>
13 #include <media/v4l2-ctrls.h>
14 #include <media/v4l2-device.h>
15 #include <media/v4l2-fwnode.h>
16 
17 #define HI556_REG_VALUE_08BIT		1
18 #define HI556_REG_VALUE_16BIT		2
19 #define HI556_REG_VALUE_24BIT		3
20 
21 #define HI556_LINK_FREQ_437MHZ		437000000ULL
22 #define HI556_MCLK			19200000
23 #define HI556_DATA_LANES		2
24 #define HI556_RGB_DEPTH			10
25 
26 #define HI556_REG_CHIP_ID		0x0f16
27 #define HI556_CHIP_ID			0x0556
28 
29 #define HI556_REG_MODE_SELECT		0x0a00
30 #define HI556_MODE_STANDBY		0x0000
31 #define HI556_MODE_STREAMING		0x0100
32 
33 /* vertical-timings from sensor */
34 #define HI556_REG_FLL			0x0006
35 #define HI556_FLL_30FPS			0x0814
36 #define HI556_FLL_30FPS_MIN		0x0814
37 #define HI556_FLL_MAX			0x7fff
38 
39 /* horizontal-timings from sensor */
40 #define HI556_REG_LLP			0x0008
41 
42 /* Exposure controls from sensor */
43 #define HI556_REG_EXPOSURE		0x0074
44 #define HI556_EXPOSURE_MIN		6
45 #define HI556_EXPOSURE_MAX_MARGIN	2
46 #define HI556_EXPOSURE_STEP		1
47 
48 /* Analog gain controls from sensor */
49 #define HI556_REG_ANALOG_GAIN		0x0077
50 #define HI556_ANAL_GAIN_MIN		0
51 #define HI556_ANAL_GAIN_MAX		240
52 #define HI556_ANAL_GAIN_STEP		1
53 
54 /* Digital gain controls from sensor */
55 #define HI556_REG_MWB_GR_GAIN		0x0078
56 #define HI556_REG_MWB_GB_GAIN		0x007a
57 #define HI556_REG_MWB_R_GAIN		0x007c
58 #define HI556_REG_MWB_B_GAIN		0x007e
59 #define HI556_DGTL_GAIN_MIN		0
60 #define HI556_DGTL_GAIN_MAX		2048
61 #define HI556_DGTL_GAIN_STEP		1
62 #define HI556_DGTL_GAIN_DEFAULT		256
63 
64 /* Test Pattern Control */
65 #define HI556_REG_ISP			0X0a05
66 #define HI556_REG_ISP_TPG_EN		0x01
67 #define HI556_REG_TEST_PATTERN		0x0201
68 
69 /* HI556 native and active pixel array size. */
70 #define HI556_NATIVE_WIDTH		2592U
71 #define HI556_NATIVE_HEIGHT		1944U
72 #define HI556_PIXEL_ARRAY_LEFT		0U
73 #define HI556_PIXEL_ARRAY_TOP		0U
74 #define HI556_PIXEL_ARRAY_WIDTH	2592U
75 #define HI556_PIXEL_ARRAY_HEIGHT	1944U
76 
77 enum {
78 	HI556_LINK_FREQ_437MHZ_INDEX,
79 };
80 
81 struct hi556_reg {
82 	u16 address;
83 	u16 val;
84 };
85 
86 struct hi556_reg_list {
87 	u32 num_of_regs;
88 	const struct hi556_reg *regs;
89 };
90 
91 struct hi556_link_freq_config {
92 	const struct hi556_reg_list reg_list;
93 };
94 
95 struct hi556_mode {
96 	/* Frame width in pixels */
97 	u32 width;
98 
99 	/* Frame height in pixels */
100 	u32 height;
101 
102 	/* Analog crop rectangle. */
103 	struct v4l2_rect crop;
104 
105 	/* Horizontal timining size */
106 	u32 llp;
107 
108 	/* Default vertical timining size */
109 	u32 fll_def;
110 
111 	/* Min vertical timining size */
112 	u32 fll_min;
113 
114 	/* Link frequency needed for this resolution */
115 	u32 link_freq_index;
116 
117 	/* Sensor register settings for this resolution */
118 	const struct hi556_reg_list reg_list;
119 };
120 
121 #define to_hi556(_sd) container_of(_sd, struct hi556, sd)
122 
123 //SENSOR_INITIALIZATION
124 static const struct hi556_reg mipi_data_rate_874mbps[] = {
125 	{0x0e00, 0x0102},
126 	{0x0e02, 0x0102},
127 	{0x0e0c, 0x0100},
128 	{0x2000, 0x7400},
129 	{0x2002, 0x001c},
130 	{0x2004, 0x0242},
131 	{0x2006, 0x0942},
132 	{0x2008, 0x7007},
133 	{0x200a, 0x0fd9},
134 	{0x200c, 0x0259},
135 	{0x200e, 0x7008},
136 	{0x2010, 0x160e},
137 	{0x2012, 0x0047},
138 	{0x2014, 0x2118},
139 	{0x2016, 0x0041},
140 	{0x2018, 0x00d8},
141 	{0x201a, 0x0145},
142 	{0x201c, 0x0006},
143 	{0x201e, 0x0181},
144 	{0x2020, 0x13cc},
145 	{0x2022, 0x2057},
146 	{0x2024, 0x7001},
147 	{0x2026, 0x0fca},
148 	{0x2028, 0x00cb},
149 	{0x202a, 0x009f},
150 	{0x202c, 0x7002},
151 	{0x202e, 0x13cc},
152 	{0x2030, 0x019b},
153 	{0x2032, 0x014d},
154 	{0x2034, 0x2987},
155 	{0x2036, 0x2766},
156 	{0x2038, 0x0020},
157 	{0x203a, 0x2060},
158 	{0x203c, 0x0e5d},
159 	{0x203e, 0x181d},
160 	{0x2040, 0x2066},
161 	{0x2042, 0x20c4},
162 	{0x2044, 0x5000},
163 	{0x2046, 0x0005},
164 	{0x2048, 0x0000},
165 	{0x204a, 0x01db},
166 	{0x204c, 0x025a},
167 	{0x204e, 0x00c0},
168 	{0x2050, 0x0005},
169 	{0x2052, 0x0006},
170 	{0x2054, 0x0ad9},
171 	{0x2056, 0x0259},
172 	{0x2058, 0x0618},
173 	{0x205a, 0x0258},
174 	{0x205c, 0x2266},
175 	{0x205e, 0x20c8},
176 	{0x2060, 0x2060},
177 	{0x2062, 0x707b},
178 	{0x2064, 0x0fdd},
179 	{0x2066, 0x81b8},
180 	{0x2068, 0x5040},
181 	{0x206a, 0x0020},
182 	{0x206c, 0x5060},
183 	{0x206e, 0x3143},
184 	{0x2070, 0x5081},
185 	{0x2072, 0x025c},
186 	{0x2074, 0x7800},
187 	{0x2076, 0x7400},
188 	{0x2078, 0x001c},
189 	{0x207a, 0x0242},
190 	{0x207c, 0x0942},
191 	{0x207e, 0x0bd9},
192 	{0x2080, 0x0259},
193 	{0x2082, 0x7008},
194 	{0x2084, 0x160e},
195 	{0x2086, 0x0047},
196 	{0x2088, 0x2118},
197 	{0x208a, 0x0041},
198 	{0x208c, 0x00d8},
199 	{0x208e, 0x0145},
200 	{0x2090, 0x0006},
201 	{0x2092, 0x0181},
202 	{0x2094, 0x13cc},
203 	{0x2096, 0x2057},
204 	{0x2098, 0x7001},
205 	{0x209a, 0x0fca},
206 	{0x209c, 0x00cb},
207 	{0x209e, 0x009f},
208 	{0x20a0, 0x7002},
209 	{0x20a2, 0x13cc},
210 	{0x20a4, 0x019b},
211 	{0x20a6, 0x014d},
212 	{0x20a8, 0x2987},
213 	{0x20aa, 0x2766},
214 	{0x20ac, 0x0020},
215 	{0x20ae, 0x2060},
216 	{0x20b0, 0x0e5d},
217 	{0x20b2, 0x181d},
218 	{0x20b4, 0x2066},
219 	{0x20b6, 0x20c4},
220 	{0x20b8, 0x50a0},
221 	{0x20ba, 0x0005},
222 	{0x20bc, 0x0000},
223 	{0x20be, 0x01db},
224 	{0x20c0, 0x025a},
225 	{0x20c2, 0x00c0},
226 	{0x20c4, 0x0005},
227 	{0x20c6, 0x0006},
228 	{0x20c8, 0x0ad9},
229 	{0x20ca, 0x0259},
230 	{0x20cc, 0x0618},
231 	{0x20ce, 0x0258},
232 	{0x20d0, 0x2266},
233 	{0x20d2, 0x20c8},
234 	{0x20d4, 0x2060},
235 	{0x20d6, 0x707b},
236 	{0x20d8, 0x0fdd},
237 	{0x20da, 0x86b8},
238 	{0x20dc, 0x50e0},
239 	{0x20de, 0x0020},
240 	{0x20e0, 0x5100},
241 	{0x20e2, 0x3143},
242 	{0x20e4, 0x5121},
243 	{0x20e6, 0x7800},
244 	{0x20e8, 0x3140},
245 	{0x20ea, 0x01c4},
246 	{0x20ec, 0x01c1},
247 	{0x20ee, 0x01c0},
248 	{0x20f0, 0x01c4},
249 	{0x20f2, 0x2700},
250 	{0x20f4, 0x3d40},
251 	{0x20f6, 0x7800},
252 	{0x20f8, 0xffff},
253 	{0x27fe, 0xe000},
254 	{0x3000, 0x60f8},
255 	{0x3002, 0x187f},
256 	{0x3004, 0x7060},
257 	{0x3006, 0x0114},
258 	{0x3008, 0x60b0},
259 	{0x300a, 0x1473},
260 	{0x300c, 0x0013},
261 	{0x300e, 0x140f},
262 	{0x3010, 0x0040},
263 	{0x3012, 0x100f},
264 	{0x3014, 0x60f8},
265 	{0x3016, 0x187f},
266 	{0x3018, 0x7060},
267 	{0x301a, 0x0114},
268 	{0x301c, 0x60b0},
269 	{0x301e, 0x1473},
270 	{0x3020, 0x0013},
271 	{0x3022, 0x140f},
272 	{0x3024, 0x0040},
273 	{0x3026, 0x000f},
274 
275 	{0x0b00, 0x0000},
276 	{0x0b02, 0x0045},
277 	{0x0b04, 0xb405},
278 	{0x0b06, 0xc403},
279 	{0x0b08, 0x0081},
280 	{0x0b0a, 0x8252},
281 	{0x0b0c, 0xf814},
282 	{0x0b0e, 0xc618},
283 	{0x0b10, 0xa828},
284 	{0x0b12, 0x004c},
285 	{0x0b14, 0x4068},
286 	{0x0b16, 0x0000},
287 	{0x0f30, 0x5b15},
288 	{0x0f32, 0x7067},
289 	{0x0954, 0x0009},
290 	{0x0956, 0x0000},
291 	{0x0958, 0xbb80},
292 	{0x095a, 0x5140},
293 	{0x0c00, 0x1110},
294 	{0x0c02, 0x0011},
295 	{0x0c04, 0x0000},
296 	{0x0c06, 0x0200},
297 	{0x0c10, 0x0040},
298 	{0x0c12, 0x0040},
299 	{0x0c14, 0x0040},
300 	{0x0c16, 0x0040},
301 	{0x0a10, 0x4000},
302 	{0x3068, 0xf800},
303 	{0x306a, 0xf876},
304 	{0x006c, 0x0000},
305 	{0x005e, 0x0200},
306 	{0x000e, 0x0100},
307 	{0x0e0a, 0x0001},
308 	{0x004a, 0x0100},
309 	{0x004c, 0x0000},
310 	{0x004e, 0x0100},
311 	{0x000c, 0x0022},
312 	{0x0008, 0x0b00},
313 	{0x005a, 0x0202},
314 	{0x0012, 0x000e},
315 	{0x0018, 0x0a33},
316 	{0x0022, 0x0008},
317 	{0x0028, 0x0017},
318 	{0x0024, 0x0028},
319 	{0x002a, 0x002d},
320 	{0x0026, 0x0030},
321 	{0x002c, 0x07c9},
322 	{0x002e, 0x1111},
323 	{0x0030, 0x1111},
324 	{0x0032, 0x1111},
325 	{0x0006, 0x07bc},
326 	{0x0a22, 0x0000},
327 	{0x0a12, 0x0a20},
328 	{0x0a14, 0x0798},
329 	{0x003e, 0x0000},
330 	{0x0074, 0x080e},
331 	{0x0070, 0x0407},
332 	{0x0002, 0x0000},
333 	{0x0a02, 0x0100},
334 	{0x0a24, 0x0100},
335 	{0x0046, 0x0000},
336 	{0x0076, 0x0000},
337 	{0x0060, 0x0000},
338 	{0x0062, 0x0530},
339 	{0x0064, 0x0500},
340 	{0x0066, 0x0530},
341 	{0x0068, 0x0500},
342 	{0x0122, 0x0300},
343 	{0x015a, 0xff08},
344 	{0x0804, 0x0300},
345 	{0x0806, 0x0100},
346 	{0x005c, 0x0102},
347 	{0x0a1a, 0x0800},
348 };
349 
350 static const struct hi556_reg mode_2592x1944_regs[] = {
351 	{0x0a00, 0x0000},
352 	{0x0b0a, 0x8252},
353 	{0x0f30, 0x5b15},
354 	{0x0f32, 0x7067},
355 	{0x004a, 0x0100},
356 	{0x004c, 0x0000},
357 	{0x004e, 0x0100},
358 	{0x000c, 0x0022},
359 	{0x0008, 0x0b00},
360 	{0x005a, 0x0202},
361 	{0x0012, 0x000e},
362 	{0x0018, 0x0a33},
363 	{0x0022, 0x0008},
364 	{0x0028, 0x0017},
365 	{0x0024, 0x0028},
366 	{0x002a, 0x002d},
367 	{0x0026, 0x0030},
368 	{0x002c, 0x07c9},
369 	{0x002e, 0x1111},
370 	{0x0030, 0x1111},
371 	{0x0032, 0x1111},
372 	{0x0006, 0x0814},
373 	{0x0a22, 0x0000},
374 	{0x0a12, 0x0a20},
375 	{0x0a14, 0x0798},
376 	{0x003e, 0x0000},
377 	{0x0074, 0x0812},
378 	{0x0070, 0x0409},
379 	{0x0804, 0x0300},
380 	{0x0806, 0x0100},
381 	{0x0a04, 0x014a},
382 	{0x090c, 0x0fdc},
383 	{0x090e, 0x002d},
384 
385 	{0x0902, 0x4319},
386 	{0x0914, 0xc10a},
387 	{0x0916, 0x071f},
388 	{0x0918, 0x0408},
389 	{0x091a, 0x0c0d},
390 	{0x091c, 0x0f09},
391 	{0x091e, 0x0a00},
392 	{0x0958, 0xbb80},
393 };
394 
395 static const struct hi556_reg mode_2592x1444_regs[] = {
396 	{0x0a00, 0x0000},
397 	{0x0b0a, 0x8252},
398 	{0x0f30, 0xe545},
399 	{0x0f32, 0x7067},
400 	{0x004a, 0x0100},
401 	{0x004c, 0x0000},
402 	{0x000c, 0x0022},
403 	{0x0008, 0x0b00},
404 	{0x005a, 0x0202},
405 	{0x0012, 0x000e},
406 	{0x0018, 0x0a33},
407 	{0x0022, 0x0008},
408 	{0x0028, 0x0017},
409 	{0x0024, 0x0122},
410 	{0x002a, 0x0127},
411 	{0x0026, 0x012a},
412 	{0x002c, 0x06cf},
413 	{0x002e, 0x1111},
414 	{0x0030, 0x1111},
415 	{0x0032, 0x1111},
416 	{0x0006, 0x0821},
417 	{0x0a22, 0x0000},
418 	{0x0a12, 0x0a20},
419 	{0x0a14, 0x05a4},
420 	{0x003e, 0x0000},
421 	{0x0074, 0x081f},
422 	{0x0070, 0x040f},
423 	{0x0804, 0x0300},
424 	{0x0806, 0x0100},
425 	{0x0a04, 0x014a},
426 	{0x090c, 0x0fdc},
427 	{0x090e, 0x002d},
428 	{0x0902, 0x4319},
429 	{0x0914, 0xc10a},
430 	{0x0916, 0x071f},
431 	{0x0918, 0x0408},
432 	{0x091a, 0x0c0d},
433 	{0x091c, 0x0f09},
434 	{0x091e, 0x0a00},
435 	{0x0958, 0xbb80},
436 };
437 
438 static const struct hi556_reg mode_1296x972_regs[] = {
439 	{0x0a00, 0x0000},
440 	{0x0b0a, 0x8259},
441 	{0x0f30, 0x5b15},
442 	{0x0f32, 0x7167},
443 	{0x004a, 0x0100},
444 	{0x004c, 0x0000},
445 	{0x004e, 0x0100},
446 	{0x000c, 0x0122},
447 	{0x0008, 0x0b00},
448 	{0x005a, 0x0404},
449 	{0x0012, 0x000c},
450 	{0x0018, 0x0a33},
451 	{0x0022, 0x0008},
452 	{0x0028, 0x0017},
453 	{0x0024, 0x0022},
454 	{0x002a, 0x002b},
455 	{0x0026, 0x0030},
456 	{0x002c, 0x07c9},
457 	{0x002e, 0x3311},
458 	{0x0030, 0x3311},
459 	{0x0032, 0x3311},
460 	{0x0006, 0x0814},
461 	{0x0a22, 0x0000},
462 	{0x0a12, 0x0510},
463 	{0x0a14, 0x03cc},
464 	{0x003e, 0x0000},
465 	{0x0074, 0x0812},
466 	{0x0070, 0x0409},
467 	{0x0804, 0x0308},
468 	{0x0806, 0x0100},
469 	{0x0a04, 0x016a},
470 	{0x090e, 0x0010},
471 	{0x090c, 0x09c0},
472 
473 	{0x0902, 0x4319},
474 	{0x0914, 0xc106},
475 	{0x0916, 0x040e},
476 	{0x0918, 0x0304},
477 	{0x091a, 0x0708},
478 	{0x091c, 0x0e06},
479 	{0x091e, 0x0300},
480 	{0x0958, 0xbb80},
481 };
482 
483 static const struct hi556_reg mode_1296x722_regs[] = {
484 	{0x0a00, 0x0000},
485 	{0x0b0a, 0x8259},
486 	{0x0f30, 0x5b15},
487 	{0x0f32, 0x7167},
488 	{0x004a, 0x0100},
489 	{0x004c, 0x0000},
490 	{0x004e, 0x0100},
491 	{0x000c, 0x0122},
492 	{0x0008, 0x0b00},
493 	{0x005a, 0x0404},
494 	{0x0012, 0x000c},
495 	{0x0018, 0x0a33},
496 	{0x0022, 0x0008},
497 	{0x0028, 0x0017},
498 	{0x0024, 0x0022},
499 	{0x002a, 0x002b},
500 	{0x0026, 0x012a},
501 	{0x002c, 0x06cf},
502 	{0x002e, 0x3311},
503 	{0x0030, 0x3311},
504 	{0x0032, 0x3311},
505 	{0x0006, 0x0814},
506 	{0x0a22, 0x0000},
507 	{0x0a12, 0x0510},
508 	{0x0a14, 0x02d2},
509 	{0x003e, 0x0000},
510 	{0x0074, 0x0812},
511 	{0x0070, 0x0409},
512 	{0x0804, 0x0308},
513 	{0x0806, 0x0100},
514 	{0x0a04, 0x016a},
515 	{0x090c, 0x09c0},
516 	{0x090e, 0x0010},
517 	{0x0902, 0x4319},
518 	{0x0914, 0xc106},
519 	{0x0916, 0x040e},
520 	{0x0918, 0x0304},
521 	{0x091a, 0x0708},
522 	{0x091c, 0x0e06},
523 	{0x091e, 0x0300},
524 	{0x0958, 0xbb80},
525 };
526 
527 static const char * const hi556_test_pattern_menu[] = {
528 	"Disabled",
529 	"Solid Colour",
530 	"100% Colour Bars",
531 	"Fade To Grey Colour Bars",
532 	"PN9",
533 	"Gradient Horizontal",
534 	"Gradient Vertical",
535 	"Check Board",
536 	"Slant Pattern",
537 };
538 
539 static const s64 link_freq_menu_items[] = {
540 	HI556_LINK_FREQ_437MHZ,
541 };
542 
543 static const struct hi556_link_freq_config link_freq_configs[] = {
544 	[HI556_LINK_FREQ_437MHZ_INDEX] = {
545 		.reg_list = {
546 			.num_of_regs = ARRAY_SIZE(mipi_data_rate_874mbps),
547 			.regs = mipi_data_rate_874mbps,
548 		}
549 	}
550 };
551 
552 static const struct hi556_mode supported_modes[] = {
553 	{
554 		.width = HI556_PIXEL_ARRAY_WIDTH,
555 		.height = HI556_PIXEL_ARRAY_HEIGHT,
556 		.crop = {
557 			.left = HI556_PIXEL_ARRAY_LEFT,
558 			.top = HI556_PIXEL_ARRAY_TOP,
559 			.width = HI556_PIXEL_ARRAY_WIDTH,
560 			.height = HI556_PIXEL_ARRAY_HEIGHT
561 		},
562 		.fll_def = HI556_FLL_30FPS,
563 		.fll_min = HI556_FLL_30FPS_MIN,
564 		.llp = 0x0b00,
565 		.reg_list = {
566 			.num_of_regs = ARRAY_SIZE(mode_2592x1944_regs),
567 			.regs = mode_2592x1944_regs,
568 		},
569 		.link_freq_index = HI556_LINK_FREQ_437MHZ_INDEX,
570 	},
571 	{
572 		.width = HI556_PIXEL_ARRAY_WIDTH,
573 		.height = 1444,
574 		.crop = {
575 			.left = HI556_PIXEL_ARRAY_LEFT,
576 			.top = 250,
577 			.width = HI556_PIXEL_ARRAY_WIDTH,
578 			.height = 1444
579 		},
580 		.fll_def = 0x821,
581 		.fll_min = 0x821,
582 		.llp = 0x0b00,
583 		.reg_list = {
584 			.num_of_regs = ARRAY_SIZE(mode_2592x1444_regs),
585 			.regs = mode_2592x1444_regs,
586 		},
587 		.link_freq_index = HI556_LINK_FREQ_437MHZ_INDEX,
588 	},
589 	{
590 		.width = 1296,
591 		.height = 972,
592 		.crop = {
593 			.left = HI556_PIXEL_ARRAY_LEFT,
594 			.top = HI556_PIXEL_ARRAY_TOP,
595 			.width = HI556_PIXEL_ARRAY_WIDTH,
596 			.height = HI556_PIXEL_ARRAY_HEIGHT
597 		},
598 		.fll_def = HI556_FLL_30FPS,
599 		.fll_min = HI556_FLL_30FPS_MIN,
600 		.llp = 0x0b00,
601 		.reg_list = {
602 			.num_of_regs = ARRAY_SIZE(mode_1296x972_regs),
603 			.regs = mode_1296x972_regs,
604 		},
605 		.link_freq_index = HI556_LINK_FREQ_437MHZ_INDEX,
606 	},
607 	{
608 		.width = 1296,
609 		.height = 722,
610 		.crop = {
611 			.left = HI556_PIXEL_ARRAY_LEFT,
612 			.top = 250,
613 			.width = HI556_PIXEL_ARRAY_WIDTH,
614 			.height = 1444
615 		},
616 		.fll_def = HI556_FLL_30FPS,
617 		.fll_min = HI556_FLL_30FPS_MIN,
618 		.llp = 0x0b00,
619 		.reg_list = {
620 			.num_of_regs = ARRAY_SIZE(mode_1296x722_regs),
621 			.regs = mode_1296x722_regs,
622 		},
623 		.link_freq_index = HI556_LINK_FREQ_437MHZ_INDEX,
624 	},
625 };
626 
627 static const char * const hi556_supply_names[] = {
628 	"dovdd",	/* Digital I/O power */
629 	"avdd",		/* Analog power */
630 	"dvdd",		/* Digital core power */
631 };
632 
633 struct hi556 {
634 	struct v4l2_subdev sd;
635 	struct media_pad pad;
636 	struct v4l2_ctrl_handler ctrl_handler;
637 
638 	/* V4L2 Controls */
639 	struct v4l2_ctrl *link_freq;
640 	struct v4l2_ctrl *pixel_rate;
641 	struct v4l2_ctrl *vblank;
642 	struct v4l2_ctrl *hblank;
643 	struct v4l2_ctrl *exposure;
644 
645 	/* GPIOs, clocks, etc. */
646 	struct gpio_desc *reset_gpio;
647 	struct clk *clk;
648 	struct regulator_bulk_data supplies[ARRAY_SIZE(hi556_supply_names)];
649 
650 	/* Current mode */
651 	const struct hi556_mode *cur_mode;
652 
653 	/* To serialize asynchronous callbacks */
654 	struct mutex mutex;
655 
656 	/* True if the device has been identified */
657 	bool identified;
658 };
659 
to_pixel_rate(u32 f_index)660 static u64 to_pixel_rate(u32 f_index)
661 {
662 	u64 pixel_rate = link_freq_menu_items[f_index] * 2 * HI556_DATA_LANES;
663 
664 	do_div(pixel_rate, HI556_RGB_DEPTH);
665 
666 	return pixel_rate;
667 }
668 
hi556_read_reg(struct hi556 * hi556,u16 reg,u16 len,u32 * val)669 static int hi556_read_reg(struct hi556 *hi556, u16 reg, u16 len, u32 *val)
670 {
671 	struct i2c_client *client = v4l2_get_subdevdata(&hi556->sd);
672 	struct i2c_msg msgs[2];
673 	u8 addr_buf[2];
674 	u8 data_buf[4] = {0};
675 	int ret;
676 
677 	if (len > 4)
678 		return -EINVAL;
679 
680 	put_unaligned_be16(reg, addr_buf);
681 	msgs[0].addr = client->addr;
682 	msgs[0].flags = 0;
683 	msgs[0].len = sizeof(addr_buf);
684 	msgs[0].buf = addr_buf;
685 	msgs[1].addr = client->addr;
686 	msgs[1].flags = I2C_M_RD;
687 	msgs[1].len = len;
688 	msgs[1].buf = &data_buf[4 - len];
689 
690 	ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
691 	if (ret != ARRAY_SIZE(msgs))
692 		return -EIO;
693 
694 	*val = get_unaligned_be32(data_buf);
695 
696 	return 0;
697 }
698 
hi556_write_reg(struct hi556 * hi556,u16 reg,u16 len,u32 val)699 static int hi556_write_reg(struct hi556 *hi556, u16 reg, u16 len, u32 val)
700 {
701 	struct i2c_client *client = v4l2_get_subdevdata(&hi556->sd);
702 	u8 buf[6];
703 
704 	if (len > 4)
705 		return -EINVAL;
706 
707 	put_unaligned_be16(reg, buf);
708 	put_unaligned_be32(val << 8 * (4 - len), buf + 2);
709 	if (i2c_master_send(client, buf, len + 2) != len + 2)
710 		return -EIO;
711 
712 	return 0;
713 }
714 
hi556_write_reg_list(struct hi556 * hi556,const struct hi556_reg_list * r_list)715 static int hi556_write_reg_list(struct hi556 *hi556,
716 				const struct hi556_reg_list *r_list)
717 {
718 	struct i2c_client *client = v4l2_get_subdevdata(&hi556->sd);
719 	unsigned int i;
720 	int ret;
721 
722 	for (i = 0; i < r_list->num_of_regs; i++) {
723 		ret = hi556_write_reg(hi556, r_list->regs[i].address,
724 				      HI556_REG_VALUE_16BIT,
725 				      r_list->regs[i].val);
726 		if (ret) {
727 			dev_err_ratelimited(&client->dev,
728 					    "failed to write reg 0x%4.4x. error = %d\n",
729 					    r_list->regs[i].address, ret);
730 			return ret;
731 		}
732 	}
733 
734 	return 0;
735 }
736 
hi556_update_digital_gain(struct hi556 * hi556,u32 d_gain)737 static int hi556_update_digital_gain(struct hi556 *hi556, u32 d_gain)
738 {
739 	int ret;
740 
741 	ret = hi556_write_reg(hi556, HI556_REG_MWB_GR_GAIN,
742 			      HI556_REG_VALUE_16BIT, d_gain);
743 	if (ret)
744 		return ret;
745 
746 	ret = hi556_write_reg(hi556, HI556_REG_MWB_GB_GAIN,
747 			      HI556_REG_VALUE_16BIT, d_gain);
748 	if (ret)
749 		return ret;
750 
751 	ret = hi556_write_reg(hi556, HI556_REG_MWB_R_GAIN,
752 			      HI556_REG_VALUE_16BIT, d_gain);
753 	if (ret)
754 		return ret;
755 
756 	return hi556_write_reg(hi556, HI556_REG_MWB_B_GAIN,
757 			       HI556_REG_VALUE_16BIT, d_gain);
758 }
759 
hi556_test_pattern(struct hi556 * hi556,u32 pattern)760 static int hi556_test_pattern(struct hi556 *hi556, u32 pattern)
761 {
762 	int ret;
763 	u32 val;
764 
765 	ret = hi556_read_reg(hi556, HI556_REG_ISP,
766 			     HI556_REG_VALUE_08BIT, &val);
767 	if (ret)
768 		return ret;
769 
770 	val = pattern ? (val | HI556_REG_ISP_TPG_EN) :
771 		(val & ~HI556_REG_ISP_TPG_EN);
772 
773 	ret = hi556_write_reg(hi556, HI556_REG_ISP,
774 			      HI556_REG_VALUE_08BIT, val);
775 	if (ret)
776 		return ret;
777 
778 	val = pattern ? BIT(pattern - 1) : 0;
779 
780 	return hi556_write_reg(hi556, HI556_REG_TEST_PATTERN,
781 			       HI556_REG_VALUE_08BIT, val);
782 }
783 
hi556_set_ctrl(struct v4l2_ctrl * ctrl)784 static int hi556_set_ctrl(struct v4l2_ctrl *ctrl)
785 {
786 	struct hi556 *hi556 = container_of(ctrl->handler,
787 					     struct hi556, ctrl_handler);
788 	struct i2c_client *client = v4l2_get_subdevdata(&hi556->sd);
789 	s64 exposure_max;
790 	int ret = 0;
791 
792 	/* Propagate change of current control to all related controls */
793 	if (ctrl->id == V4L2_CID_VBLANK) {
794 		/* Update max exposure while meeting expected vblanking */
795 		exposure_max = hi556->cur_mode->height + ctrl->val -
796 			       HI556_EXPOSURE_MAX_MARGIN;
797 		__v4l2_ctrl_modify_range(hi556->exposure,
798 					 hi556->exposure->minimum,
799 					 exposure_max, hi556->exposure->step,
800 					 exposure_max);
801 	}
802 
803 	/* V4L2 controls values will be applied only when power is already up */
804 	if (!pm_runtime_get_if_in_use(&client->dev))
805 		return 0;
806 
807 	switch (ctrl->id) {
808 	case V4L2_CID_ANALOGUE_GAIN:
809 		ret = hi556_write_reg(hi556, HI556_REG_ANALOG_GAIN,
810 				      HI556_REG_VALUE_16BIT, ctrl->val);
811 		break;
812 
813 	case V4L2_CID_DIGITAL_GAIN:
814 		ret = hi556_update_digital_gain(hi556, ctrl->val);
815 		break;
816 
817 	case V4L2_CID_EXPOSURE:
818 		ret = hi556_write_reg(hi556, HI556_REG_EXPOSURE,
819 				      HI556_REG_VALUE_16BIT, ctrl->val);
820 		break;
821 
822 	case V4L2_CID_VBLANK:
823 		/* Update FLL that meets expected vertical blanking */
824 		ret = hi556_write_reg(hi556, HI556_REG_FLL,
825 				      HI556_REG_VALUE_16BIT,
826 				      hi556->cur_mode->height + ctrl->val);
827 		break;
828 
829 	case V4L2_CID_TEST_PATTERN:
830 		ret = hi556_test_pattern(hi556, ctrl->val);
831 		break;
832 
833 	default:
834 		ret = -EINVAL;
835 		break;
836 	}
837 
838 	pm_runtime_put(&client->dev);
839 
840 	return ret;
841 }
842 
843 static const struct v4l2_ctrl_ops hi556_ctrl_ops = {
844 	.s_ctrl = hi556_set_ctrl,
845 };
846 
hi556_init_controls(struct hi556 * hi556)847 static int hi556_init_controls(struct hi556 *hi556)
848 {
849 	struct v4l2_ctrl_handler *ctrl_hdlr;
850 	s64 exposure_max, h_blank;
851 	int ret;
852 
853 	ctrl_hdlr = &hi556->ctrl_handler;
854 	ret = v4l2_ctrl_handler_init(ctrl_hdlr, 8);
855 	if (ret)
856 		return ret;
857 
858 	ctrl_hdlr->lock = &hi556->mutex;
859 	hi556->link_freq = v4l2_ctrl_new_int_menu(ctrl_hdlr, &hi556_ctrl_ops,
860 						  V4L2_CID_LINK_FREQ,
861 					ARRAY_SIZE(link_freq_menu_items) - 1,
862 					0, link_freq_menu_items);
863 	if (hi556->link_freq)
864 		hi556->link_freq->flags |= V4L2_CTRL_FLAG_READ_ONLY;
865 
866 	hi556->pixel_rate = v4l2_ctrl_new_std
867 			    (ctrl_hdlr, &hi556_ctrl_ops,
868 			     V4L2_CID_PIXEL_RATE, 0,
869 			     to_pixel_rate(HI556_LINK_FREQ_437MHZ_INDEX),
870 			     1,
871 			     to_pixel_rate(HI556_LINK_FREQ_437MHZ_INDEX));
872 	hi556->vblank = v4l2_ctrl_new_std(ctrl_hdlr, &hi556_ctrl_ops,
873 					  V4L2_CID_VBLANK,
874 					  hi556->cur_mode->fll_min -
875 					  hi556->cur_mode->height,
876 					  HI556_FLL_MAX -
877 					  hi556->cur_mode->height, 1,
878 					  hi556->cur_mode->fll_def -
879 					  hi556->cur_mode->height);
880 
881 	h_blank = hi556->cur_mode->llp - hi556->cur_mode->width;
882 
883 	hi556->hblank = v4l2_ctrl_new_std(ctrl_hdlr, &hi556_ctrl_ops,
884 					  V4L2_CID_HBLANK, h_blank, h_blank, 1,
885 					  h_blank);
886 	if (hi556->hblank)
887 		hi556->hblank->flags |= V4L2_CTRL_FLAG_READ_ONLY;
888 
889 	v4l2_ctrl_new_std(ctrl_hdlr, &hi556_ctrl_ops, V4L2_CID_ANALOGUE_GAIN,
890 			  HI556_ANAL_GAIN_MIN, HI556_ANAL_GAIN_MAX,
891 			  HI556_ANAL_GAIN_STEP, HI556_ANAL_GAIN_MIN);
892 	v4l2_ctrl_new_std(ctrl_hdlr, &hi556_ctrl_ops, V4L2_CID_DIGITAL_GAIN,
893 			  HI556_DGTL_GAIN_MIN, HI556_DGTL_GAIN_MAX,
894 			  HI556_DGTL_GAIN_STEP, HI556_DGTL_GAIN_DEFAULT);
895 	exposure_max = hi556->cur_mode->fll_def - HI556_EXPOSURE_MAX_MARGIN;
896 	hi556->exposure = v4l2_ctrl_new_std(ctrl_hdlr, &hi556_ctrl_ops,
897 					    V4L2_CID_EXPOSURE,
898 					    HI556_EXPOSURE_MIN, exposure_max,
899 					    HI556_EXPOSURE_STEP,
900 					    exposure_max);
901 	v4l2_ctrl_new_std_menu_items(ctrl_hdlr, &hi556_ctrl_ops,
902 				     V4L2_CID_TEST_PATTERN,
903 				     ARRAY_SIZE(hi556_test_pattern_menu) - 1,
904 				     0, 0, hi556_test_pattern_menu);
905 	if (ctrl_hdlr->error)
906 		return ctrl_hdlr->error;
907 
908 	hi556->sd.ctrl_handler = ctrl_hdlr;
909 
910 	return 0;
911 }
912 
hi556_assign_pad_format(const struct hi556_mode * mode,struct v4l2_mbus_framefmt * fmt)913 static void hi556_assign_pad_format(const struct hi556_mode *mode,
914 				    struct v4l2_mbus_framefmt *fmt)
915 {
916 	fmt->width = mode->width;
917 	fmt->height = mode->height;
918 	fmt->code = MEDIA_BUS_FMT_SGRBG10_1X10;
919 	fmt->field = V4L2_FIELD_NONE;
920 }
921 
hi556_identify_module(struct hi556 * hi556)922 static int hi556_identify_module(struct hi556 *hi556)
923 {
924 	struct i2c_client *client = v4l2_get_subdevdata(&hi556->sd);
925 	int ret;
926 	u32 val;
927 
928 	if (hi556->identified)
929 		return 0;
930 
931 	ret = hi556_read_reg(hi556, HI556_REG_CHIP_ID,
932 			     HI556_REG_VALUE_16BIT, &val);
933 	if (ret)
934 		return ret;
935 
936 	if (val != HI556_CHIP_ID) {
937 		dev_err(&client->dev, "chip id mismatch: %x!=%x\n",
938 			HI556_CHIP_ID, val);
939 		return -ENXIO;
940 	}
941 
942 	hi556->identified = true;
943 
944 	return 0;
945 }
946 
947 static const struct v4l2_rect *
__hi556_get_pad_crop(struct hi556 * hi556,struct v4l2_subdev_state * sd_state,unsigned int pad,enum v4l2_subdev_format_whence which)948 __hi556_get_pad_crop(struct hi556 *hi556,
949 		     struct v4l2_subdev_state *sd_state,
950 		     unsigned int pad, enum v4l2_subdev_format_whence which)
951 {
952 	switch (which) {
953 	case V4L2_SUBDEV_FORMAT_TRY:
954 		return v4l2_subdev_state_get_crop(sd_state, pad);
955 	case V4L2_SUBDEV_FORMAT_ACTIVE:
956 		return &hi556->cur_mode->crop;
957 	}
958 
959 	return NULL;
960 }
961 
hi556_get_selection(struct v4l2_subdev * sd,struct v4l2_subdev_state * sd_state,struct v4l2_subdev_selection * sel)962 static int hi556_get_selection(struct v4l2_subdev *sd,
963 			       struct v4l2_subdev_state *sd_state,
964 			       struct v4l2_subdev_selection *sel)
965 {
966 	switch (sel->target) {
967 	case V4L2_SEL_TGT_CROP: {
968 		struct hi556 *hi556 = to_hi556(sd);
969 
970 		mutex_lock(&hi556->mutex);
971 		sel->r = *__hi556_get_pad_crop(hi556, sd_state, sel->pad,
972 						sel->which);
973 		mutex_unlock(&hi556->mutex);
974 
975 		return 0;
976 	}
977 
978 	case V4L2_SEL_TGT_NATIVE_SIZE:
979 		sel->r.top = 0;
980 		sel->r.left = 0;
981 		sel->r.width = HI556_NATIVE_WIDTH;
982 		sel->r.height = HI556_NATIVE_HEIGHT;
983 
984 		return 0;
985 
986 	case V4L2_SEL_TGT_CROP_DEFAULT:
987 	case V4L2_SEL_TGT_CROP_BOUNDS:
988 		sel->r.top = HI556_PIXEL_ARRAY_TOP;
989 		sel->r.left = HI556_PIXEL_ARRAY_LEFT;
990 		sel->r.width = HI556_PIXEL_ARRAY_WIDTH;
991 		sel->r.height = HI556_PIXEL_ARRAY_HEIGHT;
992 
993 		return 0;
994 	}
995 
996 	return -EINVAL;
997 }
998 
hi556_start_streaming(struct hi556 * hi556)999 static int hi556_start_streaming(struct hi556 *hi556)
1000 {
1001 	struct i2c_client *client = v4l2_get_subdevdata(&hi556->sd);
1002 	const struct hi556_reg_list *reg_list;
1003 	int link_freq_index, ret;
1004 
1005 	ret = hi556_identify_module(hi556);
1006 	if (ret)
1007 		return ret;
1008 
1009 	link_freq_index = hi556->cur_mode->link_freq_index;
1010 	reg_list = &link_freq_configs[link_freq_index].reg_list;
1011 	ret = hi556_write_reg_list(hi556, reg_list);
1012 	if (ret) {
1013 		dev_err(&client->dev, "failed to set plls\n");
1014 		return ret;
1015 	}
1016 
1017 	reg_list = &hi556->cur_mode->reg_list;
1018 	ret = hi556_write_reg_list(hi556, reg_list);
1019 	if (ret) {
1020 		dev_err(&client->dev, "failed to set mode\n");
1021 		return ret;
1022 	}
1023 
1024 	ret = __v4l2_ctrl_handler_setup(hi556->sd.ctrl_handler);
1025 	if (ret)
1026 		return ret;
1027 
1028 	ret = hi556_write_reg(hi556, HI556_REG_MODE_SELECT,
1029 			      HI556_REG_VALUE_16BIT, HI556_MODE_STREAMING);
1030 
1031 	if (ret) {
1032 		dev_err(&client->dev, "failed to set stream\n");
1033 		return ret;
1034 	}
1035 
1036 	return 0;
1037 }
1038 
hi556_stop_streaming(struct hi556 * hi556)1039 static void hi556_stop_streaming(struct hi556 *hi556)
1040 {
1041 	struct i2c_client *client = v4l2_get_subdevdata(&hi556->sd);
1042 
1043 	if (hi556_write_reg(hi556, HI556_REG_MODE_SELECT,
1044 			    HI556_REG_VALUE_16BIT, HI556_MODE_STANDBY))
1045 		dev_err(&client->dev, "failed to set stream\n");
1046 }
1047 
hi556_set_stream(struct v4l2_subdev * sd,int enable)1048 static int hi556_set_stream(struct v4l2_subdev *sd, int enable)
1049 {
1050 	struct hi556 *hi556 = to_hi556(sd);
1051 	struct i2c_client *client = v4l2_get_subdevdata(sd);
1052 	int ret = 0;
1053 
1054 	mutex_lock(&hi556->mutex);
1055 	if (enable) {
1056 		ret = pm_runtime_resume_and_get(&client->dev);
1057 		if (ret < 0) {
1058 			mutex_unlock(&hi556->mutex);
1059 			return ret;
1060 		}
1061 
1062 		ret = hi556_start_streaming(hi556);
1063 		if (ret) {
1064 			hi556_stop_streaming(hi556);
1065 			pm_runtime_put(&client->dev);
1066 		}
1067 	} else {
1068 		hi556_stop_streaming(hi556);
1069 		pm_runtime_put(&client->dev);
1070 	}
1071 
1072 	mutex_unlock(&hi556->mutex);
1073 
1074 	return ret;
1075 }
1076 
hi556_set_format(struct v4l2_subdev * sd,struct v4l2_subdev_state * sd_state,struct v4l2_subdev_format * fmt)1077 static int hi556_set_format(struct v4l2_subdev *sd,
1078 			    struct v4l2_subdev_state *sd_state,
1079 			    struct v4l2_subdev_format *fmt)
1080 {
1081 	struct hi556 *hi556 = to_hi556(sd);
1082 	const struct hi556_mode *mode;
1083 	s32 vblank_def, h_blank;
1084 
1085 	mode = v4l2_find_nearest_size(supported_modes,
1086 				      ARRAY_SIZE(supported_modes), width,
1087 				      height, fmt->format.width,
1088 				      fmt->format.height);
1089 
1090 	mutex_lock(&hi556->mutex);
1091 	hi556_assign_pad_format(mode, &fmt->format);
1092 	if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
1093 		*v4l2_subdev_state_get_format(sd_state, fmt->pad) = fmt->format;
1094 	} else {
1095 		hi556->cur_mode = mode;
1096 		__v4l2_ctrl_s_ctrl(hi556->link_freq, mode->link_freq_index);
1097 		__v4l2_ctrl_s_ctrl_int64(hi556->pixel_rate,
1098 					 to_pixel_rate(mode->link_freq_index));
1099 
1100 		/* Update limits and set FPS to default */
1101 		vblank_def = mode->fll_def - mode->height;
1102 		__v4l2_ctrl_modify_range(hi556->vblank,
1103 					 mode->fll_min - mode->height,
1104 					 HI556_FLL_MAX - mode->height, 1,
1105 					 vblank_def);
1106 		__v4l2_ctrl_s_ctrl(hi556->vblank, vblank_def);
1107 
1108 		h_blank = hi556->cur_mode->llp - hi556->cur_mode->width;
1109 
1110 		__v4l2_ctrl_modify_range(hi556->hblank, h_blank, h_blank, 1,
1111 					 h_blank);
1112 	}
1113 
1114 	mutex_unlock(&hi556->mutex);
1115 
1116 	return 0;
1117 }
1118 
hi556_get_format(struct v4l2_subdev * sd,struct v4l2_subdev_state * sd_state,struct v4l2_subdev_format * fmt)1119 static int hi556_get_format(struct v4l2_subdev *sd,
1120 			    struct v4l2_subdev_state *sd_state,
1121 			    struct v4l2_subdev_format *fmt)
1122 {
1123 	struct hi556 *hi556 = to_hi556(sd);
1124 
1125 	mutex_lock(&hi556->mutex);
1126 	if (fmt->which == V4L2_SUBDEV_FORMAT_TRY)
1127 		fmt->format = *v4l2_subdev_state_get_format(sd_state,
1128 							    fmt->pad);
1129 	else
1130 		hi556_assign_pad_format(hi556->cur_mode, &fmt->format);
1131 
1132 	mutex_unlock(&hi556->mutex);
1133 
1134 	return 0;
1135 }
1136 
hi556_enum_mbus_code(struct v4l2_subdev * sd,struct v4l2_subdev_state * sd_state,struct v4l2_subdev_mbus_code_enum * code)1137 static int hi556_enum_mbus_code(struct v4l2_subdev *sd,
1138 				struct v4l2_subdev_state *sd_state,
1139 				struct v4l2_subdev_mbus_code_enum *code)
1140 {
1141 	if (code->index > 0)
1142 		return -EINVAL;
1143 
1144 	code->code = MEDIA_BUS_FMT_SGRBG10_1X10;
1145 
1146 	return 0;
1147 }
1148 
hi556_enum_frame_size(struct v4l2_subdev * sd,struct v4l2_subdev_state * sd_state,struct v4l2_subdev_frame_size_enum * fse)1149 static int hi556_enum_frame_size(struct v4l2_subdev *sd,
1150 				 struct v4l2_subdev_state *sd_state,
1151 				 struct v4l2_subdev_frame_size_enum *fse)
1152 {
1153 	if (fse->index >= ARRAY_SIZE(supported_modes))
1154 		return -EINVAL;
1155 
1156 	if (fse->code != MEDIA_BUS_FMT_SGRBG10_1X10)
1157 		return -EINVAL;
1158 
1159 	fse->min_width = supported_modes[fse->index].width;
1160 	fse->max_width = fse->min_width;
1161 	fse->min_height = supported_modes[fse->index].height;
1162 	fse->max_height = fse->min_height;
1163 
1164 	return 0;
1165 }
1166 
hi556_open(struct v4l2_subdev * sd,struct v4l2_subdev_fh * fh)1167 static int hi556_open(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
1168 {
1169 	struct hi556 *hi556 = to_hi556(sd);
1170 	struct v4l2_rect *try_crop;
1171 
1172 	mutex_lock(&hi556->mutex);
1173 	hi556_assign_pad_format(&supported_modes[0],
1174 				v4l2_subdev_state_get_format(fh->state, 0));
1175 
1176 	/* Initialize try_crop rectangle. */
1177 	try_crop = v4l2_subdev_state_get_crop(fh->state, 0);
1178 	try_crop->top = HI556_PIXEL_ARRAY_TOP;
1179 	try_crop->left = HI556_PIXEL_ARRAY_LEFT;
1180 	try_crop->width = HI556_PIXEL_ARRAY_WIDTH;
1181 	try_crop->height = HI556_PIXEL_ARRAY_HEIGHT;
1182 
1183 	mutex_unlock(&hi556->mutex);
1184 
1185 	return 0;
1186 }
1187 
1188 static const struct v4l2_subdev_video_ops hi556_video_ops = {
1189 	.s_stream = hi556_set_stream,
1190 };
1191 
1192 static const struct v4l2_subdev_pad_ops hi556_pad_ops = {
1193 	.set_fmt = hi556_set_format,
1194 	.get_fmt = hi556_get_format,
1195 	.get_selection = hi556_get_selection,
1196 	.enum_mbus_code = hi556_enum_mbus_code,
1197 	.enum_frame_size = hi556_enum_frame_size,
1198 };
1199 
1200 static const struct v4l2_subdev_ops hi556_subdev_ops = {
1201 	.video = &hi556_video_ops,
1202 	.pad = &hi556_pad_ops,
1203 };
1204 
1205 static const struct media_entity_operations hi556_subdev_entity_ops = {
1206 	.link_validate = v4l2_subdev_link_validate,
1207 };
1208 
1209 static const struct v4l2_subdev_internal_ops hi556_internal_ops = {
1210 	.open = hi556_open,
1211 };
1212 
hi556_check_hwcfg(struct device * dev)1213 static int hi556_check_hwcfg(struct device *dev)
1214 {
1215 	struct fwnode_handle *ep;
1216 	struct fwnode_handle *fwnode = dev_fwnode(dev);
1217 	struct v4l2_fwnode_endpoint bus_cfg = {
1218 		.bus_type = V4L2_MBUS_CSI2_DPHY
1219 	};
1220 	u32 mclk;
1221 	int ret = 0;
1222 	unsigned int i, j;
1223 
1224 	/*
1225 	 * Sometimes the fwnode graph is initialized by the bridge driver,
1226 	 * wait for this.
1227 	 */
1228 	ep = fwnode_graph_get_next_endpoint(fwnode, NULL);
1229 	if (!ep)
1230 		return dev_err_probe(dev, -EPROBE_DEFER,
1231 				     "waiting for fwnode graph endpoint\n");
1232 
1233 	ret = v4l2_fwnode_endpoint_alloc_parse(ep, &bus_cfg);
1234 	fwnode_handle_put(ep);
1235 	if (ret)
1236 		return dev_err_probe(dev, ret, "parsing endpoint failed\n");
1237 
1238 	ret = fwnode_property_read_u32(fwnode, "clock-frequency", &mclk);
1239 	if (ret) {
1240 		dev_err(dev, "can't get clock frequency\n");
1241 		goto check_hwcfg_error;
1242 	}
1243 
1244 	if (mclk != HI556_MCLK) {
1245 		dev_err(dev, "external clock %d is not supported\n", mclk);
1246 		ret = -EINVAL;
1247 		goto check_hwcfg_error;
1248 	}
1249 
1250 	if (bus_cfg.bus.mipi_csi2.num_data_lanes != 2) {
1251 		dev_err(dev, "number of CSI2 data lanes %d is not supported\n",
1252 			bus_cfg.bus.mipi_csi2.num_data_lanes);
1253 		ret = -EINVAL;
1254 		goto check_hwcfg_error;
1255 	}
1256 
1257 	if (!bus_cfg.nr_of_link_frequencies) {
1258 		dev_err(dev, "no link frequencies defined\n");
1259 		ret = -EINVAL;
1260 		goto check_hwcfg_error;
1261 	}
1262 
1263 	for (i = 0; i < ARRAY_SIZE(link_freq_menu_items); i++) {
1264 		for (j = 0; j < bus_cfg.nr_of_link_frequencies; j++) {
1265 			if (link_freq_menu_items[i] ==
1266 				bus_cfg.link_frequencies[j])
1267 				break;
1268 		}
1269 
1270 		if (j == bus_cfg.nr_of_link_frequencies) {
1271 			dev_err(dev, "no link frequency %lld supported\n",
1272 				link_freq_menu_items[i]);
1273 			ret = -EINVAL;
1274 			goto check_hwcfg_error;
1275 		}
1276 	}
1277 
1278 check_hwcfg_error:
1279 	v4l2_fwnode_endpoint_free(&bus_cfg);
1280 
1281 	return ret;
1282 }
1283 
hi556_remove(struct i2c_client * client)1284 static void hi556_remove(struct i2c_client *client)
1285 {
1286 	struct v4l2_subdev *sd = i2c_get_clientdata(client);
1287 	struct hi556 *hi556 = to_hi556(sd);
1288 
1289 	v4l2_async_unregister_subdev(sd);
1290 	media_entity_cleanup(&sd->entity);
1291 	v4l2_ctrl_handler_free(sd->ctrl_handler);
1292 	pm_runtime_disable(&client->dev);
1293 	mutex_destroy(&hi556->mutex);
1294 }
1295 
hi556_suspend(struct device * dev)1296 static int hi556_suspend(struct device *dev)
1297 {
1298 	struct v4l2_subdev *sd = dev_get_drvdata(dev);
1299 	struct hi556 *hi556 = to_hi556(sd);
1300 
1301 	gpiod_set_value_cansleep(hi556->reset_gpio, 1);
1302 	regulator_bulk_disable(ARRAY_SIZE(hi556_supply_names),
1303 			       hi556->supplies);
1304 	clk_disable_unprepare(hi556->clk);
1305 	return 0;
1306 }
1307 
hi556_resume(struct device * dev)1308 static int hi556_resume(struct device *dev)
1309 {
1310 	struct v4l2_subdev *sd = dev_get_drvdata(dev);
1311 	struct hi556 *hi556 = to_hi556(sd);
1312 	int ret;
1313 
1314 	ret = clk_prepare_enable(hi556->clk);
1315 	if (ret)
1316 		return ret;
1317 
1318 	ret = regulator_bulk_enable(ARRAY_SIZE(hi556_supply_names),
1319 				    hi556->supplies);
1320 	if (ret) {
1321 		dev_err(dev, "failed to enable regulators: %d", ret);
1322 		clk_disable_unprepare(hi556->clk);
1323 		return ret;
1324 	}
1325 
1326 	if (hi556->reset_gpio) {
1327 		/* Assert reset for at least 2ms on back to back off-on */
1328 		usleep_range(2000, 2200);
1329 		gpiod_set_value_cansleep(hi556->reset_gpio, 0);
1330 	}
1331 
1332 	usleep_range(5000, 5500);
1333 	return 0;
1334 }
1335 
hi556_probe(struct i2c_client * client)1336 static int hi556_probe(struct i2c_client *client)
1337 {
1338 	struct hi556 *hi556;
1339 	bool full_power;
1340 	int i, ret;
1341 
1342 	ret = hi556_check_hwcfg(&client->dev);
1343 	if (ret)
1344 		return ret;
1345 
1346 	hi556 = devm_kzalloc(&client->dev, sizeof(*hi556), GFP_KERNEL);
1347 	if (!hi556)
1348 		return -ENOMEM;
1349 
1350 	v4l2_i2c_subdev_init(&hi556->sd, client, &hi556_subdev_ops);
1351 
1352 	hi556->reset_gpio = devm_gpiod_get_optional(&client->dev, "reset",
1353 						    GPIOD_OUT_HIGH);
1354 	if (IS_ERR(hi556->reset_gpio))
1355 		return dev_err_probe(&client->dev, PTR_ERR(hi556->reset_gpio),
1356 				     "failed to get reset GPIO\n");
1357 
1358 	hi556->clk = devm_clk_get_optional(&client->dev, "clk");
1359 	if (IS_ERR(hi556->clk))
1360 		return dev_err_probe(&client->dev, PTR_ERR(hi556->clk),
1361 				     "failed to get clock\n");
1362 
1363 	for (i = 0; i < ARRAY_SIZE(hi556_supply_names); i++)
1364 		hi556->supplies[i].supply = hi556_supply_names[i];
1365 
1366 	ret = devm_regulator_bulk_get(&client->dev,
1367 				      ARRAY_SIZE(hi556_supply_names),
1368 				      hi556->supplies);
1369 	if (ret)
1370 		return dev_err_probe(&client->dev, ret,
1371 				     "failed to get regulators\n");
1372 
1373 	full_power = acpi_dev_state_d0(&client->dev);
1374 	if (full_power) {
1375 		/* Ensure non ACPI managed resources are enabled */
1376 		ret = hi556_resume(&client->dev);
1377 		if (ret)
1378 			return dev_err_probe(&client->dev, ret,
1379 					     "failed to power on sensor\n");
1380 
1381 		ret = hi556_identify_module(hi556);
1382 		if (ret) {
1383 			dev_err(&client->dev, "failed to find sensor: %d\n", ret);
1384 			goto probe_error_power_off;
1385 		}
1386 	}
1387 
1388 	mutex_init(&hi556->mutex);
1389 	hi556->cur_mode = &supported_modes[0];
1390 	ret = hi556_init_controls(hi556);
1391 	if (ret) {
1392 		dev_err(&client->dev, "failed to init controls: %d\n", ret);
1393 		goto probe_error_v4l2_ctrl_handler_free;
1394 	}
1395 
1396 	hi556->sd.internal_ops = &hi556_internal_ops;
1397 	hi556->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
1398 	hi556->sd.entity.ops = &hi556_subdev_entity_ops;
1399 	hi556->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
1400 	hi556->pad.flags = MEDIA_PAD_FL_SOURCE;
1401 	ret = media_entity_pads_init(&hi556->sd.entity, 1, &hi556->pad);
1402 	if (ret) {
1403 		dev_err(&client->dev, "failed to init entity pads: %d\n", ret);
1404 		goto probe_error_v4l2_ctrl_handler_free;
1405 	}
1406 
1407 	ret = v4l2_async_register_subdev_sensor(&hi556->sd);
1408 	if (ret < 0) {
1409 		dev_err(&client->dev, "failed to register V4L2 subdev: %d\n",
1410 			ret);
1411 		goto probe_error_media_entity_cleanup;
1412 	}
1413 
1414 	/* Set the device's state to active if it's in D0 state. */
1415 	if (full_power)
1416 		pm_runtime_set_active(&client->dev);
1417 	pm_runtime_enable(&client->dev);
1418 	pm_runtime_idle(&client->dev);
1419 
1420 	return 0;
1421 
1422 probe_error_media_entity_cleanup:
1423 	media_entity_cleanup(&hi556->sd.entity);
1424 
1425 probe_error_v4l2_ctrl_handler_free:
1426 	v4l2_ctrl_handler_free(hi556->sd.ctrl_handler);
1427 	mutex_destroy(&hi556->mutex);
1428 
1429 probe_error_power_off:
1430 	if (full_power)
1431 		hi556_suspend(&client->dev);
1432 
1433 	return ret;
1434 }
1435 
1436 static DEFINE_RUNTIME_DEV_PM_OPS(hi556_pm_ops, hi556_suspend, hi556_resume,
1437 				 NULL);
1438 
1439 #ifdef CONFIG_ACPI
1440 static const struct acpi_device_id hi556_acpi_ids[] = {
1441 	{"INT3537"},
1442 	{}
1443 };
1444 
1445 MODULE_DEVICE_TABLE(acpi, hi556_acpi_ids);
1446 #endif
1447 
1448 static struct i2c_driver hi556_i2c_driver = {
1449 	.driver = {
1450 		.name = "hi556",
1451 		.acpi_match_table = ACPI_PTR(hi556_acpi_ids),
1452 		.pm = pm_sleep_ptr(&hi556_pm_ops),
1453 	},
1454 	.probe = hi556_probe,
1455 	.remove = hi556_remove,
1456 	.flags = I2C_DRV_ACPI_WAIVE_D0_PROBE,
1457 };
1458 
1459 module_i2c_driver(hi556_i2c_driver);
1460 
1461 MODULE_AUTHOR("Shawn Tu");
1462 MODULE_DESCRIPTION("Hynix HI556 sensor driver");
1463 MODULE_LICENSE("GPL v2");
1464