[linux-block.git] / include / media / v4l2-mediabus.h

/*
 * Media Bus API header
 *
 * Copyright (C) 2009, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef V4L2_MEDIABUS_H
#define V4L2_MEDIABUS_H

#include <linux/v4l2-mediabus.h>
#include <linux/bitops.h>


/* Parallel flags */
/*
 * Can the client run in master or in slave mode. By "Master mode" an operation
 * mode is meant, when the client (e.g., a camera sensor) is producing
 * horizontal and vertical synchronisation. In "Slave mode" the host is
 * providing these signals to the slave.
 */
#define V4L2_MBUS_MASTER			BIT(0)
#define V4L2_MBUS_SLAVE				BIT(1)
/*
 * Signal polarity flags
 * Note: in BT.656 mode HSYNC, FIELD, and VSYNC are unused
 * V4L2_MBUS_[HV]SYNC* flags should be also used for specifying
 * configuration of hardware that uses [HV]REF signals
 */
#define V4L2_MBUS_HSYNC_ACTIVE_HIGH		BIT(2)
#define V4L2_MBUS_HSYNC_ACTIVE_LOW		BIT(3)
#define V4L2_MBUS_VSYNC_ACTIVE_HIGH		BIT(4)
#define V4L2_MBUS_VSYNC_ACTIVE_LOW		BIT(5)
#define V4L2_MBUS_PCLK_SAMPLE_RISING		BIT(6)
#define V4L2_MBUS_PCLK_SAMPLE_FALLING		BIT(7)
#define V4L2_MBUS_DATA_ACTIVE_HIGH		BIT(8)
#define V4L2_MBUS_DATA_ACTIVE_LOW		BIT(9)
/* FIELD = 0/1 - Field1 (odd)/Field2 (even) */
#define V4L2_MBUS_FIELD_EVEN_HIGH		BIT(10)
/* FIELD = 1/0 - Field1 (odd)/Field2 (even) */
#define V4L2_MBUS_FIELD_EVEN_LOW		BIT(11)
/* Active state of Sync-on-green (SoG) signal, 0/1 for LOW/HIGH respectively. */
#define V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH		BIT(12)
#define V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW		BIT(13)
#define V4L2_MBUS_DATA_ENABLE_HIGH		BIT(14)
#define V4L2_MBUS_DATA_ENABLE_LOW		BIT(15)

/* Serial flags */
/* How many lanes the client can use */
#define V4L2_MBUS_CSI2_1_LANE			BIT(0)
#define V4L2_MBUS_CSI2_2_LANE			BIT(1)
#define V4L2_MBUS_CSI2_3_LANE			BIT(2)
#define V4L2_MBUS_CSI2_4_LANE			BIT(3)
/* On which channels it can send video data */
#define V4L2_MBUS_CSI2_CHANNEL_0		BIT(4)
#define V4L2_MBUS_CSI2_CHANNEL_1		BIT(5)
#define V4L2_MBUS_CSI2_CHANNEL_2		BIT(6)
#define V4L2_MBUS_CSI2_CHANNEL_3		BIT(7)
/* Does it support only continuous or also non-continuous clock mode */
#define V4L2_MBUS_CSI2_CONTINUOUS_CLOCK		BIT(8)
#define V4L2_MBUS_CSI2_NONCONTINUOUS_CLOCK	BIT(9)

#define V4L2_MBUS_CSI2_LANES		(V4L2_MBUS_CSI2_1_LANE | V4L2_MBUS_CSI2_2_LANE | \
					 V4L2_MBUS_CSI2_3_LANE | V4L2_MBUS_CSI2_4_LANE)
#define V4L2_MBUS_CSI2_CHANNELS		(V4L2_MBUS_CSI2_CHANNEL_0 | V4L2_MBUS_CSI2_CHANNEL_1 | \
					 V4L2_MBUS_CSI2_CHANNEL_2 | V4L2_MBUS_CSI2_CHANNEL_3)

