diff options
author | trhodes <trhodes@FreeBSD.org> | 2004-06-21 18:20:57 +0000 |
---|---|---|
committer | trhodes <trhodes@FreeBSD.org> | 2004-06-21 18:20:57 +0000 |
commit | e3d9f92298abd334138ae1dee7148bd5932f0025 (patch) | |
tree | c82fd259e3752317cf739e4e5abd4293a6dd8a90 /share | |
parent | e4dd46f82f856630a7a2cd642b28d84333657460 (diff) | |
download | FreeBSD-src-e3d9f92298abd334138ae1dee7148bd5932f0025.zip FreeBSD-src-e3d9f92298abd334138ae1dee7148bd5932f0025.tar.gz |
Add manual pages for cm(4), esp(4), rc(4) and snc(4).
Diffstat (limited to 'share')
-rw-r--r-- | share/man/man4/Makefile | 4 | ||||
-rw-r--r-- | share/man/man4/cm.4 | 150 | ||||
-rw-r--r-- | share/man/man4/esp.4 | 173 | ||||
-rw-r--r-- | share/man/man4/rc.4 | 124 | ||||
-rw-r--r-- | share/man/man4/snc.4 | 144 |
5 files changed, 595 insertions, 0 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 2a34340..65507da 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -38,6 +38,7 @@ MAN= aac.4 \ cd.4 \ ch.4 \ ciss.4 \ + cm.4 \ crypto.4 \ csa.4 \ cue.4 \ @@ -59,6 +60,7 @@ MAN= aac.4 \ ehci.4 \ em.4 \ en.4 \ + esp.4 \ exca.4 \ faith.4 \ fast_ipsec.4 \ @@ -225,6 +227,7 @@ MAN= aac.4 \ pty.4 \ puc.4 \ random.4 \ + rc.4 \ re.4 \ rl.4 \ rndtest.4 \ @@ -253,6 +256,7 @@ MAN= aac.4 \ smbus.4 \ smp.4 \ sn.4 \ + snc.4 \ snp.4 \ spic.4 \ splash.4 \ diff --git a/share/man/man4/cm.4 b/share/man/man4/cm.4 new file mode 100644 index 0000000..a338617 --- /dev/null +++ b/share/man/man4/cm.4 @@ -0,0 +1,150 @@ +.\" +.\" Copyright (c) 2004 Tom Rhodes +.\" 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. +.\" +.\" $FreeBSD$ +.\" +.Dd June 21, 2004 +.Dt CM 4 +.Os +.Sh NAME +.Nm cm +.Nd SMC Arcnet Ethernet device driver +.Sh SYNOPSIS +.Cd device isa +.Cd device cm +.Sh DESCRIPTION +The +.Nm +driver provides support for the +.Tn Arcnet +.Tn ISA +network adapters. +This driver supports the following card models: +.Pp +.Bl -item -compact +.It +SMC90c26 +.It +SMC90c56 +.It +SMC90c66 in '56 compatibility mode. +.El +.Pp +The +.Nm +driver also has quirks preset in the +.Xr device.hints 5 +file for card detection. +.Sh IMPLEMENTATION NOTES +When the +.Va NOARP +flag is set on the +.Nm +interface, +it does not employ the address resolution protocol described in +.Xr arp 4 +to dynamically map between Internet and Ethernet addresses on +the local network. +Instead it uses the least significant 8 bits of the +.Tn IP +address as the hardware address +like described in +.Tn RFC +1051 +and +.Tn RFC +1201. +.Pp +With the +.Dv IFF_LINK0 +flag cleared +.Tn IP/ARP/RARP +encoding is done according to +.Tn RFC +1201 +that is, with Packet Header Definition Standard header and packet type +212 / 213. +The +.Tn MTU +is normally 1500. +The +.Dv IFF_LINK0 +flag is cleared by default. +.Pp +With the +.Dv IFF_LINK0 +flag set, +.Tn IP +and +.Tn ARP +encoding is done according to the deprecated +.Tn RFC +1051 encoding, that is with simple header, packet type 240 / 241, +and the +.Tn MTU +is 507. +.Pp +When switching between the two modes, use +.Dl ifconfig interfacename down up +to switch the +.Tn MTU . +.Sh ERRORS +The following driver specific error messages +may be reported: +.Bl -tag -width Er +.It Bq Er ENOENT +May be returned if the device cannot allocate a port, +memory resource, or IRQ with the given resource ID. +.It Bq Er EINVAL +May be returned if the device is marked as down and is +still running. +This error may also be returned if the device is marked as up +but is not running. +.El +.Sh SEE ALSO +.Xr netintro 4 , +.Xr watchdog 4 , +.Xr device.hints 5 , +.Xr ifconfig 8 , +.Xr watchdog 8 +.Sh HISTORY +The +.Nm +device was ported from +.Nx +by +.An Max Khon Aq fjoe@FreeBSD.org +and first appeared in +.Fx 4.6 . +This manual page first appeared in +.Fx 5.3 . +.Sh AUTHORS +This manual page was written by +.An Tom Rhodes Aq trhodes@FreeBSD.org . +.Sh BUGS +The +.Nm +driver code could do with a bit of improvement, +it would be nice if some one could come along and take care of this. diff --git a/share/man/man4/esp.4 b/share/man/man4/esp.4 new file mode 100644 index 0000000..78d5a35 --- /dev/null +++ b/share/man/man4/esp.4 @@ -0,0 +1,173 @@ +.\" +.\" Copyright (c) 2004 Tom Rhodes +.\" 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. +.\" +.\" $FreeBSD$ +.\" +.Dd June 21, 2004 +.Dt ESP 4 +.Os +.Sh NAME +.Nm esp +.Nd Qlogic FEPS and FAS366 SCSI driver +.Sh SYNOPSIS +.Cd device scbus +.Cd device esp +.Sh DESCRIPTION +The +.Nm +driver provides support for the +.Tn Qlogic +FAS216 and FAS408 +.Tn SCSI +controller chips found in a wide variety of systems and peripheral boards. +This includes the +.Tn Qlogic +.Tn SCSI +cards found in most +.Tn Sun +.Tn Ultra 1e +and +.Tn Ultra 2 +machines. +.Pp +For +.Tn Qlogic +.Tn PCI +.Tn SCSI +host adapters, the +.Xr isp 4 +driver should be used in place of the +.Nm +driver. +.Sh IMPLEMENTATION NOTES +During the boot sequence, the +.Nm +driver +searches the linked list for LUN info by LUN ID. +At this point the driver will attach on that instance, +and then attempt to attach every sub-device. +.Pp +There are at least 4 variations of the +configuration 3 register. +A second config register must be loaded to inquire the chip revision, +otherwise the +.Fn ncr53c9x_reset +function will not set the defaults correctly. +.Pp +The drive attach routine attempts to set the appropriate +bit to put the chip into Fast +.Tn SCSI +mode so that it does not +have to be figured out each time. +This will then be stored in the +.Tn NCR +registers for later use. +.Pp +The +.Nm +driver makes use of the +.Tn LSI +64854 +.Tn DMA +engine which contains three independent +channels designed to interface with +an NCR539X +.Tn SCSI +controller; +an AM7990 Ethernet controller; +and certain types of parallel port hardware. +As such this driver may eventually replace the +.Xr amd 4 +driver for network hardware. +.Pp +.Sh ERRORS +The following driver specific error messages +may be reported: +.Bl -tag -width Er +.It Bq Er EINVAL +May be returned if the driver cannot detach or reset +the state and/or bus. +.It Bq Er ENOMEM +Might be returned if the driver cannot allocate +parent +.Tn DMA +tag, or if the device is out of memory. +.It Bq Er ENXIO +May be returned if the driver cannot map +.Tn DMA +registers. +This error may also be returned if the driver is +unable to map the +.Tn SCSI +core registers. +.El +.Sh SEE ALSO +.Xr amd 4 , +.Xr isp 4 , +.Xr scbus 4 , +.Xr camcontrol 8 +.Pp +.Pa http://www.qlc.com/ +.br +.Pa http://www.sun.com/ +.Sh HISTORY +The +.Nm +driver was written for +.Nx +by +.An Eric S. Hvozda. +The +.Nm +driver was then ported to +.Fx 5.3 +by +.An Scott Long Aq scottl@FreeBSD.org . +.Sh AUTHORS +This manual page was written by +.An Tom Rhodes Aq trhodes@FreeBSD.org +instead of porting the original from +.Nx . +.Sh BUGS +The +.Nm +driver includes the sbus front-end but lacks the +.Tn PCI +front-end. +Thus it can only support the +.Tn FEPS/FAS366 +.Tn SCSI +found in +.Tn Sun +.Tn Ultra 1e +and +.Tn Ultra 2 +machines at this time. +.Pp +This driver should eventually replace the +.Xr amd 4 +driver, but that requires porting the +.Tn PCI +front-end mentioned above. diff --git a/share/man/man4/rc.4 b/share/man/man4/rc.4 new file mode 100644 index 0000000..39f40ad --- /dev/null +++ b/share/man/man4/rc.4 @@ -0,0 +1,124 @@ +.\" +.\" Copyright (c) 2004 Tom Rhodes +.\" 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. +.\" +.\" $FreeBSD$ +.\" +.Dd June 21, 2004 +.Dt RC 4 +.Os +.Sh NAME +.Nm rc +.Nd RISCom/8 multiport card +.Sh SYNOPSIS +.Cd device isa +.Cd device rc +.Sh DESCRIPTION +The +.Nm +driver provides support for the +.Tn SDL +Communications +.Tn Riscom/8 +boards. +The +.Tn RISCom/8 +is an eight port +.Tn ISA +.Tn RS-232C +communications multiplexor with a built in +.Tn RISC +processor. +It uses a block of sixteen +.Tn I/O +ports in the range 0x200 to 0x3f0 selectable by on-board +switches or jumpers. +The block must be aligned on a sixteen port boundary. +The jumper-selectable hardware interrupt level may be set to +be detected during system +initialization using settings found in the +.Pa /boot/device.hints +file. +.Pp +This driver is mostly based on Cirrus Logic CL-CD180 driver. +.Sh ERRORS +The following driver specific error messages +may be reported: +.Bl -tag -width Er +.It Bq Er EBUSY +May be returned if the device was busy when a +request to access its resources was made by +.Nm +and was denied. +.It Bq Er ENOMEM +May be returned if the +.Nm +driver was unable to obtain the +.Tn IOBASE +addresses. +.It Bq Er ENXIO +May be returned if the device cannot obtain a valid +.Tn IO +port through +.Fn isa_get_port . +This error may also be returned if the +.Fn isa_get_irq +function cannot obtain a valid +.Tn IRQ . +.El +.Sh SEE ALSO +.Xr tty 1 , +.Xr ttyname 3 , +.Xr tty 4 , +.Xr sio 4 , +.Xr device.hints 5 , +.Xr comcontrol 8 , +.Xr getty 8 , +.Xr mutex 9 , +.Xr splx 9 +.Pp +.Pa http://www.sdlcomm.com +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 2.0.5 . +This manual page first appeared in +.Fx 5.3 . +.Sh AUTHORS +This manual page was written by +.An Tom Rhodes Aq trhodes@FreeBSD.org . +.Sh BUGS +The +.Nm +driver code still uses the +.Fn splx +functions. +These should be replaced by +.Xr mutex 9 +functions. +.Pp +The various +.Fn ttyld_* +functions should be documented. diff --git a/share/man/man4/snc.4 b/share/man/man4/snc.4 new file mode 100644 index 0000000..afb8906 --- /dev/null +++ b/share/man/man4/snc.4 @@ -0,0 +1,144 @@ +.\" +.\" Copyright (c) 2004 Tom Rhodes +.\" 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. +.\" +.\" $FreeBSD$ +.\" +.Dd June 21, 2004 +.Dt SNC 4 +.Os +.Sh NAME +.Nm snc +.Nd National Semiconductor DP8393X SONIC Ethernet adapter driver +.Sh SYNOPSIS +.Cd device isa +.Cd device snc +.Sh DESCRIPTION +The +.Nm +driver provides support for the +.Tn National +.Tn Semiconductor +.Tn SONIC +Ethernet adapters. +This currently supports the following card models: +.Pp +.Bl -item -compact +.It +National Semiconductor DP83934AVQB +.It +NEC PC-9801N-15 +.It +NEC PC-9801-84 +.It +NEC PC-9801-83 +.It +NEC PC-9801-104 +.It +NEC PC-9801-103 +.It +NEC PC-9801N-J02R PCMCIA +.It +NEC PC-9801N-J02 PCMCIA +.El +.Pp +The +.Nm +driver also includes support for the +.Tn National +.Tn Semiconductor +.Tn NS46C46 +as +64 * 16 bits Microwave Serial +.Tn EEPROM . +.Sh IMPLEMENTATION NOTES +Accessing +.Tn SONIC +card data structures and registers as 32 bit values +makes code endianess independent. +The +.Tn SONIC +is; however always in bigendian mode so it is necessary to +ensure that data structures shared +between the +.Tn CPU +and the +.Tn SONIC +card are always in bigendian order. +The +.Nm +driver supports the +.Tn PC-98 +C-Bus, +and +.Tn PnP +buses. +Support is also provided for legacy C-Bus. +.Sh ERRORS +The following driver specific error messages +may be reported: +.Bl -tag -width Er +.It Bq Er EIO +May be returned if the device cannot allocate a port, +memory resource, or +.Tn IRQ +with the given resource ID. +.It Bq Er ENOENT +May be returned if the driver cannot assign memory, a port or an +.Tn IRQ +to the board. +.It Bq Er ENXIO +May be returned if the card supplied a +.Tn PnP +ID which did not match any of the known IDs. +.El +.Sh SEE ALSO +.Xr card 4 , +.Xr netintro 4 , +.Xr bus_alloc_resource_any 9 +.Sh HISTORY +The +.Nm +driver was ported from +.Nx +by +.An -nosplit +.An Motomichi Matsuzaki Aq mzaki@e-mail.ne.jp +and +.An Hiroshi Yamashita Aq bluemoon@msj.biglobe.ne.jp . +It first appeared in +.Fx 4.2 . +This manual page first appeared in +.Fx 5.3 . +.Sh AUTHORS +This manual page was written by +.An Tom Rhodes Aq trhodes@FreeBSD.org . +.Sh BUGS +Currently the +.Nm +driver only works on the +.Tn PC-98 +architecture. +It should probably work on the i386 architecture +as well. |