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