glamor.h 12.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * Copyright © 2008 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * Authors:
 *    Eric Anholt <eric@anholt.net>
25
 *    Zhigang Gong <zhigang.gong@linux.intel.com>
26 27
 *
 */
Eric Anholt's avatar
Eric Anholt committed
28 29 30 31

#ifndef GLAMOR_H
#define GLAMOR_H

Chris Wilson's avatar
Chris Wilson committed
32 33 34 35 36 37
#include <scrnintstr.h>
#include <pixmapstr.h>
#include <gcstruct.h>
#include <picturestr.h>
#include <fb.h>
#include <fbpict.h>
38 39 40
#ifdef GLAMOR_FOR_XORG
#include <xf86xv.h>
#endif
41

42 43
struct glamor_context;

44 45 46 47
/*
 * glamor_pixmap_type : glamor pixmap's type.
 * @MEMORY: pixmap is in memory.
 * @TEXTURE_DRM: pixmap is in a texture created from a DRM buffer.
48 49 50
 * @SEPARATE_TEXTURE: The texture is created from a DRM buffer, but
 * 		      the format is incompatible, so this type of pixmap
 * 		      will never fallback to DDX layer.
51 52 53
 * @DRM_ONLY: pixmap is in a external DRM buffer.
 * @TEXTURE_ONLY: pixmap is in an internal texture.
 */
Eric Anholt's avatar
Eric Anholt committed
54 55 56 57 58 59 60
typedef enum glamor_pixmap_type {
    GLAMOR_MEMORY,
    GLAMOR_TEXTURE_DRM,
    GLAMOR_DRM_ONLY,
    GLAMOR_TEXTURE_ONLY,
    GLAMOR_TEXTURE_LARGE,
    GLAMOR_TEXTURE_PACK
61 62
} glamor_pixmap_type_t;

63
#define GLAMOR_EGL_EXTERNAL_BUFFER 3
64 65 66
#define GLAMOR_USE_EGL_SCREEN		(1 << 0)
#define GLAMOR_NO_DRI3			(1 << 1)
#define GLAMOR_VALID_FLAGS      (GLAMOR_USE_EGL_SCREEN                \
Eric Anholt's avatar
Eric Anholt committed
67
                                 | GLAMOR_NO_DRI3)
68

69 70 71 72 73
/* @glamor_init: Initialize glamor internal data structure.
 *
 * @screen: Current screen pointer.
 * @flags:  Please refer the flags description above.
 *
74 75 76 77
 * 	@GLAMOR_USE_EGL_SCREEN:
 * 	If you are using EGL layer, then please set this bit
 * 	on, otherwise, clear it.
 *
78 79 80
 *      @GLAMOR_NO_DRI3
 *      Disable the built-in DRI3 support
 *
81 82
 * This function initializes necessary internal data structure
 * for glamor. And before calling into this function, the OpenGL
83
 * environment should be ready. Should be called before any real
84 85 86
 * glamor rendering or texture allocation functions. And should
 * be called after the DDX's screen initialization or at the last
 * step of the DDX's screen initialization.
87
 */
88 89
extern _X_EXPORT Bool glamor_init(ScreenPtr screen, unsigned int flags);
extern _X_EXPORT void glamor_fini(ScreenPtr screen);
90

91 92 93 94 95 96 97 98 99
/* This function is used to free the glamor private screen's
 * resources. If the DDX driver is not set GLAMOR_USE_SCREEN,
 * then, DDX need to call this function at proper stage, if
 * it is the xorg DDX driver,then it should be called at free
 * screen stage not the close screen stage. The reason is after
 * call to this function, the xorg DDX may need to destroy the
 * screen pixmap which must be a glamor pixmap and requires
 * the internal data structure still exist at that time.
 * Otherwise, the glamor internal structure will not be freed.*/
Zhigang Gong's avatar
Zhigang Gong committed
100
extern _X_EXPORT Bool glamor_close_screen(ScreenPtr screen);
101

102 103 104
/* Let glamor to know the screen's fbo. The low level
 * driver should already assign a tex
 * to this pixmap through the set_pixmap_texture. */
