[mirror_ubuntu-bionic-kernel.git] / include / linux / 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 __LINUX_V4L2_MEDIABUS_H
#define __LINUX_V4L2_MEDIABUS_H

#include <linux/types.h>
#include <linux/videodev2.h>

/*
 * These pixel codes uniquely identify data formats on the media bus. Mostly
 * they correspond to similarly named V4L2_PIX_FMT_* formats, format 0 is
 * reserved, V4L2_MBUS_FMT_FIXED shall be used by host-client pairs, where the
 * data format is fixed. Additionally, "2X8" means that one pixel is transferred
 * in two 8-bit samples, "BE" or "LE" specify in which order those samples are
 * transferred over the bus: "LE" means that the least significant bits are
 * transferred first, "BE" means that the most significant bits are transferred
 * first, and "PADHI" and "PADLO" define which bits - low or high, in the
 * incomplete high byte, are filled with padding bits.
 *
 * The pixel codes are grouped by type, bus_width, bits per component, samples
 * per pixel and order of subsamples. Numerical values are sorted using generic
 * numerical sort order (8 thus comes before 10).
 *
 * As their value can't change when a new pixel code is inserted in the
 * enumeration, the pixel codes are explicitly given a numerical value. The next
 * free values for each category are listed below, update them when inserting
 * new pixel codes.
 */
enum v4l2_mbus_pixelcode {
	V4L2_MBUS_FMT_FIXED = 0x0001,

	/* RGB - next is 0x1009 */
	V4L2_MBUS_FMT_RGB444_2X8_PADHI_BE = 0x1001,
	V4L2_MBUS_FMT_RGB444_2X8_PADHI_LE = 0x1002,
	V4L2_MBUS_FMT_RGB555_2X8_PADHI_BE = 0x1003,
	V4L2_MBUS_FMT_RGB555_2X8_PADHI_LE = 0x1004,
	V4L2_MBUS_FMT_BGR565_2X8_BE = 0x1005,
	V4L2_MBUS_FMT_BGR565_2X8_LE = 0x1006,
	V4L2_MBUS_FMT_RGB565_2X8_BE = 0x1007,
	V4L2_MBUS_FMT_RGB565_2X8_LE = 0x1008,

	/* YUV (including grey) - next is 0x2013 */
	V4L2_MBUS_FMT_Y8_1X8 = 0x2001,
	V4L2_MBUS_FMT_UYVY8_1_5X8 = 0x2002,
	V4L2_MBUS_FMT_VYUY8_1_5X8 = 0x2003,
	V4L2_MBUS_FMT_YUYV8_1_5X8 = 0x2004,
	V4L2_MBUS_FMT_YVYU8_1_5X8 = 0x2005,
	V4L2_MBUS_FMT_UYVY8_2X8 = 0x2006,
	V4L2_MBUS_FMT_VYUY8_2X8 = 0x2007,
	V4L2_MBUS_FMT_YUYV8_2X8 = 0x2008,
	V4L2_MBUS_FMT_YVYU8_2X8 = 0x2009,
	V4L2_MBUS_FMT_Y10_1X10 = 0x200a,
	V4L2_MBUS_FMT_YUYV10_2X10 = 0x200b,
	V4L2_MBUS_FMT_YVYU10_2X10 = 0x200c,
	V4L2_MBUS_FMT_UYVY8_1X16 = 0x200f,
	V4L2_MBUS_FMT_VYUY8_1X16 = 0x2010,
	V4L2_MBUS_FMT_YUYV8_1X16 = 0x2011,
	V4L2_MBUS_FMT_YVYU8_1X16 = 0x2012,
	V4L2_MBUS_FMT_YUYV10_1X20 = 0x200d,
	V4L2_MBUS_FMT_YVYU10_1X20 = 0x200e,

	/* Bayer - next is 0x300b */
	V4L2_MBUS_FMT_SBGGR8_1X8 = 0x3001,
	V4L2_MBUS_FMT_SGRBG8_1X8 = 0x3002,
	V4L2_MBUS_FMT_SGRBG10_DPCM8_1X8 = 0x3009,
	V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_BE = 0x3003,
	V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_LE = 0x3004,
	V4L2_MBUS_FMT_SBGGR10_2X8_PADLO_BE = 0x3005,
	V4L2_MBUS_FMT_SBGGR10_2X8_PADLO_LE = 0x3006,
	V4L2_MBUS_FMT_SBGGR10_1X10 = 0x3007,
	V4L2_MBUS_FMT_SGRBG10_1X10 = 0x300a,
	V4L2_MBUS_FMT_SBGGR12_1X12 = 0x3008,
};

/**
 * struct v4l2_mbus_framefmt - frame format on the media bus
 * @width:	frame width
 * @height:	frame height
 * @code:	data format code (from enum v4l2_mbus_pixelcode)
 * @field:	used interlacing type (from enum v4l2_field)
 * @colorspace:	colorspace of the data (from enum v4l2_colorspace)
 */
struct v4l2_mbus_framefmt {
	__u32			width;
	__u32			height;
	__u32			code;
	__u32			field;
	__u32			colorspace;
	__u32			reserved[7];
};

