src/glx/mini/driver.h

   1 /**
   2  * \file driver.h
   3  * \brief DRI utility functions definitions.
   4  *
   5  * This module acts as glue between GLX and the actual hardware driver.  A DRI
   6  * driver doesn't really \e have to use any of this - it's optional.  But, some
   7  * useful stuff is done here that otherwise would have to be duplicated in most
   8  * drivers.
   9  *
  10  * Basically, these utility functions take care of some of the dirty details of
  11  * screen initialization, context creation, context binding, DRM setup, etc.
  12  *
  13  * These functions are compiled into each DRI driver so libGL.so knows nothing
  14  * about them.
  15  *
  16  * Look for more comments in the dri_util.c file.
  17  *
  18  * \author Kevin E. Martin <kevin@precisioninsight.com>
  19  * \author Brian Paul <brian@precisioninsight.com>
  20  */
  21
  22 /*
  23  * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
  24  * All Rights Reserved.
  25  *
  26  * Permission is hereby granted, free of charge, to any person obtaining a
  27  * copy of this software and associated documentation files (the
  28  * "Software"), to deal in the Software without restriction, including
  29  * without limitation the rights to use, copy, modify, merge, publish,
  30  * distribute, sub license, and/or sell copies of the Software, and to
  31  * permit persons to whom the Software is furnished to do so, subject to
  32  * the following conditions:
  33  *
  34  * The above copyright notice and this permission notice (including the
  35  * next paragraph) shall be included in all copies or substantial portions
  36  * of the Software.
  37  *
  38  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  39  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  40  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  41  * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  42  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  43  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  44  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  45  */
  46
  47 #ifndef _driver_H_
  48 #define _driver_H_
  49
  50 #define CAPI  /* XXX this should be globally defined somewhere */
  51
  52 #include "GL/gl.h"
  53 #include "GL/internal/glcore.h"
  54
  55 #include "drm.h"
  56 #include "drm_sarea.h"
  57
  58 /**
  59  * \brief DRIDriverContext type.
  60  */
  61 typedef struct DRIDriverContextRec {
  62    const char *pciBusID;
  63    int pciBus;
  64    int pciDevice;
  65    int pciFunc;
  66    int chipset;
  67    int bpp;
  68    int cpp;
  69    int agpmode;
  70
  71    unsigned long FBStart;   /**< \brief physical address of the framebuffer */
  72    unsigned long MMIOStart; /**< \brief physical address of the MMIO region */
  73
  74    int FBSize;              /**< \brief size of the mmap'd framebuffer in bytes */
  75    int MMIOSize;            /**< \brief size of the mmap'd MMIO region in bytes */
  76
  77    void *FBAddress;         /**< \brief start of the mmap'd framebuffer */
  78    void *MMIOAddress;       /**< \brief start of the mmap'd MMIO region */
  79
  80    /**
  81     * \brief Client configuration details
  82     *
  83     * These are computed on the server and sent to clients as part of
  84     * the initial handshaking.
  85     */
  86    struct {
  87       unsigned long hSAREA;
  88       int SAREASize;
  89       unsigned long hFrameBuffer;
  90       int fbOrigin;
  91       int fbSize;
  92       int fbStride;
  93       int virtualWidth;
  94       int virtualHeight;
  95    } shared;
  96
  97    /**
  98     * \name From DRIInfoRec
  99     */
 100    /*@{*/
 101    int drmFD;  /**< \brief DRM device file descriptor */
 102    drm_sarea_t *pSAREA;
 103    unsigned int serverContext;  /**< \brief DRM context only active on server */
 104    /*@}*/
 105
 106
 107    /**
 108     * \name Driver private
 109     *
 110     * Populated by __driInitFBDev()
 111     */
 112    /*@{*/
 113    void *driverPrivate;
 114    void *driverClientMsg;
 115    int driverClientMsgSize;
 116    /*@}*/
 117 } DRIDriverContext;
 118
 119 /**
 120  * \brief Interface to the DRI driver.
 121  *
 122  * This structure is retrieved from the loadable driver by the \e
 123  * __driDriver symbol to access the Mini GLX specific hardware
 124  * initialization and take down routines.
 125  */
 126 typedef struct DRIDriverRec {
 127    /**
 128     * \brief Get the list of supported gl context modes.
 129     */
 130    int (*initContextModes)( const DRIDriverContext *context,
 131                              int *numModes, const __GLcontextModes **modes );
 132    /**
 133     * \brief Validate the framebuffer device mode
 134     */
 135    int (*validateMode)( const DRIDriverContext *context );
 136
 137    /**
 138     * \brief Examine mode returned by fbdev (may differ from the one
 139     * requested), restore any hw regs clobbered by fbdev.
 140     */
 141    int (*postValidateMode)( const DRIDriverContext *context );
 142
 143    /**
 144     * \brief Initialize the framebuffer device.
 145     */
 146    int (*initFBDev)( DRIDriverContext *context );
 147
 148    /**
 149     * \brief Halt the framebuffer device.
 150     */
 151    void (*haltFBDev)( DRIDriverContext *context );
 152
 153
 154    /**
 155     * \brief Idle and shutdown hardware in preparation for a VT switch.
 156     */
 157    int (*shutdownHardware)(  const DRIDriverContext *context );
 158
 159    /**
 160     * \brief Restore hardware state after regaining the VT.
 161     */
 162    int (*restoreHardware)(  const DRIDriverContext *context );
 163
 164    /**
 165     * \brief Notify hardware driver of gain/loose focus.  May be zero
 166     * as this is of limited utility for most drivers.
 167     */
 168    void (*notifyFocus)( int have_focus );
 169 } DRIDriver;
 170
 171 #endif /* _driver_H_ */