Eric Anholt's avatar
Eric Anholt committed
105 106
extern _X_EXPORT void glamor_set_screen_pixmap(PixmapPtr screen_pixmap,
                                               PixmapPtr *back_pixmap);
107

108 109
extern _X_EXPORT uint32_t glamor_get_pixmap_texture(PixmapPtr pixmap);

Zhigang Gong's avatar
Zhigang Gong committed
110 111
extern _X_EXPORT Bool glamor_glyphs_init(ScreenPtr pScreen);

112
extern _X_EXPORT void glamor_set_pixmap_texture(PixmapPtr pixmap,
Eric Anholt's avatar
Eric Anholt committed
113
                                                unsigned int tex);
114

Eric Anholt's avatar
Eric Anholt committed
115 116
extern _X_EXPORT void glamor_set_pixmap_type(PixmapPtr pixmap,
                                             glamor_pixmap_type_t type);
117
extern _X_EXPORT void glamor_destroy_textured_pixmap(PixmapPtr pixmap);
Zhigang Gong's avatar
Zhigang Gong committed
118
extern _X_EXPORT void glamor_block_handler(ScreenPtr screen);
119

Eric Anholt's avatar
Eric Anholt committed
120 121
extern _X_EXPORT PixmapPtr glamor_create_pixmap(ScreenPtr screen, int w, int h,
                                                int depth, unsigned int usage);
122
extern _X_EXPORT Bool glamor_destroy_pixmap(PixmapPtr pixmap);
123

124 125 126 127
#define GLAMOR_CREATE_PIXMAP_CPU        0x100
#define GLAMOR_CREATE_PIXMAP_FIXUP      0x101
#define GLAMOR_CREATE_FBO_NO_FBO        0x103
#define GLAMOR_CREATE_NO_LARGE          0x105
128
#define GLAMOR_CREATE_PIXMAP_NO_TEXTURE 0x106
129

Zhigang Gong's avatar
Zhigang Gong committed
130 131 132 133 134 135 136 137
/* @glamor_egl_exchange_buffers: Exchange the underlying buffers(KHR image,fbo).
 *
 * @front: front pixmap.
 * @back: back pixmap.
 *
 * Used by the DRI2 page flip. This function will exchange the KHR images and
 * fbos of the two pixmaps.
 * */
Eric Anholt's avatar
Eric Anholt committed
138 139
extern _X_EXPORT void glamor_egl_exchange_buffers(PixmapPtr front,
                                                  PixmapPtr back);
Zhigang Gong's avatar
Zhigang Gong committed
140

Eric Anholt's avatar
Eric Anholt committed
141 142
extern _X_EXPORT void glamor_pixmap_exchange_fbos(PixmapPtr front,
                                                  PixmapPtr back);
143

Axel Davy's avatar
Axel Davy committed
144 145
/* The DDX is not supposed to call these three functions */
extern _X_EXPORT void glamor_enable_dri3(ScreenPtr screen);
Eric Anholt's avatar
Eric Anholt committed
146 147 148 149 150 151 152
extern _X_EXPORT unsigned int glamor_egl_create_argb8888_based_texture(ScreenPtr
                                                                       screen,
                                                                       int w,
                                                                       int h);
extern _X_EXPORT int glamor_egl_dri3_fd_name_from_tex(ScreenPtr, PixmapPtr,
                                                      unsigned int, Bool,
                                                      CARD16 *, CARD32 *);
Axel Davy's avatar
Axel Davy committed
153

154 155
extern void glamor_egl_destroy_pixmap_image(PixmapPtr pixmap);

156 157
extern _X_EXPORT void *glamor_egl_get_gbm_device(ScreenPtr screen);

158 159 160
/* @glamor_supports_pixmap_import_export: Returns whether
 * glamor_fd_from_pixmap(), glamor_name_from_pixmap(), and
 * glamor_pixmap_from_fd() are supported.
Axel Davy's avatar
Axel Davy committed
161 162 163
 *
 * @screen: Current screen pointer.
 *
164 165 166 167 168
 * To have DRI3 support enabled, glamor and glamor_egl need to be
 * initialized. glamor also has to be compiled with gbm support.
 *
 * The EGL layer needs to have the following extensions working:
 *
Axel Davy's avatar
Axel Davy committed
169 170 171
 * .EGL_KHR_gl_texture_2D_image
 * .EGL_EXT_image_dma_buf_import
 * */
