d757f22e772e618f8b7b37aa8beb69b9dcf3c9d9
[dragonfly.git] / share / man / man4 / sbsh.4
1 .\" Written by Denis I. Timofeev, 2003.
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/sbsh.4,v 1.1.2.1 2003/04/15 18:15:08 fjoe Exp $
25 .\" $DragonFly: src/share/man/man4/sbsh.4,v 1.4 2006/02/17 19:37:09 swildner Exp $
26 .\"
27 .Dd April 11, 2003
28 .Dt SBSH 4
29 .Os
30 .Sh NAME
31 .Nm sbsh
32 .Nd "Granch SBNI16 SHDSL modem device driver"
33 .Sh SYNOPSIS
34 .Cd "device sbsh"
35 .Sh DESCRIPTION
36 The
37 .Nm
38 driver provides support for an internal PCI modem SBNI16-SHDSL. A device
39 is introduced to OS as common ethernet-like netcard which must be
40 configured with
41 .Xr ifconfig 8
42 (all standard network interface parameters could be set). Modem-specific
43 parameters (master/slave mode, line rate etc.) must be set with the
44 sb16config utility before interface activation.
45 .Sh FILES
46 The sources for the driver reside in:
47 .Pp
48 .Bl -tag -compact
49 .It Pa /sys/dev/sbsh/if_sbsh.c
50 .It Pa /sys/dev/sbsh/if_sbshreg.h
51 .El
52 .Sh DIAGNOSTICS
53 .Bl -diag
54 .It "sbsh%d: couldn't map memory"
55 .It "sbsh%d: couldn't map interrupt"
56 .It "sbsh%d: couldn't set up irq"
57 A fatal initialization error has occurred.
58 .It "sbsh%d: unable to load firmware"
59 A fatal error has occurred while sb16config running.
60 .It "sbsh%d: firmware wasn't loaded"
61 ifconfig...up has failed because device hadn't been configured with
62 sb16config.
63 .It "sbsh%d: transmit timeout"
64 .It "sbsh%d: interrupt posted but not delivered"
65 Probably, a hardware error or incompatibility.
66 .It "sbsh%d: unable to get mbuf"
67 .It "sbsh%d: unable to get mbuf cluster"
68 The driver failed to allocate a memory buffer.
69 .El
70 .Sh SEE ALSO
71 .Xr arp 4 ,
72 .Xr netintro 4 ,
73 .Xr ifconfig 8 ,
74 .Xr /usr/ports/sysutils/sb16config
75 .Sh HISTORY
76 The
77 .Nm
78 device driver first appeared in
79 .Fx 4.9 .
80 .Sh AUTHORS
81 The
82 .Nm
83 driver was written by
84 .An Denis I. Timofeev Aq timofeev@granch.ru .