Loading...
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
95int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl,
96 s32 min, s32 max, s32 step, s32 def);
97
98/* ------------------------------------------------------------------------- */
99
100struct v4l2_device;
101struct v4l2_subdev;
102struct 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 */
130enum 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 */
152struct 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 */
169struct 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's name will be used
179 * @postfix: sub-device specific string to put right after the I²C device name;
180 * may be NULL
181 */
182void v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client,
183 const char *devname, const char *postfix);
184
185/**
186 * v4l2_i2c_subdev_init - Initializes a &struct v4l2_subdev with data from
187 * an i2c_client struct.
188 *
189 * @sd: pointer to &struct v4l2_subdev
190 * @client: pointer to struct i2c_client
191 * @ops: pointer to &struct v4l2_subdev_ops
192 */
193void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
194 const struct v4l2_subdev_ops *ops);
195
196/**
197 * v4l2_i2c_subdev_addr - returns i2c client address of &struct v4l2_subdev.
198 *
199 * @sd: pointer to &struct v4l2_subdev
200 *
201 * Returns the address of an I2C sub-device
202 */
203unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
204
205/**
206 * v4l2_i2c_tuner_addrs - Return a list of I2C tuner addresses to probe.
207 *
208 * @type: type of the tuner to seek, as defined by
209 * &enum v4l2_i2c_tuner_type.
210 *
211 * NOTE: Use only if the tuner addresses are unknown.
212 */
213const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
214
215/**
216 * v4l2_i2c_subdev_unregister - Unregister a v4l2_subdev
217 *
218 * @sd: pointer to &struct v4l2_subdev
219 */
220void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd);
221
222#else
223
224static inline struct v4l2_subdev *
225v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev,
226 struct i2c_adapter *adapter, const char *client_type,
227 u8 addr, const unsigned short *probe_addrs)
228{
229 return NULL;
230}
231
232static inline struct v4l2_subdev *
233v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev,
234 struct i2c_adapter *adapter, struct i2c_board_info *info,
235 const unsigned short *probe_addrs)
236{
237 return NULL;
238}
239
240static inline void
241v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client,
242 const char *devname, const char *postfix)
243{}
244
245static inline void
246v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
247 const struct v4l2_subdev_ops *ops)
248{}
249
250static inline unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd)
251{
252 return I2C_CLIENT_END;
253}
254
255static inline const unsigned short *
256v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type)
257{
258 return NULL;
259}
260
261static inline void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd)
262{}
263
264#endif
265
266/* ------------------------------------------------------------------------- */
267
268/* SPI Helper functions */
269
270#include <linux/spi/spi.h>
271
272#if defined(CONFIG_SPI)
273
274/**
275 * v4l2_spi_new_subdev - Load an spi module and return an initialized
276 * &struct v4l2_subdev.
277 *
278 *
279 * @v4l2_dev: pointer to &struct v4l2_device.
280 * @master: pointer to struct spi_master.
281 * @info: pointer to struct spi_board_info.
282 *
283 * returns a &struct v4l2_subdev pointer.
284 */
285struct v4l2_subdev *v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
286 struct spi_master *master, struct spi_board_info *info);
287
288/**
289 * v4l2_spi_subdev_init - Initialize a v4l2_subdev with data from an
290 * spi_device struct.
291 *
292 * @sd: pointer to &struct v4l2_subdev
293 * @spi: pointer to struct spi_device.
294 * @ops: pointer to &struct v4l2_subdev_ops
295 */
296void v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
297 const struct v4l2_subdev_ops *ops);
298
299/**
300 * v4l2_spi_subdev_unregister - Unregister a v4l2_subdev
301 *
302 * @sd: pointer to &struct v4l2_subdev
303 */
304void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd);
305
306#else
307
308static inline struct v4l2_subdev *
309v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
310 struct spi_master *master, struct spi_board_info *info)
311{
312 return NULL;
313}
314
315static inline void
316v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
317 const struct v4l2_subdev_ops *ops)
318{}
319
320static inline void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd)
321{}
322#endif
323
324/* ------------------------------------------------------------------------- */
325
326/*
327 * FIXME: these remaining ioctls/structs should be removed as well, but they
328 * are still used in tuner-simple.c (TUNER_SET_CONFIG) and cx18/ivtv (RESET).
329 * To remove these ioctls some more cleanup is needed in those modules.
330 *
331 * It doesn't make much sense on documenting them, as what we really want is
332 * to get rid of them.
333 */
334
335/* s_config */
336struct v4l2_priv_tun_config {
337 int tuner;
338 void *priv;
339};
340#define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
341
342#define VIDIOC_INT_RESET _IOW ('d', 102, u32)
343
344/* ------------------------------------------------------------------------- */
345
346/* Miscellaneous helper functions */
347
348/**
349 * v4l_bound_align_image - adjust video dimensions according to
350 * a given constraints.
351 *
352 * @width: pointer to width that will be adjusted if needed.
353 * @wmin: minimum width.
354 * @wmax: maximum width.
355 * @walign: least significant bit on width.
356 * @height: pointer to height that will be adjusted if needed.
357 * @hmin: minimum height.
358 * @hmax: maximum height.
359 * @halign: least significant bit on height.
360 * @salign: least significant bit for the image size (e. g.
361 * :math:`width * height`).
362 *
363 * Clip an image to have @width between @wmin and @wmax, and @height between
364 * @hmin and @hmax, inclusive.
365 *
366 * Additionally, the @width will be a multiple of :math:`2^{walign}`,
367 * the @height will be a multiple of :math:`2^{halign}`, and the overall
368 * size :math:`width * height` will be a multiple of :math:`2^{salign}`.
369 *
370 * .. note::
371 *
372 * #. The clipping rectangle may be shrunk or enlarged to fit the alignment
373 * constraints.
374 * #. @wmax must not be smaller than @wmin.
375 * #. @hmax must not be smaller than @hmin.
376 * #. The alignments must not be so high there are no possible image
377 * sizes within the allowed bounds.
378 * #. @wmin and @hmin must be at least 1 (don't use 0).
379 * #. For @walign, @halign and @salign, if you don't care about a certain
380 * alignment, specify ``0``, as :math:`2^0 = 1` and one byte alignment
381 * is equivalent to no alignment.
382 * #. If you only want to adjust downward, specify a maximum that's the
383 * same as the initial value.
384 */
385void v4l_bound_align_image(unsigned int *width, unsigned int wmin,
386 unsigned int wmax, unsigned int walign,
387 unsigned int *height, unsigned int hmin,
388 unsigned int hmax, unsigned int halign,
389 unsigned int salign);
390
391/**
392 * v4l2_find_nearest_size - Find the nearest size among a discrete
393 * set of resolutions contained in an array of a driver specific struct.
394 *
395 * @array: a driver specific array of image sizes
396 * @array_size: the length of the driver specific array of image sizes
397 * @width_field: the name of the width field in the driver specific struct
398 * @height_field: the name of the height field in the driver specific struct
399 * @width: desired width.
400 * @height: desired height.
401 *
402 * Finds the closest resolution to minimize the width and height differences
403 * between what requested and the supported resolutions. The size of the width
404 * and height fields in the driver specific must equal to that of u32, i.e. four
405 * bytes.
406 *
407 * Returns the best match or NULL if the length of the array is zero.
408 */
409#define v4l2_find_nearest_size(array, array_size, width_field, height_field, \
410 width, height) \
411 ({ \
412 BUILD_BUG_ON(sizeof((array)->width_field) != sizeof(u32) || \
413 sizeof((array)->height_field) != sizeof(u32)); \
414 (typeof(&(array)[0]))__v4l2_find_nearest_size( \
415 (array), array_size, sizeof(*(array)), \
416 offsetof(typeof(*(array)), width_field), \
417 offsetof(typeof(*(array)), height_field), \
418 width, height); \
419 })
420const void *
421__v4l2_find_nearest_size(const void *array, size_t array_size,
422 size_t entry_size, size_t width_offset,
423 size_t height_offset, s32 width, s32 height);
424
425/**
426 * v4l2_g_parm_cap - helper routine for vidioc_g_parm to fill this in by
427 * calling the g_frame_interval op of the given subdev. It only works
428 * for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the
429 * function name.
430 *
431 * @vdev: the struct video_device pointer. Used to determine the device caps.
432 * @sd: the sub-device pointer.
433 * @a: the VIDIOC_G_PARM argument.
434 */
435int v4l2_g_parm_cap(struct video_device *vdev,
436 struct v4l2_subdev *sd, struct v4l2_streamparm *a);
437
438/**
439 * v4l2_s_parm_cap - helper routine for vidioc_s_parm to fill this in by
440 * calling the s_frame_interval op of the given subdev. It only works
441 * for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the
442 * function name.
443 *
444 * @vdev: the struct video_device pointer. Used to determine the device caps.
445 * @sd: the sub-device pointer.
446 * @a: the VIDIOC_S_PARM argument.
447 */
448int v4l2_s_parm_cap(struct video_device *vdev,
449 struct v4l2_subdev *sd, struct v4l2_streamparm *a);
450
451/* Compare two v4l2_fract structs */
452#define V4L2_FRACT_COMPARE(a, OP, b) \
453 ((u64)(a).numerator * (b).denominator OP \
454 (u64)(b).numerator * (a).denominator)
455
456/* ------------------------------------------------------------------------- */
457
458/* Pixel format and FourCC helpers */
459
460/**
461 * enum v4l2_pixel_encoding - specifies the pixel encoding value
462 *
463 * @V4L2_PIXEL_ENC_UNKNOWN: Pixel encoding is unknown/un-initialized
464 * @V4L2_PIXEL_ENC_YUV: Pixel encoding is YUV
465 * @V4L2_PIXEL_ENC_RGB: Pixel encoding is RGB
466 * @V4L2_PIXEL_ENC_BAYER: Pixel encoding is Bayer
467 */
468enum v4l2_pixel_encoding {
469 V4L2_PIXEL_ENC_UNKNOWN = 0,
470 V4L2_PIXEL_ENC_YUV = 1,
471 V4L2_PIXEL_ENC_RGB = 2,
472 V4L2_PIXEL_ENC_BAYER = 3,
473};
474
475/**
476 * struct v4l2_format_info - information about a V4L2 format
477 * @format: 4CC format identifier (V4L2_PIX_FMT_*)
478 * @pixel_enc: Pixel encoding (see enum v4l2_pixel_encoding above)
479 * @mem_planes: Number of memory planes, which includes the alpha plane (1 to 4).
480 * @comp_planes: Number of component planes, which includes the alpha plane (1 to 4).
481 * @bpp: Array of per-plane bytes per pixel
482 * @hdiv: Horizontal chroma subsampling factor
483 * @vdiv: Vertical chroma subsampling factor
484 * @block_w: Per-plane macroblock pixel width (optional)
485 * @block_h: Per-plane macroblock pixel height (optional)
486 */
487struct v4l2_format_info {
488 u32 format;
489 u8 pixel_enc;
490 u8 mem_planes;
491 u8 comp_planes;
492 u8 bpp[4];
493 u8 hdiv;
494 u8 vdiv;
495 u8 block_w[4];
496 u8 block_h[4];
497};
498
499static inline bool v4l2_is_format_rgb(const struct v4l2_format_info *f)
500{
501 return f && f->pixel_enc == V4L2_PIXEL_ENC_RGB;
502}
503
504static inline bool v4l2_is_format_yuv(const struct v4l2_format_info *f)
505{
506 return f && f->pixel_enc == V4L2_PIXEL_ENC_YUV;
507}
508
509static inline bool v4l2_is_format_bayer(const struct v4l2_format_info *f)
510{
511 return f && f->pixel_enc == V4L2_PIXEL_ENC_BAYER;
512}
513
514const struct v4l2_format_info *v4l2_format_info(u32 format);
515void v4l2_apply_frmsize_constraints(u32 *width, u32 *height,
516 const struct v4l2_frmsize_stepwise *frmsize);
517int v4l2_fill_pixfmt(struct v4l2_pix_format *pixfmt, u32 pixelformat,
518 u32 width, u32 height);
519int v4l2_fill_pixfmt_mp(struct v4l2_pix_format_mplane *pixfmt, u32 pixelformat,
520 u32 width, u32 height);
521
522static inline u64 v4l2_buffer_get_timestamp(const struct v4l2_buffer *buf)
523{
524 /*
525 * When the timestamp comes from 32-bit user space, there may be
526 * uninitialized data in tv_usec, so cast it to u32.
527 * Otherwise allow invalid input for backwards compatibility.
528 */
529 return buf->timestamp.tv_sec * NSEC_PER_SEC +
530 (u32)buf->timestamp.tv_usec * NSEC_PER_USEC;
531}
532
533static inline void v4l2_buffer_set_timestamp(struct v4l2_buffer *buf,
534 u64 timestamp)
535{
536 struct timespec64 ts = ns_to_timespec64(timestamp);
537
538 buf->timestamp.tv_sec = ts.tv_sec;
539 buf->timestamp.tv_usec = ts.tv_nsec / NSEC_PER_USEC;
540}
541
542#endif /* V4L2_COMMON_H_ */
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
95int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl,
96 s32 min, s32 max, s32 step, s32 def);
97
98/* ------------------------------------------------------------------------- */
99
100struct v4l2_device;
101struct v4l2_subdev;
102struct 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 */
130enum 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 */
152struct 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 */
169struct 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 */
183void 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 */
194void 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 */
204unsigned 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 */
214const 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 */
221void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd);
222
223#else
224
225static inline struct v4l2_subdev *
226v4l2_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
233static inline struct v4l2_subdev *
234v4l2_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
241static inline void
242v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client,
243 const char *devname, const char *postfix)
244{}
245
246static inline void
247v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
248 const struct v4l2_subdev_ops *ops)
249{}
250
251static inline unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd)
252{
253 return I2C_CLIENT_END;
254}
255
256static inline const unsigned short *
257v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type)
258{
259 return NULL;
260}
261
262static 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 */
286struct 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 */
297void 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 */
305void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd);
306
307#else
308
309static inline struct v4l2_subdev *
310v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
311 struct spi_controller *ctlr, struct spi_board_info *info)
312{
313 return NULL;
314}
315
316static inline void
317v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
318 const struct v4l2_subdev_ops *ops)
319{}
320
321static 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 */
337struct 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 */
386void 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 - Find the nearest size among a discrete
394 * set of resolutions contained in an array of a driver specific struct.
395 *
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.
402 *
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
406 * bytes.
407 *
408 * Returns the best match or NULL if the length of the array is zero.
409 */
410#define v4l2_find_nearest_size(array, array_size, width_field, height_field, \
411 width, height) \
412 ({ \
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), \
419 width, height); \
420 })
421const void *
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);
425
426/**
427 * v4l2_g_parm_cap - helper routine for vidioc_g_parm to fill this in by
428 * calling the get_frame_interval op of the given subdev. It only works
429 * for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the
430 * function name.
431 *
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.
435 */
436int v4l2_g_parm_cap(struct video_device *vdev,
437 struct v4l2_subdev *sd, struct v4l2_streamparm *a);
438
439/**
440 * v4l2_s_parm_cap - helper routine for vidioc_s_parm to fill this in by
441 * calling the set_frame_interval op of the given subdev. It only works
442 * for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the
443 * function name.
444 *
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.
448 */
449int v4l2_s_parm_cap(struct video_device *vdev,
450 struct v4l2_subdev *sd, struct v4l2_streamparm *a);
451
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)
456
457/* ------------------------------------------------------------------------- */
458
459/* Pixel format and FourCC helpers */
460
461/**
462 * enum v4l2_pixel_encoding - specifies the pixel encoding value
463 *
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
468 */
469enum 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,
474};
475
476/**
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)
488 */
489struct v4l2_format_info {
490 u32 format;
491 u8 pixel_enc;
492 u8 mem_planes;
493 u8 comp_planes;
494 u8 bpp[4];
495 u8 bpp_div[4];
496 u8 hdiv;
497 u8 vdiv;
498 u8 block_w[4];
499 u8 block_h[4];
500};
501
502static inline bool v4l2_is_format_rgb(const struct v4l2_format_info *f)
503{
504 return f && f->pixel_enc == V4L2_PIXEL_ENC_RGB;
505}
506
507static inline bool v4l2_is_format_yuv(const struct v4l2_format_info *f)
508{
509 return f && f->pixel_enc == V4L2_PIXEL_ENC_YUV;
510}
511
512static inline bool v4l2_is_format_bayer(const struct v4l2_format_info *f)
513{
514 return f && f->pixel_enc == V4L2_PIXEL_ENC_BAYER;
515}
516
517const struct v4l2_format_info *v4l2_format_info(u32 format);
518void v4l2_apply_frmsize_constraints(u32 *width, u32 *height,
519 const struct v4l2_frmsize_stepwise *frmsize);
520int v4l2_fill_pixfmt(struct v4l2_pix_format *pixfmt, u32 pixelformat,
521 u32 width, u32 height);
522int v4l2_fill_pixfmt_mp(struct v4l2_pix_format_mplane *pixfmt, u32 pixelformat,
523 u32 width, u32 height);
524
525/**
526 * v4l2_get_link_freq - Get link rate from transmitter
527 *
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.
533 *
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.
538 *
539 * Return:
540 * * >0: Link frequency
541 * * %-ENOENT: Link frequency or pixel rate control not found
542 * * %-EINVAL: Invalid link frequency value
543 */
544s64 v4l2_get_link_freq(struct v4l2_ctrl_handler *handler, unsigned int mul,
545 unsigned int div);
546
547void v4l2_simplify_fraction(u32 *numerator, u32 *denominator,
548 unsigned int n_terms, unsigned int threshold);
549u32 v4l2_fraction_to_interval(u32 numerator, u32 denominator);
550
551/**
552 * v4l2_link_freq_to_bitmap - Figure out platform-supported link frequencies
553 * @dev: The struct device
554 * @fw_link_freqs: Array of link frequencies from firmware
555 * @num_of_fw_link_freqs: Number of entries in @fw_link_freqs
556 * @driver_link_freqs: Array of link frequencies supported by the driver
557 * @num_of_driver_link_freqs: Number of entries in @driver_link_freqs
558 * @bitmap: Bitmap of driver-supported link frequencies found in @fw_link_freqs
559 *
560 * This function checks which driver-supported link frequencies are enabled in
561 * system firmware and sets the corresponding bits in @bitmap (after first
562 * zeroing it).
563 *
564 * Return:
565 * * %0: Success
566 * * %-ENOENT: No match found between driver-supported link frequencies and
567 * those available in firmware.
568 * * %-ENODATA: No link frequencies were specified in firmware.
569 */
570int v4l2_link_freq_to_bitmap(struct device *dev, const u64 *fw_link_freqs,
571 unsigned int num_of_fw_link_freqs,
572 const s64 *driver_link_freqs,
573 unsigned int num_of_driver_link_freqs,
574 unsigned long *bitmap);
575
576static inline u64 v4l2_buffer_get_timestamp(const struct v4l2_buffer *buf)
577{
578 /*
579 * When the timestamp comes from 32-bit user space, there may be
580 * uninitialized data in tv_usec, so cast it to u32.
581 * Otherwise allow invalid input for backwards compatibility.
582 */
583 return buf->timestamp.tv_sec * NSEC_PER_SEC +
584 (u32)buf->timestamp.tv_usec * NSEC_PER_USEC;
585}
586
587static inline void v4l2_buffer_set_timestamp(struct v4l2_buffer *buf,
588 u64 timestamp)
589{
590 struct timespec64 ts = ns_to_timespec64(timestamp);
591
592 buf->timestamp.tv_sec = ts.tv_sec;
593 buf->timestamp.tv_usec = ts.tv_nsec / NSEC_PER_USEC;
594}
595
596static inline bool v4l2_is_colorspace_valid(__u32 colorspace)
597{
598 return colorspace > V4L2_COLORSPACE_DEFAULT &&
599 colorspace < V4L2_COLORSPACE_LAST;
600}
601
602static inline bool v4l2_is_xfer_func_valid(__u32 xfer_func)
603{
604 return xfer_func > V4L2_XFER_FUNC_DEFAULT &&
605 xfer_func < V4L2_XFER_FUNC_LAST;
606}
607
608static inline bool v4l2_is_ycbcr_enc_valid(__u8 ycbcr_enc)
609{
610 return ycbcr_enc > V4L2_YCBCR_ENC_DEFAULT &&
611 ycbcr_enc < V4L2_YCBCR_ENC_LAST;
612}
613
614static inline bool v4l2_is_hsv_enc_valid(__u8 hsv_enc)
615{
616 return hsv_enc == V4L2_HSV_ENC_180 || hsv_enc == V4L2_HSV_ENC_256;
617}
618
619static inline bool v4l2_is_quant_valid(__u8 quantization)
620{
621 return quantization == V4L2_QUANTIZATION_FULL_RANGE ||
622 quantization == V4L2_QUANTIZATION_LIM_RANGE;
623}
624
625#endif /* V4L2_COMMON_H_ */