mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-16 10:20:30 +00:00
Code Issues Releases Activity

- Stop talking about non-FreeBSD stuff (mostly because it's hard

Browse Source 
to keep this info up-to-date as time goes by).
- Revise the markup.
This commit is contained in:
Ruslan Ermilov 2005-11-24 16:03:09 +00:00
parent ae5a74ec72
commit abfb299cfc
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=152776
1 changed files with 133 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

259
usr.sbin/lmcconfig/lmcconfig.8
View File

@ -1,6 +1,3 @@
.\"
.\" $FreeBSD$
.\"
.\" Copyright (c) 2003 David Boggs. (boggs@boggs.palo-alto.ca.us) .\" Copyright (c) 2003 David Boggs. (boggs@boggs.palo-alto.ca.us)
.\" All rights reserved. .\" All rights reserved.
.\" .\"
@ -43,43 +40,34 @@
.\" this program; if not, write to the Free Software Foundation, Inc., 59 .\" this program; if not, write to the Free Software Foundation, Inc., 59
.\" Temple Place - Suite 330, Boston, MA 02111-1307, USA. .\" Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\" .\"
.\" I forget these things: .\" $FreeBSD$
.\" groff -Tascii -mdoc lmcconfig.8 > lmcconfig.txt
.\" groff -Tps -mdoc lmcconfig.8 > lmcconfig.ps
.\" groff -Thtml -mdoc lmcconfig.8 > lmcconfig.html (buggy)
.\" .\"
.Dd June 2005 .Dd October 3, 2005
.Dt LMCCONFIG 8 .Dt LMCCONFIG 8
.Os .Os
.Sp
.Sh NAME .Sh NAME
.Sp
.Nm lmcconfig .Nm lmcconfig
.Nd configuration program for .Nd configuration program for
.Tn SBE .Tn SBE
(formerly (formerly
.Tn LMC ) .Tn LMC )
wide-area network interface cards. wide-area network interface cards
.Sp
.Sh SYNOPSIS .Sh SYNOPSIS
.Sp
.Nm .Nm
.Ar interface .Ar interface
.Op Fl abBcCdDeEfhLmMpPrsStTuwxXyYzZ? .Op Fl abBcCdDeEfhLmMpPrsStTuwxXyYzZ?
.br
.Nm .Nm
.Ar interface .Ar interface
.Fl 1 .Fl 1
.Op Fl aABceEfFgiIlLpPstTuUxX .Op Fl aABceEfFgiIlLpPstTuUxX
.br
.Nm .Nm
.Ar interface .Ar interface
.Fl 3 .Fl 3
.Op Fl aABcefFlLsSv .Op Fl aABcefFlLsSv
.Sp
.Sh DESCRIPTION .Sh DESCRIPTION
.Sp The
.Nm .Nm
utility
is the configuration program for the is the configuration program for the
.Xr lmc 4 .Xr lmc 4
wide-area network device driver. wide-area network device driver.
@ -88,13 +76,15 @@ and it displays status, such as that of integrated modems,
that are beyond the scope of that are beyond the scope of
.Xr ifconfig 8 . .Xr ifconfig 8 .
.Pp .Pp
The
.Nm .Nm
utility
displays the interface status when no parameters are specified; displays the interface status when no parameters are specified;
see example below. see example below.
For this case only, if no For this case only, if no
.Ar interface .Ar interface
is specified, it defaults to is specified, it defaults to
.Ic lmc0 . .Dq Li lmc0 .
.Pp .Pp
Only the super-user may modify the configuration of a network interface. Only the super-user may modify the configuration of a network interface.
.Pp .Pp
@ -102,11 +92,11 @@ The following options are available:
.Bl -tag -width indent .Bl -tag -width indent
.It Ar interface .It Ar interface
This is the name of the interface; the default is This is the name of the interface; the default is
.Cm lmc0 . .Dq Li lmc0 .
If If
.Xr netgraph 4 .Xr netgraph 4
is present and the interface name ends with a colon is present and the interface name ends with a colon
then netgraph control messages are used, then Netgraph control messages are used,
otherwise the otherwise the
.Xr ifnet 9 .Xr ifnet 9
kernel interface and socket kernel interface and socket
@ -117,14 +107,13 @@ All parameters after this apply to the T1E1 card.
.It Fl 3 .It Fl 3
All parameters after this apply to the T3 card. All parameters after this apply to the T3 card.
.El .El
.Sp
.Ss Commands for all cards .Ss Commands for all cards
.Sp
The following parameters apply to more then one card type. The following parameters apply to more then one card type.
.Bl -tag -width indent .Bl -tag -width indent
.It Fl a Ar number .It Fl a Ar number
Set Transmitter clock source to Set Transmitter clock source to
.Ar number . .Ar number .
.Pp
.Bl -column "1" "External connector" "T1E1, HSSIc" -offset 2m -compact .Bl -column "1" "External connector" "T1E1, HSSIc" -offset 2m -compact
.It "1" Ta "TxClk from modem" Ta "T1E1, HSSI" Ta "default" .It "1" Ta "TxClk from modem" Ta "T1E1, HSSI" Ta "default"
.It "2" Ta "Internal source" Ta "T1E1, HSSI" .It "2" Ta "Internal source" Ta "T1E1, HSSI"
@ -146,23 +135,23 @@ the card if the value is 4.
.Pp .Pp
TxClk source is not applicable to other card types. TxClk source is not applicable to other card types.
.It Fl b .It Fl b
Read BIOS rom. Read BIOS ROM.
Print the first 256 locations. Print the first 256 locations.
The BIOS rom is not used and not present on some cards. The BIOS ROM is not used and not present on some cards.
.It Fl B .It Fl B
Write BIOS rom. Write BIOS ROM.
Write the first 256 locations with an address pattern. Write the first 256 locations with an address pattern.
.It Fl c .It Fl c
Use HDLC's 16-bit CRC polynomial: X^16+X^12+X^5+1 (default) Use HDLC's 16-bit CRC polynomial: X^16+X^12+X^5+1 (default).
.Bd -ragged -compact
.It Fl C .It Fl C
Use HDLC's 32-bit CRC polynomial: Use HDLC's 32-bit CRC polynomial:
X^32+X^26+X^23+X^22+X^16+X^12+X^11+X^10+X^8+X^7+X^5+X^4+X^2+X+1 X^32+X^26+X^23+X^22+X^16+X^12+X^11+X^10+X^8+X^7+X^5+X^4+X^2+X+1
.Ed
.It Fl d .It Fl d
Clear the driver-level debug flag. Non-critical log messages are suppressed. Clear the driver-level debug flag.
Non-critical log messages are suppressed.
.It Fl D .It Fl D
Set the driver-level debug flag. The driver generates more log messages. Set the driver-level debug flag.
The driver generates more log messages.
The driver also generates more log messages if the interface-level debug The driver also generates more log messages if the interface-level debug
flag is set by flag is set by
.Xr ifconfig 8 . .Xr ifconfig 8 .
@ -184,15 +173,18 @@ The nearest frequency that the synthesizer can generate will be used.
Only SSI cards and a few rare CompactPCI/HSSI cards have synthesizers. Only SSI cards and a few rare CompactPCI/HSSI cards have synthesizers.
.It Fl F .It Fl F
Set SPPP line protocol to Frame-Relay. Set SPPP line protocol to Frame-Relay.
Only works for FreeBSD-5.4 and later. Only works for
Not applicable to Linux, NetBSD, OpenBSD. or BSD/OS. .Fx 5.4
and later.
.It Fl h .It Fl h
Print help (usage message). Print help (usage message).
.It Fl i .It Fl i
Set interface name (eg. 'lmc0'). Set interface name (e.g.\&
.Dq Li lmc0 ) .
.It Fl L Ar number .It Fl L Ar number
Set loopback mode to Set loopback mode to
.Ar number . .Ar number .
.Pp
.Bl -column "99" "payload" "inward thru drvrs/rcvrsxxx" "HSSI, SSI" -offset 1m -compact .Bl -column "99" "payload" "inward thru drvrs/rcvrsxxx" "HSSI, SSI" -offset 1m -compact
.It "1" Ta "none" Ta "default" .It "1" Ta "none" Ta "default"
.It "2" Ta "payload" Ta "outward thru framer" Ta "T1E1. T3" .It "2" Ta "payload" Ta "outward thru framer" Ta "T1E1. T3"
@ -231,7 +223,8 @@ The PCI subsystem vendor and device IDs are kept here.
Write Tulip SROM. Write Tulip SROM.
Initializes the Tulip SROM to card type Initializes the Tulip SROM to card type
.Ar number . .Ar number .
.Bl -tag -width 1m -offset 1m -compact .Pp
.Bl -column "9" -offset 1m -compact
.It 3 Ta HSSI .It 3 Ta HSSI
.It 4 Ta T3 .It 4 Ta T3
.It 5 Ta SSI .It 5 Ta SSI
@ -240,6 +233,7 @@ Initializes the Tulip SROM to card type
.It 8 Ta SDSL .It 8 Ta SDSL
.It 0 Ta auto-set from MII PHYID .It 0 Ta auto-set from MII PHYID
.El .El
.Pp
If If
.Ar number .Ar number
is zero, then the card type is computed from the gate array is zero, then the card type is computed from the gate array
@ -248,7 +242,9 @@ microcode version field in the MII PHYID register.
if the SROM is incorrect, the card will be unusable! if the SROM is incorrect, the card will be unusable!
This command is This command is
.Em so .Em so
dangerous that lmcconfig must be edited and recompiled to enable it. dangerous that
.Nm
must be edited and recompiled to enable it.
.It Fl t .It Fl t
Read Tulip CSRs. Read Tulip CSRs.
Print the 16 32-bit control and status registers. Print the 16 32-bit control and status registers.
@ -256,9 +252,11 @@ Print the 16 32-bit control and status registers.
Write Tulip CSR. Write Tulip CSR.
Write Write
.Ar data .Ar data
into csr number into CSR number
.Ar addr . .Ar addr .
Note that addr is a CSR number (0-15) not a byte offset into CSR space. Note that
.Ar addr
is a CSR number (0-15) not a byte offset into CSR space.
.It Fl u .It Fl u
Reset event counters to zero. Reset event counters to zero.
The driver counts events like packets in and out, errors, discards, etc. The driver counts events like packets in and out, errors, discards, etc.
@ -269,51 +267,45 @@ Not needed during normal operation; just for testing.
.It Fl v .It Fl v
Set verbose mode: print more stuff. Set verbose mode: print more stuff.
.It Fl V .It Fl V
Print the card configuration -- see the EXAMPLES section. Print the card configuration \[em] see the
.Sx EXAMPLES
section.
.It Fl w .It Fl w
Load gate array from on-board rom. Load gate array from on-board ROM.
Not needed during normal operation; just for testing. Not needed during normal operation; just for testing.
.It Fl W Ar filename .It Fl W Ar filename
Load gate array microcode from Load gate array microcode from
.Ar filename . .Ar filename .
.It Fl x .It Fl x
Select RAWIP mode -- bypass line protocol code. Select RAWIP mode \[em] bypass line protocol code.
.It Fl X .It Fl X
Select line protocol code rather than RAWIP mode. Select line protocol code rather than RAWIP mode.
.It Fl y .It Fl y
Disable SPPP keep-alive packets, Disable SPPP keep-alive packets,
Only works for FreeBSD, NetBSD and OpenBSD.
Not applicable to Linux or BSD/OS.
.It Fl Y .It Fl Y
Enable SPPP keep-alive packets. Enable SPPP keep-alive packets.
Only works for FreeBSD, NetBSD and OpenBSD.
Not applicable to Linux or BSD/OS.
.It Fl z .It Fl z
Set SPPP line protocol to Cisco-HDLC. Set SPPP line protocol to Cisco-HDLC.
Only works for FreeBSD, NetBSD and OpenBSD.
Not applicable to Linux or BSD/OS.
.It Fl Z .It Fl Z
Set SPPP line protocol to PPP. Set SPPP line protocol to PPP.
Only works for FreeBSD, NetBSD and OpenBSD. .It Fl ?\&
Not applicable to Linux or BSD/OS.
.It Fl ?
Print help (usage message). Print help (usage message).
.El .El
.Sp
.Ss Commands for T1E1 cards .Ss Commands for T1E1 cards
.Sp
The following parameters apply to the T1E1 card type: The following parameters apply to the T1E1 card type:
.Bl -tag -width indent .Bl -tag -width indent
.It Fl a Ar y|a|b .It Fl a Sm Cm y | a | b Sm
Stop sending alarm signal. Stop sending alarm signal.
.Pp
.Bl -column "y" "Yellow Alarm" "unframed all ones; aka AIS" -offset 1m -compact .Bl -column "y" "Yellow Alarm" "unframed all ones; aka AIS" -offset 1m -compact
.It "y" Ta "Yellow Alarm" Ta "varies with framing" .It "y" Ta "Yellow Alarm" Ta "varies with framing"
.It "a" Ta "Red Alarm" Ta "unframed all ones; aka AIS" .It "a" Ta "Red Alarm" Ta "unframed all ones; aka AIS"
.It "b" Ta "Blue Alarm" Ta "unframed all ones" .It "b" Ta "Blue Alarm" Ta "unframed all ones"
.El .El
.Pp
Red alarm, also known as AIS (Alarm Indication Signal), Red alarm, also known as AIS (Alarm Indication Signal),
and Blue alarm are identical in T1. and Blue alarm are identical in T1.
.It Fl A Ar y|a|b .It Fl A Sm Cm y | a | b Sm
Start sending alarm signal (see table above). Start sending alarm signal (see table above).
.It Fl B Ar number .It Fl B Ar number
Send a Bit Oriented Protocol (BOP) message with code Send a Bit Oriented Protocol (BOP) message with code
@ -326,11 +318,14 @@ meters (default: 10 meters).
This is used to set receiver sensitivity This is used to set receiver sensitivity
and transmitter line build-out. and transmitter line build-out.
.It Fl d .It Fl d
Print the status of the on-board DSU/CSU -- see the EXAMPLES section. Print the status of the on-board DSU/CSU \[em] see the
.Sx EXAMPLES
section.
.It Fl e Ar number .It Fl e Ar number
Set the framing format to Set the framing format to
.Ar number : .Ar number :
.Bl -tag -width 1m -offset 1m -compact .Pp
.Bl -column "99" -offset 1m -compact
.It 9 Ta T1-SF/AMI .It 9 Ta T1-SF/AMI
.It 27 Ta T1-ESF/B8ZS (default) .It 27 Ta T1-ESF/B8ZS (default)
.It 0 Ta E1-FAS .It 0 Ta E1-FAS
@ -341,7 +336,9 @@ Set the framing format to
.El .El
.It Fl E Ar number .It Fl E Ar number
Enable 64Kb time slots (TSs) for the T1E1 card. Enable 64Kb time slots (TSs) for the T1E1 card.
The
.Ar number .Ar number
argument
is a 32-bit hex number (default 0xFFFFFFFF). is a 32-bit hex number (default 0xFFFFFFFF).
The LSB is TS0 and the MSB is TS31. The LSB is TS0 and the MSB is TS31.
TS0 and TS25-31 are ignored in T1 mode. TS0 and TS25-31 are ignored in T1 mode.
@ -358,6 +355,7 @@ into register
.It Fl g Ar number .It Fl g Ar number
Set receiver gain range to Set receiver gain range to
.Ar number : .Ar number :
.Pp
.Bl -column "0x00" "Medium" "auto-set based on cable length (default)" -offset 1m -compact .Bl -column "0x00" "Medium" "auto-set based on cable length (default)" -offset 1m -compact
.It "0x24" Ta "Short" Ta "0 to 20 dB of equalized gain" .It "0x24" Ta "Short" Ta "0 to 20 dB of equalized gain"
.It "0x2C" Ta "Medium" Ta "0 to 30 dB of equalized gain" .It "0x2C" Ta "Medium" Ta "0 to 30 dB of equalized gain"
@ -365,6 +363,7 @@ Set receiver gain range to
.It "0x3F" Ta "Extend" Ta "0 to 64 dB of equalized gain (wide open)" .It "0x3F" Ta "Extend" Ta "0 to 64 dB of equalized gain (wide open)"
.It "0xFF" Ta "Auto" Ta "auto-set based on cable length (default)" .It "0xFF" Ta "Auto" Ta "auto-set based on cable length (default)"
.El .El
.Pp
This sets the level at which This sets the level at which
.Em Loss-Of-Signal .Em Loss-Of-Signal
is declared. is declared.
@ -393,13 +392,16 @@ Send a
.Em payload loopback activate .Em payload loopback activate
BOP message (T1-ESF only). BOP message (T1-ESF only).
.It Fl s .It Fl s
Print the status of the on-board DSU/CSU -- see the EXAMPLES section. Print the status of the on-board DSU/CSU \[em] see the
.Sx EXAMPLES
section.
.It Fl t .It Fl t
Stop sending test pattern. Stop sending test pattern.
.It Fl T Ar number .It Fl T Ar number
Start sending test pattern Start sending test pattern
.Ar number : .Ar number :
.Bl -tag -width 1m -offset 1m -compact .Pp
.Bl -column "99" -offset 1m -compact
.It 0 Ta unframed X^11+X^9+1 .It 0 Ta unframed X^11+X^9+1
.It 1 Ta unframed X^15+X^14+1 .It 1 Ta unframed X^15+X^14+1
.It 2 Ta unframed X^20+X^17+1 .It 2 Ta unframed X^20+X^17+1
@ -420,7 +422,8 @@ Start sending test pattern
.It Fl u Ar number .It Fl u Ar number
Set transmit pulse shape to Set transmit pulse shape to
.Ar number : .Ar number :
.Bl -tag -width 1m -offset 1m -compact .Pp
.Bl -column "99" -offset 1m -compact
.It 0 Ta T1 DSX 0 to 40 meters .It 0 Ta T1 DSX 0 to 40 meters
.It 2 Ta T1 DSX 40 to 80 meters .It 2 Ta T1 DSX 40 to 80 meters
.It 4 Ta T1 DSX 80 to 120 meters .It 4 Ta T1 DSX 80 to 120 meters
@ -434,6 +437,7 @@ Set transmit pulse shape to
.It Fl U Ar number .It Fl U Ar number
Set transmit line build-out to Set transmit line build-out to
.Ar number : .Ar number :
.Pp
.Bl -column "255" "22.5 dB" "FCC option A" -offset 1m -compact .Bl -column "255" "22.5 dB" "FCC option A" -offset 1m -compact
.It " 0" Ta "0 dB" Ta "FCC option A" .It " 0" Ta "0 dB" Ta "FCC option A"
.It " 16" Ta "7.5 dB" Ta "FCC option B" .It " 16" Ta "7.5 dB" Ta "FCC option B"
@ -441,6 +445,7 @@ Set transmit line build-out to
.It " 48" Ta "22.5 dB" Ta "final span" .It " 48" Ta "22.5 dB" Ta "final span"
.It "255" Ta "auto-set based on cable length (default)" .It "255" Ta "auto-set based on cable length (default)"
.El .El
.Pp
This is only applicable if the pulse shape is T1-CSU. This is only applicable if the pulse shape is T1-CSU.
.It Fl v .It Fl v
Set verbose mode: print more stuff. Set verbose mode: print more stuff.
@ -449,20 +454,19 @@ Disable transmitter outputs.
.It Fl X .It Fl X
Enable transmitter outputs. Enable transmitter outputs.
.El .El
.Sp
.Ss Commands for T3 cards .Ss Commands for T3 cards
.Sp
The following parameters apply to the T3 card type: The following parameters apply to the T3 card type:
.Bl -tag -width indent .Bl -tag -width indent
.It Fl a Ar y|a|b|i .It Fl a Sm Cm y | a | b | i Sm
Stop sending alarm signal. Stop sending alarm signal.
.Pp
.Bl -column "y" "Yellow Alarm" "framed 1010... aka AIS" -offset 1m -compact .Bl -column "y" "Yellow Alarm" "framed 1010... aka AIS" -offset 1m -compact
.It "y" Ta "Yellow Alarm" Ta "X-bits set to 0" .It "y" Ta "Yellow Alarm" Ta "X-bits set to 0"
.It "a" Ta "Red Alarm" Ta "framed 1010... aka AIS" .It "a" Ta "Red Alarm" Ta "framed 1010... aka AIS"
.It "b" Ta "Blue Alarm" Ta "unframed all-ones" .It "b" Ta "Blue Alarm" Ta "unframed all-ones"
.It "i" Ta "Idle signal" Ta "framed 11001100..." .It "i" Ta "Idle signal" Ta "framed 11001100..."
.El .El
.It Fl A Ar y|a|b|i .It Fl A Sm Cm y | a | b | i Sm
Start sending alarm signal (see table above). Start sending alarm signal (see table above).
.It Fl B Ar number .It Fl B Ar number
Send a BOP (Bit Oriented Protocol) message with code Send a BOP (Bit Oriented Protocol) message with code
@ -475,11 +479,14 @@ meters (default: 10 meters).
This is used to set receiver sensitivity This is used to set receiver sensitivity
and transmitter line build-out. and transmitter line build-out.
.It Fl d .It Fl d
Print the status of the on-board T3 DSU -- see the EXAMPLES section. Print the status of the on-board T3 DSU \[em] see the
.Sx EXAMPLES
section.
.It Fl e Ar number .It Fl e Ar number
Set the framing format to Set the framing format to
.Ar number : .Ar number :
.Bl -tag -width 1m -offset 1m -compact .Pp
.Bl -column "100" -offset 1m -compact
.It 100 Ta T3-C-bit parity .It 100 Ta T3-C-bit parity
.It 101 Ta T3-M13 format .It 101 Ta T3-M13 format
.El .El
@ -501,11 +508,14 @@ Send a
.Em line loopback activate .Em line loopback activate
BOP message. BOP message.
.It Fl s .It Fl s
Print the status of the on-board T3 DSU -- see the EXAMPLES section. Print the status of the on-board T3 DSU \[em] see the
.Sx EXAMPLES
section.
.It Fl S Ar number .It Fl S Ar number
Set payload scrambler polynominal to Set payload scrambler polynominal to
.Ar number : .Ar number :
.Bl -tag -width 1m -offset 1m -compact .Pp
.Bl -column "9" -offset 1m -compact
.It 1 Ta payload scrambler disabled .It 1 Ta payload scrambler disabled
.It 2 Ta X^43+1: DigitalLink and Kentrox .It 2 Ta X^43+1: DigitalLink and Kentrox
.It 3 Ta X^20+X^17+1 w/28ZS: Larscom .It 3 Ta X^20+X^17+1 w/28ZS: Larscom
@ -519,110 +529,112 @@ Set transmit frequency offset to
Some T3 cards can offset the transmitter frequency from 44.736 MHz. Some T3 cards can offset the transmitter frequency from 44.736 MHz.
.Ar Number .Ar Number
is in the range (0..4095); 2048 is zero offset; step size is about 3 Hz. is in the range (0..4095); 2048 is zero offset; step size is about 3 Hz.
.Ar Number A
.Ar number
is written to a Digital-Analog Converter (DAC) which connects is written to a Digital-Analog Converter (DAC) which connects
to a Voltage Controlled Crystal Oscillator (VCXO). to a Voltage Controlled Crystal Oscillator (VCXO).
.El .El
.Sp
.Ss Event Counters .Ss Event Counters
.Sp
The device driver counts many interesting events such as The device driver counts many interesting events such as
packets in and out, errors and discards. packets in and out, errors and discards.
The table below lists the event counters and describes what they count. The table below lists the event counters and describes what they count.
.Bl -tag -width "underruns" .Bl -tag -width ".Va underruns"
.It ibytes .It Va ibytes
Bytes received in packets with good ending status. Bytes received in packets with good ending status.
.It obytes .It Va obytes
Bytes transmitted. Bytes transmitted.
.It ipackets .It Va ipackets
Packets received with good ending status. Packets received with good ending status.
.It opackets .It Va opackets
Packets transmitted. Packets transmitted.
.It ierrors .It Va ierrors
Packets received with bad ending status. Packets received with bad ending status.
.It oerrors .It Va oerrors
Packets transmitted with bad ending status. Packets transmitted with bad ending status.
.It idiscards .It Va idiscards
Packets received but discarded because Packets received but discarded because
the input queue was full or the interface was down. the input queue was full or the interface was down.
.It odiscards .It Va odiscards
Packets presented for transmission but discarded because Packets presented for transmission but discarded because
the output queue was full or the interface was down. the output queue was full or the interface was down.
.It txdma .It Va txdma
Packets presented for transmission but queued and retried later Packets presented for transmission but queued and retried later
because no DMA descriptors were available. because no DMA descriptors were available.
This can happen during normal operation and is not an indication of trouble. This can happen during normal operation and is not an indication of trouble.
.It fifo-overrun .It Va fifo-overrun
Packets that started to arrive, but were aborted because Packets that started to arrive, but were aborted because
the card was unable to DMA data to memory fast enough the card was unable to DMA data to memory fast enough
to prevent the receiver fifo from overflowing. to prevent the receiver fifo from overflowing.
.It fifo-underrun .It Va fifo-underrun
Packets that started to transmit but were aborted because Packets that started to transmit but were aborted because
the card was unable to DMA data from the memory fast enough the card was unable to DMA data from the memory fast enough
to prevent the transmitter fifo from underflowing. to prevent the transmitter fifo from underflowing.
When this happens, the transmitter threshold is increased, When this happens, the transmitter threshold is increased,
so that more bytes are required to be in the fifo so that more bytes are required to be in the fifo
before the transmitter is started. before the transmitter is started.
.It missed .It Va missed
Packets that are missed because the receiver is stopped. Packets that are missed because the receiver is stopped.
.It overruns .It Va overruns
Packets that are missed because the receiver Packets that are missed because the receiver
had no DMA descriptors available. had no DMA descriptors available.
.It fdl_pkts .It Va fdl_pkts
Packets received on the T1 Facility Data Link. Packets received on the T1 Facility Data Link.
.It crc-errs .It Va crc-errs
Cyclic Redundancy Checksum errors detected by the CRC-6 in Cyclic Redundancy Checksum errors detected by the CRC-6 in
T1 Extended SuperFrames (ESF) or the CRC-4 in E1 frames. T1 Extended SuperFrames (ESF) or the CRC-4 in E1 frames.
.It lcv-errs .It Va lcv-errs
Line Coding Violation errors: Line Coding Violation errors:
Alternate Mark Inversion (AMI) errors for T1-SF, Alternate Mark Inversion (AMI) errors for T1-SF,
Bipolar 8-Zero Substitution (B8ZS) errors for T1-ESF, or Bipolar 8-Zero Substitution (B8ZS) errors for T1-ESF, or
High Density Bipolar with 3-Zero Substitution (HDB3) errors for E1 or High Density Bipolar with 3-Zero Substitution (HDB3) errors for E1 or
Bipolar 3-Zero Substitution (B3ZS) errors for T3. Bipolar 3-Zero Substitution (B3ZS) errors for T3.
.It frm-errs .It Va frm-errs
T1 or T3 bit errors in the frame alignment signal. T1 or T3 bit errors in the frame alignment signal.
.It febe-errs .It Va febe-errs
Far End Block Errors: Far End Block Errors:
T1 or T3 bit errors detected by the device at the far end of the link. T1 or T3 bit errors detected by the device at the far end of the link.
.It par-errs .It Va par-errs
T3 bit errors detected by the hop-by-hop parity mechanism. T3 bit errors detected by the hop-by-hop parity mechanism.
.It cpar-errs .It Va cpar-errs
T3 bit errors detected by the end-to-end parity mechanism. T3 bit errors detected by the end-to-end parity mechanism.
.It mfrm-errs .It Va mfrm-errs
T3 bit errors in the multi-frame alignment signal. T3 bit errors in the multi-frame alignment signal.
.El .El
.Sp
.Ss Transmit Speed .Ss Transmit Speed
.Sp
The hardware counts transmit clocks divided by 2048. The hardware counts transmit clocks divided by 2048.
The software computes "Tx speed" from this (see examples below). The software computes
.Dq "Tx speed"
from this (see
.Sx EXAMPLES
below).
The transmit clock is the bit rate of the circuit divided by two if the The transmit clock is the bit rate of the circuit divided by two if the
circuit is idle and divided by four if the circuit is carrying a packet. circuit is idle and divided by four if the circuit is carrying a packet.
So an idle circuit reports a Tx speed equal to its bit rate, So an idle circuit reports a Tx speed equal to its bit rate,
and a busy circuit reports a Tx speed equal to half its bit rate. and a busy circuit reports a Tx speed equal to half its bit rate.
.Pp .Pp
This "bit rate" does not include circuit-level overhead bits This
.Dq "bit rate"
does not include circuit-level overhead bits
(such as T1 or T3 frame bits) but does include HDLC stuff bits. (such as T1 or T3 frame bits) but does include HDLC stuff bits.
An idle T1 circuit with a raw bit rate of 1544000 and a An idle T1 circuit with a raw bit rate of 1544000 and a
bit-rate-minus-overhead of 1536000 will report a "Tx speed" bit-rate-minus-overhead of 1536000 will report a
.Dq "Tx speed"
of ((1536000 bitand 4095) plus or minus 4096). of ((1536000 bitand 4095) plus or minus 4096).
Sometimes it will even get the correct answer of 1536000, and Sometimes it will even get the correct answer of 1536000, and
if the link is fully loaded it will report about 768000 bits/sec. if the link is fully loaded it will report about 768000 bits/sec.
.Pp .Pp
It's not a perfect bit rate meter (the circuit must be idle), It is not a perfect bit rate meter (the circuit must be idle),
but it is a useful circuit utilization meter if you know the but it is a useful circuit utilization meter if you know the
circuit bit rate and do some arithmetic. Software recalculates circuit bit rate and do some arithmetic.
Software recalculates
Tx speed once a second; the measurement period has some jitter. Tx speed once a second; the measurement period has some jitter.
.Sp
.Sh EXAMPLES .Sh EXAMPLES
.Sp When
.Bd -unfilled -compact .Dq Li lmc0
When lmc0 is a T1E1 card, is a T1E1 card,
.br .Dq Li lmcconfig lmc0
.Ic lmcconfig lmc0
generates the following output: generates the following output:
.Ed .Bd -literal -offset 2m
.Bd -literal -offset 2m -compact
Card name: lmc0 Card name: lmc0
Card type: SBE/LMC T1E1 card Card type: SBE/LMC T1E1 card
Link status: Up Link status: Up
@ -645,13 +657,13 @@ TX bytes: 1732169
TX packets: 20526 TX packets: 20526
Rx fdl pkts: 5443 Rx fdl pkts: 5443
.Ed .Ed
.Bd -unfilled .Pp
When lmc0 is a T1E1 card, When
.br .Dq Li lmc0
.Ic lmcconfig lmc0 -1 -d is a T1E1 card,
.Dq Li "lmcconfig lmc0 -1 -d"
generates the following output: generates the following output:
.Ed .Bd -literal -offset 2m
.Bd -literal -offset 2m -compact
Format-Frame/Code: T1-ESF/B8ZS Format-Frame/Code: T1-ESF/B8ZS
TimeSlot [31-0]: 0x01FFFFFE TimeSlot [31-0]: 0x01FFFFFE
Tx Clk src: Internal source Tx Clk src: Internal source
@ -691,26 +703,21 @@ ANSI Far-end performance reports:
SEQ=3 CRC=0 SE=0 FE=0 LV=0 SL=0 LB=0 SEQ=3 CRC=0 SE=0 FE=0 LV=0 SL=0 LB=0
SEQ=2 CRC=0 SE=0 FE=0 LV=0 SL=0 LB=0 SEQ=2 CRC=0 SE=0 FE=0 LV=0 SL=0 LB=0
.Ed .Ed
.Sp
.Sh DIAGNOSTICS .Sh DIAGNOSTICS
.Sp
Messages indicating the specified interface does not exist, or Messages indicating the specified interface does not exist, or
the user is not privileged and tried to alter an interface's configuration. the user is not privileged and tried to alter an interface's configuration.
.Sp
.Sh SEE ALSO .Sh SEE ALSO
.Sp
.Xr ioctl 2 , .Xr ioctl 2 ,
.Xr netgraph 4 ,
.Xr lmc 4 , .Xr lmc 4 ,
.Xr netgraph 4 ,
.Xr ifconfig 8 , .Xr ifconfig 8 ,
.Xr ifnet 9 . .Xr ifnet 9
.Pp .Pp
.Pa http://www.sbei.com . .Pa http://www.sbei.com/
.Sp
.Sh HISTORY .Sh HISTORY
.Sp This is a total rewrite of the program
This is a total rewrite of the program lmcctl by Andrew Stanley-Jones. .Nm lmcctl
.Sp by
.Sh AUTHOR .An "Andrew Stanley-Jones" .
.Sp .Sh AUTHORS
.An "David Boggs" Aq boggs@boggs.palo-alto.ca.us . .An "David Boggs" Aq boggs@boggs.palo-alto.ca.us