diff options
author | Dimitry Andric <dim@FreeBSD.org> | 2017-04-27 12:59:14 +0000 |
---|---|---|
committer | Dimitry Andric <dim@FreeBSD.org> | 2017-04-27 12:59:14 +0000 |
commit | af3f36025b146acb03a057959e0ac8faf1f2fa13 (patch) | |
tree | 160de34699f0fa0489c9bacda58051631fa16f4d /share/man/man4 | |
parent | 51690af2a4b3d3bdfe021ef513b596b0508909f6 (diff) | |
parent | 007e172d64c834b458a33bbccd2a9a9cc0bf6ace (diff) |
Merge ^/head r317281 through r317502.
Notes
Notes:
svn path=/projects/clang500-import/; revision=317503
Diffstat (limited to 'share/man/man4')
-rw-r--r-- | share/man/man4/Makefile | 13 | ||||
-rw-r--r-- | share/man/man4/cy.4 | 257 | ||||
-rw-r--r-- | share/man/man4/en.4 | 78 | ||||
-rw-r--r-- | share/man/man4/fatm.4 | 115 | ||||
-rw-r--r-- | share/man/man4/hatm.4 | 282 | ||||
-rw-r--r-- | share/man/man4/natm.4 | 102 | ||||
-rw-r--r-- | share/man/man4/natmip.4 | 248 | ||||
-rw-r--r-- | share/man/man4/ng_atm.4 | 406 | ||||
-rw-r--r-- | share/man/man4/patm.4 | 192 | ||||
-rw-r--r-- | share/man/man4/u3g.4 | 16 | ||||
-rw-r--r-- | share/man/man4/uark.4 | 16 | ||||
-rw-r--r-- | share/man/man4/uart.4 | 6 | ||||
-rw-r--r-- | share/man/man4/ubsa.4 | 16 | ||||
-rw-r--r-- | share/man/man4/ubser.4 | 17 | ||||
-rw-r--r-- | share/man/man4/uchcom.4 | 16 | ||||
-rw-r--r-- | share/man/man4/ucom.4 | 22 | ||||
-rw-r--r-- | share/man/man4/ucycom.4 | 17 | ||||
-rw-r--r-- | share/man/man4/uftdi.4 | 16 | ||||
-rw-r--r-- | share/man/man4/uipaq.4 | 17 | ||||
-rw-r--r-- | share/man/man4/umcs.4 | 16 | ||||
-rw-r--r-- | share/man/man4/umct.4 | 16 | ||||
-rw-r--r-- | share/man/man4/umodem.4 | 16 | ||||
-rw-r--r-- | share/man/man4/umoscom.4 | 16 | ||||
-rw-r--r-- | share/man/man4/uplcom.4 | 16 | ||||
-rw-r--r-- | share/man/man4/uslcom.4 | 16 | ||||
-rw-r--r-- | share/man/man4/utopia.4 | 196 | ||||
-rw-r--r-- | share/man/man4/uvisor.4 | 16 | ||||
-rw-r--r-- | share/man/man4/uvscom.4 | 15 |
28 files changed, 261 insertions, 1914 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index e05cce1d7149..748bde202369 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -118,7 +118,6 @@ MAN= aac.4 \ cxgb.4 \ cxgbe.4 \ cxgbev.4 \ - cy.4 \ cyapa.4 \ da.4 \ dc.4 \ @@ -144,7 +143,6 @@ MAN= aac.4 \ edsc.4 \ ehci.4 \ em.4 \ - en.4 \ enc.4 \ epair.4 \ esp.4 \ @@ -153,7 +151,6 @@ MAN= aac.4 \ etherswitch.4 \ eventtimers.4 \ exca.4 \ - fatm.4 \ fd.4 \ fdc.4 \ fdt.4 \ @@ -181,7 +178,6 @@ MAN= aac.4 \ gpioled.4 \ gre.4 \ h_ertt.4 \ - hatm.4 \ hifn.4 \ hme.4 \ hpet.4 \ @@ -307,8 +303,6 @@ MAN= aac.4 \ my.4 \ nand.4 \ nandsim.4 \ - natm.4 \ - natmip.4 \ ncr.4 \ ncv.4 \ ${_ndis.4} \ @@ -320,7 +314,6 @@ MAN= aac.4 \ ${_nfe.4} \ ${_nfsmb.4} \ ng_async.4 \ - ng_atm.4 \ ngatmbase.4 \ ng_atmllc.4 \ ng_bpf.4 \ @@ -397,7 +390,6 @@ MAN= aac.4 \ owc.4 \ ${_padlock.4} \ pass.4 \ - patm.4 \ pccard.4 \ pccbb.4 \ pcf.4 \ @@ -627,11 +619,9 @@ MLINKS+=disc.4 if_disc.4 MLINKS+=ed.4 if_ed.4 MLINKS+=edsc.4 if_edsc.4 MLINKS+=em.4 if_em.4 -MLINKS+=en.4 if_en.4 MLINKS+=enc.4 if_enc.4 MLINKS+=epair.4 if_epair.4 MLINKS+=et.4 if_et.4 -MLINKS+=fatm.4 if_fatm.4 MLINKS+=fd.4 stderr.4 \ fd.4 stdin.4 \ fd.4 stdout.4 @@ -645,7 +635,6 @@ MLINKS+=geom.4 GEOM.4 MLINKS+=gif.4 if_gif.4 MLINKS+=gpio.4 gpiobus.4 MLINKS+=gre.4 if_gre.4 -MLINKS+=hatm.4 if_hatm.4 MLINKS+=hme.4 if_hme.4 MLINKS+=hpet.4 acpi_hpet.4 MLINKS+=${_hptrr.4} ${_rr232x.4} @@ -695,7 +684,6 @@ MLINKS+=nge.4 if_nge.4 MLINKS+=${_ntb_hw.4} ${_ntb.4} MLINKS+=${_nxge.4} ${_if_nxge.4} MLINKS+=ow.4 onewire.4 -MLINKS+=patm.4 if_patm.4 MLINKS+=pccbb.4 cbb.4 MLINKS+=pcm.4 snd.4 \ pcm.4 sound.4 @@ -966,7 +954,6 @@ MAN+= \ usb_template.4 \ usfs.4 \ uslcom.4 \ - utopia.4 \ uvisor.4 \ uvscom.4 \ zyd.4 diff --git a/share/man/man4/cy.4 b/share/man/man4/cy.4 deleted file mode 100644 index c0c807286f1e..000000000000 --- a/share/man/man4/cy.4 +++ /dev/null @@ -1,257 +0,0 @@ -.\" Copyright (c) 1990, 1991 The Regents of the University of California. -.\" All rights reserved. -.\" -.\" This code is derived from software contributed to Berkeley by -.\" the Systems Programming Group of the University of Utah Computer -.\" Science Department. -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" 3. Neither the name of the University nor the names of its contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" from: @(#)dca.4 5.2 (Berkeley) 3/27/91 -.\" from: com.4,v 1.1 1993/08/06 11:19:07 cgd Exp -.\" from: sio.4,v 1.16 1995/06/26 06:05:30 bde Exp $ -.\" $FreeBSD$ -.\" -.Dd May 24, 2004 -.Dt CY 4 -.Os -.Sh NAME -.Nm cy -.Nd Cyclades Cyclom-Y serial driver -.Sh SYNOPSIS -For one ISA card: -.Bd -ragged -offset indent -compact -.Cd "device cy" -.Pp -In -.Pa /boot/device.hints : -.Cd hint.cy.0.at="isa" -.Cd hint.cy.0.irq="10" -.Cd hint.cy.0.maddr="0xd4000" -.Cd hint.cy.0.msize="0x2000" -.Ed -.Pp -For two ISA cards: -.Bd -ragged -offset indent -compact -.Cd "device cy" -.Pp -In -.Pa /boot/device.hints : -.Cd hint.cy.0.at="isa" -.Cd hint.cy.0.irq="10" -.Cd hint.cy.0.maddr="0xd4000" -.Cd hint.cy.0.msize="0x2000" -.Cd hint.cy.1.at="isa" -.Cd hint.cy.1.irq="11" -.Cd hint.cy.1.maddr="0xd6000" -.Cd hint.cy.1.msize="0x2000" -.Ed -.Pp -For PCI cards: -.Bd -ragged -offset indent -compact -.Cd "device cy" -.Cd "options CY_PCI_FASTINTR" -.Pp -No lines are required in -.Pa /boot/device.hints -for PCI cards. -.Ed -.Pp -Minor numbering: -.Bd -literal -offset indent -compact -0b\fIMMMMMMMMMMMMMMMMxxxxxxxxOLIMMMMM\fR - call\fBO\fRut - \fBL\fRock - \fBI\fRnitial - \fBMMMMMMMMMMMMMMMM MMMMMM\fRinor -.Ed -.Sh DESCRIPTION -The -.Nm -driver provides support for Cirrus Logic CD1400-based -.Tn EIA -.Tn RS-232C -.Pf ( Tn CCITT -.Tn V.24 ) -communications interfaces (ports) on Cyclades Cyclom-Y boards. -Each CD1400 provides 4 ports. -Cyclom-Y boards with various numbers of CD1400's are available. -This driver supports up to 8 CD1400's (32 ports) per board. -.Pp -Input and output for each line may set independently -to the following speeds: -50, 75, 110, 134.5, 150, 300, 600, 1200, 1800, 2400, 4800, 9600, -19200, 38400, 57600, or 115200 bps. -Other speeds of up to 150000 are supported by the termios interface -but not by the sgttyb compatibility interface. -The CD1400 is not fast enough to handle speeds above 115200 bps -effectively. -It can transmit on a single line at slightly more than 115200 bps, -but when 4 lines are active in both directions its limit is about -90000 bps on each line. -.\" XXX the following should be true for all serial drivers and -.\" should not be repeated in the man pages for all serial drivers. -.\" It was copied from sio.4. The only change was s/sio/cy/g. -.Pp -Serial ports controlled by the -.Nm -driver can be used for both `callin' and `callout'. -For each port there is a callin device and a callout device. -The minor number of the callout device is 128 higher -than that of the corresponding callin port. -The callin device is general purpose. -Processes opening it normally wait for carrier -and for the callout device to become inactive. -The callout device is used to steal the port from -processes waiting for carrier on the callin device. -Processes opening it do not wait for carrier -and put any processes waiting for carrier on the callin device into -a deeper sleep so that they do not conflict with the callout session. -The callout device is abused for handling programs that are supposed -to work on general ports and need to open the port without waiting -but are too stupid to do so. -.Pp -The -.Nm -driver also supports an initial-state and a lock-state control -device for each of the callin and the callout "data" devices. -The minor number of the initial-state device is 32 higher -than that of the corresponding data device. -The minor number of the lock-state device is 64 higher -than that of the corresponding data device. -The termios settings of a data device are copied -from those of the corresponding initial-state device -on first opens and are not inherited from previous opens. -Use -.Xr stty 1 -in the normal way on the initial-state devices to program -initial termios states suitable for your setup. -.Pp -The lock termios state acts as flags to disable changing -the termios state. -E.g., to lock a flag variable such as -CRTSCTS, use -.Em "stty crtscts" -on the lock-state device. -Speeds and special characters -may be locked by setting the corresponding value in the lock-state -device to any nonzero value. -.Pp -Correct programs talking to correctly wired external devices -work with almost arbitrary initial states and almost no locking, -but other setups may benefit from changing some of the default -initial state and locking the state. -In particular, the initial states for non (POSIX) standard flags -should be set to suit the devices attached and may need to be -locked to prevent buggy programs from changing them. -E.g., CRTSCTS should be locked on for devices that support -RTS/CTS handshaking at all times and off for devices that do not -support it at all. -CLOCAL should be locked on for devices -that do not support carrier. -HUPCL may be locked off if you do not -want to hang up for some reason. -In general, very bad things happen -if something is locked to the wrong state, and things should not -be locked for devices that support more than one setting. -The -CLOCAL flag on callin ports should be locked off for logins -to avoid certain security holes, but this needs to be done by -getty if the callin port is used for anything else. -.Ss Kernel Configuration Options -The -.Em CY_PCI_FASTINTR -option should be used to avoid suboptimal interrupt handling for -PCI Cyclades boards. -The PCI BIOS must be configured with the -.Nm -interrupt not shared with any other active device -for this option to work. -This option is not the default because it is currently harmful in -certain cases where it does not work. -.Sh FILES -.\" XXX more cloning: s/d/c/g and add a ? for the card number. -.Bl -tag -width /dev/ttyic?? -compact -.It Pa /dev/ttyc?? -for callin ports -.It Pa /dev/ttyic?? -.It Pa /dev/ttylc?? -corresponding callin initial-state and lock-state devices -.Pp -.\" XXX more cloning: s/a/c/g. No consistency :-(. -.It Pa /dev/cuac?? -for callout ports -.It Pa /dev/cuaic?? -.It Pa /dev/cualc?? -corresponding callout initial-state and lock-state devices -.El -.Pp -.Bl -tag -width /etc/rc.serial -compact -.It Pa /etc/rc.serial -examples of setting the initial-state and lock-state devices -.El -.Pp -The first question mark in these device names is short for the -card number -(a decimal number between 0 and 65535 inclusive). -The second question mark is short for the port number -(a letter in the range [0-9a-v]). -.Sh DIAGNOSTICS -.Bl -diag -.\" XXX back to s/sio/cy/g. -.It cy%d: silo overflow. -Problem in the interrupt handler. -.El -.Bl -diag -.It cy%d: interrupt-level buffer overflow. -Problem in the bottom half of the driver. -.El -.Bl -diag -.It cy%d: tty-level buffer overflow. -Problem in the application. -Input has arrived faster than the given module could process it -and some has been lost. -.El -.\" .Bl -diag -.\" .It sio%d: reduced fifo trigger level to %d. -.\" Attempting to avoid further silo overflows. -.\" .El -.Sh SEE ALSO -.Xr stty 1 , -.Xr termios 4 , -.Xr tty 4 , -.Xr comcontrol 8 , -.Xr pstat 8 -.Sh HISTORY -The -.Nm -driver is derived from the -.Nm sio -driver and the -.Nx -.Nm -driver and is -.Ud -.Sh BUGS -Serial consoles are not implemented. diff --git a/share/man/man4/en.4 b/share/man/man4/en.4 deleted file mode 100644 index f9281fa968f7..000000000000 --- a/share/man/man4/en.4 +++ /dev/null @@ -1,78 +0,0 @@ -.\" $FreeBSD$ -.\" -.Dd July 16, 2005 -.Dt EN 4 -.Os -.Sh NAME -.Nm en -.Nd "device driver for Midway-based ATM interfaces" -.Sh SYNOPSIS -To compile this driver into the kernel, -place the following lines in your -kernel configuration file: -.Bd -ragged -offset indent -.Cd "device en" -.Cd "device atm" -.Cd "device utopia" -.Ed -.Pp -Alternatively, to load the driver as a -module at boot time, place the following line in -.Xr loader.conf 5 : -.Bd -literal -offset indent -if_en_load="YES" -.Ed -.Sh DESCRIPTION -The -.Nm -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 -For configuring the card for IP see -.Xr natmip 4 . -.Pp -The following sysctls are recognized by the driver additionally to those -handled by -.Xr utopia 4 : -.Bl -tag -width indent -.It Va hw.atm.enX.istats -Contains an array of -.Vt uint32_t -with internal driver statistics. -.It Va hw.atm.enX.debug -This is a bit map of debugging options. -This variable is only available when the driver is compiled with debugging -support. -.El -.Pp -The driver supports the media options -.Cm sdh , -.Cm noscramb -and -.Cm unassigned -(see -.Xr utopia 4 ) . -.Sh DIAGNOSTICS -.Bd -literal -en0 <Efficient Networks ENI-155p> rev 0 int a irq 5 on pci0:16 -en0: ATM midway v0, board IDs 6.0, Utopia (pipelined), 512KB on-board RAM -en0: maximum DMA burst length = 64 bytes -en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated -.Ed -.Sh SEE ALSO -.Xr natm 4 , -.Xr natmip 4 , -.Xr utopia 4 , -.Xr ifconfig 8 , -.Xr route 8 -.Sh AUTHORS -.An Chuck Cranor -of Washington University implemented -.Nm -driver in 1996 for -.Nx . -.Sh CAVEATS -The driver extensively uses DMA on PCI. -The first -generation PCI chipsets do not work or exhibit poor performance. diff --git a/share/man/man4/fatm.4 b/share/man/man4/fatm.4 deleted file mode 100644 index c59ff338b644..000000000000 --- a/share/man/man4/fatm.4 +++ /dev/null @@ -1,115 +0,0 @@ -.\" -.\" Copyright (c) 2001-2003 -.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). -.\" All rights reserved. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" Author: Hartmut Brandt <harti@FreeBSD.org> -.\" -.\" $FreeBSD$ -.\" -.\" fatm(4) man page -.\" -.Dd May 15, 2003 -.Dt FATM 4 -.Os -.Sh NAME -.Nm fatm -.Nd "device driver for Fore PCA200E ATM interfaces" -.Sh SYNOPSIS -.Cd device fatm -.Cd device utopia -.Cd device atm -.Pp -.Cd options NATM -.Sh DESCRIPTION -The -.Nm -device driver supports the FORE (now Marconi) PCA200E ATM interface cards. -The driver interfaces with the -.Xr natm 4 -framework, -.Xr netgraph 4 -and HARP. -It provides only PVC services. -Signalling, ATMARP, ILMI and other -higher layer protocols are implemented using -.Xr netgraph 4 -or HARP. -.Pp -For configuring the card for IP see -.Xr natmip 4 . -The following sysctls are recognized by the driver additionally to those -handled by -.Xr utopia 4 : -.Bl -tag -width indent -.It Va hw.atm.fatm Ns Ar N Ns Va .stats -Returns a device specific statistic list of -.Vt uint32_t -statistic counters. -.It Va hw.atm.fatm Ns Ar N Ns Va .istats -Returns a list of -.Vt uint32_t -with internal driver statistics. -.It Va hw.atm.fatm Ns Ar N Ns Va .retry_tx -If this is set packets are stuffed back into the interface's send queue when -the cards transmit queue is found to be full. -They are transmitted later. -If this is not set the packets are dropped. -It may be useful to set this -if only UBR traffic is sent. -.It Va hw.atm.fatm Ns Ar N Ns Va .debug -.Bf Em -(Only if debugging enabled.) -.Ef -These are debugging flags. -See -.Pa src/sys/dev/fatm/if_fatmvar.h -for the possible flags. -.El -.Pp -The driver supports the media options -.Cm sdh , noscramb -and -.Cm unassigned -(see -.Xr utopia 4 ) . -.Sh DIAGNOSTICS -.Bd -literal -fatm0: <FORE PCA200E> mem 0xd5800000-0xd59fffff irq 9 at device 9.0 on pci0 -.Ed -.Sh SEE ALSO -.Xr natm 4 , -.Xr natmip 4 , -.Xr utopia 4 -.Sh AUTHORS -.An Harti Brandt Aq Mt harti@FreeBSD.org -.Sh BUGS -These cards can CBR shape a single VCC only. -It is currently possible to -request more than one CBR connection. -In this case all the timing will be -wrong. -See -.Xr hatm 4 -for a better card. diff --git a/share/man/man4/hatm.4 b/share/man/man4/hatm.4 deleted file mode 100644 index e6e1714ea3fd..000000000000 --- a/share/man/man4/hatm.4 +++ /dev/null @@ -1,282 +0,0 @@ -.\" -.\" Copyright (c) 2001-2003 -.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). -.\" All rights reserved. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" Author: Hartmut Brandt <harti@FreeBSD.org> -.\" -.\" $FreeBSD$ -.\" -.\" hatm(4) man page -.\" -.Dd May 15, 2003 -.Dt HATM 4 -.Os -.Sh NAME -.Nm hatm -.Nd "device driver for Fore/Marconi HE155 and HE622 ATM interfaces" -.Sh SYNOPSIS -.Cd device hatm -.Cd device utopia -.Cd device atm -.Pp -.Cd options NATM -.Sh DESCRIPTION -The -.Nm -device driver supports the FORE (now Marconi) HE155 and HE622 ATM interface -cards. -The driver interfaces with the -.Xr natm 4 -framework, -.Xr netgraph 4 -and the HARP ATM stack. -It provides only PVC services. -Signalling, ATMARP, ILMI and other -higher layer protocols are implemented using -.Xr netgraph 4 -or HARP. -.Pp -For configuring the card for IP see -.Xr natmip 4 . -.Pp -The following sysctls are recognized by the driver additionally to those -handled by -.Xr utopia 4 : -.Bl -tag -width indent -.It Va hw.atm.hatm.natm_traffic -This is the traffic type to be used for NATM pvc connections. -The type of -this variable is integer and it must have one of the values 0 (UBR) or 1 (CBR). -.It Va hw.atm.hatm.natm_pcr -This is the peak cell rate to be used for NATM CBR connections. -.It Va hw.atm.hatm Ns Ar N Ns Va .stats -Contains an array of -.Vt uint32_t -with device specific statistics. -.It Va hw.atm.hatm Ns Ar N Ns Va .istats -Contains an array of -.Vt uint32_t -with internal driver statistics. -.It Va hw.atm.hatm Ns Ar N Ns Va .debug -.Bf Em -(Only if debugging enabled.) -.Ef -These are the debugging flags. -See -.Pa src/sys/dev/hatm/if_hatmvar.h -for the possible flags. -.It Va hw.atm.hatm Ns Ar N Ns Va .tsr -.Bf Em -(Only if debugging enabled.) -.Ef -This is an array containing all transmission status registers. -For each of the -4096 possible VCCs there are 15 32-bit registers. -.It Va hw.atm.hatm Ns Ar N Ns Va .tpd -.Bf Em -(Only if debugging enabled.) -.Ef -This is an array containing all on card current transmission packet descriptors. -For each of the 4096 possible VCCs there are 16 32-bit registers. -.It Va hw.atm.hatm Ns Ar N Ns Va .mbox -.Bf Em -(Only if debugging enabled.) -.Ef -This is an array containing the mbox registers. -.It Va hw.atm.hatm Ns Ar N Ns Va .cm -.Bf Em -(Only if debugging enabled.) -.Ef -This is an array containing all connection memory registers. -The first 32-bit integer of this array is the ABR base address. -.It Va hw.atm.hatm Ns Ar N Ns Va .heregs -.Bf Em -(Only if debugging enabled.) -.Ef -This is an array containing all card registers including SUNI and the FLASH ROM. -.It Va hw.atm.hatm Ns Ar N Ns Va .lbmem -.Bf Em -(Only if debugging enabled.) -.Ef -Returns the contents of the local memory. -.El -.Pp -The driver supports the media options -.Cm sdh , noscramb -and -.Cm unassigned -(see -.Xr utopia 4 ) . -.Sh ENVIRONMENT -When attaching to a device the driver checks the kernel environment -(see -.Xr kenv 1 ) -to see if the default queues sizes should be overwritten or not. -The -following variables are checked and interpreted as unsigned integer -values (in either radix): -.Bl -tag -width indent -.It Va hw.hatm Ns Ar N Ns Va .rbps0_size -Size of the small receive buffer pool 0. -This pool is used for all -except raw AAL connections. -The pool size must be a power of two between -4 and 8192 inclusive. -When attaching the driver allocates this number -of mbufs. -.It Va hw.hatm Ns Ar N Ns Va .rbps0_thresh -Interrupt threshold for small receive buffer pool 0. -When the number of free -buffers in the pool falls below this threshold it generates an interrupt -so that the driver can refill the pool. -.It Va hw.hatm Ns Ar N Ns Va .rbpl0_thresh -Size of the large receive buffer pool 0. -This pool is used for all -except raw AAL connections. -The pool size must be a power of two between -4 and 8192 inclusive. -When attaching the driver allocates this number -of mbufs with clusters. -.It Va hw.hatm Ns Ar N Ns Va .rbpl0_thresh -Interrupt threshold for large receive buffer pool 0. -When the number of free -buffers in the pool falls below this threshold it generates an interrupt -so that the driver can refill the pool. -.It Va hw.hatm Ns Ar N Ns Va .rbrq0_size -Size of receive buffer return queue 0. -This queue is used to return buffers -filled with received frames to the driver. -The size must be a power of 2 -between 1 and 16384 inclusive. -.It Va hw.hatm Ns Ar N Ns Va .rbrq0_thresh -Interrupt threshold for receive buffer return queue 0. -This threshold -should only be triggered in exceptional cases. -.It Va hw.hatm Ns Ar N Ns Va .rbrq0_tout -Interrupt timeout for receive buffer return queue 0. -An interrupt is generated -after this time if the queue is not empty. -The number is in internal card -ticks. -.It Va hw.hatm Ns Ar N Ns Va .rbrq0_pcnt -Packet count threshold for receive buffer return queue 0. -An interrupt -is generated if this number of packets is in the queue. -.It Va hw.hatm Ns Ar N Ns Va .rbps1_size -Size of the small receive buffer pool 1. -This pool is used for all -raw AAL connections. -The pool size must be a power of two between -4 and 8192 inclusive. -When attaching the driver allocates this number -of mbufs. -.It Va hw.hatm Ns Ar N Ns Va .rbps1_thresh -Interrupt threshold for small receive buffer pool 1. -When the number of free -buffers in the pool falls below this threshold it generates an interrupt -so that the driver can refill the pool. -.It Va hw.hatm Ns Ar N Ns Va .rbrq1_size -Size of receive buffer return queue 1. -This queue is used to return buffers -filled with received cells to the driver. -The size must be a power of 2 -between 1 and 16384 inclusive. -.It Va hw.hatm Ns Ar N Ns Va .rbrq1_thresh -Interrupt threshold for receive buffer return queue 1. -This threshold -should only be triggered in exceptional cases. -.It Va hw.hatm Ns Ar N Ns Va .rbrq1_tout -Interrupt timeout for receive buffer return queue 1. -An interrupt is generated -after this time if the queue is not empty. -The number is in internal card -ticks. -.It Va hw.hatm Ns Ar N Ns Va .rbrq1_pcnt -Packet count threshold for receive buffer return queue 0. -An interrupt -is generated if this number of cells is in the queue. -.It Va hw.hatm Ns Ar N Ns Va .irq0_size -Size of interrupt queue 0. -This must be a number between 1 and 1023 inclusive. -.It Va hw.hatm Ns Ar N Ns Va .irq0_thresh -Interrupt retrigger threshold of interrupt queue 0. -A new interrupt is trigger -if the queue fill state reaches this threshold and the interrupt was no -served. -.It Va hw.hatm Ns Ar N Ns Va .tbrq0_size -Transmit buffer return queue 0 size. -This queue is used to feed back empty -buffers of transmitted frames back to the driver. -It must be a power of 2 -between 1 and 4096 inclusive. -.It Va hw.hatm Ns Ar N Ns Va .tbrq0_thresh -Transmit buffer return queue 0 threshold. -An interrupt is generated if the -queue fill state reaches this point. -.It Va hw.hatm Ns Ar N Ns Va .tpdrq_size -Transmit descriptor ready queue size. -This queue is used by the driver -to feed transmit descriptors into the card. -The size must be a power of 2 -between 1 and 16384 inclusive. -.It Va hw.hatm Ns Ar N Ns Va .tpdmax -Maximum number of active TPDs per connection. -This controls the maximum -number of outstanding packet chunks per connection and thus the maximum -delay packets can have because of queueing on the adapter. -If set to 0, -a connection can eat up all available TPDs. -.It Va hw.hatm Ns Ar N Ns Va .mbuf_max_pages -Maximum number of memory pages allocated to small external mbufs. -This must not be zero and not larger than 65536. -.El -.Sh DIAGNOSTICS -.Bd -literal -hatm0: <FORE HE> mem 0xd2600000-0xd26fffff irq 9 at device 15.0 on pci2 -hatm0: ForeRunnerHE 622, Rev. D, S/N 2949834, MAC=00:20:48:2d:02:ca -.Ed -.Sh SEE ALSO -.Xr natm 4 , -.Xr natmip 4 , -.Xr utopia 4 , -.Xr ifconfig 8 , -.Xr route 8 -.Sh AUTHORS -.An Harti Brandt Aq Mt harti@FreeBSD.org -.Sh CAVEATS -When putting a HE155 into a 64-bit 66MHz PCI slot the machine may hang. -This occurs very early in the POST so that even the display does not turn on. -The HE155 runs only in 33MHz slots (either 32 or 64-bit). -HE622 cards work just fine in 64-bit slots. -.Pp -The driver may not work with bounce buffer, because of -.Xr bus_dmamap_sync 9 -missing the -.Fa offset -and -.Fa len -arguments the -.Nx -function has. diff --git a/share/man/man4/natm.4 b/share/man/man4/natm.4 deleted file mode 100644 index ce9fe606d636..000000000000 --- a/share/man/man4/natm.4 +++ /dev/null @@ -1,102 +0,0 @@ -.\" $FreeBSD$ -.\" -.Dd December 29, 1997 -.Dt NATM 4 -.Os -.Sh NAME -.Nm natm -.Nd Native Mode ATM protocol layer -.Sh DESCRIPTION -The -.Bx -ATM software comes with a -.Em native mode ATM protocol layer -which provides socket level access to AAL0 and AAL5 virtual circuits. -To enable this protocol layer, add -.Dl options NATM -.Dl device atm -to your kernel configuration file and re-make the kernel (do not forget -to do -.Dq make clean ) . -.Sh NATM API -The NATM layer uses a -.Vt struct sockaddr_natm -to specify a virtual circuit: -.Bd -literal -offset indent -struct sockaddr_natm { - uint8_t snatm_len; /* length */ - uint8_t snatm_family; /* AF_NATM */ - char snatm_if[IFNAMSIZ]; /* interface name */ - uint16_t snatm_vci; /* vci */ - uint8_t snatm_vpi; /* vpi */ -}; -.Ed -.Pp -To create an AAL5 connection to a virtual circuit with VPI 0, VCI 201 -one would use the following: -.Bd -literal -offset indent - struct sockaddr_natm snatm; - int s, r; - s = socket(AF_NATM, SOCK_STREAM, PROTO_NATMAAL5); - /* note: PROTO_NATMAAL0 is AAL0 */ - if (s < 0) { perror("socket"); exit(1); } - bzero(&snatm, sizeof(snatm)); - snatm.snatm_len = sizeof(snatm); - snatm.snatm_family = AF_NATM; - sprintf(snatm.snatm_if, "en0"); - snatm.snatm_vci = 201; - snatm.snatm_vpi = 0; - r = connect(s, (struct sockaddr *)&snatm, sizeof(snatm)); - if (r < 0) { perror("connect"); exit(1); } - /* s now connected to ATM! */ -.Ed -.Pp -The -.Fn socket -call simply creates an unconnected NATM socket. -The -.Fn connect -call associates an unconnected NATM socket with a -virtual circuit and tells the driver to enable that virtual circuit -for receiving data. -After the -.Fn connect -call one can -.Fn read -or -.Fn write -to the socket to perform ATM I/O. -.Sh Internal NATM operation -Internally, the NATM protocol layer keeps a list of all active virtual -circuits on the system in -.Dv natm_pcbs . -This includes circuits currently being used for IP to prevent NATM and -IP from clashing over virtual circuit usage. -.Pp -When a virtual circuit is enabled for receiving data, the NATM -protocol layer passes the address of the protocol control block down -to the driver as a receive -.Dq handle . -When inbound data arrives, the driver passes the data back with the -appropriate receive handle. -The NATM layer uses this to avoid the -overhead of a protocol control block lookup. -This allows us to take -advantage of the fact that ATM has already demultiplexed the data for -us. -.Sh SEE ALSO -.Xr en 4 , -.Xr fatm 4 , -.Xr hatm 4 , -.Xr natmip 4 , -.Xr patm 4 -.Sh AUTHORS -.An Chuck Cranor -of Washington University implemented the NATM protocol layer -along with the EN ATM driver in 1996 for -.Nx . -.Sh CAVEATS -The NATM protocol support is subject to change as -the ATM protocols develop. -Users should not depend on details of the current implementation, but rather -the services exported. diff --git a/share/man/man4/natmip.4 b/share/man/man4/natmip.4 deleted file mode 100644 index 154e97da6681..000000000000 --- a/share/man/man4/natmip.4 +++ /dev/null @@ -1,248 +0,0 @@ -.\" -.\" Copyright (c) 2003 -.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). -.\" All rights reserved. -.\" -.\" Author: Hartmut Brandt <harti@FreeBSD.org> -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" $FreeBSD$ -.\" -.Dd August 11, 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 -.Li ( en0 -in this example) is configured for IP by something -like: -.Pp -.Dl "ifconfig en0 128.252.200.1 netmask 0xffffff00 up" -.Pp -IP routing is done with special interface routes (routes with directly -reachable destinations) with a link layer gateway address. -The link layer address specifies the ATM interface through which the -destination can be reached, the virtual channel that connects to the -destination and the ATM characteristics of this channel. -The address part of the link layer address (see -.Xr link_addr 3 ) -consists of a fixed part (the first 5 bytes) and a part that -depends on the kind of the PVC (UBR, CBR, VBR, ABR). -Multi-byte values -are big-endian encoded: the bytes with the lower numbers contain the -higher order bits. -.Bl -tag -width "bytes 12...12" -offset indent -.It byte 0 -Is a flag byte. -Currently only flag 0x20 is used. -When set, all IP frames are LLC/SNAP encapsulated before putting them into -an AAL5 frame. -Setting this flag is recommended and allows interoperability with other -CLIP implementations. -Note that BPF works only with LLC/SNAP encapsulation. -.It byte 1 -This is the VPI of the channel. -.It bytes 2...3 -VCI of the channel. -Must not be zero. -.It byte 4 -Traffic type. -One of 0 (UBR), 1 (CBR), 2 (ABR), 3 (VBR). -.El -.Pp -The variable part for UBR connections may be either empty or three bytes: -.Bl -tag -width "bytes 12...12" -offset indent -.It bytes 5...7 -Specifies the peak cell rate for UBR. -.El -.Pp -The variable part for CBR connections must be three bytes: -.Bl -tag -width "bytes 12...12" -offset indent -.It bytes 5...7 -Specifies the peak cell rate for CBR. -.El -.Pp -The variable part for VBR connections must be 9 bytes long and specifies three -values: -.Bl -tag -width "bytes 12...12" -offset indent -.It bytes 5...7 -Specifies the peak cell rate for VBR. -.It bytes 8...10 -This is the sustainable cell rate. -.It bytes 11...13 -The maximum burst size. -.El -.Pp -The variable part for ABR connections must be 19 bytes long and specifies the -following values: -.Bl -tag -width "bytes 12...12" -offset indent -.It bytes 5...7 -Specifies the peak cell rate for ABR. -.It bytes 8...10 -The minimum cell rate. -.It bytes 11...13 -The initial cell rate. -.It bytes 14...16 -The transient buffer exposure. -.It byte 17 -The NRM value. -.It byte 18 -The TRM value. -.It bytes 19...20 -The ADTF value. -.It byte 21 -The rate increase factor (RIF). -.It byte 22 -The rate decrease factor (RDF). -.It byte 23 -The cutoff decrease factor (CDF). -.El -.Pp -To add a PVC the -.Xr route 8 -utility can be used: -.Bd -ragged -offset indent -.Nm route Cm add -.Fl iface Aq Ar "remote\ IP\ address" -.Fl link Ao Ar iface Ac : Ns Aq Ar lladdr -.Ed -.Pp -The -.Ar iface -is the ATM interface through which -.Ar "remote\ IP\ address" -can be reached and -.Ar lladdr -is the link layer address as a string of dot-separated, hexadecimal bytes. -.Pp -NATM also supports the old, original format. -This consists of 4 byte -link layer addresses (and the channels are implicit UBR): -.Bl -tag -width "bytes 12...12" -offset indent -.It byte 0 -Flags: -.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. -.It byte 1 -VPI for the channel -.It bytes 2...3 -VCI for the channel -.El -.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 UBR -.It -between 128.252.200.1 and 128.252.200.3: 0xca VBR -.It -between 128.252.200.2 and 128.252.200.3: 0xcb CBR -.El -.Pp -The parameters for the VBR channel are: PCR 50000, SCR 10000, MBS 10. -The peak cell rate for the CBR channel is 100000. -.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.0 -route add -iface 128.252.200.3 -link en0:3.0.0.ca.3.0.c3.50.0.27.10.0.0.a -.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.0 -route add -iface 128.252.200.3 -link en0:3.0.0.cb.1.1.86.a0 -.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.3.0.c3.50.0.27.10.0.0.a -route add -iface 128.252.200.2 -link en0:3.0.0.cb.1.1.86.a0 -.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.0" -route_host3="-iface 128.252.200.3 -link en0:3.0.0.ca.3.0.c3.50.0.27.10.0.0.a" -.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.0" -route_host3="-iface 128.252.200.3 -link en0:3.0.0.cb.1.1.86.a0" -.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.3.0.c3.50.0.27.10.0.0.a" -route_host2="-iface 128.252.200.2 -link en0:3.0.0.cb.1.1.86.a0" -.Ed -.Sh SEE ALSO -.Xr en 4 , -.Xr fatm 4 , -.Xr hatm 4 , -.Xr natm 4 , -.Xr patm 4 -.Sh AUTHORS -.An Chuck Cranor -of Washington University implemented the NATM protocol layer -along with the EN ATM driver in 1996 for -.Nx . diff --git a/share/man/man4/ng_atm.4 b/share/man/man4/ng_atm.4 deleted file mode 100644 index 2ac1accba386..000000000000 --- a/share/man/man4/ng_atm.4 +++ /dev/null @@ -1,406 +0,0 @@ -.\" -.\" Copyright (c) 2001-2003 -.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). -.\" All rights reserved. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" Author: Hartmut Brandt <harti@FreeBSD.org> -.\" -.\" $FreeBSD$ -.\" -.\" ng_atm(4) man page -.\" -.Dd November 2, 2012 -.Dt NG_ATM 4 -.Os -.Sh NAME -.Nm ng_atm -.Nd netgraph ATM node type -.Sh SYNOPSIS -.In sys/types.h -.In net/if_atm.h -.In netgraph.h -.In netgraph/atm/ng_atm.h -.Sh DESCRIPTION -The -.Nm atm -netgraph node type allows -.Xr natm 4 -ATM drivers to be connected to the -.Xr netgraph 4 -networking subsystem. -When the -.Nm -module is loaded a node is automatically created for each -.Xr natm 4 -ATM interface. -The nodes are named with the same name as the -interface. -Nodes are also created if a driver for an ATM -card is loaded after -.Nm -was loaded. -.Pp -The -.Nm atm -nodes are persistent. -They are removed when the interface is removed. -.Dv NGM_SHUTDOWN -messages are ignored by the node. -.Sh HOOKS -Four special hooks with fixed names and an unlimited number of hooks with user -defined names are supported. -Three of the fixed hooks are attached to -strategic points in the information flow in the -.Xr natm 4 -system and support only reading. -The fourth fixed hook behaves like the other -user hooks, but a number of management messages are sent along the hook. -The other hooks can be attached to VCIs dynamically by means of -control messages to the -.Nm atm -node and can be written and read. -.Pp -The four fixed hooks are: -.Bl -tag -width ".Va orphans" -.It Va input -This is a connection to the raw input stream from the network. -If this hook is connected, all incoming packets are delivered out to -this hook. -Note that this redirects ALL input. -Neither -.Xr natm 4 -nor the user hooks will see any input if -.Va input -is connected. -An -.Vt atm_pseudohdr -(see -.Xr natm 4 ) -is prepended to the actual data. -.It Va output -This is a connection to the raw output stream to the network device. -If this hook is connected, all outgoing packets are handed over to -the netgraph system and delivered to the hook instead of being delivered -to the ATM driver. -An -.Vt atm_pseudohdr -(see -.Xr natm 4 ) -is prepended to the actual data. -.It Va orphans -This hook receives all packets that are unrecognized, i.e., do not belong to -either a -.Xr natm 4 -socket, a -.Nm -VCI or -.Xr natm 4 -IP. -Because ATM is connection oriented and packets are received on a given VCI only -when someone initiates this VCI, packets should never be orphaned. -There is -however one exception: if you use -.Xr natm 4 -IP with LLC/SNAP encapsulation packets with do not have the IP protocol -indicated in the packet header are delivered out of this hook. -An -.Vt atm_pseudohdr -(see -.Xr natm 4 ) -is prepended to the actual data send out to the hook. -.It Va manage -This hook behaves exactly like a normal user hook (see below) except that -the node at the other hand will receive management messages. -.El -.Pp -Hooks for dynamically initiated VCIs can have whatever name is allowed by -.Xr netgraph 4 -as long as the name does not collide with one of the three predefined names. -.Pp -To initiate packet sending and receiving on a dynamic hook, one has to issue -a -.Dv NGM_ATM_CPCS_INIT -control message. -To terminate sending and receiving one must send a -.Dv NGM_ATM_CPCS_TERM -message (see -.Sx CONTROL MESSAGES ) . -The data sent and received on these hooks has no additional -headers. -.Sh CONTROL MESSAGES -This node type supports the generic messages plus the following: -.Bl -tag -width 4n -.It Dv NGM_ATM_GET_IFNAME Pq Ic getifname -Return the name of the interface as a -.Dv NUL Ns --terminated string. -This is normally the same name as that of the node. -.It Dv NGM_ATM_GET_CONFIG Pq Ic getconfig -Returns a structure defining the configuration of the interface: -.Bd -literal -struct ngm_atm_config { - uint32_t pcr; /* peak cell rate */ - uint32_t vpi_bits; /* number of active VPI bits */ - uint32_t vci_bits; /* number of active VCI bits */ - uint32_t max_vpcs; /* maximum number of VPCs */ - uint32_t max_vccs; /* maximum number of VCCs */ -}; -.Ed -.It Dv NGM_ATM_GET_VCCS Pq Ic getvccs -Returns the table of open VCCs from the driver. -This table consists of -a header and a variable sized array of entries, one for each open VCC: -.Bd -literal -struct atmio_vcctable { - uint32_t count; /* number of vccs */ - struct atmio_vcc vccs[0]; /* array of VCCs */ -}; -struct atmio_vcc { - uint16_t flags; /* flags */ - uint16_t vpi; /* VPI */ - uint16_t vci; /* VCI */ - uint16_t rmtu; /* Receive maximum CPCS size */ - uint16_t tmtu; /* Transmit maximum CPCS size */ - uint8_t aal; /* aal type */ - uint8_t traffic; /* traffic type */ - struct atmio_tparam tparam; /* traffic parameters */ -}; -struct atmio_tparam { - uint32_t pcr; /* 24bit: Peak Cell Rate */ - uint32_t scr; /* 24bit: VBR Sustainable Cell Rate */ - uint32_t mbs; /* 24bit: VBR Maximum burst size */ - uint32_t mcr; /* 24bit: ABR/VBR/UBR+MCR MCR */ - uint32_t icr; /* 24bit: ABR ICR */ - uint32_t tbe; /* 24bit: ABR TBE (1...2^24-1) */ - uint8_t nrm; /* 3bit: ABR Nrm */ - uint8_t trm; /* 3bit: ABR Trm */ - uint16_t adtf; /* 10bit: ABR ADTF */ - uint8_t rif; /* 4bit: ABR RIF */ - uint8_t rdf; /* 4bit: ABR RDF */ - uint8_t cdf; /* 3bit: ABR CDF */ -}; -.Ed -.Pp -Note that this is the driver's table, so all VCCs opened via -.Xr natm 4 -sockets and IP are also shown. -They can, however, be distinguished by -their flags. -The -.Va flags -field contains the following flags: -.Pp -.Bl -tag -width ".Dv ATM_PH_LLCSNAP" -offset indent -compact -.It Dv ATM_PH_AAL5 -use AAL5 instead of AAL0 -.It Dv ATM_PH_LLCSNAP -if AAL5 use LLC SNAP encapsulation -.It Dv ATM_FLAG_NG -this is a netgraph VCC -.It Dv ATM_FLAG_HARP -this is a HARP VCC -.It Dv ATM_FLAG_NORX -transmit only VCC -.It Dv ATM_FLAG_NOTX -receive only VCC -.It Dv ATMIO_FLAG_PVC -treat channel as a PVC -.El -.Pp -If the -.Dv ATM_FLAG_NG -flag is set, then -.Va traffic -and -.Va tparam -contain meaningful information. -.Pp -The -.Va aal -field -contains one of the following values: -.Pp -.Bl -tag -width ".Dv ATM_PH_LLCSNAP" -offset indent -compact -.It Dv ATMIO_AAL_0 -AAL 0 (raw cells) -.It Dv ATMIO_AAL_34 -AAL 3 or AAL 4 -.It Dv ATMIO_AAL_5 -AAL 5 -.It Dv ATMIO_AAL_RAW -device specific raw cells -.El -.Pp -The -.Va traffic -field -can have one of the following values (not all drivers support -all traffic types however): -.Pp -.Bl -tag -width ".Dv ATM_PH_LLCSNAP" -offset indent -compact -.It Dv ATMIO_TRAFFIC_UBR -.It Dv ATMIO_TRAFFIC_CBR -.It Dv ATMIO_TRAFFIC_ABR -.It Dv ATMIO_TRAFFIC_VBR -.El -.It Dv NGM_ATM_CPCS_INIT Pq Ic cpcsinit -Initialize a VCC for sending and receiving. -The argument is a structure: -.Bd -literal -struct ngm_atm_cpcs_init { - char name[NG_HOOKSIZ]; - uint32_t flags; /* flags. (if_atm.h) */ - uint16_t vci; /* VCI to open */ - uint16_t vpi; /* VPI to open */ - uint16_t rmtu; /* receive maximum PDU */ - uint16_t tmtu; /* transmit maximum PDU */ - uint8_t aal; /* AAL type (if_atm.h) */ - uint8_t traffic; /* traffic type (if_atm.h) */ - uint32_t pcr; /* Peak cell rate */ - uint32_t scr; /* VBR: Sustainable cell rate */ - uint32_t mbs; /* VBR: Maximum burst rate */ - uint32_t mcr; /* UBR+: Minimum cell rate */ - uint32_t icr; /* ABR: Initial cell rate */ - uint32_t tbe; /* ABR: Transmit buffer exposure */ - uint8_t nrm; /* ABR: Nrm */ - uint8_t trm; /* ABR: Trm */ - uint16_t adtf; /* ABR: ADTF */ - uint8_t rif; /* ABR: RIF */ - uint8_t rdf; /* ABR: RDF */ - uint8_t cdf; /* ABR: CDF */ -}; -.Ed -.Pp -The -.Va name -field -is the name of the hook for which sending and receiving should be enabled. -This hook must already be connected. -The -.Va vpi -and -.Va vci -fields -are the respective VPI and VCI values to use for the ATM cells. -They must be -within the range, given by the -.Va maxvpi -and -.Va maxvci -fields of the -.Vt ng_atm_config -structure. -The -.Va flags -field -contains the flags (see above) and the other fields describe the -type of traffic. -.It Dv NGM_ATM_CPCS_TERM Pq Ic cpcsterm -Stop sending and receiving on the indicated hook. -The argument is a -.Bd -literal -struct ngm_atm_cpcs_term { - char name[NG_HOOKSIZ]; -}; -.Ed -.It Dv NGM_ATM_GET_STATS Pq Ic getstats -This command returns a message, containing node statistics. -The structure of the message is: -.Bd -literal -struct ngm_atm_stats { - uint64_t in_packets; - uint64_t in_errors; - uint64_t out_packets; - uint64_t out_errors; -}; -.Ed -.El -.Sh MANAGEMENT MESSAGES -If the -.Va manage -hook is connected, certain messages are sent along the hook. -They are -received by the peer node with a cookie of -.Dv NG_ATM_COOKIE . -.Bl -tag -width 4n -.It Dv NGM_ATM_VCC_CHANGE Pq Ic vcc_change -A permanent VCC has been added, deleted or changed. -This is used by -.Xr ilmid 8 -to generate the appropriate ILMI traps. -The structure of the message is: -.Bd -literal -struct ngm_atm_vcc_change { - uint32_t node; - uint16_t vci; - uint8_t vpi; - uint8_t state; -}; -.Ed -Where -.Va state -is 0 if the PVC was deleted, and 1 if it was added or modified. -.El -.Sh FLOW CONTROL -If the hardware driver supports it, the node can emit flow control messages -along a user hook. -The format of these messages is described in -.In netgraph/ng_message.h . -The -.Nm atm -node may generate -.Dv NGM_HIGH_WATER_PASSED -and -.Dv NGM_LOW_WATER_PASSED -messages. -The first one indicates that the hardware driver has stopped output -on the channel and drops new packets, the second one reports that -output was reenabled. -Currently, the structures are not filled with -information. -.Sh SHUTDOWN -The nodes are persistent as long as the corresponding interface exists. -Upon receipt of a -.Dv NGM_SHUTDOWN -messages, all hooks are disconnected and the node is reinitialized. -All -VCCs opened via -.Xr netgraph 4 -are closed. -When the ATM interface is unloaded, -the node disappears. -If the node is compiled with -.Dv NGATM_DEBUG -there is a sysctl -.Va net.graph.atm.allow_shutdown -which, when set to a non-zero value, allows the nodes to shut down. -Note that this is intended for development only and may lead to kernel -panics if set. -.Sh SEE ALSO -.Xr natm 4 , -.Xr netgraph 4 , -.Xr ng_ether 4 , -.Xr ngctl 8 -.Sh AUTHORS -.An Harti Brandt Aq Mt harti@FreeBSD.org diff --git a/share/man/man4/patm.4 b/share/man/man4/patm.4 deleted file mode 100644 index 4f7a10438f43..000000000000 --- a/share/man/man4/patm.4 +++ /dev/null @@ -1,192 +0,0 @@ -.\" -.\" Copyright (c) 2003 -.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). -.\" All rights reserved. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" Author: Hartmut Brandt <harti@FreeBSD.org> -.\" -.\" $FreeBSD$ -.\" -.\" patm(4) man page -.\" -.Dd July 15, 2003 -.Dt PATM 4 -.Os -.Sh NAME -.Nm patm -.Nd "device driver for IDT77252 based ATM interfaces (ProSum and IDT)" -.Sh SYNOPSIS -.Cd device patm -.Cd device utopia -.Cd device atm -.Pp -.Cd options NATM -.Cd options LIBMBPOOL -.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. -The driver interfaces with the -.Xr natm 4 -framework, -.Xr netgraph 4 -and HARP. -It provides only PVC services. -Signalling, ATMARP, ILMI and other -higher layer protocols are implemented using -.Xr netgraph 4 -or HARP. -.Pp -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. -.Pp -The following sysctls are recognized by the driver additionally to those -handled by -.Xr utopia 4 : -.Bl -tag -width indent -.It Va hw.atm.patm Ns Ar N Ns Va .istats -Returns a list of -.Vt uint32_t -statistic counters with internal driver statistics. -.It Va hw.atm.patm Ns Ar N Ns Va .eeprom -This is a read-only variable containing the contents of the on-board EEPROM -device. -.It Va hw.atm.patm Ns Ar N Ns Va .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 -.Xr loader 8 -tunable. -.It Va hw.atm.patm Ns Ar N Ns Va .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 -.Xr loader 8 -tunable. -.It Va hw.atm.patm Ns Ar N Ns Va .debug -.Bf Em -(Only if debugging enabled.) -.Ef -These are debugging flags. -See -.Pa src/sys/dev/patm/if_patmvar.h -for the possible flags. -This may be initialized via a -.Xr loader 8 -tunable. -.It Va hw.atm.patm Ns Ar N Ns Va .regs -.Bf Em -(Only if debugging enabled.) -.Ef -Returns the current values of the card's registers. -.It Va hw.atm.patm Ns Ar N Ns Va .tsq -Returns the transmit status queue. -.El -.Pp -When loaded, the driver initializes several variables from -.Xr loader 8 -tunables: -.Bl -tag -width indent -.It Va hw.patm Ns Ar N Ns Va .lbuf_max -This initializes the corresponding -.Xr sysctl 8 -variable and defines an upper -limit on the number of large receive buffers (mbuf clusters). -.It Va hw.patm Ns Ar N Ns Va .tx_maxmaps -This initializes the corresponding -.Xr sysctl 8 -variable and is the maximum -number of DMA maps for transmission that the driver will allocated. -.It Va hw.patm Ns Ar N Ns Va .debug -.Bf Em -(Only if debugging enabled.) -.Ef -Initializes the debugging flags. -.El -.Pp -The driver supports the media options -.Cm sdh , noscramb -and -.Cm 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. -.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 -patm1: IDT77252 155MBit interface; idt77252 Rev. G; IDT77155 PHY -patm1: 128K x 32 SRAM; 4096 connections -.Ed -.Sh SEE ALSO -.Xr natm 4 , -.Xr natmip 4 , -.Xr utopia 4 -.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. -.Sh AUTHORS -.An Harti Brandt Aq Mt harti@FreeBSD.org -.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. -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% 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. -.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 -and, according to the documentation, this should not influence cell spacing, -it does, so the driver lets the chip generate idle cells. diff --git a/share/man/man4/u3g.4 b/share/man/man4/u3g.4 index ceec14bcccf7..7df2a8c2cfc7 100644 --- a/share/man/man4/u3g.4 +++ b/share/man/man4/u3g.4 @@ -18,7 +18,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 26, 2013 +.Dd April 26, 2017 .Dt U3G 4 .Os .Sh NAME @@ -97,6 +97,20 @@ See .Xr usbconfig 8 and .Xr usb_quirk 4 . +.Sh FILES +.Bl -tag -width "/dev/ttyU?.?.init" -compact +.It Pa /dev/ttyU?.? +for callin ports +.It Pa /dev/ttyU?.?.init +.It Pa /dev/ttyU?.?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU?.? +for callout ports +.It Pa /dev/cuaU?.?.init +.It Pa /dev/cuaU?.?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/uark.4 b/share/man/man4/uark.4 index b130ff165484..f09b3c5d27b6 100644 --- a/share/man/man4/uark.4 +++ b/share/man/man4/uark.4 @@ -16,7 +16,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 20, 2011 +.Dd April 26, 2017 .Dt UARK 4 .Os .Sh NAME @@ -57,6 +57,20 @@ KQ-U8A Data Cable .It Skymaster USB to RS232 .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/uart.4 b/share/man/man4/uart.4 index cbf8e0808187..faa8ff0024cf 100644 --- a/share/man/man4/uart.4 +++ b/share/man/man4/uart.4 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd December 9, 2015 +.Dd April 26, 2017 .Dt UART 4 .Os .Sh NAME @@ -226,14 +226,14 @@ level signal at up to 12 volts. A connection to header pins or an edge-connector on an embedded board is typically a TTL signal at 3.3 or 5 volts. .Sh FILES -.Bl -tag -width ".Pa /dev/ttyu?.init" -compact +.Bl -tag -width "/dev/ttyu?.init" -compact .It Pa /dev/ttyu? for callin ports .It Pa /dev/ttyu?.init .It Pa /dev/ttyu?.lock corresponding callin initial-state and lock-state devices .Pp -.It Pa /dev/cuau? +.It Pa /dev/cuau* for callout ports .It Pa /dev/cuau?.init .It Pa /dev/cuau?.lock diff --git a/share/man/man4/ubsa.4 b/share/man/man4/ubsa.4 index 12a18f007504..98bc69c6fc5f 100644 --- a/share/man/man4/ubsa.4 +++ b/share/man/man4/ubsa.4 @@ -28,7 +28,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 20, 2011 +.Dd April 26, 2017 .Dt UBSA 4 .Os .Sh NAME @@ -81,6 +81,20 @@ GoHubs GoCOM232 .It Peracom single port serial adapter .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/ubser.4 b/share/man/man4/ubser.4 index 556d4ec3a41e..780e1c227d62 100644 --- a/share/man/man4/ubser.4 +++ b/share/man/man4/ubser.4 @@ -28,7 +28,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 20, 2011 +.Dd April 26, 2017 .Dt UBSER 4 .Os .Sh NAME @@ -55,11 +55,22 @@ The .Nm driver provides support for the BWCT console management serial adapters. .Sh FILES -.Bl -tag -width ".Pa /dev/ttyy??" -compact -.It Pa /dev/ttyy?? +.Bl -tag -width "/dev/ttyU?.?.init" -compact +.It Pa /dev/ttyU?.? +for callin ports +.It Pa /dev/ttyU?.?.init +.It Pa /dev/ttyU?.?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU?.? +for callout ports +.It Pa /dev/cuaU?.?.init +.It Pa /dev/cuaU?.?.lock +corresponding callout initial-state and lock-state devices .El .Sh SEE ALSO .Xr tty 4 , +.Xr ucom 4 , .Xr usb 4 .Sh HISTORY The diff --git a/share/man/man4/uchcom.4 b/share/man/man4/uchcom.4 index d7c0abc7659d..957d84f8ae86 100644 --- a/share/man/man4/uchcom.4 +++ b/share/man/man4/uchcom.4 @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 20, 2011 +.Dd April 26, 2017 .Dt UCHCOM 4 .Os .Sh NAME @@ -70,6 +70,20 @@ driver supports the following adapters: .It HL USB-RS232 .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/ucom.4 b/share/man/man4/ucom.4 index 6fb0ecef7048..9984503e073f 100644 --- a/share/man/man4/ucom.4 +++ b/share/man/man4/ucom.4 @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 11, 2015 +.Dd April 26, 2017 .Dt UCOM 4 .Os .Sh NAME @@ -92,15 +92,31 @@ Capture pulses on the CTS line. Capture pulses on the DCD line. .El .Sh FILES -.Bl -tag -width ".Pa /dev/cuaU?" -.It Pa /dev/cuaU? +.Bl -tag -width "/dev/ttyU?.init" -compact .It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices .El .Sh SEE ALSO .Xr tty 4 , .Xr uark 4 , +.Xr ubsa 4 , +.Xr ubser 4 , .Xr uchcom 4 , +.Xr ucycom 4 , +.Xr ufoma 4 , .Xr uftdi 4 , +.Xr uhso 4 , +.\".Xr ugensa 4 , +.Xr uipaq 4 , .Xr umcs 4 , .Xr umct 4 , .Xr umodem 4 , diff --git a/share/man/man4/ucycom.4 b/share/man/man4/ucycom.4 index 8ec0a4812c24..b20cbeb7e5c9 100644 --- a/share/man/man4/ucycom.4 +++ b/share/man/man4/ucycom.4 @@ -27,7 +27,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 20, 2011 +.Dd April 26, 2017 .Dt UCYCOM 4 .Os .Sh NAME @@ -71,8 +71,23 @@ Cypress USB to RS232 bridge chips: .It DeLorme Earthmate USB GPS receiver .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , +.Xr ucom 4 , .Xr usb 4 .Sh HISTORY The diff --git a/share/man/man4/uftdi.4 b/share/man/man4/uftdi.4 index dc45373ae401..afe0fa6c0023 100644 --- a/share/man/man4/uftdi.4 +++ b/share/man/man4/uftdi.4 @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 6, 2015 +.Dd April 26, 2017 .Dt UFTDI 4 .Os .Sh NAME @@ -242,6 +242,20 @@ Buffalo PC-OP-RS / Kurouto-shikou KURO-RS universal remote .It Prologix GPIB-USB Controller .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/uipaq.4 b/share/man/man4/uipaq.4 index 96b23e3c2fdf..8a6d539c2071 100644 --- a/share/man/man4/uipaq.4 +++ b/share/man/man4/uipaq.4 @@ -30,7 +30,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 20, 2011 +.Dd April 26, 2017 .Dt UIPAQ 4 .Os .Sh NAME @@ -79,10 +79,23 @@ The device is accessed through the .Xr ucom 4 driver which makes it behave like a .Xr tty 4 . +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , -.Xr uhub 4 , .Xr usb 4 .Sh HISTORY The diff --git a/share/man/man4/umcs.4 b/share/man/man4/umcs.4 index f94e359aadb8..42e89a69980f 100644 --- a/share/man/man4/umcs.4 +++ b/share/man/man4/umcs.4 @@ -28,7 +28,7 @@ .\" .\" $FreeBSD$ .\" -.Dd February 25, 2012 +.Dd April 26, 2017 .Dt UMCS 4 .Os .Sh NAME @@ -80,6 +80,20 @@ ST Lab U-360 two-port serial USB adapter .It ST Lab U-400 four-port serial USB adapter .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.?.init" -compact +.It Pa /dev/ttyU?.? +for callin ports +.It Pa /dev/ttyU?.?.init +.It Pa /dev/ttyU?.?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU?.? +for callout ports +.It Pa /dev/cuaU?.?.init +.It Pa /dev/cuaU?.?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/umct.4 b/share/man/man4/umct.4 index 00e4e09e20cd..893711ef6d5a 100644 --- a/share/man/man4/umct.4 +++ b/share/man/man4/umct.4 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 20, 2011 +.Dd April 26, 2017 .Dt UMCT 4 .Os .Sh NAME @@ -78,6 +78,20 @@ Magic Control Technology USB-232 .It Sitecom USB-232 .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/umodem.4 b/share/man/man4/umodem.4 index 480b453f5328..aaa1f99738b1 100644 --- a/share/man/man4/umodem.4 +++ b/share/man/man4/umodem.4 @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 6, 2012 +.Dd April 26, 2017 .Dt UMODEM 4 .Os .Sh NAME @@ -95,6 +95,20 @@ Sony Ericsson W810i phone .It Sonim XP5300 Force .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/umoscom.4 b/share/man/man4/umoscom.4 index 93f5fbd8414d..11f638ffb118 100644 --- a/share/man/man4/umoscom.4 +++ b/share/man/man4/umoscom.4 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 18, 2014 +.Dd April 26, 2017 .Dt UMOSCOM 4 .Os .Sh NAME @@ -56,6 +56,20 @@ The device is accessed through the .Xr ucom 4 driver which makes it behave like a .Xr tty 4 . +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/uplcom.4 b/share/man/man4/uplcom.4 index d38626107909..164703431789 100644 --- a/share/man/man4/uplcom.4 +++ b/share/man/man4/uplcom.4 @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 25, 2012 +.Dd April 26, 2017 .Dt UPLCOM 4 .Os .Sh NAME @@ -180,6 +180,20 @@ YC-Cable USB-Serial Adapter .It Zeagle N2iTion3 Diving Computer .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/uslcom.4 b/share/man/man4/uslcom.4 index 01eb93dc4bb9..c24920ddbeff 100644 --- a/share/man/man4/uslcom.4 +++ b/share/man/man4/uslcom.4 @@ -16,7 +16,7 @@ .\" .\" $FreeBSD$ .\" -.Dd August 4, 2012 +.Dd April 26, 2017 .Dt USLCOM 4 .Os .Sh NAME @@ -192,6 +192,20 @@ WMR RIGblaster Plug&Play and RIGtalk RT1 .It Zephyr Bioharness .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/utopia.4 b/share/man/man4/utopia.4 deleted file mode 100644 index b3c0e5b9c2f0..000000000000 --- a/share/man/man4/utopia.4 +++ /dev/null @@ -1,196 +0,0 @@ -.\" Copyright (c) 2003 -.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). -.\" All rights reserved. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" Author: Hartmut Brandt <harti@FreeBSD.org> -.\" -.\" $FreeBSD$ -.\" -.Dd November 22, 2006 -.Dt UTOPIA 4 -.Os -.Sh NAME -.Nm utopia -.Nd "driver module for ATM PHY chips" -.Sh SYNOPSIS -To compile this driver into the kernel, -place the following line in your -kernel configuration file: -.Bd -ragged -offset indent -.Cd "device utopia" -.Ed -.Pp -Alternatively, to load the driver as a -module at boot time, place the following line in -.Xr loader.conf 5 : -.Bd -literal -offset indent -utopia_load="YES" -.Ed -.Sh DESCRIPTION -This module is used by all ATM drivers for cards that use -PMC-Sierra S/Uni and IDT77105/IDT77155 -chips to provide uniform functionality. -The module implements status monitoring -in either interrupt or polling mode, media option handling and application -access to chip registers. -.Pp -The driver implements several sysctls that are accessible under the -.Va hw.atm. Ns Ao Ar iface Ac Ns Va .\& -tree, where -.Ar iface -is the name of the ATM interface: -.Bl -tag -width indent -.It Va phy_regs -When reading this sysctl an array of 8-bit unsigned integers is returned -containing all accessible chip registers starting at register 0. -A register can be written by writing three 8-bit unsigned integers to the -sysctl: the register number, the new value and a bit mask. -This changes all bits in the register for which the corresponding bit in the -mask is one to the bit values from value. -Note that not all registers may -be writeable. -.It Va phy_loopback -allows to put the interface in one of several loopback modes. -Not all modes and all combinations of modes are supported on all chips. -The possible modes are: -.Bl -tag -width indent -.It Dv UTP_LOOP_NONE Pq No 0x00 -No loopback, normal operation. -.It Dv UTP_LOOP_TIME Pq No 0x01 -Timing source loopback. -When this is set the transmitter's clock is -derived from the receiver's clock. -.It Dv UTP_LOOP_DIAG Pq No 0x02 -Diagnostic loopback. -In this mode the receiver's input is connected to the -transmitter's output. -The receiver gets back everything that is sent. -The -transmitter operates normally. -.It Dv UTP_LOOP_LINE Pq No 0x04 -Serial line loopback. -This connects the line receiver to the line transmitter. -The chip transmits all cells back that it receives. -The receiver operates -normally. -.It Dv UTP_LOOP_PARAL Pq No 0x08 -Parallel diagnostic loopback. -This feeds back all transmitted cells into the -receiver between the parallel/serial converters. -The transmitter -operates normally. -.It Dv UTP_LOOP_TWIST Pq No 0x10 -Twisted pair diagnostic loopback. -Connects the high speed receive data to the -high speed transmit data. -All received data is sent back. -The receiver -operates normally. -.It Dv UTP_LOOP_PATH Pq No 0x20 -Diagnostic path loopback. -This connects the receiver input to the transmitter -output just between the path overhead processor and the byte mux. -The -transmitter operates normally. -.El -.It Va phy_type -This is the detected type of the phy chip. -Currently the following chips are -supported: -.Bl -tag -width indent -.It Dv UTP_TYPE_UNKNOWN Pq No 0 -The module could not determine the type of the PHY chip. -.It Dv UTP_TYPE_SUNI_LITE Pq No 1 -PMC-5346 (S/Uni-Lite) -.It Dv UTP_TYPE_SUNI_ULTRA Pq No 2 -PMC-5350 (S/Uni-Ultra) -.It Dv UTP_TYPE_SUNI_622 Pq No 3 -PMC-5355 (S/Uni-622) -.It Dv UTP_TYPE_IDT77105 Pq No 4 -IDT77105 (25.6MBit UTP interface) -.It Dv UTP_TYPE_IDT77155 Pq No 5 -IDT77155 (155MBit interface) -.El -.It Va phy_name -This is a string describing the type of the PHY chip. -.It Va phy_stats -Physical and some ATM layer statistics. -These are the statistics usually -provided by the chip. -The data is a returned in the following structure: -.Bd -literal -struct utopia_stats1 { - uint32_t version; /* version of this struct */ - uint32_t fill; - uint64_t rx_sbip; /* rx section BIP errors */ - uint64_t rx_lbip; /* rx line BIP errors */ - uint64_t rx_lfebe; /* rx line far end block errors */ - uint64_t rx_pbip; /* rx path BIP errors */ - uint64_t rx_pfebe; /* rx path far end block errors */ - uint64_t rx_cells; /* received cells */ - uint64_t rx_corr; /* correctable cell errors */ - uint64_t rx_uncorr; /* uncorrectable cell errors */ - uint64_t rx_symerr; /* symbol errors */ - uint64_t tx_cells; /* transmitted cells */ -}; -.Ed -.Pp -The current version is 1. -The statistics are updated from the chip once -a second. -On overflow the counters wrap to zero. -Note that not all counters -are meaningful for all PHY chips. -The statistics are cleared by writing an -arbitrary new value (the value is ignored). -.El -.Pp -The -.Nm -module also interfaces with the ifmedia system. -The module reports the current state of the carrier and will issue a -warning message when the carrier state changes. -While the physical media itself cannot be changed, several media options can: -.Bl -tag -width indent -.It Cm SDH -If the PHY is a Sonet/SDH chip this flag switches the interface into SDH mode. -If this option is not set (the default) the interface is in Sonet mode. -.It Cm noscramb -If the PHY is a Sonet/SDH chip disable scrambling. -This may be useful for debugging purposes. -.It Cm unassigned -Normally the interface emits idle cells when there are no other cells to -transmit. -This changes the default cell type to unassigned cells. -This -may be needed for interworking with public networks. -.El -.Sh SEE ALSO -.Xr en 4 , -.Xr fatm 4 , -.Xr hatm 4 , -.Xr patm 4 , -.Xr utopia 9 -.Sh AUTHORS -.An Harti Brandt Aq Mt harti@FreeBSD.org diff --git a/share/man/man4/uvisor.4 b/share/man/man4/uvisor.4 index 254e9b5b2d9d..368f218626b8 100644 --- a/share/man/man4/uvisor.4 +++ b/share/man/man4/uvisor.4 @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 20, 2011 +.Dd April 26, 2017 .Dt UVISOR 4 .Os .Sh NAME @@ -118,6 +118,20 @@ Sony Clie S360 .It Sony Clie TJ37 .El +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices +.El .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , diff --git a/share/man/man4/uvscom.4 b/share/man/man4/uvscom.4 index fb8ada7aa26d..119d6c41e440 100644 --- a/share/man/man4/uvscom.4 +++ b/share/man/man4/uvscom.4 @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 20, 2011 +.Dd April 26, 2017 .Dt UVSCOM 4 .Os .Sh NAME @@ -77,6 +77,19 @@ The device is accessed through the .Xr ucom 4 driver which makes it behave like a .Xr tty 4 . +.Sh FILES +.Bl -tag -width "/dev/ttyU?.init" -compact +.It Pa /dev/ttyU? +for callin ports +.It Pa /dev/ttyU?.init +.It Pa /dev/ttyU?.lock +corresponding callin initial-state and lock-state devices +.Pp +.It Pa /dev/cuaU? +for callout ports +.It Pa /dev/cuaU?.init +.It Pa /dev/cuaU?.lock +corresponding callout initial-state and lock-state devices .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , |