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    int isPCI;
  71
  72    unsigned long FBStart;   /**< \brief physical address of the framebuffer */
  73    unsigned long MMIOStart; /**< \brief physical address of the MMIO region */
  74
  75    int FBSize;              /**< \brief size of the mmap'd framebuffer in bytes */
  76    int MMIOSize;            /**< \brief size of the mmap'd MMIO region in bytes */
  77
  78    void *FBAddress;         /**< \brief start of the mmap'd framebuffer */
  79    void *MMIOAddress;       /**< \brief start of the mmap'd MMIO region */
  80
  81    /**
  82     * \brief Client configuration details
  83     *
  84     * These are computed on the server and sent to clients as part of
  85     * the initial handshaking.
  86     */
  87    struct {
  88       unsigned long hSAREA;
  89       int SAREASize;
  90       unsigned long hFrameBuffer;
  91       int fbOrigin;
  92       int fbSize;
  93       int fbStride;
  94       int virtualWidth;
  95       int virtualHeight;
  96    } shared;
  97
  98    /**
  99     * \name From DRIInfoRec
 100     */
 101    /*@{*/
 102    int drmFD;  /**< \brief DRM device file descriptor */
 103    drm_sarea_t *pSAREA;
 104    unsigned int serverContext;  /**< \brief DRM context only active on server */
 105    /*@}*/
 106
 107
 108    /**
 109     * \name Driver private
 110     *
 111     * Populated by __driInitFBDev()
 112     */
 113    /*@{*/
 114    void *driverPrivate;
 115    void *driverClientMsg;
 116    int driverClientMsgSize;
 117    /*@}*/
 118 } DRIDriverContext;
 119
 120 /**
 121  * \brief Interface to the DRI driver.
 122  *
 123  * This structure is retrieved from the loadable driver by the \e
 124  * __driDriver symbol to access the Mini GLX specific hardware
 125  * initialization and take down routines.
 126  */
 127 typedef struct DRIDriverRec {
 128    /**
 129     * \brief Validate the framebuffer device mode
 130     */
 131    int (*validateMode)( const DRIDriverContext *context );
 132
 133    /**
 134     * \brief Examine mode returned by fbdev (may differ from the one
 135     * requested), restore any hw regs clobbered by fbdev.
 136     */
 137    int (*postValidateMode)( const DRIDriverContext *context );
 138
 139    /**
 140     * \brief Initialize the framebuffer device.
 141     */
 142    int (*initFBDev)( DRIDriverContext *context );
 143
 144    /**
 145     * \brief Halt the framebuffer device.
 146     */
 147    void (*haltFBDev)( DRIDriverContext *context );
 148
 149
 150    /**
 151     * \brief Idle and shutdown hardware in preparation for a VT switch.
 152     */
 153    int (*shutdownHardware)(  const DRIDriverContext *context );
 154
 155    /**
 156     * \brief Restore hardware state after regaining the VT.
 157     */
 158    int (*restoreHardware)(  const DRIDriverContext *context );
 159
 160    /**
 161     * \brief Notify hardware driver of gain/loose focus.  May be zero
 162     * as this is of limited utility for most drivers.
 163     */
 164    void (*notifyFocus)( int have_focus );
 165 } DRIDriver;
 166
 167 #endif /* _driver_H_ */