]>
Commit | Line | Data |
---|---|---|
b18787ed HV |
1 | /* |
2 | * v4l2-dv-timings - Internal header with dv-timings helper functions | |
3 | * | |
4 | * Copyright 2013 Cisco Systems, Inc. and/or its affiliates. All rights reserved. | |
5 | * | |
6 | * This program is free software; you may redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation; version 2 of the License. | |
9 | * | |
10 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | |
11 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | |
12 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | |
13 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS | |
14 | * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN | |
15 | * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | |
16 | * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
17 | * SOFTWARE. | |
18 | * | |
19 | */ | |
20 | ||
21 | #ifndef __V4L2_DV_TIMINGS_H | |
22 | #define __V4L2_DV_TIMINGS_H | |
23 | ||
24 | #include <linux/videodev2.h> | |
25 | ||
506bb54b MCC |
26 | /** |
27 | * v4l2_dv_timings_presets: list of all dv_timings presets. | |
d1c65ad6 HV |
28 | */ |
29 | extern const struct v4l2_dv_timings v4l2_dv_timings_presets[]; | |
30 | ||
506bb54b MCC |
31 | /** |
32 | * v4l2_check_dv_timings_fnc - timings check callback | |
33 | * | |
b8f0fff4 HV |
34 | * @t: the v4l2_dv_timings struct. |
35 | * @handle: a handle from the driver. | |
36 | * | |
37 | * Returns true if the given timings are valid. | |
38 | */ | |
39 | typedef bool v4l2_check_dv_timings_fnc(const struct v4l2_dv_timings *t, void *handle); | |
40 | ||
506bb54b MCC |
41 | /** |
42 | * v4l2_valid_dv_timings() - are these timings valid? | |
43 | * | |
44 | * @t: the v4l2_dv_timings struct. | |
45 | * @cap: the v4l2_dv_timings_cap capabilities. | |
46 | * @fnc: callback to check if this timing is OK. May be NULL. | |
47 | * @fnc_handle: a handle that is passed on to @fnc. | |
48 | * | |
49 | * Returns true if the given dv_timings struct is supported by the | |
50 | * hardware capabilities and the callback function (if non-NULL), returns | |
51 | * false otherwise. | |
52 | */ | |
70b65494 | 53 | bool v4l2_valid_dv_timings(const struct v4l2_dv_timings *t, |
b8f0fff4 HV |
54 | const struct v4l2_dv_timings_cap *cap, |
55 | v4l2_check_dv_timings_fnc fnc, | |
56 | void *fnc_handle); | |
b18787ed | 57 | |
506bb54b MCC |
58 | /** |
59 | * v4l2_enum_dv_timings_cap() - Helper function to enumerate possible DV | |
60 | * timings based on capabilities | |
61 | * | |
62 | * @t: the v4l2_enum_dv_timings struct. | |
63 | * @cap: the v4l2_dv_timings_cap capabilities. | |
64 | * @fnc: callback to check if this timing is OK. May be NULL. | |
65 | * @fnc_handle: a handle that is passed on to @fnc. | |
66 | * | |
67 | * This enumerates dv_timings using the full list of possible CEA-861 and DMT | |
68 | * timings, filtering out any timings that are not supported based on the | |
69 | * hardware capabilities and the callback function (if non-NULL). | |
70 | * | |
71 | * If a valid timing for the given index is found, it will fill in @t and | |
72 | * return 0, otherwise it returns -EINVAL. | |
73 | */ | |
b18787ed | 74 | int v4l2_enum_dv_timings_cap(struct v4l2_enum_dv_timings *t, |
b8f0fff4 HV |
75 | const struct v4l2_dv_timings_cap *cap, |
76 | v4l2_check_dv_timings_fnc fnc, | |
77 | void *fnc_handle); | |
b18787ed | 78 | |
506bb54b MCC |
79 | /** |
80 | * v4l2_find_dv_timings_cap() - Find the closest timings struct | |
81 | * | |
82 | * @t: the v4l2_enum_dv_timings struct. | |
83 | * @cap: the v4l2_dv_timings_cap capabilities. | |
84 | * @pclock_delta: maximum delta between t->pixelclock and the timing struct | |
85 | * under consideration. | |
86 | * @fnc: callback to check if a given timings struct is OK. May be NULL. | |
87 | * @fnc_handle: a handle that is passed on to @fnc. | |
88 | * | |
89 | * This function tries to map the given timings to an entry in the | |
90 | * full list of possible CEA-861 and DMT timings, filtering out any timings | |
91 | * that are not supported based on the hardware capabilities and the callback | |
92 | * function (if non-NULL). | |
93 | * | |
94 | * On success it will fill in @t with the found timings and it returns true. | |
95 | * On failure it will return false. | |
96 | */ | |
b18787ed HV |
97 | bool v4l2_find_dv_timings_cap(struct v4l2_dv_timings *t, |
98 | const struct v4l2_dv_timings_cap *cap, | |
b8f0fff4 HV |
99 | unsigned pclock_delta, |
100 | v4l2_check_dv_timings_fnc fnc, | |
101 | void *fnc_handle); | |
b18787ed | 102 | |
506bb54b MCC |
103 | /** |
104 | * v4l2_match_dv_timings() - do two timings match? | |
105 | * | |
106 | * @measured: the measured timings data. | |
107 | * @standard: the timings according to the standard. | |
108 | * @pclock_delta: maximum delta in Hz between standard->pixelclock and | |
109 | * the measured timings. | |
110 | * | |
111 | * Returns true if the two timings match, returns false otherwise. | |
112 | */ | |
ef1ed8f5 HV |
113 | bool v4l2_match_dv_timings(const struct v4l2_dv_timings *measured, |
114 | const struct v4l2_dv_timings *standard, | |
115 | unsigned pclock_delta); | |
25764158 | 116 | |
506bb54b MCC |
117 | /** |
118 | * v4l2_print_dv_timings() - log the contents of a dv_timings struct | |
119 | * @dev_prefix:device prefix for each log line. | |
120 | * @prefix: additional prefix for each log line, may be NULL. | |
121 | * @t: the timings data. | |
122 | * @detailed: if true, give a detailed log. | |
123 | */ | |
0216dc2f HV |
124 | void v4l2_print_dv_timings(const char *dev_prefix, const char *prefix, |
125 | const struct v4l2_dv_timings *t, bool detailed); | |
126 | ||
506bb54b MCC |
127 | /** |
128 | * v4l2_detect_cvt - detect if the given timings follow the CVT standard | |
129 | * | |
25764158 HV |
130 | * @frame_height - the total height of the frame (including blanking) in lines. |
131 | * @hfreq - the horizontal frequency in Hz. | |
132 | * @vsync - the height of the vertical sync in lines. | |
5fea1bb7 PL |
133 | * @active_width - active width of image (does not include blanking). This |
134 | * information is needed only in case of version 2 of reduced blanking. | |
135 | * In other cases, this parameter does not have any effect on timings. | |
25764158 HV |
136 | * @polarities - the horizontal and vertical polarities (same as struct |
137 | * v4l2_bt_timings polarities). | |
061ddda6 | 138 | * @interlaced - if this flag is true, it indicates interlaced format |
25764158 HV |
139 | * @fmt - the resulting timings. |
140 | * | |
141 | * This function will attempt to detect if the given values correspond to a | |
142 | * valid CVT format. If so, then it will return true, and fmt will be filled | |
143 | * in with the found CVT timings. | |
144 | */ | |
145 | bool v4l2_detect_cvt(unsigned frame_height, unsigned hfreq, unsigned vsync, | |
5fea1bb7 PL |
146 | unsigned active_width, u32 polarities, bool interlaced, |
147 | struct v4l2_dv_timings *fmt); | |
25764158 | 148 | |
506bb54b MCC |
149 | /** |
150 | * v4l2_detect_gtf - detect if the given timings follow the GTF standard | |
151 | * | |
25764158 HV |
152 | * @frame_height - the total height of the frame (including blanking) in lines. |
153 | * @hfreq - the horizontal frequency in Hz. | |
154 | * @vsync - the height of the vertical sync in lines. | |
155 | * @polarities - the horizontal and vertical polarities (same as struct | |
156 | * v4l2_bt_timings polarities). | |
061ddda6 | 157 | * @interlaced - if this flag is true, it indicates interlaced format |
25764158 HV |
158 | * @aspect - preferred aspect ratio. GTF has no method of determining the |
159 | * aspect ratio in order to derive the image width from the | |
160 | * image height, so it has to be passed explicitly. Usually | |
161 | * the native screen aspect ratio is used for this. If it | |
162 | * is not filled in correctly, then 16:9 will be assumed. | |
163 | * @fmt - the resulting timings. | |
164 | * | |
165 | * This function will attempt to detect if the given values correspond to a | |
166 | * valid GTF format. If so, then it will return true, and fmt will be filled | |
167 | * in with the found GTF timings. | |
168 | */ | |
169 | bool v4l2_detect_gtf(unsigned frame_height, unsigned hfreq, unsigned vsync, | |
061ddda6 | 170 | u32 polarities, bool interlaced, struct v4l2_fract aspect, |
25764158 HV |
171 | struct v4l2_dv_timings *fmt); |
172 | ||
506bb54b MCC |
173 | /** |
174 | * v4l2_calc_aspect_ratio - calculate the aspect ratio based on bytes | |
25764158 | 175 | * 0x15 and 0x16 from the EDID. |
506bb54b | 176 | * |
25764158 HV |
177 | * @hor_landscape - byte 0x15 from the EDID. |
178 | * @vert_portrait - byte 0x16 from the EDID. | |
179 | * | |
180 | * Determines the aspect ratio from the EDID. | |
181 | * See VESA Enhanced EDID standard, release A, rev 2, section 3.6.2: | |
182 | * "Horizontal and Vertical Screen Size or Aspect Ratio" | |
183 | */ | |
184 | struct v4l2_fract v4l2_calc_aspect_ratio(u8 hor_landscape, u8 vert_portrait); | |
185 | ||
b18787ed | 186 | #endif |