Factor out the description of how to configure a CLIP into its own

man page. This will be more scaleable as more driver man pages hit
the tree. Add also a description on how to do this configuration
in the rc.conf script.
This commit is contained in:
harti 2003-06-13 12:33:33 +00:00
parent a1ff0d0224
commit ab9fef4667
4 changed files with 130 additions and 29 deletions

View File

@ -124,6 +124,7 @@ MAN= aac.4 \
mtio.4 \
my.4 \
natm.4 \
natmip.4 \
ncr.4 \
netgraph.4 \
netintro.4 \

View File

@ -17,24 +17,11 @@ device driver supports Midway-based ATM interfaces including the
Efficient Networks, Inc. ENI-155 and Adaptec ANA-59x0.
Midway is an AAL5 SAR (Segmentation and Reassembly) chip.
.Pp
The driver only supports ATM PVCs. SVC or ATM-ARP is not supported.
For configuring the card for IP see
.Xr natm 4 .
.Pp
To configure the card for IP, use something like:
.Dl # ifconfig en0 128.252.200.1 netmask 0xffffff00 up
To add a PVC to a host you must use the ``route'' command:
.Dl # route add -iface <remote IP address> -link en0:z.0.x.y
where x and y are the byte encoding of the VCI to use, and z is the
byte encoding of the following flags.
.Dl 0x01 (use AAL5),
.Dl 0x02 (if using AAL5, use a LLCSNAP header)
Thus, parameter 3 means AAL5 and LLC/SNAP encapsulation.
Note that BPF works only with LLC/SNAP encapsulation.
.Pp
The device driver uses the
.Xr utopia 4
module for communication with the physical and ATM layer chip (SUNI/Lite).
.Pp
The following sysctls are recognized by the driver besides those implemented by
The following sysctls are recognized by the driver additionally to those
handled by
.Xr utopia 4 :
.Bl -tag -width XXX
.It Cm hw.atm.enX.istats
@ -45,18 +32,15 @@ with internal driver statistics.
This is a bit map of debugging options.
This variable is only available when the driver is compiled with debugging
support.
.EL
.Sh EXAMPLES
Suppose you have 2 hosts 128.252.200.1 and 128.252.200.2 connected
by ATM through PVC # 201 (0xc9).
To enable the link use the following commands:
.Dl on host 128.252.200.1:
.Dl # ifconfig en0 128.252.200.1 netmask 0xffffff00 up
.Dl # route add -iface 128.252.200.2 -link en0:3.0.0.c9
.El
.Pp
.Dl on host 128.252.200.2:
.Dl # ifconfig en0 128.252.200.2 netmask 0xffffff00 up
.Dl # route add -iface 128.252.200.1 -link en0:3.0.0.c9
The driver supports the media options
.Ar sdh ,
.Ar noscramb
and
.Ar unassigned
(see
.Xr utopia 4 ).
.Sh DIAGNOSTICS
.Bd -literal
en0 <Efficient Networks ENI-155p> rev 0 int a irq 5 on pci0:16
@ -69,6 +53,8 @@ The driver extensively uses DMA on PCI.
The first
generation PCI chipsets do not work or exhibit poor performance.
.Sh SEE ALSO
.Xr natm 4 ,
.Xr natmip 4 ,
.Xr utopia 4 ,
.Xr ifconfig 8 ,
.Xr route 8

View File

@ -85,7 +85,8 @@ the ATM protocols develop. Users should not depend
on details of the current implementation, but rather
the services exported.
.Sh SEE ALSO
.Xr en 4
.Xr en 4 ,
.Xr natmip 4
.Sh AUTHORS
.An Chuck Cranor
of Washington University implemented the NATM protocol layer

113
share/man/man4/natmip.4 Normal file
View File

