summaryrefslogtreecommitdiffstats
path: root/share/man/man4/patm.4
diff options
context:
space:
mode:
authorharti <harti@FreeBSD.org>2003-07-21 07:51:29 +0000
committerharti <harti@FreeBSD.org>2003-07-21 07:51:29 +0000
commit71ec5f458ad9303e21df70b52c79be5209172abe (patch)
treefa6e3c9a02ec772cc90dcba035424105002470eb /share/man/man4/patm.4
parent7629ee78c2690dbb82ef90911af70cefaa3d3abe (diff)
downloadFreeBSD-src-71ec5f458ad9303e21df70b52c79be5209172abe.zip
FreeBSD-src-71ec5f458ad9303e21df70b52c79be5209172abe.tar.gz
Always start new sentences on a new line.
Submitted by: Anil Madhavapeddy <anil@recoil.org>
Diffstat (limited to 'share/man/man4/patm.4')
-rw-r--r--share/man/man4/patm.463
1 files changed, 36 insertions, 27 deletions
diff --git a/share/man/man4/patm.4 b/share/man/man4/patm.4
index 0094f59..a82929c 100644
--- a/share/man/man4/patm.4
+++ b/share/man/man4/patm.4
@@ -45,8 +45,9 @@
.Sh DESCRIPTION
The
.Nm
-device driver supports ATM cards based on the IDT77252 chip. It has been
-tested with ProSum's ProATM-155 cards and with IDT's evaluation boards.
+device driver supports ATM cards based on the IDT77252 chip.
+It has been tested with ProSum's ProATM-155 cards and with IDT's evaluation
+boards.
The driver interfaces with the
.Xr natm 4
framework,
@@ -61,11 +62,12 @@ For configuring the card for IP see
.Xr natmip 4 .
.Pp
The driver supports UBR, CBR, VBR and ABR traffic. Supported AALs are:
-AAL0 (cell payloads), AAL5 and raw AAL. The driver supports opening
-of VCI/VPI 0/0 in RX, raw AAL-mode. This VC will receive all incoming cells (even
-those with non-zero GFC fields and VPI/VCI values outside the allowed range)
-that are not claimed by other open connections. This may be used
-for monitoring purposes.
+AAL0 (cell payloads), AAL5 and raw AAL.
+The driver supports opening of VCI/VPI 0/0 in RX, raw AAL-mode.
+This VC will receive all incoming cells (even those with non-zero GFC
+fields and VPI/VCI values outside the allowed range) that are not
+claimed by other open connections.
+This may be used for monitoring purposes.
.Pp
The following sysctls are recognized by the driver additionally to those
handled by
@@ -80,8 +82,8 @@ This is a read-only variable containing the contents of the on-board EEPROM
device.
.It Cm hw.atm.patmN.lbuf_max
This puts an upper limit on the number of large receive buffers the
-driver will allocate. This is a read-only variable that can be set
-via a loader tunable.
+driver will allocate.
+This is a read-only variable that can be set via a loader tunable.
.It Cm hw.atm.patmN.tx_maxmaps
This is the upper limit of transmission DMA maps the driver will allocate.
This is read-only but may be set via a loader tunable.
@@ -89,7 +91,8 @@ This is read-only but may be set via a loader tunable.
.Em (only if debugging enabled)
These are debugging flags. See
.Fn if_patmvar.h
-for the possible flags. This may be initialized via a loader tunable.
+for the possible flags.
+This may be initialized via a loader tunable.
.It Cm hw.atm.patmN.regs
.Em (only if debugging enabled)
Returns the current values of the card's registers.
@@ -117,9 +120,9 @@ and
.Ar unassigned
(see
.Xr utopia 4 )
-when the card is a 155MBit card. Both PMC-Sierra S/UNI and IDT77155 PHY
-chips are supported for these cards. For 25MBit cards the IDT77105 is
-supported.
+when the card is a 155MBit card.
+Both PMC-Sierra S/UNI and IDT77155 PHY chips are supported for these cards.
+For 25MBit cards the IDT77105 is supported.
.Sh DIAGNOSTICS
.Bd -literal
patm1: <NICStAR (77222/77252) ATM adapter> port 0xc000-0xc0ff mem 0xf8000000-0xf83fffff,0xf4000000-0xf4000fff irq 11 at device 8.0 on pci2
@@ -132,31 +135,37 @@ patm1: 128K x 32 SRAM; 4096 connections
.Xr utopia 4
.Sh CAVEATS
The card fails to generate an interrupt if a cell is received in AAL0 mode
-that has the MSB of the PTI field cleared. Therefor cells will delivered
-on the next receive interrupt which can happen either when the receive
-status queue is full, or a cell with the last bit of the PTI set is received.
+that has the MSB of the PTI field cleared.
+Therefore cells will be delivered on the next receive interrupt which can happen
+either when the receive status queue is full, or a cell with the last bit of
+the PTI set is received.
.Pp
Although the card supports AAL3/4 the driver does not.
.Pp
The rate tables used by this driver are not the tables recommended by IDT
-(they are wrong anyway). The driver's tables are slightly more aggressive
-than IDT's. That means, that the actual cell rate can be slightly higher
-than the specified. This is in contrast to the IDT tables where cell rates
-5% lesser than the allowed one have been observed. This can be changed
-by changing the program that generates these tables (/sys/dev/patm/genrtab)
-and regenerating the tables.
+(they are wrong anyway).
+The driver's tables are slightly more aggressive than IDT's.
+That means, that the actual cell rate can be slightly higher than the
+specified.
+This is in contrast to the IDT tables where cell rates 5% less than the
+allowed one have been observed.
+This can be changed by changing the program that generates these tables,
+found in
+.Pa /usr/src/sys/dev/patm/genrtab ,
+and regenerating them.
.Pp
The reported media for the 155MBit cards will always be OC3/MM, because
-there is no (known to me) way to figure out the actual medium. The medium
-should really be coded in the EEPROM by the manufacturer.
+there is no (known to me) way to figure out the actual medium.
+The medium should really be coded in the EEPROM by the manufacturer.
.Pp
The Tx cell counter in the utopia statistics is wrong, because the chip
-uses idle cells for spacing and the PHY counts these cells. While
-there is a configuration option for the chip to switch of these cells
+uses idle cells for spacing and the PHY counts these cells.
+While there is a configuration option for the chip to switch of these cells
and, according to the documentation, this should not influence cell spacing,
it does, so the driver let's the chip generate idle cells.
.Sh ACKNOWLEDGEMENTS
Thanks to Christian Bucari from ProSum for lending two of these cards to enable
-the development of this driver. Thanks also for answering my questions.
+the development of this driver.
+Thanks also for answering my questions.
.Sh AUTHORS
.An Harti Brandt Aq harti@freebsd.org .
OpenPOWER on IntegriCloud