172
extern _X_EXPORT Bool glamor_supports_pixmap_import_export(ScreenPtr screen);
Axel Davy's avatar
Axel Davy committed
173

174
/* @glamor_fd_from_pixmap: Get a dma-buf fd from a pixmap.
Axel Davy's avatar
Axel Davy committed
175 176 177 178 179 180 181 182 183 184
 *
 * @screen: Current screen pointer.
 * @pixmap: The pixmap from which we want the fd.
 * @stride, @size: Pointers to fill the stride and size of the
 * 		   buffer associated to the fd.
 *
 * the pixmap and the buffer associated by the fd will share the same
 * content.
 * Returns the fd on success, -1 on error.
 * */
185 186 187
extern _X_EXPORT int glamor_fd_from_pixmap(ScreenPtr screen,
                                           PixmapPtr pixmap,
                                           CARD16 *stride, CARD32 *size);
Axel Davy's avatar
Axel Davy committed
188

189 190
/**
 * @glamor_name_from_pixmap: Gets a gem name from a pixmap.
Axel Davy's avatar
Axel Davy committed
191 192 193
 *
 * @pixmap: The pixmap from which we want the gem name.
 *
194 195 196 197 198
 * the pixmap and the buffer associated by the gem name will share the
 * same content. This function can be used by the DDX to support DRI2,
 * and needs the same set of buffer export GL extensions as DRI3
 * support.
 *
Axel Davy's avatar
Axel Davy committed
199 200
 * Returns the name on success, -1 on error.
 * */
201 202
extern _X_EXPORT int glamor_name_from_pixmap(PixmapPtr pixmap,
                                             CARD16 *stride, CARD32 *size);
Axel Davy's avatar
Axel Davy committed
203

204
/* @glamor_pixmap_from_fd: Creates a pixmap to wrap a dma-buf fd.
Axel Davy's avatar
Axel Davy committed
205 206 207 208 209 210 211 212 213 214 215
 *
 * @screen: Current screen pointer.
 * @fd: The dma-buf fd to import.
 * @width: The width of the buffer.
 * @height: The height of the buffer.
 * @stride: The stride of the buffer.
 * @depth: The depth of the buffer.
 * @bpp: The number of bpp of the buffer.
 *
 * Returns a valid pixmap if the import succeeded, else NULL.
 * */
216 217 218 219 220 221 222
extern _X_EXPORT PixmapPtr glamor_pixmap_from_fd(ScreenPtr screen,
                                                 int fd,
                                                 CARD16 width,
                                                 CARD16 height,
                                                 CARD16 stride,
                                                 CARD8 depth,
                                                 CARD8 bpp);
223

224
#ifdef GLAMOR_FOR_XORG
225 226 227

#define GLAMOR_EGL_MODULE_NAME  "glamoregl"

228 229 230 231 232
/* @glamor_egl_init: Initialize EGL environment.
 *
 * @scrn: Current screen info pointer.
 * @fd:   Current drm fd.
 *
233
 * This function creates and intialize EGL contexts.
234 235 236
 * Should be called from DDX's preInit function.
 * Return TRUE if success, otherwise return FALSE.
 * */
237
extern _X_EXPORT Bool glamor_egl_init(ScrnInfoPtr scrn, int fd);
238 239 240 241 242 243 244 245 246 247 248 249

extern _X_EXPORT Bool glamor_egl_init_textured_pixmap(ScreenPtr screen);

/* @glamor_egl_create_textured_screen: Create textured screen pixmap.
 *
 * @screen: screen pointer to be processed.
 * @handle: screen pixmap's BO handle.
 * @stride: screen pixmap's stride in bytes.
 *
 * This function is similar with the create_textured_pixmap. As the
 * screen pixmap is a special, we handle it separately in this function.
 */
