vbe_display_api.txt

   1 VBE Display API
   2 -------------------------------------------------------------------------------------------------------------
   3   This document is part of the Bochs/VBEBios documentation,
   4   it specifies the bochs host <-> vbebios client communication.
   5
   6   That means, the display code implementation and the vbebios code depend
   7   very heavily on each other. As such, this documents needs be synchronised
   8   between bochs CVS and the vgabios CVS.
   9
  10   This document does not describe hwo the VBEBios implements the VBE2/3 spec.
  11   This document does not describe how the Bochs display code will display gfx based upon this spec.
  12
  13
  14 API History
  15 -----------
  16 0xb0c0            supports the following VBE_DISPI_ interfaces (present in Bochs 1.4):
  17                   VBE_DISPI_INDEX_ID
  18                   VBE_DISPI_INDEX_XRES
  19                   VBE_DISPI_INDEX_YRES
  20                   VBE_DISPI_INDEX_BPP
  21                   VBE_DISPI_INDEX_ENABLE
  22                   VBE_DISPI_INDEX_BANK
  23
  24                   Bpp format supported is:
  25                   VBE_DISPI_BPP_8
  26
  27 0xb0c1            supports 0xb0c0 VBE_DISPI_ interfaces, additional interfaces (present in Bochs 2.0):
  28                   VBE_DISPI_INDEX_VIRT_WIDTH
  29                   VBE_DISPI_INDEX_VIRT_HEIGHT
  30                   VBE_DISPI_INDEX_X_OFFSET
  31                   VBE_DISPI_INDEX_Y_OFFSET
  32
  33 0xb0c2            supports 0xb0c1 VBE_DISPI_ interfaces, interfaces updated for
  34                   additional features (present in Bochs 2.1):
  35                   VBE_DISPI_INDEX_BPP supports >8bpp color depth (value = bits)
  36                   VBE_DISPI_INDEX_ENABLE supports new flags VBE_DISPI_NOCLEARMEM and VBE_DISPI_LFB_ENABLED
  37                   VBE i/o registers changed from 0xFF80/81 to 0x01CE/CF
  38
  39 0xb0c3            supports 0xb0c2 VBE_DISPI_ interfaces, interfaces updated for
  40                   additional features:
  41                   VBE_DISPI_INDEX_ENABLE supports new flag VBE_DISPI_GETCAPS
  42
  43
  44 History
  45 -------
  46   Version 0.6     2002 Nov 23  Jeroen Janssen
  47                   - Added LFB support
  48                   - Added Virt width, height and x,y offset
  49
  50   Version 0.5     2002 March 08   Jeroen Janssen
  51                   - Added documentation about panic behaviour / current limits of the data values.
  52                   - Changed BPP API (in order to include future (A)RGB formats)
  53                   - Initial version (based upon extended display text of the vbe bochs display patch)
  54
  55
  56 Todo
  57 ----
  58   Version 0.6     - add virtual width, height, x offset, y offset in bios & bochs
  59                     (for set/get logical scan line length and set/get display start)
  60
  61   Version 0.6+    [random order]
  62                   - Add lots of different (A)RGB formats
  63
  64 References
  65 ----------
  66   [VBE3]          VBE 3 Specification at
  67                   http://www.vesa.org/vbe3.pdf
  68
  69   [BOCHS]         Bochs Open Source IA-32 Emulator at
  70                   http://bochs.sourceforge.net
  71
  72   [VBEBIOS]       VBE Bios for Bochs at
  73                   http://savannah.gnu.org/projects/vgabios/
  74
  75   [Screenshots]   Screenshots of programs using the VBE Bios at
  76                   http://japj.org/projects/bochs_plex86/screenshots.html
  77
  78 Abbreviations
  79 -------------
  80   VBE             Vesa Bios Extension
  81   DISPI           (Bochs) Display Interface
  82   BPP             Bits Per Pixel
  83   LFB             Linear Frame Buffer
  84
  85
  86 #defines
  87 --------
  88   #define VBE_DISPI_TOTAL_VIDEO_MEMORY_MB 4
  89   #define VBE_DISPI_BANK_ADDRESS          0xA0000
  90   #define VBE_DISPI_BANK_SIZE_KB          64
  91
  92   #define VBE_DISPI_MAX_XRES              1024
  93   #define VBE_DISPI_MAX_YRES              768
  94
  95   #define VBE_DISPI_IOPORT_INDEX          0x01CE
  96   #define VBE_DISPI_IOPORT_DATA           0x01CF
  97
  98   #define VBE_DISPI_INDEX_ID              0x0
  99   #define VBE_DISPI_INDEX_XRES            0x1
 100   #define VBE_DISPI_INDEX_YRES            0x2
 101   #define VBE_DISPI_INDEX_BPP             0x3
 102   #define VBE_DISPI_INDEX_ENABLE          0x4
 103   #define VBE_DISPI_INDEX_BANK            0x5
 104   #define VBE_DISPI_INDEX_VIRT_WIDTH      0x6
 105   #define VBE_DISPI_INDEX_VIRT_HEIGHT     0x7
 106   #define VBE_DISPI_INDEX_X_OFFSET        0x8
 107   #define VBE_DISPI_INDEX_Y_OFFSET        0x9
 108
 109   #define VBE_DISPI_ID0                   0xB0C0
 110   #define VBE_DISPI_ID1                   0xB0C1
 111   #define VBE_DISPI_ID2                   0xB0C2
 112
 113   #define VBE_DISPI_DISABLED              0x00
 114   #define VBE_DISPI_ENABLED               0x01
 115   #define VBE_DISPI_VBE_ENABLED           0x40
 116   #define VBE_DISPI_NOCLEARMEM            0x80
 117
 118   #define VBE_DISPI_LFB_PHYSICAL_ADDRESS  0xE0000000
 119
 120 API
 121 ---
 122   The display api works by using a index (VBE_DISPI_IOPORT_INDEX) and
 123   data (VBE_DISPI_IOPORT_DATA) ioport. One writes the index of the parameter to the index port.
 124   Next, the parameter value can be read or written.
 125
 126 [0xb0c0]
 127   * VBE_DISPI_INDEX_ID  : WORD {R,W}
 128     This parameter can be used to detect the current display API (both bochs & vbebios).
 129     The bios writes VBE_DISPI_ID0 to the dataport and reads it back again.
 130     This way, the display code knows the vbebios 'ID' and the vbebios can check if the correct
 131     display code is present.
 132     As a result, a PANIC can be generated if an incompatible vbebios/display code combination is detected.
 133     This panic can be generated from the bochs display code (NOT the bios, see Notes).
 134
 135     Example values: VBE_DISPI_ID0
 136
 137   * VBE_DISPI_INDEX_XRES : WORD {R,W}
 138     This parameter can be used to read/write the vbe display X resolution (in pixels).
 139     It's illegal to set the XRES when the VBE is enabled (display code should generate PANIC).
 140
 141     If the value written exceeds VBE_DISPI_MAX_XRES, the display code needs to generate a PANIC.
 142
 143     Example values:   320,640,800,1024
 144
 145   * VBE_DISPI_INDEX_YRES : WORD {R,W}
 146     This parameter can be used to read/write the vbe display Y resolution (in pixels).
 147     It's illegal to set the YRES when the VBE is enabled (display code should generate PANIC).
 148
 149     If the value written exceeds VBE_DISPI_MAX_YRES, the display code needs to generate a PANIC.
 150
 151     Example values:   200,400,480,600,768
 152
 153   * VBE_DISPI_INDEX_BPP : WORD {R,W}
 154     This parameter can be used to read/write the vbe display BPP.
 155     It's illegal to set the BPP when the VBE is enabled (display code should generate PANIC).
 156
 157     If the value written is an incompatible BPP, the display code needs to generate a PANIC.
 158
 159     Example values:   VBE_DISPI_BPP_8
 160
 161   * VBE_DISPI_INDEX_ENABLE : WORD {R,W}
 162     This parameter can be used to read/write the vbe ENABLED state.
 163     If the bios writes VBE_DISPI_ENABLED then the display code will setup a hostside display mode
 164     with the current XRES, YRES and BPP settings.
 165     If the bios write VBE_DISPI_DISABLED then the display code will switch back to normal vga mode behaviour.
 166
 167     Example values: VBE_DISPI_ENABLED, VBE_DISPI_DISABLED
 168
 169   * VBE_DISPI_INDEX_BANK : WORD {R,W}
 170     This parameter can be used to read/write the current selected BANK (at 0xA0000).
 171     This can be used for switching banks in banked mode.
 172
 173 [0xb0c1]
 174   * VBE_DISPI_INDEX_VIRT_WIDTH : WORD {R,W}
 175     This parameter can be used to read/write the current virtual width.
 176     Upon enabling a mode, this will be set to the current xres
 177     Setting this field during enabled mode will result in the virtual width to be changed.
 178     Value will be adjusted if current setting is not possible.
 179
 180   * VBE_DISPI_INDEX_VIRT_HEIGHT : WORD {R}
 181     This parameter can be read in order to obtain the current virtual height.
 182     This setting will be adjusted after setting a virtual width in order to stay within limit of video memory.
 183
 184   * VBE_DISPI_INDEX_X_OFFSET : WORD {R,W}
 185     The current X offset (in pixels!) of the visible screen part.
 186     Writing a new offset will also result in a complete screen refresh.
 187
 188   * VBE_DISPI_INDEX_Y_OFFSET : WORD {R,W}
 189     The current Y offset (in pixels!) of the visible screen part.
 190     Writing a new offset will also result in a complete screen refresh.
 191
 192
 193 [0xb0c2]
 194   * VBE_DISPI_INDEX_BPP : WORD {R,W}
 195     The value written is now the number of bits per pixel. A value of 0 is treated
 196     the same as 8 for backward compatibilty. These values are supported: 8, 15,
 197     16, 24 and 32. The value of 4 is not handled in the VBE code.
 198   * VBE_DISPI_INDEX_ENABLE : WORD {R,W}
 199     The new flag VBE_DISPI_NOCLEARMEM allows to preserve the VBE video memory.
 200     The new flag VBE_DISPI_LFB_ENABLED indicates the usage of the LFB.
 201
 202 [0xb0c3]
 203   * VBE_DISPI_INDEX_ENABLE : WORD {R,W}
 204     If the new flag VBE_DISPI_GETCAPS is enabled, the xres, yres and bpp registers
 205     return the gui capabilities.
 206
 207 Displaying GFX (banked mode)
 208 --------------
 209   What happens is that the total screen is devided in banks of 'VBE_DISPI_BANK_SIZE_KB' KiloByte in size.
 210   If you want to set a pixel you can calculate its bank by doing:
 211
 212     offset = pixel_x + pixel_y * resolution_x;
 213     bank = offset / 64 Kb (rounded 1.9999 -> 1)
 214
 215     bank_pixel_pos = offset - bank * 64Kb
 216
 217   Now you can set the current bank and put the pixel at VBE_DISPI_BANK_ADDRESS + bank_pixel_pos
 218
 219 Displaying GFX (linear frame buffer mode)
 220 --------------
 221   NOT WRITTEN YET
 222
 223 Notes
 224 -----
 225   * Since the XRES/YRES/BPP may not be written when VBE is enabled, if you want to switch from one VBE mode
 226     to another, you will need to disable VBE first.
 227
 228   * Note when the bios doesn't find a valid DISPI_ID, it can disable the VBE functions. This allows people to
 229     use the same bios for both vbe enabled and disabled bochs executables.