[mirror_ubuntu-focal-kernel.git] / include / media / v4l2-common.h

/* 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>

 */

#ifndef V4L2_COMMON_H_
#define V4L2_COMMON_H_

#include <media/v4l2-dev.h>

/* 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)

#define v4l_client_printk(level, client, fmt, arg...)			    \
	v4l_printk(level, (client)->dev.driver->name, (client)->adapter, \
		   (client)->addr, fmt , ## arg)

#define v4l_err(client, fmt, arg...) \
	v4l_client_printk(KERN_ERR, client, fmt , ## arg)

#define v4l_warn(client, fmt, arg...) \
	v4l_client_printk(KERN_WARNING, client, fmt , ## arg)

#define v4l_info(client, fmt, arg...) \
	v4l_client_printk(KERN_INFO, client, fmt , ## 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)

#define v4l2_err(dev, fmt, arg...) \
	v4l2_printk(KERN_ERR, dev, fmt , ## arg)

#define v4l2_warn(dev, fmt, arg...) \
	v4l2_printk(KERN_WARNING, dev, fmt , ## arg)

#define v4l2_info(dev, fmt, arg...) \
	v4l2_printk(KERN_INFO, dev, fmt , ## 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.
 */

int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl,
			 s32 min, s32 max, s32 step, s32 def);

/* ------------------------------------------------------------------------- */

struct v4l2_device;
struct v4l2_subdev;
struct v4l2_subdev_ops;

/* I2C Helper functions */
#include <linux/i2c.h>

/**
 * 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,
};

#if defined(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, const char *client_type,
		u8 addr, const unsigned short *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,
		const unsigned short *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'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,
			      const char *devname, const char *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,
		const struct 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
 */
unsigned short 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.
 */
const unsigned short *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);

#else

static inline struct v4l2_subdev *
v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev,
		    struct i2c_adapter *adapter, const char *client_type,
		    u8 addr, const unsigned short *probe_addrs)
{
	return NULL;
}

static inline struct v4l2_subdev *
v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev,
			  struct i2c_adapter *adapter, struct i2c_board_info *info,
			  const unsigned short *probe_addrs)
{
	return NULL;
}

static inline void
v4l2_i2c_subdev_set_name(struct v4l2_subdev *sd, struct i2c_client *client,
			 const char *devname, const char *postfix)
{}

static inline void
v4l2_i2c_subdev_init(struct v4l2_subdev *sd, struct i2c_client *client,
		     const struct v4l2_subdev_ops *ops)
{}

static inline unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd)
{
	return I2C_CLIENT_END;
}

static inline const unsigned short *
v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type)
{
	return NULL;
}

static inline void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd)
{}

#endif

/* ------------------------------------------------------------------------- */

/* SPI Helper functions */

#include <linux/spi/spi.h>

#if defined(CONFIG_SPI)

/**
 *  v4l2_spi_new_subdev - Load an spi module and return an initialized
 *	&struct v4l2_subdev.
 *
 *
 * @v4l2_dev: pointer to &struct v4l2_device.
 * @master: pointer to struct spi_master.
 * @info: pointer to struct spi_board_info.
 *
 * returns a &struct v4l2_subdev pointer.
 */
struct v4l2_subdev *v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
		struct spi_master *master, struct spi_board_info *info);

/**
 * v4l2_spi_subdev_init - Initialize a v4l2_subdev with data from an
 *	spi_device struct.
 *
 * @sd: pointer to &struct v4l2_subdev
 * @spi: pointer to struct spi_device.
 * @ops: pointer to &struct v4l2_subdev_ops
 */
void v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
		const struct v4l2_subdev_ops *ops);

/**
 * v4l2_spi_subdev_unregister - Unregister a v4l2_subdev
 *
 * @sd: pointer to &struct v4l2_subdev
 */
void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd);

#else

static inline struct v4l2_subdev *
v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
		    struct spi_master *master, struct spi_board_info *info)
{
	return NULL;
}

static inline void
v4l2_spi_subdev_init(struct v4l2_subdev *sd, struct spi_device *spi,
		     const struct v4l2_subdev_ops *ops)
{}

static inline void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd)
{}
#endif

/* ------------------------------------------------------------------------- */

/*
 * 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.
 */

