1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 v4l2 common internal API header
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
10 Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
14 #ifndef V4L2_COMMON_H_
15 #define V4L2_COMMON_H_
17 #include <linux/time.h>
18 #include <media/v4l2-dev.h>
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
23 #define v4l_printk(level, name, adapter, addr, fmt, arg...) \
24 printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)
26 #define v4l_client_printk(level, client, fmt, arg...) \
27 v4l_printk(level, (client)->dev.driver->name, (client)->adapter, \
28 (client)->addr, fmt , ## arg)
30 #define v4l_err(client, fmt, arg...) \
31 v4l_client_printk(KERN_ERR, client, fmt , ## arg)
33 #define v4l_warn(client, fmt, arg...) \
34 v4l_client_printk(KERN_WARNING, client, fmt , ## arg)
36 #define v4l_info(client, fmt, arg...) \
37 v4l_client_printk(KERN_INFO, client, fmt , ## arg)
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...) \
43 if (debug >= (level)) \
44 v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
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...) \
50 if (__debug >= (__level)) \
51 dev_printk(KERN_DEBUG, __dev, __fmt, ##__arg); \
54 /* ------------------------------------------------------------------------- */
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)
60 #define v4l2_err(dev, fmt, arg...) \
61 v4l2_printk(KERN_ERR, dev, fmt , ## arg)
63 #define v4l2_warn(dev, fmt, arg...) \
64 v4l2_printk(KERN_WARNING, dev, fmt , ## arg)
66 #define v4l2_info(dev, fmt, arg...) \
67 v4l2_printk(KERN_INFO, dev, fmt , ## arg)
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...) \
73 if (debug >= (level)) \
74 v4l2_printk(KERN_DEBUG, dev, fmt , ## arg); \
78 * v4l2_ctrl_query_fill- Fill in a struct v4l2_queryctrl
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
84 * @def: default value for the control
86 * Fills the &struct v4l2_queryctrl fields for the query control.
90 * This function assumes that the @qctrl->id field is filled.
92 * Returns -EINVAL if the control is not known by the V4L2 core, 0 on success.
95 int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl,
96 s32 min, s32 max, s32 step, s32 def);
98 /* ------------------------------------------------------------------------- */
102 struct v4l2_subdev_ops;
104 /* I2C Helper functions */
105 #include <linux/i2c.h>
108 * enum v4l2_i2c_tuner_type - specifies the range of tuner address that
109 * should be used when seeking for I2C devices.
111 * @ADDRS_RADIO: Radio tuner addresses.
112 * Represent the following I2C addresses:
113 * 0x10 (if compiled with tea5761 support)
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,
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.
128 * NOTE: All I2C addresses above use the 7-bit notation.
130 enum v4l2_i2c_tuner_type {
137 #if defined(CONFIG_VIDEO_V4L2_I2C)
140 * v4l2_i2c_new_subdev - Load an i2c module and return an initialized
141 * &struct v4l2_subdev.
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.
150 * returns a &struct v4l2_subdev pointer.
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);
157 * v4l2_i2c_new_subdev_board - Load an i2c module and return an initialized
158 * &struct v4l2_subdev.
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.
167 * returns a &struct v4l2_subdev pointer.
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);
174 * v4l2_i2c_subdev_set_name - Set name for an I²C sub-device
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
180 * @postfix: sub-device specific string to put right after the I²C device name;
183 void v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client,
184 const char *devname, const char *postfix);
187 * v4l2_i2c_subdev_init - Initializes a &struct v4l2_subdev with data from
188 * an i2c_client struct.
190 * @sd: pointer to &struct v4l2_subdev
191 * @client: pointer to struct i2c_client
192 * @ops: pointer to &struct v4l2_subdev_ops
194 void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
195 const struct v4l2_subdev_ops *ops);
198 * v4l2_i2c_subdev_addr - returns i2c client address of &struct v4l2_subdev.
200 * @sd: pointer to &struct v4l2_subdev
202 * Returns the address of an I2C sub-device
204 unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
207 * v4l2_i2c_tuner_addrs - Return a list of I2C tuner addresses to probe.
209 * @type: type of the tuner to seek, as defined by
210 * &enum v4l2_i2c_tuner_type.
212 * NOTE: Use only if the tuner addresses are unknown.
214 const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
217 * v4l2_i2c_subdev_unregister - Unregister a v4l2_subdev
219 * @sd: pointer to &struct v4l2_subdev
221 void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd);
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)
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)
242 v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client,
243 const char *devname, const char *postfix)
247 v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
248 const struct v4l2_subdev_ops *ops)
251 static inline unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd)
253 return I2C_CLIENT_END;
256 static inline const unsigned short *
257 v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type)
262 static inline void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd)
267 /* ------------------------------------------------------------------------- */
269 /* SPI Helper functions */
271 #include <linux/spi/spi.h>
273 #if defined(CONFIG_SPI)
276 * v4l2_spi_new_subdev - Load an spi module and return an initialized
277 * &struct v4l2_subdev.
280 * @v4l2_dev: pointer to &struct v4l2_device.
281 * @master: pointer to struct spi_master.
282 * @info: pointer to struct spi_board_info.
284 * returns a &struct v4l2_subdev pointer.
286 struct v4l2_subdev *v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
287 struct spi_master *master, struct spi_board_info *info);
290 * v4l2_spi_subdev_init - Initialize a v4l2_subdev with data from an
293 * @sd: pointer to &struct v4l2_subdev
294 * @spi: pointer to struct spi_device.
295 * @ops: pointer to &struct v4l2_subdev_ops
297 void v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
298 const struct v4l2_subdev_ops *ops);
301 * v4l2_spi_subdev_unregister - Unregister a v4l2_subdev
303 * @sd: pointer to &struct v4l2_subdev
305 void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd);
309 static inline struct v4l2_subdev *
310 v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
311 struct spi_master *master, struct spi_board_info *info)
317 v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
318 const struct v4l2_subdev_ops *ops)
321 static inline void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd)
325 /* ------------------------------------------------------------------------- */
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.
332 * It doesn't make much sense on documenting them, as what we really want is
333 * to get rid of them.
337 struct v4l2_priv_tun_config {
341 #define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
343 #define VIDIOC_INT_RESET _IOW ('d', 102, u32)
345 /* ------------------------------------------------------------------------- */
347 /* Miscellaneous helper functions */
350 * v4l_bound_align_image - adjust video dimensions according to
351 * a given constraints.
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`).
364 * Clip an image to have @width between @wmin and @wmax, and @height between
365 * @hmin and @hmax, inclusive.
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}`.
373 * #. The clipping rectangle may be shrunk or enlarged to fit the alignment
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.
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);
393 * v4l2_find_nearest_size - Find the nearest size among a discrete
394 * set of resolutions contained in an array of a driver specific struct.
396 * @array: a driver specific array of image sizes
397 * @array_size: the length of the driver specific array of image sizes
398 * @width_field: the name of the width field in the driver specific struct
399 * @height_field: the name of the height field in the driver specific struct
400 * @width: desired width.
401 * @height: desired height.
403 * Finds the closest resolution to minimize the width and height differences
404 * between what requested and the supported resolutions. The size of the width
405 * and height fields in the driver specific must equal to that of u32, i.e. four
408 * Returns the best match or NULL if the length of the array is zero.
410 #define v4l2_find_nearest_size(array, array_size, width_field, height_field, \
413 BUILD_BUG_ON(sizeof((array)->width_field) != sizeof(u32) || \
414 sizeof((array)->height_field) != sizeof(u32)); \
415 (typeof(&(array)[0]))__v4l2_find_nearest_size( \
416 (array), array_size, sizeof(*(array)), \
417 offsetof(typeof(*(array)), width_field), \
418 offsetof(typeof(*(array)), height_field), \
422 __v4l2_find_nearest_size(const void *array, size_t array_size,
423 size_t entry_size, size_t width_offset,
424 size_t height_offset, s32 width, s32 height);
427 * v4l2_g_parm_cap - helper routine for vidioc_g_parm to fill this in by
428 * calling the g_frame_interval op of the given subdev. It only works
429 * for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the
432 * @vdev: the struct video_device pointer. Used to determine the device caps.
433 * @sd: the sub-device pointer.
434 * @a: the VIDIOC_G_PARM argument.
436 int v4l2_g_parm_cap(struct video_device *vdev,
437 struct v4l2_subdev *sd, struct v4l2_streamparm *a);
440 * v4l2_s_parm_cap - helper routine for vidioc_s_parm to fill this in by
441 * calling the s_frame_interval op of the given subdev. It only works
442 * for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the
445 * @vdev: the struct video_device pointer. Used to determine the device caps.
446 * @sd: the sub-device pointer.
447 * @a: the VIDIOC_S_PARM argument.
449 int v4l2_s_parm_cap(struct video_device *vdev,
450 struct v4l2_subdev *sd, struct v4l2_streamparm *a);
452 /* Compare two v4l2_fract structs */
453 #define V4L2_FRACT_COMPARE(a, OP, b) \
454 ((u64)(a).numerator * (b).denominator OP \
455 (u64)(b).numerator * (a).denominator)
457 /* ------------------------------------------------------------------------- */
459 /* Pixel format and FourCC helpers */
462 * enum v4l2_pixel_encoding - specifies the pixel encoding value
464 * @V4L2_PIXEL_ENC_UNKNOWN: Pixel encoding is unknown/un-initialized
465 * @V4L2_PIXEL_ENC_YUV: Pixel encoding is YUV
466 * @V4L2_PIXEL_ENC_RGB: Pixel encoding is RGB
467 * @V4L2_PIXEL_ENC_BAYER: Pixel encoding is Bayer
469 enum v4l2_pixel_encoding {
470 V4L2_PIXEL_ENC_UNKNOWN = 0,
471 V4L2_PIXEL_ENC_YUV = 1,
472 V4L2_PIXEL_ENC_RGB = 2,
473 V4L2_PIXEL_ENC_BAYER = 3,
477 * struct v4l2_format_info - information about a V4L2 format
478 * @format: 4CC format identifier (V4L2_PIX_FMT_*)
479 * @pixel_enc: Pixel encoding (see enum v4l2_pixel_encoding above)
480 * @mem_planes: Number of memory planes, which includes the alpha plane (1 to 4).
481 * @comp_planes: Number of component planes, which includes the alpha plane (1 to 4).
482 * @bpp: Array of per-plane bytes per pixel
483 * @bpp_div: Array of per-plane bytes per pixel divisors to support fractional pixel sizes.
484 * @hdiv: Horizontal chroma subsampling factor
485 * @vdiv: Vertical chroma subsampling factor
486 * @block_w: Per-plane macroblock pixel width (optional)
487 * @block_h: Per-plane macroblock pixel height (optional)
489 struct v4l2_format_info {
502 static inline bool v4l2_is_format_rgb(const struct v4l2_format_info *f)
504 return f && f->pixel_enc == V4L2_PIXEL_ENC_RGB;
507 static inline bool v4l2_is_format_yuv(const struct v4l2_format_info *f)
509 return f && f->pixel_enc == V4L2_PIXEL_ENC_YUV;
512 static inline bool v4l2_is_format_bayer(const struct v4l2_format_info *f)
514 return f && f->pixel_enc == V4L2_PIXEL_ENC_BAYER;
517 const struct v4l2_format_info *v4l2_format_info(u32 format);
518 void v4l2_apply_frmsize_constraints(u32 *width, u32 *height,
519 const struct v4l2_frmsize_stepwise *frmsize);
520 int v4l2_fill_pixfmt(struct v4l2_pix_format *pixfmt, u32 pixelformat,
521 u32 width, u32 height);
522 int v4l2_fill_pixfmt_mp(struct v4l2_pix_format_mplane *pixfmt, u32 pixelformat,
523 u32 width, u32 height);
526 * v4l2_get_link_freq - Get link rate from transmitter
528 * @handler: The transmitter's control handler
529 * @mul: The multiplier between pixel rate and link frequency. Bits per pixel on
530 * D-PHY, samples per clock on parallel. 0 otherwise.
531 * @div: The divisor between pixel rate and link frequency. Number of data lanes
532 * times two on D-PHY, 1 on parallel. 0 otherwise.
534 * This function is intended for obtaining the link frequency from the
535 * transmitter sub-devices. It returns the link rate, either from the
536 * V4L2_CID_LINK_FREQ control implemented by the transmitter, or value
537 * calculated based on the V4L2_CID_PIXEL_RATE implemented by the transmitter.
539 * Returns link frequency on success, otherwise a negative error code:
540 * -ENOENT: Link frequency or pixel rate control not found
541 * -EINVAL: Invalid link frequency value
543 s64 v4l2_get_link_freq(struct v4l2_ctrl_handler *handler, unsigned int mul,
546 void v4l2_simplify_fraction(u32 *numerator, u32 *denominator,
547 unsigned int n_terms, unsigned int threshold);
548 u32 v4l2_fraction_to_interval(u32 numerator, u32 denominator);
550 static inline u64 v4l2_buffer_get_timestamp(const struct v4l2_buffer *buf)
553 * When the timestamp comes from 32-bit user space, there may be
554 * uninitialized data in tv_usec, so cast it to u32.
555 * Otherwise allow invalid input for backwards compatibility.
557 return buf->timestamp.tv_sec * NSEC_PER_SEC +
558 (u32)buf->timestamp.tv_usec * NSEC_PER_USEC;
561 static inline void v4l2_buffer_set_timestamp(struct v4l2_buffer *buf,
564 struct timespec64 ts = ns_to_timespec64(timestamp);
566 buf->timestamp.tv_sec = ts.tv_sec;
567 buf->timestamp.tv_usec = ts.tv_nsec / NSEC_PER_USEC;
570 static inline bool v4l2_is_colorspace_valid(__u32 colorspace)
572 return colorspace > V4L2_COLORSPACE_DEFAULT &&
573 colorspace < V4L2_COLORSPACE_LAST;
576 static inline bool v4l2_is_xfer_func_valid(__u32 xfer_func)
578 return xfer_func > V4L2_XFER_FUNC_DEFAULT &&
579 xfer_func < V4L2_XFER_FUNC_LAST;
582 static inline bool v4l2_is_ycbcr_enc_valid(__u8 ycbcr_enc)
584 return ycbcr_enc > V4L2_YCBCR_ENC_DEFAULT &&
585 ycbcr_enc < V4L2_YCBCR_ENC_LAST;
588 static inline bool v4l2_is_hsv_enc_valid(__u8 hsv_enc)
590 return hsv_enc == V4L2_HSV_ENC_180 || hsv_enc == V4L2_HSV_ENC_256;
593 static inline bool v4l2_is_quant_valid(__u8 quantization)
595 return quantization == V4L2_QUANTIZATION_FULL_RANGE ||
596 quantization == V4L2_QUANTIZATION_LIM_RANGE;
599 #endif /* V4L2_COMMON_H_ */