xref: /netbsd-src/share/man/man4/man4.vax/ik.4 (revision 075022b349321510ad14036d70908681ed02f117)
1.\"	$NetBSD: ik.4,v 1.9 2003/08/07 10:31:13 agc 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. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"     from: @(#)ik.4	8.1 (Berkeley) 6/5/93
31.\"
32.Dd June 5, 1993
33.Dt IK 4 vax
34.Os
35.Sh NAME
36.Nm ik
37.Nd Ikonas frame buffer, graphics device interface
38.Sh SYNOPSIS
39.Cd "ik0 at uba? csr 0172460 vector ikintr"
40.Sh DESCRIPTION
41NOTE: This driver has not been ported from
42.Bx 4.4
43yet.
44.Pp
45The
46.Nm ik
47driver
48provides an interface to an Ikonas frame buffer graphics device.
49Each minor device is a different frame buffer interface board.
50When the device is opened, its interface registers are mapped,
51via virtual memory, into the user processes address space.
52This allows the user process very high bandwidth to the frame buffer
53with no system call overhead.
54.Pp
55Bytes written or read from the device are
56.Tn DMA Ns 'ed
57from or to the interface.
58The frame buffer
59.Tn XY
60address, its addressing mode, etc. must be set up by the
61user process before calling write or read.
62.Pp
63Other communication with the driver is via ioctls.
64The
65.Dv IK_GETADDR
66.Xr ioctl 2
67returns the virtual address where the user process can
68find the interface registers.
69The
70.Dv IK_WAITINT
71.Xr ioctl 2
72suspends the user process until the ikonas device
73has interrupted (for whatever reason \(em the user process has to set
74the interrupt enables).
75.Sh FILES
76.Bl -tag -width /dev/ikxx -compact
77.It Pa /dev/ik
78.El
79.Sh DIAGNOSTICS
80None.
81.Sh HISTORY
82The
83.Nm
84driver appeared in
85.Bx 4.2 .
86.Sh BUGS
87An invalid access (e.g., longword) to a mapped interface register
88can cause the system to crash with a machine check.
89A user process could possibly cause infinite interrupts hence
90bringing things to a crawl.
91