/**
 * enum v4l2_mbus_type - media bus type
 * @V4L2_MBUS_PARALLEL:	parallel interface with hsync and vsync
 * @V4L2_MBUS_BT656:	parallel interface with embedded synchronisation, can
 *			also be used for BT.1120
 * @V4L2_MBUS_CSI1:	MIPI CSI-1 serial interface
 * @V4L2_MBUS_CCP2:	CCP2 (Compact Camera Port 2)
 * @V4L2_MBUS_CSI2:	MIPI CSI-2 serial interface
 */
enum v4l2_mbus_type {
	V4L2_MBUS_PARALLEL,
	V4L2_MBUS_BT656,
	V4L2_MBUS_CSI1,
	V4L2_MBUS_CCP2,
	V4L2_MBUS_CSI2,
};

/**
 * struct v4l2_mbus_config - media bus configuration
 * @type:	in: interface type
 * @flags:	in / out: configuration flags, depending on @type
 */
struct v4l2_mbus_config {
	enum v4l2_mbus_type type;
	unsigned int flags;
};

/**
 * v4l2_fill_pix_format - Ancillary routine that fills a &struct
 *	v4l2_pix_format fields from a &struct v4l2_mbus_framefmt.
 *
 * @pix_fmt:	pointer to &struct v4l2_pix_format to be filled
 * @mbus_fmt:	pointer to &struct v4l2_mbus_framefmt to be used as model
 */
static inline void v4l2_fill_pix_format(struct v4l2_pix_format *pix_fmt,
				const struct v4l2_mbus_framefmt *mbus_fmt)
{
	pix_fmt->width = mbus_fmt->width;
	pix_fmt->height = mbus_fmt->height;
	pix_fmt->field = mbus_fmt->field;
	pix_fmt->colorspace = mbus_fmt->colorspace;
	pix_fmt->ycbcr_enc = mbus_fmt->ycbcr_enc;
	pix_fmt->quantization = mbus_fmt->quantization;
	pix_fmt->xfer_func = mbus_fmt->xfer_func;
}

/**
 * v4l2_fill_pix_format - Ancillary routine that fills a &struct
 *	v4l2_mbus_framefmt from a &struct v4l2_pix_format and a
 *	data format code.
 *
 * @mbus_fmt:	pointer to &struct v4l2_mbus_framefmt to be filled
 * @pix_fmt:	pointer to &struct v4l2_pix_format to be used as model
 * @code:	data format code (from &enum v4l2_mbus_pixelcode)
 */
static inline void v4l2_fill_mbus_format(struct v4l2_mbus_framefmt *mbus_fmt,
			   const struct v4l2_pix_format *pix_fmt,
			   u32 code)
{
	mbus_fmt->width = pix_fmt->width;
	mbus_fmt->height = pix_fmt->height;
	mbus_fmt->field = pix_fmt->field;
	mbus_fmt->colorspace = pix_fmt->colorspace;
	mbus_fmt->ycbcr_enc = pix_fmt->ycbcr_enc;
	mbus_fmt->quantization = pix_fmt->quantization;
	mbus_fmt->xfer_func = pix_fmt->xfer_func;
	mbus_fmt->code = code;
}

/**
 * v4l2_fill_pix_format - Ancillary routine that fills a &struct
 *	v4l2_pix_format_mplane fields from a media bus structure.
 *
 * @pix_mp_fmt:	pointer to &struct v4l2_pix_format_mplane to be filled
 * @mbus_fmt:	pointer to &struct v4l2_mbus_framefmt to be used as model
 */
static inline void v4l2_fill_pix_format_mplane(
				struct v4l2_pix_format_mplane *pix_mp_fmt,
				const struct v4l2_mbus_framefmt *mbus_fmt)
{
	pix_mp_fmt->width = mbus_fmt->width;
	pix_mp_fmt->height = mbus_fmt->height;
	pix_mp_fmt->field = mbus_fmt->field;
	pix_mp_fmt->colorspace = mbus_fmt->colorspace;
	pix_mp_fmt->ycbcr_enc = mbus_fmt->ycbcr_enc;
	pix_mp_fmt->quantization = mbus_fmt->quantization;
	pix_mp_fmt->xfer_func = mbus_fmt->xfer_func;
}

