xref: /netbsd/share/man/man4/man4.vax/ps.4 (revision bf9ec67e)
1.\"	$NetBSD: ps.4,v 1.8 2001/08/18 14:37:48 wiz Exp $
2.\"
3.\" Copyright (c) 1983, 1991, 1993
4.\"	The Regents of the University of California.  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.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     from: @(#)ps.4	8.1 (Berkeley) 6/5/93
35.\"
36.Dd June 5, 1993
37.Dt PS 4 vax
38.Os
39.Sh NAME
40.Nm ps
41.Nd Evans and Sutherland Picture System 2 graphics device interface
42.Sh SYNOPSIS
43.Cd "ps0 at uba? csr 0172460 vector psclockintr pssystemintr"
44.Sh DESCRIPTION
45NOTE: This driver has not been ported from
46.Bx 4.4
47yet.
48.Pp
49The
50.Nm ps
51driver provides access
52to an Evans and
53Sutherland Picture System 2 graphics device.
54Each minor device is a new
55.Tn PS2 .
56When the device is opened, its interface registers are mapped,
57via virtual memory, into a user process's address space.
58This allows the user process very high bandwidth to the device
59with no system call overhead.
60.Pp
61.Tn DMA
62to and from the
63.Tn PS2
64is not supported. All read and write
65system calls will fail.
66All data is moved to and from the
67.Tn PS2
68via programmed
69.Tn I/O
70using
71the device's interface registers.
72.Pp
73Commands are fed to and from the driver using the following
74.Xr ioctl 2 Ns s :
75.Bl -tag -width PSIOSINGLEREFRESH
76.It Dv PSIOGETADDR
77Returns the virtual address through which the user process can access
78the device's interface registers.
79.It Dv PSIOAUTOREFRESH
80Start auto refreshing the screen.
81The argument is an address in user space where the following data resides.
82The first longword is a
83.Em count
84of the number of static refresh buffers.
85The next
86.Em count
87longwords are the addresses in refresh memory where
88the refresh buffers lie.
89The driver will cycle through these refresh buffers displaying them one by one
90on the screen.
91.It Dv PSIOAUTOMAP
92Start automatically passing the display file through the matrix processor and
93into the refresh buffer.
94The argument is an address in user memory where the following data resides.
95The first longword is a
96.Em count
97of the number of display files to operate on.
98The next
99.Em count
100longwords are the address of these display files.
101The final longword is the address in refresh buffer memory where transformed
102coordinates are to be placed if the driver is not in double buffer mode (see
103below).
104.It Dv PSIODOUBLEBUFFER
105Cause the driver to double buffer the output from the map that
106is going to the refresh buffer.
107The argument is again a user space address where the real arguments are stored.
108The first argument is the starting address of refresh memory where the two
109double buffers are located.
110The second argument is the length of each double buffer.
111The refresh mechanism displays the current double buffer, in addition
112to its static refresh lists, when in double buffer mode.
113.It Dv PSIOSINGLEREFRESH
114Single step the refresh process. That is, the driver does not continually
115refresh the screen.
116.It Dv PSIOSINGLEMAP
117Single step the matrix process.
118The driver does not automatically feed display files through the matrix unit.
119.It Dv PSIOSINGLEBUFFER
120Turn off double buffering.
121.It Dv PSIOTIMEREFRESH
122The argument is a count of the number of refresh interrupts to take
123before turning off the screen.  This is used to do time exposures.
124.It Dv PSIOWAITREFRESH
125Suspend the user process until a refresh interrupt has occurred.
126If in
127.Dv TIMEREFRESH
128mode, suspend until count refreshes have occurred.
129.It Dv PSIOSTOPREFRESH
130Wait for the next refresh, stop all refreshes, and then return to user process.
131.It Dv PSIOWAITMAP
132Wait until a map done interrupt has occurred.
133.It Dv PSIOSTOPMAP
134Wait for a map done interrupt, do not restart the map, and then
135return to the user.
136.El
137.Sh FILES
138.Bl -tag -width /dev/psxx
139.It Pa /dev/ps
140.El
141.Sh DIAGNOSTICS
142.Bl -diag
143.It ps device intr.
144.It ps dma intr.
145An interrupt was received from the device.
146This shouldn't happen,
147check your device configuration for overlapping interrupt vectors.
148.El
149.Sh HISTORY
150The
151.Nm
152driver appeared in
153.Bx 4.2 .
154.Sh BUGS
155An invalid access (e.g., longword) to a mapped interface register
156can cause the system to crash with a machine check.
157A user process could possibly cause infinite interrupts hence
158bringing things to a crawl.
159