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 #if ANDROID_VERSION >= 0x0400
  60 #  include <system/window.h>
  61 #else
  62 #  define android_native_buffer_t ANativeWindowBuffer
  63 #  include <ui/egl/android_natives.h>
  64 #  include <ui/android_native_buffer.h>
  65 #endif
  66
  67 #include <hardware/gralloc.h>
  68 #include <gralloc_drm_handle.h>
  69 #include <cutils/log.h>
  70
  71 #endif /* HAVE_ANDROID_PLATFORM */
  72
  73 #include "eglconfig.h"
  74 #include "eglcontext.h"
  75 #include "egldisplay.h"
  76 #include "egldriver.h"
  77 #include "eglcurrent.h"
  78 #include "egllog.h"
  79 #include "eglsurface.h"
  80 #include "eglimage.h"
  81 #include "eglsync.h"
  82
  83 struct wl_buffer;
  84
  85 struct dri2_egl_driver
  86 {
  87    _EGLDriver base;
  88
  89    void *handle;
  90    _EGLProc (*get_proc_address)(const char *procname);
  91    void (*glFlush)(void);
  92 };
  93
  94 struct dri2_egl_display_vtbl {
  95    int (*authenticate)(_EGLDisplay *disp, uint32_t id);
  96
  97    _EGLSurface* (*create_window_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
  98                                          _EGLConfig *config,
  99                                          void *native_window,
 100                                          const EGLint *attrib_list);
 101
 102    _EGLSurface* (*create_pixmap_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
 103                                          _EGLConfig *config,
 104                                          void *native_pixmap,
 105                                          const EGLint *attrib_list);
 106
 107    _EGLSurface* (*create_pbuffer_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
 108                                           _EGLConfig *config,
 109                                           const EGLint *attrib_list);
 110
 111    EGLBoolean (*destroy_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
 112                                  _EGLSurface *surface);
 113
 114    EGLBoolean (*swap_interval)(_EGLDriver *drv, _EGLDisplay *dpy,
 115                                _EGLSurface *surf, EGLint interval);
 116
 117    _EGLImage* (*create_image)(_EGLDriver *drv, _EGLDisplay *dpy,
 118                               _EGLContext *ctx, EGLenum target,
 119                               EGLClientBuffer buffer,
 120                               const EGLint *attr_list);
 121
 122    EGLBoolean (*swap_buffers)(_EGLDriver *drv, _EGLDisplay *dpy,
 123                               _EGLSurface *surf);
 124
 125    EGLBoolean (*swap_buffers_with_damage)(_EGLDriver *drv, _EGLDisplay *dpy,
 126                                           _EGLSurface *surface,
 127                                           const EGLint *rects, EGLint n_rects);
 128
 129    EGLBoolean (*swap_buffers_region)(_EGLDriver *drv, _EGLDisplay *dpy,
 130                                      _EGLSurface *surf, EGLint numRects,
 131                                      const EGLint *rects);
 132
 133    EGLBoolean (*post_sub_buffer)(_EGLDriver *drv, _EGLDisplay *dpy,
 134                                  _EGLSurface *surf,
 135                                  EGLint x, EGLint y,
 136                                  EGLint width, EGLint height);
 137
 138    EGLBoolean (*copy_buffers)(_EGLDriver *drv, _EGLDisplay *dpy,
 139                               _EGLSurface *surf, void *native_pixmap_target);
 140
 141    EGLint (*query_buffer_age)(_EGLDriver *drv, _EGLDisplay *dpy,
 142                               _EGLSurface *surf);
 143
 144    EGLBoolean (*query_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
 145                                _EGLSurface *surf, EGLint attribute,
 146                                EGLint *value);
 147
 148    struct wl_buffer* (*create_wayland_buffer_from_image)(
 149                         _EGLDriver *drv, _EGLDisplay *dpy, _EGLImage *img);
 150
 151    EGLBoolean (*get_sync_values)(_EGLDisplay *display, _EGLSurface *surface,
 152                                  EGLuint64KHR *ust, EGLuint64KHR *msc,
 153                                  EGLuint64KHR *sbc);
 154
 155    __DRIdrawable *(*get_dri_drawable)(_EGLSurface *surf);
 156 };
 157
 158 struct dri2_egl_display
 159 {
 160    const struct dri2_egl_display_vtbl *vtbl;
 161
 162    int                       dri2_major;
 163    int                       dri2_minor;
 164    __DRIscreen              *dri_screen;
 165    int                       own_dri_screen;
 166    const __DRIconfig       **driver_configs;
 167    void                     *driver;
 168    const __DRIcoreExtension       *core;
 169    const __DRIimageDriverExtension *image_driver;
 170    const __DRIdri2Extension       *dri2;
 171    const __DRIswrastExtension     *swrast;
 172    const __DRI2flushExtension     *flush;
 173    const __DRItexBufferExtension  *tex_buffer;
 174    const __DRIimageExtension      *image;
 175    const __DRIrobustnessExtension *robustness;
 176    const __DRI2configQueryExtension *config;
 177    const __DRI2fenceExtension *fence;
 178    const __DRI2rendererQueryExtension *rendererQuery;
 179    const __DRI2interopExtension *interop;
 180    int                       fd;
 181
 182    /* dri2_initialize/dri2_terminate increment/decrement this count, so does
 183     * dri2_make_current (tracks if there are active contexts/surfaces). */
 184    int                       ref_count;
 185
 186    int                       own_device;
 187    int                       invalidate_available;
 188    int                       min_swap_interval;
 189    int                       max_swap_interval;
 190    int                       default_swap_interval;
 191 #ifdef HAVE_DRM_PLATFORM
 192    struct gbm_dri_device    *gbm_dri;
 193 #endif
 194
 195    char                     *driver_name;
 196
 197    const __DRIextension    **loader_extensions;
 198    const __DRIextension    **driver_extensions;
 199
 200 #ifdef HAVE_X11_PLATFORM
 201    xcb_connection_t         *conn;
 202    xcb_screen_t             *screen;
 203    int                      swap_available;
 204 #ifdef HAVE_DRI3
 205    struct loader_dri3_extensions loader_dri3_ext;
 206 #endif
 207 #endif
 208
 209 #ifdef HAVE_WAYLAND_PLATFORM
 210    struct wl_display        *wl_dpy;
 211    struct wl_display        *wl_dpy_wrapper;
 212    struct wl_registry       *wl_registry;
 213    struct wl_drm            *wl_server_drm;
 214    struct wl_drm            *wl_drm;
 215    struct wl_shm            *wl_shm;
 216    struct wl_event_queue    *wl_queue;
 217    int                       authenticated;
 218    int                       formats;
 219    uint32_t                  capabilities;
 220    char                     *device_name;
 221 #endif
 222
 223 #ifdef HAVE_ANDROID_PLATFORM
 224    const gralloc_module_t *gralloc;
 225 #endif
 226
 227    int                       is_render_node;
 228    int                       is_different_gpu;
 229 };
 230
 231 struct dri2_egl_context
 232 {
 233    _EGLContext   base;
 234    __DRIcontext *dri_context;
 235 };
 236
 237 #ifdef HAVE_WAYLAND_PLATFORM
 238 enum wayland_buffer_type {
 239    WL_BUFFER_FRONT,
 240    WL_BUFFER_BACK,
 241    WL_BUFFER_THIRD,
 242    WL_BUFFER_COUNT
 243 };
 244 #endif
 245
 246 struct dri2_egl_surface
 247 {
 248    _EGLSurface          base;
 249    __DRIdrawable       *dri_drawable;
 250    __DRIbuffer          buffers[5];
 251    int                  buffer_count;
 252    int                  have_fake_front;
 253
 254 #ifdef HAVE_X11_PLATFORM
 255    xcb_drawable_t       drawable;
 256    xcb_xfixes_region_t  region;
 257    int                  depth;
 258    int                  bytes_per_pixel;
 259    xcb_gcontext_t       gc;
 260    xcb_gcontext_t       swapgc;
 261 #endif
 262
 263 #ifdef HAVE_WAYLAND_PLATFORM
 264    struct wl_egl_window  *wl_win;
 265    int                    dx;
 266    int                    dy;
 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 __DRIdrawable *
 373 dri2_surface_get_dri_drawable(_EGLSurface *surf);
 374
 375 __DRIimage *
 376 dri2_lookup_egl_image(__DRIscreen *screen, void *image, void *data);
 377
 378 struct dri2_egl_config *
 379 dri2_add_config(_EGLDisplay *disp, const __DRIconfig *dri_config, int id,
 380                 EGLint surface_type, const EGLint *attr_list,
 381                 const unsigned int *rgba_masks);
 382
 383 _EGLImage *
 384 dri2_create_image_khr(_EGLDriver *drv, _EGLDisplay *disp,
 385                       _EGLContext *ctx, EGLenum target,
 386                       EGLClientBuffer buffer, const EGLint *attr_list);
 387
 388 _EGLImage *
 389 dri2_create_image_dma_buf(_EGLDisplay *disp, _EGLContext *ctx,
 390                           EGLClientBuffer buffer, const EGLint *attr_list);
 391
 392 EGLBoolean
 393 dri2_initialize_x11(_EGLDriver *drv, _EGLDisplay *disp);
 394
 395 EGLBoolean
 396 dri2_initialize_drm(_EGLDriver *drv, _EGLDisplay *disp);
 397
 398 EGLBoolean
 399 dri2_initialize_wayland(_EGLDriver *drv, _EGLDisplay *disp);
 400
 401 EGLBoolean
 402 dri2_initialize_android(_EGLDriver *drv, _EGLDisplay *disp);
 403
 404 EGLBoolean
 405 dri2_initialize_surfaceless(_EGLDriver *drv, _EGLDisplay *disp);
 406
 407 void
 408 dri2_flush_drawable_for_swapbuffers(_EGLDisplay *disp, _EGLSurface *draw);
 409
 410 const __DRIconfig *
 411 dri2_get_dri_config(struct dri2_egl_config *conf, EGLint surface_type,
 412                     EGLenum colorspace);
 413
 414 static inline void
 415 dri2_set_WL_bind_wayland_display(_EGLDriver *drv, _EGLDisplay *disp)
 416 {
 417 #ifdef HAVE_WAYLAND_PLATFORM
 418    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 419
 420    (void) drv;
 421
 422    if (dri2_dpy->device_name && dri2_dpy->image) {
 423        if (dri2_dpy->image->base.version >= 10 &&
 424            dri2_dpy->image->getCapabilities != NULL) {
 425            int capabilities;
 426
 427            capabilities =
 428                dri2_dpy->image->getCapabilities(dri2_dpy->dri_screen);
 429            disp->Extensions.WL_bind_wayland_display =
 430                (capabilities & __DRI_IMAGE_CAP_GLOBAL_NAMES) != 0;
 431        } else {
 432            disp->Extensions.WL_bind_wayland_display = EGL_TRUE;
 433        }
 434    }
 435 #endif
 436 }
 437
 438 #endif /* EGL_DRI2_INCLUDED */