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 (*swap_buffers_region)(_EGLDriver *drv, _EGLDisplay *dpy,
 122                                      _EGLSurface *surf, EGLint numRects,
 123                                      const EGLint *rects);
 124
 125    EGLBoolean (*post_sub_buffer)(_EGLDriver *drv, _EGLDisplay *dpy,
 126                                  _EGLSurface *surf,
 127                                  EGLint x, EGLint y,
 128                                  EGLint width, EGLint height);
 129
 130    EGLBoolean (*copy_buffers)(_EGLDriver *drv, _EGLDisplay *dpy,
 131                               _EGLSurface *surf, void *native_pixmap_target);
 132
 133    EGLint (*query_buffer_age)(_EGLDriver *drv, _EGLDisplay *dpy,
 134                               _EGLSurface *surf);
 135
 136    EGLBoolean (*query_surface)(_EGLDriver *drv, _EGLDisplay *dpy,
 137                                _EGLSurface *surf, EGLint attribute,
 138                                EGLint *value);
 139
 140    struct wl_buffer* (*create_wayland_buffer_from_image)(
 141                         _EGLDriver *drv, _EGLDisplay *dpy, _EGLImage *img);
 142
 143    EGLBoolean (*get_sync_values)(_EGLDisplay *display, _EGLSurface *surface,
 144                                  EGLuint64KHR *ust, EGLuint64KHR *msc,
 145                                  EGLuint64KHR *sbc);
 146
 147    __DRIdrawable *(*get_dri_drawable)(_EGLSurface *surf);
 148 };
 149
 150 struct dri2_egl_display
 151 {
 152    const struct dri2_egl_display_vtbl *vtbl;
 153
 154    int                       dri2_major;
 155    int                       dri2_minor;
 156    __DRIscreen              *dri_screen;
 157    int                       own_dri_screen;
 158    const __DRIconfig       **driver_configs;
 159    void                     *driver;
 160    const __DRIcoreExtension       *core;
 161    const __DRIimageDriverExtension *image_driver;
 162    const __DRIdri2Extension       *dri2;
 163    const __DRIswrastExtension     *swrast;
 164    const __DRI2flushExtension     *flush;
 165    const __DRItexBufferExtension  *tex_buffer;
 166    const __DRIimageExtension      *image;
 167    const __DRIrobustnessExtension *robustness;
 168    const __DRI2configQueryExtension *config;
 169    const __DRI2fenceExtension *fence;
 170    const __DRI2rendererQueryExtension *rendererQuery;
 171    const __DRI2interopExtension *interop;
 172    int                       fd;
 173
 174    /* dri2_initialize/dri2_terminate increment/decrement this count, so does
 175     * dri2_make_current (tracks if there are active contexts/surfaces). */
 176    int                       ref_count;
 177
 178    int                       own_device;
 179    int                       invalidate_available;
 180    int                       min_swap_interval;
 181    int                       max_swap_interval;
 182    int                       default_swap_interval;
 183 #ifdef HAVE_DRM_PLATFORM
 184    struct gbm_dri_device    *gbm_dri;
 185 #endif
 186
 187    char                     *driver_name;
 188
 189    const __DRIextension    **loader_extensions;
 190    const __DRIextension    **driver_extensions;
 191
 192 #ifdef HAVE_X11_PLATFORM
 193    xcb_connection_t         *conn;
 194    xcb_screen_t             *screen;
 195    int                      swap_available;
 196 #ifdef HAVE_DRI3
 197    struct loader_dri3_extensions loader_dri3_ext;
 198 #endif
 199 #endif
 200
 201 #ifdef HAVE_WAYLAND_PLATFORM
 202    struct wl_display        *wl_dpy;
 203    struct wl_display        *wl_dpy_wrapper;
 204    struct wl_registry       *wl_registry;
 205    struct wl_drm            *wl_server_drm;
 206    struct wl_drm            *wl_drm;
 207    struct wl_shm            *wl_shm;
 208    struct wl_event_queue    *wl_queue;
 209    int                       authenticated;
 210    int                       formats;
 211    uint32_t                  capabilities;
 212    char                     *device_name;
 213 #endif
 214
 215 #ifdef HAVE_ANDROID_PLATFORM
 216    const gralloc_module_t *gralloc;
 217 #endif
 218
 219    int                       is_render_node;
 220    int                       is_different_gpu;
 221 };
 222
 223 struct dri2_egl_context
 224 {
 225    _EGLContext   base;
 226    __DRIcontext *dri_context;
 227 };
 228
 229 #ifdef HAVE_WAYLAND_PLATFORM
 230 enum wayland_buffer_type {
 231    WL_BUFFER_FRONT,
 232    WL_BUFFER_BACK,
 233    WL_BUFFER_THIRD,
 234    WL_BUFFER_COUNT
 235 };
 236 #endif
 237
 238 struct dri2_egl_surface
 239 {
 240    _EGLSurface          base;
 241    __DRIdrawable       *dri_drawable;
 242    __DRIbuffer          buffers[5];
 243    int                  buffer_count;
 244    int                  have_fake_front;
 245
 246 #ifdef HAVE_X11_PLATFORM
 247    xcb_drawable_t       drawable;
 248    xcb_xfixes_region_t  region;
 249    int                  depth;
 250    int                  bytes_per_pixel;
 251    xcb_gcontext_t       gc;
 252    xcb_gcontext_t       swapgc;
 253 #endif
 254
 255 #ifdef HAVE_WAYLAND_PLATFORM
 256    struct wl_egl_window  *wl_win;
 257    int                    dx;
 258    int                    dy;
 259    struct wl_callback    *throttle_callback;
 260    int                    format;
 261 #endif
 262
 263 #ifdef HAVE_DRM_PLATFORM
 264    struct gbm_dri_surface *gbm_surf;
 265 #endif
 266
 267 #if defined(HAVE_WAYLAND_PLATFORM) || defined(HAVE_DRM_PLATFORM)
 268    __DRIbuffer           *dri_buffers[__DRI_BUFFER_COUNT];
 269    struct {
 270 #ifdef HAVE_WAYLAND_PLATFORM
 271       struct wl_buffer   *wl_buffer;
 272       __DRIimage         *dri_image;
 273       /* for is_different_gpu case. NULL else */
 274       __DRIimage         *linear_copy;
 275       /* for swrast */
 276       void *data;
 277       int data_size;
 278 #endif
 279 #ifdef HAVE_DRM_PLATFORM
 280       struct gbm_bo       *bo;
 281 #endif
 282       int                 locked;
 283       int                 age;
 284    } color_buffers[4], *back, *current;
 285 #endif
 286
 287 #ifdef HAVE_ANDROID_PLATFORM
 288    struct ANativeWindow *window;
 289    struct ANativeWindowBuffer *buffer;
 290    __DRIimage *dri_image_back;
 291    __DRIimage *dri_image_front;
 292
 293    /* EGL-owned buffers */
 294    __DRIbuffer           *local_buffers[__DRI_BUFFER_COUNT];
 295
 296    /* Used to record all the buffers created by ANativeWindow and their ages.
 297     * Usually Android uses at most triple buffers in ANativeWindow
 298     * so hardcode the number of color_buffers to 3.
 299     */
 300    struct {
 301       struct ANativeWindowBuffer *buffer;
 302       int age;
 303    } color_buffers[3], *back;
 304 #endif
 305
 306 #if defined(HAVE_SURFACELESS_PLATFORM)
 307       __DRIimage           *front;
 308       unsigned int         visual;
 309 #endif
 310 };
 311
 312 struct dri2_egl_config
 313 {
 314    _EGLConfig         base;
 315    const __DRIconfig *dri_single_config[2];
 316    const __DRIconfig *dri_double_config[2];
 317 };
 318
 319 struct dri2_egl_image
 320 {
 321    _EGLImage   base;
 322    __DRIimage *dri_image;
 323 };
 324
 325 struct dri2_egl_sync {
 326    _EGLSync base;
 327    mtx_t mutex;
 328    cnd_t cond;
 329    int refcount;
 330    void *fence;
 331 };
 332
 333 /* From xmlpool/options.h, user exposed so should be stable */
 334 #define DRI_CONF_VBLANK_NEVER 0
 335 #define DRI_CONF_VBLANK_DEF_INTERVAL_0 1
 336 #define DRI_CONF_VBLANK_DEF_INTERVAL_1 2
 337 #define DRI_CONF_VBLANK_ALWAYS_SYNC 3
 338
 339 /* standard typecasts */
 340 _EGL_DRIVER_STANDARD_TYPECASTS(dri2_egl)
 341 _EGL_DRIVER_TYPECAST(dri2_egl_image, _EGLImage, obj)
 342 _EGL_DRIVER_TYPECAST(dri2_egl_sync, _EGLSync, obj)
 343
 344 extern const __DRIimageLookupExtension image_lookup_extension;
 345 extern const __DRIuseInvalidateExtension use_invalidate;
 346 extern const __DRIbackgroundCallableExtension background_callable_extension;
 347
 348 EGLBoolean
 349 dri2_load_driver(_EGLDisplay *disp);
 350
 351 /* Helper for platforms not using dri2_create_screen */
 352 void
 353 dri2_setup_screen(_EGLDisplay *disp);
 354
 355 EGLBoolean
 356 dri2_load_driver_swrast(_EGLDisplay *disp);
 357
 358 EGLBoolean
 359 dri2_load_driver_dri3(_EGLDisplay *disp);
 360
 361 EGLBoolean
 362 dri2_create_screen(_EGLDisplay *disp);
 363
 364 __DRIdrawable *
 365 dri2_surface_get_dri_drawable(_EGLSurface *surf);
 366
 367 __DRIimage *
 368 dri2_lookup_egl_image(__DRIscreen *screen, void *image, void *data);
 369
 370 struct dri2_egl_config *
 371 dri2_add_config(_EGLDisplay *disp, const __DRIconfig *dri_config, int id,
 372                 EGLint surface_type, const EGLint *attr_list,
 373                 const unsigned int *rgba_masks);
 374
 375 _EGLImage *
 376 dri2_create_image_khr(_EGLDriver *drv, _EGLDisplay *disp,
 377                       _EGLContext *ctx, EGLenum target,
 378                       EGLClientBuffer buffer, const EGLint *attr_list);
 379
 380 _EGLImage *
 381 dri2_create_image_dma_buf(_EGLDisplay *disp, _EGLContext *ctx,
 382                           EGLClientBuffer buffer, const EGLint *attr_list);
 383
 384 EGLBoolean
 385 dri2_initialize_x11(_EGLDriver *drv, _EGLDisplay *disp);
 386
 387 EGLBoolean
 388 dri2_initialize_drm(_EGLDriver *drv, _EGLDisplay *disp);
 389
 390 EGLBoolean
 391 dri2_initialize_wayland(_EGLDriver *drv, _EGLDisplay *disp);
 392
 393 EGLBoolean
 394 dri2_initialize_android(_EGLDriver *drv, _EGLDisplay *disp);
 395
 396 EGLBoolean
 397 dri2_initialize_surfaceless(_EGLDriver *drv, _EGLDisplay *disp);
 398
 399 void
 400 dri2_flush_drawable_for_swapbuffers(_EGLDisplay *disp, _EGLSurface *draw);
 401
 402 const __DRIconfig *
 403 dri2_get_dri_config(struct dri2_egl_config *conf, EGLint surface_type,
 404                     EGLenum colorspace);
 405
 406 static inline void
 407 dri2_set_WL_bind_wayland_display(_EGLDriver *drv, _EGLDisplay *disp)
 408 {
 409 #ifdef HAVE_WAYLAND_PLATFORM
 410    struct dri2_egl_display *dri2_dpy = dri2_egl_display(disp);
 411
 412    (void) drv;
 413
 414    if (dri2_dpy->device_name && dri2_dpy->image) {
 415        if (dri2_dpy->image->base.version >= 10 &&
 416            dri2_dpy->image->getCapabilities != NULL) {
 417            int capabilities;
 418
 419            capabilities =
 420                dri2_dpy->image->getCapabilities(dri2_dpy->dri_screen);
 421            disp->Extensions.WL_bind_wayland_display =
 422                (capabilities & __DRI_IMAGE_CAP_GLOBAL_NAMES) != 0;
 423        } else {
 424            disp->Extensions.WL_bind_wayland_display = EGL_TRUE;
 425        }
 426    }
 427 #endif
 428 }
 429
 430 #endif /* EGL_DRI2_INCLUDED */