share/man/man4/vga.4

   1 .\"
   2 .\" Copyright (c) 1999
   3 .\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer as
  11 .\"    the first lines of this file unmodified.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd June 30, 1999
  30 .Dt VGA 4
  31 .Os
  32 .Sh NAME
  33 .Nm vga
  34 .Nd generic video card interface
  35 .Sh SYNOPSIS
  36 .Cd "options VESA"
  37 .Cd "options VESA_DEBUG=N"
  38 .Cd "options VGA_ALT_SEQACCESS"
  39 .Cd "options VGA_NO_FONT_LOADING"
  40 .Cd "options VGA_NO_MODE_CHANGE"
  41 .Cd "options VGA_SLOW_IOACCESS"
  42 .Cd "options VGA_WIDTH90"
  43 .Cd "device vga"
  44 .Pp
  45 In
  46 .Pa /boot/device.hints :
  47 .Cd hint.vga.0.at="isa"
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver is a generic video card driver which provides access to
  52 video cards.
  53 This driver is required for the console driver
  54 .Xr syscons 4 .
  55 The console driver will call the
  56 .Nm
  57 driver to manipulate video hardware (changing video modes, loading font, etc).
  58 .Pp
  59 The
  60 .Nm
  61 driver supports the standard video cards: MDA, CGA, EGA and VGA.
  62 In
  63 addition, the driver can utilize VESA BIOS extensions if the video card
  64 supports them.
  65 VESA support can either be statically included in the kernel
  66 or can be loaded as a separate module.
  67 .Pp
  68 In order to statically link the VESA support to the kernel, the
  69 .Dv VESA
  70 option (see below) must be defined in the kernel configuration file.
  71 .Pp
  72 The
  73 .Nm vesa
  74 module can be dynamically loaded into the kernel using
  75 .Xr kldload 8 .
  76 .Sh DRIVER CONFIGURATION
  77 .Ss Kernel Configuration Options
  78 The following kernel configuration options
  79 (see
  80 .Xr config 8 )
  81 can be used to control the
  82 .Nm
  83 driver.
  84 These options provide compatibility with certain VGA cards.
  85 .Bl -tag -width MOUSE
  86 .It Dv VGA_ALT_SEQACCESS
  87 You may want to try this option if the mouse pointer is not drawn correctly
  88 or the font does not seem to be loaded properly on the VGA card.
  89 However, it may cause flicker on some systems.
  90 .It Dv VGA_SLOW_IOACCESS
  91 Older VGA cards may require this option for proper operation.
  92 It makes the driver perform byte-wide I/O to VGA registers and
  93 slow down a little.
  94 .It Dv VGA_WIDTH90
  95 This option enables 90 column modes: 90x25, 90x30, 90x43, 90x50, 90x60.
  96 These modes are not always supported by the video card and the display.
  97 It is highly likely that LCD display cannot work with these modes.
  98 .El
  99 .Pp
 100 The following options add optional features to the driver.
 101 .Bl -tag -width MOUSE
 102 .It Dv VESA
 103 Add VESA BIOS support to the driver.
 104 If the VGA card has the VESA BIOS extension 1.2 or later,
 105 this option will utilize the VESA BIOS service to switch to high
 106 resolution modes.
 107 .It Dv VESA_DEBUG=N
 108 Set the VESA support debug level to
 109 .Fa N .
 110 The default value is zero, which suppresses all debugging output.
 111 .El
 112 .Pp
 113 The following options will remove some features from the
 114 .Nm
 115 driver and save kernel memory.
 116 .Bl -tag -width MOUSE
 117 .It Dv VGA_NO_FONT_LOADING
 118 The
 119 .Nm
 120 driver can load software font to EGA and VGA cards.
 121 This option removes this feature.
 122 Note that if you use this option and
 123 still wish to use the mouse on the console then you must also use the
 124 .Dv SC_ALT_MOUSE_IMAGE
 125 option.
 126 See
 127 .Xr syscons 4 .
 128 .It Dv VGA_NO_MODE_CHANGE
 129 This option prevents the driver from changing video modes.
 130 .El
 131 .\".Sh FILES
 132 .Sh EXAMPLES
 133 Your kernel configuration should normally have:
 134 .Pp
 135 .Dl "device vga"
 136 .Pp
 137 And you need the following line in
 138 .Pa /boot/device.hints .
 139 .Pp
 140 .Dl hint.vga.0.at="isa"
 141 .Pp
 142 The following lines should be included in the kernel configuration file
 143 in order to enable the VESA BIOS Extension support.
 144 .Pp
 145 .Dl "options VESA"
 146 .Dl "device vga"
 147 .Pp
 148 If you do not want VESA support included in the kernel, but
 149 want to use occasionally, do not add the
 150 .Dv VESA
 151 option.
 152 And load the
 153 .Nm vesa
 154 module as desired:
 155 .Pp
 156 .Dl kldload vesa
 157 .\".Sh DIAGNOSTICS
 158 .\".Sh CAVEATS
 159 .\".Sh BUGS
 160 .Sh SEE ALSO
 161 .Xr vgl 3 ,
 162 .Xr syscons 4 ,
 163 .Xr config 8 ,
 164 .Xr kldload 8 ,
 165 .Xr kldunload 8
 166 .Sh STANDARDS
 167 .Rs
 168 .%T "VESA BIOS Extension (VBE)"
 169 .%A Video Electronics Standards Association
 170 .Re
 171 .Sh HISTORY
 172 The
 173 .Nm
 174 driver first appeared in
 175 .Fx 3.1 .
 176 .Sh AUTHORS
 177 .An -nosplit
 178 The
 179 .Nm
 180 driver was written by
 181 .An S\(/oren Schmidt Aq sos@FreeBSD.org
 182 and
 183 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
 184 This manual page was written by
 185 .An Kazutaka Yokota .