1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3     v4l2 common internal API header
4 
5     This header contains internal shared ioctl definitions for use by the
6     internal low-level v4l2 drivers.
7     Each ioctl begins with VIDIOC_INT_ to clearly mark that it is an internal
8     define,
9 
10     Copyright (C) 2005  Hans Verkuil <hverkuil@xs4all.nl>
11 
12  */
13 
14 #ifndef V4L2_COMMON_H_
15 #define V4L2_COMMON_H_
16 
17 #include <linux/time.h>
18 #include <media/v4l2-dev.h>
19 
20 /* Common printk constructs for v4l-i2c drivers. These macros create a unique
21    prefix consisting of the driver name, the adapter number and the i2c
22    address. */
23 #define v4l_printk(level, name, adapter, addr, fmt, arg...) \
24 	printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)
25 
26 #define v4l_client_printk(level, client, fmt, arg...)			    \
27 	v4l_printk(level, (client)->dev.driver->name, (client)->adapter, \
28 		   (client)->addr, fmt , ## arg)
29 
30 #define v4l_err(client, fmt, arg...) \
31 	v4l_client_printk(KERN_ERR, client, fmt , ## arg)
32 
33 #define v4l_warn(client, fmt, arg...) \
34 	v4l_client_printk(KERN_WARNING, client, fmt , ## arg)
35 
36 #define v4l_info(client, fmt, arg...) \
37 	v4l_client_printk(KERN_INFO, client, fmt , ## arg)
38 
39 /* These three macros assume that the debug level is set with a module
40    parameter called 'debug'. */
41 #define v4l_dbg(level, debug, client, fmt, arg...)			     \
42 	do {								     \
43 		if (debug >= (level))					     \
44 			v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
45 	} while (0)
46 
47 /* Add a version of v4l_dbg to be used on drivers using dev_foo() macros */
48 #define dev_dbg_lvl(__dev, __level, __debug, __fmt, __arg...)		\
49 	do {								\
50 		if (__debug >= (__level))				\
51 			dev_printk(KERN_DEBUG, __dev, __fmt, ##__arg);	\
52 	} while (0)
53 
54 /* ------------------------------------------------------------------------- */
55 
56 /* These printk constructs can be used with v4l2_device and v4l2_subdev */
57 #define v4l2_printk(level, dev, fmt, arg...) \
58 	printk(level "%s: " fmt, (dev)->name , ## arg)
59 
60 #define v4l2_err(dev, fmt, arg...) \
61 	v4l2_printk(KERN_ERR, dev, fmt , ## arg)
62 
63 #define v4l2_warn(dev, fmt, arg...) \
64 	v4l2_printk(KERN_WARNING, dev, fmt , ## arg)
65 
66 #define v4l2_info(dev, fmt, arg...) \
67 	v4l2_printk(KERN_INFO, dev, fmt , ## arg)
68 
69 /* These three macros assume that the debug level is set with a module
70    parameter called 'debug'. */
71 #define v4l2_dbg(level, debug, dev, fmt, arg...)			\
72 	do {								\
73 		if (debug >= (level))					\
74 			v4l2_printk(KERN_DEBUG, dev, fmt , ## arg);	\
75 	} while (0)
76 
77 /**
78  * v4l2_ctrl_query_fill- Fill in a struct v4l2_queryctrl
79  *
80  * @qctrl: pointer to the &struct v4l2_queryctrl to be filled
81  * @min: minimum value for the control
82  * @max: maximum value for the control
83  * @step: control step
84  * @def: default value for the control
85  *
86  * Fills the &struct v4l2_queryctrl fields for the query control.
87  *
88  * .. note::
89  *
90  *    This function assumes that the @qctrl->id field is filled.
91  *
92  * Returns -EINVAL if the control is not known by the V4L2 core, 0 on success.
93  */
94 
95 int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl,
96 			 s32 min, s32 max, s32 step, s32 def);
97 
98 /* ------------------------------------------------------------------------- */
99 
100 struct v4l2_device;
101 struct v4l2_subdev;
102 struct v4l2_subdev_ops;
103 
104 /* I2C Helper functions */
105 #include <linux/i2c.h>
106 
107 /**
108  * enum v4l2_i2c_tuner_type - specifies the range of tuner address that
109  *	should be used when seeking for I2C devices.
110  *
111  * @ADDRS_RADIO:		Radio tuner addresses.
112  *				Represent the following I2C addresses:
113  *				0x10 (if compiled with tea5761 support)
114  *				and 0x60.
115  * @ADDRS_DEMOD:		Demod tuner addresses.
116  *				Represent the following I2C addresses:
117  *				0x42, 0x43, 0x4a and 0x4b.
118  * @ADDRS_TV:			TV tuner addresses.
119  *				Represent the following I2C addresses:
120  *				0x42, 0x43, 0x4a, 0x4b, 0x60, 0x61, 0x62,
121  *				0x63 and 0x64.
122  * @ADDRS_TV_WITH_DEMOD:	TV tuner addresses if demod is present, this
123  *				excludes addresses used by the demodulator
124  *				from the list of candidates.
125  *				Represent the following I2C addresses:
126  *				0x60, 0x61, 0x62, 0x63 and 0x64.
127  *
128  * NOTE: All I2C addresses above use the 7-bit notation.
129  */
130 enum v4l2_i2c_tuner_type {
131 	ADDRS_RADIO,
132 	ADDRS_DEMOD,
133 	ADDRS_TV,
134 	ADDRS_TV_WITH_DEMOD,
135 };
136 
137 #if defined(CONFIG_VIDEO_V4L2_I2C)
138 
139 /**
140  * v4l2_i2c_new_subdev - Load an i2c module and return an initialized
141  *	&struct v4l2_subdev.
142  *
143  * @v4l2_dev: pointer to &struct v4l2_device
144  * @adapter: pointer to struct i2c_adapter
145  * @client_type:  name of the chip that's on the adapter.
146  * @addr: I2C address. If zero, it will use @probe_addrs
147  * @probe_addrs: array with a list of address. The last entry at such
148  *	array should be %I2C_CLIENT_END.
149  *
150  * returns a &struct v4l2_subdev pointer.
151  */
152 struct v4l2_subdev *v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev,
153 		struct i2c_adapter *adapter, const char *client_type,
154 		u8 addr, const unsigned short *probe_addrs);
155 
156 /**
157  * v4l2_i2c_new_subdev_board - Load an i2c module and return an initialized
158  *	&struct v4l2_subdev.
159  *
160  * @v4l2_dev: pointer to &struct v4l2_device
161  * @adapter: pointer to struct i2c_adapter
162  * @info: pointer to struct i2c_board_info used to replace the irq,
163  *	 platform_data and addr arguments.
164  * @probe_addrs: array with a list of address. The last entry at such
165  *	array should be %I2C_CLIENT_END.
166  *
167  * returns a &struct v4l2_subdev pointer.
168  */
169 struct v4l2_subdev *v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev,
170 		struct i2c_adapter *adapter, struct i2c_board_info *info,
171 		const unsigned short *probe_addrs);
172 
173 /**
174  * v4l2_i2c_subdev_set_name - Set name for an I²C sub-device
175  *
176  * @sd: pointer to &struct v4l2_subdev
177  * @client: pointer to struct i2c_client
178  * @devname: the name of the device; if NULL, the I²C device drivers's name
179  *           will be used
180  * @postfix: sub-device specific string to put right after the I²C device name;
181  *	     may be NULL
182  */
183 void v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client,
184 			      const char *devname, const char *postfix);
185 
186 /**
187  * v4l2_i2c_subdev_init - Initializes a &struct v4l2_subdev with data from
188  *	an i2c_client struct.
189  *
190  * @sd: pointer to &struct v4l2_subdev
191  * @client: pointer to struct i2c_client
192  * @ops: pointer to &struct v4l2_subdev_ops
193  */
194 void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
195 		const struct v4l2_subdev_ops *ops);
196 
197 /**
198  * v4l2_i2c_subdev_addr - returns i2c client address of &struct v4l2_subdev.
199  *
200  * @sd: pointer to &struct v4l2_subdev
201  *
202  * Returns the address of an I2C sub-device
203  */
204 unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
205 
206 /**
207  * v4l2_i2c_tuner_addrs - Return a list of I2C tuner addresses to probe.
208  *
209  * @type: type of the tuner to seek, as defined by
210  *	  &enum v4l2_i2c_tuner_type.
211  *
212  * NOTE: Use only if the tuner addresses are unknown.
213  */
214 const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
215 
216 /**
217  * v4l2_i2c_subdev_unregister - Unregister a v4l2_subdev
218  *
219  * @sd: pointer to &struct v4l2_subdev
220  */
221 void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd);
222 
223 #else
224 
225 static inline struct v4l2_subdev *
226 v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev,
227 		    struct i2c_adapter *adapter, const char *client_type,
228 		    u8 addr, const unsigned short *probe_addrs)
229 {
230 	return NULL;
231 }
232 
233 static inline struct v4l2_subdev *
234 v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev,
235 			  struct i2c_adapter *adapter, struct i2c_board_info *info,
236 			  const unsigned short *probe_addrs)
237 {
238 	return NULL;
239 }
240 
241 static inline void
242 v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client,
243 			 const char *devname, const char *postfix)
244 {}
245 
246 static inline void
247 v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
248 		     const struct v4l2_subdev_ops *ops)
249 {}
250 
251 static inline unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd)
252 {
253 	return I2C_CLIENT_END;
254 }
255 
256 static inline const unsigned short *
257 v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type)
258 {
259 	return NULL;
260 }
261 
262 static inline void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd)
263 {}
264 
265 #endif
266 
267 /* ------------------------------------------------------------------------- */
268 
269 /* SPI Helper functions */
270 
271 #include <linux/spi/spi.h>
272 
273 #if defined(CONFIG_SPI)
274 
275 /**
276  *  v4l2_spi_new_subdev - Load an spi module and return an initialized
277  *	&struct v4l2_subdev.
278  *
279  *
280  * @v4l2_dev: pointer to &struct v4l2_device.
281  * @ctlr: pointer to struct spi_controller.
282  * @info: pointer to struct spi_board_info.
283  *
284  * returns a &struct v4l2_subdev pointer.
285  */
286 struct v4l2_subdev *v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
287 		struct spi_controller *ctlr, struct spi_board_info *info);
288 
289 /**
290  * v4l2_spi_subdev_init - Initialize a v4l2_subdev with data from an
291  *	spi_device struct.
292  *
293  * @sd: pointer to &struct v4l2_subdev
294  * @spi: pointer to struct spi_device.
295  * @ops: pointer to &struct v4l2_subdev_ops
296  */
297 void v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
298 		const struct v4l2_subdev_ops *ops);
299 
300 /**
301  * v4l2_spi_subdev_unregister - Unregister a v4l2_subdev
302  *
303  * @sd: pointer to &struct v4l2_subdev
304  */
305 void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd);
306 
307 #else
308 
309 static inline struct v4l2_subdev *
310 v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
311 		    struct spi_controller *ctlr, struct spi_board_info *info)
312 {
313 	return NULL;
314 }
315 
316 static inline void
317 v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
318 		     const struct v4l2_subdev_ops *ops)
319 {}
320 
321 static inline void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd)
322 {}
323 #endif
324 
325 /* ------------------------------------------------------------------------- */
326 
327 /*
328  * FIXME: these remaining ioctls/structs should be removed as well, but they
329  * are still used in tuner-simple.c (TUNER_SET_CONFIG) and cx18/ivtv (RESET).
330  * To remove these ioctls some more cleanup is needed in those modules.
331  *
332  * It doesn't make much sense on documenting them, as what we really want is
333  * to get rid of them.
334  */
335 
336 /* s_config */
337 struct v4l2_priv_tun_config {
338 	int tuner;
339 	void *priv;
340 };
341 #define TUNER_SET_CONFIG           _IOW('d', 92, struct v4l2_priv_tun_config)
342 
343 #define VIDIOC_INT_RESET		_IOW ('d', 102, u32)
344 
345 /* ------------------------------------------------------------------------- */
346 
347 /* Miscellaneous helper functions */
348 
349 /**
350  * v4l_bound_align_image - adjust video dimensions according to
351  *	a given constraints.
352  *
353  * @width:	pointer to width that will be adjusted if needed.
354  * @wmin:	minimum width.
355  * @wmax:	maximum width.
356  * @walign:	least significant bit on width.
357  * @height:	pointer to height that will be adjusted if needed.
358  * @hmin:	minimum height.
359  * @hmax:	maximum height.
360  * @halign:	least significant bit on height.
361  * @salign:	least significant bit for the image size (e. g.
362  *		:math:`width * height`).
363  *
364  * Clip an image to have @width between @wmin and @wmax, and @height between
365  * @hmin and @hmax, inclusive.
366  *
367  * Additionally, the @width will be a multiple of :math:`2^{walign}`,
368  * the @height will be a multiple of :math:`2^{halign}`, and the overall
369  * size :math:`width * height` will be a multiple of :math:`2^{salign}`.
370  *
371  * .. note::
372  *
373  *    #. The clipping rectangle may be shrunk or enlarged to fit the alignment
374  *       constraints.
375  *    #. @wmax must not be smaller than @wmin.
376  *    #. @hmax must not be smaller than @hmin.
377  *    #. The alignments must not be so high there are no possible image
378  *       sizes within the allowed bounds.
379  *    #. @wmin and @hmin must be at least 1 (don't use 0).
380  *    #. For @walign, @halign and @salign, if you don't care about a certain
381  *       alignment, specify ``0``, as :math:`2^0 = 1` and one byte alignment
382  *       is equivalent to no alignment.
383  *    #. If you only want to adjust downward, specify a maximum that's the
384  *       same as the initial value.
385  */
386 void v4l_bound_align_image(unsigned int *width, unsigned int wmin,
387 			   unsigned int wmax, unsigned int walign,
388 			   unsigned int *height, unsigned int hmin,
389 			   unsigned int hmax, unsigned int halign,
390 			   unsigned int salign);
391 
392 /**
393  * v4l2_find_nearest_size_conditional - Find the nearest size among a discrete
394  *	set of resolutions contained in an array of a driver specific struct,
395  *	with conditionally exlusion of certain modes
396  *
397  * @array: a driver specific array of image sizes
398  * @array_size: the length of the driver specific array of image sizes
399  * @width_field: the name of the width field in the driver specific struct
400  * @height_field: the name of the height field in the driver specific struct
401  * @width: desired width
402  * @height: desired height
403  * @func: ignores mode if returns false
404  * @context: context for the function
405  *
406  * Finds the closest resolution to minimize the width and height differences
407  * between what requested and the supported resolutions. The size of the width
408  * and height fields in the driver specific must equal to that of u32, i.e. four
409  * bytes. @func is called for each mode considered, a mode is ignored if @func
410  * returns false for it.
411  *
412  * Returns the best match or NULL if the length of the array is zero.
413  */
414 #define v4l2_find_nearest_size_conditional(array, array_size, width_field, \
415 					   height_field, width, height, \
416 					   func, context) \
417 	({								\
418 		BUILD_BUG_ON(sizeof((array)->width_field) != sizeof(u32) || \
419 			     sizeof((array)->height_field) != sizeof(u32)); \
420 		(typeof(&(array)[0]))__v4l2_find_nearest_size_conditional( \
421 			(array), array_size, sizeof(*(array)),		\
422 			offsetof(typeof(*(array)), width_field),	\
423 			offsetof(typeof(*(array)), height_field),	\
424 			width, height, func, context);			\
425 	})
426 const void *
427 __v4l2_find_nearest_size_conditional(const void *array, size_t array_size,
428 				     size_t entry_size, size_t width_offset,
429 				     size_t height_offset, s32 width,
430 				     s32 height,
431 				     bool (*func)(const void *array,
432 						  size_t index,
433 						  const void *context),
434 				     const void *context);
435 
436 /**
437  * v4l2_find_nearest_size - Find the nearest size among a discrete set of
438  *	resolutions contained in an array of a driver specific struct
439  *
440  * @array: a driver specific array of image sizes
441  * @array_size: the length of the driver specific array of image sizes
442  * @width_field: the name of the width field in the driver specific struct
443  * @height_field: the name of the height field in the driver specific struct
444  * @width: desired width
445  * @height: desired height
446  *
447  * Finds the closest resolution to minimize the width and height differences
448  * between what requested and the supported resolutions. The size of the width
449  * and height fields in the driver specific must equal to that of u32, i.e. four
450  * bytes.
451  *
452  * Returns the best match or NULL if the length of the array is zero.
453  */
454 #define v4l2_find_nearest_size(array, array_size, width_field,		\
455 			       height_field, width, height)		\
456 	v4l2_find_nearest_size_conditional(array, array_size, width_field, \
457 					   height_field, width, height, NULL, \
458 					   NULL)
459 
460 /**
461  * v4l2_g_parm_cap - helper routine for vidioc_g_parm to fill this in by
462  *      calling the get_frame_interval op of the given subdev. It only works
463  *      for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the
464  *      function name.
465  *
466  * @vdev: the struct video_device pointer. Used to determine the device caps.
467  * @sd: the sub-device pointer.
468  * @a: the VIDIOC_G_PARM argument.
469  */
470 int v4l2_g_parm_cap(struct video_device *vdev,
471 		    struct v4l2_subdev *sd, struct v4l2_streamparm *a);
472 
473 /**
474  * v4l2_s_parm_cap - helper routine for vidioc_s_parm to fill this in by
475  *      calling the set_frame_interval op of the given subdev. It only works
476  *      for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the
477  *      function name.
478  *
479  * @vdev: the struct video_device pointer. Used to determine the device caps.
480  * @sd: the sub-device pointer.
481  * @a: the VIDIOC_S_PARM argument.
482  */
483 int v4l2_s_parm_cap(struct video_device *vdev,
484 		    struct v4l2_subdev *sd, struct v4l2_streamparm *a);
485 
486 /* Compare two v4l2_fract structs */
487 #define V4L2_FRACT_COMPARE(a, OP, b)			\
488 	((u64)(a).numerator * (b).denominator OP	\
489 	(u64)(b).numerator * (a).denominator)
490 
491 /* ------------------------------------------------------------------------- */
492 
493 /* Pixel format and FourCC helpers */
494 
495 /**
496  * enum v4l2_pixel_encoding - specifies the pixel encoding value
497  *
498  * @V4L2_PIXEL_ENC_UNKNOWN:	Pixel encoding is unknown/un-initialized
499  * @V4L2_PIXEL_ENC_YUV:		Pixel encoding is YUV
500  * @V4L2_PIXEL_ENC_RGB:		Pixel encoding is RGB
501  * @V4L2_PIXEL_ENC_BAYER:	Pixel encoding is Bayer
502  */
503 enum v4l2_pixel_encoding {
504 	V4L2_PIXEL_ENC_UNKNOWN = 0,
505 	V4L2_PIXEL_ENC_YUV = 1,
506 	V4L2_PIXEL_ENC_RGB = 2,
507 	V4L2_PIXEL_ENC_BAYER = 3,
508 };
509 
510 /**
511  * struct v4l2_format_info - information about a V4L2 format
512  * @format: 4CC format identifier (V4L2_PIX_FMT_*)
513  * @pixel_enc: Pixel encoding (see enum v4l2_pixel_encoding above)
514  * @mem_planes: Number of memory planes, which includes the alpha plane (1 to 4).
515  * @comp_planes: Number of component planes, which includes the alpha plane (1 to 4).
516  * @bpp: Array of per-plane bytes per pixel
517  * @bpp_div: Array of per-plane bytes per pixel divisors to support fractional pixel sizes.
518  * @hdiv: Horizontal chroma subsampling factor
519  * @vdiv: Vertical chroma subsampling factor
520  * @block_w: Per-plane macroblock pixel width (optional)
521  * @block_h: Per-plane macroblock pixel height (optional)
522  */
523 struct v4l2_format_info {
524 	u32 format;
525 	u8 pixel_enc;
526 	u8 mem_planes;
527 	u8 comp_planes;
528 	u8 bpp[4];
529 	u8 bpp_div[4];
530 	u8 hdiv;
531 	u8 vdiv;
532 	u8 block_w[4];
533 	u8 block_h[4];
534 };
535 
536 static inline bool v4l2_is_format_rgb(const struct v4l2_format_info *f)
537 {
538 	return f && f->pixel_enc == V4L2_PIXEL_ENC_RGB;
539 }
540 
541 static inline bool v4l2_is_format_yuv(const struct v4l2_format_info *f)
542 {
543 	return f && f->pixel_enc == V4L2_PIXEL_ENC_YUV;
544 }
545 
546 static inline bool v4l2_is_format_bayer(const struct v4l2_format_info *f)
547 {
548 	return f && f->pixel_enc == V4L2_PIXEL_ENC_BAYER;
549 }
550 
551 const struct v4l2_format_info *v4l2_format_info(u32 format);
552 void v4l2_apply_frmsize_constraints(u32 *width, u32 *height,
553 				    const struct v4l2_frmsize_stepwise *frmsize);
554 int v4l2_fill_pixfmt(struct v4l2_pix_format *pixfmt, u32 pixelformat,
555 		     u32 width, u32 height);
556 int v4l2_fill_pixfmt_mp(struct v4l2_pix_format_mplane *pixfmt, u32 pixelformat,
557 			u32 width, u32 height);
558 
559 /**
560  * v4l2_get_link_freq - Get link rate from transmitter
561  *
562  * @pad: The transmitter's media pad (or control handler for non-MC users or
563  *	 compatibility reasons, don't use in new code)
564  * @mul: The multiplier between pixel rate and link frequency. Bits per pixel on
565  *	 D-PHY, samples per clock on parallel. 0 otherwise.
566  * @div: The divisor between pixel rate and link frequency. Number of data lanes
567  *	 times two on D-PHY, 1 on parallel. 0 otherwise.
568  *
569  * This function is intended for obtaining the link frequency from the
570  * transmitter sub-devices. It returns the link rate, either from the
571  * V4L2_CID_LINK_FREQ control implemented by the transmitter, or value
572  * calculated based on the V4L2_CID_PIXEL_RATE implemented by the transmitter.
573  *
574  * Return:
575  * * >0: Link frequency
576  * * %-ENOENT: Link frequency or pixel rate control not found
577  * * %-EINVAL: Invalid link frequency value
578  */
579 #ifdef CONFIG_MEDIA_CONTROLLER
580 #define v4l2_get_link_freq(pad, mul, div)				\
581 	_Generic(pad,							\
582 		 struct media_pad *: __v4l2_get_link_freq_pad,		\
583 		 struct v4l2_ctrl_handler *: __v4l2_get_link_freq_ctrl)	\
584 	(pad, mul, div)
585 s64 __v4l2_get_link_freq_pad(struct media_pad *pad, unsigned int mul,
586 			     unsigned int div);
587 #else
588 #define v4l2_get_link_freq(handler, mul, div)		\
589 	__v4l2_get_link_freq_ctrl(handler, mul, div)
590 #endif
591 s64 __v4l2_get_link_freq_ctrl(struct v4l2_ctrl_handler *handler,
592 			      unsigned int mul, unsigned int div);
593 
594 void v4l2_simplify_fraction(u32 *numerator, u32 *denominator,
595 		unsigned int n_terms, unsigned int threshold);
596 u32 v4l2_fraction_to_interval(u32 numerator, u32 denominator);
597 
598 /**
599  * v4l2_link_freq_to_bitmap - Figure out platform-supported link frequencies
600  * @dev: The struct device
601  * @fw_link_freqs: Array of link frequencies from firmware
602  * @num_of_fw_link_freqs: Number of entries in @fw_link_freqs
603  * @driver_link_freqs: Array of link frequencies supported by the driver
604  * @num_of_driver_link_freqs: Number of entries in @driver_link_freqs
605  * @bitmap: Bitmap of driver-supported link frequencies found in @fw_link_freqs
606  *
607  * This function checks which driver-supported link frequencies are enabled in
608  * system firmware and sets the corresponding bits in @bitmap (after first
609  * zeroing it).
610  *
611  * Return:
612  * * %0: Success
613  * * %-ENOENT: No match found between driver-supported link frequencies and
614  *   those available in firmware.
615  * * %-ENODATA: No link frequencies were specified in firmware.
616  */
617 int v4l2_link_freq_to_bitmap(struct device *dev, const u64 *fw_link_freqs,
618 			     unsigned int num_of_fw_link_freqs,
619 			     const s64 *driver_link_freqs,
620 			     unsigned int num_of_driver_link_freqs,
621 			     unsigned long *bitmap);
622 
623 static inline u64 v4l2_buffer_get_timestamp(const struct v4l2_buffer *buf)
624 {
625 	/*
626 	 * When the timestamp comes from 32-bit user space, there may be
627 	 * uninitialized data in tv_usec, so cast it to u32.
628 	 * Otherwise allow invalid input for backwards compatibility.
629 	 */
630 	return buf->timestamp.tv_sec * NSEC_PER_SEC +
631 		(u32)buf->timestamp.tv_usec * NSEC_PER_USEC;
632 }
633 
634 static inline void v4l2_buffer_set_timestamp(struct v4l2_buffer *buf,
635 					     u64 timestamp)
636 {
637 	struct timespec64 ts = ns_to_timespec64(timestamp);
638 
639 	buf->timestamp.tv_sec  = ts.tv_sec;
640 	buf->timestamp.tv_usec = ts.tv_nsec / NSEC_PER_USEC;
641 }
642 
643 static inline bool v4l2_is_colorspace_valid(__u32 colorspace)
644 {
645 	return colorspace > V4L2_COLORSPACE_DEFAULT &&
646 	       colorspace < V4L2_COLORSPACE_LAST;
647 }
648 
649 static inline bool v4l2_is_xfer_func_valid(__u32 xfer_func)
650 {
651 	return xfer_func > V4L2_XFER_FUNC_DEFAULT &&
652 	       xfer_func < V4L2_XFER_FUNC_LAST;
653 }
654 
655 static inline bool v4l2_is_ycbcr_enc_valid(__u8 ycbcr_enc)
656 {
657 	return ycbcr_enc > V4L2_YCBCR_ENC_DEFAULT &&
658 	       ycbcr_enc < V4L2_YCBCR_ENC_LAST;
659 }
660 
661 static inline bool v4l2_is_hsv_enc_valid(__u8 hsv_enc)
662 {
663 	return hsv_enc == V4L2_HSV_ENC_180 || hsv_enc == V4L2_HSV_ENC_256;
664 }
665 
666 static inline bool v4l2_is_quant_valid(__u8 quantization)
667 {
668 	return quantization == V4L2_QUANTIZATION_FULL_RANGE ||
669 	       quantization == V4L2_QUANTIZATION_LIM_RANGE;
670 }
671 
672 #endif /* V4L2_COMMON_H_ */
673