]>
Commit | Line | Data |
---|---|---|
1a59d1b8 | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
b2f0648f HV |
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 | ||
b2f0648f HV |
12 | */ |
13 | ||
14 | #ifndef V4L2_COMMON_H_ | |
15 | #define V4L2_COMMON_H_ | |
16 | ||
77cdffcb | 17 | #include <linux/time.h> |
401998fa MCC |
18 | #include <media/v4l2-dev.h> |
19 | ||
76a59fe7 | 20 | /* Common printk constructs for v4l-i2c drivers. These macros create a unique |
7e8b09ea HV |
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 | ||
cab462f7 | 26 | #define v4l_client_printk(level, client, fmt, arg...) \ |
f9d32f25 | 27 | v4l_printk(level, (client)->dev.driver->name, (client)->adapter, \ |
7e8b09ea HV |
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'. */ | |
f167cb4e | 41 | #define v4l_dbg(level, debug, client, fmt, arg...) \ |
6e6a8b5a | 42 | do { \ |
7e8b09ea HV |
43 | if (debug >= (level)) \ |
44 | v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \ | |
45 | } while (0) | |
46 | ||
a41231d5 MCC |
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 | ||
7e8b09ea HV |
54 | /* ------------------------------------------------------------------------- */ |
55 | ||
dd99120c HV |
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...) \ | |
6e6a8b5a | 72 | do { \ |
dd99120c | 73 | if (debug >= (level)) \ |
6e6a8b5a | 74 | v4l2_printk(KERN_DEBUG, dev, fmt , ## arg); \ |
dd99120c HV |
75 | } while (0) |
76 | ||
b8719158 MCC |
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 | */ | |
dd99120c | 94 | |
b8719158 MCC |
95 | int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl, |
96 | s32 min, s32 max, s32 step, s32 def); | |
9cb2318b HV |
97 | |
98 | /* ------------------------------------------------------------------------- */ | |
99 | ||
dd99120c HV |
100 | struct v4l2_device; |
101 | struct v4l2_subdev; | |
102 | struct v4l2_subdev_ops; | |
8ffbc655 | 103 | |
02283b98 EG |
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 | ||
a39c57f8 MCC |
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 | |
4a3fad70 | 148 | * array should be %I2C_CLIENT_END. |
a39c57f8 MCC |
149 | * |
150 | * returns a &struct v4l2_subdev pointer. | |
151 | */ | |
3c7c9370 | 152 | struct v4l2_subdev *v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev, |
9a1f8b34 | 153 | struct i2c_adapter *adapter, const char *client_type, |
53dacb15 | 154 | u8 addr, const unsigned short *probe_addrs); |
f0222c7d | 155 | |
a39c57f8 MCC |
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 | |
4a3fad70 | 165 | * array should be %I2C_CLIENT_END. |
a39c57f8 MCC |
166 | * |
167 | * returns a &struct v4l2_subdev pointer. | |
168 | */ | |
f0222c7d | 169 | struct v4l2_subdev *v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev, |
9a1f8b34 LP |
170 | struct i2c_adapter *adapter, struct i2c_board_info *info, |
171 | const unsigned short *probe_addrs); | |
f0222c7d | 172 | |
06582930 SA |
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 | */ | |
182 | void v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client, | |
183 | const char *devname, const char *postfix); | |
184 | ||
a39c57f8 MCC |
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 | */ | |
dd99120c HV |
193 | void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client, |
194 | const struct v4l2_subdev_ops *ops); | |
a39c57f8 MCC |
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 | */ | |
ab373190 | 203 | unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd); |
dd99120c | 204 | |
76a59fe7 MCC |
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 | */ | |
c7d29e2f HV |
213 | const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type); |
214 | ||
51ff392c EG |
215 | /** |
216 | * v4l2_i2c_subdev_unregister - Unregister a v4l2_subdev | |
217 | * | |
218 | * @sd: pointer to &struct v4l2_subdev | |
219 | */ | |
220 | void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd); | |
221 | ||
02283b98 EG |
222 | #else |
223 | ||
224 | static inline struct v4l2_subdev * | |
225 | v4l2_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 | ||
232 | static inline struct v4l2_subdev * | |
233 | v4l2_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 | ||
240 | static inline void | |
241 | v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client, | |
242 | const char *devname, const char *postfix) | |
243 | {} | |
244 | ||
245 | static inline void | |
246 | v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client, | |
247 | const struct v4l2_subdev_ops *ops) | |
248 | {} | |
249 | ||
250 | static inline unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd) | |
251 | { | |
252 | return I2C_CLIENT_END; | |
253 | } | |
254 | ||
255 | static inline const unsigned short * | |
256 | v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type) | |
257 | { | |
258 | return NULL; | |
259 | } | |
260 | ||
51ff392c EG |
261 | static inline void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd) |
262 | {} | |
263 | ||
02283b98 EG |
264 | #endif |
265 | ||
8ffbc655 | 266 | /* ------------------------------------------------------------------------- */ |
85e09219 DB |
267 | |
268 | /* SPI Helper functions */ | |
85e09219 DB |
269 | |
270 | #include <linux/spi/spi.h> | |
271 | ||
7c795df5 | 272 | #if defined(CONFIG_SPI) |
85e09219 | 273 | |
b8719158 MCC |
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 | */ | |
85e09219 DB |
285 | struct v4l2_subdev *v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev, |
286 | struct spi_master *master, struct spi_board_info *info); | |
287 | ||
b8719158 MCC |
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 | */ | |
85e09219 DB |
296 | void v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi, |
297 | const struct v4l2_subdev_ops *ops); | |
7c795df5 | 298 | |
a9cff393 EG |
299 | /** |
300 | * v4l2_spi_subdev_unregister - Unregister a v4l2_subdev | |
301 | * | |
302 | * @sd: pointer to &struct v4l2_subdev | |
303 | */ | |
304 | void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd); | |
305 | ||
7c795df5 EG |
306 | #else |
307 | ||
308 | static inline struct v4l2_subdev * | |
309 | v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev, | |
310 | struct spi_master *master, struct spi_board_info *info) | |
311 | { | |
312 | return NULL; | |
313 | } | |
314 | ||
315 | static inline void | |
316 | v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi, | |
317 | const struct v4l2_subdev_ops *ops) | |
318 | {} | |
319 | ||
a9cff393 EG |
320 | static inline void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd) |
321 | {} | |
85e09219 DB |
322 | #endif |
323 | ||
324 | /* ------------------------------------------------------------------------- */ | |
8ffbc655 | 325 | |
01154ef5 MCC |
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. | |
76a59fe7 MCC |
330 | * |
331 | * It doesn't make much sense on documenting them, as what we really want is | |
332 | * to get rid of them. | |
01154ef5 | 333 | */ |
b2f0648f | 334 | |
78a3b4db | 335 | /* s_config */ |
7f171123 MCC |
336 | struct v4l2_priv_tun_config { |
337 | int tuner; | |
338 | void *priv; | |
339 | }; | |
7f171123 | 340 | #define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config) |
757d2505 | 341 | |
6e6a8b5a | 342 | #define VIDIOC_INT_RESET _IOW ('d', 102, u32) |
6c31e598 | 343 | |
b0d3159b TP |
344 | /* ------------------------------------------------------------------------- */ |
345 | ||
346 | /* Miscellaneous helper functions */ | |
347 | ||
76a59fe7 MCC |
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. | |
ae5a8ca8 | 359 | * @halign: least significant bit on height. |
76a59fe7 MCC |
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 | */ | |
385 | void v4l_bound_align_image(unsigned int *width, unsigned int wmin, | |
b0d3159b | 386 | unsigned int wmax, unsigned int walign, |
76a59fe7 | 387 | unsigned int *height, unsigned int hmin, |
b0d3159b TP |
388 | unsigned int hmax, unsigned int halign, |
389 | unsigned int salign); | |
3fd8e647 | 390 | |
95ce9c28 SA |
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 | |
d2dc57b1 | 396 | * @array_size: the length of the driver specific array of image sizes |
95ce9c28 SA |
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 | */ | |
d2dc57b1 | 409 | #define v4l2_find_nearest_size(array, array_size, width_field, height_field, \ |
95ce9c28 SA |
410 | width, height) \ |
411 | ({ \ | |
412 | BUILD_BUG_ON(sizeof((array)->width_field) != sizeof(u32) || \ | |
413 | sizeof((array)->height_field) != sizeof(u32)); \ | |
2bbc46e8 | 414 | (typeof(&(array)[0]))__v4l2_find_nearest_size( \ |
d2dc57b1 | 415 | (array), array_size, sizeof(*(array)), \ |
95ce9c28 SA |
416 | offsetof(typeof(*(array)), width_field), \ |
417 | offsetof(typeof(*(array)), height_field), \ | |
418 | width, height); \ | |
419 | }) | |
420 | const 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 | ||
672de9a7 HV |
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 | */ | |
435 | int 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 | */ | |
448 | int v4l2_s_parm_cap(struct video_device *vdev, | |
449 | struct v4l2_subdev *sd, struct v4l2_streamparm *a); | |
450 | ||
85de5e06 AM |
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 | ||
f44b969a EG |
456 | /* ------------------------------------------------------------------------- */ |
457 | ||
458 | /* Pixel format and FourCC helpers */ | |
459 | ||
d5a897c8 BP |
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 | */ | |
468 | enum 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 | ||
f44b969a EG |
475 | /** |
476 | * struct v4l2_format_info - information about a V4L2 format | |
477 | * @format: 4CC format identifier (V4L2_PIX_FMT_*) | |
d5a897c8 | 478 | * @pixel_enc: Pixel encoding (see enum v4l2_pixel_encoding above) |
f44b969a EG |
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 | */ | |
487 | struct v4l2_format_info { | |
488 | u32 format; | |
d5a897c8 | 489 | u8 pixel_enc; |
f44b969a EG |
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 | ||
d5a897c8 BP |
499 | static inline bool v4l2_is_format_rgb(const struct v4l2_format_info *f) |
500 | { | |
501 | return f && f->pixel_enc == V4L2_PIXEL_ENC_RGB; | |
502 | } | |
f44b969a | 503 | |
d5a897c8 BP |
504 | static 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 | ||
509 | static 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 | ||
514 | const struct v4l2_format_info *v4l2_format_info(u32 format); | |
32cddf9c BB |
515 | void v4l2_apply_frmsize_constraints(u32 *width, u32 *height, |
516 | const struct v4l2_frmsize_stepwise *frmsize); | |
ce57a82f BB |
517 | int v4l2_fill_pixfmt(struct v4l2_pix_format *pixfmt, u32 pixelformat, |
518 | u32 width, u32 height); | |
519 | int v4l2_fill_pixfmt_mp(struct v4l2_pix_format_mplane *pixfmt, u32 pixelformat, | |
520 | u32 width, u32 height); | |
f44b969a | 521 | |
1b888b3c SA |
522 | /** |
523 | * v4l2_get_link_rate - Get link rate from transmitter | |
524 | * | |
525 | * @handler: The transmitter's control handler | |
526 | * @mul: The multiplier between pixel rate and link frequency. Bits per pixel on | |
527 | * D-PHY, samples per clock on parallel. 0 otherwise. | |
528 | * @div: The divisor between pixel rate and link frequency. Number of data lanes | |
529 | * times two on D-PHY, 1 on parallel. 0 otherwise. | |
530 | * | |
531 | * This function is intended for obtaining the link frequency from the | |
532 | * transmitter sub-devices. It returns the link rate, either from the | |
533 | * V4L2_CID_LINK_FREQ control implemented by the transmitter, or value | |
534 | * calculated based on the V4L2_CID_PIXEL_RATE implemented by the transmitter. | |
535 | * | |
536 | * Returns link frequency on success, otherwise a negative error code: | |
537 | * -ENOENT: Link frequency or pixel rate control not found | |
538 | * -EINVAL: Invalid link frequency value | |
539 | */ | |
540 | s64 v4l2_get_link_rate(struct v4l2_ctrl_handler *handler, unsigned int mul, | |
541 | unsigned int div); | |
542 | ||
77cdffcb AB |
543 | static inline u64 v4l2_buffer_get_timestamp(const struct v4l2_buffer *buf) |
544 | { | |
545 | /* | |
546 | * When the timestamp comes from 32-bit user space, there may be | |
547 | * uninitialized data in tv_usec, so cast it to u32. | |
548 | * Otherwise allow invalid input for backwards compatibility. | |
549 | */ | |
550 | return buf->timestamp.tv_sec * NSEC_PER_SEC + | |
551 | (u32)buf->timestamp.tv_usec * NSEC_PER_USEC; | |
552 | } | |
553 | ||
554 | static inline void v4l2_buffer_set_timestamp(struct v4l2_buffer *buf, | |
555 | u64 timestamp) | |
556 | { | |
557 | struct timespec64 ts = ns_to_timespec64(timestamp); | |
558 | ||
559 | buf->timestamp.tv_sec = ts.tv_sec; | |
560 | buf->timestamp.tv_usec = ts.tv_nsec / NSEC_PER_USEC; | |
561 | } | |
562 | ||
2f491463 DH |
563 | static inline bool v4l2_is_colorspace_valid(__u32 colorspace) |
564 | { | |
565 | return colorspace > V4L2_COLORSPACE_DEFAULT && | |
566 | colorspace <= V4L2_COLORSPACE_DCI_P3; | |
567 | } | |
568 | ||
569 | static inline bool v4l2_is_xfer_func_valid(__u32 xfer_func) | |
570 | { | |
571 | return xfer_func > V4L2_XFER_FUNC_DEFAULT && | |
572 | xfer_func <= V4L2_XFER_FUNC_SMPTE2084; | |
573 | } | |
574 | ||
575 | static inline bool v4l2_is_ycbcr_enc_valid(__u8 ycbcr_enc) | |
576 | { | |
577 | return ycbcr_enc > V4L2_YCBCR_ENC_DEFAULT && | |
578 | ycbcr_enc <= V4L2_YCBCR_ENC_SMPTE240M; | |
579 | } | |
580 | ||
581 | static inline bool v4l2_is_hsv_enc_valid(__u8 hsv_enc) | |
582 | { | |
583 | return hsv_enc == V4L2_HSV_ENC_180 || hsv_enc == V4L2_HSV_ENC_256; | |
584 | } | |
585 | ||
586 | static inline bool v4l2_is_quant_valid(__u8 quantization) | |
587 | { | |
588 | return quantization == V4L2_QUANTIZATION_FULL_RANGE || | |
589 | quantization == V4L2_QUANTIZATION_LIM_RANGE; | |
590 | } | |
591 | ||
b2f0648f | 592 | #endif /* V4L2_COMMON_H_ */ |