/**
 * v4l2_fill_pix_format - Ancillary routine that fills a &struct
 *	v4l2_mbus_framefmt from a &struct v4l2_pix_format_mplane.
 *
 * @mbus_fmt:	pointer to &struct v4l2_mbus_framefmt to be filled
 * @pix_mp_fmt:	pointer to &struct v4l2_pix_format_mplane to be used as model
 */
static inline void v4l2_fill_mbus_format_mplane(
				struct v4l2_mbus_framefmt *mbus_fmt,
				const struct v4l2_pix_format_mplane *pix_mp_fmt)
{
	mbus_fmt->width = pix_mp_fmt->width;
	mbus_fmt->height = pix_mp_fmt->height;
	mbus_fmt->field = pix_mp_fmt->field;
	mbus_fmt->colorspace = pix_mp_fmt->colorspace;
	mbus_fmt->ycbcr_enc = pix_mp_fmt->ycbcr_enc;
	mbus_fmt->quantization = pix_mp_fmt->quantization;
	mbus_fmt->xfer_func = pix_mp_fmt->xfer_func;
}

#endif
Commit	Line	Data
9a74251d GL	1	/*
	2	* Media Bus API header
	3	*
	4	* Copyright (C) 2009, Guennadi Liakhovetski <g.liakhovetski@gmx.de>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*/
	10
	11	#ifndef V4L2_MEDIABUS_H
	12	#define V4L2_MEDIABUS_H
	13
2ef2d5a3	14	#include <linux/v4l2-mediabus.h>
2120961f MCC	15	#include <linux/bitops.h>
2120961f MCC	16
9a74251d	17
91c79530 GL	18	/* Parallel flags */
	19	/*
	20	* Can the client run in master or in slave mode. By "Master mode" an operation
	21	* mode is meant, when the client (e.g., a camera sensor) is producing
	22	* horizontal and vertical synchronisation. In "Slave mode" the host is
	23	* providing these signals to the slave.
	24	*/
2120961f MCC	25	#define V4L2_MBUS_MASTER BIT(0)
2120961f MCC	26	#define V4L2_MBUS_SLAVE BIT(1)
3c6938f8 SN	27	/*
	28	* Signal polarity flags
	29	* Note: in BT.656 mode HSYNC, FIELD, and VSYNC are unused
	30	* V4L2_MBUS_[HV]SYNC* flags should be also used for specifying
	31	* configuration of hardware that uses [HV]REF signals
	32	*/
2120961f MCC	33	#define V4L2_MBUS_HSYNC_ACTIVE_HIGH BIT(2)
	34	#define V4L2_MBUS_HSYNC_ACTIVE_LOW BIT(3)
	35	#define V4L2_MBUS_VSYNC_ACTIVE_HIGH BIT(4)
	36	#define V4L2_MBUS_VSYNC_ACTIVE_LOW BIT(5)
	37	#define V4L2_MBUS_PCLK_SAMPLE_RISING BIT(6)
	38	#define V4L2_MBUS_PCLK_SAMPLE_FALLING BIT(7)
	39	#define V4L2_MBUS_DATA_ACTIVE_HIGH BIT(8)
	40	#define V4L2_MBUS_DATA_ACTIVE_LOW BIT(9)
3c6938f8	41	/* FIELD = 0/1 - Field1 (odd)/Field2 (even) */
2120961f	42	#define V4L2_MBUS_FIELD_EVEN_HIGH BIT(10)
3c6938f8	43	/* FIELD = 1/0 - Field1 (odd)/Field2 (even) */
2120961f	44	#define V4L2_MBUS_FIELD_EVEN_LOW BIT(11)
d1d70aa6	45	/* Active state of Sync-on-green (SoG) signal, 0/1 for LOW/HIGH respectively. */
2120961f MCC	46	#define V4L2_MBUS_VIDEO_SOG_ACTIVE_HIGH BIT(12)
2120961f MCC	47	#define V4L2_MBUS_VIDEO_SOG_ACTIVE_LOW BIT(13)
9b04fcc1 JM	48	#define V4L2_MBUS_DATA_ENABLE_HIGH BIT(14)
9b04fcc1 JM	49	#define V4L2_MBUS_DATA_ENABLE_LOW BIT(15)
91c79530 GL	50
	51	/* Serial flags */
	52	/* How many lanes the client can use */