#endif
Commit	Line	Data
2ef2d5a3 LP	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 __LINUX_V4L2_MEDIABUS_H
	12	#define __LINUX_V4L2_MEDIABUS_H
	13
	14	#include <linux/types.h>
	15	#include <linux/videodev2.h>
	16
	17	/*
	18	* These pixel codes uniquely identify data formats on the media bus. Mostly
	19	* they correspond to similarly named V4L2_PIX_FMT_* formats, format 0 is
	20	* reserved, V4L2_MBUS_FMT_FIXED shall be used by host-client pairs, where the
	21	* data format is fixed. Additionally, "2X8" means that one pixel is transferred
	22	* in two 8-bit samples, "BE" or "LE" specify in which order those samples are
	23	* transferred over the bus: "LE" means that the least significant bits are
	24	* transferred first, "BE" means that the most significant bits are transferred
	25	* first, and "PADHI" and "PADLO" define which bits - low or high, in the
	26	* incomplete high byte, are filled with padding bits.
dacdde78 LP	27	*
	28	* The pixel codes are grouped by type, bus_width, bits per component, samples
	29	* per pixel and order of subsamples. Numerical values are sorted using generic
	30	* numerical sort order (8 thus comes before 10).
	31	*
	32	* As their value can't change when a new pixel code is inserted in the
	33	* enumeration, the pixel codes are explicitly given a numerical value. The next
	34	* free values for each category are listed below, update them when inserting
	35	* new pixel codes.
2ef2d5a3 LP	36	*/
2ef2d5a3 LP	37	enum v4l2_mbus_pixelcode {
dacdde78 LP	38	V4L2_MBUS_FMT_FIXED = 0x0001,
	39
	40	/* RGB - next is 0x1009 */
	41	V4L2_MBUS_FMT_RGB444_2X8_PADHI_BE = 0x1001,
	42	V4L2_MBUS_FMT_RGB444_2X8_PADHI_LE = 0x1002,
	43	V4L2_MBUS_FMT_RGB555_2X8_PADHI_BE = 0x1003,
	44	V4L2_MBUS_FMT_RGB555_2X8_PADHI_LE = 0x1004,
	45	V4L2_MBUS_FMT_BGR565_2X8_BE = 0x1005,
	46	V4L2_MBUS_FMT_BGR565_2X8_LE = 0x1006,
	47	V4L2_MBUS_FMT_RGB565_2X8_BE = 0x1007,
	48	V4L2_MBUS_FMT_RGB565_2X8_LE = 0x1008,
	49
2d8deaf6	50	/* YUV (including grey) - next is 0x2013 */
dacdde78 LP	51	V4L2_MBUS_FMT_Y8_1X8 = 0x2001,
	52	V4L2_MBUS_FMT_UYVY8_1_5X8 = 0x2002,
	53	V4L2_MBUS_FMT_VYUY8_1_5X8 = 0x2003,
	54	V4L2_MBUS_FMT_YUYV8_1_5X8 = 0x2004,
	55	V4L2_MBUS_FMT_YVYU8_1_5X8 = 0x2005,
	56	V4L2_MBUS_FMT_UYVY8_2X8 = 0x2006,
	57	V4L2_MBUS_FMT_VYUY8_2X8 = 0x2007,
	58	V4L2_MBUS_FMT_YUYV8_2X8 = 0x2008,
	59	V4L2_MBUS_FMT_YVYU8_2X8 = 0x2009,
	60	V4L2_MBUS_FMT_Y10_1X10 = 0x200a,
	61	V4L2_MBUS_FMT_YUYV10_2X10 = 0x200b,
	62	V4L2_MBUS_FMT_YVYU10_2X10 = 0x200c,
2d8deaf6 LP	63	V4L2_MBUS_FMT_UYVY8_1X16 = 0x200f,
	64	V4L2_MBUS_FMT_VYUY8_1X16 = 0x2010,
	65	V4L2_MBUS_FMT_YUYV8_1X16 = 0x2011,
	66	V4L2_MBUS_FMT_YVYU8_1X16 = 0x2012,
dacdde78 LP	67	V4L2_MBUS_FMT_YUYV10_1X20 = 0x200d,
	68	V4L2_MBUS_FMT_YVYU10_1X20 = 0x200e,
	69
2d8deaf6	70	/* Bayer - next is 0x300b */
dacdde78 LP	71	V4L2_MBUS_FMT_SBGGR8_1X8 = 0x3001,
dacdde78 LP	72	V4L2_MBUS_FMT_SGRBG8_1X8 = 0x3002,
2d8deaf6	73	V4L2_MBUS_FMT_SGRBG10_DPCM8_1X8 = 0x3009,
dacdde78 LP	74	V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_BE = 0x3003,
	75	V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_LE = 0x3004,
	76	V4L2_MBUS_FMT_SBGGR10_2X8_PADLO_BE = 0x3005,
	77	V4L2_MBUS_FMT_SBGGR10_2X8_PADLO_LE = 0x3006,
	78	V4L2_MBUS_FMT_SBGGR10_1X10 = 0x3007,
2d8deaf6	79	V4L2_MBUS_FMT_SGRBG10_1X10 = 0x300a,
dacdde78	80	V4L2_MBUS_FMT_SBGGR12_1X12 = 0x3008,
2ef2d5a3 LP	81	};
	82
	83	/**
	84	* struct v4l2_mbus_framefmt - frame format on the media bus
	85	* @width: frame width
	86	* @height: frame height
84d0688d LP	87	* @code: data format code (from enum v4l2_mbus_pixelcode)
	88	* @field: used interlacing type (from enum v4l2_field)
	89	* @colorspace: colorspace of the data (from enum v4l2_colorspace)
2ef2d5a3 LP	90	*/
2ef2d5a3 LP	91	struct v4l2_mbus_framefmt {
84d0688d LP	92	__u32 width;
	93	__u32 height;
	94	__u32 code;
	95	__u32 field;
	96	__u32 colorspace;
	97	__u32 reserved[7];
2ef2d5a3 LP	98	};
	99
	100	#endif