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: src/share/man/man4/vga.4,v 1.7.2.10 2002/12/20 18:03:05 trhodes Exp $
  28 .\"
  29 .Dd December 14, 2009
  30 .Dt VGA 4
  31 .Os
  32 .Sh NAME
  33 .Nm vga ,
  34 .Nm vesa
  35 .Nd generic video card interface
  36 .Sh SYNOPSIS
  37 .Cd "options VESA"
  38 .Cd "options VESA_DEBUG=N"
  39 .Cd "options VGA_KEEP_POWERON_MODE"
  40 .Cd "options VGA_NO_FONT_LOADING"
  41 .Cd "options VGA_NO_MODE_CHANGE"
  42 .Cd "options VGA_DEBUG=N"
  43 .Cd "options VGA_WIDTH90"
  44 .Cd "device vga0 at isa? port ?"
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 driver is a generic video card driver which provides access to
  49 video cards.
  50 This driver is required for the console driver
  51 .Xr syscons 4 .
  52 The console driver will call the
  53 .Nm
  54 driver to manipulate video hardware (changing video modes, loading font, etc).
  55 .Pp
  56 The
  57 .Nm
  58 driver supports the standard VGA video cards.
  59 In addition, the driver can utilize the VESA BIOS Extension if the video card
  60 supports it.
  61 VESA support can either be statically included in the kernel
  62 or can be loaded as a separate module.
  63 .Pp
  64 In order to statically link the VESA support into the kernel, the
  65 .Dv VESA
  66 option (see below) must be defined in the kernel configuration file.
  67 .Pp
  68 The
  69 .Nm vesa
  70 module can be dynamically loaded into the kernel using
  71 .Xr kldload 8 .
  72 .Sh DRIVER CONFIGURATION
  73 .Ss Kernel Configuration Options
  74 The following kernel configuration options
  75 (see
  76 .Xr config 8 )
  77 can be used to control the
  78 .Nm
  79 driver.
  80 These options provide compatibility with certain VGA cards.
  81 .Bl -tag -width ".Dv VGA_KEEP_POWERON_MODE"
  82 .It Dv VGA_DEBUG=N
  83 Set the VGA support debug level to
  84 .Fa N .
  85 The default value is 0, which suppresses all debugging output.
  86 A value of 2 gives maximum verbosity.
  87 .It Dv VGA_KEEP_POWERON_MODE
  88 This option keeps the initial mode's register settings for switching back
  89 to it from another mode.
  90 .It Dv VGA_WIDTH90
  91 This option enables 90 column modes: 90x25, 90x30, 90x43, 90x50, 90x60.
  92 These modes are not always supported by the video card and the display.
  93 It is highly likely that LCD display cannot work with these modes.
  94 .El
  95 .Pp
  96 The following options will remove some features from the
  97 .Nm
  98 driver and save kernel memory.
  99 .Bl -tag -width ".Dv VGA_KEEP_POWERON_MODE"
 100 .It Dv VGA_NO_FONT_LOADING
 101 This option removes font loading from the driver.
 102 Note that if you use this option and
 103 still wish to use the mouse on the console then you must also use the
 104 .Dv SC_ALT_MOUSE_IMAGE
 105 option.
 106 See
 107 .Xr syscons 4 .
 108 .It Dv VGA_NO_MODE_CHANGE
 109 This option prevents the driver from changing video modes.
 110 .El
 111 .Pp
 112 The following options add optional features to the driver.
 113 .Bl -tag -width ".Dv VGA_KEEP_POWERON_MODE"
 114 .It Dv VESA
 115 Add VESA BIOS Extension support to the driver.
 116 If the VGA card has the VESA BIOS Extension 1.2 or later,
 117 this option will utilize it to switch to high resolution modes.
 118 .It Dv VESA_DEBUG=N
 119 Set the VESA support debug level to
 120 .Fa N .
 121 The default value is 0, which suppresses all debugging output.
 122 A value of 2 gives maximum verbosity.
 123 .El
 124 .Sh EXAMPLES
 125 Your kernel configuration should normally have:
 126 .Pp
 127 .D1 Cd "device vga0 at isa? port ?"
 128 .Pp
 129 The following line should be included in the kernel configuration file
 130 in order to enable the VESA BIOS Extension support.
 131 .Pp
 132 .D1 Cd "options VESA"
 133 .Pp
 134 If you do not want VESA support included in the kernel, but
 135 want to use occasionally, do not add the
 136 .Dv VESA
 137 option.
 138 And load the
 139 .Nm vesa
 140 module as desired:
 141 .Pp
 142 .Dl kldload vesa
 143 .Sh SEE ALSO
 144 .Xr vgl 3 ,
 145 .Xr syscons 4 ,
 146 .Xr config 8 ,
 147 .Xr kldload 8 ,
 148 .Xr kldunload 8
 149 .Sh STANDARDS
 150 .Rs
 151 .%A "Apple, IBM, Motorola"
 152 .%T "Common Hardware Reference Platform: I/O Device Reference"
 153 .%B "Appendix A: VGA Programming Model"
 154 .%P "p. 195"
 155 .%O "ftp://ftp.software.ibm.com/rs6000/technology/spec/chrp/"
 156 .Re
 157 .Pp
 158 .Rs
 159 .%T "VESA BIOS Extension (VBE)"
 160 .%A Video Electronics Standards Association
 161 .Re
 162 .Sh HISTORY
 163 The
 164 .Nm
 165 driver first appeared in
 166 .Fx 3.1 .
 167 .Sh AUTHORS
 168 .An -nosplit
 169 The
 170 .Nm
 171 driver was written by
 172 .An S\(/oren Schmidt Aq Mt sos@FreeBSD.org
 173 and
 174 .An Kazutaka Yokota Aq Mt yokota@FreeBSD.org .
 175 This manual page was written by
 176 .An Kazutaka Yokota .