xref: /netbsd-src/share/man/man4/man4.vax/ps.4 (revision cda4f8f6ee55684e8d311b86c99ea59191e6b74f)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  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.\"     @(#)ps.4	8.1 (Berkeley) 6/5/93
33.\"
34.Dd June 5, 1993
35.Dt PS 4 vax
36.Os BSD 4.2
37.Sh NAME
38.Nm ps
39.Nd Evans and Sutherland Picture System 2 graphics device interface
40.Sh SYNOPSIS
41.Cd "device ps0 at uba? csr 0172460 vector psclockintr pssystemintr"
42.Sh DESCRIPTION
43The
44.Nm ps
45driver provides access
46to an Evans and
47Sutherland Picture System 2 graphics device.
48Each minor device is a new
49.Tn PS2 .
50When the device is opened, its interface registers are mapped,
51via virtual memory, into a user process's address space.
52This allows the user process very high bandwidth to the device
53with no system call overhead.
54.Pp
55.Tn DMA
56to and from the
57.Tn PS2
58is not supported. All read and write
59system calls will fail.
60All data is moved to and from the
61.Tn PS2
62via programmed
63.Tn I/O
64using
65the device's interface registers.
66.Pp
67Commands are fed to and from the driver using the following
68.Xr ioctl 2 Ns s :
69.Bl -tag -width PSIOSINGLEREFRESH
70.It Dv PSIOGETADDR
71Returns the virtual address through which the user process can access
72the device's interface registers.
73.It Dv PSIOAUTOREFRESH
74Start auto refreshing the screen.
75The argument is an address in user space where the following data resides.
76The first longword is a
77.Em count
78of the number of static refresh buffers.
79The next
80.Em count
81longwords are the addresses in refresh memory where
82the refresh buffers lie.
83The driver will cycle through these refresh buffers displaying them one by one
84on the screen.
85.It Dv PSIOAUTOMAP
86Start automatically passing the display file through the matrix processor and
87into the refresh buffer.
88The argument is an address in user memory where the following data resides.
89The first longword is a
90.Em count
91of the number of display files to operate on.
92The next
93.Em count
94longwords are the address of these display files.
95The final longword is the address in refresh buffer memory where transformed
96coordinates are to be placed if the driver is not in double buffer mode (see
97below).
98.It Dv PSIODOUBLEBUFFER
99Cause the driver to double buffer the output from the map that
100is going to the refresh buffer.
101The argument is again a user space address where the real arguments are stored.
102The first argument is the starting address of refresh memory where the two
103double buffers are located.
104The second argument is the length of each double buffer.
105The refresh mechanism displays the current double buffer, in addition
106to its static refresh lists, when in double buffer mode.
107.It Dv PSIOSINGLEREFRESH
108Single step the refresh process. That is, the driver does not continually
109refresh the screen.
110.It Dv PSIOSINGLEMAP
111Single step the matrix process.
112The driver does not automatically feed display files through the matrix unit.
113.It Dv PSIOSINGLEBUFFER
114Turn off double buffering.
115.It Dv PSIOTIMEREFRESH
116The argument is a count of the number of refresh interrupts to take
117before turning off the screen.  This is used to do time exposures.
118.It Dv PSIOWAITREFRESH
119Suspend the user process until a refresh interrupt has occurred.
120If in
121.Dv TIMEREFRESH
122mode, suspend until count refreshes have occurred.
123.It Dv PSIOSTOPREFRESH
124Wait for the next refresh, stop all refreshes, and then return to user process.
125.It Dv PSIOWAITMAP
126Wait until a map done interrupt has occurred.
127.It Dv PSIOSTOPMAP
128Wait for a map done interrupt, do not restart the map, and then
129return to the user.
130.El
131.Sh FILES
132.Bl -tag -width /dev/psxx
133.It Pa /dev/ps
134.El
135.Sh DIAGNOSTICS
136.Bl -diag
137.It ps device intr.
138.It ps dma intr.
139An interrupt was received from the device.
140This shouldn't happen,
141check your device configuration for overlapping interrupt vectors.
142.El
143.Sh HISTORY
144The
145.Nm
146driver appeared in
147.Bx 4.2 .
148.Sh BUGS
149An invalid access (e.g., longword) to a mapped interface register
150can cause the system to crash with a machine check.
151A user process could possibly cause infinite interrupts hence
152bringing things to a crawl.
153