/* SPDX-License-Identifier: GPL-2.0-or-later */ /* v4l2 common internal API header
This header contains internal shared ioctl definitions for use by the internal low-level v4l2 drivers. Each ioctl begins with VIDIOC_INT_ to clearly mark that it is an internal define,
Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
/* Common printk constructs for v4l-i2c drivers. These macros create a unique prefix consisting of the driver name, the adapter number and the i2c
address. */ #define v4l_printk(level, name, adapter, addr, fmt, arg...) \
printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)
/* These three macros assume that the debug level is set with a module
parameter called 'debug'. */ #define v4l_dbg(level, debug, client, fmt, arg...) \ do { \ if (debug >= (level)) \
v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
} while (0)
/* Add a version of v4l_dbg to be used on drivers using dev_foo() macros */ #define dev_dbg_lvl(__dev, __level, __debug, __fmt, __arg...) \ do { \ if (__debug >= (__level)) \
dev_printk(KERN_DEBUG, __dev, __fmt, ##__arg); \
} while (0)
/* These printk constructs can be used with v4l2_device and v4l2_subdev */ #define v4l2_printk(level, dev, fmt, arg...) \
printk(level "%s: " fmt, (dev)->name , ## arg)
/* These three macros assume that the debug level is set with a module
parameter called 'debug'. */ #define v4l2_dbg(level, debug, dev, fmt, arg...) \ do { \ if (debug >= (level)) \
v4l2_printk(KERN_DEBUG, dev, fmt , ## arg); \
} while (0)
/** * v4l2_ctrl_query_fill- Fill in a struct v4l2_queryctrl * * @qctrl: pointer to the &struct v4l2_queryctrl to be filled * @min: minimum value for the control * @max: maximum value for the control * @step: control step * @def: default value for the control * * Fills the &struct v4l2_queryctrl fields for the query control. * * .. note:: * * This function assumes that the @qctrl->id field is filled. * * Returns -EINVAL if the control is not known by the V4L2 core, 0 on success.
*/
/** * enum v4l2_i2c_tuner_type - specifies the range of tuner address that * should be used when seeking for I2C devices. * * @ADDRS_RADIO: Radio tuner addresses. * Represent the following I2C addresses: * 0x10 (if compiled with tea5761 support) * and 0x60. * @ADDRS_DEMOD: Demod tuner addresses. * Represent the following I2C addresses: * 0x42, 0x43, 0x4a and 0x4b. * @ADDRS_TV: TV tuner addresses. * Represent the following I2C addresses: * 0x42, 0x43, 0x4a, 0x4b, 0x60, 0x61, 0x62, * 0x63 and 0x64. * @ADDRS_TV_WITH_DEMOD: TV tuner addresses if demod is present, this * excludes addresses used by the demodulator * from the list of candidates. * Represent the following I2C addresses: * 0x60, 0x61, 0x62, 0x63 and 0x64. * * NOTE: All I2C addresses above use the 7-bit notation.
*/ enum v4l2_i2c_tuner_type {
ADDRS_RADIO,
ADDRS_DEMOD,
ADDRS_TV,
ADDRS_TV_WITH_DEMOD,
};
#ifdefined(CONFIG_VIDEO_V4L2_I2C)
/** * v4l2_i2c_new_subdev - Load an i2c module and return an initialized * &struct v4l2_subdev. * * @v4l2_dev: pointer to &struct v4l2_device * @adapter: pointer to struct i2c_adapter * @client_type: name of the chip that's on the adapter. * @addr: I2C address. If zero, it will use @probe_addrs * @probe_addrs: array with a list of address. The last entry at such * array should be %I2C_CLIENT_END. * * returns a &struct v4l2_subdev pointer.
*/ struct v4l2_subdev *v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev, struct i2c_adapter *adapter, constchar *client_type,
u8 addr, constunsignedshort *probe_addrs);
/** * v4l2_i2c_new_subdev_board - Load an i2c module and return an initialized * &struct v4l2_subdev. * * @v4l2_dev: pointer to &struct v4l2_device * @adapter: pointer to struct i2c_adapter * @info: pointer to struct i2c_board_info used to replace the irq, * platform_data and addr arguments. * @probe_addrs: array with a list of address. The last entry at such * array should be %I2C_CLIENT_END. * * returns a &struct v4l2_subdev pointer.
*/ struct v4l2_subdev *v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev, struct i2c_adapter *adapter, struct i2c_board_info *info, constunsignedshort *probe_addrs);
/** * v4l2_i2c_subdev_set_name - Set name for an I²C sub-device * * @sd: pointer to &struct v4l2_subdev * @client: pointer to struct i2c_client * @devname: the name of the device; if NULL, the I²C device drivers's name * will be used * @postfix: sub-device specific string to put right after the I²C device name; * may be NULL
*/ void v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client, constchar *devname, constchar *postfix);
/** * v4l2_i2c_subdev_init - Initializes a &struct v4l2_subdev with data from * an i2c_client struct. * * @sd: pointer to &struct v4l2_subdev * @client: pointer to struct i2c_client * @ops: pointer to &struct v4l2_subdev_ops
*/ void v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client, conststruct v4l2_subdev_ops *ops);
/** * v4l2_i2c_subdev_addr - returns i2c client address of &struct v4l2_subdev. * * @sd: pointer to &struct v4l2_subdev * * Returns the address of an I2C sub-device
*/ unsignedshort v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
/** * v4l2_i2c_tuner_addrs - Return a list of I2C tuner addresses to probe. * * @type: type of the tuner to seek, as defined by * &enum v4l2_i2c_tuner_type. * * NOTE: Use only if the tuner addresses are unknown.
*/ constunsignedshort *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
/** * v4l2_i2c_subdev_unregister - Unregister a v4l2_subdev * * @sd: pointer to &struct v4l2_subdev
*/ void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd);
/* * FIXME: these remaining ioctls/structs should be removed as well, but they * are still used in tuner-simple.c (TUNER_SET_CONFIG) and cx18/ivtv (RESET). * To remove these ioctls some more cleanup is needed in those modules. * * It doesn't make much sense on documenting them, as what we really want is * to get rid of them.
*/
/** * v4l_bound_align_image - adjust video dimensions according to * a given constraints. * * @width: pointer to width that will be adjusted if needed. * @wmin: minimum width. * @wmax: maximum width. * @walign: least significant bit on width. * @height: pointer to height that will be adjusted if needed. * @hmin: minimum height. * @hmax: maximum height. * @halign: least significant bit on height. * @salign: least significant bit for the image size (e. g. * :math:`width * height`). * * Clip an image to have @width between @wmin and @wmax, and @height between * @hmin and @hmax, inclusive. * * Additionally, the @width will be a multiple of :math:`2^{walign}`, * the @height will be a multiple of :math:`2^{halign}`, and the overall * size :math:`width * height` will be a multiple of :math:`2^{salign}`. * * .. note:: * * #. The clipping rectangle may be shrunk or enlarged to fit the alignment * constraints. * #. @wmax must not be smaller than @wmin. * #. @hmax must not be smaller than @hmin. * #. The alignments must not be so high there are no possible image * sizes within the allowed bounds. * #. @wmin and @hmin must be at least 1 (don't use 0). * #. For @walign, @halign and @salign, if you don't care about a certain * alignment, specify ``0``, as :math:`2^0 = 1` and one byte alignment * is equivalent to no alignment. * #. If you only want to adjust downward, specify a maximum that's the * same as the initial value.
*/ void v4l_bound_align_image(unsignedint *width, unsignedint wmin, unsignedint wmax, unsignedint walign, unsignedint *height, unsignedint hmin, unsignedint hmax, unsignedint halign, unsignedint salign);
/** * v4l2_find_nearest_size_conditional - Find the nearest size among a discrete * set of resolutions contained in an array of a driver specific struct, * with conditionally exlusion of certain modes * * @array: a driver specific array of image sizes * @array_size: the length of the driver specific array of image sizes * @width_field: the name of the width field in the driver specific struct * @height_field: the name of the height field in the driver specific struct * @width: desired width * @height: desired height * @func: ignores mode if returns false * @context: context for the function * * Finds the closest resolution to minimize the width and height differences * between what requested and the supported resolutions. The size of the width * and height fields in the driver specific must equal to that of u32, i.e. four * bytes. @func is called for each mode considered, a mode is ignored if @func * returns false for it. * * Returns the best match or NULL if the length of the array is zero.
*/ #define v4l2_find_nearest_size_conditional(array, array_size, width_field, \
height_field, width, height, \
func, context) \
({ \
BUILD_BUG_ON(sizeof((array)->width_field) != sizeof(u32) || \ sizeof((array)->height_field) != sizeof(u32)); \
(typeof(&(array)[0]))__v4l2_find_nearest_size_conditional( \
(array), array_size, sizeof(*(array)), \
offsetof(typeof(*(array)), width_field), \
offsetof(typeof(*(array)), height_field), \
width, height, func, context); \
}) constvoid *
__v4l2_find_nearest_size_conditional(constvoid *array, size_t array_size,
size_t entry_size, size_t width_offset,
size_t height_offset, s32 width,
s32 height, bool (*func)(constvoid *array,
size_t index, constvoid *context), constvoid *context);
/** * v4l2_find_nearest_size - Find the nearest size among a discrete set of * resolutions contained in an array of a driver specific struct * * @array: a driver specific array of image sizes * @array_size: the length of the driver specific array of image sizes * @width_field: the name of the width field in the driver specific struct * @height_field: the name of the height field in the driver specific struct * @width: desired width * @height: desired height * * Finds the closest resolution to minimize the width and height differences * between what requested and the supported resolutions. The size of the width * and height fields in the driver specific must equal to that of u32, i.e. four * bytes. * * Returns the best match or NULL if the length of the array is zero.
*/ #define v4l2_find_nearest_size(array, array_size, width_field, \
height_field, width, height) \
v4l2_find_nearest_size_conditional(array, array_size, width_field, \
height_field, width, height, NULL, \
NULL)
/** * v4l2_g_parm_cap - helper routine for vidioc_g_parm to fill this in by * calling the get_frame_interval op of the given subdev. It only works * for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the * function name. * * @vdev: the struct video_device pointer. Used to determine the device caps. * @sd: the sub-device pointer. * @a: the VIDIOC_G_PARM argument.
*/ int v4l2_g_parm_cap(struct video_device *vdev, struct v4l2_subdev *sd, struct v4l2_streamparm *a);
/** * v4l2_s_parm_cap - helper routine for vidioc_s_parm to fill this in by * calling the set_frame_interval op of the given subdev. It only works * for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the * function name. * * @vdev: the struct video_device pointer. Used to determine the device caps. * @sd: the sub-device pointer. * @a: the VIDIOC_S_PARM argument.
*/ int v4l2_s_parm_cap(struct video_device *vdev, struct v4l2_subdev *sd, struct v4l2_streamparm *a);
/* Compare two v4l2_fract structs */ #define V4L2_FRACT_COMPARE(a, OP, b) \
((u64)(a).numerator * (b).denominator OP \
(u64)(b).numerator * (a).denominator)
/** * v4l2_get_link_freq - Get link rate from transmitter * * @pad: The transmitter's media pad (or control handler for non-MC users or * compatibility reasons, don't use in new code) * @mul: The multiplier between pixel rate and link frequency. Bits per pixel on * D-PHY, samples per clock on parallel. 0 otherwise. * @div: The divisor between pixel rate and link frequency. Number of data lanes * times two on D-PHY, 1 on parallel. 0 otherwise. * * This function is intended for obtaining the link frequency from the * transmitter sub-devices. It returns the link rate, either from the * V4L2_CID_LINK_FREQ control implemented by the transmitter, or value * calculated based on the V4L2_CID_PIXEL_RATE implemented by the transmitter. * * Return: * * >0: Link frequency * * %-ENOENT: Link frequency or pixel rate control not found * * %-EINVAL: Invalid link frequency value
*/ #ifdef CONFIG_MEDIA_CONTROLLER #define v4l2_get_link_freq(pad, mul, div) \
_Generic(pad, \ struct media_pad *: __v4l2_get_link_freq_pad, \ struct v4l2_ctrl_handler *: __v4l2_get_link_freq_ctrl) \
(pad, mul, div)
s64 __v4l2_get_link_freq_pad(struct media_pad *pad, unsignedint mul, unsignedint div); #else #define v4l2_get_link_freq(handler, mul, div) \
__v4l2_get_link_freq_ctrl(handler, mul, div) #endif
s64 __v4l2_get_link_freq_ctrl(struct v4l2_ctrl_handler *handler, unsignedint mul, unsignedint div);
/** * v4l2_link_freq_to_bitmap - Figure out platform-supported link frequencies * @dev: The struct device * @fw_link_freqs: Array of link frequencies from firmware * @num_of_fw_link_freqs: Number of entries in @fw_link_freqs * @driver_link_freqs: Array of link frequencies supported by the driver * @num_of_driver_link_freqs: Number of entries in @driver_link_freqs * @bitmap: Bitmap of driver-supported link frequencies found in @fw_link_freqs * * This function checks which driver-supported link frequencies are enabled in * system firmware and sets the corresponding bits in @bitmap (after first * zeroing it). * * Return: * * %0: Success * * %-ENOENT: No match found between driver-supported link frequencies and * those available in firmware. * * %-ENODATA: No link frequencies were specified in firmware.
*/ int v4l2_link_freq_to_bitmap(struct device *dev, const u64 *fw_link_freqs, unsignedint num_of_fw_link_freqs, const s64 *driver_link_freqs, unsignedint num_of_driver_link_freqs, unsignedlong *bitmap);
staticinline u64 v4l2_buffer_get_timestamp(conststruct v4l2_buffer *buf)
{ /* * When the timestamp comes from 32-bit user space, there may be * uninitialized data in tv_usec, so cast it to u32. * Otherwise allow invalid input for backwards compatibility.
*/ return buf->timestamp.tv_sec * NSEC_PER_SEC +
(u32)buf->timestamp.tv_usec * NSEC_PER_USEC;
}
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.