usr.sbin/pcvt/vgaio/vgaio.8

   1 .\"
   2 .\" Copyright (c) 1994 Joerg Wunsch
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" This program is free software.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by Joerg Wunsch
  19 .\" 4. The name of the developer may not be used to endorse or promote
  20 .\"    products derived from this software without specific prior written
  21 .\"    permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  24 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  25 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  26 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  28 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  32 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33 .\"
  34 .\" $FreeBSD$
  35 .\" -hm updated 31.12.94
  36 .\"
  37 .Dd December 31, 1994
  38 .Dt VGAIO 8
  39 .Os FreeBSD
  40 .Sh NAME
  41 .Nm vgaio
  42 .Nd perform input/output on a Video Graphics Array
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Op Fl d
  46 .Sh DESCRIPTION
  47 .Ss Purpose
  48 .Nm Vgaio
  49 is used to perform register-level input/output on a Video Graphics Array.
  50 Since some of the sequences required to access those registers are very
  51 silly,
  52 .Nm
  53 cares of all the things necessary and allows the user to access the
  54 registers of several register groups with their symbolic names.
  55 .Ss Options
  56 .Bl -tag -width 10n -offset indent
  57 .It Fl d
  58 Turn on the grammar parser debugger.
  59 .El
  60 .Ss Command language
  61 The command language of
  62 .Nm
  63 constitutes of some very simple tokens and rules.
  64 Commands are executed
  65 line by line as they are entered.
  66 Each line may contain any number of
  67 semicolon-separated input/output commands.
  68 .Pp
  69 Symbolic register names look like:
  70 .Pp
  71 .D1 Ao Em reggroup Ac Ns Aq Em regnumber
  72 .Pp
  73 with
  74 .Aq Em regnumber
  75 being any hexadecimal number
  76 .Pq without a leading Em 0x ,
  77 and
  78 .Aq Em reggroup
  79 one of the strings
  80 .Dq Em ar ,
  81 .Dq Em cr ,
  82 .Dq Em gr ,
  83 .Dq Em mi ,
  84 or
  85 .Dq Em sr ,
  86 standing for the
  87 .Em Attribute controller ,
  88 .Em CRT controller ,
  89 .Em Graphics controller ,
  90 .Em Miscellaneous Output Register ,
  91 or
  92 .Em Timing sequencer ,
  93 respectively.
  94 .Pp
  95 An input instruction has the form
  96 .Pp
  97 .D1 Ao Em regname Ac \&?
  98 .Pp
  99 and will cause
 100 .Nm
 101 to output a line like
 102 .Bd -ragged -offset indent
 103 .Aq Em regname
 104 .No = 0x Ns Aq Em number
 105 .Ed
 106 .Pp
 107 An output instruction looks like
 108 .Bd -ragged -offset indent
 109 .Ao Em regname Ac =
 110 .Aq Em number
 111 .Ed
 112 .Pp
 113 Spaces or Tabs between the
 114 .Aq Em reggroup ,
 115 the
 116 .Aq Em regnumber ,
 117 or any of the other tokens are ignored.
 118 They are not required anyway.
 119 .Pp
 120 The
 121 .Dq Em mi
 122 needs a single unused argument to satisfy the syntax :-) (-hm).
 123 .Ss Access control
 124 The caller must have uid 0 in order to gain the required access to
 125 the IO registers.
 126 .Sh HISTORY
 127 This program is considered
 128 .Dq hackware .
 129 It has been developed in order to simplify the process of developing other
 130 software that needs to program the Video Graphics Array.
 131 .Pp
 132 Remember, to use this program, your kernel has to be compiled with XSERVER
 133 being defined!
 134 .Sh AUTHORS
 135 The program has been contributed by
 136 .An J\(:org Wunsch ,
 137 Dresden
 138 .Aq joerg_wunsch@uriah.sax.de .