src/mesa/drivers/dri/common/dri_util.h

   1 /*
   2  * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
   3  * All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sub license, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the
  14  * next paragraph) shall be included in all copies or substantial portions
  15  * of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  20  * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  21  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  22  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  23  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 /**
  27  * \file dri_util.h
  28  * DRI utility functions definitions.
  29  *
  30  * This module acts as glue between GLX and the actual hardware driver.  A DRI
  31  * driver doesn't really \e have to use any of this - it's optional.  But, some
  32  * useful stuff is done here that otherwise would have to be duplicated in most
  33  * drivers.
  34  *
  35  * Basically, these utility functions take care of some of the dirty details of
  36  * screen initialization, context creation, context binding, DRM setup, etc.
  37  *
  38  * These functions are compiled into each DRI driver so libGL.so knows nothing
  39  * about them.
  40  *
  41  * \sa dri_util.c.
  42  *
  43  * \author Kevin E. Martin <kevin@precisioninsight.com>
  44  * \author Brian Paul <brian@precisioninsight.com>
  45  */
  46
  47 #ifndef _DRI_UTIL_H_
  48 #define _DRI_UTIL_H_
  49
  50 #include <GL/gl.h>
  51 #include <drm.h>
  52 #include <drm_sarea.h>
  53 #include <xf86drm.h>
  54 #include "xmlconfig.h"
  55 #include "main/glheader.h"
  56 #include "main/mtypes.h"
  57 #include "GL/internal/dri_interface.h"
  58
  59 #define GLX_BAD_CONTEXT                    5
  60
  61 /**
  62  * Extensions.
  63  */
  64 extern const __DRIcoreExtension driCoreExtension;
  65 extern const __DRIdri2Extension driDRI2Extension;
  66 extern const __DRI2configQueryExtension dri2ConfigQueryExtension;
  67
  68 /**
  69  * Driver callback functions.
  70  *
  71  * Each DRI driver must have one of these structures with all the pointers set
  72  * to appropriate functions within the driver.
  73  *
  74  * When glXCreateContext() is called, for example, it'll call a helper function
  75  * dri_util.c which in turn will jump through the \a CreateContext pointer in
  76  * this structure.
  77  */
  78 struct __DriverAPIRec {
  79     const __DRIconfig **(*InitScreen) (__DRIscreen * priv);
  80
  81     /**
  82      * Screen destruction callback
  83      */
  84     void (*DestroyScreen)(__DRIscreen *driScrnPriv);
  85
  86     /**
  87      * Context creation callback
  88      */
  89     GLboolean (*CreateContext)(gl_api api,
  90                                const struct gl_config *glVis,
  91                                __DRIcontext *driContextPriv,
  92                                void *sharedContextPrivate);
  93
  94     /**
  95      * Context destruction callback
  96      */
  97     void (*DestroyContext)(__DRIcontext *driContextPriv);
  98
  99     /**
 100      * Buffer (drawable) creation callback
 101      */
 102     GLboolean (*CreateBuffer)(__DRIscreen *driScrnPriv,
 103                               __DRIdrawable *driDrawPriv,
 104                               const struct gl_config *glVis,
 105                               GLboolean pixmapBuffer);
 106
 107     /**
 108      * Buffer (drawable) destruction callback
 109      */
 110     void (*DestroyBuffer)(__DRIdrawable *driDrawPriv);
 111
 112     /**
 113      * Buffer swapping callback
 114      */
 115     void (*SwapBuffers)(__DRIdrawable *driDrawPriv);
 116
 117     /**
 118      * Context activation callback
 119      */
 120     GLboolean (*MakeCurrent)(__DRIcontext *driContextPriv,
 121                              __DRIdrawable *driDrawPriv,
 122                              __DRIdrawable *driReadPriv);
 123
 124     /**
 125      * Context unbinding callback
 126      */
 127     GLboolean (*UnbindContext)(__DRIcontext *driContextPriv);
 128
 129     /**
 130      * These are required if GLX_OML_sync_control is supported.
 131      */
 132     /*@{*/
 133     int (*WaitForMSC)( __DRIdrawable *priv, int64_t target_msc,
 134                        int64_t divisor, int64_t remainder,
 135                        int64_t * msc );
 136     int (*WaitForSBC)( __DRIdrawable *priv, int64_t target_sbc,
 137                        int64_t * msc, int64_t * sbc );
 138
 139     int64_t (*SwapBuffersMSC)( __DRIdrawable *priv, int64_t target_msc,
 140                                int64_t divisor, int64_t remainder );
 141     /*@}*/
 142     void (*CopySubBuffer)(__DRIdrawable *driDrawPriv,
 143                           int x, int y, int w, int h);
 144
 145     /**
 146      * New version of GetMSC so we can pass drawable data to the low
 147      * level DRM driver (e.g. pipe info).  Required if
 148      * GLX_SGI_video_sync or GLX_OML_sync_control is supported.
 149      */
 150     int (*GetDrawableMSC) ( __DRIscreen * priv,
 151                             __DRIdrawable *drawablePrivate,
 152                             int64_t *count);
 153
 154
 155
 156     /* DRI2 Entry point */
 157     const __DRIconfig **(*InitScreen2) (__DRIscreen * priv);
 158
 159     __DRIbuffer *(*AllocateBuffer) (__DRIscreen *screenPrivate,
 160                                     unsigned int attachment,
 161                                     unsigned int format,
 162                                     int width, int height);
 163     void (*ReleaseBuffer) (__DRIscreen *screenPrivate, __DRIbuffer *buffer);
 164 };
 165
 166 extern const struct __DriverAPIRec driDriverAPI;
 167
 168
 169 /**
 170  * Per-drawable private DRI driver information.
 171  */
 172 struct __DRIdrawableRec {
 173     /**
 174      * Driver's private drawable information.
 175      *
 176      * This structure is opaque.
 177      */
 178     void *driverPrivate;
 179
 180     /**
 181      * Private data from the loader.  We just hold on to it and pass
 182      * it back when calling into loader provided functions.
 183      */
 184     void *loaderPrivate;
 185
 186     /**
 187      * Reference count for number of context's currently bound to this
 188      * drawable.
 189      *
 190      * Once it reaches zero, the drawable can be destroyed.
 191      *
 192      * \note This behavior will change with GLX 1.3.
 193      */
 194     int refcount;
 195
 196     /**
 197      * Pointer to the "drawable has changed ID" stamp in the SAREA (or
 198      * to dri2.stamp if DRI2 is being used).
 199      */
 200     unsigned int *pStamp;
 201
 202     /**
 203      * Last value of the stamp.
 204      *
 205      * If this differs from the value stored at __DRIdrawable::pStamp,
 206      * then the drawable information has been modified by the X server, and the
 207      * drawable information (below) should be retrieved from the X server.
 208      */
 209     unsigned int lastStamp;
 210
 211     int w, h;
 212
 213     /**
 214      * Pointer to context to which this drawable is currently bound.
 215      */
 216     __DRIcontext *driContextPriv;
 217
 218     /**
 219      * Pointer to screen on which this drawable was created.
 220      */
 221     __DRIscreen *driScreenPriv;
 222
 223     struct {
 224         unsigned int stamp;
 225     } dri2;
 226 };
 227
 228 /**
 229  * Per-context private driver information.
 230  */
 231 struct __DRIcontextRec {
 232     /**
 233      * Device driver's private context data.  This structure is opaque.
 234      */
 235     void *driverPrivate;
 236
 237     /**
 238      * Pointer to drawable currently bound to this context for drawing.
 239      */
 240     __DRIdrawable *driDrawablePriv;
 241
 242     /**
 243      * Pointer to drawable currently bound to this context for reading.
 244      */
 245     __DRIdrawable *driReadablePriv;
 246
 247     /**
 248      * Pointer to screen on which this context was created.
 249      */
 250     __DRIscreen *driScreenPriv;
 251
 252     /**
 253      * The loaders's private context data.  This structure is opaque.
 254      */
 255     void *loaderPrivate;
 256
 257     struct {
 258         int draw_stamp;
 259         int read_stamp;
 260     } dri2;
 261 };
 262
 263 /**
 264  * Per-screen private driver information.
 265  */
 266 struct __DRIscreenRec {
 267     /**
 268      * Current screen's number
 269      */
 270     int myNum;
 271
 272     /**
 273      * Callback functions into the hardware-specific DRI driver code.
 274      */
 275     struct __DriverAPIRec DriverAPI;
 276
 277     const __DRIextension **extensions;
 278
 279     /**
 280      * DRM (kernel module) version information.
 281      */
 282     __DRIversion drm_version;
 283
 284     /**
 285      * File descriptor returned when the kernel device driver is opened.
 286      *
 287      * Used to:
 288      *   - authenticate client to kernel
 289      *   - map the frame buffer, SAREA, etc.
 290      *   - close the kernel device driver
 291      */
 292     int fd;
 293
 294     /**
 295      * Device-dependent private information (not stored in the SAREA).
 296      *
 297      * This pointer is never touched by the DRI layer.
 298      */
 299 #ifdef __cplusplus
 300     void *priv;
 301 #else
 302     void *private;
 303 #endif
 304
 305     struct {
 306         /* Flag to indicate that this is a DRI2 screen.  Many of the above
 307          * fields will not be valid or initializaed in that case. */
 308         int enabled;
 309         __DRIdri2LoaderExtension *loader;
 310         __DRIimageLookupExtension *image;
 311         __DRIuseInvalidateExtension *useInvalidate;
 312     } dri2;
 313
 314     driOptionCache optionInfo;
 315     driOptionCache optionCache;
 316    unsigned int api_mask;
 317    void *loaderPrivate;
 318 };
 319
 320 extern void
 321 dri2InvalidateDrawable(__DRIdrawable *drawable);
 322
 323 #endif /* _DRI_UTIL_H_ */