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 .\" $Id: $
  28 .\"
  29 .Dd February 6, 1999
  30 .Dt VGA 4 i386
  31 .Os FreeBSD
  32 .Sh NAME
  33 .Nm vga
  34 .Nd
  35 generic video card interface
  36 .Sh SYNOPSIS
  37 .Cd "options" \&"VESA\&"
  38 .Cd "options" \&"VESA_DEBUG=N\&"
  39 .Cd "options" \&"VGA_ALT_SEQACCESS\&"
  40 .Cd "options" \&"VGA_NO_FONT_LOADING\&"
  41 .Cd "options" \&"VGA_NO_MODE_CHANGE\&"
  42 .Cd "options" \&"VGA_SLOW_IOACCESS\&"
  43 .Cd "options" \&"VM86\&"
  44 .Cd "device vga0 at isa? port ? conflicts"
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 driver is a generic video card driver which provides access to
  49 video cards.  This driver is required for the console driver
  50 .Xr syscons 4 .
  51 The console driver will call the
  52 .Nm
  53 driver to manipulate video hardware (changing video modes, loading font, etc).
  54 .Pp
  55 The
  56 .Nm
  57 driver supports the standard video cards: MDA, CGA, EGA and VGA.
  58 In addition, the driver can utilize the VESA BIOS extension,
  59 if the video card has one.
  60 VESA support can either be statically included in the kernel or
  61 available as a separate module.
  62 .Pp
  63 In order to statically link the support to the kernel, define the
  64 .Em VESA
  65 option (see below) and the
  66 .Em VM86
  67 option in the kernel configuration file.
  68 .Pp
  69 The
  70 .Nm vesa
  71 module can be loaded to the kernel, without static VESA support, by
  72 .Xr kldload 8 .
  73 The
  74 .Em VM86
  75 option is required in the kernel configuration file in this case too.
  76 .Sh DRIVER CONFIGURATION
  77 .Ss Kernel Configuration Options
  78 The following kernel configuration options control the
  79 .Nm
  80 driver.
  81 They may be set in the kernel configuration file
  82 .Pq see Xr config 8 .
  83 .Pp
  84 The following options are to provide compatibility with certain VGA
  85 cards.
  86 .Bl -tag -width MOUSE
  87 .It Em VGA_ALT_SEQACCESS
  88 You may want to try this option if the mouse pointer is not drawn correctly
  89 or font does not seem to be loaded properly on the VGA card.
  90 However, it may cause flicker on some systems.
  91 .It Em VGA_SLOW_IOACCESS
  92 Older VGA cards may require this option for proper operation.
  93 It makes the driver perform byte-wide I/O to VGA registers and
  94 slow down a little.
  95 .El
  96 .Pp
  97 The following options add optional features to the driver.
  98 .Bl -tag -width MOUSE
  99 .It Em VESA
 100 Add VESA BIOS support to the driver.
 101 If the VGA card has the VESA BIOS extension 1.2 or later,
 102 this option will utilize the VESA BIOS service to switch to high
 103 resolution modes.
 104 This option requires the
 105 .Em VM86
 106 option.
 107 .It Em VESA_DEBUG=N
 108 Set the VESA support debug level to N.
 109 The default value is zero (all debugging output is suppressed).
 110 .El
 111 .Pp
 112 The following options will remove some features from the
 113 .Nm
 114 driver and save kernel memory.
 115 .Bl -tag -width MOUSE
 116 .It Em VGA_NO_FONT_LOADING
 117 The
 118 .Nm
 119 driver can load software font to EGA and VGA cards.
 120 This option removes this feature.
 121 .It Em VGA_NO_MODE_CHANGE
 122 This option disallows the driver to change video modes.
 123 .El
 124 .\".Sh FILES
 125 .Sh EXAMPLE
 126 Your kernel configuration should normally have:
 127 .Pp
 128 .Dl "device vga0 at isa? port ? conflicts"
 129 .Pp
 130 The following lines should be included in the kernel configuration file
 131 in order to enable the VESA BIOS Extension support.
 132 .Pp
 133 .Dl "options" \&"VM86\&"
 134 .Dl "options" \&"VESA\&"
 135 .Dl "device vga0 at isa? port ? conflicts"
 136 .Pp
 137 If you do not want the VESA support always included in the kernel, but
 138 want to use occasionally, add the following lines to the kernel configuration
 139 file.
 140 .Pp
 141 .Dl "options" \&"VM86\&"
 142 .Dl "device vga0 at isa? port ? conflicts"
 143 .Pp
 144 And load the
 145 .Nm vesa
 146 module, when desired, as follows.
 147 .Pp
 148 .Dl kldload vesa
 149 .Pp
 150 .\".Sh DIAGNOSTICS
 151 .\".Sh CAVEATS
 152 .\".Sh BUGS
 153 .Sh SEE ALSO
 154 .Xr kldload 8 ,
 155 .Xr kldunload 8 .
 156 .Sh STANDARD
 157 .Rs
 158 .%T "VESA BIOS Extension (VBE)"
 159 .%A Video Electronics Standards Association
 160 .Re
 161 .Sh HISTORY
 162 The
 163 .Nm
 164 driver first appeared in
 165 .Fx 3.1 .
 166 .Sh AUTHORS
 167 The
 168 .Nm
 169 driver was written by
 170 .An Søren Schmidt Aq sos@FreeBSD.org
 171 and
 172 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
 173 This manual page was written by
 174 .An Kazutaka Yokota .