Fix mdoc(7)/man(7) mix up.
[netbsd-mini2440.git] / share / man / man4 / spif.4
blob52686489cb89bb4986be3ba1b308a53885e54701
1 .\"     $NetBSD: spif.4,v 1.3 2005/06/23 12:47:38 peter Exp $
2 .\"     $OpenBSD: spif.4,v 1.12 2003/11/09 16:06:07 jmc Exp $
3 .\"
4 .\" Copyright (c) 1999 Jason L. Wright (jason@thought.net)
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 .\" POSSIBILITY OF SUCH DAMAGE.
27 .\"
28 .Dd February 4, 1999
29 .Dt SPIF 4
30 .Os
31 .Sh NAME
32 .Nm spif
33 .Nd SBus (spiffy) Serial/Parallel Interface
34 .Sh SYNOPSIS
35 .Cd "spif* at sbus? slot ? offset ?                " Pq "sun4c/sun4m"
36 .Cd "stty* at spif?                                " Pq "sun4c/sun4m"
37 .Cd "sbpp* at spif?                                " Pq "sun4c/sun4m"
38 .Sh DESCRIPTION
39 The
40 .Nm spif
41 driver provides support for the Sun Serial/Parallel Interface card
42 (Sun part number 501-1931)
43 based around the
44 Cirrus Logic CD180 octal serial controller
45 and the
46 Cirrus Logic PPC2 parallel port controller.
47 .Pp
48 The device minor numbers for this driver are encoded as follows:
49 .Bd -literal
50     +---+---+---+---+---+---+---+---+
51     | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
52     +---+---+---+---+---+---+---+---+
53       |   |   |   |   |   |   |   |
54       |   |   |   |   |   +---+---+---> port number
55       |   |   |   |   |
56       |   |   |   |   +---------------> unused
57       |   |   |   |
58       |   |   |   +-------------------> dial-out (on tty ports)
59       |   |   |
60       |   |   +-----------------------> unused
61       |   |
62       +---+---------------------------> card number
63 .Ed
64 .Pp
65 Up to four cards are supported in the system.
66 .Pp
67 Each of the serial ports has an 8 byte FIFO for receive and transmit as
68 well as automatic hardware (RTS/CTS) flow control.
69 .Sh FILES
70 .Bl -tag -width /dev/tty[jkl][0-7] -compact
71 .It /dev/tty[jkl][0-7]
72 Serial ports
73 .It /dev/sbpp[0-3]
74 Parallel ports
75 .El
76 .Sh DIAGNOSTICS
77 .Bl -diag
78 .It "spif%d: ccr timeout"
79 A timeout occurred while writing to one of the CD180 registers.
80 .It "stty%d-%d: ring overflow"
81 Incoming characters were discarded because the application
82 in control of the device did not read the input fast enough.
83 .El
84 .Sh SEE ALSO
85 .Xr intro 4 ,
86 .Xr sbus 4 ,
87 .Xr tty 4
88 .Sh HISTORY
89 The
90 .Nm spif
91 driver was first supported in
92 .Ox 2.5 .
93 .Sh AUTHORS
94 .An -nosplit
95 The driver was written by
96 .An Jason Wright Aq jason@thought.net ,
97 and is heavily based on the
98 .Xr magma 4
99 driver written by
100 .An Iain Hibbert .
101 .Sh TODO
102 The parallel port is not supported yet.
104 Dial-out (cua) devices are not yet supported.