/* s_config */
struct v4l2_priv_tun_config {
	int tuner;
	void *priv;
};
#define TUNER_SET_CONFIG           _IOW('d', 92, struct v4l2_priv_tun_config)

#define VIDIOC_INT_RESET		_IOW ('d', 102, u32)

/* ------------------------------------------------------------------------- */

/* Miscellaneous helper functions */

/**
 * 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(unsigned int *width, unsigned int wmin,
			   unsigned int wmax, unsigned int walign,
			   unsigned int *height, unsigned int hmin,
			   unsigned int hmax, unsigned int halign,
			   unsigned int salign);

/**
 * 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)				\
	({								\
		BUILD_BUG_ON(sizeof((array)->width_field) != sizeof(u32) || \
			     sizeof((array)->height_field) != sizeof(u32)); \
		(typeof(&(array)[0]))__v4l2_find_nearest_size(		\
			(array), array_size, sizeof(*(array)),		\
			offsetof(typeof(*(array)), width_field),	\
			offsetof(typeof(*(array)), height_field),	\
			width, height);					\
	})
const void *
__v4l2_find_nearest_size(const void *array, size_t array_size,
			 size_t entry_size, size_t width_offset,
			 size_t height_offset, s32 width, s32 height);

/**
 * v4l2_g_parm_cap - helper routine for vidioc_g_parm to fill this in by
 *      calling the g_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 s_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)

/* ------------------------------------------------------------------------- */

/* Pixel format and FourCC helpers */

/**
 * struct v4l2_format_info - information about a V4L2 format
 * @format: 4CC format identifier (V4L2_PIX_FMT_*)
 * @mem_planes: Number of memory planes, which includes the alpha plane (1 to 4).
 * @comp_planes: Number of component planes, which includes the alpha plane (1 to 4).
 * @bpp: Array of per-plane bytes per pixel
 * @hdiv: Horizontal chroma subsampling factor
 * @vdiv: Vertical chroma subsampling factor
 * @block_w: Per-plane macroblock pixel width (optional)
 * @block_h: Per-plane macroblock pixel height (optional)
 */
struct v4l2_format_info {
	u32 format;
	u8 mem_planes;
	u8 comp_planes;
	u8 bpp[4];
	u8 hdiv;
	u8 vdiv;
	u8 block_w[4];
	u8 block_h[4];
};

const struct v4l2_format_info *v4l2_format_info(u32 format);

void v4l2_apply_frmsize_constraints(u32 *width, u32 *height,
				    const struct v4l2_frmsize_stepwise *frmsize);
int v4l2_fill_pixfmt(struct v4l2_pix_format *pixfmt, u32 pixelformat,
		     u32 width, u32 height);
int v4l2_fill_pixfmt_mp(struct v4l2_pix_format_mplane *pixfmt, u32 pixelformat,
			u32 width, u32 height);