2120961f MCC	53	#define V4L2_MBUS_CSI2_1_LANE BIT(0)
	54	#define V4L2_MBUS_CSI2_2_LANE BIT(1)
	55	#define V4L2_MBUS_CSI2_3_LANE BIT(2)
	56	#define V4L2_MBUS_CSI2_4_LANE BIT(3)
91c79530	57	/* On which channels it can send video data */
2120961f MCC	58	#define V4L2_MBUS_CSI2_CHANNEL_0 BIT(4)
	59	#define V4L2_MBUS_CSI2_CHANNEL_1 BIT(5)
	60	#define V4L2_MBUS_CSI2_CHANNEL_2 BIT(6)
	61	#define V4L2_MBUS_CSI2_CHANNEL_3 BIT(7)
91c79530	62	/* Does it support only continuous or also non-continuous clock mode */
2120961f MCC	63	#define V4L2_MBUS_CSI2_CONTINUOUS_CLOCK BIT(8)
2120961f MCC	64	#define V4L2_MBUS_CSI2_NONCONTINUOUS_CLOCK BIT(9)
91c79530 GL	65
	66	#define V4L2_MBUS_CSI2_LANES (V4L2_MBUS_CSI2_1_LANE \| V4L2_MBUS_CSI2_2_LANE \| \
	67	V4L2_MBUS_CSI2_3_LANE \| V4L2_MBUS_CSI2_4_LANE)
	68	#define V4L2_MBUS_CSI2_CHANNELS (V4L2_MBUS_CSI2_CHANNEL_0 \| V4L2_MBUS_CSI2_CHANNEL_1 \| \
	69	V4L2_MBUS_CSI2_CHANNEL_2 \| V4L2_MBUS_CSI2_CHANNEL_3)
	70
	71	/**
98d00bd7	72	* enum v4l2_mbus_type - media bus type
91c79530 GL	73	* @V4L2_MBUS_PARALLEL: parallel interface with hsync and vsync
	74	* @V4L2_MBUS_BT656: parallel interface with embedded synchronisation, can
	75	* also be used for BT.1120
97bbdf02 SA	76	* @V4L2_MBUS_CSI1: MIPI CSI-1 serial interface
97bbdf02 SA	77	* @V4L2_MBUS_CCP2: CCP2 (Compact Camera Port 2)
91c79530 GL	78	* @V4L2_MBUS_CSI2: MIPI CSI-2 serial interface
	79	*/
	80	enum v4l2_mbus_type {
	81	V4L2_MBUS_PARALLEL,
	82	V4L2_MBUS_BT656,
97bbdf02 SA	83	V4L2_MBUS_CSI1,
97bbdf02 SA	84	V4L2_MBUS_CCP2,
91c79530 GL	85	V4L2_MBUS_CSI2,
	86	};
	87
	88	/**
98d00bd7	89	* struct v4l2_mbus_config - media bus configuration
91c79530 GL	90	* @type: in: interface type
	91	* @flags: in / out: configuration flags, depending on @type
	92	*/
	93	struct v4l2_mbus_config {
	94	enum v4l2_mbus_type type;
	95	unsigned int flags;
	96	};
	97
4839c58f MCC	98	/**
	99	* v4l2_fill_pix_format - Ancillary routine that fills a &struct
	100	* v4l2_pix_format fields from a &struct v4l2_mbus_framefmt.
	101	*
	102	* @pix_fmt: pointer to &struct v4l2_pix_format to be filled
	103	* @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be used as model
	104	*/