@ -0,0 +1,113 @@
.\" $FreeBSD$
.\"
.Dd June 13, 2003
.Dt NATMIP 4
.Os
.Sh NAME
.Nm natmip
.Nd IP over ATM PVCs
.Sh SYNOPSIS
.Cd "device atm"
.Cd "options NATM"
.Sh DESCRIPTION
The NATM protocol stack includes support for IP over ATM. Without any
additional signalling stacks or other modules it is possible to build
a CLIP (classical IP over ATM) network based on PVCs.
.Pp
An ATM network card (en0 in this example) is configured for IP by something
like:
.Pp
.Dl # ifconfig en0 128.252.200.1 netmask 0xffffff00 up
.Pp
A PVC is added with the
.Dq route
utility:
.Pp
.Dl # route add -iface <remote IP address> -link en0:z.0.x.y
.Pp
where x and y are the hexadecimal byte encoding of the VCI to use,
and z is the byte encoding of the following flags:
.Pp
.Bl -tag -width "0x02" -offset indent -compact
.It 0x01
use AAL5.
.It 0x02
if using AAL5, use an LLC/SNAP header.
.El
.Pp
Thus, parameter 3 means AAL5 and LLC/SNAP encapsulation (this is the required
setting for interworking with other CLIP clients).
Note that BPF works only with LLC/SNAP encapsulation.
.Sh EXAMPLES
Suppose you have 3 hosts 128.252.200.1, 128.252.200.2 and
128.252.200.3 connected by ATM through PVCs:
.Pp
.Bl -item -offset indent -compact
.It
between 128.252.200.1 and 128.252.200.2: 0xc9
.It
between 128.252.200.1 and 128.252.200.3: 0xca
.It
between 128.252.200.2 and 128.252.200.3: 0xcb
.El
.Pp
To enable the links use the following commands:
.Pp
on host 128.252.200.1:
.Bd -literal -offset indent -compact
# ifconfig en0 128.252.200.1 netmask 0xffffff00 up
# route add -iface 128.252.200.2 -link en0:3.0.0.c9
# route add -iface 128.252.200.3 -link en0:3.0.0.ca
.Ed
.Pp
on host 128.252.200.2:
.Bd -literal -offset indent -compact
# ifconfig en0 128.252.200.2 netmask 0xffffff00 up
# route add -iface 128.252.200.1 -link en0:3.0.0.c9
# route add -iface 128.252.200.3 -link en0:3.0.0.cb
.Ed
.Pp
on host 128.252.200.3:
.Bd -literal -offset indent -compact
# ifconfig en0 128.252.200.3 netmask 0xffffff00 up
# route add -iface 128.252.200.1 -link en0:3.0.0.ca
# route add -iface 128.252.200.2 -link en0:3.0.0.cb
.Ed
.Pp
This can also be done in
.Xr rc.conf 5 :
.Pp
on host 128.252.200.1:
.Bd -literal -offset indent -compact
network_interfaces="lo0 en0"
ifconfig_en0="inet 128.252.200.1 netmask 255.255.255.0"
static_routes="host2 host3"
route_host2="-iface 128.252.200.2 -link en0:3.0.0.c9"
route_host3="-iface 128.252.200.3 -link en0:3.0.0.ca"
.Ed
.Pp
on host 128.252.200.2:
.Bd -literal -offset indent -compact
network_interfaces="lo0 en0"
ifconfig_en0="inet 128.252.200.2 netmask 255.255.255.0"
static_routes="host1 host3"
route_host1="-iface 128.252.200.1 -link en0:3.0.0.c9"
route_host3="-iface 128.252.200.3 -link en0:3.0.0.cb"
.Ed
.Pp
on host 128.252.200.3:
.Bd -literal -offset indent -compact
network_interfaces="lo0 en0"
ifconfig_en0="inet 128.252.200.3 netmask 255.255.255.0"
static_routes="host1 host2"
route_host1="-iface 128.252.200.1 -link en0:3.0.0.ca"
route_host2="-iface 128.252.200.2 -link en0:3.0.0.cb"
.Ed
.Sh SEE ALSO
.Xr en 4 ,
.Xr natm 4
.Sh AUTHORS
.An Chuck Cranor
of Washington University implemented the NATM protocol layer
along with the EN ATM driver in 1996 for
.Nx .