8e0321cf45a95702d40fdb024c1247f864d6a13b
[platform/upstream/libdrm.git] / exynos / fimg2d.h
1 /*
2  * Copyright (C) 2013 Samsung Electronics Co.Ltd
3  * Authors:
4  *      Inki Dae <inki.dae@samsung.com>
5  *
6  * This program is free software; you can redistribute  it and/or modify it
7  * under  the terms of  the GNU General  Public License as published by the
8  * Free Software Foundation;  either version 2 of the  License, or (at your
9  * option) any later version.
10  *
11  */
12
13 #ifndef _FIMG2D_H_
14 #define _FIMG2D_H_
15
16 #ifndef TRUE
17 #define TRUE 0
18 #endif
19 #ifndef FALSE
20 #define FALSE -1
21 #endif
22
23 #define G2D_MAX_CMD_NR          64
24 #define G2D_MAX_GEM_CMD_NR      64
25 #define G2D_MAX_CMD_LIST_NR     64
26 #define G2D_PLANE_MAX_NR        2
27
28 enum e_g2d_color_mode {
29         /* COLOR FORMAT */
30         G2D_COLOR_FMT_XRGB8888,
31         G2D_COLOR_FMT_ARGB8888,
32         G2D_COLOR_FMT_RGB565,
33         G2D_COLOR_FMT_XRGB1555,
34         G2D_COLOR_FMT_ARGB1555,
35         G2D_COLOR_FMT_XRGB4444,
36         G2D_COLOR_FMT_ARGB4444,
37         G2D_COLOR_FMT_PRGB888,
38         G2D_COLOR_FMT_YCbCr444,
39         G2D_COLOR_FMT_YCbCr422,
40         G2D_COLOR_FMT_YCbCr420,
41         /* alpha 8bit */
42         G2D_COLOR_FMT_A8,
43         /* Luminance 8bit: gray color */
44         G2D_COLOR_FMT_L8,
45         /* alpha 1bit */
46         G2D_COLOR_FMT_A1,
47         /* alpha 4bit */
48         G2D_COLOR_FMT_A4,
49         G2D_COLOR_FMT_MASK,                             /* VER4.1 */
50
51         /* COLOR ORDER */
52         G2D_ORDER_AXRGB         = (0 << 4),             /* VER4.1 */
53         G2D_ORDER_RGBAX         = (1 << 4),             /* VER4.1 */
54         G2D_ORDER_AXBGR         = (2 << 4),             /* VER4.1 */
55         G2D_ORDER_BGRAX         = (3 << 4),             /* VER4.1 */
56         G2D_ORDER_MASK          = (3 << 4),             /* VER4.1 */
57
58         /* Number of YCbCr plane */
59         G2D_YCbCr_1PLANE        = (0 << 8),             /* VER4.1 */
60         G2D_YCbCr_2PLANE        = (1 << 8),             /* VER4.1 */
61         G2D_YCbCr_PLANE_MASK    = (3 << 8),             /* VER4.1 */
62
63         /* Order in YCbCr */
64         G2D_YCbCr_ORDER_CrY1CbY0 = (0 << 12),                   /* VER4.1 */
65         G2D_YCbCr_ORDER_CbY1CrY0 = (1 << 12),                   /* VER4.1 */
66         G2D_YCbCr_ORDER_Y1CrY0Cb = (2 << 12),                   /* VER4.1 */
67         G2D_YCbCr_ORDER_Y1CbY0Cr = (3 << 12),                   /* VER4.1 */
68         G2D_YCbCr_ORDER_CrCb = G2D_YCbCr_ORDER_CrY1CbY0,        /* VER4.1 */
69         G2D_YCbCr_ORDER_CbCr = G2D_YCbCr_ORDER_CbY1CrY0,        /* VER4.1 */
70         G2D_YCbCr_ORDER_MASK = (3 < 12),                        /* VER4.1 */
71
72         /* CSC */
73         G2D_CSC_601 = (0 << 16),                /* VER4.1 */
74         G2D_CSC_709 = (1 << 16),                /* VER4.1 */
75         G2D_CSC_MASK = (1 << 16),               /* VER4.1 */
76
77         /* Valid value range of YCbCr */
78         G2D_YCbCr_RANGE_NARROW = (0 << 17),     /* VER4.1 */
79         G2D_YCbCr_RANGE_WIDE = (1 << 17),       /* VER4.1 */
80         G2D_YCbCr_RANGE_MASK = (1 << 17),       /* VER4.1 */
81
82         G2D_COLOR_MODE_MASK = 0xFFFFFFFF,
83 };
84
85 enum e_g2d_select_mode {
86         G2D_SELECT_MODE_NORMAL  = (0 << 0),
87         G2D_SELECT_MODE_FGCOLOR = (1 << 0),
88         G2D_SELECT_MODE_BGCOLOR = (2 << 0),
89 };
90
91 enum e_g2d_repeat_mode {
92         G2D_REPEAT_MODE_REPEAT,
93         G2D_REPEAT_MODE_PAD,
94         G2D_REPEAT_MODE_REFLECT,
95         G2D_REPEAT_MODE_CLAMP,
96         G2D_REPEAT_MODE_NONE,
97 };
98
99 enum e_g2d_scale_mode {
100         G2D_SCALE_MODE_NONE = 0,
101         G2D_SCALE_MODE_NEAREST,
102         G2D_SCALE_MODE_BILINEAR,
103         G2D_SCALE_MODE_MAX,
104 };
105
106 enum e_g2d_buf_type {
107         G2D_IMGBUF_COLOR,
108         G2D_IMGBUF_GEM,
109         G2D_IMGBUF_USERPTR,
110 };
111
112 enum e_g2d_rop3_type {
113         G2D_ROP3_DST = 0xAA,
114         G2D_ROP3_SRC = 0xCC,
115         G2D_ROP3_3RD = 0xF0,
116         G2D_ROP3_MASK = 0xFF,
117 };
118
119 enum e_g2d_select_alpha_src {
120         G2D_SELECT_SRC_FOR_ALPHA_BLEND, /* VER4.1 */
121         G2D_SELECT_ROP_FOR_ALPHA_BLEND, /* VER4.1 */
122 };
123
124 enum e_g2d_transparent_mode {
125         G2D_TRANSPARENT_MODE_OPAQUE,
126         G2D_TRANSPARENT_MODE_TRANSPARENT,
127         G2D_TRANSPARENT_MODE_BLUESCREEN,
128         G2D_TRANSPARENT_MODE_MAX,
129 };
130
131 enum e_g2d_color_key_mode {
132         G2D_COLORKEY_MODE_DISABLE       = 0,
133         G2D_COLORKEY_MODE_SRC_RGBA      = (1<<0),
134         G2D_COLORKEY_MODE_DST_RGBA      = (1<<1),
135         G2D_COLORKEY_MODE_SRC_YCbCr     = (1<<2),               /* VER4.1 */
136         G2D_COLORKEY_MODE_DST_YCbCr     = (1<<3),               /* VER4.1 */
137         G2D_COLORKEY_MODE_MASK          = 15,
138 };
139
140 enum e_g2d_alpha_blend_mode {
141         G2D_ALPHA_BLEND_MODE_DISABLE,
142         G2D_ALPHA_BLEND_MODE_ENABLE,
143         G2D_ALPHA_BLEND_MODE_FADING,                            /* VER3.0 */
144         G2D_ALPHA_BLEND_MODE_MAX,
145 };
146
147 enum e_g2d_op {
148         G2D_OP_CLEAR                    = 0x00,
149         G2D_OP_SRC                      = 0x01,
150         G2D_OP_DST                      = 0x02,
151         G2D_OP_OVER                     = 0x03,
152         G2D_OP_DISJOINT_CLEAR           = 0x10,
153         G2D_OP_DISJOINT_SRC             = 0x11,
154         G2D_OP_DISJOINT_DST             = 0x12,
155         G2D_OP_CONJOINT_CLEAR           = 0x20,
156         G2D_OP_CONJOINT_SRC             = 0x21,
157         G2D_OP_CONJOINT_DST             = 0x22,
158 };
159
160 enum e_g2d_coeff_mode {
161         G2D_COEFF_MODE_ONE,
162         G2D_COEFF_MODE_ZERO,
163         G2D_COEFF_MODE_SRC_ALPHA,
164         G2D_COEFF_MODE_SRC_COLOR,
165         G2D_COEFF_MODE_DST_ALPHA,
166         G2D_COEFF_MODE_DST_COLOR,
167         /* Global Alpha : Set by ALPHA_REG(0x618) */
168         G2D_COEFF_MODE_GB_ALPHA,
169         /* Global Alpha : Set by ALPHA_REG(0x618) */
170         G2D_COEFF_MODE_GB_COLOR,
171         /* (1-SRC alpha)/DST Alpha */
172         G2D_COEFF_MODE_DISJOINT_S,
173         /* (1-DST alpha)/SRC Alpha */
174         G2D_COEFF_MODE_DISJOINT_D,
175         /* SRC alpha/DST alpha */
176         G2D_COEFF_MODE_CONJOINT_S,
177         /* DST alpha/SRC alpha */
178         G2D_COEFF_MODE_CONJOINT_D,
179         /* DST alpha/SRC alpha */
180         G2D_COEFF_MODE_MASK
181 };
182
183 enum e_g2d_acoeff_mode {
184         G2D_ACOEFF_MODE_A,          /* alpha */
185         G2D_ACOEFF_MODE_APGA,   /* alpha + global alpha */
186         G2D_ACOEFF_MODE_AMGA,   /* alpha * global alpha */
187         G2D_ACOEFF_MODE_MASK
188 };
189
190 union g2d_point_val {
191         unsigned int val;
192         struct {
193                 /*
194                  * Coordinate of Source Image
195                  * Range: 0 ~ 8000 (Requirement: SrcLeftX < SrcRightX)
196                  * In YCbCr 422 and YCbCr 420 format with even number.
197                  */
198                 unsigned int x:16;
199                 /*
200                  * Y Coordinate of Source Image
201                  * Range: 0 ~ 8000 (Requirement: SrcTopY < SrcBottomY)
202                  * In YCbCr 420 format with even number.
203                  */
204                 unsigned int y:16;
205         } data;
206 };
207
208 union g2d_rop4_val {
209         unsigned int val;
210         struct {
211                 enum e_g2d_rop3_type    unmasked_rop3:8;
212                 enum e_g2d_rop3_type    masked_rop3:8;
213                 unsigned int            reserved:16;
214         } data;
215 };
216
217 union g2d_bitblt_cmd_val {
218         unsigned int val;
219         struct {
220                 /* [0:3] */
221                 unsigned int                    mask_rop4_en:1;
222                 unsigned int                    masking_en:1;
223                 enum e_g2d_select_alpha_src     rop4_alpha_en:1;
224                 unsigned int                    dither_en:1;
225                 /* [4:7] */
226                 unsigned int                    resolved1:4;
227                 /* [8:11] */
228                 unsigned int                    cw_en:4;
229                 /* [12:15] */
230                 enum e_g2d_transparent_mode     transparent_mode:4;
231                 /* [16:19] */
232                 enum e_g2d_color_key_mode       color_key_mode:4;
233                 /* [20:23] */
234                 enum e_g2d_alpha_blend_mode     alpha_blend_mode:4;
235                 /* [24:27] */
236                 unsigned int src_pre_multiply:1;
237                 unsigned int pat_pre_multiply:1;
238                 unsigned int dst_pre_multiply:1;
239                 unsigned int dst_depre_multiply:1;
240                 /* [28:31] */
241                 unsigned int fast_solid_color_fill_en:1;
242                 unsigned int reserved:3;
243         } data;
244 };
245
246 union g2d_blend_func_val {
247         unsigned int val;
248         struct {
249                 /* [0:15] */
250                 enum e_g2d_coeff_mode src_coeff:4;
251                 enum e_g2d_acoeff_mode src_coeff_src_a:2;
252                 enum e_g2d_acoeff_mode src_coeff_dst_a:2;
253                 enum e_g2d_coeff_mode dst_coeff:4;
254                 enum e_g2d_acoeff_mode dst_coeff_src_a:2;
255                 enum e_g2d_acoeff_mode dst_coeff_dst_a:2;
256                 /* [16:19] */
257                 unsigned int inv_src_color_coeff:1;
258                 unsigned int resoled1:1;
259                 unsigned int inv_dst_color_coeff:1;
260                 unsigned int resoled2:1;
261                 /* [20:23] */
262                 unsigned int lighten_en:1;
263                 unsigned int darken_en:1;
264                 unsigned int win_ce_src_over_en:2;
265                 /* [24:31] */
266                 unsigned int reserved:8;
267         } data;
268 };
269
270 struct g2d_image {
271         enum e_g2d_select_mode          select_mode;
272         enum e_g2d_color_mode           color_mode;
273         enum e_g2d_repeat_mode          repeat_mode;
274         enum e_g2d_scale_mode           scale_mode;
275         unsigned int                    xscale;
276         unsigned int                    yscale;
277         unsigned char                   rotate_90;
278         unsigned char                   x_dir;
279         unsigned char                   y_dir;
280         unsigned char                   component_alpha;
281         unsigned int                    width;
282         unsigned int                    height;
283         unsigned int                    stride;
284         unsigned int                    need_free;
285         unsigned int                    color;
286         enum e_g2d_buf_type             buf_type;
287         unsigned int                    bo[G2D_PLANE_MAX_NR];
288         struct drm_exynos_g2d_userptr   user_ptr[G2D_PLANE_MAX_NR];
289         void                            *mapped_ptr[G2D_PLANE_MAX_NR];
290 };
291
292 struct g2d_context {
293         int                             fd;
294         unsigned int                    major;
295         unsigned int                    minor;
296         struct drm_exynos_g2d_cmd       cmd[G2D_MAX_CMD_NR];
297         struct drm_exynos_g2d_cmd       cmd_buf[G2D_MAX_GEM_CMD_NR];
298         unsigned int                    cmd_nr;
299         unsigned int                    cmd_buf_nr;
300         unsigned int                    cmdlist_nr;
301 };
302
303 struct g2d_context *g2d_init(int fd);
304 void g2d_fini(struct g2d_context *ctx);
305 int g2d_exec(struct g2d_context *ctx);
306 int g2d_solid_fill(struct g2d_context *ctx, struct g2d_image *img,
307                         unsigned int x, unsigned int y, unsigned int w,
308                         unsigned int h);
309 int g2d_copy(struct g2d_context *ctx, struct g2d_image *src,
310                 struct g2d_image *dst, unsigned int src_x,
311                 unsigned int src_y, unsigned int dst_x, unsigned int dst_y,
312                 unsigned int w, unsigned int h);
313 int g2d_copy_with_scale(struct g2d_context *ctx, struct g2d_image *src,
314                                 struct g2d_image *dst, unsigned int src_x,
315                                 unsigned int src_y, unsigned int src_w,
316                                 unsigned int src_h, unsigned int dst_x,
317                                 unsigned int dst_y, unsigned int dst_w,
318                                 unsigned int dst_h, unsigned int negative);
319 int g2d_blend(struct g2d_context *ctx, struct g2d_image *src,
320                 struct g2d_image *dst, unsigned int src_x,
321                 unsigned int src_y, unsigned int dst_x, unsigned int dst_y,
322                 unsigned int w, unsigned int h, enum e_g2d_op op);
323 #endif /* _FIMG2D_H_ */