Add a missing '-width' in various manpages' lists.
[dragonfly.git] / share / man / man4 / man4.i386 / sbni.4
1 .\" Written by Denis I. Timofeev, 2002.
2 .\"
3 .\" Redistribution and use in source and binary forms, with or without
4 .\" modification, are permitted provided that the following conditions
5 .\" are met:
6 .\" 1. Redistributions of source code must retain the above copyright
7 .\"    notice, this list of conditions and the following disclaimer.
8 .\" 2. Redistributions in binary form must reproduce the above copyright
9 .\"    notice, this list of conditions and the following disclaimer in the
10 .\"    documentation and/or other materials provided with the distribution.
11 .\"
12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22 .\" SUCH DAMAGE.
23 .\"
24 .\" $FreeBSD: src/share/man/man4/man4.i386/sbni.4,v 1.1.2.1 2003/04/15 17:23:32 fjoe Exp $
25 .\"
26 .Dd January 8, 2002
27 .Dt SBNI 4 i386
28 .Os
29 .Sh NAME
30 .Nm sbni
31 .Nd Granch SBNI12 leased line modem driver
32 .Sh SYNOPSIS
33 .Cd "device sbni0 at isa? port 0x210 irq 5"
34 .Cd "device sbni1 at isa? port 0x2c0 irq 11 flags 0xe9123456"
35 .Sh DESCRIPTION
36 The
37 .Nm
38 driver provides support for leased line modems of following models:
39 .Pp
40 .Bl -tag -compact -width ".Pa SBNI12-10, SBNI12D-10, ISA and PCI"
41 .It Pa SBNI12-02, SBNI12D-02
42 .It Pa SBNI12-04, SBNI12D-04
43 .It Pa SBNI12-05, SBNI12D-05, ISA and PCI
44 .It Pa SBNI12-10, SBNI12D-10, ISA and PCI
45 .El
46 .Pp
47 and a kit for data link over a voice band
48 SBNI12-11, SBNI12D-11,  ISA and PCI.
49 .Pp
50 In addition to the standard port and irq specifications, the
51 .Nm
52 driver also supports a number of
53 .Em flags
54 which can set baud rate, receive level, and low three bytes of Ethernet
55 MAC-address (high three always are 00:ff:01), because Granch modems is
56 presented to the system as Ethernet-like netcards.
57 .Pp
58 The high byte of the
59 .Em flags
60 is a bit field, it's used to specify SBNI adapter receive level/baud rate:
61 .Bd -literal
62         Bits 0-3: receive level (0x00..0x0f)
63         Bits 4-5: baud rate number:
64                         00 - 0 baud rate (2Mb in fast mode/500kb in slow)
65                         01 - 1 baud rate (1Mb/250kb)
66                         10 - 2 baud rate (500kb/125kb)
67                         11 - 3 baud rate (250kb/62.5kb)
68         Bit 6   : use fixed receive level
69                   if bit 6 is set then receive level will be set according
70                   to bits 0-3 value, otherwise receive level will be
71                   autodetected
72         Bit 7   : use fixed baud rate
73                   if bit 7 is set then baud rate will be set according to
74                   bits 4-5 value, otherwise baud rate is set to 2Mb
75
76 E.g.:
77 device sbni0 at isa? port 0x210 irq 5 flags 0xefdead
78         - baud rate 2 Mb (default), receive level autodetected,
79           MAC address will be 00:ff:01:ef:de:ad
80
81 device sbni1 at isa? port 0x214 irq 7 flags 0xd6abcdef
82         - baud rate 1 Mb, receive level 0x06 (fixed),
83           MAC address 00:ff:01:ab:cd:ef
84 .Ed
85 .Sh FILES
86 The sources for the driver reside in:
87 .Pp
88 .Bl -tag -compact -width ".Pa /sys/dev/netif/sbni/if_sbnireg.h"
89 .It Pa /sys/dev/netif/sbni/if_sbni.c
90 .It Pa /sys/dev/netif/sbni/if_sbnireg.h
91 .It Pa /sys/dev/netif/sbni/if_sbnivar.h
92 .El
93 .Sh SEE ALSO
94 .Xr arp 4 ,
95 .Xr netintro 4 ,
96 .Xr ifconfig 8
97 .Sh HISTORY
98 The
99 .Nm
100 device driver first appeared in
101 .Fx 4.6 .
102 .Sh AUTHORS
103 The
104 .Nm
105 device driver for
106 .Fx
107 4.x was written by Denis I. Timofeev, partially
108 based on David Greenman's
109 .Nm ed
110 driver. Earlier versions (available on ftp.granch.com) were written by
111 Alexey V. Zverev.
112 .Pp
113 SBNI12 hardware was designed by Alexey V. Chirkov.