191 lines
5.4 KiB
Groff
191 lines
5.4 KiB
Groff
.\" Copyright (c) 1983, 1991 Regents of the University of California.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)ik.4 6.3 (Berkeley) 3/27/91
|
|
.\"
|
|
.Dd March 27, 1991
|
|
.Dt IK 4
|
|
.Os BSD 4.2
|
|
.Sh NAME
|
|
.Nm ik
|
|
.Nd Evans and Sutherland Picture System 300 graphics device interface
|
|
.Sh SYNOPSIS
|
|
.Cd "device ik0 at vba? csr 0xfffb100 vector ikintr"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm ik
|
|
driver provides access
|
|
to an Evans and
|
|
Sutherland Picture System 300 through an Ikon
|
|
.Tn DR-11W
|
|
interface card.
|
|
Each two minor device numbers are a different
|
|
.Tn PS300 ;
|
|
within a pair of device numbers the odd valued
|
|
device is used for ``diagnostic'' purposes. That is,
|
|
for even numbered minor devices, opening the device results
|
|
in a
|
|
.Tn PS300
|
|
``attach'' request being performed while for
|
|
odd numbered minor devices the attach request is not performed.
|
|
.Pp
|
|
All operations between the host and the
|
|
.Tn PS300
|
|
utilize
|
|
.Tn DMA .
|
|
The driver currently supports only physical
|
|
.Tn I/O operations
|
|
when reading and writing; this makes the device useless with
|
|
standard Evans and Sutherland software.
|
|
.Pp
|
|
The interface provided by the interface is as
|
|
.Ux Ns -like
|
|
as possible.
|
|
When a device is opened a
|
|
.Tn PS300
|
|
attach request is automatically
|
|
performed. When a device is closed a detach is performed. Reads
|
|
and writes result in physical
|
|
.Tn I/O
|
|
requests, but hide all the details
|
|
of the physical
|
|
.Tn I/O
|
|
protocol. This is programming style is completely
|
|
different from the
|
|
.Tn VMS Ns -oriented
|
|
qio-style interface supplied by Evans
|
|
and Sutherland.
|
|
.Pp
|
|
Reads and writes to the device result in a physical
|
|
.Tn I/O
|
|
request
|
|
to the
|
|
.Tn PS300 .
|
|
If a
|
|
.Xr readv 2
|
|
or
|
|
.Xr writev 2
|
|
call is used, each
|
|
.Tn I/O
|
|
request results in a single physical
|
|
.Tn I/O
|
|
request (i.e. the scatter-gather facilities are not supported).
|
|
In normal operation, the address used in a physical
|
|
.Tn I/O
|
|
request
|
|
is the current file offset as specified explicitly with
|
|
.Xr lseek 2
|
|
or implictly as a result of reading or writing the device.
|
|
To specify an address to be used with each physical
|
|
.Tn I/O
|
|
request,
|
|
the
|
|
.Nm ik
|
|
driver interprets the
|
|
.Ar iov
|
|
entries in a non-standard way. If
|
|
.Ar iov_len
|
|
is zero, then
|
|
.Ar iov_base
|
|
is interpreted as an address to be used in the physical
|
|
.Tn I/O
|
|
request. If the address has the
|
|
.Dv PSIO_SYNC
|
|
flag or-d into it,
|
|
the physical
|
|
.Tn I/O
|
|
request is made as a ``write with sync''.
|
|
All addresses and data presented to the driver should be in
|
|
the byte order of the host; any byte swapping required to converse
|
|
with the
|
|
.Tn PS300
|
|
is performed in the driver/controller.
|
|
.Pp
|
|
In addition to reading and writing, the following
|
|
.Xr ioctl
|
|
requests are available:
|
|
.Bl -tag -width PSIOGETERROR
|
|
.It Dv PSIOLOOKUP
|
|
Perform a ``name lookup'' request. The
|
|
.Ar pslookup
|
|
structure passed indicates the symbol name to be looked up
|
|
and contains the address returned by the
|
|
.Tn PS300 .
|
|
A zero
|
|
address return indicates the symbol was undefined.
|
|
.It Dv PSIOGETERROR
|
|
In the event of an error, this request may be made to
|
|
return a more detailed and, sometimes
|
|
.Tn PS300 Ns -specific ,
|
|
error code.
|
|
.Sh FILES
|
|
.Bl -tag -width /dec/ik[0-7]xx -compact
|
|
.It Pa /dev/ik[0-7]
|
|
auto-attach devices
|
|
.It Pa /dev/ik[0-7]d
|
|
diagnostic interfaces to devices
|
|
.El
|
|
.Sh DIAGNOSTICS
|
|
.Bl -diag
|
|
.It ik%d: bad cmd %x.
|
|
An unknown or unsupported command was received by the host.
|
|
.It ik%d: spurious interrupt, code %x.
|
|
An unexpected interrupt was received from the
|
|
.Tn PS300 ;
|
|
the
|
|
attention code from the
|
|
.Tn PS300
|
|
is printed.
|
|
.It ik%d: timeout.
|
|
A command failed to elicit a response within a reasonable
|
|
time; the
|
|
.Tn PS300
|
|
probably crashed.
|
|
.El
|
|
.Sh HISTORY
|
|
The
|
|
Tahoe Version
|
|
.Nm
|
|
driver appeared in
|
|
.Bx 4.2 .
|
|
.Sh BUGS
|
|
An invalid access (e.g. illegal address) to the
|
|
.Tn PS300
|
|
can
|
|
cause the
|
|
.Tn PS300
|
|
to crash. It is not always possible to unwedge
|
|
the
|
|
.Tn PS300
|
|
interface hardware hung by an
|
|
.Tn I/O
|
|
request.
|