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 .Sh NAME
  40 .Nm vgaio
  41 .Nd perform input/output on a Video Graphics Array
  42 .Sh SYNOPSIS
  43 .Nm vgaio
  44 .Op Fl d
  45 .Sh DESCRIPTION
  46 .Ss Purpose
  47 .Nm Vgaio
  48 is used to perform register-level input/output on a Video Graphics Array.
  49 Since some of the sequences required to access those registers are very
  50 silly,
  51 .Nm vgaio
  52 cares of all the things necessary and allows the user to access the
  53 registers of several register groups with their symbolic names.
  54
  55 .Ss Options
  56 .Bl -tag -width 10n -offset indent
  57 .It Fl d
  58 Turn on the grammar parser debugger.
  59
  60 .El
  61 .Ss Command language
  62 The command language of
  63 .Nm
  64 constitutes of some very simple tokens and rules.
  65 Commands are executed
  66 line by line as they are entered.
  67 Each line may contain any number of
  68 semicolon-separated input/output commands.
  69
  70 Symbolic register names look like:
  71
  72 .D1 Ao Em reggroup Ac Ao Em regnumber Ac
  73
  74 with
  75 .Aq Em regnumber
  76 being any hexadecimal number
  77 .Pq without a leading Em 0x ,
  78 and
  79 .Aq Em reggroup
  80 one of the strings
  81 .Dq Em ar ,
  82 .Dq Em cr ,
  83 .Dq Em gr ,
  84 .Dq Em mi ,
  85 or
  86 .Dq Em sr ,
  87 standing for the
  88 .Em Attribute controller ,
  89 .Em CRT controller ,
  90 .Em Graphics controller ,
  91 .Em Miscellaneous Output Register ,
  92 or
  93 .Em Timing sequencer ,
  94 respectively.
  95
  96 An input instruction has the form
  97
  98 .D1 Ao Em regname Ac ?
  99
 100 and will cause
 101 .Nm
 102 to output a line like
 103
 104 .Bd -ragged -offset indent
 105 .Ao Em regname Ac \& = 0x Ns
 106 .Aq Em number
 107 .Ed
 108
 109 An output instruction looks like
 110
 111 .Bd -ragged -offset indent
 112 .Ao Em regname Ac =
 113 .Aq Em number
 114 .Ed
 115
 116 Spaces or Tabs between the
 117 .Aq Em reggroup ,
 118 the
 119 .Aq Em regnumber ,
 120 or any of the other tokens are ignored.
 121 They are not required anyway.
 122
 123 The
 124 .Dq Em mi
 125 needs a single unused argument to satisfy the syntax :-) (-hm).
 126
 127
 128 .Ss Access control
 129 The caller must have uid 0 in order to gain the required access to
 130 the IO registers.
 131
 132 .Sh HISTORY
 133 This program is considered
 134 .Dq hackware .
 135 It has been developed in order to simplify the process of developing other
 136 software that needs to program the Video Graphics Array.
 137
 138 Remember, to use this program, your kernel has to be compiled with XSERVER
 139 being defined !
 140
 141 .Sh AUTHORS
 142 The program has been contributed by
 143 .if n Joerg Wunsch,
 144 .if t J\(:org Wunsch,
 145 Dresden
 146 .Aq joerg_wunsch@uriah.sax.de .