#endif /* V4L2_COMMON_H_ */
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
401998fa MCC	17	#include <media/v4l2-dev.h>
401998fa MCC	18
76a59fe7	19	/* Common printk constructs for v4l-i2c drivers. These macros create a unique
7e8b09ea HV	20	prefix consisting of the driver name, the adapter number and the i2c
	21	address. */
	22	#define v4l_printk(level, name, adapter, addr, fmt, arg...) \
	23	printk(level "%s %d-%04x: " fmt, name, i2c_adapter_id(adapter), addr , ## arg)
	24
cab462f7	25	#define v4l_client_printk(level, client, fmt, arg...) \
f9d32f25	26	v4l_printk(level, (client)->dev.driver->name, (client)->adapter, \
7e8b09ea HV	27	(client)->addr, fmt , ## arg)
	28
	29	#define v4l_err(client, fmt, arg...) \
	30	v4l_client_printk(KERN_ERR, client, fmt , ## arg)
	31
	32	#define v4l_warn(client, fmt, arg...) \
	33	v4l_client_printk(KERN_WARNING, client, fmt , ## arg)
	34
	35	#define v4l_info(client, fmt, arg...) \
	36	v4l_client_printk(KERN_INFO, client, fmt , ## arg)
	37
	38	/* These three macros assume that the debug level is set with a module
	39	parameter called 'debug'. */
f167cb4e	40	#define v4l_dbg(level, debug, client, fmt, arg...) \
6e6a8b5a	41	do { \
7e8b09ea HV	42	if (debug >= (level)) \
	43	v4l_client_printk(KERN_DEBUG, client, fmt , ## arg); \
	44	} while (0)
	45
a41231d5 MCC	46	/* Add a version of v4l_dbg to be used on drivers using dev_foo() macros */
	47	#define dev_dbg_lvl(__dev, __level, __debug, __fmt, __arg...) \
	48	do { \
	49	if (__debug >= (__level)) \
	50	dev_printk(KERN_DEBUG, __dev, __fmt, ##__arg); \
	51	} while (0)
	52
7e8b09ea HV	53	/* ------------------------------------------------------------------------- */
7e8b09ea HV	54
dd99120c HV	55	/* These printk constructs can be used with v4l2_device and v4l2_subdev */
	56	#define v4l2_printk(level, dev, fmt, arg...) \
	57	printk(level "%s: " fmt, (dev)->name , ## arg)
	58
	59	#define v4l2_err(dev, fmt, arg...) \
	60	v4l2_printk(KERN_ERR, dev, fmt , ## arg)
	61
	62	#define v4l2_warn(dev, fmt, arg...) \
	63	v4l2_printk(KERN_WARNING, dev, fmt , ## arg)
	64
	65	#define v4l2_info(dev, fmt, arg...) \
	66	v4l2_printk(KERN_INFO, dev, fmt , ## arg)
	67
	68	/* These three macros assume that the debug level is set with a module
	69	parameter called 'debug'. */
	70	#define v4l2_dbg(level, debug, dev, fmt, arg...) \
6e6a8b5a	71	do { \
dd99120c	72	if (debug >= (level)) \
6e6a8b5a	73	v4l2_printk(KERN_DEBUG, dev, fmt , ## arg); \
dd99120c HV	74	} while (0)
dd99120c HV	75
b8719158 MCC	76	/**
	77	* v4l2_ctrl_query_fill- Fill in a struct v4l2_queryctrl
	78	*
	79	* @qctrl: pointer to the &struct v4l2_queryctrl to be filled
	80	* @min: minimum value for the control
	81	* @max: maximum value for the control
	82	* @step: control step
	83	* @def: default value for the control
	84	*
	85	* Fills the &struct v4l2_queryctrl fields for the query control.
	86	*
	87	* .. note::
	88	*
	89	* This function assumes that the @qctrl->id field is filled.
	90	*
	91	* Returns -EINVAL if the control is not known by the V4L2 core, 0 on success.
	92	*/
dd99120c	93
b8719158 MCC	94	int v4l2_ctrl_query_fill(struct v4l2_queryctrl *qctrl,
b8719158 MCC	95	s32 min, s32 max, s32 step, s32 def);
9cb2318b HV	96
	97	/* ------------------------------------------------------------------------- */
	98
dd99120c HV	99	struct v4l2_device;
	100	struct v4l2_subdev;
	101	struct v4l2_subdev_ops;
8ffbc655	102
02283b98 EG	103	/* I2C Helper functions */
	104	#include <linux/i2c.h>
	105
	106	/**
	107	* enum v4l2_i2c_tuner_type - specifies the range of tuner address that
	108	* should be used when seeking for I2C devices.
	109	*
	110	* @ADDRS_RADIO: Radio tuner addresses.
	111	* Represent the following I2C addresses:
	112	* 0x10 (if compiled with tea5761 support)
	113	* and 0x60.
	114	* @ADDRS_DEMOD: Demod tuner addresses.
	115	* Represent the following I2C addresses:
	116	* 0x42, 0x43, 0x4a and 0x4b.
	117	* @ADDRS_TV: TV tuner addresses.
	118	* Represent the following I2C addresses:
	119	* 0x42, 0x43, 0x4a, 0x4b, 0x60, 0x61, 0x62,
	120	* 0x63 and 0x64.
	121	* @ADDRS_TV_WITH_DEMOD: TV tuner addresses if demod is present, this
	122	* excludes addresses used by the demodulator
	123	* from the list of candidates.
	124	* Represent the following I2C addresses:
	125	* 0x60, 0x61, 0x62, 0x63 and 0x64.
	126	*
	127	* NOTE: All I2C addresses above use the 7-bit notation.
	128	*/
	129	enum v4l2_i2c_tuner_type {
	130	ADDRS_RADIO,
	131	ADDRS_DEMOD,
	132	ADDRS_TV,
	133	ADDRS_TV_WITH_DEMOD,
	134	};
	135
	136	#if defined(CONFIG_VIDEO_V4L2_I2C)
	137
a39c57f8 MCC	138	/**
	139	* v4l2_i2c_new_subdev - Load an i2c module and return an initialized
	140	* &struct v4l2_subdev.
	141	*
	142	* @v4l2_dev: pointer to &struct v4l2_device
	143	* @adapter: pointer to struct i2c_adapter
	144	* @client_type: name of the chip that's on the adapter.
	145	* @addr: I2C address. If zero, it will use @probe_addrs
	146	* @probe_addrs: array with a list of address. The last entry at such
4a3fad70	147	* array should be %I2C_CLIENT_END.
a39c57f8 MCC	148	*
	149	* returns a &struct v4l2_subdev pointer.
	150	*/
3c7c9370	151	struct v4l2_subdev v4l2_i2c_new_subdev(struct v4l2_device v4l2_dev,
9a1f8b34	152	struct i2c_adapter adapter, const char client_type,
53dacb15	153	u8 addr, const unsigned short *probe_addrs);
f0222c7d	154
a39c57f8 MCC	155	/**
	156	* v4l2_i2c_new_subdev_board - Load an i2c module and return an initialized
	157	* &struct v4l2_subdev.
	158	*
	159	* @v4l2_dev: pointer to &struct v4l2_device
	160	* @adapter: pointer to struct i2c_adapter
	161	* @info: pointer to struct i2c_board_info used to replace the irq,
	162	* platform_data and addr arguments.
	163	* @probe_addrs: array with a list of address. The last entry at such
4a3fad70	164	* array should be %I2C_CLIENT_END.
a39c57f8 MCC	165	*
	166	* returns a &struct v4l2_subdev pointer.
	167	*/
f0222c7d	168	struct v4l2_subdev v4l2_i2c_new_subdev_board(struct v4l2_device v4l2_dev,
9a1f8b34 LP	169	struct i2c_adapter adapter, struct i2c_board_info info,
9a1f8b34 LP	170	const unsigned short *probe_addrs);
f0222c7d	171
06582930 SA	172	/**
	173	* v4l2_i2c_subdev_set_name - Set name for an I²C sub-device
	174	*
	175	* @sd: pointer to &struct v4l2_subdev
	176	* @client: pointer to struct i2c_client
	177	* @devname: the name of the device; if NULL, the I²C device's name will be used
	178	* @postfix: sub-device specific string to put right after the I²C device name;
	179	* may be NULL
	180	*/
	181	void v4l2_i2c_subdev_set_name(struct v4l2_subdev sd, struct i2c_client client,
	182	const char devname, const char postfix);
	183
a39c57f8 MCC	184	/**
	185	* v4l2_i2c_subdev_init - Initializes a &struct v4l2_subdev with data from
	186	* an i2c_client struct.
	187	*
	188	* @sd: pointer to &struct v4l2_subdev
	189	* @client: pointer to struct i2c_client
	190	* @ops: pointer to &struct v4l2_subdev_ops
	191	*/
dd99120c HV	192	void v4l2_i2c_subdev_init(struct v4l2_subdev sd, struct i2c_client client,
dd99120c HV	193	const struct v4l2_subdev_ops *ops);
a39c57f8 MCC	194
	195	/**
	196	* v4l2_i2c_subdev_addr - returns i2c client address of &struct v4l2_subdev.
	197	*
	198	* @sd: pointer to &struct v4l2_subdev
	199	*
	200	* Returns the address of an I2C sub-device
	201	*/
ab373190	202	unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd);
dd99120c	203
76a59fe7 MCC	204	/**
	205	* v4l2_i2c_tuner_addrs - Return a list of I2C tuner addresses to probe.
	206	*
	207	* @type: type of the tuner to seek, as defined by
	208	* &enum v4l2_i2c_tuner_type.
	209	*
	210	* NOTE: Use only if the tuner addresses are unknown.
	211	*/
c7d29e2f HV	212	const unsigned short *v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type);
c7d29e2f HV	213
51ff392c EG	214	/**
	215	* v4l2_i2c_subdev_unregister - Unregister a v4l2_subdev
	216	*
	217	* @sd: pointer to &struct v4l2_subdev
	218	*/
	219	void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd);
	220
02283b98 EG	221	#else
	222
	223	static inline struct v4l2_subdev *
	224	v4l2_i2c_new_subdev(struct v4l2_device *v4l2_dev,
	225	struct i2c_adapter adapter, const char client_type,
	226	u8 addr, const unsigned short *probe_addrs)
	227	{
	228	return NULL;
	229	}
	230
	231	static inline struct v4l2_subdev *
	232	v4l2_i2c_new_subdev_board(struct v4l2_device *v4l2_dev,
	233	struct i2c_adapter adapter, struct i2c_board_info info,
	234	const unsigned short *probe_addrs)
	235	{
	236	return NULL;
	237	}
	238
	239	static inline void
	240	v4l2_i2c_subdev_set_name(struct v4l2_subdev sd, struct i2c_client client,
	241	const char devname, const char postfix)
	242	{}
	243
	244	static inline void
	245	v4l2_i2c_subdev_init(struct v4l2_subdev sd, struct i2c_client client,
	246	const struct v4l2_subdev_ops *ops)
	247	{}
	248
	249	static inline unsigned short v4l2_i2c_subdev_addr(struct v4l2_subdev *sd)
	250	{
	251	return I2C_CLIENT_END;
	252	}
	253
	254	static inline const unsigned short *
	255	v4l2_i2c_tuner_addrs(enum v4l2_i2c_tuner_type type)
	256	{
	257	return NULL;
	258	}
	259
51ff392c EG	260	static inline void v4l2_i2c_subdev_unregister(struct v4l2_subdev *sd)
	261	{}
	262
02283b98 EG	263	#endif
02283b98 EG	264
8ffbc655	265	/* ------------------------------------------------------------------------- */
85e09219 DB	266
85e09219 DB	267	/* SPI Helper functions */
85e09219 DB	268
	269	#include <linux/spi/spi.h>
	270
7c795df5	271	#if defined(CONFIG_SPI)
85e09219	272
b8719158 MCC	273	/**
	274	* v4l2_spi_new_subdev - Load an spi module and return an initialized
	275	* &struct v4l2_subdev.
	276	*
	277	*
	278	* @v4l2_dev: pointer to &struct v4l2_device.
	279	* @master: pointer to struct spi_master.
	280	* @info: pointer to struct spi_board_info.
	281	*
	282	* returns a &struct v4l2_subdev pointer.
	283	*/
85e09219 DB	284	struct v4l2_subdev v4l2_spi_new_subdev(struct v4l2_device v4l2_dev,
	285	struct spi_master master, struct spi_board_info info);
	286
b8719158 MCC	287	/**
	288	* v4l2_spi_subdev_init - Initialize a v4l2_subdev with data from an
	289	* spi_device struct.
	290	*
	291	* @sd: pointer to &struct v4l2_subdev
	292	* @spi: pointer to struct spi_device.
	293	* @ops: pointer to &struct v4l2_subdev_ops
	294	*/
85e09219 DB	295	void v4l2_spi_subdev_init(struct v4l2_subdev sd, struct spi_device spi,
85e09219 DB	296	const struct v4l2_subdev_ops *ops);
7c795df5	297
a9cff393 EG	298	/**
	299	* v4l2_spi_subdev_unregister - Unregister a v4l2_subdev
	300	*
	301	* @sd: pointer to &struct v4l2_subdev
	302	*/
	303	void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd);
	304
7c795df5 EG	305	#else
	306
	307	static inline struct v4l2_subdev *
	308	v4l2_spi_new_subdev(struct v4l2_device *v4l2_dev,
	309	struct spi_master master, struct spi_board_info info)
	310	{
	311	return NULL;
	312	}
	313
	314	static inline void
	315	v4l2_spi_subdev_init(struct v4l2_subdev sd, struct spi_device spi,
	316	const struct v4l2_subdev_ops *ops)
	317	{}
	318
a9cff393 EG	319	static inline void v4l2_spi_subdev_unregister(struct v4l2_subdev *sd)
a9cff393 EG	320	{}
85e09219 DB	321	#endif
	322
	323	/* ------------------------------------------------------------------------- */
8ffbc655	324
01154ef5 MCC	325	/*
	326	* FIXME: these remaining ioctls/structs should be removed as well, but they
	327	* are still used in tuner-simple.c (TUNER_SET_CONFIG) and cx18/ivtv (RESET).
	328	* To remove these ioctls some more cleanup is needed in those modules.
76a59fe7 MCC	329	*
	330	* It doesn't make much sense on documenting them, as what we really want is
	331	* to get rid of them.
01154ef5	332	*/
b2f0648f	333
78a3b4db	334	/* s_config */
7f171123 MCC	335	struct v4l2_priv_tun_config {
	336	int tuner;
	337	void *priv;
	338	};
7f171123	339	#define TUNER_SET_CONFIG _IOW('d', 92, struct v4l2_priv_tun_config)
757d2505	340
6e6a8b5a	341	#define VIDIOC_INT_RESET _IOW ('d', 102, u32)
6c31e598	342
b0d3159b TP	343	/* ------------------------------------------------------------------------- */
	344
	345	/* Miscellaneous helper functions */
	346
76a59fe7 MCC	347	/**
	348	* v4l_bound_align_image - adjust video dimensions according to
	349	* a given constraints.
	350	*
	351	* @width: pointer to width that will be adjusted if needed.
	352	* @wmin: minimum width.
	353	* @wmax: maximum width.
	354	* @walign: least significant bit on width.
	355	* @height: pointer to height that will be adjusted if needed.
	356	* @hmin: minimum height.
	357	* @hmax: maximum height.
ae5a8ca8	358	* @halign: least significant bit on height.
76a59fe7 MCC	359	* @salign: least significant bit for the image size (e. g.
	360	* :math:`width * height`).
	361	*
	362	* Clip an image to have @width between @wmin and @wmax, and @height between
	363	* @hmin and @hmax, inclusive.
	364	*
	365	* Additionally, the @width will be a multiple of :math:`2^{walign}`,
	366	* the @height will be a multiple of :math:`2^{halign}`, and the overall
	367	* size :math:`width * height` will be a multiple of :math:`2^{salign}`.
	368	*
	369	* .. note::
	370	*
	371	* #. The clipping rectangle may be shrunk or enlarged to fit the alignment
	372	* constraints.
	373	* #. @wmax must not be smaller than @wmin.
	374	* #. @hmax must not be smaller than @hmin.
	375	* #. The alignments must not be so high there are no possible image
	376	* sizes within the allowed bounds.
	377	* #. @wmin and @hmin must be at least 1 (don't use 0).
	378	* #. For @walign, @halign and @salign, if you don't care about a certain
	379	* alignment, specify ``0``, as :math:`2^0 = 1` and one byte alignment
	380	* is equivalent to no alignment.
	381	* #. If you only want to adjust downward, specify a maximum that's the
	382	* same as the initial value.
	383	*/
	384	void v4l_bound_align_image(unsigned int *width, unsigned int wmin,
b0d3159b	385	unsigned int wmax, unsigned int walign,
76a59fe7	386	unsigned int *height, unsigned int hmin,
b0d3159b TP	387	unsigned int hmax, unsigned int halign,
b0d3159b TP	388	unsigned int salign);
3fd8e647	389
95ce9c28 SA	390	/**
	391	* v4l2_find_nearest_size - Find the nearest size among a discrete
	392	* set of resolutions contained in an array of a driver specific struct.
	393	*
	394	* @array: a driver specific array of image sizes
d2dc57b1	395	* @array_size: the length of the driver specific array of image sizes
95ce9c28 SA	396	* @width_field: the name of the width field in the driver specific struct
	397	* @height_field: the name of the height field in the driver specific struct
	398	* @width: desired width.
	399	* @height: desired height.
	400	*
	401	* Finds the closest resolution to minimize the width and height differences
	402	* between what requested and the supported resolutions. The size of the width
	403	* and height fields in the driver specific must equal to that of u32, i.e. four
	404	* bytes.
	405	*
	406	* Returns the best match or NULL if the length of the array is zero.
	407	*/
d2dc57b1	408	#define v4l2_find_nearest_size(array, array_size, width_field, height_field, \
95ce9c28 SA	409	width, height) \
	410	({ \
	411	BUILD_BUG_ON(sizeof((array)->width_field) != sizeof(u32) \|\| \
	412	sizeof((array)->height_field) != sizeof(u32)); \
2bbc46e8	413	(typeof(&(array)[0]))__v4l2_find_nearest_size( \
d2dc57b1	414	(array), array_size, sizeof(*(array)), \
95ce9c28 SA	415	offsetof(typeof(*(array)), width_field), \
	416	offsetof(typeof(*(array)), height_field), \
	417	width, height); \
	418	})
	419	const void *
	420	__v4l2_find_nearest_size(const void *array, size_t array_size,
	421	size_t entry_size, size_t width_offset,
	422	size_t height_offset, s32 width, s32 height);
	423
672de9a7 HV	424	/**
	425	* v4l2_g_parm_cap - helper routine for vidioc_g_parm to fill this in by
	426	* calling the g_frame_interval op of the given subdev. It only works
	427	* for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the
	428	* function name.
	429	*
	430	* @vdev: the struct video_device pointer. Used to determine the device caps.
	431	* @sd: the sub-device pointer.
	432	* @a: the VIDIOC_G_PARM argument.
	433	*/
	434	int v4l2_g_parm_cap(struct video_device *vdev,
	435	struct v4l2_subdev sd, struct v4l2_streamparm a);
	436
	437	/**
	438	* v4l2_s_parm_cap - helper routine for vidioc_s_parm to fill this in by
	439	* calling the s_frame_interval op of the given subdev. It only works
	440	* for V4L2_BUF_TYPE_VIDEO_CAPTURE(_MPLANE), hence the _cap in the
	441	* function name.
	442	*
	443	* @vdev: the struct video_device pointer. Used to determine the device caps.
	444	* @sd: the sub-device pointer.
	445	* @a: the VIDIOC_S_PARM argument.
	446	*/
	447	int v4l2_s_parm_cap(struct video_device *vdev,
	448	struct v4l2_subdev sd, struct v4l2_streamparm a);
	449
85de5e06 AM	450	/* Compare two v4l2_fract structs */
	451	#define V4L2_FRACT_COMPARE(a, OP, b) \
	452	((u64)(a).numerator * (b).denominator OP \
	453	(u64)(b).numerator * (a).denominator)
	454
f44b969a EG	455	/* ------------------------------------------------------------------------- */
	456
	457	/* Pixel format and FourCC helpers */
	458
	459	/**
	460	* struct v4l2_format_info - information about a V4L2 format
	461	* @format: 4CC format identifier (V4L2_PIX_FMT_*)
	462	* @mem_planes: Number of memory planes, which includes the alpha plane (1 to 4).
	463	* @comp_planes: Number of component planes, which includes the alpha plane (1 to 4).
	464	* @bpp: Array of per-plane bytes per pixel
	465	* @hdiv: Horizontal chroma subsampling factor
	466	* @vdiv: Vertical chroma subsampling factor
	467	* @block_w: Per-plane macroblock pixel width (optional)
	468	* @block_h: Per-plane macroblock pixel height (optional)
	469	*/
	470	struct v4l2_format_info {
	471	u32 format;
	472	u8 mem_planes;
	473	u8 comp_planes;
	474	u8 bpp[4];
	475	u8 hdiv;
	476	u8 vdiv;
	477	u8 block_w[4];
	478	u8 block_h[4];
	479	};
	480
	481	const struct v4l2_format_info *v4l2_format_info(u32 format);
	482
32cddf9c BB	483	void v4l2_apply_frmsize_constraints(u32 width, u32 height,
32cddf9c BB	484	const struct v4l2_frmsize_stepwise *frmsize);
ce57a82f BB	485	int v4l2_fill_pixfmt(struct v4l2_pix_format *pixfmt, u32 pixelformat,
	486	u32 width, u32 height);
	487	int v4l2_fill_pixfmt_mp(struct v4l2_pix_format_mplane *pixfmt, u32 pixelformat,
	488	u32 width, u32 height);
f44b969a	489
b2f0648f	490	#endif /* V4L2_COMMON_H_ */