1 /* 1 /*
2 * Copyright (C) 2011-2013 Intel Corporation 2 * Copyright (C) 2011-2013 Intel Corporation
3 * 3 *
4 * Permission is hereby granted, free of charg 4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated docume 5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction 6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, pub 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to 8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to 9 * Software is furnished to do so, subject to the following conditions:
10 * 10 *
11 * The above copyright notice and this permiss 11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies 12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software. 13 * Software.
14 * 14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT W 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE W 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINF 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE 18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT 19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE O 20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE. 21 * SOFTWARE.
22 */ 22 */
23 23
24 #ifndef DRM_RECT_H 24 #ifndef DRM_RECT_H
25 #define DRM_RECT_H 25 #define DRM_RECT_H
26 26
27 #include <linux/types.h> <<
28 <<
29 /** 27 /**
30 * DOC: rect utils 28 * DOC: rect utils
31 * 29 *
32 * Utility functions to help manage rectangula 30 * Utility functions to help manage rectangular areas for
33 * clipping, scaling, etc. calculations. 31 * clipping, scaling, etc. calculations.
34 */ 32 */
35 33
36 /** 34 /**
37 * struct drm_rect - two dimensional rectangle 35 * struct drm_rect - two dimensional rectangle
38 * @x1: horizontal starting coordinate (inclus 36 * @x1: horizontal starting coordinate (inclusive)
39 * @x2: horizontal ending coordinate (exclusiv 37 * @x2: horizontal ending coordinate (exclusive)
40 * @y1: vertical starting coordinate (inclusiv 38 * @y1: vertical starting coordinate (inclusive)
41 * @y2: vertical ending coordinate (exclusive) 39 * @y2: vertical ending coordinate (exclusive)
42 * <<
43 * Note that this must match the layout of str <<
44 * helpers like drm_atomic_helper_damage_iter_ <<
45 */ 40 */
46 struct drm_rect { 41 struct drm_rect {
47 int x1, y1, x2, y2; 42 int x1, y1, x2, y2;
48 }; 43 };
49 44
50 /** 45 /**
51 * DRM_RECT_INIT - initialize a rectangle from <<
52 * @x: x coordinate <<
53 * @y: y coordinate <<
54 * @w: width <<
55 * @h: height <<
56 * <<
57 * RETURNS: <<
58 * A new rectangle of the specified size. <<
59 */ <<
60 #define DRM_RECT_INIT(x, y, w, h) ((struct drm <<
61 .x1 = (x), \ <<
62 .y1 = (y), \ <<
63 .x2 = (x) + (w), \ <<
64 .y2 = (y) + (h) }) <<
65 <<
66 /** <<
67 * DRM_RECT_FMT - printf string for &struct dr 46 * DRM_RECT_FMT - printf string for &struct drm_rect
68 */ 47 */
69 #define DRM_RECT_FMT "%dx%d%+d%+d" 48 #define DRM_RECT_FMT "%dx%d%+d%+d"
70 /** 49 /**
71 * DRM_RECT_ARG - printf arguments for &struct 50 * DRM_RECT_ARG - printf arguments for &struct drm_rect
72 * @r: rectangle struct 51 * @r: rectangle struct
73 */ 52 */
74 #define DRM_RECT_ARG(r) drm_rect_width(r), drm 53 #define DRM_RECT_ARG(r) drm_rect_width(r), drm_rect_height(r), (r)->x1, (r)->y1
75 54
76 /** 55 /**
77 * DRM_RECT_FP_FMT - printf string for &struct 56 * DRM_RECT_FP_FMT - printf string for &struct drm_rect in 16.16 fixed point
78 */ 57 */
79 #define DRM_RECT_FP_FMT "%d.%06ux%d.%06u%+d.%0 58 #define DRM_RECT_FP_FMT "%d.%06ux%d.%06u%+d.%06u%+d.%06u"
80 /** 59 /**
81 * DRM_RECT_FP_ARG - printf arguments for &str 60 * DRM_RECT_FP_ARG - printf arguments for &struct drm_rect in 16.16 fixed point
82 * @r: rectangle struct 61 * @r: rectangle struct
83 * 62 *
84 * This is useful for e.g. printing plane sour 63 * This is useful for e.g. printing plane source rectangles, which are in 16.16
85 * fixed point. 64 * fixed point.
86 */ 65 */
87 #define DRM_RECT_FP_ARG(r) \ 66 #define DRM_RECT_FP_ARG(r) \
88 drm_rect_width(r) >> 16, ((drm 67 drm_rect_width(r) >> 16, ((drm_rect_width(r) & 0xffff) * 15625) >> 10, \
89 drm_rect_height(r) >> 16, ((dr 68 drm_rect_height(r) >> 16, ((drm_rect_height(r) & 0xffff) * 15625) >> 10, \
90 (r)->x1 >> 16, (((r)->x1 & 0xf 69 (r)->x1 >> 16, (((r)->x1 & 0xffff) * 15625) >> 10, \
91 (r)->y1 >> 16, (((r)->y1 & 0xf 70 (r)->y1 >> 16, (((r)->y1 & 0xffff) * 15625) >> 10
92 71
93 /** 72 /**
94 * drm_rect_init - initialize the rectangle fr 73 * drm_rect_init - initialize the rectangle from x/y/w/h
95 * @r: rectangle 74 * @r: rectangle
96 * @x: x coordinate 75 * @x: x coordinate
97 * @y: y coordinate 76 * @y: y coordinate
98 * @width: width 77 * @width: width
99 * @height: height 78 * @height: height
100 */ 79 */
101 static inline void drm_rect_init(struct drm_re 80 static inline void drm_rect_init(struct drm_rect *r, int x, int y,
102 int width, in 81 int width, int height)
103 { 82 {
104 r->x1 = x; 83 r->x1 = x;
105 r->y1 = y; 84 r->y1 = y;
106 r->x2 = x + width; 85 r->x2 = x + width;
107 r->y2 = y + height; 86 r->y2 = y + height;
108 } 87 }
109 88
110 /** 89 /**
111 * drm_rect_adjust_size - adjust the size of t 90 * drm_rect_adjust_size - adjust the size of the rectangle
112 * @r: rectangle to be adjusted 91 * @r: rectangle to be adjusted
113 * @dw: horizontal adjustment 92 * @dw: horizontal adjustment
114 * @dh: vertical adjustment 93 * @dh: vertical adjustment
115 * 94 *
116 * Change the size of rectangle @r by @dw in t 95 * Change the size of rectangle @r by @dw in the horizontal direction,
117 * and by @dh in the vertical direction, while 96 * and by @dh in the vertical direction, while keeping the center
118 * of @r stationary. 97 * of @r stationary.
119 * 98 *
120 * Positive @dw and @dh increase the size, neg 99 * Positive @dw and @dh increase the size, negative values decrease it.
121 */ 100 */
122 static inline void drm_rect_adjust_size(struct 101 static inline void drm_rect_adjust_size(struct drm_rect *r, int dw, int dh)
123 { 102 {
124 r->x1 -= dw >> 1; 103 r->x1 -= dw >> 1;
125 r->y1 -= dh >> 1; 104 r->y1 -= dh >> 1;
126 r->x2 += (dw + 1) >> 1; 105 r->x2 += (dw + 1) >> 1;
127 r->y2 += (dh + 1) >> 1; 106 r->y2 += (dh + 1) >> 1;
128 } 107 }
129 108
130 /** 109 /**
131 * drm_rect_translate - translate the rectangl 110 * drm_rect_translate - translate the rectangle
132 * @r: rectangle to be translated !! 111 * @r: rectangle to be tranlated
133 * @dx: horizontal translation 112 * @dx: horizontal translation
134 * @dy: vertical translation 113 * @dy: vertical translation
135 * 114 *
136 * Move rectangle @r by @dx in the horizontal 115 * Move rectangle @r by @dx in the horizontal direction,
137 * and by @dy in the vertical direction. 116 * and by @dy in the vertical direction.
138 */ 117 */
139 static inline void drm_rect_translate(struct d 118 static inline void drm_rect_translate(struct drm_rect *r, int dx, int dy)
140 { 119 {
141 r->x1 += dx; 120 r->x1 += dx;
142 r->y1 += dy; 121 r->y1 += dy;
143 r->x2 += dx; 122 r->x2 += dx;
144 r->y2 += dy; 123 r->y2 += dy;
145 } 124 }
146 125
147 /** 126 /**
148 * drm_rect_translate_to - translate the recta 127 * drm_rect_translate_to - translate the rectangle to an absolute position
149 * @r: rectangle to be translated !! 128 * @r: rectangle to be tranlated
150 * @x: horizontal position 129 * @x: horizontal position
151 * @y: vertical position 130 * @y: vertical position
152 * 131 *
153 * Move rectangle @r to @x in the horizontal d 132 * Move rectangle @r to @x in the horizontal direction,
154 * and to @y in the vertical direction. 133 * and to @y in the vertical direction.
155 */ 134 */
156 static inline void drm_rect_translate_to(struc 135 static inline void drm_rect_translate_to(struct drm_rect *r, int x, int y)
157 { 136 {
158 drm_rect_translate(r, x - r->x1, y - r 137 drm_rect_translate(r, x - r->x1, y - r->y1);
159 } 138 }
160 139
161 /** 140 /**
162 * drm_rect_downscale - downscale a rectangle 141 * drm_rect_downscale - downscale a rectangle
163 * @r: rectangle to be downscaled 142 * @r: rectangle to be downscaled
164 * @horz: horizontal downscale factor 143 * @horz: horizontal downscale factor
165 * @vert: vertical downscale factor 144 * @vert: vertical downscale factor
166 * 145 *
167 * Divide the coordinates of rectangle @r by @ 146 * Divide the coordinates of rectangle @r by @horz and @vert.
168 */ 147 */
169 static inline void drm_rect_downscale(struct d 148 static inline void drm_rect_downscale(struct drm_rect *r, int horz, int vert)
170 { 149 {
171 r->x1 /= horz; 150 r->x1 /= horz;
172 r->y1 /= vert; 151 r->y1 /= vert;
173 r->x2 /= horz; 152 r->x2 /= horz;
174 r->y2 /= vert; 153 r->y2 /= vert;
175 } 154 }
176 155
177 /** 156 /**
178 * drm_rect_width - determine the rectangle wi 157 * drm_rect_width - determine the rectangle width
179 * @r: rectangle whose width is returned 158 * @r: rectangle whose width is returned
180 * 159 *
181 * RETURNS: 160 * RETURNS:
182 * The width of the rectangle. 161 * The width of the rectangle.
183 */ 162 */
184 static inline int drm_rect_width(const struct 163 static inline int drm_rect_width(const struct drm_rect *r)
185 { 164 {
186 return r->x2 - r->x1; 165 return r->x2 - r->x1;
187 } 166 }
188 167
189 /** 168 /**
190 * drm_rect_height - determine the rectangle h 169 * drm_rect_height - determine the rectangle height
191 * @r: rectangle whose height is returned 170 * @r: rectangle whose height is returned
192 * 171 *
193 * RETURNS: 172 * RETURNS:
194 * The height of the rectangle. 173 * The height of the rectangle.
195 */ 174 */
196 static inline int drm_rect_height(const struct 175 static inline int drm_rect_height(const struct drm_rect *r)
197 { 176 {
198 return r->y2 - r->y1; 177 return r->y2 - r->y1;
199 } 178 }
200 179
201 /** 180 /**
202 * drm_rect_visible - determine if the rectang !! 181 * drm_rect_visible - determine if the the rectangle is visible
203 * @r: rectangle whose visibility is returned 182 * @r: rectangle whose visibility is returned
204 * 183 *
205 * RETURNS: 184 * RETURNS:
206 * %true if the rectangle is visible, %false o 185 * %true if the rectangle is visible, %false otherwise.
207 */ 186 */
208 static inline bool drm_rect_visible(const stru 187 static inline bool drm_rect_visible(const struct drm_rect *r)
209 { 188 {
210 return drm_rect_width(r) > 0 && drm_re 189 return drm_rect_width(r) > 0 && drm_rect_height(r) > 0;
211 } 190 }
212 191
213 /** 192 /**
214 * drm_rect_equals - determine if two rectangl 193 * drm_rect_equals - determine if two rectangles are equal
215 * @r1: first rectangle 194 * @r1: first rectangle
216 * @r2: second rectangle 195 * @r2: second rectangle
217 * 196 *
218 * RETURNS: 197 * RETURNS:
219 * %true if the rectangles are equal, %false o 198 * %true if the rectangles are equal, %false otherwise.
220 */ 199 */
221 static inline bool drm_rect_equals(const struc 200 static inline bool drm_rect_equals(const struct drm_rect *r1,
222 const struc 201 const struct drm_rect *r2)
223 { 202 {
224 return r1->x1 == r2->x1 && r1->x2 == r 203 return r1->x1 == r2->x1 && r1->x2 == r2->x2 &&
225 r1->y1 == r2->y1 && r1->y2 == 204 r1->y1 == r2->y1 && r1->y2 == r2->y2;
226 } <<
227 <<
228 /** <<
229 * drm_rect_fp_to_int - Convert a rect in 16.1 <<
230 * @dst: rect to be stored the converted value <<
231 * @src: rect in 16.16 fixed point form <<
232 */ <<
233 static inline void drm_rect_fp_to_int(struct d <<
234 const st <<
235 { <<
236 drm_rect_init(dst, src->x1 >> 16, src- <<
237 drm_rect_width(src) >> 1 <<
238 drm_rect_height(src) >> <<
239 } <<
240 <<
241 /** <<
242 * drm_rect_overlap - Check if two rectangles <<
243 * @a: first rectangle <<
244 * @b: second rectangle <<
245 * <<
246 * RETURNS: <<
247 * %true if the rectangles overlap, %false oth <<
248 */ <<
249 static inline bool drm_rect_overlap(const stru <<
250 const stru <<
251 { <<
252 return (a->x2 > b->x1 && b->x2 > a->x1 <<
253 a->y2 > b->y1 && b->y2 > a->y1 <<
254 } 205 }
255 206
256 bool drm_rect_intersect(struct drm_rect *r, co 207 bool drm_rect_intersect(struct drm_rect *r, const struct drm_rect *clip);
257 bool drm_rect_clip_scaled(struct drm_rect *src 208 bool drm_rect_clip_scaled(struct drm_rect *src, struct drm_rect *dst,
258 const struct drm_rec 209 const struct drm_rect *clip);
259 int drm_rect_calc_hscale(const struct drm_rect 210 int drm_rect_calc_hscale(const struct drm_rect *src,
260 const struct drm_rect 211 const struct drm_rect *dst,
261 int min_hscale, int m 212 int min_hscale, int max_hscale);
262 int drm_rect_calc_vscale(const struct drm_rect 213 int drm_rect_calc_vscale(const struct drm_rect *src,
263 const struct drm_rect 214 const struct drm_rect *dst,
264 int min_vscale, int m 215 int min_vscale, int max_vscale);
265 void drm_rect_debug_print(const char *prefix, 216 void drm_rect_debug_print(const char *prefix,
266 const struct drm_rec 217 const struct drm_rect *r, bool fixed_point);
267 void drm_rect_rotate(struct drm_rect *r, 218 void drm_rect_rotate(struct drm_rect *r,
268 int width, int height, 219 int width, int height,
269 unsigned int rotation); 220 unsigned int rotation);
270 void drm_rect_rotate_inv(struct drm_rect *r, 221 void drm_rect_rotate_inv(struct drm_rect *r,
271 int width, int height 222 int width, int height,
272 unsigned int rotation 223 unsigned int rotation);
273 224
274 #endif 225 #endif
275 226
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.