[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)

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

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;
}

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;
}

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;
}

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)
91c79530 GL	48
	49	/* Serial flags */
	50	/* How many lanes the client can use */
2120961f MCC	51	#define V4L2_MBUS_CSI2_1_LANE BIT(0)
	52	#define V4L2_MBUS_CSI2_2_LANE BIT(1)
	53	#define V4L2_MBUS_CSI2_3_LANE BIT(2)
	54	#define V4L2_MBUS_CSI2_4_LANE BIT(3)
91c79530	55	/* On which channels it can send video data */
2120961f MCC	56	#define V4L2_MBUS_CSI2_CHANNEL_0 BIT(4)
	57	#define V4L2_MBUS_CSI2_CHANNEL_1 BIT(5)
	58	#define V4L2_MBUS_CSI2_CHANNEL_2 BIT(6)
	59	#define V4L2_MBUS_CSI2_CHANNEL_3 BIT(7)
91c79530	60	/* Does it support only continuous or also non-continuous clock mode */
2120961f MCC	61	#define V4L2_MBUS_CSI2_CONTINUOUS_CLOCK BIT(8)
2120961f MCC	62	#define V4L2_MBUS_CSI2_NONCONTINUOUS_CLOCK BIT(9)
91c79530 GL	63
	64	#define V4L2_MBUS_CSI2_LANES (V4L2_MBUS_CSI2_1_LANE \| V4L2_MBUS_CSI2_2_LANE \| \
	65	V4L2_MBUS_CSI2_3_LANE \| V4L2_MBUS_CSI2_4_LANE)
	66	#define V4L2_MBUS_CSI2_CHANNELS (V4L2_MBUS_CSI2_CHANNEL_0 \| V4L2_MBUS_CSI2_CHANNEL_1 \| \
	67	V4L2_MBUS_CSI2_CHANNEL_2 \| V4L2_MBUS_CSI2_CHANNEL_3)
	68
	69	/**
98d00bd7	70	* enum v4l2_mbus_type - media bus type
91c79530 GL	71	* @V4L2_MBUS_PARALLEL: parallel interface with hsync and vsync
	72	* @V4L2_MBUS_BT656: parallel interface with embedded synchronisation, can
	73	* also be used for BT.1120
97bbdf02 SA	74	* @V4L2_MBUS_CSI1: MIPI CSI-1 serial interface
97bbdf02 SA	75	* @V4L2_MBUS_CCP2: CCP2 (Compact Camera Port 2)
91c79530 GL	76	* @V4L2_MBUS_CSI2: MIPI CSI-2 serial interface
	77	*/
	78	enum v4l2_mbus_type {
	79	V4L2_MBUS_PARALLEL,
	80	V4L2_MBUS_BT656,
97bbdf02 SA	81	V4L2_MBUS_CSI1,
97bbdf02 SA	82	V4L2_MBUS_CCP2,
91c79530 GL	83	V4L2_MBUS_CSI2,
	84	};
	85
	86	/**
98d00bd7	87	* struct v4l2_mbus_config - media bus configuration
91c79530 GL	88	* @type: in: interface type
	89	* @flags: in / out: configuration flags, depending on @type
	90	*/
	91	struct v4l2_mbus_config {
	92	enum v4l2_mbus_type type;
	93	unsigned int flags;
	94	};
	95
3a21ceed HV	96	static inline void v4l2_fill_pix_format(struct v4l2_pix_format *pix_fmt,
	97	const struct v4l2_mbus_framefmt *mbus_fmt)
	98	{
	99	pix_fmt->width = mbus_fmt->width;
	100	pix_fmt->height = mbus_fmt->height;
	101	pix_fmt->field = mbus_fmt->field;
	102	pix_fmt->colorspace = mbus_fmt->colorspace;
11ff030c HV	103	pix_fmt->ycbcr_enc = mbus_fmt->ycbcr_enc;
11ff030c HV	104	pix_fmt->quantization = mbus_fmt->quantization;
74fdcb2e	105	pix_fmt->xfer_func = mbus_fmt->xfer_func;
3a21ceed HV	106	}
	107
	108	static inline void v4l2_fill_mbus_format(struct v4l2_mbus_framefmt *mbus_fmt,
	109	const struct v4l2_pix_format *pix_fmt,
32b32ce8	110	u32 code)
3a21ceed HV	111	{
	112	mbus_fmt->width = pix_fmt->width;
	113	mbus_fmt->height = pix_fmt->height;
	114	mbus_fmt->field = pix_fmt->field;
	115	mbus_fmt->colorspace = pix_fmt->colorspace;
11ff030c HV	116	mbus_fmt->ycbcr_enc = pix_fmt->ycbcr_enc;
11ff030c HV	117	mbus_fmt->quantization = pix_fmt->quantization;
74fdcb2e	118	mbus_fmt->xfer_func = pix_fmt->xfer_func;
3a21ceed HV	119	mbus_fmt->code = code;
	120	}
	121
f1923010 TT	122	static inline void v4l2_fill_pix_format_mplane(
	123	struct v4l2_pix_format_mplane *pix_mp_fmt,
	124	const struct v4l2_mbus_framefmt *mbus_fmt)
	125	{
	126	pix_mp_fmt->width = mbus_fmt->width;
	127	pix_mp_fmt->height = mbus_fmt->height;
	128	pix_mp_fmt->field = mbus_fmt->field;
	129	pix_mp_fmt->colorspace = mbus_fmt->colorspace;
	130	pix_mp_fmt->ycbcr_enc = mbus_fmt->ycbcr_enc;
	131	pix_mp_fmt->quantization = mbus_fmt->quantization;
	132	pix_mp_fmt->xfer_func = mbus_fmt->xfer_func;
	133	}
	134
	135	static inline void v4l2_fill_mbus_format_mplane(
	136	struct v4l2_mbus_framefmt *mbus_fmt,
	137	const struct v4l2_pix_format_mplane *pix_mp_fmt)
	138	{
	139	mbus_fmt->width = pix_mp_fmt->width;
	140	mbus_fmt->height = pix_mp_fmt->height;
	141	mbus_fmt->field = pix_mp_fmt->field;
	142	mbus_fmt->colorspace = pix_mp_fmt->colorspace;
	143	mbus_fmt->ycbcr_enc = pix_mp_fmt->ycbcr_enc;
	144	mbus_fmt->quantization = pix_mp_fmt->quantization;
	145	mbus_fmt->xfer_func = pix_mp_fmt->xfer_func;
	146	}
	147
9a74251d	148	#endif