2 * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
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:
13 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial portions
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.
28 * DRI utility functions definitions.
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
35 * Basically, these utility functions take care of some of the dirty details of
36 * screen initialization, context creation, context binding, DRM setup, etc.
38 * These functions are compiled into each DRI driver so libGL.so knows nothing
43 * \author Kevin E. Martin <kevin@precisioninsight.com>
44 * \author Brian Paul <brian@precisioninsight.com>
52 #include <drm_sarea.h>
54 #include "xmlconfig.h"
55 #include "main/glheader.h"
56 #include "main/mtypes.h"
57 #include "GL/internal/dri_interface.h"
59 #define GLX_BAD_CONTEXT 5
64 extern const __DRIcoreExtension driCoreExtension;
65 extern const __DRIdri2Extension driDRI2Extension;
66 extern const __DRI2configQueryExtension dri2ConfigQueryExtension;
69 * Used by DRI_VALIDATE_DRAWABLE_INFO
71 #define DRI_VALIDATE_DRAWABLE_INFO_ONCE(pDrawPriv) \
73 if (*(pDrawPriv->pStamp) != pDrawPriv->lastStamp) { \
74 __driUtilUpdateDrawableInfo(pDrawPriv); \
80 * Utility macro to validate the drawable information.
82 * See __DRIdrawable::pStamp and __DRIdrawable::lastStamp.
84 #define DRI_VALIDATE_DRAWABLE_INFO(psp, pdp) \
86 while (*(pdp->pStamp) != pdp->lastStamp) { \
87 register unsigned int hwContext = psp->pSAREA->lock.lock & \
88 ~(DRM_LOCK_HELD | DRM_LOCK_CONT); \
89 DRM_UNLOCK(psp->fd, &psp->pSAREA->lock, hwContext); \
91 DRM_SPINLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID); \
92 DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp); \
93 DRM_SPINUNLOCK(&psp->pSAREA->drawable_lock, psp->drawLockID); \
95 DRM_LIGHT_LOCK(psp->fd, &psp->pSAREA->lock, hwContext); \
100 * Same as above, but for two drawables simultaneously.
104 #define DRI_VALIDATE_TWO_DRAWABLES_INFO(psp, pdp, prp) \
106 while (*((pdp)->pStamp) != (pdp)->lastStamp || \
107 *((prp)->pStamp) != (prp)->lastStamp) { \
108 register unsigned int hwContext = (psp)->pSAREA->lock.lock & \
109 ~(DRM_LOCK_HELD | DRM_LOCK_CONT); \
110 DRM_UNLOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext); \
112 DRM_SPINLOCK(&(psp)->pSAREA->drawable_lock, (psp)->drawLockID); \
113 DRI_VALIDATE_DRAWABLE_INFO_ONCE(pdp); \
114 DRI_VALIDATE_DRAWABLE_INFO_ONCE(prp); \
115 DRM_SPINUNLOCK(&(psp)->pSAREA->drawable_lock, (psp)->drawLockID); \
117 DRM_LIGHT_LOCK((psp)->fd, &(psp)->pSAREA->lock, hwContext); \
123 * Driver callback functions.
125 * Each DRI driver must have one of these structures with all the pointers set
126 * to appropriate functions within the driver.
128 * When glXCreateContext() is called, for example, it'll call a helper function
129 * dri_util.c which in turn will jump through the \a CreateContext pointer in
132 struct __DriverAPIRec {
133 const __DRIconfig **(*InitScreen) (__DRIscreen * priv);
136 * Screen destruction callback
138 void (*DestroyScreen)(__DRIscreen *driScrnPriv);
141 * Context creation callback
143 GLboolean (*CreateContext)(gl_api api,
144 const struct gl_config *glVis,
145 __DRIcontext *driContextPriv,
146 void *sharedContextPrivate);
149 * Context destruction callback
151 void (*DestroyContext)(__DRIcontext *driContextPriv);
154 * Buffer (drawable) creation callback
156 GLboolean (*CreateBuffer)(__DRIscreen *driScrnPriv,
157 __DRIdrawable *driDrawPriv,
158 const struct gl_config *glVis,
159 GLboolean pixmapBuffer);
162 * Buffer (drawable) destruction callback
164 void (*DestroyBuffer)(__DRIdrawable *driDrawPriv);
167 * Buffer swapping callback
169 void (*SwapBuffers)(__DRIdrawable *driDrawPriv);
172 * Context activation callback
174 GLboolean (*MakeCurrent)(__DRIcontext *driContextPriv,
175 __DRIdrawable *driDrawPriv,
176 __DRIdrawable *driReadPriv);
179 * Context unbinding callback
181 GLboolean (*UnbindContext)(__DRIcontext *driContextPriv);
184 * These are required if GLX_OML_sync_control is supported.
187 int (*WaitForMSC)( __DRIdrawable *priv, int64_t target_msc,
188 int64_t divisor, int64_t remainder,
190 int (*WaitForSBC)( __DRIdrawable *priv, int64_t target_sbc,
191 int64_t * msc, int64_t * sbc );
193 int64_t (*SwapBuffersMSC)( __DRIdrawable *priv, int64_t target_msc,
194 int64_t divisor, int64_t remainder );
196 void (*CopySubBuffer)(__DRIdrawable *driDrawPriv,
197 int x, int y, int w, int h);
200 * New version of GetMSC so we can pass drawable data to the low
201 * level DRM driver (e.g. pipe info). Required if
202 * GLX_SGI_video_sync or GLX_OML_sync_control is supported.
204 int (*GetDrawableMSC) ( __DRIscreen * priv,
205 __DRIdrawable *drawablePrivate,
210 /* DRI2 Entry point */
211 const __DRIconfig **(*InitScreen2) (__DRIscreen * priv);
213 __DRIbuffer *(*AllocateBuffer) (__DRIscreen *screenPrivate,
214 unsigned int attachment,
216 int width, int height);
217 void (*ReleaseBuffer) (__DRIscreen *screenPrivate, __DRIbuffer *buffer);
220 extern const struct __DriverAPIRec driDriverAPI;
224 * Per-drawable private DRI driver information.
226 struct __DRIdrawableRec {
228 * Kernel drawable handle
230 drm_drawable_t hHWDrawable;
233 * Driver's private drawable information.
235 * This structure is opaque.
240 * Private data from the loader. We just hold on to it and pass
241 * it back when calling into loader provided functions.
246 * Reference count for number of context's currently bound to this
249 * Once it reaches zero, the drawable can be destroyed.
251 * \note This behavior will change with GLX 1.3.
256 * Index of this drawable information in the SAREA.
261 * Pointer to the "drawable has changed ID" stamp in the SAREA (or
262 * to dri2.stamp if DRI2 is being used).
264 unsigned int *pStamp;
267 * Last value of the stamp.
269 * If this differs from the value stored at __DRIdrawable::pStamp,
270 * then the drawable information has been modified by the X server, and the
271 * drawable information (below) should be retrieved from the X server.
273 unsigned int lastStamp;
278 * Drawable information used in software fallbacks.
286 drm_clip_rect_t *pClipRects;
290 * \name Back and depthbuffer
292 * Information about the back and depthbuffer where different from above.
297 int backClipRectType;
298 int numBackClipRects;
299 drm_clip_rect_t *pBackClipRects;
303 * \name Vertical blank tracking information
304 * Used for waiting on vertical blank events.
308 unsigned int vblFlags;
312 * \name Monotonic MSC tracking
314 * Low level driver is responsible for updating msc_base and
315 * vblSeq values so that higher level code can calculate
316 * a new msc value or msc target for a WaitMSC call. The new value
318 * msc = msc_base + get_vblank_count() - vblank_base;
320 * And for waiting on a value, core code will use:
321 * actual_target = target_msc - msc_base + vblank_base;
329 * Pointer to context to which this drawable is currently bound.
331 __DRIcontext *driContextPriv;
334 * Pointer to screen on which this drawable was created.
336 __DRIscreen *driScreenPriv;
339 * Controls swap interval as used by GLX_SGI_swap_control and
340 * GLX_MESA_swap_control.
342 unsigned int swap_interval;
346 drm_clip_rect_t clipRect;
351 * Per-context private driver information.
353 struct __DRIcontextRec {
355 * Kernel context handle used to access the device lock.
357 drm_context_t hHWContext;
360 * Device driver's private context data. This structure is opaque.
365 * Pointer to drawable currently bound to this context for drawing.
367 __DRIdrawable *driDrawablePriv;
370 * Pointer to drawable currently bound to this context for reading.
372 __DRIdrawable *driReadablePriv;
375 * Pointer to screen on which this context was created.
377 __DRIscreen *driScreenPriv;
380 * The loaders's private context data. This structure is opaque.
391 * Per-screen private driver information.
393 struct __DRIscreenRec {
395 * Current screen's number
400 * Callback functions into the hardware-specific DRI driver code.
402 struct __DriverAPIRec DriverAPI;
404 const __DRIextension **extensions;
406 * DDX / 2D driver version information.
408 __DRIversion ddx_version;
411 * DRI X extension version information.
413 __DRIversion dri_version;
416 * DRM (kernel module) version information.
418 __DRIversion drm_version;
421 * ID used when the client sets the drawable lock.
423 * The X server uses this value to detect if the client has died while
424 * holding the drawable lock.
429 * File descriptor returned when the kernel device driver is opened.
432 * - authenticate client to kernel
433 * - map the frame buffer, SAREA, etc.
434 * - close the kernel device driver
443 * - the device-independent per-drawable and per-context(?) information
448 * \name Direct frame buffer access information
449 * Used for software fallbacks.
462 * \name Device-dependent private information (stored in the SAREA).
464 * This data is accessed by the client driver only.
472 * Device-dependent private information (not stored in the SAREA).
474 * This pointer is never touched by the DRI layer.
482 /* Extensions provided by the loader. */
483 const __DRIgetDrawableInfoExtension *getDrawableInfo;
484 const __DRIsystemTimeExtension *systemTime;
485 const __DRIdamageExtension *damage;
488 /* Flag to indicate that this is a DRI2 screen. Many of the above
489 * fields will not be valid or initializaed in that case. */
491 __DRIdri2LoaderExtension *loader;
492 __DRIimageLookupExtension *image;
493 __DRIuseInvalidateExtension *useInvalidate;
496 /* The lock actually in use, old sarea or DRI2 */
499 driOptionCache optionInfo;
500 driOptionCache optionCache;
501 unsigned int api_mask;
506 __driUtilUpdateDrawableInfo(__DRIdrawable *pdp);
509 driCalculateSwapUsage( __DRIdrawable *dPriv,
510 int64_t last_swap_ust, int64_t current_ust );
513 driIntersectArea( drm_clip_rect_t rect1, drm_clip_rect_t rect2 );
516 dri2InvalidateDrawable(__DRIdrawable *drawable);
518 #endif /* _DRI_UTIL_H_ */