3a21ceed HV	105	static inline void v4l2_fill_pix_format(struct v4l2_pix_format *pix_fmt,
	106	const struct v4l2_mbus_framefmt *mbus_fmt)
	107	{
	108	pix_fmt->width = mbus_fmt->width;
	109	pix_fmt->height = mbus_fmt->height;
	110	pix_fmt->field = mbus_fmt->field;
	111	pix_fmt->colorspace = mbus_fmt->colorspace;
11ff030c HV	112	pix_fmt->ycbcr_enc = mbus_fmt->ycbcr_enc;
11ff030c HV	113	pix_fmt->quantization = mbus_fmt->quantization;
74fdcb2e	114	pix_fmt->xfer_func = mbus_fmt->xfer_func;
3a21ceed HV	115	}
3a21ceed HV	116
4839c58f MCC	117	/**
	118	* v4l2_fill_pix_format - Ancillary routine that fills a &struct
	119	* v4l2_mbus_framefmt from a &struct v4l2_pix_format and a
	120	* data format code.
	121	*
	122	* @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be filled
	123	* @pix_fmt: pointer to &struct v4l2_pix_format to be used as model
	124	* @code: data format code (from &enum v4l2_mbus_pixelcode)
	125	*/
3a21ceed HV	126	static inline void v4l2_fill_mbus_format(struct v4l2_mbus_framefmt *mbus_fmt,
3a21ceed HV	127	const struct v4l2_pix_format *pix_fmt,
32b32ce8	128	u32 code)
3a21ceed HV	129	{
	130	mbus_fmt->width = pix_fmt->width;
	131	mbus_fmt->height = pix_fmt->height;
	132	mbus_fmt->field = pix_fmt->field;
	133	mbus_fmt->colorspace = pix_fmt->colorspace;
11ff030c HV	134	mbus_fmt->ycbcr_enc = pix_fmt->ycbcr_enc;
11ff030c HV	135	mbus_fmt->quantization = pix_fmt->quantization;
74fdcb2e	136	mbus_fmt->xfer_func = pix_fmt->xfer_func;
3a21ceed HV	137	mbus_fmt->code = code;
	138	}
	139
4839c58f MCC	140	/**
	141	* v4l2_fill_pix_format - Ancillary routine that fills a &struct
	142	* v4l2_pix_format_mplane fields from a media bus structure.
	143	*
	144	* @pix_mp_fmt: pointer to &struct v4l2_pix_format_mplane to be filled
	145	* @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be used as model
	146	*/
f1923010 TT	147	static inline void v4l2_fill_pix_format_mplane(
	148	struct v4l2_pix_format_mplane *pix_mp_fmt,
	149	const struct v4l2_mbus_framefmt *mbus_fmt)
	150	{
	151	pix_mp_fmt->width = mbus_fmt->width;
	152	pix_mp_fmt->height = mbus_fmt->height;
	153	pix_mp_fmt->field = mbus_fmt->field;
	154	pix_mp_fmt->colorspace = mbus_fmt->colorspace;
	155	pix_mp_fmt->ycbcr_enc = mbus_fmt->ycbcr_enc;
	156	pix_mp_fmt->quantization = mbus_fmt->quantization;
	157	pix_mp_fmt->xfer_func = mbus_fmt->xfer_func;
	158	}
	159
4839c58f MCC	160	/**
	161	* v4l2_fill_pix_format - Ancillary routine that fills a &struct
	162	* v4l2_mbus_framefmt from a &struct v4l2_pix_format_mplane.
	163	*
	164	* @mbus_fmt: pointer to &struct v4l2_mbus_framefmt to be filled
	165	* @pix_mp_fmt: pointer to &struct v4l2_pix_format_mplane to be used as model
	166	*/
f1923010 TT	167	static inline void v4l2_fill_mbus_format_mplane(
	168	struct v4l2_mbus_framefmt *mbus_fmt,
	169	const struct v4l2_pix_format_mplane *pix_mp_fmt)
	170	{
	171	mbus_fmt->width = pix_mp_fmt->width;
	172	mbus_fmt->height = pix_mp_fmt->height;
	173	mbus_fmt->field = pix_mp_fmt->field;
	174	mbus_fmt->colorspace = pix_mp_fmt->colorspace;
	175	mbus_fmt->ycbcr_enc = pix_mp_fmt->ycbcr_enc;
	176	mbus_fmt->quantization = pix_mp_fmt->quantization;
	177	mbus_fmt->xfer_func = pix_mp_fmt->xfer_func;
	178	}
	179
9a74251d	180	#endif