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 .\" $DragonFly: src/share/man/man4/man4.i386/sbni.4,v 1.4 2005/12/05 02:22:51 swildner Exp $
  26 .\"
  27 .Dd January 8, 2002
  28 .Dt SBNI 4 i386
  29 .Os FreeBSD
  30 .Sh NAME
  31 .Nm sbni
  32 .Nd Granch SBNI12 leased line modem driver
  33 .Sh SYNOPSIS
  34 .Cd "device sbni0 at isa? port 0x210 irq 5"
  35 .Cd "device sbni1 at isa? port 0x2c0 irq 11 flags 0xe9123456"
  36 .Sh DESCRIPTION
  37 The
  38 .Nm sbni
  39 driver provides support for leased line modems of following models:
  40 .Pp
  41 .Bl -tag -compact
  42 .It Pa SBNI12-02, SBNI12D-02
  43 .It Pa SBNI12-04, SBNI12D-04
  44 .It Pa SBNI12-05, SBNI12D-05, ISA and PCI
  45 .It Pa SBNI12-10, SBNI12D-10, ISA and PCI
  46 .El
  47 .Pp
  48 and a kit for data link over a voice band
  49 SBNI12-11, SBNI12D-11,  ISA and PCI.
  50 .Pp
  51 In addition to the standard port and irq specifications, the
  52 .Nm
  53 driver also supports a number of
  54 .Em flags
  55 which can set baud rate, receive level, and low three bytes of Ethernet
  56 MAC-address (high three always are 00:ff:01), because Granch modems is
  57 presented to the system as Ethernet-like netcards.
  58 .Pp
  59 The high byte of the
  60 .Em flags
  61 is a bit field, it's used to specify SBNI adapter receive level/baud rate:
  62 .Bd -literal
  63         Bits 0-3: receive level (0x00..0x0f)
  64         Bits 4-5: baud rate number:
  65                         00 - 0 baud rate (2Mb in fast mode/500kb in slow)
  66                         01 - 1 baud rate (1Mb/250kb)
  67                         10 - 2 baud rate (500kb/125kb)
  68                         11 - 3 baud rate (250kb/62.5kb)
  69         Bit 6   : use fixed receive level
  70                   if bit 6 is set then receive level will be set according
  71                   to bits 0-3 value, otherwise receive level will be
  72                   autodetected
  73         Bit 7   : use fixed baud rate
  74                   if bit 7 is set then baud rate will be set according to
  75                   bits 4-5 value, otherwise baud rate is set to 2Mb
  76
  77 E.g.:
  78 device sbni0 at isa? port 0x210 irq 5 flags 0xefdead
  79         - baud rate 2 Mb (default), receive level autodetected,
  80           MAC address will be 00:ff:01:ef:de:ad
  81
  82 device sbni1 at isa? port 0x214 irq 7 flags 0xd6abcdef
  83         - baud rate 1 Mb, receive level 0x06 (fixed),
  84           MAC address 00:ff:01:ab:cd:ef
  85 .El
  86 .Sh FILES
  87 The sources for the driver reside in:
  88 .Pp
  89 .Bl -tag -compact
  90 .It Pa /sys/dev/sbni/if_sbni.c
  91 .It Pa /sys/dev/sbni/if_sbnireg.h
  92 .It Pa /sys/dev/sbni/if_sbnivar.h
  93 .El
  94 .Sh SEE ALSO
  95 .Xr arp 4 ,
  96 .Xr netintro 4 ,
  97 .Xr ifconfig 8
  98 .Sh HISTORY
  99 The
 100 .Nm
 101 device driver first appeared in
 102 .Fx 4.6 .
 103 .Sh AUTHORS
 104 The
 105 .Nm sbni
 106 device driver for FreeBSD 4.x was written by Denis I. Timofeev, partially
 107 based on David Greenman's
 108 .Nm ed
 109 driver. Earlier versions (available on ftp.granch.com) were written by
 110 Alexey V. Zverev.
 111 .Pp
 112 SBNI12 hardware was designed by Alexey V. Chirkov.