7054a7a8065ec20689853e85f784efda5b857e27
[linux-2.6.git] / include / linux / v4l2-mediabus.h
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.
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.
36  */
37 enum v4l2_mbus_pixelcode {
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
50         /* YUV (including grey) - next is 0x2013 */
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,
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,
67         V4L2_MBUS_FMT_YUYV10_1X20 = 0x200d,
68         V4L2_MBUS_FMT_YVYU10_1X20 = 0x200e,
69
70         /* Bayer - next is 0x3013 */
71         V4L2_MBUS_FMT_SBGGR8_1X8 = 0x3001,
72         V4L2_MBUS_FMT_SGRBG8_1X8 = 0x3002,
73         V4L2_MBUS_FMT_SBGGR10_DPCM8_1X8 = 0x300b,
74         V4L2_MBUS_FMT_SGBRG10_DPCM8_1X8 = 0x300c,
75         V4L2_MBUS_FMT_SGRBG10_DPCM8_1X8 = 0x3009,
76         V4L2_MBUS_FMT_SRGGB10_DPCM8_1X8 = 0x300d,
77         V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_BE = 0x3003,
78         V4L2_MBUS_FMT_SBGGR10_2X8_PADHI_LE = 0x3004,
79         V4L2_MBUS_FMT_SBGGR10_2X8_PADLO_BE = 0x3005,
80         V4L2_MBUS_FMT_SBGGR10_2X8_PADLO_LE = 0x3006,
81         V4L2_MBUS_FMT_SBGGR10_1X10 = 0x3007,
82         V4L2_MBUS_FMT_SGBRG10_1X10 = 0x300e,
83         V4L2_MBUS_FMT_SGRBG10_1X10 = 0x300a,
84         V4L2_MBUS_FMT_SRGGB10_1X10 = 0x300f,
85         V4L2_MBUS_FMT_SBGGR12_1X12 = 0x3008,
86         V4L2_MBUS_FMT_SGBRG12_1X12 = 0x3010,
87         V4L2_MBUS_FMT_SGRBG12_1X12 = 0x3011,
88         V4L2_MBUS_FMT_SRGGB12_1X12 = 0x3012,
89 };
90
91 /**
92  * struct v4l2_mbus_framefmt - frame format on the media bus
93  * @width:      frame width
94  * @height:     frame height
95  * @code:       data format code (from enum v4l2_mbus_pixelcode)
96  * @field:      used interlacing type (from enum v4l2_field)
97  * @colorspace: colorspace of the data (from enum v4l2_colorspace)
98  */
99 struct v4l2_mbus_framefmt {
100         __u32                   width;
101         __u32                   height;
102         __u32                   code;
103         __u32                   field;
104         __u32                   colorspace;
105         __u32                   reserved[7];
106 };
107
108 #endif