Add a copy of V4L2 kernel headers
[media-ctl.git] / src / linux / v4l2-subdev.h
1 /*
2  * V4L2 subdev userspace API
3  *
4  * Copyright (C) 2010 Nokia Corporation
5  *
6  * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
7  *           Sakari Ailus <sakari.ailus@iki.fi>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License version 2 as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef __LINUX_V4L2_SUBDEV_H
24 #define __LINUX_V4L2_SUBDEV_H
25
26 #include <linux/ioctl.h>
27 #include <linux/types.h>
28 #include <linux/v4l2-common.h>
29 #include <linux/v4l2-mediabus.h>
30
31 /**
32  * enum v4l2_subdev_format_whence - Media bus format type
33  * @V4L2_SUBDEV_FORMAT_TRY: try format, for negotiation only
34  * @V4L2_SUBDEV_FORMAT_ACTIVE: active format, applied to the device
35  */
36 enum v4l2_subdev_format_whence {
37         V4L2_SUBDEV_FORMAT_TRY = 0,
38         V4L2_SUBDEV_FORMAT_ACTIVE = 1,
39 };
40
41 /**
42  * struct v4l2_subdev_format - Pad-level media bus format
43  * @which: format type (from enum v4l2_subdev_format_whence)
44  * @pad: pad number, as reported by the media API
45  * @format: media bus format (format code and frame size)
46  */
47 struct v4l2_subdev_format {
48         __u32 which;
49         __u32 pad;
50         struct v4l2_mbus_framefmt format;
51         __u32 reserved[8];
52 };
53
54 /**
55  * struct v4l2_subdev_crop - Pad-level crop settings
56  * @which: format type (from enum v4l2_subdev_format_whence)
57  * @pad: pad number, as reported by the media API
58  * @rect: pad crop rectangle boundaries
59  */
60 struct v4l2_subdev_crop {
61         __u32 which;
62         __u32 pad;
63         struct v4l2_rect rect;
64         __u32 reserved[8];
65 };
66
67 /**
68  * struct v4l2_subdev_mbus_code_enum - Media bus format enumeration
69  * @pad: pad number, as reported by the media API
70  * @index: format index during enumeration
71  * @code: format code (from enum v4l2_mbus_pixelcode)
72  */
73 struct v4l2_subdev_mbus_code_enum {
74         __u32 pad;
75         __u32 index;
76         __u32 code;
77         __u32 reserved[9];
78 };
79
80 /**
81  * struct v4l2_subdev_frame_size_enum - Media bus format enumeration
82  * @pad: pad number, as reported by the media API
83  * @index: format index during enumeration
84  * @code: format code (from enum v4l2_mbus_pixelcode)
85  */
86 struct v4l2_subdev_frame_size_enum {
87         __u32 index;
88         __u32 pad;
89         __u32 code;
90         __u32 min_width;
91         __u32 max_width;
92         __u32 min_height;
93         __u32 max_height;
94         __u32 reserved[9];
95 };
96
97 /**
98  * struct v4l2_subdev_frame_interval - Pad-level frame rate
99  * @pad: pad number, as reported by the media API
100  * @interval: frame interval in seconds
101  */
102 struct v4l2_subdev_frame_interval {
103         __u32 pad;
104         struct v4l2_fract interval;
105         __u32 reserved[9];
106 };
107
108 /**
109  * struct v4l2_subdev_frame_interval_enum - Frame interval enumeration
110  * @pad: pad number, as reported by the media API
111  * @index: frame interval index during enumeration
112  * @code: format code (from enum v4l2_mbus_pixelcode)
113  * @width: frame width in pixels
114  * @height: frame height in pixels
115  * @interval: frame interval in seconds
116  */
117 struct v4l2_subdev_frame_interval_enum {
118         __u32 index;
119         __u32 pad;
120         __u32 code;
121         __u32 width;
122         __u32 height;
123         struct v4l2_fract interval;
124         __u32 reserved[9];
125 };
126
127 /**
128  * struct v4l2_subdev_selection - selection info
129  *
130  * @which: either V4L2_SUBDEV_FORMAT_ACTIVE or V4L2_SUBDEV_FORMAT_TRY
131  * @pad: pad number, as reported by the media API
132  * @target: Selection target, used to choose one of possible rectangles,
133  *          defined in v4l2-common.h; V4L2_SEL_TGT_* .
134  * @flags: constraint flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
135  * @r: coordinates of the selection window
136  * @reserved: for future use, set to zero for now
137  *
138  * Hardware may use multiple helper windows to process a video stream.
139  * The structure is used to exchange this selection areas between
140  * an application and a driver.
141  */
142 struct v4l2_subdev_selection {
143         __u32 which;
144         __u32 pad;
145         __u32 target;
146         __u32 flags;
147         struct v4l2_rect r;
148         __u32 reserved[8];
149 };
150
151 #define VIDIOC_SUBDEV_G_FMT     _IOWR('V',  4, struct v4l2_subdev_format)
152 #define VIDIOC_SUBDEV_S_FMT     _IOWR('V',  5, struct v4l2_subdev_format)
153 #define VIDIOC_SUBDEV_G_FRAME_INTERVAL \
154                         _IOWR('V', 21, struct v4l2_subdev_frame_interval)
155 #define VIDIOC_SUBDEV_S_FRAME_INTERVAL \
156                         _IOWR('V', 22, struct v4l2_subdev_frame_interval)
157 #define VIDIOC_SUBDEV_ENUM_MBUS_CODE \
158                         _IOWR('V',  2, struct v4l2_subdev_mbus_code_enum)
159 #define VIDIOC_SUBDEV_ENUM_FRAME_SIZE \
160                         _IOWR('V', 74, struct v4l2_subdev_frame_size_enum)
161 #define VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL \
162                         _IOWR('V', 75, struct v4l2_subdev_frame_interval_enum)
163 #define VIDIOC_SUBDEV_G_CROP    _IOWR('V', 59, struct v4l2_subdev_crop)
164 #define VIDIOC_SUBDEV_S_CROP    _IOWR('V', 60, struct v4l2_subdev_crop)
165 #define VIDIOC_SUBDEV_G_SELECTION \
166         _IOWR('V', 61, struct v4l2_subdev_selection)
167 #define VIDIOC_SUBDEV_S_SELECTION \
168         _IOWR('V', 62, struct v4l2_subdev_selection)
169
170 #endif