src/egl/drivers/dri2/egl_dri2.h

   1 /*
   2  * Copyright © 2011 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  19  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  20  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  * Authors:
  25  *    Kristian Høgsberg <krh@bitplanet.net>
  26  */
  27
  28 #ifndef EGL_DRI2_INCLUDED
  29 #define EGL_DRI2_INCLUDED
  30
  31 #include <stdint.h>
  32
  33 #ifdef HAVE_X11_PLATFORM
  34 #include <xcb/xcb.h>
  35 #include <xcb/dri2.h>
  36 #include <xcb/xfixes.h>
  37 #include <X11/Xlib-xcb.h>
  38
  39 #ifdef HAVE_DRI3
  40 #include "loader_dri3_helper.h"
  41 #endif
  42 #endif
  43
  44 #ifdef HAVE_WAYLAND_PLATFORM
  45 #include <wayland-client.h>
  46 #include "wayland-egl-priv.h"
  47 #endif
  48
  49 #include <GL/gl.h>
  50 #include <GL/internal/dri_interface.h>
  51
  52 #ifdef HAVE_DRM_PLATFORM
  53 #include <gbm_driint.h>
  54 #endif
  55
  56 #ifdef HAVE_ANDROID_PLATFORM
  57 #define LOG_TAG "EGL-DRI2"
  58
  59 #include <system/window.h>
  60 #include <hardware/gralloc.h>
  61 #include <gralloc_drm_handle.h>
  62
  63 #endif /* HAVE_ANDROID_PLATFORM */
  64
  65 #include "eglconfig.h"
  66 #include "eglcontext.h"
  67 #include "egldisplay.h"
  68 #include "egldriver.h"
  69 #include "eglcurrent.h"
  70 #include "egllog.h"
  71 #include "eglsurface.h"
  72 #include "eglimage.h"
  73 #include "eglsync.h"
  74
  75 struct wl_buffer;
  76
  77 struct dri2_egl_driver
  78 {
  79    _EGLDriver base;
  80
  81    void *handle;
  82    _EGLProc (*get_proc_address)(const char *procname);
  83    void (*glFlush)(void);
  84 };
  85
  86 struct dri2_egl_display_vtbl {
  87    int (*authenticate)(_EGLDisplay *disp, uint32_t id);
  88
  89    _EGLSurface* (*create_window_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
  90                                          _EGLConfig *config,
  91                                          void *native_window,
  92                                          const EGLint *attrib_list);
  93
  94    _EGLSurface* (*create_pixmap_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
  95                                          _EGLConfig *config,
  96                                          void *native_pixmap,
  97                                          const EGLint *attrib_list);
  98
  99    _EGLSurface* (*create_pbuffer_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
 100                                           _EGLConfig *config,
 101                                           const EGLint *attrib_list);
 102
 103    EGLBoolean (*destroy_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
 104                                  _EGLSurface *surface);
 105
 106    EGLBoolean (*swap_interval)(_EGLDriver *drv, _EGLDisplay *dpy,
 107                                _EGLSurface *surf, EGLint interval);
 108
 109    _EGLImage* (*create_image)(_EGLDriver *drv, _EGLDisplay *dpy,
 110                               _EGLContext *ctx, EGLenum target,
 111                               EGLClientBuffer buffer,
 112                               const EGLint *attr_list);
 113
 114    EGLBoolean (*swap_buffers)(_EGLDriver *drv, _EGLDisplay *dpy,
 115                               _EGLSurface *surf);
 116
 117    EGLBoolean (*swap_buffers_with_damage)(_EGLDriver *drv, _EGLDisplay *dpy,
 118                                           _EGLSurface *surface,
 119                                           const EGLint *rects, EGLint n_rects);
 120
 121    EGLBoolean (*set_damage_region)(_EGLDriver *drv, _EGLDisplay *dpy,
 122                                    _EGLSurface *surface,
 123                                    const EGLint *rects, EGLint n_rects);
 124
 125    EGLBoolean (*swap_buffers_region)(_EGLDriver *drv, _EGLDisplay *dpy,
 126                                      _EGLSurface *surf, EGLint numRects,
 127                                      const EGLint *rects);
 128
 129    EGLBoolean (*post_sub_buffer)(_EGLDriver *drv, _EGLDisplay *dpy,
 130                                  _EGLSurface *surf,
 131                                  EGLint x, EGLint y,
 132                                  EGLint width, EGLint height);
 133
 134    EGLBoolean (*copy_buffers)(_EGLDriver *drv, _EGLDisplay *dpy,
 135                               _EGLSurface *surf, void *native_pixmap_target);
 136
 137    EGLint (*query_buffer_age)(_EGLDriver *drv, _EGLDisplay *dpy,
 138                               _EGLSurface *surf);
 139
 140    EGLBoolean (*query_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
 141                                _EGLSurface *surf, EGLint attribute,
 142                                EGLint *value);
 143
 144    struct wl_buffer* (*create_wayland_buffer_from_image)(
 145                         _EGLDriver *drv, _EGLDisplay *dpy, _EGLImage *img);
 146
 147    EGLBoolean (*get_sync_values)(_EGLDisplay *display, _EGLSurface *surface,
 148                                  EGLuint64KHR *ust, EGLuint64KHR *msc,
 149                                  EGLuint64KHR *sbc);
 150
 151    __DRIdrawable *(*get_dri_drawable)(_EGLSurface *surf);
 152 };
 153
 154 struct dri2_egl_display
 155 {
 156    const struct dri2_egl_display_vtbl *vtbl;
 157
 158    int                       dri2_major;
 159    int                       dri2_minor;
 160    __DRIscreen              *dri_screen;
 161    int                       own_dri_screen;
 162    const __DRIconfig       **driver_configs;
 163    void                     *driver;
 164    const __DRIcoreExtension       *core;
 165    const __DRIimageDriverExtension *image_driver;
 166    const __DRIdri2Extension       *dri2;
 167    const __DRIswrastExtension     *swrast;
 168    const __DRI2flushExtension     *flush;
 169    const __DRItexBufferExtension  *tex_buffer;
 170    const __DRIimageExtension      *image;
 171    const __DRIrobustnessExtension *robustness;
 172    const __DRI2configQueryExtension *config;
 173    const __DRI2fenceExtension *fence;
 174    const __DRI2rendererQueryExtension *rendererQuery;
 175    const __DRI2interopExtension *interop;
 176    int                       fd;
 177
 178    /* dri2_initialize/dri2_terminate increment/decrement this count, so does
 179     * dri2_make_current (tracks if there are active contexts/surfaces). */
 180    int                       ref_count;
 181
 182    int                       own_device;
 183    int                       invalidate_available;
 184    int                       min_swap_interval;
 185    int                       max_swap_interval;
 186    int                       default_swap_interval;
 187 #ifdef HAVE_DRM_PLATFORM
 188    struct gbm_dri_device    *gbm_dri;
 189 #endif
 190
 191    char                     *driver_name;
 192
 193    const __DRIextension    **loader_extensions;
 194    const __DRIextension    **driver_extensions;
 195
 196 #ifdef HAVE_X11_PLATFORM
 197    xcb_connection_t         *conn;
 198    xcb_screen_t             *screen;
 199    int                      swap_available;
 200 #ifdef HAVE_DRI3
 201    struct loader_dri3_extensions loader_dri3_ext;
 202 #endif
 203 #endif
 204
 205 #ifdef HAVE_WAYLAND_PLATFORM
 206    struct wl_display        *wl_dpy;
 207    struct wl_display        *wl_dpy_wrapper;
 208    struct wl_registry       *wl_registry;
 209    struct wl_drm            *wl_server_drm;
 210    struct wl_drm            *wl_drm;
 211    struct wl_shm            *wl_shm;
 212    struct wl_event_queue    *wl_queue;
 213    int                       authenticated;
 214    int                       formats;
 215    uint32_t                  capabilities;
 216    char                     *device_name;
 217 #endif
 218
 219 #ifdef HAVE_ANDROID_PLATFORM
 220    const gralloc_module_t *gralloc;
 221 #endif
 222
 223    int                       is_render_node;
 224    int                       is_different_gpu;
 225 };
 226
 227 struct dri2_egl_context
 228 {
 229    _EGLContext   base;
 230    __DRIcontext *dri_context;
 231 };
 232
 233 #ifdef HAVE_WAYLAND_PLATFORM
 234 enum wayland_buffer_type {
 235    WL_BUFFER_FRONT,
 236    WL_BUFFER_BACK,
 237    WL_BUFFER_THIRD,
 238    WL_BUFFER_COUNT
 239 };
 240 #endif
 241
 242 struct dri2_egl_surface
 243 {
 244    _EGLSurface          base;
 245    __DRIdrawable       *dri_drawable;
 246    __DRIbuffer          buffers[5];
 247    int                  buffer_count;
 248    int                  have_fake_front;
 249
 250 #ifdef HAVE_X11_PLATFORM
 251    xcb_drawable_t       drawable;
 252    xcb_xfixes_region_t  region;
 253    int                  depth;
 254    int                  bytes_per_pixel;
 255    xcb_gcontext_t       gc;
 256    xcb_gcontext_t       swapgc;
 257 #endif
 258
 259 #ifdef HAVE_WAYLAND_PLATFORM
 260    struct wl_egl_window  *wl_win;
 261    int                    dx;
 262    int                    dy;
 263    struct wl_event_queue *wl_queue;
 264    struct wl_surface     *wl_surface_wrapper;
 265    struct wl_display     *wl_dpy_wrapper;
 266    struct wl_drm         *wl_drm_wrapper;
 267    struct wl_callback    *throttle_callback;
 268    int                    format;
 269 #endif
 270
 271 #ifdef HAVE_DRM_PLATFORM
 272    struct gbm_dri_surface *gbm_surf;
 273 #endif
 274
 275 #if defined(HAVE_WAYLAND_PLATFORM) || defined(HAVE_DRM_PLATFORM)
 276    __DRIbuffer           *dri_buffers[__DRI_BUFFER_COUNT];
 277    struct {
 278 #ifdef HAVE_WAYLAND_PLATFORM
 279       struct wl_buffer   *wl_buffer;
 280       __DRIimage         *dri_image;
 281       /* for is_different_gpu case. NULL else */
 282       __DRIimage         *linear_copy;
 283       /* for swrast */
 284       void *data;
 285       int data_size;
 286 #endif
 287 #ifdef HAVE_DRM_PLATFORM
 288       struct gbm_bo       *bo;
 289 #endif
 290       int                 locked;
 291       int                 age;
 292    } color_buffers[4], *back, *current;
 293 #endif
 294
 295 #ifdef HAVE_ANDROID_PLATFORM
 296    struct ANativeWindow *window;
 297    struct ANativeWindowBuffer *buffer;
 298    __DRIimage *dri_image_back;
 299    __DRIimage *dri_image_front;
 300
 301    /* EGL-owned buffers */
 302    __DRIbuffer           *local_buffers[__DRI_BUFFER_COUNT];
 303
 304    /* Used to record all the buffers created by ANativeWindow and their ages.
 305     * Usually Android uses at most triple buffers in ANativeWindow
 306     * so hardcode the number of color_buffers to 3.
 307     */
 308    struct {
 309       struct ANativeWindowBuffer *buffer;
 310       int age;
 311    } color_buffers[3], *back;
 312 #endif
 313
 314 #if defined(HAVE_SURFACELESS_PLATFORM)
 315       __DRIimage           *front;
 316       unsigned int         visual;
 317 #endif
 318 };
 319
 320 struct dri2_egl_config
 321 {
 322    _EGLConfig         base;
 323    const __DRIconfig *dri_single_config[2];
 324    const __DRIconfig *dri_double_config[2];
 325 };
 326
 327 struct dri2_egl_image
 328 {
 329    _EGLImage   base;
 330    __DRIimage *dri_image;
 331 };
 332
 333 struct dri2_egl_sync {
 334    _EGLSync base;
 335    mtx_t mutex;
 336    cnd_t cond;
 337    int refcount;
 338    void *fence;
 339 };
 340
 341 /* From xmlpool/options.h, user exposed so should be stable */
 342 #define DRI_CONF_VBLANK_NEVER 0
 343 #define DRI_CONF_VBLANK_DEF_INTERVAL_0 1
 344 #define DRI_CONF_VBLANK_DEF_INTERVAL_1 2
 345 #define DRI_CONF_VBLANK_ALWAYS_SYNC 3
 346
 347 /* standard typecasts */
 348 _EGL_DRIVER_STANDARD_TYPECASTS(dri2_egl)
 349 _EGL_DRIVER_TYPECAST(dri2_egl_image, _EGLImage, obj)
 350 _EGL_DRIVER_TYPECAST(dri2_egl_sync, _EGLSync, obj)
 351
 352 extern const __DRIimageLookupExtension image_lookup_extension;
 353 extern const __DRIuseInvalidateExtension use_invalidate;
 354 extern const __DRIbackgroundCallableExtension background_callable_extension;
 355
 356 EGLBoolean
 357 dri2_load_driver(_EGLDisplay *disp);
 358
 359 /* Helper for platforms not using dri2_create_screen */
 360 void
 361 dri2_setup_screen(_EGLDisplay *disp);
 362
 363 EGLBoolean
 364 dri2_load_driver_swrast(_EGLDisplay *disp);
 365
 366 EGLBoolean
 367 dri2_load_driver_dri3(_EGLDisplay *disp);
 368
 369 EGLBoolean
 370 dri2_create_screen(_EGLDisplay *disp);
 371
 372 EGLBoolean
 373 dri2_setup_extensions(_EGLDisplay *disp);
 374
 375 __DRIdrawable *
 376 dri2_surface_get_dri_drawable(_EGLSurface *surf);
 377
 378 __DRIimage *
 379 dri2_lookup_egl_image(__DRIscreen *screen, void *image, void *data);
 380
 381 struct dri2_egl_config *
 382 dri2_add_config(_EGLDisplay *disp, const __DRIconfig *dri_config, int id,
 383                 EGLint surface_type, const EGLint *attr_list,
 384                 const unsigned int *rgba_masks);
 385
 386 _EGLImage *
 387 dri2_create_image_khr(_EGLDriver *drv, _EGLDisplay *disp,
 388                       _EGLContext *ctx, EGLenum target,
 389                       EGLClientBuffer buffer, const EGLint *attr_list);
 390
 391 _EGLImage *
 392 dri2_create_image_dma_buf(_EGLDisplay *disp, _EGLContext *ctx,
 393                           EGLClientBuffer buffer, const EGLint *attr_list);
 394
 395 EGLBoolean
 396 dri2_initialize_x11(_EGLDriver *drv, _EGLDisplay *disp);
 397
 398 EGLBoolean
 399 dri2_initialize_drm(_EGLDriver *drv, _EGLDisplay *disp);
 400
 401 EGLBoolean
 402 dri2_initialize_wayland(_EGLDriver *drv, _EGLDisplay *disp);
 403
 404 EGLBoolean
 405 dri2_initialize_android(_EGLDriver *drv, _EGLDisplay *disp);
 406
 407 EGLBoolean
 408 dri2_initialize_surfaceless(_EGLDriver *drv, _EGLDisplay *disp);
 409
 410 void
 411 dri2_flush_drawable_for_swapbuffers(_EGLDisplay *disp, _EGLSurface *draw);
 412
 413 const __DRIconfig *
 414 dri2_get_dri_config(struct dri2_egl_config *conf, EGLint surface_type,
 415                     EGLenum colorspace);
 416
 417 static inline void
 418 dri2_set_WL_bind_wayland_display(_EGLDriver *drv, _EGLDisplay *disp)
 419 {
 420 #ifdef HAVE_WAYLAND_PLATFORM
 421    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 422
 423    (void) drv;
 424
 425    if (dri2_dpy->device_name && dri2_dpy->image) {
 426        if (dri2_dpy->image->base.version >= 10 &&
 427            dri2_dpy->image->getCapabilities != NULL) {
 428            int capabilities;
 429
 430            capabilities =
 431                dri2_dpy->image->getCapabilities(dri2_dpy->dri_screen);
 432            disp->Extensions.WL_bind_wayland_display =
 433                (capabilities & __DRI_IMAGE_CAP_GLOBAL_NAMES) != 0;
 434        } else {
 435            disp->Extensions.WL_bind_wayland_display = EGL_TRUE;
 436        }
 437    }
 438 #endif
 439 }
 440
 441 void
 442 dri2_display_destroy(_EGLDisplay *disp);
 443
 444 #endif /* EGL_DRI2_INCLUDED */