Zhigang Gong's avatar
Zhigang Gong committed
250
extern _X_EXPORT Bool glamor_egl_create_textured_screen(ScreenPtr screen,
Eric Anholt's avatar
Eric Anholt committed
251
                                                        int handle, int stride);
Zhigang Gong's avatar
Zhigang Gong committed
252 253 254 255 256 257 258 259

/* @glamor_egl_create_textured_screen_ext:
 *
 * extent one parameter to track the pointer of the DDX layer's back pixmap.
 * We need this pointer during the closing screen stage. As before back to
 * the DDX's close screen, we have to free all the glamor related resources.
 */
extern _X_EXPORT Bool glamor_egl_create_textured_screen_ext(ScreenPtr screen,
Eric Anholt's avatar
Eric Anholt committed
260 261 262 263
                                                            int handle,
                                                            int stride,
                                                            PixmapPtr
                                                            *back_pixmap);
Zhigang Gong's avatar
Zhigang Gong committed
264

265 266 267
/*
 * @glamor_egl_create_textured_pixmap: Try to create a textured pixmap from
 * 				       a BO handle.
268
 *
269 270 271 272 273 274 275 276
 * @pixmap: The pixmap need to be processed.
 * @handle: The BO's handle attached to this pixmap at DDX layer.
 * @stride: Stride in bytes for this pixmap.
 *
 * This function try to create a texture from the handle and attach
 * the texture to the pixmap , thus glamor can render to this pixmap
 * as well. Return true if successful, otherwise return FALSE.
 */
Zhigang Gong's avatar
Zhigang Gong committed
277
extern _X_EXPORT Bool glamor_egl_create_textured_pixmap(PixmapPtr pixmap,
Eric Anholt's avatar
Eric Anholt committed
278
                                                        int handle, int stride);
Zhigang Gong's avatar
Zhigang Gong committed
279

280 281 282 283 284 285 286 287 288 289
/*
 * @glamor_egl_create_textured_pixmap_from_bo: Try to create a textured pixmap
 * 					       from a gbm_bo.
 *
 * @pixmap: The pixmap need to be processed.
 * @bo: a pointer on a gbm_bo structure attached to this pixmap at DDX layer.
 *
 * This function is similar to glamor_egl_create_textured_pixmap.
 */
extern _X_EXPORT Bool
Eric Anholt's avatar
Eric Anholt committed
290
 glamor_egl_create_textured_pixmap_from_gbm_bo(PixmapPtr pixmap, void *bo);
291

292
#endif
293

294 295
extern _X_EXPORT void glamor_egl_screen_init(ScreenPtr screen,
                                             struct glamor_context *glamor_ctx);
Axel Davy's avatar
Axel Davy committed
296 297
extern _X_EXPORT void glamor_egl_destroy_textured_pixmap(PixmapPtr pixmap);

Zhigang Gong's avatar
Zhigang Gong committed
298
extern _X_EXPORT int glamor_create_gc(GCPtr gc);
299

Eric Anholt's avatar
Eric Anholt committed
300 301
extern _X_EXPORT void glamor_validate_gc(GCPtr gc, unsigned long changes,
                                         DrawablePtr drawable);
302

303 304 305 306
extern _X_EXPORT void glamor_destroy_gc(GCPtr gc);

#define HAS_GLAMOR_DESTROY_GC 1

307 308 309
extern Bool _X_EXPORT glamor_change_window_attributes(WindowPtr pWin, unsigned long mask);
extern void _X_EXPORT glamor_copy_window(WindowPtr window, DDXPointRec old_origin, RegionPtr src_region);

310 311
#define HAS_GLAMOR_TEXT 1

312
#ifdef GLAMOR_FOR_XORG
Eric Anholt's avatar
Eric Anholt committed
313 314
extern _X_EXPORT XF86VideoAdaptorPtr glamor_xv_init(ScreenPtr pScreen,
                                                    int num_texture_ports);
315
#endif
Dave Airlie's avatar
Dave Airlie committed
316

Eric Anholt's avatar
Eric Anholt committed
317
#endif                          /* GLAMOR_H */