hw/xfree86/vbe/vbeModes.h

   1 /*
   2  * Copyright © 2002 David Dawes
   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 shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17  * THE AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  18  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  19  * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  *
  22  * Except as contained in this notice, the name of the author(s) shall
  23  * not be used in advertising or otherwise to promote the sale, use or other
  24  * dealings in this Software without prior written authorization from
  25  * the author(s).
  26  *
  27  * Authors: David Dawes <dawes@xfree86.org>
  28  *
  29  */
  30
  31 #ifndef _VBE_MODES_H
  32
  33 /*
  34  * This is intended to be stored in the DisplayModeRec's private area.
  35  * It includes all the information necessary to VBE information.
  36  */
  37 typedef struct _VbeModeInfoData {
  38     int mode;
  39     VbeModeInfoBlock *data;
  40     VbeCRTCInfoBlock *block;
  41 } VbeModeInfoData;
  42
  43 #define V_DEPTH_1       0x001
  44 #define V_DEPTH_4       0x002
  45 #define V_DEPTH_8       0x004
  46 #define V_DEPTH_15      0x008
  47 #define V_DEPTH_16      0x010
  48 #define V_DEPTH_24_24   0x020
  49 #define V_DEPTH_24_32   0x040
  50 #define V_DEPTH_24      (V_DEPTH_24_24 | V_DEPTH_24_32)
  51 #define V_DEPTH_30      0x080
  52 #define V_DEPTH_32      0x100
  53
  54 #define VBE_MODE_SUPPORTED(m)   (((m)->ModeAttributes & 0x01) != 0)
  55 #define VBE_MODE_COLOR(m)       (((m)->ModeAttributes & 0x08) != 0)
  56 #define VBE_MODE_GRAPHICS(m)    (((m)->ModeAttributes & 0x10) != 0)
  57 #define VBE_MODE_VGA(m)         (((m)->ModeAttributes & 0x40) == 0)
  58 #define VBE_MODE_LINEAR(m)      (((m)->ModeAttributes & 0x80) != 0 && \
  59                                  ((m)->PhysBasePtr != 0))
  60
  61 #define VBE_MODE_USABLE(m, f)   (VBE_MODE_SUPPORTED(m) || \
  62                                  (f & V_MODETYPE_BAD)) && \
  63                                 VBE_MODE_GRAPHICS(m) && \
  64                                 (VBE_MODE_VGA(m) || VBE_MODE_LINEAR(m))
  65
  66 #define V_MODETYPE_VBE          0x01
  67 #define V_MODETYPE_VGA          0x02
  68 #define V_MODETYPE_BAD          0x04
  69
  70 extern _X_EXPORT int VBEFindSupportedDepths(vbeInfoPtr pVbe, VbeInfoBlock * vbe,
  71                                             int *flags24, int modeTypes);
  72 extern _X_EXPORT DisplayModePtr VBEGetModePool(ScrnInfoPtr pScrn,
  73                                                vbeInfoPtr pVbe,
  74                                                VbeInfoBlock * vbe,
  75                                                int modeTypes);
  76 extern _X_EXPORT void VBESetModeNames(DisplayModePtr pMode);
  77 extern _X_EXPORT void VBESetModeParameters(ScrnInfoPtr pScrn, vbeInfoPtr pVbe);
  78
  79 /*
  80  * Note: These are alternatives to the standard helpers.  They should
  81  * usually just wrap the standard helpers.
  82  */
  83 extern _X_EXPORT int VBEValidateModes(ScrnInfoPtr scrp,
  84                                       DisplayModePtr availModes,
  85                                       const char **modeNames,
  86                                       ClockRangePtr clockRanges,
  87                                       int *linePitches, int minPitch,
  88                                       int maxPitch, int pitchInc, int minHeight,
  89                                       int maxHeight, int virtualX, int virtualY,
  90                                       int apertureSize,
  91                                       LookupModeFlags strategy);
  92 extern _X_EXPORT void VBEPrintModes(ScrnInfoPtr scrp);
  93
  94 #endif                          /* VBE_MODES_H */