diff options
| author | cvs2svn <cvs2svn@FreeBSD.org> | 1999-01-21 00:55:32 +0000 |
|---|---|---|
| committer | cvs2svn <cvs2svn@FreeBSD.org> | 1999-01-21 00:55:32 +0000 |
| commit | 76b5366091f76c9bc73570149ef5055648fc2c39 (patch) | |
| tree | 590d020e0f2a5bea6e09d66d951a674443b21d67 /share/man | |
| parent | 4b4d01da6f07f7754ff6a6e4f5223e9f0984d1a6 (diff) | |
Notes
Diffstat (limited to 'share/man')
90 files changed, 771 insertions, 4856 deletions
diff --git a/share/man/man1/Makefile b/share/man/man1/Makefile index f1ed384cd840e..6084116648e26 100644 --- a/share/man/man1/Makefile +++ b/share/man/man1/Makefile @@ -1,7 +1,8 @@ # @(#)Makefile 8.1 (Berkeley) 6/5/93 -# $Id: Makefile,v 1.6 1998/12/20 06:27:00 bde Exp $ +# $Id: Makefile,v 1.3 1997/03/07 03:27:49 jmg Exp $ MAN1= cd.1 intro.1 wait.1 MLINKS= intro.1 introduction.1 .include <bsd.prog.mk> + diff --git a/share/man/man1/intro.1 b/share/man/man1/intro.1 index 93a5b086aaac0..cbb1fdb745dc6 100644 --- a/share/man/man1/intro.1 +++ b/share/man/man1/intro.1 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" @(#)intro.1 8.2 (Berkeley) 12/30/93 -.\" $Id: intro.1,v 1.11 1998/12/19 09:33:03 dillon Exp $ +.\" $Id: intro.1,v 1.9 1997/04/22 05:52:54 jmg Exp $ .\" .Dd December 30, 1993 .Dt INTRO 1 @@ -61,7 +61,6 @@ completion of the command. .Sh SEE ALSO .Xr apropos 1 , .Xr man 1 , -.Xr security 1 , .Xr intro 2 , .Xr intro 3 , .Xr intro 4 , diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 28ffe9e810c33..888dfcbfa25e9 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,15 +1,12 @@ # @(#)Makefile 8.1 (Berkeley) 6/18/93 -MAN4= bpf.4 bridge.4 ccd.4 cd.4 ch.4 da.4 ddb.4 divert.4 drum.4 \ - dummynet.4 fd.4 fpa.4 \ - icmp.4 ifmib.4 iic.4 iicbb.4 iicbus.4 iicsmb.4 \ - imm.4 inet.4 intro.4 ip.4 ipfirewall.4 \ - lkm.4 lo.4 lpbb.4 natm.4 netintro.4 \ - null.4 od.4 pass.4 plip.4 ppbus.4 ppi.4 ppp.4 pt.4 pty.4 \ - route.4 sa.4 scsi.4 \ - sd.4 sl.4 smb.4 smbus.4 smp.4 snp.4 sppp.4 ssc.4 st.4 su.4 tcp.4 \ +MAN4= bpf.4 ccd.4 cd.4 ch.4 da.4 ddb.4 divert.4 drum.4 fd.4 fpa.4 \ + icmp.4 ifmib.4 inet.4 intro.4 ip.4 ipfirewall.4 \ + lkm.4 lo.4 natm.4 netintro.4 \ + null.4 od.4 pass.4 ppi.4 ppp.4 pt.4 pty.4 route.4 sa.4 \ + scsi.4 sd.4 sl.4 smp.4 snp.4 sppp.4 ssc.4 st.4 su.4 tcp.4 \ ttcp.4 termios.4 tty.4 tun.4 udp.4 uk.4 update.4 unix.4 vinum.4 vn.4 \ - vpo.4 worm.4 wst.4 xpt.4 yp.4 zero.4 + worm.4 wst.4 xpt.4 yp.4 zero.4 MLINKS+=fd.4 stderr.4 fd.4 stdin.4 fd.4 stdout.4 MLINKS+=netintro.4 networking.4 diff --git a/share/man/man4/bpf.4 b/share/man/man4/bpf.4 index 22b4aeb5586cc..c70ec943ebc24 100644 --- a/share/man/man4/bpf.4 +++ b/share/man/man4/bpf.4 @@ -20,7 +20,7 @@ .\" This document is derived in part from the enet man page (enet.4) .\" distributed with 4.3BSD Unix. .\" -.\" $Id: bpf.4,v 1.15 1998/11/03 22:01:21 des Exp $ +.\" $Id: bpf.4,v 1.12 1998/03/12 07:30:16 charnier Exp $ .\" .Dd January 16, 1996 .Dt BPF 4 @@ -170,7 +170,7 @@ and resets the statistics that are returned by BIOCGSTATS. .It Dv BIOCGETIF .Pq Li "struct ifreq" Returns the name of the hardware interface that the file is listening on. -The name is returned in the ifr_name field of +The name is returned in the if_name field of the .Li ifreq structure. @@ -180,7 +180,7 @@ All other fields are undefined. Sets the hardware interface associate with the file. This command must be performed before any packets can be read. The device is indicated by name using the -.Li ifr_name +.Li if_name field of the .Li ifreq structure. diff --git a/share/man/man4/bridge.4 b/share/man/man4/bridge.4 deleted file mode 100644 index 5482c0e1f00e3..0000000000000 --- a/share/man/man4/bridge.4 +++ /dev/null @@ -1,65 +0,0 @@ -.\" -.\" $Id$ -.\" -.Dd Sep 28, 1998 -.Dt BRIDGE 4 -.Os -.Sh NAME -.Nm bridge -.Nd Bridging support -.Sh DESCRIPTION -Starting from version 2.2.8, FreeBSD supports bridging on ethernet-type -interfaces. This is achieved using the following option -.Bd -literal - options BRIDGE -.Ed - -in the kernel config file, and is controlled by two -.Nm sysctl -variables: -.Bd -literal - net.link.ether.bridge -.Ed - -Set to 1 to enable bridging, set to 0 to disable it -.Bd -literal - net.link.ether.bridge_ipfw -.Ed - -Set to 1 to enable -.Nm ipfw -filtering on bridged packets. Note that -.Nm ipfw -rules only apply -to IP packets. Non-IP packets are subject to the default -.Nm ipfw -rule (number 65535) which must be an -.Ar allow -rule if we want ARP and other non-IP packets to flow through the -bridge. - - -.Sh BUGS -.Pp -Care must be taken not to construct loops in the bridge topology. -The kernel supports only a primitive form of loop detection, by disabling -some interfaces when a loop is detected. No support for a daemon running the -spanning tree algorithm is currently provided. -.Pp -With bridging active, interfaces are in promiscuous mode, -thus causing some load on the system to receive and filter -out undesired traffic. -.Pp -Extended functionality to enable bridging selectively on clusters -of interfaces is still in the works. -.Pp -Not all interface support bridging -- at the moment it works for -``ed'', ``de'', ``ep'', ``fxp'', ``lnc'' interfaces. -.Sh SEE ALSO -.Xr ip 4 , -.Xr ipfw 8 , -.Xr sysctl 8 . -.Sh HISTORY -.Nm -bridging has been introduced in FreeBSD 2.2.8 -by Luigi Rizzo <luigi@iet.unipi.it>. diff --git a/share/man/man4/dummynet.4 b/share/man/man4/dummynet.4 deleted file mode 100644 index caefdefe035e4..0000000000000 --- a/share/man/man4/dummynet.4 +++ /dev/null @@ -1,182 +0,0 @@ -.\" -.\" $Id$ -.\" -.Dd Sep 28, 1998 -.Dt DUMMYNET 4 -.Os -.Sh NAME -.Nm dummynet -.Nd Flexible bandwidth manager and delay emulator -.Sh SYNOPSIS -.Fd #include <sys/types.h> -.Fd #include <sys/queue.h> -.Fd #include <netinet/in.h> -.Fd #include <netinet/ip_fw.h> -.Ft int -.Fn setsockopt raw_socket IPPROTO_IP "ipfw option" "struct ipfw" size -.Sh DESCRIPTION -dummynet is a system facility that permits the control of traffic -going through the various network interfaces, by applying bandwidth -and queue size limitations, and simulating delays and losses. -.Pp -In its current implementation, -packet selection is done with the -.Nm ipfw -program, by means of -.Nm ``pipe'' -rules. -A dummynet -.Nm pipe -is characterized by a bandwidth, delay, queue size, and loss -rate, which can be configured with the -.Nm ipfw -program. Pipes are -numbered from 1 to 65534, and packets can be passed through multiple -pipes depending on the ipfw configuration. -.Pp -Dummynet operates at the ip level, but if bridging extensions are -enabled, it is possible to pass bridged packets through pipes as well. -.Sh USAGE -Packets are sent to a pipe using the command -.Bd -literal - ipfw add pipe NNN .... -.Ed - -and pipes are configured as follows: -.Bd -literal - ipfw pipe NNN config bw B delay D queue Q plr P -.Ed - -where the bandwidth B can be expressed in bit/s, Kbit/s, Mbit/s, -Bytes/s, KBytes/s, MBytes/s , delay in milliseconds, queue size in -packets or Bytes, plr is the fraction of packets randomly dropped. -.Pp -Getting ipfw to work right is not very intuitive, especially when -the system is acting as a router or a bridge. -.Pp -When acting as a router, the same ruleset is applied on both the -input and the output path for routed packets, so you have to make -sure that a packet does not go through the same pipe twice (unless -this is what you really want). -.Pp -When acting as a bridge, the -.Nm ipfw -filter is invoked only once, in the input path, -for bridged packets. -.Pp -Also, when simulating true full-duplex channels, be sure to pass -traffic through two different pipes, depending on the direction. -E.g. a suitable rule set for simulating an asymmetric bidirectional -link would be the following: -.Bd -literal - ipfw add pipe 1 ip from A to B out - ipfw add pipe 2 ip from B to A in - ipfw pipe 1 config bw 1Mbit/s delay 80ms - ipfw pipe 2 config bw 128Kbit/s delay 300ms -.Ed - -.Pp -.Sh OPERATION -The -.Nm ipfw -code is used to select packets that must be subject to -bandwidth/queue/delay/losses, and returns the identifier of -the ``pipe'' describing such limitations. -.Pp -Selected packets are first queued in a bounded size queue, from which -they are extracted at the programmed rate and passed to a second queue -where delay is simulated. At the output from the second queue packets -are reinjected into the protocol stack at the same point they came -from (i.e. ip_input(), ip_output(), bdg_forward() ). -Depending on the setting of the sysctl variable - sys.net.inet.ipfw.one_pass -Packets coming from a pipe can be either forwarded to their -destination, or passed again through the -.Nm ipfw -rules, starting from the one after the matching rule. -.Pp -.Nm dummynet -performs its task once per timer tick. The granularity of operation is -thus controlled by the kernel option -.Bd -literal - options HZ -.Ed - -whose default value (100) means a granularity of 10ms. -For an accurate simulation of high data rates it might be necessary to -reduce the timer granularity to 1ms or less. Consider, however, -that some interfaces using programmed I/O may require a considerable -time to output packets. So, reducing the granularity too much might -actually cause ticks to be missed thus reducing the accuracy of -operation. - -.Sh KERNEL OPTIONS -The following options in the kernel configuration file are related -to -.Nm dummynet -operation: -.Bd -literal - IPFIREWALL - enable ipfirewall (required for dummynet). - IPFIREWALL_VERBOSE - enable firewall output. - IPFIREWALL_VERBOSE_LIMIT - limit firewall output. - DUMMYNET - enable dummynet operation. - NMBCLUSTER - set the amount of network packet buffers - HZ - sets the timer granularity -.Ed -.Pp -Generally, the following options are required: -.Bd -literal - options IPFIREWALL - options DUMMYNET -.Ed - -additionally, one may want to increase the number -of mbuf clusters (used to store network packets) according to the -sum of the bandwidth-delay products and queue sizes of all configured -pipes. - - -.Sh SYSCTL VARIABLES -.Pp -.Bd -literal - net.inet.ip.fw.one_pass -.Ed - -is set to 1 if we want packets to pass through the firewall code only -once. -.Bd -literal - net.link.ether.bridge_ipfw -.Ed - -is set if we want bridged packets to pass through the firewall code. - -.Sh COMMANDS -The following socket options are used to manage pipes: -.Pp -IP_DUMMYNET_CONFIGURE updates a pipe configuration (or creates a -new one. -.Pp -IP_DUMMYNET_DEL deletes all pipes having the matching rule number. -.Pp -IP_DUMMYNET_GET returns the pipes matching the number. -.Pp -IP_FW_FLUSH flushes the pipes matching the number. -.Pp -When the kernel security level is greater than 2, only IP_DUMMYNET_GET -is allowed. -.Sh SEE ALSO -.Xr setsockopt 2 , -.Xr ip 4 , -.Xr ipfw 8 , -.Xr sysctl 8 . -.Sh BUGS -This manpage is not illustrating all the possible ways to use -dummynet. -.Sh HISTORY -.Nm -dummynet -was initially implemented as a testing tool for TCP congestion control -by Luigi Rizzo <luigi@iet.unipi.it>, as described on ACM Computer -Communication Review, Jan.97 issue. Later it has been then modified -to work at the ip and bridging level, and integrated with the IPFW -packet filter. diff --git a/share/man/man4/iic.4 b/share/man/man4/iic.4 deleted file mode 100644 index 9e18d9abe64d3..0000000000000 --- a/share/man/man4/iic.4 +++ /dev/null @@ -1,63 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd October 25, 1998 -.Dt IIC 4 -.Os FreeBSD -.Sh NAME -.Nm iic -.Nd -I2C generic i/o device driver -.Sh SYNOPSIS -.Cd "device iic0 at iicbus?" -.Sh DESCRIPTION -The -.Em iic -character device driver provides generic i/o to any -.Xr iicbus 4 -instance. In order to control I2C devices, use /dev/iic? with the -following ioctls: -.Pp -.Bl -column "Ioctls" -compact -.It Em Ioctl Ta Em Description -.It Sy I2CSTART Ta "send start condition to the specified device (with 7-bit address) on the bus" -.It Sy I2CSTOP Ta "send stop condition to the bus" -.It Sy I2CRSTCARD Ta "reset the bus" -.El -.Pp -You may also use read/write routines, then I2C start/stop handshake is -managed by the iicbus system. -.Pp -.Sh SEE ALSO -.Xr iicbus 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/iicbb.4 b/share/man/man4/iicbb.4 deleted file mode 100644 index cbe5fb466d458..0000000000000 --- a/share/man/man4/iicbb.4 +++ /dev/null @@ -1,59 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd October 25, 1998 -.Dt IICBB 4 -.Os FreeBSD -.Sh NAME -.Nm iicbb -.Nd -I2C generic bit-banging driver -.Sh SYNOPSIS -.Cd "controller iicbb0" -.Pp -.Cd "device lpbb at ppbus?" -.Pp -For one or more iicbus busses: -.Cd "controller iicbus0" -.Sh DESCRIPTION -The -.Em iicbb -driver provides support to any bit-banging interface for the -.Xr iicbus 4 -system. -.Pp -.Sh SEE ALSO -.Xr iicbus 4 , -.Xr lpbb 4 , -.Xr ppbus 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/iicbus.4 b/share/man/man4/iicbus.4 deleted file mode 100644 index f45943a488d1b..0000000000000 --- a/share/man/man4/iicbus.4 +++ /dev/null @@ -1,108 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd August 6, 1998 -.Dt IICBUS 4 -.Os FreeBSD -.Sh NAME -.Nm iicbus -.Nd -I2C bus system -.Sh SYNOPSIS -.Cd "controller iicbus0" -.Cd "controller iicbb0" -.Pp -.Cd "device iic0 at iicbus?" -.Cd "device ic0 at iicbus?" -.Cd "device iicsmb0 at iicbus?" -.Sh DESCRIPTION -The -.Em iicbus -system provides a uniform, modular and architecture-independent -system for the implementation of drivers to control various I2C devices -and to utilize different I2C controllers. -.Sh I2C -I2C is an acronym for Inter Integrated Circuit bus. The I2C bus was developed -in the early 1980's by Philips semiconductors. It's purpose was to provide an -easy way to connect a CPU to peripheral chips in a TV-set. -.Pp -The BUS physically consists of 2 active wires and a ground connection. -The active wires, SDA and SCL, are both bidirectional. Where SDA is the -Serial DAta line and SCL is the Serial CLock line. - -Every component hooked up to the bus has its own unique address whether it -is a CPU, LCD driver, memory, or complex function chip. Each of these chips -can act as a receiver and/or transmitter depending on it's functionality. -Obviously an LCD driver is only a receiver, while a memory or I/O chip can -both be transmitter and receiver. Furthermore there may be one or -more BUS MASTER's. - -The BUS MASTER is the chip issuing the commands on the BUS. In the I2C protocol -specification it is stated that the IC that initiates a data transfer on the -bus is considered the BUS MASTER. At that time all the others are regarded to -as the BUS SLAVEs. As mentioned before, the IC bus is a Multi-MASTER BUS. -This means that more than one IC capable of initiating data transfer can be -connected to it. -.Sh DEVICES -Some I2C device drivers are available: -.Pp -.Bl -column "Device drivers" -compact -.It Em Devices Ta Em Description -.It Sy iic Ta "general i/o operation" -.It Sy ic Ta "network IP interface" -.It Sy iicsmb Ta "I2C to SMB software bridge" -.El -.Sh INTERFACES -The I2C protocol may be implemented by hardware or software. Software -interfaces rely on very simple hardware, usually two lines -twiddled by 2 registers. Hardware interfaces are more intelligent and receive -8-bit characters they write to the bus according to the I2C protocol. - -I2C interfaces may act on the bus as slave devices, allowing spontaneous -bidirectional communications, thanks to the mutli-master capabilities of the -I2C protocol. - -Some I2C interfaces are available: -.Pp -.Bl -column "Interface drivers" -compact -.It Em Interface Ta Em Description -.It Sy pcf Ta "Philips PCF8584 master/slave interface" -.It Sy iicbb Ta "generic bit-banging master-only driver" -.It Sy lpbb Ta "parallel port specific bit-banging interface" -.It Sy bktr Ta "Brooktree848 video chipset, hardware and software master-only interface" -.El -.Sh SEE ALSO -.Xr pcf 4 , -.Xr iicbb 4 , -.Xr lpbb 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/iicsmb.4 b/share/man/man4/iicsmb.4 deleted file mode 100644 index 0a1b92bb506cd..0000000000000 --- a/share/man/man4/iicsmb.4 +++ /dev/null @@ -1,57 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd August 10, 1998 -.Dt IICSMB 4 -.Os FreeBSD -.Sh NAME -.Nm iicsmb -.Nd -I2C to SMB bridge -.Sh SYNOPSIS -.Cd "device iicsmb0 at iicbus?" -.Pp -For one or more smbus busses: -.Cd "controller smbus0" -.Sh DESCRIPTION -The -.Em iicsmb -driver supports SMB commands over -.Xr iicbus 4 -for the -.Xr smbus 4 -system. -.Pp -.Sh SEE ALSO -.Xr smbus 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/imm.4 b/share/man/man4/imm.4 deleted file mode 100644 index cbc3070686772..0000000000000 --- a/share/man/man4/imm.4 +++ /dev/null @@ -1,59 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd October 27, 1998 -.Dt IMM 4 -.Os FreeBSD -.Sh NAME -.Nm imm -.Nd -Parallel to SCSI interface driver -.Sh SYNOPSIS -.Cd "controller vpo at ppbus?" -.Pp -For one or more SCSI busses: -.Cd "controller scbus0 at vpo0" -.Sh DESCRIPTION -The imm driver is an extension of the -.Xr vpo 4 -driver for the Iomega Matchmaker Parallel to SCSI interface. This driver -is mostly written with the -.Xr microseq 9 -mechanism. -.Sh SEE ALSO -.Xr ppbus 4 , -.Xr vpo 4 , -.Xr microseq 9 , -.Xr scsi 4 , -.Xr sd 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/intro.4 b/share/man/man4/intro.4 index e89d3c0b96765..cc44936ef1c3e 100644 --- a/share/man/man4/intro.4 +++ b/share/man/man4/intro.4 @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: intro.4,v 1.10 1998/03/12 07:30:17 charnier Exp $ +.\" $Id: intro.4,v 1.9 1997/09/29 10:10:14 wosch Exp $ .\" .Dd January 20, 1996 .Dt INTRO 4 @@ -112,9 +112,9 @@ implement a buffered device. For the latter group of devices, the differentiation is conventionally done by prepending the latter .Ql r to the path name of the device node, for example -.Pa /dev/rda0 +.Pa /dev/rsd0 denotes the raw device for the first SCSI disk, while -.Pa /dev/da0 +.Pa /dev/sd0 is the corresponding device node for the buffered device. .Pp Unbuffered devices should be used for all actions that are not related diff --git a/share/man/man4/lpbb.4 b/share/man/man4/lpbb.4 deleted file mode 100644 index 14033d9620975..0000000000000 --- a/share/man/man4/lpbb.4 +++ /dev/null @@ -1,79 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd October 25, 1998 -.Dt LPBB 4 -.Os FreeBSD -.Sh NAME -.Nm lpbb -.Nd -Parallel port I2C bit-banging interface -.Sh SYNOPSIS -.Cd "controller iicbus" -.Cd "controller iicbb0" -.Pp -.Cd "device lpbb0 at ppbus?" -.Cd "device iic0 at iicbus?" -.Sh DESCRIPTION -The -.Em lpbb -driver supports the Philips official I2C parallel bit-banging interface. -.Pp - - LS05 pin 14 (Vcc) o ------- - | | | - +--+--+---------------------+--+--+------------+------+-o 1 | - | | | | | | ===.1uF | +5V | - -------- [R][R][R] 3x10K 3x10K [R][R][R] LS05 | | | - | | | | | | | | pin 7 o-+------+-o 2 | - | 12 o-+--+ | | 3|\\ 4 | | | (Gnd) | GND | - | 17 o-+-----|--|----| >o-------------+--|--|--------------+ | | - | | | | |/ 8 /|9 | | 10 /|11 +----+-o 3 | - | 15 o-+-----+--|--------------o< |------+--|------o< |----+ | SCL | - | | | 1|\\ 2 \\| | \\| | | - | 9 o-+--------|----| >o-------------------+--------------+----+-o 4 | - | | | |/ 6 /|5 | | SDA | - | 11 o-+--------+----------------------------------o< |----+ ------- - | 10 o-+-+ \\| 4-pin - | 13 o-+-+--oGND Connector - | 25 o-+-+ ------------------ Part List -------------------------- - -------- | 1 - .1 uF capacitor | 6 - 10K 5% resistors | - 25-pin male D | 1 - 4-pin connector | 1 - 25-pin male D connector | - connector to PC | 1 - 74LS05 open collector hex inverter | - printer port ------------------------------------------------------- -.Pp -.Sh SEE ALSO -.Xr iicbus 4 , -.Xr iicbb 4 , -.Xr ppbus 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/man4.i386/Makefile b/share/man/man4/man4.i386/Makefile index 054976add2b7f..3950e7624fd82 100644 --- a/share/man/man4/man4.i386/Makefile +++ b/share/man/man4/man4.i386/Makefile @@ -1,25 +1,23 @@ -# $Id: Makefile,v 1.94 1999/01/09 18:12:06 wpaul Exp $ +# $Id: Makefile,v 1.80 1998/08/19 01:54:13 jkoshy Exp $ -MAN4= adv.4 adw.4 aha.4 ahb.4 ahc.4 aic.4 apm.4 ar.4 asc.4 ax.4 \ - bktr.4 bt.4 cs.4 cx.4 cy.4 de.4 \ - dgb.4 dpt.4 ed.4 el.4 en.4 ep.4 ex.4 fdc.4 fe.4 fxp.4 gsc.4 ie.4 \ - io.4 joy.4 keyboard.4 labpc.4 le.4 lnc.4 lp.4 lpt.4 matcd.4 mcd.4 \ - mem.4 meteor.4 mouse.4 mse.4 mtio.4 mx.4 ncr.4 npx.4 \ - pcf.4 pcm.4 pcvt.4 perfmon.4 pn.4 pnp.4 ppc.4 psm.4 \ - rdp.4 rl.4 sb.4 scd.4 screen.4 si.4 sio.4 \ - spkr.4 sr.4 sysmouse.4 tl.4 tw.4 tx.4 vr.4 vx.4 \ - wb.4 wd.4 wfd.4 wl.4 wt.4 xl.4 ze.4 zp.4 +MAN4= aha.4 ahb.4 ahc.4 aic.4 alog.4 apm.4 ar.4 asc.4 bktr.4 bt.4 \ + cs.4 cx.4 cy.4 de.4 \ + dgb.4 ed.4 eg.4 el.4 en.4 ep.4 ex.4 fdc.4 fe.4 fxp.4 gsc.4 ie.4 io.4 \ + joy.4 keyboard.4 labpc.4 le.4 lnc.4 lp.4 lpt.4 matcd.4 mcd.4 mem.4 \ + meteor.4 mouse.4 mse.4 mtio.4 nca.4 ncr.4 npx.4 \ + pcm.4 pcvt.4 perfmon.4 pnp.4 psm.4 \ + sb.4 scd.4 screen.4 sea.4 si.4 sio.4 \ + spkr.4 sr.4 sysmouse.4 tl.4 tw.4 tx.4 uha.4 vx.4 \ + wd.4 wfd.4 wl.4 wt.4 xl.4 ze.4 zp.4 -MLINKS= adv.4 ../adv.4 -MLINKS+= adw.4 ../adw.4 -MLINKS+= aha.4 ../aha.4 +MLINKS= aha.4 ../aha.4 MLINKS+= ahb.4 ../ahb.4 MLINKS+= ahc.4 ../ahc.4 MLINKS+= aic.4 ../aic.4 +MLINKS+= alog.4 ../alog.4 MLINKS+= apm.4 ../apm.4 MLINKS+= ar.4 ../ar.4 MLINKS+= asc.4 ../asc.4 -MLINKS+= ax.4 ../ax.4 MLINKS+= bktr.4 ../bktr.4 MLINKS+= bt.4 ../bt.4 MLINKS+= cs.4 ../cs.4 @@ -27,8 +25,8 @@ MLINKS+= cx.4 ../cx.4 MLINKS+= cy.4 ../cy.4 MLINKS+= de.4 ../de.4 MLINKS+= dgb.4 ../dgb.4 -MLINKS+= dpt.4 ../dpt.4 MLINKS+= ed.4 ../ed.4 +MLINKS+= eg.4 ../eg.4 MLINKS+= el.4 ../el.4 MLINKS+= en.4 ../en.4 MLINKS+= ep.4 ../ep.4 @@ -44,7 +42,7 @@ MLINKS+= keyboard.4 ../keyboard.4 MLINKS+= labpc.4 ../labpc.4 MLINKS+= le.4 ../le.4 MLINKS+= lnc.4 ../lnc.4 -MLINKS+= lp.4 ../lp.4 +MLINKS+= lp.4 ../lp.4 lp.4 plip.4 lp.4 ../plip.4 MLINKS+= lpt.4 ../lpt.4 MLINKS+= matcd.4 ../matcd.4 MLINKS+= mcd.4 ../mcd.4 @@ -53,22 +51,18 @@ MLINKS+= meteor.4 ../meteor.4 MLINKS+= mouse.4 ../mouse.4 MLINKS+= mse.4 ../mse.4 MLINKS+= mtio.4 ../mtio.4 -MLINKS+= mx.4 ../mx.4 +MLINKS+= nca.4 ../nca.4 MLINKS+= ncr.4 ../ncr.4 MLINKS+= npx.4 ../npx.4 -MLINKS+= pcf.4 ../pcf.4 MLINKS+= pcm.4 ../pcm.4 MLINKS+= pcvt.4 vt.4 pcvt.4 ../pcvt.4 pcvt.4 ../vt.4 MLINKS+= perfmon.4 ../perfmon.4 -MLINKS+= pn.4 ../pn.4 MLINKS+= pnp.4 ../pnp.4 -MLINKS+= ppc.4 ../ppc.4 MLINKS+= psm.4 ../psm.4 -MLINKS+= rdp.4 ../rdp.4 -MLINKS+= rl.4 ../rl.4 MLINKS+= sb.4 ../sb.4 MLINKS+= scd.4 ../scd.4 MLINKS+= screen.4 ../screen.4 +MLINKS+= sea.4 ../sea.4 MLINKS+= si.4 ../si.4 MLINKS+= sio.4 ../sio.4 MLINKS+= spkr.4 ../spkr.4 spkr.4 speaker.4 spkr.4 ../speaker.4 @@ -77,9 +71,8 @@ MLINKS+= sysmouse.4 ../sysmouse.4 MLINKS+= tl.4 ../tl.4 MLINKS+= tw.4 ../tw.4 MLINKS+= tx.4 ../tx.4 -MLINKS+= vr.4 ../vr.4 +MLINKS+= uha.4 ../uha.4 MLINKS+= vx.4 ../vx.4 -MLINKS+= wb.4 ../wb.4 MLINKS+= wd.4 ../wd.4 MLINKS+= wfd.4 ../wfd.4 MLINKS+= wl.4 ../wl.4 diff --git a/share/man/man4/man4.i386/adv.4 b/share/man/man4/man4.i386/adv.4 deleted file mode 100644 index 221976b49bc01..0000000000000 --- a/share/man/man4/man4.i386/adv.4 +++ /dev/null @@ -1,170 +0,0 @@ -.\" -.\" Copyright (c) 1998 -.\" Justin T. Gibbs. 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. The name of the author may not be used to endorse or promote products -.\" derived from this software withough specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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. -.\" -.\" $Id$ -.\" -.Dd October 16, 1998 -.Dt ADV 4 i386 -.Os FreeBSD -.Sh NAME -.Nm adv -.Nd Advansys ISA/VL/EISA/PCI 8bit SCSI Host adapter driver -.Sh SYNOPSIS -For one or more ISA or VL cards: -.Cd controller isa0 -.Cd controller "adv0 at isa? port ? cam irq ? drq ?" -.Pp -For one or more EISA cards: -.Cd controller eisa0 -.Cd controller adv0 -.Pp -For one or more PCI cards: -.Cd controller pci0 -.Cd controller adv0 -.Pp -For one or more SCSI busses: -.Cd controller scbus0 at adv0 -.Sh DESCRIPTION -This driver provides access to the 8bit -.Tn SCSI -bus connected to the Advanced Systems Products, Inc. -.Tn ASC900 , -.Tn ASC1000 , -.Tn ASC1090 , -.Tn ASC1200 , -.Tn ASC3050 , -and -.Tn ASC3150 -host adapter chips. -The following tables list the AdvanSys products using these chips, -their bus attachment type, maximum sync rate, and the maximum number of -commands that can be handled by the adapter concurrently. -.Pp -.Bd -filled -offset indent -.Bl -column "ABP510/5150 " "ISA PnP " "Yes " "10MHz " "Commands " Footnotes -Connectivity Products: -.Pp -.Em "Adapter Bus Floppy MaxSync Commands Footnotes" -ABP510/5150 ISA No 10MHz 240 1 -ABP5140 ISA PnP No 10MHz 16 1, 3 -ABP5142 ISA PnP Yes 10MHz 16 4 -ABP920 PCI No 10MHz 16 -ABP930 PCI No 10MHz 16 5 -ABP930U PCI No 20MHz 16 -ABP930UA PCI No 20MHz 16 -ABP960 PCI No 10MHz 16 2 -ABP960U PCI No 20MHz 16 2 -.El -.Pp -Footnotes: -.Bl -enum -compact -.It -This board has been shipped by HP with the 4020i CD-R drive. -The board has no BIOS so it cannot control a boot device, but -it can control any secondary SCSI device. -.It -This board has been sold by Iomega as a Jaz Jet PCI adapter. -.It -This board has been sold by SIIG as the i540 SpeedMaster. -.It -This board has been sold by SIIG as the i542 SpeedMaster. -.It -This board has been sold by SIIG as the Fast SCSI Pro PCI. -.El -.Ed -.Pp -.Bd -filled -offset indent -.Bl -column "ABP510/5150 " "ISA PnP " "Yes " "10MHz " Commands -Single Channel Products: -.Pp -.Em "Adapter Bus Floppy MaxSync Commands" -ABP542 ISA Yes 10MHz 240 -ABP742 EISA Yes 10MHz 240 -ABP842 VL Yes 10MHz 240 -ABP940 PCI No 10MHz 240 -ABP940U PCI No 20MHz 240 -ABP970 PCI No 10MHz 240 -ABP970U PCI No 20MHz 240 -.El -.Ed -.Pp -.Bd -filled -offset indent -.Bl -column "ABP510/5150 " "ISA PnP " "Yes " "10MHz " "Commands " "Channels " -Multi Channel Products (Commands are per-channel): -.Pp -.Em "Adapter Bus Floppy MaxSync Commands Channels" -ABP752 EISA Yes 10MHz 240 2 -ABP852 VL Yes 10MHz 240 2 -ABP950 PCI No 10MHz 240 2 -ABP980 PCI No 10MHz 240 4 -ABP980U PCI No 20MHz 240 4 -.El -.Ed -.Pp -For ISA or Vesa Local Bus adapters, one kernel config entry is required -for every card to be attached by the system. Specific values for the port -address, irq, and drq may be specified. If wildcard values are used, the -driver will query the device for its current settings and use those. If -the port address is a wildcard, the driver consults an internal table of -possible port address locations and attaches to the first unattached card -it finds. The possible port addresses for these card are 0x110, 0x130, -0x150, 0x190, 0x210, 0x230, 0x250, and 0x330. -.Pp -Per target configuration performed in the -.Tn AdvanceWare -menu, which is accessible at boot, -is honored by this driver. -This includes synchronous/asynchronous transfers, -maximum synchronous negotiation rate, disconnection, tagged queueing, -and the host adapter's SCSI ID. -The global setting for the maximum number of tagged transactions allowed -per target is not honored as the CAM SCSI system will automatically determine -the maximum number of tags a device can receive as well as guarantee fair -resource allocation among devices. -.Sh SEE ALSO -.Xr adw 4 , -.Xr aha 4 , -.Xr ahb 4 , -.Xr ahc 4 , -.Xr cd 4 , -.Xr da 4 , -.Xr sa 4 , -.Xr scsi 4 -.Sh AUTHORS -The -.Nm adv -driver was ported by -.An Justin T. Gibbs -from the Linux driver -written by -.An Bob Frey -of Advanced System Products, Inc. -Many thanks to AdvanSys for providing the original driver under a suitable -license for use in FreeBSD. -.Sh HISTORY -The -.Nm -driver appeared in -.Fx 3.0 . - - diff --git a/share/man/man4/man4.i386/adw.4 b/share/man/man4/man4.i386/adw.4 deleted file mode 100644 index 413274909d199..0000000000000 --- a/share/man/man4/man4.i386/adw.4 +++ /dev/null @@ -1,79 +0,0 @@ -.\" -.\" Copyright (c) 1998 -.\" Justin T. Gibbs. 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. The name of the author may not be used to endorse or promote products -.\" derived from this software withough specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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. -.\" -.\" $Id$ -.\" -.Dd October 16, 1998 -.Dt ADW 4 i386 -.Os FreeBSD -.Sh NAME -.Nm adw -.Nd Advansys PCI 16bit SCSI Host adapter driver -.Sh SYNOPSIS -.Cd controller pci0 -.Cd controller adw0 -.Pp -For one or more SCSI busses: -.Cd controller scbus0 at adw0 -.Sh DESCRIPTION -This driver provides access to the 16bit -.Tn SCSI -bus connected to the Advanced Systems Products, Inc. -.Tn ASC3550 -as found on the ABP940UW SCSI Host Adapter board. This chip -supports, Ultra SCSI (20MHz), 16bit transfers, tagged queueing, -and up to 253 concurrent SCSI transactions. -.Pp -Per target configuration performed in the -.Tn AdvanceWare -menu, which is accessible at boot, -is honored by this driver. -This includes synchronous/asynchronous transfers, -maximum synchronous negotiation rate, wide transfers, disconnection, -tagged queueing, and the host adapter's SCSI ID. -The global setting for the maximum number of tagged transactions allowed -per target is not honored as the CAM SCSI system will automatically determine -the maximum number of tags a device can receive as well as guarantee fair -resource allocation among devices. -.Sh SEE ALSO -.Xr adv 4 , -.Xr cd 4 , -.Xr scsi 4 , -.Xr da 4 , -.Xr sa 4 -.Sh AUTHORS -The -.Nm -driver was ported by -.An Justin T. Gibbs -from the Linux driver written by -.An Bob Frey -of Advanced System Products, Inc. Many thanks to AdvanSys for providing -the original driver under a suitable license for use in FreeBSD. -.Sh HISTORY -The -.Nm -driver appeared in -.Fx 3.0 . - - diff --git a/share/man/man4/man4.i386/ahc.4 b/share/man/man4/man4.i386/ahc.4 index 5ff9df86bbeaf..b786034749c1d 100644 --- a/share/man/man4/man4.i386/ahc.4 +++ b/share/man/man4/man4.i386/ahc.4 @@ -1,5 +1,5 @@ .\" -.\" Copyright (c) 1995, 1996, 1997, 1998 +.\" Copyright (c) 1995, 1996, 1997 .\" Justin T. Gibbs. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without @@ -24,9 +24,9 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: ahc.4,v 1.12 1998/06/13 19:06:49 steve Exp $ +.\" $Id: ahc.4,v 1.11 1998/06/08 06:11:58 jkoshy Exp $ .\" -.Dd October 15, 1998 +.Dd April 20, 1996 .Dt AHC 4 i386 .Os FreeBSD .Sh NAME @@ -41,6 +41,12 @@ For one or more PCI cards: .Cd controller pci0 .Cd controller ahc0 .Pp +To enable SCB paging: +.Cd options AHC_SCBPAGING_ENABLE +.Pp +To enable tagged queueing: +.Cd options AHC_TAGENABLE +.Pp To allow PCI adapters to use memory mapped I/O if enabled: .Cd options AHC_ALLOW_MEMIO .Pp @@ -49,49 +55,59 @@ For one or more SCSI busses: .Sh DESCRIPTION This driver provides access to the .Tn SCSI -bus(es) connected to Adaptec +bus(es) connected to Adaptec +274x, 284x, 2940, 3940, or controllers based on the .Tn AIC7770, .Tn AIC7850, .Tn AIC7860, .Tn AIC7870, -.Tn AIC7880, -.Tn AIC7890, -.Tn AIC7891, -.Tn AIC7895, -.Tn AIC7896, or -.Tn AIC7897 +.Tn AIC7880 host adapter chips. -These chips are found on many motherboards as well as the following -Adaptec SCSI controller cards: -.Tn 274X(W), -.Tn 274X(T), -.Tn 284X, -.Tn 2920C, -.Tn 2940, -.Tn 2940U, -.Tn 2940AU, -.Tn 2940UW, -.Tn 2940UW Dual, -.Tn 2940U2W, -.Tn 2940U2B, -.Tn 2950U2W, -.Tn 2950U2B, -.Tn 3940, -.Tn 3940U, -.Tn 3940AU, -.Tn 3940UW, -.Tn 3940AUW, -.Tn 3940U2W, -and -.Tn 3985. -.Pp -Driver features include support for twin and wide busses, -fast, ultra and ultra2 synchronous transfers depending on controller type, -tagged queueing, +Features include support for twin and wide busses, +ultra +.Tn SCSI, +two active commands at a time per non-tagged queueing target, +tagged queuing, and SCB paging. .Pp -Memory mapped I/O can be enabled for PCI devices with the +The number of concurrent transactions allowed is chip dependent +and ranges from 3 to 16. +On PCI adapters, +this number can be increased with the SCB paging option. +SCB paging implements an algorithm to 'page-out' transactions +that are in the disconnected state so that the freed space in +the controller's memory can be used to start additional transactions. +On the aic7880 and aic7870, +this increases the maximum number of outstanding transactions from 16 to 255. +On the aic7850 and aic7860 controllers, this maximum rises from 3 to 8. +During the hardware probe, +a diagnostic showing the ratio of hardware supported 'slots' to number +of transactions is printed. +SCB paging is enabled with the +.Dq Dv AHC_SCBPAGING_ENABLE +configuration option. +This option will likely be removed and become the default behavior for +adapters that support it, +in the near future. +.Pp +Tagged queueing is enabled with the +.Dq Dv AHC_TAGENABLE +configuration option. +Tagged queueing allows multiple transactions to be queued at the device +level instead of the host level, +allowing the device to re-order I/O to minimize seeks, +seek distance, +and to increase throughput. +Tagged queueing can have a significant impact on performance for seek +bound applications and should be enabled for most configurations. +Unfortunately, some devices that claim to support tagged queueing fail +miserably when it is used. +The only reason tagged queueing remains as a controller option is as a +stop gap measure until a mechanism to detect these broken devices and to +control this feature on a per device basis is in place. +.Pp +Memory mapped I/O can be enabled with the .Dq Dv AHC_ALLOW_MEMIO configuration option. Memory mapped I/O is more efficient than the alternative, programmed I/O. @@ -123,12 +139,7 @@ must be enabled for adaptors. This includes synchronous/asynchronous transfers, maximum synchronous negotiation rate, disconnection, -the host adapter's SCSI ID, -and, -in the case of -.Tn EISA -Twin Channel controllers, -the primary channel selection. +and the host adapter's SCSI ID. .Pp Note that I/O addresses are determined automatically by the probe routines, but care should be taken when using a 284x @@ -140,110 +151,35 @@ system. Ensure that the jumpers setting the I/O area for the 284x match the slot into which the card is inserted to prevent conflicts with other .Tn EISA cards. -.Pp -Performance and feature sets vary throughout the aic7xxx product line. -The following table provides a comparison of the different chips supported -by the -.Nm -driver. Note that wide and twin channel features, although always supported -by a particular chip, may be disabled in a particular motherboard or card -design. -.Pp -.Bd -filled -offset indent -.Bl -column "aic7770 " "10 " "EISA/VL " "10MHz " "16bit " "SCBs " Features -.Em "Chip MIPS Bus MaxSync MaxWidth SCBs Features" -aic7770 10 EISA/VL 10MHz 16Bit 4 1 -aic7850 10 PCI/32 10MHz 8Bit 3 -aic7860 10 PCI/32 20MHz 8Bit 3 -aic7870 10 PCI/32 10MHz 16Bit 16 -aic7880 10 PCI/32 20MHz 16Bit 16 -aic7890 20 PCI/32 40MHz 16Bit 16 3 4 5 6 7 -aic7891 20 PCI/64 40MHz 16Bit 16 3 4 5 6 7 -aic7895 15 PCI/32 20MHz 16Bit 16 2 3 4 5 -aic7896 20 PCI/32 40MHz 16Bit 16 2 3 4 5 6 7 -aic7897 20 PCI/64 40MHz 16Bit 16 2 3 4 5 6 7 -.El -.Pp -.Bl -enum -compact -.It -Multiplexed Twin Channel Device - One controller servicing two busses. -.It -Multi-function Twin Channel Device - Two controllers on one chip. -.It -Command Channel Secondary DMA Engine - Allows scatter gather list and -SCB prefetch. -.It -64 Byte SCB Support - SCSI CDB is embedded in the SCB to eliminate an extra DMA. -.It -Block Move Instruction Support - Doubles the speed of certain sequencer -operations. -.It -.Sq Bayonet -style Scatter Gather Engine - Improves S/G prefetch performance. -.It -Queueing Registers - Allows queueing of new transactions without pausing the -sequencer. -.El -.Ed -.Pp - -.Sh SCSI CONTROL BLOCKS (SCBs) -Every transaction sent to a device on the SCSI bus is assigned a -.Sq SCSI Control Block -(SCB). The SCB contains all of the information required by the -controller to process a transaction. The chip feature table lists -the number of SCBs that can be stored in on chip memory. All chips -with model numbers greater than or equal to 7870 allow for the on chip -SCB space to be augmented with external SRAM up to a maximum of 255 SCBs. -Very few Adaptec controller have external SRAM. - -If external SRAM is not available, SCBs are a limited resource and -using them in a straight forward manner would only allow us to -keep as many transactions as there are SCBs outstanding at a time. -This would not allow enough concurrency to fully utilize the SCSI -bus and it's devices. The solution to this problem is -.Em SCB Paging , -a concept similar to memory paging. SCB paging takes advantage of -the fact that devices usually disconnect from the SCSI bus for long -periods of time without talking to the controller. The SCBs -for disconnected transactions are only of use to the controller -when the transfer is resumed. When the host queues another transaction -for the controller to execute, the controller firmware will use a -free SCB if one is available. Otherwise, the state of the most recently -disconnected (and therefor most likely to stay disconnected) SCB is -saved, via dma, to host memory, and the local SCB reused to start -the new transaction. This allows the controller to queue up to -255 transactions regardless of the amount of SCB space. Since the -local SCB space serves as a cache for disconnected transactions, the -more SCB space available, the less host bus traffic consumed saving -and restoring SCB data. .Sh BUGS Some Quantum drives (at least the Empire 2100 and 1080s) will not run on an .Tn AIC7870 Rev B in synchronous mode at 10MHz. Controllers with this problem have a -42 MHz clock crystal on them and run slightly above 10MHz. This confuses -the drive and hangs the bus. Setting a maximum synchronous negotiation rate -of 8MHz in the +42 MHz clock crystal on them and run slightly above 10MHz. This causes the +drive much confusion. Setting a maximum synchronous negotiation rate of 8MHz +in the .Tn SCSI-Select utility -will allow normal operation. +will allow normal function. .Sh SEE ALSO .Xr aha 4 , .Xr ahb 4 , .Xr cd 4 , .Xr scsi 4 , -.Xr da 4 , -.Xr sa 4 +.Xr sd 4 , +.Xr st 4 .Sh AUTHORS The .Nm -driver, the +driver was written by +.An Justin Gibbs . +The .Tn AIC7xxx -sequencer-code assember, -and the firmware running on the aic7xxx chips was written by -.An Justin T. Gibbs . +sequencer-code assembler was +written by +.An John Aycock . .Sh HISTORY The .Nm driver appeared in -.Fx 2.0 . +.Fx 2.1 . diff --git a/share/man/man4/man4.i386/alog.4 b/share/man/man4/man4.i386/alog.4 new file mode 100644 index 0000000000000..3deabeb829a74 --- /dev/null +++ b/share/man/man4/man4.i386/alog.4 @@ -0,0 +1,149 @@ +.\" +.\" Copyright (c) 1998 Scottibox +.\" 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 +.\" in this position and unchanged. +.\" 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. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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. +.\" +.\" Industrial Computer Source model AIO8-P +.\" 8 channel, moderate speed analog to digital converter board with +.\" 128 channel MUX capability via daisy-chained AT-16P units +.\" alog.c, character device driver, last revised January 6 1998 +.\" See http://www.scottibox.com +.\" http://www.indcompsrc.com/products/data/html/aio8g-p.html +.\" http://www.indcompsrc.com/products/data/html/at16-p.html +.\" +.\" Written by: Jamil J. Weatherbee <jamil@scottibox.com> +.\" +.\" +.Dd January 6, 1998 +.Dt ALOG 4 i386 +.Os FreeBSD +.Sh NAME +.Nm alog +.Nd +Industrial Computer Source AIO8-P driver +.Sh SYNOPSIS +.Cd "device alog0 at isa? port 0x260 tty irq 5 vector alogintr" +.Sh DESCRIPTION +This driver supports the Industrial Computer Source \fIAIO8-P 8-Channel +12-Bit Analog Input board\fP. +.Pp +This board provides 8 12 bit, single-ended analog input ports. +The driver also directly provides support for up to 8 daisy chained +\fIAT16-P Programmable Analog Multiplexers with 16 Differential Inputs\fP. +This makes it possible to sample up to 128 differential channels with a single +interface board. +Use of at least one \fIAT16-P\fP is highly recommended as the \fIAIO8-P\fP +offers no signal conditioning options and only operates in a -5 to +5 Volt +input range. However, if you wish to use the \fIAIO8-P\fP standalone, +insert the following into your kernel +.Xr config 8 +file: +.Bd -literal -offset indent +options ALOG_CHANNELS=8 +.Ed +.Pp +Selection of the input port is through the minor number: +.Pp +.Bd -literal -offset indent +The 8 bit minor number format is UCCCCMMM, where + U: board unit (0-1) +CCCC: external multiplexer channel (0-15) (on AT-16P units) + MMM: internal multiplexer channel (0-7) (on AIO8-P card) +.Ed +.Pp +.Xr devfs 5 +device node names are of the form: alog[0-1][a-p][0-7] +.Pp +.Sh IOCTL +The following +.Xr ioctl 2 +calls apply to +.Nm +devices. Their declaration can be found in the header files +.Pa <sys/alogio.h> +and +.Pa <sys/dataacq.h> +.Bl -tag -width AD_MICRO_PERIOD_SET +.It Dv AD_MICRO_PERIOD_SET +Takes a pointer to a long argument specifying the number of microseconds +between samples. Half of this is used as the external multiplexer +settling time and the other half as conversion time. +.It Dv AD_MICRO_PERIOD_GET +Takes a pointer to a long argument and returns the current number of +microseconds between samples. +.It Dv AD_NCHANS_GET +Takes a pointer to an integer and returns the number of channels the board +supports. This should be 8 for a standalone \fIAIO8-P\fP or 128 for any +other setup. +.It Dv AD_FIFOSIZE_GET +Takes a pointer to an integer and returns the size of the fifo in +entries. The compile time option ALOG_FIFOSIZE is by default set to 64. +.It Dv AD_FIFO_TRIGGER_GET +Takes a pointer to an integer and returns the minimum number of entries a +fifo must contain to cause +.Xr poll 2 +to return. This by default is set to 1. +.It Dv AD_FIFO_TRIGGER_SET +Takes a pointer to an integer specifying the minimum number of entries a +fifo must contain to cause +.Xr poll 2 +to return. +.It Dv AD_START +Starts the clocked accumulation of sample values into a channel's driver fifo. +When a channel is first opened its software fifo is initialized in the +stopped state. This is to prevent high sample clocks from overrunning the +fifos before the user is ready to read from the channel. The driver +automatically performs an AD_START when the user issues the first read, +except for channels opened with the O_NONBLOCK flag which must explicitly +have an AD_START issued. +.It Dv AD_STOP +Stops the clocked accumulation of sample values into a channel's driver fifo. +.Sh BUGS +On the \fIAIO8-P\fP, interrupt driven conversion (the only type +supported by the +.Nm +driver) is facilitated through 8253 timer #2. In order for interrupts to +be generated you must connect line 6 to line 24 (counter 2 output to +interrupt input) and line 23 to line 29 (counter 2 gate to +5VDC). +The design of the \fIAIO8-P\fP precludes the use of programmable +gain control. +.Pp +Use the combination of non-blocking i/o, +.Xr poll 2 +and a custom fifo trigger +wherever possible, especially with large numbers of open channels. +Using this method, multichannel sample rates as high as 16,000 samples/sec +have been observed. +.Pp +Sample rates lower than 32 Hz are not supported. +.Sh SEE ALSO +.Bd -literal +http://www.scottibox.com +http://www.indcompsrc.com/products/data/html/aio8g-p.html +http://www.indcompsrc.com/products/data/html/at16-p.html +.Ed +.Sh AUTHORS +.An Jamil J. Weatherbee Aq jamil@scottibox.com diff --git a/share/man/man4/man4.i386/apm.4 b/share/man/man4/man4.i386/apm.4 index 24aa3a1deefb5..959439ba71166 100644 --- a/share/man/man4/man4.i386/apm.4 +++ b/share/man/man4/man4.i386/apm.4 @@ -9,7 +9,7 @@ .\" the author assume any responsibility for damages incurred with its .\" use. .\" -.\" $Id: apm.4,v 1.8 1998/06/08 06:11:58 jkoshy Exp $ +.\" $Id: apm.4,v 1.7 1998/02/20 07:19:51 hosokawa Exp $ .\" .Dd November 1, 1994 .Dt APM 4 i386 @@ -116,15 +116,15 @@ WARNING! Many, if not most, of the implementations of APM-bios in laptops today are buggy. You may be putting your LCD-display and batteries at a risk by using this interface. (The reason this isn't a problem for MS-windows is that they use the real-mode interface.) If you see any -weird behavior from your system with this code in use, unplug the +weird behaviour from your system with this code in use, unplug the power and batteries ASAP, if not immediately, and disable this code. .Pp We are very interested in getting this code working, so please send you -observations of any anomalous behavior to us. +observations of any anormalous behaviour to us. .Pp When .Nm apm -is active, calling the BIOS setup routine by using hot-keys, +is active, calling the BIOS setup routine by using hotkeys, may cause serious trouble when resuming the system. BIOS setup programs should be called during bootstrap, or from DOS. .Pp @@ -138,7 +138,7 @@ by using or .Xr zzz 8 . .Pp -Disk spin-down, LCD backlight control, and power on demand have not +Disk spindown, LCD backlight control, and power on demand have not been supported on the current version. .Sh SEE ALSO .Xr apm 8 , diff --git a/share/man/man4/man4.i386/ar.4 b/share/man/man4/man4.i386/ar.4 index 5446b667e92f7..5ba3c209e9e63 100644 --- a/share/man/man4/man4.i386/ar.4 +++ b/share/man/man4/man4.i386/ar.4 @@ -28,7 +28,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: ar.4,v 1.8 1998/06/08 06:11:58 jkoshy Exp $ +.\" $Id: ar.4,v 1.7 1998/03/12 07:30:30 charnier Exp $ .\" .Dd November 19, 1995 .Dt AR 4 i386 @@ -38,8 +38,8 @@ .Nd synchronous Arnet device driver. .Sh SYNOPSIS -.Cd "device ar0 at isa? port 0x300 net irq 10 iomem 0xd0000" -.Cd "device ar1 at isa? port 0x310 net irq 11 iomem 0xd0000" +.Cd "device ar0 at isa? port 0x300 net irq 10 iomem 0xd0000 vector arintr" +.Cd "device ar1 at isa? port 0x310 net irq 11 iomem 0xd0000 vector arintr" .Pp .Cd "pseudo-device sppp" .Sh DESCRIPTION diff --git a/share/man/man4/man4.i386/asc.4 b/share/man/man4/man4.i386/asc.4 index d84ae7b49f4a9..f3789554ac663 100644 --- a/share/man/man4/man4.i386/asc.4 +++ b/share/man/man4/man4.i386/asc.4 @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: asc.4,v 1.7 1998/06/08 06:11:58 jkoshy Exp $ +.\" $Id: asc.4,v 1.6 1997/02/22 13:25:13 peter Exp $ .Dd January 19, 1995 .Dt ASC 4 i386 .Os FreeBSD @@ -37,7 +37,7 @@ .Nm asc .Nd device driver for a GI1904-based hand scanner .Sh SYNOPSIS -.Cd "device asc0 at isa? port" \&"IO_ASC1\&" tty drq 3 irq 10 +.Cd "device asc0 at isa? port IO_ASC1 tty drq 3 irq 10 vector ascintr" .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/man4.i386/ax.4 b/share/man/man4/man4.i386/ax.4 deleted file mode 100644 index 58507c8930b5b..0000000000000 --- a/share/man/man4/man4.i386/ax.4 +++ /dev/null @@ -1,152 +0,0 @@ -.\" Copyright (c) 1997, 1998, 1999 -.\" Bill Paul <wpaul@ctr.columbia.edu>. 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. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by Bill Paul. -.\" 4. Neither the name of the author nor the names of any co-contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD -.\" 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. -.\" -.\" $Id: ax.4,v 1.1 1999/01/09 18:12:06 wpaul Exp $ -.\" -.Dd January 2, 1999 -.Dt AX 4 i386 -.Os FreeBSD -.Sh NAME -.Nm ax -.Nd -ASIX Electronics AX88140A fast ethernet device driver -.Sh SYNOPSIS -.Cd "device ax0" -.Sh DESCRIPTION -The -.Nm -driver provides support for PCI ethernet adapters and embedded -controllers based on the ASIX AX88140A fast ethernet controller chip, -including the Alfa Inc. GFC2204 and the CNet Pro110B. -.Pp -The ASIX chip uses bus master DMA and is designed to be a -DEC 21x4x workalike. The only major difference between the DEC -and ASIX parts is that the ASIX receiver filter is programmed -using two special registers where as the DEC chip is programmed -by uploading a special setup frame via the transmit DMA engine. -The ASIX receive filter can only be programmed with a single -perfect filter entry for the local station address and a 64-bit -multicast hash table; the DEC filter has supports several other -options. The ASIX fast ethernet controller supports both -10 and 100Mbps speeds in either full or half duplex using -an external MII transceiver. -.Pp -The -.Nm -driver supports the following media types: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It autoselect -Enable autoselection of the media type and options. -The user can manually override -the autoselected mode by adding media options to the -.Pa /etc/rc.conf -fine. -.It 10baseT/UTP -Set 10Mbps operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex modes. -.It 100baseTX -Set 100Mbps (fast ethernet) operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex -modes. -.El -.Pp -The -.Nm -driver supports the following media options: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It full-duplex -Force full duplex operation -.It half-duplex -Force half duplex operation. -.El -.Pp -For more information on configuring this device, see -.Xr ifconfig 8 . -.Sh DIAGNOSTICS -.Bl -diag -.It "ax%d: couldn't map memory" -A fatal initialization error has occurred. -.It "ax%d: couldn't map interrupt" -A fatal initialization error has occurred. -.It "ax%d: watchdog timeout" -The device has stopped responding to the network, or there is a problem with -the network connection (cable). -.It "ax%d: no memory for rx list" -The driver failed to allocate an mbuf for the receiver ring. -.It "ax%d: no memory for tx list" -The driver failed to allocate an mbuf for the transmitter ring when -allocating a pad buffer or collapsing an mbuf chain into a cluster. -.It "ax%d: chip is in D3 power state -- setting to D0" -This message applies only to adapters which support power -management. Some operating systems place the controller in low power -mode when shutting down, and some PCI BIOSes fail to bring the chip -out of this state before configuring it. The controller loses all of -its PCI configuration in the D3 state, so if the BIOS does not set -it back to full power mode in time, it won't be able to configure it -correctly. The driver tries to detect this condition and bring -the adapter back to the D0 (full power) state, but this may not be -enough to return the driver to a fully operational condition. If -you see this message at boot time and the driver fails to attach -the device as a network interface, you will have to perform second -warm boot to have the device properly configured. -.Pp -Note that this condition only occurs when warm booting from another -operating system. If you power down your system prior to booting -.Fx , -the card should be configured correctly. -.El -.Sh SEE ALSO -.Xr arp 4 , -.Xr netintro 4 , -.Xr ifconfig 8 -.Rs -.%T ASIX AX81140A data sheet -.%O http://www.asix.com.tw -.Re -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 3.0 . -.Sh AUTHOR -The -.Nm -driver was written by -.An Bill Paul Aq wpaul@ctr.columbia.edu . diff --git a/share/man/man4/man4.i386/bktr.4 b/share/man/man4/man4.i386/bktr.4 index d0c151d1098c3..04d30a7b2d10f 100644 --- a/share/man/man4/man4.i386/bktr.4 +++ b/share/man/man4/man4.i386/bktr.4 @@ -1,5 +1,5 @@ .\" -.\" $Id: bktr.4,v 1.1 1998/03/09 10:56:22 jkh Exp $ +.\" $Id$ .\" .Dd January 28, 1998 .br @@ -11,10 +11,6 @@ .Nd video capture driver .Sh SYNOPSIS .Nm device bktr0 -.Pp -.Nm controller iicbus0 -.Nm controller iicbb0 -.Nm controller smbus0 .Sh DESCRIPTION The .Nm bktr @@ -51,15 +47,6 @@ rgb24 rgb32 .in -0.5i .Pp -On these cards, tuners and other components are interconnected with an I2C bus. -The Brooktree848 chips act as a master device on the bus to control them. -Therefore, -.Xr iicbus 4 , -.Xr iicbb 4 -and -.Xr smbus 4 -controller declarations are mandatory to active bktr support. -.Pp The following kernel parameters may be used to further configure the driver: .Pp .Em options "BROOKTREE_ALLOC_PAGES=xxx" diff --git a/share/man/man4/man4.i386/bt.4 b/share/man/man4/man4.i386/bt.4 index a5756956f8e3c..39cb8915e2408 100644 --- a/share/man/man4/man4.i386/bt.4 +++ b/share/man/man4/man4.i386/bt.4 @@ -24,112 +24,44 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: bt.4,v 1.5 1998/03/12 07:30:30 charnier Exp $ +.\" $Id: bt.4,v 1.4 1997/03/07 02:49:45 jmg Exp $ .\" -.Dd October 16, 1998 +.Dd August 31, 1994 .Dt BT 4 i386 .Os FreeBSD .Sh NAME .Nm bt -.Nd Buslogic/Mylex MultiMaster SCSI host adapter driver +.Nd Buslogic SCSI host adapter driver .Sh SYNOPSIS -.Cd "controller bt0 at isa? port ? cam irq ?" +.Cd "controller bt0 at isa? port IO_BT0 bio irq ? vector btintr" .Cd controller scbus0 at bt0 .Sh DESCRIPTION This driver provides access to the .Tn SCSI -bus connected to a Buslogic/Mylex MultiMaster or compatible controller: -.Pp -.Bd -filled -offset indent -.Bl -column "BT-956CD " "ISA " "Commands " Description -MultiMaster "W" Series Host Adapters: -.Pp -.Em "Adapter Bus Commands Description" -BT-948 PCI 192 ULtra SCSI-3 -BT-958 PCI 192 Wide ULtra SCSI-3 -BT-958D PCI 192 Wide Differential ULtra SCSI-3 -.El -.Bl -column "BT-956CD " "ISA " "Commands " Description -MultiMaster "C" Series Host Adapters: -.Pp -.Em "Adapter Bus Commands Description" -BT-946C PCI 100 Fast SCSI-2 -BT-956C PCI 100 Wide Fast SCSI-2 -BT-956CD PCI 100 Wide Differential Fast SCSI-2 -BT-445C VLB 100 Fast SCSI-2 -BT-747C EISA 100 Fast SCSI-2 -BT-757C EISA 100 Wide Fast SCSI-2 -BT-757CD EISA 100 Wide Differential Fast SCSI-2 -BT-545C ISA 50 Fast SCSI-2 -BT-540CF ISA 50 Fast SCSI-2 -.El -.Bl -column "BT-956CD " "ISA " "Commands " Description -MultiMaster "S" Series Host Adapters: -.Pp -.Em "Adapter Bus Commands Description" -BT-445S VLB 30 Fast SCSI-2 -BT-747S EISA 30 Fast SCSI-2 -BT-747D EISA 30 Differential Fast SCSI-2 -BT-757S EISA 30 Wide Fast SCSI-2 -BT-757D EISA 30 Wide Differential Fast SCSI-2 -BT-545S ISA 30 Fast SCSI-2 -BT-542D ISA 30 Differential Fast SCSI-2 -BT-742A EISA 30 SCSI-2 (742A revision H) -BT-542B ISA 30 SCSI-2 (542B revision H) -.El -.Bl -column "BT-956CD " "ISA " "Commands " Description -MultiMaster "A" Series Host Adapters: -.Pp -.Em "Adapter Bus Commands Description" -BT-742A EISA 30 SCSI-2 (742A revisions A - G) -BT-542B ISA 30 SCSI-2 (542B revisions A - G) -.El -.Ed -.Pp -AMI FastDisk Host Adapters that are true BusLogic MultiMaster clones are also -supported by this driver. -.Pp -Tagged queueing is supported on 'W' series adapters, 'C' series adapters -with firmware of rev 4.42 and higher, and 'S' series adapters with firmware -of rev 3.35 and higher. -.Pp -Boards with certain firmware revisions may lock up under heavy load to -certain devices, especially if tagged queueing is used. Should you encounter -a problem with your adapter, contact Mylex technical support and ensure you -have the latest firmware for your controller. +bus connected to a Buslogic +545, 445, 742, 747 or 946 host adapter. +.\" +.\" .Sh DIAGNOSTICS +.\" .Sh SEE ALSO .Xr cd 4 , .Xr scsi 4 , -.Xr da 4 , -.Xr sa 4 +.Xr sd 4 , +.Xr st 4 .Sh AUTHORS +The +.Nm +driver was written by .An Julian Elischer -wrote a driver for the Multimaster cards that appeared in the 386BSD -patch kit. The driver was rewritten by -.An Justin T. Gibbs -to take advantage of new board features and work with the CAM SCSI framework -in FreeBSD 3.0R. -.Pp -Special thanks to Leonard N. Zubkoff -for writing such a complete and well documented Mylex/BusLogic MultiMaster -driver for Linux. Support in this driver for the wide range of MultiMaster -controllers and firmware revisions, with their otherwise undocumented quirks, -would not have been possible without his efforts. -.Sh FILES -.Bl -tag -width /usr/share/man0/template.doc -compact -.It Pa sys/dev/buslogic/bt.c -Core Driver Implementation -.It Pa sys/dev/buslogic/btreg.h -MultiMaster Register Set and Core Driver Data Structures -.It Pa sys/pci/bt_pci.c -PCI Bus Driver Attachment -.It Pa sys/i386/eisa/bt_eisa.c -EISA Bus Driver Attachment -.It Pa sys/i386/isa/bt_isa.c -ISA/VL Bus Driver Attachment -.El +for use with +.Tn Mach +2.5. The interface for the +.Tn PCI +and +.Tn EISA +busses was written by +.An Justin Gibbs . .Sh HISTORY -The +We're not sure when the .Nm -driver first appeared in the 386BSD patch kit. - +driver first appeared. diff --git a/share/man/man4/man4.i386/cs.4 b/share/man/man4/man4.i386/cs.4 index 4121ee5219716..912ad259f9c27 100644 --- a/share/man/man4/man4.i386/cs.4 +++ b/share/man/man4/man4.i386/cs.4 @@ -23,7 +23,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: cs.4,v 1.1 1998/07/20 20:02:32 msmith Exp $ +.\" $Id$ .\" .Dd July 20, 1998 .Dt CS 4 i386 @@ -32,8 +32,8 @@ .Nm cs .Nd ethernet device driver .Sh SYNOPSIS -.Cd "device cs0 at isa? port 0x300 net irq ?" -.Cd "device cs1 at isa? port 0x300 net irq 10 iomem 0xd0000" +.Cd "device cs0 at isa? port 0x300 net irq ? vector csintr" +.Cd "device cs1 at isa? port 0x300 net irq 10 iomem 0xd0000 vector csintr" .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/man4.i386/cy.4 b/share/man/man4/man4.i386/cy.4 index 316dfc51c4942..6fd1017624d44 100644 --- a/share/man/man4/man4.i386/cy.4 +++ b/share/man/man4/man4.i386/cy.4 @@ -35,7 +35,7 @@ .\" 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 $ -.\" $Id: cy.4,v 1.8 1997/03/21 20:13:42 mpp Exp $ +.\" $Id: cy.4,v 1.7 1997/03/03 18:38:37 bde Exp $ .\" .Dd October 10, 1995 .Dt CY 4 i386 @@ -44,8 +44,8 @@ .Nm cy .Nd Cyclades Cyclom-Y serial driver .Sh SYNOPSIS -.Cd "device cy0 at isa? tty irq 10 iomem 0xd4000 iosiz 0x2000" -.Cd "device cy1 at isa? tty irq 11 iomem 0xd6000 iosiz 0x2000" +.Cd "device cy0 at isa? tty irq 10 iomem 0xd4000 iosiz 0x2000 vector cyintr +.Cd "device cy1 at isa? tty irq 11 iomem 0xd6000 iosiz 0x2000 vector cyintr .Pp Minor numbering: .Pp diff --git a/share/man/man4/man4.i386/ed.4 b/share/man/man4/man4.i386/ed.4 index 60ed90d4aa71a..88460ce932e8b 100644 --- a/share/man/man4/man4.i386/ed.4 +++ b/share/man/man4/man4.i386/ed.4 @@ -28,7 +28,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: ed.4,v 1.12 1998/06/08 06:11:59 jkoshy Exp $ +.\" $Id: ed.4,v 1.11 1998/03/12 07:30:31 charnier Exp $ .\" .Dd October 28, 1995 .Dt ED 4 i386 @@ -37,9 +37,9 @@ .Nm ed .Nd high performance ethernet device driver .Sh SYNOPSIS -.Cd "device ed0 at isa? port 0x280 net irq 5 iomem 0xd8000" -.Cd "device ed1 at isa? port 0x300 net irq 5 iomem 0xd8000" -.Cd "device ed2 at isa? port 0x320 net irq 10 flags 0x4 iosiz 16384 iomem 0xd8000" +.Cd "device ed0 at isa? port 0x280 net irq 5 iomem 0xd8000 vector edintr" +.Cd "device ed1 at isa? port 0x300 net irq 5 iomem 0xd8000 vector edintr" +.Cd "device ed2 at isa? port 0x320 net irq 10 flags 0x4 iosiz 16384 iomem 0xd8000 vector edintr" .Sh DESCRIPTION The .Nm ed diff --git a/share/man/man4/man4.i386/dpt.4 b/share/man/man4/man4.i386/eg.4 index cb0e9b20f3084..9e96270b2a7a0 100644 --- a/share/man/man4/man4.i386/dpt.4 +++ b/share/man/man4/man4.i386/eg.4 @@ -1,5 +1,5 @@ .\" -.\" Copyright (c) 1998 Justin T. Gibbs +.\" Copyright (c) 1994 James A. Jegers .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without @@ -21,58 +21,52 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id$ +.\" $Id: eg.4,v 1.5 1997/02/22 13:25:19 peter Exp $ .\" -.Dd October 16, 1998 -.Dt DPT 4 i386 -.Os FreeBSD 3.0 +.Dd July 10, 1995 +.Dt EG 4 i386 +.Os .Sh NAME -.Nm dpt -.Nd DPT RAID Controller SCSI driver +.Nm eg +.Nd Ethernet driver for 3Com 3c505 Etherlink+ Ethernet board .Sh SYNOPSIS -For one or more EISA Controllers -.Cd "controller eisa0" -.Cd "controller dpt0" -.Pp -For one or more PCI Controllers -.Cd "controller pci0" -.Cd "controller dpt0" -.Pp -To allow PCI adapters to use memory mapped I/O if enabled: -.Cd options DPT_ALLOW_MEMIO -.Pp +.Cd "device eg0 at isa? port 0x310 net irq 5 vector egintr" .Sh DESCRIPTION The .Nm -driver provides support for the DPT Smart Cache Plus, Smart Cache III, -Smart Raid III, Smart Cache IV, and Smart RAID IV families of procucts. -.Sh FILES -.Bl -tag -width /usr/share/man0/template.doc -compact -.It Pa sys/dev/dpt/dpt_scsi.c -Core Driver Implementation -.It Pa sys/dev/dpt/dpt.h -Register Set and Core Driver Data Structures -.It Pa sys/pci/dpt_pci.c -PCI Bus Driver Attachment -.It Pa sys/i386/eisa/dpt_eisa.c -EISA Bus Driver Attachment +interface provides access to a 10 Mb/s Ethernet network via the +3Com 3c505 board based on the Intel 82586 Ethernet chip. +.Sh DIAGNOSTICS +.Bl -diag +.It "eg%d: configure card command failed" +For some reason, the driver could not initialize the card. Please check +the card's IRQ and I/O settings relative to those in the kernel +configuration file. .El +.Pp +.Sh BUGS +Uses the onboard firmware, which is not a good way to do it. +Doesn't support DMA or high speeds. +Currently the driver does not support multicast. +The timeout interval can be quite long (16 seconds) for a 512k board. .Sh SEE ALSO -.Xr cd 4 , -.Xr ch 4 , -.Xr scsi 4 , -.Xr da 4 , -.Xr sa 4 -.Sh AUTHORS +.Xr ed 4 , +.Xr el 4 , +.Xr ep 4 , +.Xr ie 4 , +.Xr intro 4 , +.Xr le 4 , +.Xr ifconfig 8 +.Sh HISTORY The .Nm -driver was written by -.An Simon Shapiro -and ported to the CAM SCSI system by -.An Justin T. Gibbs . -.Sh HISTORY +device driver first appeared in +.Fx 2.0.5 +coming from NetBSD. +.Sh AUTHORS The .Nm -driver first appeared in -.Fx 2.2.6 . - +device driver was written by +.An Dean Huxley . +This manual page was written by +.An James A. Jegers . diff --git a/share/man/man4/man4.i386/el.4 b/share/man/man4/man4.i386/el.4 index 1e1add5529b91..fe1c78bae1d33 100644 --- a/share/man/man4/man4.i386/el.4 +++ b/share/man/man4/man4.i386/el.4 @@ -21,7 +21,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: el.4,v 1.6 1997/08/12 20:03:54 adam Exp $ +.\" $Id: el.4,v 1.5 1997/02/22 13:25:20 peter Exp $ .\" .Dd July 10, 1995 .Dt EL 4 i386 @@ -30,7 +30,7 @@ .Nm el .Nd Ethernet driver for 3Com Etherlink 3C501 device driver .Sh SYNOPSIS -.Cd "device el0 at isa? port 0x300 net irq 9" +.Cd "device el0 at isa? port 0x300 net irq 9 vector elintr" .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/man4.i386/ep.4 b/share/man/man4/man4.i386/ep.4 index c0abf0112cc7c..666e2908f6eb0 100644 --- a/share/man/man4/man4.i386/ep.4 +++ b/share/man/man4/man4.i386/ep.4 @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: ep.4,v 1.8 1998/01/08 17:09:38 joerg Exp $ +.\" $Id: ep.4,v 1.7 1997/12/22 07:37:50 charnier Exp $ .\" .Dd February 04, 1993 .Dt EP 4 i386 @@ -36,7 +36,7 @@ .Nm ep .Nd Ethernet driver for 3Com Etherlink III (3c5x9) .Sh SYNOPSIS -.Cd "device ep0 at isa? port 0x300 net irq 10" +.Cd "device ep0 at isa? port 0x300 net irq 10 vector epintr" .Sh DESCRIPTION The .Nm ep diff --git a/share/man/man4/man4.i386/ex.4 b/share/man/man4/man4.i386/ex.4 index b51769ea2a366..ab7e3fbd690ed 100644 --- a/share/man/man4/man4.i386/ex.4 +++ b/share/man/man4/man4.i386/ex.4 @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: ex.4,v 1.5 1998/03/12 07:30:32 charnier Exp $ +.\" $Id: ex.4,v 1.4 1997/09/26 17:16:52 msmith Exp $ .\" .Dd January 19, 1997 .Dt EX 4 i386 @@ -33,7 +33,7 @@ .Nd Ethernet device driver for the Intel EtherExpress Pro/10 and Pro/10+ .Sh SYNOPSIS -.Cd "device ex0 at isa? port? net irq ?" +.Cd "device ex0 at isa? port? net irq? vector exintr" .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/man4.i386/fdc.4 b/share/man/man4/man4.i386/fdc.4 index ae04bc1682a84..6c8861d1166f1 100644 --- a/share/man/man4/man4.i386/fdc.4 +++ b/share/man/man4/man4.i386/fdc.4 @@ -24,7 +24,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: fdc.4,v 1.10 1998/10/22 14:49:00 bde Exp $ +.\" $Id: fdc.4,v 1.8 1997/02/22 13:25:23 peter Exp $ .\" .Dd August 31, 1994 .Dt FDC 4 i386 @@ -34,9 +34,12 @@ .Nd PC architecture floppy disk controller driver .Sh SYNOPSIS -.Cd "controller fdc0 at isa? port" \&"IO_FD1\&" "bio flags 0x1 irq 6 drq 2" +.Cd "controller fdc0 at isa? port" \&"IO_FD1\&" bio "flags 0x1" "irq 6" "drq 2" "vector fdintr" .Cd "disk fd0 at fdc0 drive 0 .Cd "disk fd1 at fdc0 drive 1 +.Pp +For QIC40 and QIC80 tapedrives controlled by the floppy controller: +.Cd "tape ft0 at fdc0 drive 2 .Sh DESCRIPTION This driver provides access to floppy disk drives and QIC40/80 tapedrives. In /dev for each floppy device a number of minor devices are present. The @@ -59,11 +62,16 @@ floppy disk device nodes .It /dev/fd*.<size in kB> floppy disk device nodes where the trailing number indicates the floppy capacity +.It /dev/ft* +floppy tape (QIC40/80) device nodes .It Pa /sys/i386/conf/GENERIC sample generic kernel config file .It Pa /sys/i386/isa/fd.c floppy driver source +.It Pa /sys/i386/isa/ft.c +floppy tape (QIC40/80 driver source .El .Sh SEE ALSO .Xr fdformat 1 , .Xr disktab 5 , +.Xr ft 8 diff --git a/share/man/man4/man4.i386/fe.4 b/share/man/man4/man4.i386/fe.4 index 1902932bff3ff..1a0e3bee20856 100644 --- a/share/man/man4/man4.i386/fe.4 +++ b/share/man/man4/man4.i386/fe.4 @@ -21,14 +21,14 @@ .\" Contributed by M. Sekiguchi <seki@sysrap.cs.fujitsu.co.jp>. .\" for fe driver. .\" -.\" $Id: fe.4,v 1.10 1998/03/12 07:30:32 charnier Exp $ +.\" $Id: fe.4,v 1.9 1997/02/22 13:25:26 peter Exp $ .Dd March 3, 1996 .Dt FE 4 i386 .Sh NAME .Nm fe .Nd Fujitsu MB86960A/MB86965A based Ethernet adapters .Sh SYNOPSIS -.Cd "device fe0 at isa? port 0x300 net irq ?" +.Cm "device fe0 at isa? port 0x300 net irq ? vector feintr" .Sh DESCRIPTION The .Nm fe diff --git a/share/man/man4/man4.i386/ie.4 b/share/man/man4/man4.i386/ie.4 index d81b7b5ff41be..a18a8acf0f4ea 100644 --- a/share/man/man4/man4.i386/ie.4 +++ b/share/man/man4/man4.i386/ie.4 @@ -2,7 +2,7 @@ .\" Copyright (c) 1994, Wilko Bulte .\" All rights reserved. .\" -.\" $Id: ie.4,v 1.6 1998/06/17 08:33:10 jkoshy Exp $ +.\" $Id: ie.4,v 1.5 1998/03/12 07:30:33 charnier Exp $ .\" .Dd September 23, 1994 .Dt IE 4 i386 @@ -12,7 +12,7 @@ .Nd ethernet device driver .Sh SYNOPSIS -.Cd "device ie0 at isa? port 0x360 net irq 7 iomem 0xd0000" +.Cd "device ie0 at isa? port 0x360 net irq 7 iomem 0xd0000 vector ieintr" .Sh DESCRIPTION The .Nm ie diff --git a/share/man/man4/man4.i386/labpc.4 b/share/man/man4/man4.i386/labpc.4 index 350bc6236257a..0dba76f5b73d4 100644 --- a/share/man/man4/man4.i386/labpc.4 +++ b/share/man/man4/man4.i386/labpc.4 @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: labpc.4,v 1.5 1998/06/08 06:11:59 jkoshy Exp $ +.\" $Id: labpc.4,v 1.4 1997/03/07 02:49:48 jmg Exp $ .\" .rm ES .rm EE @@ -48,7 +48,7 @@ .Nd National Instruments LABPC and LABPC+ driver .Sh SYNOPSIS -.Cd "device labpc0 at isa? port 260 tty irq 5" +.Cd "device labpc0 at isa? port 260 tty irq 5 vector labpcintr .Sh DESCRIPTION This supports the National Instruments LABPC and LABPC+ \fILow-Cost Multifunction I/O Board\fP. diff --git a/share/man/man4/man4.i386/le.4 b/share/man/man4/man4.i386/le.4 index f9ba670a6964b..e6888a7f2160d 100644 --- a/share/man/man4/man4.i386/le.4 +++ b/share/man/man4/man4.i386/le.4 @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: le.4,v 1.4 1998/03/12 07:30:34 charnier Exp $ +.\" $Id: le.4,v 1.3 1997/02/22 13:25:33 peter Exp $ .\" .Dd January 19, 1997 .Dt LE 4 i386 @@ -33,7 +33,7 @@ .Nd DEC EtherWORKS II/III Ethernet device driver .Sh SYNOPSIS -.Cd "device le0 at isa? port 0x300 net irq 5 iomem 0xd0000" +.Cd "device le0 at isa? port 0x300 net irq 5 iomem 0xd0000 vector le_intr" .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/man4.i386/lnc.4 b/share/man/man4/man4.i386/lnc.4 index 23c24bece083f..9bfc10a1434af 100644 --- a/share/man/man4/man4.i386/lnc.4 +++ b/share/man/man4/man4.i386/lnc.4 @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: lnc.4,v 1.5 1998/10/22 14:12:55 bde Exp $ +.\" $Id: lnc.4,v 1.3 1997/02/22 13:25:34 peter Exp $ .\" .Dd January 19, 1997 .Dt LNC 4 i386 @@ -33,7 +33,7 @@ .Nd AMD Lance/PCnet Ethernet device driver .Sh SYNOPSIS -.Cd "device lnc0 at isa? port 0x280 net irq 10 drq 0" +.Cd "device lnc0 at isa? port 0x280 net irq 10 drq 0 vector lncintr" .Sh DESCRIPTION The .Nm @@ -47,8 +47,6 @@ interface are: .It Novell NE32-VL .It Isolan BICC .It Digital DEPCA -.It Hewlett Packard Vectra 486/66XM -.It Hewlett Packard Vectra XU .El .Sh DIAGNOSTICS .Bl -diag diff --git a/share/man/man4/man4.i386/lp.4 b/share/man/man4/man4.i386/lp.4 index 26010f8ecb1ab..37721455f484a 100644 --- a/share/man/man4/man4.i386/lp.4 +++ b/share/man/man4/man4.i386/lp.4 @@ -31,7 +31,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: lp.4,v 1.6 1998/10/15 20:36:55 wosch Exp $ +.\" $Id: lp.4,v 1.5 1997/03/07 02:49:48 jmg Exp $ .\" .Dd March 4, 1996 .Os @@ -43,7 +43,7 @@ .Nm ifconfig lp0 .Ar myaddress hisaddress .Op Fl link0 -.Cd "device lpt0 at isa? port? tty irq 7" +.Cd "device lpt0 at isa? port? tty irq 7 vector lptintr" .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/man4.i386/lpt.4 b/share/man/man4/man4.i386/lpt.4 index 2c2354ea4b64e..85edd0fb98baf 100644 --- a/share/man/man4/man4.i386/lpt.4 +++ b/share/man/man4/man4.i386/lpt.4 @@ -29,7 +29,7 @@ .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .\" from: lpt.4,v 1.1 1993/08/06 10:34:12 cgd Exp -.\" $Id: lpt.4,v 1.7 1998/10/15 20:27:26 wosch Exp $ +.\" $Id: lpt.4,v 1.6 1997/03/07 02:49:49 jmg Exp $ .\" .Dd August 28, 1993 .Dt LPT 4 i386 @@ -40,12 +40,12 @@ Parallel port driver .Sh SYNOPSIS For interrupt-driven ports: -.Cd "device lpt0 at isa? port" \&"IO_LPT1\&" tty irq 7 -.Cd "device lpt1 at isa? port" \&"IO_LPT2\&" tty irq 7 -.Cd "device lpt2 at isa? port" \&"IO_LPT3\&" tty irq 7 +.Cd "device lpt0 at isa? port" \&"IO_LPT1\&" tty irq 7 vector lptintr +.Cd "device lpt1 at isa? port" \&"IO_LPT2\&" tty irq 7 vector lptintr +.Cd "device lpt2 at isa? port" \&"IO_LPT3\&" tty irq 7 vector lptintr .Pp For BIOS-probed ports: -.Cd "device lpt0 at isa? port? tty irq 7" +.Cd "device lpt0 at isa? port? tty irq 7 vector lptintr" .Pp For polled ports: .Cd "device lpt0 at isa? port? tty" diff --git a/share/man/man4/man4.i386/mcd.4 b/share/man/man4/man4.i386/mcd.4 index 28febc901a7f9..79814f311d999 100644 --- a/share/man/man4/man4.i386/mcd.4 +++ b/share/man/man4/man4.i386/mcd.4 @@ -24,7 +24,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: mcd.4,v 1.5 1998/03/12 07:30:35 charnier Exp $ +.\" $Id: mcd.4,v 1.4 1997/03/21 20:13:46 mpp Exp $ .\" .Dd December 8, 1994 .Dt MCD 4 i386 @@ -33,7 +33,7 @@ .Nm mcd .Nd Mitsumi CD-ROM driver .Sh SYNOPSIS -.Cd "device mcd0 at isa? port 0x300 bio irq 10" +.Cd "device mcd0 at isa? port 0x300 bio irq 10 vector mcdintr" .Sh DESCRIPTION The .Nm mcd diff --git a/share/man/man4/man4.i386/mse.4 b/share/man/man4/man4.i386/mse.4 index 64936b24f483f..9e3202cd88181 100644 --- a/share/man/man4/man4.i386/mse.4 +++ b/share/man/man4/man4.i386/mse.4 @@ -10,7 +10,7 @@ .\" this software for any purpose. It is provided "as is" .\" without express or implied warranty. .\" -.\" $Id: mse.4,v 1.4 1997/12/07 08:46:53 yokota Exp $ +.\" $Id: mse.4,v 1.3 1997/03/07 02:49:53 jmg Exp $ .\" .Dd December 3, 1997 .Dt MSE 4 i386 @@ -20,7 +20,7 @@ .Nd bus and InPort mice driver .Sh SYNOPSIS .\" .Cd "options" \&"MSE_XXX=N\&" -.Cd "device mse0 at isa? port 0x23c tty irq 5" +.Cd "device mse0 at isa? port" 0x23c tty irq 5 vector mseintr .Sh DESCRIPTION The .Nm @@ -328,13 +328,13 @@ movement counts as described in .Em devfs . .El .Sh EXAMPLE -.Dl "device mse0 at isa? port 0x23c tty irq 5" +.Dl "device mse0 at isa? port" 0x23c tty irq 5 vector mseintr .Pp Add the .Nm driver at the primary port address with the IRQ 5. .Pp -.Dl "device mse1 at isa? port 0x238 tty flags 0x30 irq 4" +.Dl "device mse1 at isa? port" 0x238 tty flags 0x30 irq 4 vector mseintr .Pp Define the .Nm diff --git a/share/man/man4/man4.i386/mx.4 b/share/man/man4/man4.i386/mx.4 deleted file mode 100644 index 5c600b8a3f1b4..0000000000000 --- a/share/man/man4/man4.i386/mx.4 +++ /dev/null @@ -1,167 +0,0 @@ -.\" Copyright (c) 1997, 1998 -.\" Bill Paul <wpaul@ctr.columbia.edu>. 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. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by Bill Paul. -.\" 4. Neither the name of the author nor the names of any co-contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD -.\" 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. -.\" -.\" $Id: mx.4,v 1.1 1998/12/04 18:01:22 wpaul Exp $ -.\" -.Dd November 5, 1998 -.Dt MX 4 i386 -.Os FreeBSD -.Sh NAME -.Nm mx -.Nd -Macronix 98713/98715/98725 fast ethernet device driver -.Sh SYNOPSIS -.Cd "device mx0" -.Sh DESCRIPTION -The -.Nm -driver provides support for PCI ethernet adapters and embedded -controllers based on the Macronix 98713, 98713A, 98715, 98715A and -98725 fast ethernet controller chips. This includes the NDC -Communications SOHOware SFA110, the SVEC PN102-TX -fast ethernet card, and various other adapters. -.Pp -The Macronix chips use bus master DMA and are designed to be -DEC 'tulip' workalikes. The original 98713 had an MII bus for -controlling an external PHY, however the 98713A and up use an -internal transceiver with NWAY support. The Macronix parts are -advertised as being register compatible with the DEC 21x4x -controllers. All of the Macronix controllers support both -10 and 100Mbps speeds in either full or half duplex. -.Pp -The -.Nm -driver supports the following media types: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It autoselect -Enable autoselection of the media type and options. -The user can manually override -the autoselected mode by adding media options to the -.Pa /etc/rc.conf -fine. -.It 10baseT/UTP -Set 10Mbps operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex modes. -.It 100baseTX -Set 100Mbps (fast ethernet) operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex -modes. -.El -.Pp -The -.Nm -driver supports the following media options: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It full-duplex -Force full duplex operation -.It half-duplex -Force half duplex operation. -.El -.Pp -Note that the 100baseTX media type is only available if supported -by the adapter. -For more information on configuring this device, see -.Xr ifconfig 8 . -.Sh DIAGNOSTICS -.Bl -diag -.It "mx%d: couldn't map memory" -A fatal initialization error has occurred. -.It "mx%d: couldn't map interrupt" -A fatal initialization error has occurred. -.It "mx%d: watchdog timeout" -The device has stopped responding to the network, or there is a problem with -the network connection (cable). -.It "mx%d: no memory for rx list" -The driver failed to allocate an mbuf for the receiver ring. -.It "mx%d: no memory for tx list" -The driver failed to allocate an mbuf for the transmitter ring when -allocating a pad buffer or collapsing an mbuf chain into a cluster. -.It "mx%d: chip is in D3 power state -- setting to D0" -This message applies only to adapters which support power -management. Some operating systems place the controller in low power -mode when shutting down, and some PCI BIOSes fail to bring the chip -out of this state before configuring it. The controller loses all of -its PCI configuration in the D3 state, so if the BIOS does not set -it back to full power mode in time, it won't be able to configure it -correctly. The driver tries to detect this condition and bring -the adapter back to the D0 (full power) state, but this may not be -enough to return the driver to a fully operational condition. If -you see this message at boot time and the driver fails to attach -the device as a network interface, you will have to perform second -warm boot to have the device properly configured. -.Pp -Note that this condition only occurs when warm booting from another -operating system. If you power down your system prior to booting -.Fx , -the card should be configured correctly. -.El -.Sh SEE ALSO -.Xr arp 4 , -.Xr netintro 4 , -.Xr ifconfig 8 -.Rs -.%T Macronix 98713/A, 98715/A and 98725 data sheets -.%O http://www.macronix.com -.Re -.Rs -.%T Macronix 98713/A and 98715/A app notes -.%O http://www.macronix.com -.Re -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 3.0 . -.Sh AUTHOR -The -.Nm -driver was written by -.An Bill Paul Aq wpaul@ctr.columbia.edu . -.Sh BUGS -The Macronix application notes claim that in order to put the -chips in normal operation, the driver must write a certian magic -number into the CSR16 register. The numbers are documented in -the app notes, but the exact meaning of the bits is not. -.Pp -The 98713A seems to have a problem with 10Mbps full duplex mode. -The transmitter works but the receiver tends to produce many -unexplained errors leading to very poor overall performance. The -98715A does not exhibit this problem. All other modes on the -98713A seem to work correctly. diff --git a/share/man/man4/man4.i386/nca.4 b/share/man/man4/man4.i386/nca.4 new file mode 100644 index 0000000000000..687cc37df6a49 --- /dev/null +++ b/share/man/man4/man4.i386/nca.4 @@ -0,0 +1,71 @@ +.\"Manual pages for FreeBSD generic NCR-5380/NCR-53C400 SCSI driver. +.\" +.\"Copyright 1994, Serge Vakulenko (vak@cronyx.ru) +.\" +.\"Redistribution and use of this document, with or without +.\"modification, are permitted provided redistributions must retain +.\"the above copyright notice and this condition. +.\" +.\" $Id$ +.Dd January 9, 1995 +.Dt NCA 4 i386 +.Os FreeBSD +.Sh NAME +.Nm nca +.Nd +Generic NCR-5380/NCR-53C400 SCSI adapter driver +.Sh SYNOPSIS +Trantor 130, with IRQ: +.Cd "controller nca0 at isa? port 0x350 bio irq 5 vector ncaintr +.Pp +Trantor 130, without IRQ: +.Cd "controller nca0 at isa? port 0x350 +.Pp +ProAudioSpectrum-16, with IRQ: +.Cd "controller nca0 at isa? port 0x1f88 bio irq 5 vector ncaintr +.Cd "controller nca1 at isa? port 0x1f84 bio irq 5 vector ncaintr +.Cd "controller nca2 at isa? port 0x1f8c bio irq 5 vector ncaintr +.Cd "controller nca3 at isa? port 0x1e88 bio irq 5 vector ncaintr +.Pp +ProAudioSpectrum-16, without IRQ: +.Cd "controller nca0 at isa? port 0x1f88 +.Cd "controller nca1 at isa? port 0x1f84 +.Cd "controller nca2 at isa? port 0x1f8c +.Cd "controller nca3 at isa? port 0x1e88 +.Sh DESCRIPTION +This driver provides access to SCSI devices connected to +NCR-5380/NCR-53C400 SCSI adapter. +.Pp +It's possible to use the adapter without IRQ line. +The data rate then slightly decreases (by 20-30%). +.Pp +The \fBflags\fP keyword in the configuration file can be used to set +some adapter driver parameters: +.Pp +Bits Description +.br +------------------------------------------ +.br +0x01 Disable SCSI bus parity check. +.Pp +Tested on the following hardware: +.br + Adapter: Trantor T130 + Adapter: ProAudioSpectrum16 +.br + Streamer: Archive Viper 150 +.br + CD-ROM: NEC CDR-25 + CD-ROM: PLEXTOR CD-ROM PX-4XCH +.Sh FILES +.Bl -tag -width Pa -compact +.It Pa /sys/i386/isa/ncr5380.c +.It Pa /sys/i386/isa/ic/ncr5380.h +.It Pa /sys/i386/isa/ic/ncr53400.h +driver source +.El +.Sh SEE ALSO +.Xr cd 4 , +.Xr scsi 4 , +.Xr sd 4 , +.Xr st 4 diff --git a/share/man/man4/man4.i386/npx.4 b/share/man/man4/man4.i386/npx.4 index 4bbb263a5705d..ff79d593308e0 100644 --- a/share/man/man4/man4.i386/npx.4 +++ b/share/man/man4/man4.i386/npx.4 @@ -28,7 +28,7 @@ .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .\" from: npx.4,v 1.1 1993/08/06 10:58:03 cgd Exp -.\" $Id: npx.4,v 1.4 1997/02/22 13:25:36 peter Exp $ +.\" $Id$ .\" .Dd August 28, 1993 .Dt NPX 4 i386 @@ -39,7 +39,7 @@ .Sh SYNOPSIS .Cd "options MATH_EMULATE" .\" XXX this is awful hackery to get it to work right... -- cgd -.Cd "device npx0 at isa? port IO_NPX tty irq 13" +.Cd "device npx0 at isa? port" \&"IO_NPX0\&" tty irq 13 vector npxintr .Sh DESCRIPTION The .Nm npx diff --git a/share/man/man4/man4.i386/pcf.4 b/share/man/man4/man4.i386/pcf.4 deleted file mode 100644 index d7825dfc353cc..0000000000000 --- a/share/man/man4/man4.i386/pcf.4 +++ /dev/null @@ -1,64 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd August 6, 1998 -.Dt PCF 4 -.Os FreeBSD -.Sh NAME -.Nm pcf -.Nd -Philips I2C bus controller -.Sh SYNOPSIS -.Cd "controller pcf0 at isa? port? irq 5" -.Pp -For one or more iicbus busses: -.Cd "controller iicbus0" -.Sh DESCRIPTION -The -.Em pcf -driver provides support to the Philips PCF8584 I2C controller for the -.Xr iicbus 4 -system. -.Pp -The PCF8584 is an integrated circuit designed in CMOS technology which serves -as an interface between most standard parallel-bus -microcontrollers/microprocessors and the serial I2C-bus. The PCF8584 -provides both master and slave functions. Communication with I2C-bus is -carried out on a byte-wise basis using interrupt or polled handshake. It -controls all the I2C-bus specific sequences, protocol, arbitration and timing. -The PCF8584 allows parallel-bus systems to communicate bidirectionally with -the I2C-bus. -.Pp -.Sh SEE ALSO -.Xr iicbus 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/man4.i386/pcm.4 b/share/man/man4/man4.i386/pcm.4 index 51f8e179ea636..de715206ae6a1 100644 --- a/share/man/man4/man4.i386/pcm.4 +++ b/share/man/man4/man4.i386/pcm.4 @@ -23,7 +23,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: pcm.4,v 1.1 1998/08/09 19:42:53 jkh Exp $ +.\" $Id: pcm.4,v 1.1 1998/06/03 14:23:06 lr Exp $ .\" .Dd June 3, 1998 .Dt PCM 4 i386 @@ -32,7 +32,7 @@ .Nm pcm .Nd FreeBSD audio device driver .Sh SYNOPSIS -.Cd "device pcm0 at isa? port? tty irq 5 drq 1 flags 0x15" +.Cd "device pcm0 at isa? port? tty irq 5 drq 1 flags 0x15 vector pcmintr" .Sh DESCRIPTION The .Nm pcm diff --git a/share/man/man4/man4.i386/pcvt.4 b/share/man/man4/man4.i386/pcvt.4 index 96ef474f8e341..c7faf0e92a74e 100644 --- a/share/man/man4/man4.i386/pcvt.4 +++ b/share/man/man4/man4.i386/pcvt.4 @@ -31,7 +31,7 @@ .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .\" @(#)pcvt.4, 3.20, Last Edit-Date: [Sun Apr 2 18:23:39 1995] -.\" $Id: pcvt.4,v 1.12 1998/10/22 14:29:03 bde Exp $ +.\" $Id: pcvt.4,v 1.10 1998/03/12 07:30:35 charnier Exp $ .\" .\" Man page pcvt(4) created after pcvt_ioctl.h on 13-Jan-93 .\" by Joerg Wunsch @@ -65,7 +65,17 @@ see below .Pc .Pp -.Cd "device vt0 at isa? port IO_KBD tty irq 1" +device +.Em vt0 +at +.Em isa? +port +.Dq Em IO_KBD +.Em tty +irq +.Em 1 +vector +.Em pcrint .Sh DESCRIPTION .Ss Overview The diff --git a/share/man/man4/man4.i386/pn.4 b/share/man/man4/man4.i386/pn.4 deleted file mode 100644 index 813fb5d82cfe1..0000000000000 --- a/share/man/man4/man4.i386/pn.4 +++ /dev/null @@ -1,161 +0,0 @@ -.\" Copyright (c) 1997, 1998 -.\" Bill Paul <wpaul@ctr.columbia.edu>. 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. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by Bill Paul. -.\" 4. Neither the name of the author nor the names of any co-contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD -.\" 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. -.\" -.\" $Id: pn.4,v 1.2 1998/12/05 09:31:25 rnordier Exp $ -.\" -.Dd November 7, 1998 -.Dt PN 4 i386 -.Os FreeBSD -.Sh NAME -.Nm pn -.Nd -Lite-On 82c168/82c169 PNIC fast ethernet device driver -.Sh SYNOPSIS -.Cd "device pn0" -.Sh DESCRIPTION -The -.Nm -driver provides support for PCI ethernet adapters and embedded -controllers based on the Lite-On 82c168 and 82c169 fast ethernet -controller chips. This includes the LinkSys LNE100TX, the -Bay Networks Netgear FA310TX revision D1, the Matrox Networks -FastNIC 10/100, certain adapters manufactured by D-Link and -Trendware, and various other commodity fast ethernet cards. -.Pp -The Lite-On chips use bus master DMA and are designed to be -DEC 'tulip' workalikes. Many vendors that formerly based their -designs around the DEC 21x4x devices are now using the PNIC -instead. The chips support both an internal transceiver -and external transceivers via an MII bus. The Lite-On parts are -advertised as being register compatible with the DEC 21x4x -controllers, however there are some differences in the way the -EEPROM and MII access is done. The PNIC controllers support both -10 and 100Mbps speeds in either full or half duplex. -.Pp -The -.Nm -driver supports the following media types: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It autoselect -Enable autoselection of the media type and options. -The user can manually override -the autoselected mode by adding media options to the -.Pa /etc/rc.conf -fine. -.It 10baseT/UTP -Set 10Mbps operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex modes. -.It 100baseTX -Set 100Mbps (fast ethernet) operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex -modes. -.El -.Pp -The -.Nm -driver supports the following media options: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It full-duplex -Force full duplex operation -.It half-duplex -Force half duplex operation. -.El -.Pp -Note that the 100baseTX media type is only available if supported -by the adapter. -For more information on configuring this device, see -.Xr ifconfig 8 . -.Sh DIAGNOSTICS -.Bl -diag -.It "pn%d: couldn't map memory" -A fatal initialization error has occurred. -.It "pn%d: couldn't map interrupt" -A fatal initialization error has occurred. -.It "pn%d: watchdog timeout" -The device has stopped responding to the network, or there is a problem with -the network connection (cable). -.It "pn%d: no memory for rx list" -The driver failed to allocate an mbuf for the receiver ring. -.It "pn%d: no memory for tx list" -The driver failed to allocate an mbuf for the transmitter ring when -allocating a pad buffer or collapsing an mbuf chain into a cluster. -.It "pn%d: chip is in D3 power state -- setting to D0" -This message applies only to adapters which support power -management. Some operating systems place the controller in low power -mode when shutting down, and some PCI BIOSes fail to bring the chip -out of this state before configuring it. The controller loses all of -its PCI configuration in the D3 state, so if the BIOS does not set -it back to full power mode in time, it won't be able to configure it -correctly. The driver tries to detect this condition and bring -the adapter back to the D0 (full power) state, but this may not be -enough to return the driver to a fully operational condition. If -you see this message at boot time and the driver fails to attach -the device as a network interface, you will have to perform second -warm boot to have the device properly configured. -.Pp -Note that this condition only occurs when warm booting from another -operating system. If you power down your system prior to booting -.Fx , -the card should be configured correctly. -.El -.Sh SEE ALSO -.Xr arp 4 , -.Xr netintro 4 , -.Xr ifconfig 8 -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 3.0 . -.Sh AUTHOR -The -.Nm -driver was written by -.An Bill Paul Aq wpaul@ctr.columbia.edu . -.Sh BUGS -The -.Nm -driver currently only supports cards with external transceivers -connected to the PNIC controller via its MII bus. This is because -the author had no boards available for testing which made use of the -internal transceiver. Most of the PNIC implementations on the market -today use an external PHY, so hopefully this will not present any -serious problems. Code to support the internal transceiver may be -added later if hardware becomes available. diff --git a/share/man/man4/man4.i386/ppc.4 b/share/man/man4/man4.i386/ppc.4 deleted file mode 100644 index 91cb2d3b43530..0000000000000 --- a/share/man/man4/man4.i386/ppc.4 +++ /dev/null @@ -1,112 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd March 5, 1998 -.Dt PPC 4 -.Os FreeBSD -.Sh NAME -.Nm ppc -.Nd -Parallel port chipset driver -.Sh SYNOPSIS -.Cd "controller ppc0 at isa? port? tty irq 7" -.Pp -For one or more PPBUS busses: -.Cd "controller ppbus at ppc0" -.Sh DESCRIPTION -The -.Em ppc -driver provides low level support to various parallel port chipsets for the -.Xr ppbus 4 -system. -.Pp -During the probe phasis, ppc detects parallel port chipsets and initialize -private data according to their operating mode: COMPATIBLE, -NIBBLE, PS/2, EPP, ECP and other mixed modes. If a mode is provided at startup -throw the flags variable of the boot interface, the operating mode of the -chipset is forced according to 'flags' and its available modes. -.Pp -During attach phasis, ppc allocates a ppbus structure, initializes it and -calls ppbus attach function. -.Ss Supported flags -.Bl -item -offset indent -.It -bits 0-4: chipset forced mode(s) -.Bd -literal -PPB_COMPATIBLE 0x0 /* Centronics compatible mode */ -PPB_NIBBLE 0x1 /* reverse 4 bit mode */ -PPB_PS2 0x2 /* PS/2 byte mode */ -PPB_EPP 0x4 /* EPP mode, 32 bit */ -PPB_ECP 0x8 /* ECP mode */ -.Ed -.Pp -And any mixed values. -.It -bit 5: EPP protocol (0 EPP 1.9, 1 EPP 1.7) -.It -bit 6: activate IRQ (1 IRQ disabled, 0 IRQ enabled) -.El -.Ss Supported chipsets -Some parallel port chipsets are explicitly supported by ppc: detection and -initialisation code has been written according to specs datasheets. -.Bl -bullet -offset indent -.It -SMC FDC37C665GT and FDC37C666GT chipsets -.It -Natsemi PC873xx-family (PC87332 and PC87306) -.It -Winbond W83877xx-family (W83877F and W83877AF) -.It -SMC-like chipsets with mixed modes (see -.Xr ppbus 4 ) -.El -.Ss Adding support to a new chipset -You may want to add support for the newest chipset your last motherboard was -sold with? For the ISA bus, just retrieve the specs of the chipset and -write the corresponding -.Fn ppc_mychipset_detect "" -function. -Then add an entry to the general purpose -.Fn ppc_detect "" -function. -.Pp -Your -.Fn ppc_mychipset_detect "" -function should ensure that: if the mode field of the -.Va flags -boot variable is not null, then the operating -mode is forced to the given mode and no other mode is available and -ppb->ppb_avm field contains the available modes of the chipset -.Sh SEE ALSO -.Xr ppbus 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/man4.i386/psm.4 b/share/man/man4/man4.i386/psm.4 index ef215f3bf76c9..0c3b7c9a469ae 100644 --- a/share/man/man4/man4.i386/psm.4 +++ b/share/man/man4/man4.i386/psm.4 @@ -24,7 +24,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: psm.4,v 1.12 1998/03/12 07:30:36 charnier Exp $ +.\" $Id: psm.4,v 1.11 1998/01/24 12:14:13 yokota Exp $ .\" .Dd December 3, 1997 .Dt PSM 4 i386 @@ -40,7 +40,7 @@ PS/2 mouse style pointing device driver .Cd "options" \&"KBD_MAXWAIT=N\&" .Cd "options" \&"PSM_DEBUG=N\&" .Cd "options" \&"KBDIO_DEBUG=N\&" -.Cd "device psm0 at isa? port IO_KBD conflicts tty irq 12" +.Cd "device psm0 at isa? port" \&"IO_KBD\&" conflicts tty irq 12 vector psmintr .Sh DESCRIPTION The .Nm @@ -48,7 +48,7 @@ driver provides support for the PS/2 mouse style pointing device. Currently there can be only one .Nm device node in the system. -.Em port IO_KBD +.Em port \&"IO_KBD\&" and .Em conflicts are required, @@ -570,14 +570,15 @@ movement counts as described in .El .Sh EXAMPLE .Dl "options" \&"PSM_HOOKAPM\&" -.Dl "device psm0 at isa? port IO_KBD conflicts tty irq 12" +.Dl "device psm0 at isa? port" \&"IO_KBD\&" conflicts tty irq 12 vector psmintr .Pp Add the .Nm driver to the kernel with the optional code to stimulate the pointing device after the `resume' event. .Pp -.Dl "device psm0 at isa? port IO_KBD conflicts tty flags 0x024 irq 12" +.Dl "device psm0 at isa? port" \&"IO_KBD\&" conflicts tty flags 0x024 irq 12 +.Dl vector psmintr .Pp Set the device resolution high (4) and the acceleration factor to 2. .Sh DIAGNOSTICS diff --git a/share/man/man4/man4.i386/rdp.4 b/share/man/man4/man4.i386/rdp.4 deleted file mode 100644 index fb70f402aa938..0000000000000 --- a/share/man/man4/man4.i386/rdp.4 +++ /dev/null @@ -1,181 +0,0 @@ -.\" -.\" -.\" Copyright (c) 1997 Joerg Wunsch -.\" -.\" 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 DEVELOPERS ``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 DEVELOPERS 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. -.\" -.\" $Id: rdp.4,v 1.1.1.1 1998/12/21 12:43:35 j Exp $ -.\" -.\" -.\" " (emacs disconfusion) -.Dd December 21, 1998 -.Dt RDP 4 i386 -.Os -.Sh NAME -.Nm rdp -.Nd Ethernet driver for RealTek RTL 8002 pocket ethernet -.Sh SYNOPSIS -.Cd "device rdp0 at isa? port 0x378 net irq 7" -.Cd "device rdp0 at isa? port 0x378 net irq 7 flags 0x2" -.Sh DESCRIPTION -The -.Nm -device driver supports RealTek RTL 8002-based pocket ethernet adapters, -connected to a standard parallel port. -.Pp -These adapters seem to belong to the cheaper choices among pocket -ethernet adapters. The RTL 8002 is the central part, containing an -interface to BNC and UTP (10 Mbit/s) media, as well as a host -interface that is designed to talk to standard parallel printer -adapters. For the full ethernet adapter to work, it is completed by -an external RAM used as the Tx and Rx packet buffer (16 K x 4 for the -RTL 8002), and an EEPROM to hold the assigned ethernet hardware -address. For the RTL 8002, the EEPROM can be either a standard 93C46 -serial EEPROM (which seems to be a common choice), or a 74S288 -parallel one. The latter variant needs the device configuration flag -0x1 in order to work. -.Pp -Since standard printer adapters seem to vary wildly among their timing -requirements, there are currently two possible choices for the way -data are being exchanged between the pocket ethernet adapter and the -printer interface. The default is the fastest mode the RTL 8002 -supports. If the printer adapter to use is particularly slow (which -can be noticed by watching the ethernet wire for crippled packets, or -by not seeing correclty received packets), the configuration flag 0x2 -can be set in order to throttle down the -.Nm -driver. Note that in fast mode, the data rate is assymetric, sending -is a little faster (up to two times) than receiving. Rates like 150 -KB/s for sending and 80 KB/s for receiving are common. For slow mode, -both rates are about the same, and in the range of 50 KB/s through 70 -KB/s. As always, your mileage may vary. -.Pp -In case the adapter isn't recognized at boot-time, setting the -.Em bootverbose -flag -.Pq Ql Fl v -might help in diagnosing the reason. Since the RTL 8002 requires -the availability of a working interrupt for the printer adapter (unlike -the -.Xr lpt 4 -driver), the -.Nm -driver fails to attach if the ethernet adapter cannot assert an -interrupt at probe time. -.Pp -The RTL 8002 doesn't support (hardware) multicast. -.Pp -The -.Nm -driver internally sets a flag so it gets probed very early. This way, -it is possible to configure both, an -.Nm -driver as well as an -.Xr lpt 4 -driver into the same kernel. If no RTL 8002 hardware is present, probing -will eventually detect the printer driver. -.Sh DIAGNOSTICS -.Pp -.Dl "rdp0: configured IRQ (7) cannot be asserted by device" -.Pp -The probe routine was unable to get the RTL 8002 asserting an interrupt -request through the printer adapter. -.Pp -.Dl "rdp0: failed to find a valid hardware address in EEPROM" -.Pp -Since there doesn't seem to be a standard place for storing the hardware -ethernet address within the EEPROM, the -.Nm -driver walks the entire (serial) EEPROM contents until it finds something -that looks like a valid ethernet hardware address, based on the IEEE's -OUI assignments. This diagnostic tells the driver was unable to find -one. Note: it might as well be the current adapter is one of the rare -examples with a 74S288 EEPROM, so -.Ql flags 0x1 -should be tried. -.Pp -.Dl "rdp0: Device timeout" -.Pp -After initiating a packet transmission, the ethernet adapter didn't -return a notification of the (successful or failed) transmission. The -hardware is likely to be wedged, and is being reset. -.Pp -.Sh SEE ALSO -.Xr lpt 4 , -.Xr ifconfig 8 -.Sh AUTHORS -This driver was written by -.ie t J\(:org Wunsch, -.el Joerg Wunsch, -based on RealTek's packet driver for the RTL 8002, as well as on some -description of the successor chip, RTL 8012, RealTek was gratefully -providing. -.Sh BUGS -There are certainly many of them. -.Pp -Since the -.Nm -driver wants to probe its hardware at boot-time, the adapter needs -to be present then in order to be detected. -.Pp -Only two out of the eight different speed modes RealTek's packet -driver could handle are implemented. Thus there might be hardware -where even the current slow mode is too fast. -.Pp -There should be a DMA transfer test in the probe routine that figures -out the usable mode automatically. -.Pp -Abusing a standard printer interface for data exchange is error-prone. -Occasional stuck hardware shouldn't surprise too much, hopefully the -timeout routine will catch these cases. Flood-pinging is a good -example of triggering this problem. Likewise, albeit BPF is of course -supported, it's certainly a bad idea attempting to watch a crowded -ethernet wire using promiscuous mode. -.Pp -Since the RTL 8002 has only 4 KB of Rx buffer space (2 x 2 KB are used -as Tx buffers), the usual NFS deadlock with large packets arriving too -quickly could happen if a machine using the -.Nm -driver NFS-mounts some fast server with the standard NFS blocksize of -8 KB. (Since NFS can only retransmit entire NFS packets, the same -packet will be retransmitted over and over again.) -.Pp -The heuristic to find out the ethernet hardware address from the -EEPROM sucks, but seems to be the only sensible generic way that -doesn't depend on the actual location in EEPROM. RealTek's sample -driver placed it directly at address 0, other vendors picked something -like 15, with other junk in front of it that must not be confused with -a valid ethernet address. -.Pp -The driver should support the successor chip RTL 8012, which seems to -be available and used these days. (The RTL 8002 is already somewhat -aged, around 1992/93.) The RTL 8012 offers support for advanced -printer adapter hardware, like bidirectional SPP, or EPP, which could -speed up the transfers substantially. The RTL 8012 also supports -hardware multicast, and has the ability to address 64 K x 4 packet -buffer RAM. -.Pp -The driver should be layered upon the ppc driver, instead of working -standalone, and should be available as a loadable module, so the -device probing can be deferred until the pocket ethernet adapter has -actually been attached. diff --git a/share/man/man4/man4.i386/rl.4 b/share/man/man4/man4.i386/rl.4 deleted file mode 100644 index 32f54c960e637..0000000000000 --- a/share/man/man4/man4.i386/rl.4 +++ /dev/null @@ -1,192 +0,0 @@ -.\" Copyright (c) 1997, 1998 -.\" Bill Paul <wpaul@ctr.columbia.edu>. 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. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by Bill Paul. -.\" 4. Neither the name of the author nor the names of any co-contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD -.\" 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. -.\" -.\" $Id: rl.4,v 1.6 1998/12/07 18:14:30 wpaul Exp $ -.\" -.Dd November 4, 1998 -.Dt RL 4 i386 -.Os FreeBSD -.Sh NAME -.Nm rl -.Nd -RealTek 8129/8139 fast ethernet device driver -.Sh SYNOPSIS -.Cd "device rl0" -.Sh DESCRIPTION -The -.Nm -driver provides support for PCI ethernet adapters and embedded -controllers based on the RealTek 8129 and 8139 fast ethernet controller -chips. This includes the Allied Telesyn AT2550, Genius GF100TXR, -NDC Communications NE100TX-E, OvisLink LEF-8129TX, OvisLink LEF-8139TX, -Netronix Inc. EA-1210 NetEther 10/100, KTX-9130TX 10/100 Fast Ethernet, -Encore ENL832-TX 10/100 M PCI, Longshine LCS-8038TX-R, the -SMC EZ Card 10/100 PCI 1211-TX, and various other cheap adapters. -It also supports the Accton EN1207D which has a -chip labeled MPX5030 (or MPX5038) which appears to be a RealTek workalike. -.Pp -The RealTek controllers use bus master DMA but do not use a -descriptor-based data transfer mechanism. The receiver uses a -single fixed size ring buffer from which packets must be copied -into mbufs. For transmission, there are only four outbound packet -address registers which require all outgoing packets to be stored -as contiguous buffers. Furthermore, outbound packet buffers must -be longword aligned or else transmission will fail. -.Pp -The 8129 differs from the 8139 in that the 8139 has an internal -PHY which is controlled through special direct access registers -whereas the 8129 uses an external PHY via an MII bus. The 8139 -supports both 10 and 100Mbps speeds in either full or half duplex. -The 8129 can support the same speeds and modes given an appropriate -PHY chip. -.Pp -The -.Nm -driver supports the following media types: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It autoselect -Enable autoselection of the media type and options. This is only -supported if the PHY chip attached to the RealTek controller -supports NWAY autonegotiation. The user can manually override -the autoselected mode by adding media options to the -.Pa /etc/rc.conf -fine. -.It 10baseT/UTP -Set 10Mbps operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex modes. -.It 100baseTX -Set 100Mbps (fast ethernet) operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex -modes. -.El -.Pp -The -.Nm -driver supports the following media options: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It full-duplex -Force full duplex operation -.It half-duplex -Force half duplex operation. -.El -.Pp -Note that the 100baseTX media type is only available if supported -by the adapter. -For more information on configuring this device, see -.Xr ifconfig 8 . -.Sh DIAGNOSTICS -.Bl -diag -.It "rl%d: couldn't map memory" -A fatal initialization error has occurred. -.It "rl%d: couldn't map interrupt" -A fatal initialization error has occurred. -.It "rl%d: watchdog timeout" -The device has stopped responding to the network, or there is a problem with -the network connection (cable). -.It "rl%d: no memory for rx list" -The driver failed to allocate an mbuf for the receiver ring. -.It "rl%d: no memory for tx list" -The driver failed to allocate an mbuf for the transmitter ring when -allocating a pad buffer or collapsing an mbuf chain into a cluster. -.It "rl%d: chip is in D3 power state -- setting to D0" -This message applies only to adapters which support power -management. Some operating systems place the controller in low power -mode when shutting down, and some PCI BIOSes fail to bring the chip -out of this state before configuring it. The controller loses all of -its PCI configuration in the D3 state, so if the BIOS does not set -it back to full power mode in time, it won't be able to configure it -correctly. The driver tries to detect this condition and bring -the adapter back to the D0 (full power) state, but this may not be -enough to return the driver to a fully operational condition. If -you see this message at boot time and the driver fails to attach -the device as a network interface, you will have to perform second -warm boot to have the device properly configured. -.Pp -Note that this condition only occurs when warm booting from another -operating system. If you power down your system prior to booting -.Fx , -the card should be configured correctly. -.El -.Sh SEE ALSO -.Xr arp 4 , -.Xr netintro 4 , -.Xr ifconfig 8 -.Rs -.%B The RealTek 8129 and 8139 datasheets -.%O ftp.realtek.com.tw:/lancard/data sheet -.Re -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 3.0 . -.Sh AUTHOR -The -.Nm -driver was written by -.An Bill Paul Aq wpaul@ctr.columbia.edu . -.Sh BUGS -Since outbound packets must be longword aligned, the transmit -routine has to copy an unaligned packet into an mbuf cluster buffer -before transmission. The driver abuses the fact that the cluster buffer -pool is allocated at system startup time in a contiguous region starting -at a page boundary. Since cluster buffers are 2048 bytes, they are -longword aligned by definition. The driver probably should not be -depending on this characteristic. -.Pp -The RealTek data sheets are of especially poor quality: the grammar -and spelling are awful and there is a lot of information missing, -particularly concerning the receiver operation. One particularly -important fact that the data sheets fail to mention relates to the -way in which the chip fills in the receive buffer. When an interrupt -is posted to signal that a frame has been received, it is possible that -another frame might be in the process of being copied into the receive -buffer while the driver is busy handling the first one. If the driver -manages to finish processing the first frame before the chip is done -DMAing the rest of the next frame, the driver may attempt to process -the next frame in the buffer before the chip has had a chance to finish -DMAing all of it. -.Pp -The driver can check for an incomplete frame by inspecting the frame -length in the header preceeding the actual packet data: an incomplete -frame will have the magic length of 0xFFF0. When the driver encounters -this value, it knows that it has finished processing all currently -available packets. Neither this magic value nor its significance are -documented anywhere in the RealTek data sheets. diff --git a/share/man/man4/man4.i386/sb.4 b/share/man/man4/man4.i386/sb.4 index 9c74e9e86f03a..4ec2bfcb5887a 100644 --- a/share/man/man4/man4.i386/sb.4 +++ b/share/man/man4/man4.i386/sb.4 @@ -23,7 +23,7 @@ For all sound cards supported with the sb driver this is needed: .Pp For the SoundBlaster, SB Pro, SoundBlaster16, or the Pro Audio Spectrum (emulating SB): -.Cd "device sb0 at isa? port 0x220 irq 7 drq 1" +.Cd "device sb0 at isa? port 0x220 irq 7 drq 1 vector sbintr" .Pp For specific SB16 support: .Cd "device sbxvi0 at isa? drq 5" diff --git a/share/man/man4/man4.i386/sea.4 b/share/man/man4/man4.i386/sea.4 new file mode 100644 index 0000000000000..1e5b1cc1702a7 --- /dev/null +++ b/share/man/man4/man4.i386/sea.4 @@ -0,0 +1,90 @@ +.\"Manual pages for FreeBSD Seagate ST01/02, Future Domain TMC-885, +.\"TMC-950 SCSI driver. +.\" +.\"Copyright 1994, Serge Vakulenko (vak@cronyx.ru) +.\" +.\"Redistribution and use of this document, with or without +.\"modification, are permitted provided redistributions must retain +.\"the above copyright notice and this condition. +.\" +.\" $Id: sea.4,v 1.6 1997/02/22 13:25:40 peter Exp $ +.Dd December 25, 1994 +.Dt SEA 4 i386 +.Os FreeBSD +.Sh NAME +.Nm sea +.Nd +Seagate ST01/ST02, Future Domain TMC-885, TMC-950 SCSI adapter driver +.Sh SYNOPSIS +With explicit memory and IRQ parameters: +.Cd "controller sea0 at isa? bio irq 5 iomem 0xc8000 vector seaintr +.Pp +With automatic memory address detection and no IRQ: +.Cd "controller sea0 at isa? +.Pp +.Cd "controller scbus0 +.Pp +For each connected disk: +.Cd "device sd0 +.Pp +For each connected tape device: +.Cd "device st0 +.Pp +For one or more cdroms: +.Cd "device cd0 +.Sh DESCRIPTION +This driver provides access to SCSI devices connected to Seagate ST01/ST02 or +Future Domain TMC-885, TMC-950 SCSI adapter. +.Pp +It's possible to use the Seagate ST01/ST02 adapter without IRQ line. +The data rate then slightly decreases (by 20-30%). +.Pp +The \fBflags\fP keyword in the configuration file can be used to set +some adapter driver parameters: +.Pp +Bits Description +.br +------------------------------------------ +.br +0x01 Disable SCSI bus parity check. +.Pp +The original Seagate ST02 +BIOS cannot coexist with IDE or any other disk controller +because it does not share BIOS disk drive numbers (80h, 81h) +with others. The probing code of the driver allows using ST02 controller +without BIOS: just unplug the ST02 BIOS chip from the board. +.Pp +Another problem is the floppy adapter on ST02 which could not be +disabled by jumpers. The ST02 adapter it the best as a cheap solution +for attaching the tape and CD-ROM drives, and an extra floppy controller +is just a headache. There exist a simple workaround: cutting off +the AEN signal (A11 contact on ISA connector). AEN then goes high and +disables the floppy adapter port address decoder. +.Pp +Some motherboards also have a problem with ST02 conflicting with IDE during +IDE data write phase. It seems than ST02 makes some noise +on /IOW line. The /IOW line is used only for floppy controller +part of ST02, and because it's rarely needed, cutting off the /IOW +(contact B13) will help. +.Pp +Tested on the following hardware: +.br + Adapter: Seagate ST02 +.br + Disk: HP D1686 +.br +Streamers: Archive Viper 150, Wangtek 5525 +.br + CD-ROMs: Toshiba XM-3401, NEC CDR-25 +.Pp +Maximum data rate is about 270-280 kbytes/sec (on 386DX/40). +.Sh FILES +.Bl -tag -width Pa -compact +.It Pa /sys/i386/isa/seagate.c +driver source +.El +.Sh SEE ALSO +.Xr cd 4 , +.Xr scsi 4 , +.Xr sd 4 , +.Xr st 4 diff --git a/share/man/man4/man4.i386/sio.4 b/share/man/man4/man4.i386/sio.4 index 4cc36bd8e3aa0..de4d3c75767ff 100644 --- a/share/man/man4/man4.i386/sio.4 +++ b/share/man/man4/man4.i386/sio.4 @@ -34,7 +34,7 @@ .\" .\" from: @(#)dca.4 5.2 (Berkeley) 3/27/91 .\" from: com.4,v 1.1 1993/08/06 11:19:07 cgd Exp -.\" $Id: sio.4,v 1.27 1998/06/08 06:11:59 jkoshy Exp $ +.\" $Id: sio.4,v 1.26 1998/05/31 11:16:09 bde Exp $ .\" .Dd October 10, 1995 .Dt SIO 4 i386 @@ -45,23 +45,23 @@ fast interrupt driven asynchronous serial communications interface .Sh SYNOPSIS For standard ports: -.Cd "device sio0 at isa? port" \&"IO_COM1\&" tty irq 4 -.Cd "device sio1 at isa? port" \&"IO_COM2\&" tty irq 3 -.Cd "device sio2 at isa? port" \&"IO_COM3\&" tty irq 5 -.Cd "device sio3 at isa? port" \&"IO_COM4\&" tty irq 9 +.Cd "device sio0 at isa? port" \&"IO_COM1\&" tty irq 4 vector siointr +.Cd "device sio1 at isa? port" \&"IO_COM2\&" tty irq 3 vector siointr +.Cd "device sio2 at isa? port" \&"IO_COM3\&" tty irq 5 vector siointr +.Cd "device sio3 at isa? port" \&"IO_COM4\&" tty irq 9 vector siointr .Pp For AST compatible multiport cards with 4 ports: .Cd "options" \&"COM_MULTIPORT\&" .Cd "device sio4 at isa? port 0x2a0 tty flags 0x701" .Cd "device sio5 at isa? port 0x2a8 tty flags 0x701" .Cd "device sio6 at isa? port 0x2b0 tty flags 0x701" -.Cd "device sio7 at isa? port 0x2b8 tty flags 0x701 irq 12" +.Cd "device sio7 at isa? port 0x2b8 tty flags 0x701 irq 12 vector siointr" .Pp For Boca Board compatible multiport cards with 8 ports: .Cd "options" \&"COM_MULTIPORT\&" .Cd "device sio4 at isa? port 0x100 tty flags 0xb05" .Cd "..." -.Cd "device sio11 at isa? port 0x138 tty flags 0xb05 irq 12" +.Cd "device sio11 at isa? port 0x138 tty flags 0xb05 irq 12 vector siointr" .Pp For Hayes ESP cards: .Cd "options" \&"COM_ESP\&" @@ -161,7 +161,9 @@ The same master port must be specified for all ports in a group. .Pp The .Em irq -specification must be given for master ports +and +.Em vector +specifications must be given for master ports and for ports that are not part of an IRQ sharing group, and not for other ports. .Pp diff --git a/share/man/man4/man4.i386/sr.4 b/share/man/man4/man4.i386/sr.4 index 8c84f6fec0f54..c4d31d3228eaa 100644 --- a/share/man/man4/man4.i386/sr.4 +++ b/share/man/man4/man4.i386/sr.4 @@ -28,7 +28,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: sr.4,v 1.9 1998/06/08 06:11:59 jkoshy Exp $ +.\" $Id: sr.4,v 1.8 1998/03/12 07:30:38 charnier Exp $ .\" .Dd July 4, 1996 .Dt SR 4 i386 @@ -37,8 +37,8 @@ .Nm sr .Nd synchronous RISCom/N2 / WANic 400/405 device driver. .Sh SYNOPSIS -.Cd "device sr0 at isa? port 0x300 net irq 10 iomem 0xd0000" -.Cd "device sr1 at isa? port 0x310 net irq 11 flags 0x1 iomem 0xd0000" +.Cd "device sr0 at isa? port 0x300 net irq 10 iomem 0xd0000 vector srintr" +.Cd "device sr1 at isa? port 0x310 net irq 11 flags 0x1 iomem 0xd0000 vector srintr" .Pp .Cd "pseudo-device sppp" .Sh DESCRIPTION diff --git a/share/man/man4/man4.i386/tl.4 b/share/man/man4/man4.i386/tl.4 index b967d5ea4a600..7491592c2b0eb 100644 --- a/share/man/man4/man4.i386/tl.4 +++ b/share/man/man4/man4.i386/tl.4 @@ -28,7 +28,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF .\" THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: tl.4,v 1.1 1998/05/21 03:20:39 wpaul Exp $ +.\" $Id: tl.4,v 1.3 1998/05/06 05:40:56 wpaul Exp $ .\" .Dd May 1, 1998 .Dt TL 4 i386 @@ -105,7 +105,7 @@ the network connection (cable). .It "tl%d: no memory for rx list" The driver failed to allocate an mbuf for the receiver ring. .It "tl%d: no memory for tx list" -The driver failed to allocate an mbuf for the transmitter ring when +The driver fauled to allocate an mbuf for the transmitter ring when allocating a pad buffer or collapsing an mbuf chain into a cluster. .El .Sh SEE ALSO diff --git a/share/man/man4/man4.i386/tx.4 b/share/man/man4/man4.i386/tx.4 index 329ce0c878aab..2a12c0390857b 100644 --- a/share/man/man4/man4.i386/tx.4 +++ b/share/man/man4/man4.i386/tx.4 @@ -79,7 +79,7 @@ While reseting, driver failed to stop device correctly. .Sh BUGS .Pp The multicast packets filtering is not supported. -Only one PHY was really tested (Quality Semiconductor QS6612). +Only one PHY was realy tested (Quality Semiconductor QS6612). .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , diff --git a/share/man/man4/man4.i386/uha.4 b/share/man/man4/man4.i386/uha.4 new file mode 100644 index 0000000000000..f51f121afe787 --- /dev/null +++ b/share/man/man4/man4.i386/uha.4 @@ -0,0 +1,73 @@ +.\" +.\" Copyright (c) 1994 Wilko Bulte +.\" 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. +.\" 3. The name of the author may not be used to endorse or promote products +.\" derived from this software withough specific prior written permission +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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. +.\" +.\" $Id: uha.4,v 1.8 1997/02/22 13:25:45 peter Exp $ +.Dd August 31, 1994 +.Dt UHA 4 i386 +.Os FreeBSD +.Sh NAME +.Nm uha +.Nd +UltraStor SCSI host adapter driver +.Sh SYNOPSIS +For ULTRA 24F controllers in EISA mode: +.Cd "controller uha0 at isa? bio irq ? vector uhaintr +.Cd "controller scbus0 +.Pp +For ULTRA 14F and 34F controllers: +.Cd "controller uha0 at isa? port" \&"IO_UHA0\&" bio irq ? drq 5 vector uhaintr +.Cd "controller scbus0 +.Pp +For each disk: +.Cd "device sd0 +.Pp +For each tape device: +.Cd "device st0 +.Pp +For one or more cdroms: +.Cd "device cd0 +.Sh DESCRIPTION +This driver provides access to SCSI devices connected to an UltraStor +ULTRA 14F, ULTRA 24F or ULTRA 34F host adapter. +.Pp +Note that for an ULTRA 24F in EISA mode no I/O addresses or DMA channels +are required in the kernel config file. If they are present, the driver +will correctly find the ULTRA 24F, but you tie up precious DMA channels +and I/O ranges which are not used by the card. +The ULTRA 24F uses EISA slot specific I/O which is configured +automatically. +.Sh FILES +.Bl -tag -width Pa -compact +.It Pa /sys/i386/conf/GENERIC +sample generic kernel config file for Bustek and UltraStor based systems +.It Pa /sys/i386/isa/ultra14f.c +driver source +.El +.Sh SEE ALSO +.Xr cd 4 , +.Xr scsi 4 , +.Xr sd 4 , +.Xr st 4 diff --git a/share/man/man4/man4.i386/vr.4 b/share/man/man4/man4.i386/vr.4 deleted file mode 100644 index ee4a2b598a098..0000000000000 --- a/share/man/man4/man4.i386/vr.4 +++ /dev/null @@ -1,164 +0,0 @@ -.\" Copyright (c) 1997, 1998 -.\" Bill Paul <wpaul@ctr.columbia.edu>. 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. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by Bill Paul. -.\" 4. Neither the name of the author nor the names of any co-contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD -.\" 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. -.\" -.\" $Id: vr.4,v 1.1 1998/12/04 18:01:22 wpaul Exp $ -.\" -.Dd November 22, 1998 -.Dt VR 4 i386 -.Os FreeBSD -.Sh NAME -.Nm vr -.Nd -VIA Technologies VT3043 and VT86C100A ethernet device driver -.Sh SYNOPSIS -.Cd "device vr0" -.Sh DESCRIPTION -The -.Nm -driver provides support for PCI ethernet adapters and embedded -controllers based on the VIA Technologies VT3043 Rhine I and -VT86C100A Rhine II fast ethernet controller chips. This includes -the D-Link DFE530-TX and various other commodity fast ethernet -cards. -.Pp -The VIA Rhine chips use bus master DMA and have a software interface -designed to resemble that of the DEC 21x4x "tulip" chips. The major -differences are that the receive filter in the Rhine chips is -much simpler and is programmed through registers rather than by -downloading a special setup frame through the transmit DMA engine, -and that transmit and receive DMA buffers must be longword -aligned. The Rhine chips are meant to be interfaced with external -physical layer devices via an MII bus. They support both -10 and 100Mbps speeds in either full or half duplex. -.Pp -The -.Nm -driver supports the following media types: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It autoselect -Enable autoselection of the media type and options. -The user can manually override -the autoselected mode by adding media options to the -.Pa /etc/rc.conf -fine. -.It 10baseT/UTP -Set 10Mbps operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex modes. -.It 100baseTX -Set 100Mbps (fast ethernet) operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex -modes. -.El -.Pp -The -.Nm -driver supports the following media options: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It full-duplex -Force full duplex operation -.It half-duplex -Force half duplex operation. -.El -.Pp -Note that the 100baseTX media type is only available if supported -by the adapter. -For more information on configuring this device, see -.Xr ifconfig 8 . -.Sh DIAGNOSTICS -.Bl -diag -.It "vr%d: couldn't map memory" -A fatal initialization error has occurred. -.It "vr%d: couldn't map interrupt" -A fatal initialization error has occurred. -.It "vr%d: watchdog timeout" -The device has stopped responding to the network, or there is a problem with -the network connection (cable). -.It "vr%d: no memory for rx list" -The driver failed to allocate an mbuf for the receiver ring. -.It "vr%d: no memory for tx list" -The driver failed to allocate an mbuf for the transmitter ring when -allocating a pad buffer or collapsing an mbuf chain into a cluster. -.It "vr%d: chip is in D3 power state -- setting to D0" -This message applies only to adapters which support power -management. Some operating systems place the controller in low power -mode when shutting down, and some PCI BIOSes fail to bring the chip -out of this state before configuring it. The controller loses all of -its PCI configuration in the D3 state, so if the BIOS does not set -it back to full power mode in time, it won't be able to configure it -correctly. The driver tries to detect this condition and bring -the adapter back to the D0 (full power) state, but this may not be -enough to return the driver to a fully operational condition. If -you see this message at boot time and the driver fails to attach -the device as a network interface, you will have to perform second -warm boot to have the device properly configured. -.Pp -Note that this condition only occurs when warm booting from another -operating system. If you power down your system prior to booting -.Fx , -the card should be configured correctly. -.El -.Sh SEE ALSO -.Xr arp 4 , -.Xr netintro 4 , -.Xr ifconfig 8 -.Rs -.%T The VIA Technologies VT86C100A data sheet -.%O http://www.via.com.tw -.Re -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 3.0 . -.Sh AUTHOR -The -.Nm -driver was written by -.An Bill Paul Aq wpaul@ctr.columbia.edu . -.Sh BUGS -The -.Nm -driver always copies transmit mbuf chains into longword-aligned -buffers prior to transmission in order to pacify the Rhine chips. -If buffers are not aligned correctly, the chip will round the -supplied buffer address and begin DMAing from the wrong location. -This buffer copying impairs transmit performance on slower systems but can't -be avoided. On faster machines (e.g. a Pentium II), the performance -impact is much less noticable. diff --git a/share/man/man4/man4.i386/wb.4 b/share/man/man4/man4.i386/wb.4 deleted file mode 100644 index d7171b6151901..0000000000000 --- a/share/man/man4/man4.i386/wb.4 +++ /dev/null @@ -1,159 +0,0 @@ -.\" Copyright (c) 1997, 1998 -.\" Bill Paul <wpaul@ctr.columbia.edu>. 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. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by Bill Paul. -.\" 4. Neither the name of the author nor the names of any co-contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD -.\" 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. -.\" -.\" $Id: wb.4,v 1.1 1998/12/04 18:01:22 wpaul Exp $ -.\" -.Dd November 4, 1998 -.Dt WB 4 i386 -.Os FreeBSD -.Sh NAME -.Nm wb -.Nd -Winbond W89C840F fast ethernet device driver -.Sh SYNOPSIS -.Cd "device wb0" -.Sh DESCRIPTION -The -.Nm -driver provides support for PCI ethernet adapters and embedded -controllers based on the Winbond W89C840F fast ethernet controller -chip. This includes the Trendware TE100-PCIE and various other cheap -boards. The 840F should not be confused with the 940F, which is -an NE2000 clone and only supports 10Mbps speeds. -.Pp -The Winbond controller uses bus master DMA and is designed to be -a DEC 'tulip' workalike. It differs from the standard DEC design -in several ways: the control and status registers are spaced 4 -bytes apart instead of 8, and the receive filter is programmed through -registers rather than by downloading a special setup frame via -the transmit DMA engine. Using an external PHY, the Winbond chip -supports both 10 and 100Mbps speeds in either full or half duplex. -.Pp -The -.Nm -driver supports the following media types: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It autoselect -Enable autoselection of the media type and options. This is only -supported if the PHY chip attached to the Winbond controller -supports NWAY autonegotiation. The user can manually override -the autoselected mode by adding media options to the -.Pa /etc/rc.conf -fine. -.It 10baseT/UTP -Set 10Mbps operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex modes. -.It 100baseTX -Set 100Mbps (fast ethernet) operation. The -.Ar mediaopt -option can also be used to select either -.Ar full-duplex -or -.Ar half-duplex -modes. -.El -.Pp -The -.Nm -driver supports the following media options: -.Pp -.Bl -tag -width xxxxxxxxxxxxxxxxxxxx -.It full-duplex -Force full duplex operation -.It half-duplex -Force half duplex operation. -.El -.Pp -Note that the 100baseTX media type is only available if supported -by the adapter. -For more information on configuring this device, see -.Xr ifconfig 8 . -.Sh DIAGNOSTICS -.Bl -diag -.It "wb%d: couldn't map memory" -A fatal initialization error has occurred. -.It "wb%d: couldn't map interrupt" -A fatal initialization error has occurred. -.It "wb%d: watchdog timeout" -The device has stopped responding to the network, or there is a problem with -the network connection (cable). -.It "wb%d: no memory for rx list" -The driver failed to allocate an mbuf for the receiver ring. -.It "wb%d: no memory for tx list" -The driver failed to allocate an mbuf for the transmitter ring when -allocating a pad buffer or collapsing an mbuf chain into a cluster. -.It "wb%d: chip is in D3 power state -- setting to D0" -This message applies only to adapters which support power -management. Some operating systems place the controller in low power -mode when shutting down, and some PCI BIOSes fail to bring the chip -out of this state before configuring it. The controller loses all of -its PCI configuration in the D3 state, so if the BIOS does not set -it back to full power mode in time, it won't be able to configure it -correctly. The driver tries to detect this condition and bring -the adapter back to the D0 (full power) state, but this may not be -enough to return the driver to a fully operational condition. If -you see this message at boot time and the driver fails to attach -the device as a network interface, you will have to perform second -warm boot to have the device properly configured. -.Pp -Note that this condition only occurs when warm booting from another -operating system. If you power down your system prior to booting -.Fx , -the card should be configured correctly. -.El -.Sh SEE ALSO -.Xr arp 4 , -.Xr netintro 4 , -.Xr ifconfig 8 -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 3.0 . -.Sh AUTHOR -The -.Nm -driver was written by -.An Bill Paul Aq wpaul@ctr.columbia.edu . -.Sh BUGS -The Winbond chip seems to behave strangely in some cases when the -link partner switches modes. If for example both sides are set to -10Mbps half-duplex, and the other end is changed to 100Mbps -full-duplex, the Winbond's receiver suddenly starts writing trash -all over the RX descriptors. The -.Nm -driver handles this by forcing a reset of both the controller -chip and attached PHY. This is drastic, but it appears to be the -only way to recover properly from this condition. diff --git a/share/man/man4/man4.i386/wd.4 b/share/man/man4/man4.i386/wd.4 index 27547cedcf8d6..123f53b8650ad 100644 --- a/share/man/man4/man4.i386/wd.4 +++ b/share/man/man4/man4.i386/wd.4 @@ -24,7 +24,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: wd.4,v 1.9 1998/06/08 06:11:59 jkoshy Exp $ +.\" $Id: wd.4,v 1.8 1998/04/09 22:31:47 sos Exp $ .\" .Dd August 31, 1994 .Dt WD 4 i386 @@ -34,7 +34,7 @@ .Nd Generic WD100x/IDE diskcontroller driver .Sh SYNOPSIS -.Cd "controller wdc0 at isa? port" \&"IO_WD1\&" bio irq 14 +.Cd "controller wdc0 at isa? port" \&"IO_WD1\&" bio irq 14 vector wdintr .Cd "disk wd0 at wdc0 drive 0 .Cd "disk wd1 at wdc0 drive 1 .Pp diff --git a/share/man/man4/man4.i386/wl.4 b/share/man/man4/man4.i386/wl.4 index 336380f118a28..f954ccbed10fe 100644 --- a/share/man/man4/man4.i386/wl.4 +++ b/share/man/man4/man4.i386/wl.4 @@ -28,7 +28,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: wl.4,v 1.5 1998/08/31 16:41:07 wosch Exp $ +.\" $Id: wl.4,v 1.4 1998/06/08 06:11:59 jkoshy Exp $ .Dd July 7, 1997 .Dt WL 4 i386 .Os FreeBSD @@ -36,7 +36,7 @@ .Nm wl .Nd T1 speed ISA/radio lan card .Sh SYNOPSIS -.Cd "device wl0 at isa? port 0x300 net irq 5" +.Cd "device wl0 at isa? port 0x300 net irq 5 vector wlintr" .Sh DESCRIPTION The .Nm wl diff --git a/share/man/man4/man4.i386/wt.4 b/share/man/man4/man4.i386/wt.4 index b83d6b4d433ab..3db0f92ad4914 100644 --- a/share/man/man4/man4.i386/wt.4 +++ b/share/man/man4/man4.i386/wt.4 @@ -21,7 +21,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: wt.4,v 1.3 1997/03/07 02:50:01 jmg Exp $ +.\" $Id$ .\" .Dd July 10, 1995 .Dt WT 4 i386 @@ -31,7 +31,7 @@ .Nd Archive/Wangtek cartridge tape driver .Sh SYNOPSIS -.Cd "device wt0 at isa? port 0x300 bio irq 5 drq 1" +.Cd "device wt0 at isa? port 0x300 bio irq 5 drq 1 vector wtintr" .Sh DESCRIPTION The .Nm wt diff --git a/share/man/man4/man4.i386/xl.4 b/share/man/man4/man4.i386/xl.4 index cb2ca676b192c..2d62c23f1ab1b 100644 --- a/share/man/man4/man4.i386/xl.4 +++ b/share/man/man4/man4.i386/xl.4 @@ -28,7 +28,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF .\" THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: xl.4,v 1.2 1998/12/05 09:31:25 rnordier Exp $ +.\" $Id: tl.4,v 1.3 1998/05/06 05:40:56 wpaul Exp $ .\" .Dd August 16, 1998 .Dt XL 4 i386 @@ -47,7 +47,7 @@ controllers based on the 3Com "boomerang" and "cyclone" bus-master Etherlink XL chips. This includes the 3c900-TP, 3c900-COMBO, 3c905-TX, 3c905-T4, 3c905B-TP, 3c905B-T4 and 3c905B-TX, and embedded 3c905-TX and 3c905B-TX ethernet hardware in certain Dell Optiplex and Dell -Precision desktop machines, and certain Dell Latitude laptop docking +Precision dexktop machines, and certain Dell Latitude laptop docking stations. .Pp The Etherlink XL chips support built-in 10baseT, 10base2 and 10base5 @@ -121,10 +121,10 @@ the network connection (cable). .It "xl%d: no memory for rx list" The driver failed to allocate an mbuf for the receiver ring. .It "xl%d: no memory for tx list" -The driver failed to allocate an mbuf for the transmitter ring when +The driver fauled to allocate an mbuf for the transmitter ring when allocating a pad buffer or collapsing an mbuf chain into a cluster. .It "xl%d: command never completed!" -Some commands issued to the 3c90x ASIC take time to complete: the +Some commands issued ot the 3c90x ASIC take time to complete: the driver is supposed to wait until the 'command in progress' bit in the status register clears before continuing. In rare instances, this bit may not clear. To avoid getting caught in an infinite wait loop, diff --git a/share/man/man4/man4.i386/ze.4 b/share/man/man4/man4.i386/ze.4 index bfce5f106ca40..7326561a8f44d 100644 --- a/share/man/man4/man4.i386/ze.4 +++ b/share/man/man4/man4.i386/ze.4 @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: ze.4,v 1.5 1998/03/12 07:30:40 charnier Exp $ +.\" $Id: ze.4,v 1.4 1997/03/21 20:14:00 mpp Exp $ .\" .Dd January 19, 1997 .Dt ZE 4 i386 @@ -33,7 +33,7 @@ .Nd IBM/National Semiconductor PCMCIA Ethernet device driver .Sh SYNOPSIS -.Cd "device ze0 at isa? port 0x300 net irq 5 iomem 0xd8000" +.Cd "device ze0 at isa? port 0x300 net irq 5 iomem 0xd8000 vector zeintr" .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/man4.i386/zp.4 b/share/man/man4/man4.i386/zp.4 index b25ed472d056f..518a73fff6bc5 100644 --- a/share/man/man4/man4.i386/zp.4 +++ b/share/man/man4/man4.i386/zp.4 @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: zp.4,v 1.4 1998/03/12 07:30:40 charnier Exp $ +.\" $Id: zp.4,v 1.3 1997/02/22 13:25:46 peter Exp $ .\" .Dd January 19, 1997 .Dt ZP 4 i386 @@ -33,7 +33,7 @@ .Nd 3Com PCMCIA Etherlink III Ethernet device driver .Sh SYNOPSIS -.Cd "device zp0 at isa? port 0x300 net irq 10 iomem 0xd8000" +.Cd "device zp0 at isa? port 0x300 net irq 10 iomem 0xd8000 vector zpintr" .Sh DESCRIPTION The .Nm diff --git a/share/man/man4/plip.4 b/share/man/man4/plip.4 deleted file mode 100644 index 63674adab9bbc..0000000000000 --- a/share/man/man4/plip.4 +++ /dev/null @@ -1,71 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd March 5, 1998 -.Dt PLIP 4 -.Os FreeBSD -.Sh NAME -.Nm plip -.Nd -Parallel port network interface -.Sh SYNOPSIS -.Cd "device plip at ppbus?" -.Sh DESCRIPTION -The -.Em plip -driver is the port of the -.Xr lp 4 -driver to the -.Xr ppbus 4 -system. -.Pp -One purpose of this port is to allow parallel port sharing with other -parallel devices. Parallel port bus allocation has been added to the original -.Xr lp 4 -driver. Secondly, inb()/outb() calls have been replaced by ppbus function -calls. plip is now arch-independent thanks to the ppbus interface. See -.Xr ppbus 4 -for more info about the ppbus system. -.Pp -The ppbus is allocated when the parallel network interface comes up, then -released when the interface goes down. Consequently, the parallel port bus -is unavailable to other devices when the network interface is up. plip is -interrupt driven and needs to own the bus to receive parallel port interrupts. -.Pp -Please, ensure the -.Xr ppc 4 -entry in you MACHINE file has the net interrupt level... -.Sh SEE ALSO -.Xr ppbus 4 , -.Xr lp 4 , -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/ppbus.4 b/share/man/man4/ppbus.4 deleted file mode 100644 index 74a06bdd9bcc0..0000000000000 --- a/share/man/man4/ppbus.4 +++ /dev/null @@ -1,315 +0,0 @@ -.\" Copyright (c) 1998, 1999 Nicolas Souchu -.\" 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. -.\" -.\" -.Dd March 1, 1998 -.Dt PPBUS 4 -.Os FreeBSD -.Sh NAME -.Nm ppbus -.Nd -Parallel port bus system -.Sh SYNOPSIS -.Cd "controller ppbus0" -.Pp -.Cd "controller vpo0 at ppbus?" -.Pp -.Cd "device nlpt0 at ppbus?" -.Cd "device plip0 at ppbus?" -.Cd "device ppi0 at ppbus?" -.Cd "device pps0 at ppbus?" -.Cd "device lpbb0 at ppbus?" -.Sh DESCRIPTION -The -.Em ppbus -system provides a uniform, modular and architecture-independent -system for the implementation of drivers to control various parallel devices, -and to utilize different parallel port chipsets. -.Sh DEVICE DRIVERS -In order to write new drivers or port existing drivers, the ppbus system -provides the following facilities: -.Bl -bullet -item -offset indent -.It -architecture-independent macros or functions to access parallel ports -.It -mechanism to allow various devices to share the same parallel port -.It -a user interface named -.Xr ppi 4 -that allows parallel port access from outside the kernel without confliting -with kernel-in drivers. -.El -.Ss Developing new drivers -.Pp -The ppbus system has been designed to support the development of standard -and non-standard software: -.Pp -.Bl -column "Driver" -compact -.It Em Driver Ta Em Description -.It Sy vpo Ta "VPI0 parallel to Adaptec AIC-7110 SCSI controller driver." -It uses standard and non-standard parallel port accesses -.It Sy ppi Ta "Parallel port interface for general I/O" -.It Sy pps Ta "Pulse per second Timing Interface" -.It Sy lpbb Ta "Philips official parallel port I2C bit-banging interface" -.El -.Ss Porting existing drivers -.Pp -Another approach to the ppbus system is to port existing drivers. -Various drivers have already been ported: -.Pp -.Bl -column "Driver" -compact -.It Em Driver Ta Em Description -.It Sy nlpt Ta "lpt printer driver" -.It Sy plip Ta "lp parallel network interface driver" -.El -.Pp -ppbus should let you port any other software even from other operating systems -that provide similar services. -.Sh PARALLEL PORT CHIPSETS -Parallel port chipset support is provided by -.Xr ppc 4 . -.Pp -The ppbus system provides functions and macros to allocate a new -parallel port bus, then initialize it and upper peripheral device drivers. -.Pp -ppc makes chipset detection and initialisation and then calls ppbus attach -functions to initialize the ppbus system. -.Sh PARALLEL PORT MODEL -The logical parallel port model chosen for the ppbus system is the PC's -parallel port model. Consequently, for the i386 implementation of ppbus, -most of the services provided by ppc are macros for inb() -and outb() calls. But, for an other architecture, accesses to one of our logical -registers (data, status, control...) may require more than one I/O access. -.Ss Description -The parallel port may operate in the following modes: -.Bl -bullet -item -offset indent -.It -compatible mode, also called Centronics mode -.It -bidirectional 8/4-bits mode, also called NIBBLE mode -.It -byte mode, also called PS/2 mode -.It -Extended Capability Port mode, ECP -.It -Enhanced Parallel Port mode, EPP -.It -mixed ECP+EPP or ECP+PS/2 modes -.El -.Ss Compatible mode -This mode defines the protocol used by most PCs to transfer data to a printer. -In this mode, data is placed on the port's data lines, the printer status is -checked for no errors and that it is not busy, and then a data Strobe is -generated by the sofware to clock the data to the printer. -.Pp -Many I/O controllers have implemented a mode that uses a FIFO buffer to -transfer data with the Compatibility mode protocol. This mode is referred to as -"Fast Centronics" or "Parallel Port FIFO mode". -.Ss Bidirectional mode -The NIBBLE mode is the most common way to get reverse channel data from a -printer or peripheral. Combined with the standard host to printer mode, it -provides a complete bidirectional channel. -.Pp -In this mode, outputs are 8-bits long. Inputs are accomplished by reading -4 of the 8 bits of the status register. -.Ss Byte mode -In this mode, the data register is used either for outputs and inputs. Then, -any transfer is 8-bits long. -.Ss Extended Capability Port mode -The ECP protocol was proposed as an advanced mode for communication with -printer and scanner type peripherals. Like the EPP protocol, ECP mode provides -for a high performance bidirectional communication path between the host -adapter and the peripheral. -.Pp -ECP protocol features include: -.Bl -item -offset indent -.It -Run_Length_Encoding (RLE) data compression for host adapters -.It -FIFOs for both the forward and reverse channels -.It -DMA as well as programmed I/O for the host register interface. -.El -.Ss Enhanced Parallel Port mode -The EPP protocol was originally developed as a means to provide a high -performance parallel port link that would still be compatible with the -standard parallel port. -.Ss Mixed modes -Some manufacturers, like SMC, have implemented chipsets that support mixed -modes. With such chipsets, mode switching is available at any time by -accessing the extended control register. -.Sh IEEE1284-1994 Standard -.Ss Background -This standard is also named "IEEE Standard Signaling Method for a -Bidirectional Parallel Peripheral Interface for Personal Computers". It -defines a signaling method for asynchroneous, fully interlocked, bidirectional -parallel communications between hosts and printers or other peripherals. It -also specifies a format for a peripheral identification string and a method of -returning this string to the host outside of the bidirectional data stream. -.Pp -This standard is architecture independent and only specifiy dialog handshake -at signal level. One should refer to any architecture specific document in -order to manipulate machine dependent registers, mapped memory or whatelse -to control these signals. -.Pp -The IEEE1284 protocol is fully oriented with all supported parallel port -modes. The computer acts as master and the peripheral as slave. -.Pp -Any transfer is defined as a finite state automate. It allows software to -properly manage the fully interlocked scheme of the signaling method. -The compatible mode is supported "as is" without any negociation because it -is compatible. Any other mode must be firstly negociated by the host to check -it is supported by the peripheral, then to enter one of the forward idle -states. -.Pp -At any time, the slave may want to send data to the host. This is only -possible from forward idle states (nibble, byte, ecp...). So, the -host must have previously negociated to permit the peripheral to -request transfer. Interrupt lines may be dedicated to the requesting signals -to prevent time consuming polling methods. -.Pp -But peripheral requests are only a hint to the master host. If the host -accepts the transfer, it must firstly negociate the reverse mode and then -starts the transfer. At any time during reverse transfer, the host may -terminate the transfer or the slave may drive wires to signal that no more -data is available. -.Ss Implementation -IEEE1284 Standard support has been implemented at the top of the ppbus system -as a set of procedures that perform high level functions like negociation, -termination, transfer in any mode without bothering you with low level -caracteristics of the stantdard. -.Pp -IEEE1284 interacts with the ppbus system as least as possible. That means -you still have to request the ppbus when you want to access it, the negociate -function doesn't do it for you. And of course, release it later. -.Sh ARCHITECTURE -.Ss adapter, ppbus and device layers -First, there is the -.Em adapter -layer, the lowest of the ppbus system. It provides -chipset abstraction throw a set of low level functions that maps the logical -model to the underlying hardware. -.Pp -Secondly, there is the -.Em ppbus -layer that provides functions to: -.Bl -enum -offset indent -.It -share the parallel port bus among the daisy-chain like connected devices -.It -manage devices linked to ppbus -.It -propose an arch-independent interface to access the hardware layer. -.El -.Pp -Finaly, the -.Em device -layer gathers the parallel peripheral device drivers. -.Pp -Each layer has its own C structure respectively ppb_adapter, ppb_data and -ppb_device. The ppb_link structure gathers pointers to other structures and -info shared among different layers. -.Pp -See description of these structures in -.Xr ppbconf 9 . -.Ss Parallel modes managment -We have to differenciate operating modes at various ppbus system layers. -Actually, ppbus and adapter operating modes on one hands and for each -one, current and available modes are seperated. -.Pp -With this level of abstraction a particular chipset may commute from any -native mode the any other mode emulated with extended modes without -disturbing upper layers. For example, most chipsets support NIBBLE mode as -native and emulated with ECP and/or EPP. -.Pp -This achitecture should support IEEE1284-1994 modes. -.Sh FEATURES -.Ss The boot process -The boot process starts with the probe phasis of the -.Xr ppc 4 -driver during ISA bus (PC architecture) initialisation. During attachment of -the ppc driver, a new ppbus structure is allocated, initialized -(linked to the adapter structure) then passed to the function -.Fn ppb_attachdevs "struct ppb_data *ppb" . -.Pp -.Fn ppb_attachdevs "" -tries to detect any PnP parallel peripheral (according to -.%T "Plug and Play Parallel Port Devices" -draft from (c)1993-4 Microsoft Corporation) -then probes and attaches known device drivers. -.Pp -During probe, device drivers are supposed to request the ppbus and try to -set their operating mode. This mode will be saved in the context structure and -returned each time the driver requests the ppbus. -.Ss Bus allocation and interrupts -ppbus allocation is mandatory not to corrupt I/O of other devices. An other -usage of ppbus allocation is to reserve the port and receive incoming -interrupts. -.Pp -Interrupts are connected to the -.Fn ppcintr "" -function which delivers them to ppbus directly with a -.Fn ppb_intr "struct ppb_link *pl" -call. ppbus redirects the -interrupt to the bus owner's handler if defined. Consequently, if a device -wants to be delivered an interrupt, it must own the ppbus. -.Ss Microsequences -.Em Microsequences -is a general purpose mechanism to allow fast low-level -manipulation of the parallel port. Microsequences may be used to do either -standard (in IEEE1284 modes) or non-standard transfers. The philosophy of -microsequences is to avoid the overhead of the ppbus layer and do most of -the job at adapter level. -.Pp -A microsequence is an array of opcodes and parameters. Each opcode codes an -operation (opcodes are described in -.Xr microseq 9 ). -Standard I/O operations are implemented at ppbus level whereas basic I/O -operations and microseq langage are coded at adapter level for efficiency. -.Pp -As an example, the -.Xr vpo 4 -driver uses microsequences to implement: -.Bl -bullet -offset indent -.It -a modified version of the NIBBLE transfer mode -.It -various I/O sequences to initialize, select and allocate the peripheral -.El -.Sh SEE ALSO -.Xr ppbconf 9 , -.Xr ppc 4 , -.Xr ppi 4 , -.Xr vpo 4 , -.Xr nlpt 4 , -.Xr plip 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/sl.4 b/share/man/man4/sl.4 index 00a347e091815..c2b8607451d5d 100644 --- a/share/man/man4/sl.4 +++ b/share/man/man4/sl.4 @@ -76,4 +76,4 @@ family; the packet was dropped. .Xr intro 4 , .Xr slattach 8 , .Xr sliplogin 8 , -.Xr slstat 8 +.Xr slstats 8 diff --git a/share/man/man4/smb.4 b/share/man/man4/smb.4 deleted file mode 100644 index 90d126e929a44..0000000000000 --- a/share/man/man4/smb.4 +++ /dev/null @@ -1,70 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd October 25, 1998 -.Dt SMB 4 -.Os FreeBSD -.Sh NAME -.Nm smb -.Nd -SMB generic i/o device driver -.Sh SYNOPSIS -.Cd "device smb0 at smbus?" -.Sh DESCRIPTION -The -.Em smb -character device driver provides generic i/o to any -.Xr smbus 4 -instance. In order to control SMB devices, use /dev/smb? with the -following ioctls: -.Pp -.Bl -column "System Management Bus ioctls" -compact -.It Em Ioctl Ta Em Description -.It Sy SMB_QUICK_WRITE Ta "QuickWrite command" -.It Sy SMB_QUICK_READ Ta "QuickRead command" -.It Sy SMB_SENDB Ta "SendByte command" -.It Sy SMB_RECVB Ta "ReceiveByte command" -.It Sy SMB_WRITEB Ta "WriteByte command" -.It Sy SMB_WRITEW Ta "WriteWord command" -.It Sy SMB_READB Ta "ReadByte command" -.It Sy SMB_READW Ta "ReadWord command" -.It Sy SMB_PCALL Ta "ProcedureCall command" -.It Sy SMB_BWRITE Ta "BlockWrite command" -.It Sy SMB_BREAD Ta "BlockRead command" -.El -.Pp -Using the write routine is equivalent to a SMB_WRITEW ioctl. -.Pp -.Sh SEE ALSO -.Xr smbus 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/smbus.4 b/share/man/man4/smbus.4 deleted file mode 100644 index f3b5ada9460d7..0000000000000 --- a/share/man/man4/smbus.4 +++ /dev/null @@ -1,75 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd August 10, 1998 -.Dt SMBBUS 4 -.Os FreeBSD -.Sh NAME -.Nm smbus -.Nd -System Management Bus -.Sh SYNOPSIS -.Cd "controller smbus" -.Pp -.Cd "device iicsmb0 at iicbus?" -.Cd "device bktr0" -.Sh DESCRIPTION -The -.Em smbus -system provides a uniform, modular and architecture-independent -system for the implementation of drivers to control various SMB devices -and to utilize different SMB controllers (I2C, PIIX4, Brooktree848, vm86...). -.Sh System Management Bus -The -.Em System Management Bus -is a two-wire interface through which simple power-related chips can communicate -with rest of the system. It uses I2C as its backbone (see -.Xr iicbus 4 ). - -A system using SMB passes messages to and from devices instead of tripping -individual control lines. - -With the SMBus, a device can provide manufacturer information, tell the -system what its model/part number is, save its state for a suspend event, -report different types of errors, accept control parameters, and return its -status. - -The SMBus may share the same host device and physical bus as ACCESS bus -components provided that an appropriate electrical bridge is provided -between the internal SMB devices and external ACCESS bus devices. -.Sh SEE ALSO -.Xr iicbus 4 , -.Xr iicsmb 4 , -.Xr bktr 4 , -.Xr smb 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man4/vinum.4 b/share/man/man4/vinum.4 index f155ee32972a7..52407df2cabab 100644 --- a/share/man/man4/vinum.4 +++ b/share/man/man4/vinum.4 @@ -35,7 +35,7 @@ .\" otherwise) arising in any way out of the use of this software, even if .\" advised of the possibility of such damage. .\" -.\" $Id: vinum.4,v 1.8 1999/01/15 03:54:40 grog Exp grog $ +.\" $Id: vinum.4,v 1.4 1998/08/20 02:01:16 grog Exp grog $ .\" .Dd 22 July 1998 .Dt vinum 4 @@ -44,8 +44,8 @@ .Nm vinum .Nd Logical Volume Manager .Sh SYNOPSIS -.Cd "kldload vinum" -.Cd "kldload Vinum" +.Cd "modload /lkm/vinum_mod.o" +.Cd "modload /lkm/vinum_mod.raid5.o" .Sh DESCRIPTION .Nm is a logical volume manager inspired by, but not derived from, the Veritas @@ -56,8 +56,7 @@ It provides device-independent logical disks, called \fIvolumes\fP. Volumes are not restricted to the size of any disk on the system. .It The volumes consist of one or more \fIplexes\fP, each of which contain the -entire address space of a volume. This represents an implementation of RAID-1 -(mirroring). Multiple plexes can also be used for +entire address space of a volume. Multiple plexes can be used for .\" XXX What about sparse plexes? Do we want them? .if t .sp .Bl -bullet @@ -146,70 +145,43 @@ perform this function. .El .Sh KERNEL CONFIGURATION .Nm -is currently supplied as a kernel loadable module (kld), and does not require -configuration. As with other klds, it is absolutely necessary to match the kld -to the version of the operating system. Failure to do so will cause +does not require kernel configuration, since it is supplied \fIonly\fP\| as a +loadable kernel module (\fILKM\fP\|). As with other LKMs, it is absolutely +necessary to match the LKM to the version of the operating system. Failure to +do so will cause .Nm to issue an error message and terminate. .Pp .Nm is currently available in two versions: a freely available version which does not contain RAID-5 functionality, and a full version including RAID-5 -functionality, which is available from Cybernet Systems -Inc. (http://www.cybernet.com\fR). +functionality, which is available from Cybernet Systems Inc. .Sh RUNNING VINUM -Normally, you start a configured version of -.Nm -at boot time. Set the variable -.Ar vinum_slices -in -.Ar /etc/rc.conf -to indicate the slices on which -.Nm -drives are located. For example, if you have -.Nm -drives on -.Ar /dev/da1h , -.Ar /dev/da2h , -.Ar /dev/da3h , -.Ar /dev/da4h -and -.Ar /dev/da5h , -you would set the variable to: -.Bd -literal -vinum_slices="/dev/da1h /dev/da2h /dev/da3h /dev/da4h /dev/da5h" -.Ed -.Pp -.Sh VINUM INSTALLATION The freely available version of the .Nm -kld is called -.Pa /modules/vinum.ko , +LKM is called +.Pa /lkm/vinum_mod.o , and the RAID-5 version is -.Pa /modules/Vinum.o . +.Pa /lkm/vinum_mod.raid5.o . To load the module: -.Pp .Bd -unfilled -offset indent -# kldload vinum +# modload /lkm/vinum_mod.o .Ed .Pp -.Nm vinum(8) -also automatically loads the kld module if it is not yet loaded. -.Pp -After loading -.Nm vinum , -it must be confiugred. In an existing installation, the following command reads -the configuration an existing set of disks: +At this point, +.Nm +is loaded but has not been configured. In an existing installation, the +following command reads the configuration from disk +.Ar /dev/da1h . .Bd -unfilled -offset indent -# vinum read /dev/da1h /dev/da2h /dev/da3h /dev/da4h /dev/da5h /dev/da6h +# vinum read /dev/da1h .Ed .sp -This command must specify all of the devices used by +The name of the disk device (in this example +.Ar /dev/da1h ) +can be any of the devices used by .Nm vinum . -.Nm vinum(8) -reads the configuration from the device with the newest configuration file, then -updates it if necessary with additional information from successively older -configurations. These commands are normally embedded in the startup file +These commands are normally embedded in the startup file .Pa /etc/rc . .Pp See @@ -218,27 +190,26 @@ for information on how to create a .Nm configuration. .Pp -To unload the kld, first find the +To unload the LKM, first find the .Ar Id field in -.Pa kldstat: +.Pa modstat: .Bd -unfilled -offset indent -# kldstat -Id Refs Address Size Name - 1 2 0xf0100000 1c7de8 kernel - 2 1 0xf0f5b000 b0000 Vinum.ko +# modstat +Type Id Off Loadaddr Size Info Rev Module Name +MISC 0 0 f2b6e000 0061 f2b7b034 1 vinum_mod .Ed .Pp -To unload the module, use -.Pa kldunload: +Use this value as the parameter for +.Pa modunload: .Bd -unfilled -offset indent -# kldunload -n Vinum +# modunload -i 0 .Ed .Pp -The kld can only be unloaded when idle, in other words when no volumes are +The LKM can only be unloaded when idle, in other words when no volumes are mounted and no other instances of the .Nm -program are active. Unloading the kld does not harm the data in the volumes. +program are active. Unloading the LKM does not harm the data in the volumes. .Ss CONFIGURING AND STARTING OBJECTS Use the .Xr vinum 8 @@ -563,6 +534,7 @@ box,center,tab(#) ; lfCWp9 | lw65 . State#Meaning = +.TH N volume_unallocated#T{ present but unused. This will not normally be seen from a user perspective. T} @@ -582,6 +554,7 @@ box,center,tab(#) ; lfCWp9 | lw65 . State#Meaning = +.TH N volume_unallocated#T{ present but unused. This will not normally be seen from a user perspective. T} @@ -614,6 +587,7 @@ box,center,tab(#) ; lfCWp9 | lw65 . State#Meaning = +.TH N plex_unallocated#T{ An empty entry, not a plex at all. T} @@ -701,6 +675,7 @@ box,center,tab(#) ; lfCWp9 | lw65 . State#Meaning = +.TH N sd_unallocated#T{ An empty entry, not a subdisk at all. T} @@ -795,6 +770,7 @@ box,center,tab(#) ; lfCWp9 | lw65 . State#Meaning = +.TH N drive_unallocated#T{ Unused entry. T} @@ -833,7 +809,7 @@ should fail. I don't know any good way to enforce this initialization (or the even slower alternative of rebuilding the parity blocks). If anybody has a good idea, I'd be grateful for input. .It -Det ection of differences between the version of the kernel and the kld is not +Detection of differences between the version of the kernel and the LKM is not yet implemented. .El .Sh AUTHOR diff --git a/share/man/man4/vpo.4 b/share/man/man4/vpo.4 deleted file mode 100644 index 28f8ed4906c37..0000000000000 --- a/share/man/man4/vpo.4 +++ /dev/null @@ -1,56 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd March 5, 1998 -.Dt VP0 4 -.Os FreeBSD -.Sh NAME -.Nm vpo -.Nd -Parallel to SCSI interface driver -.Sh SYNOPSIS -.Cd "controller vpo at ppbus?" -.Pp -For one or more SCSI busses: -.Cd "controller scbus0 at vpo0" -.Sh DESCRIPTION -The primary purpose of the -.Em vpo -driver is to provide access to the Adaptec AIC-7110 SCSI controller built -in the Iomega ZIP drive. But it should also work with the Iomega Jaz Traveller -parallel to SCSI interface. -.Sh SEE ALSO -.Xr ppbus 4 , -.Xr scsi 4 , -.Xr sd 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5 index 0a5993eb88335..6ea12b962835b 100644 --- a/share/man/man5/rc.conf.5 +++ b/share/man/man5/rc.conf.5 @@ -22,17 +22,14 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: rc.conf.5,v 1.26 1998/12/12 23:26:52 dillon Exp $ +.\" $Id: rc.conf.5,v 1.23 1998/10/06 19:24:26 phk Exp $ .\" .Dd April 26, 1997 .Dt RC.CONF 5 .Os FreeBSD 2.2.2 .Sh NAME .Nm rc.conf -.Nd system configuration information. -.Pp -.Nm rc.conf.local -.Nd localized system configuration information. +.Nd local configuration information. .Sh DESCRIPTION The file .Nm rc.conf @@ -43,16 +40,15 @@ started up at system initial boot time. In new installations, the file is generally initialized by the system installation utility: .Pa /stand/sysinstall . .Pp -The -.Nm rc.conf.local -file may be used to override variables set in rc.conf. The system -administrator typically uses the distribution-supplied -.Nm rc.conf -file and maintains local overrides/additions in -.Nm rc.conf.local. -.Pp +It is the duty of the system administrator to properly maintain this file +as changes occur on the local host. +.Sh FILES +.Bl -tag -width /etc/rc.conf -compact +.It Pa /etc/rc.conf +.El +.Sh DESCRIPTION The purpose of -.Nm rc.conf[.local] +.Nm is not to run commands or perform system startup actions directly. Instead, it is included by the various generic startup scripts in @@ -264,12 +260,6 @@ and run the .Xr rwhod 8 daemon at boot time. -.It Ar rwhod_flags -(str) If -.Ar rwhod_enable -is set to -.Ar YES , -these are the flags to pass to it. .It Ar amd_enable (bool) If set to .Ar YES , @@ -283,15 +273,6 @@ is set to .Ar YES , these are the flags to pass to it. Use the \fBinfo amd\fR command for more information. -.It Ar update_motd -(bool) If set to -.Ar YES , -.Nm /etc/motd -will be updated at boot time to reflect the kernel release -bring run. If set to -.Ar NO , -.Nm -will not be updated .It Ar nfs_client_enable (bool) If set to .Ar YES , @@ -304,16 +285,6 @@ is set to these are the flags to pass to the .Xr nfsiod 8 daemon. -.It Ar nfs_access_cache -if -.Ar nfs_client_enable -is set to -.Ar YES , -this can be set to -.Ar 0 -to disable NFS ACCESS RPC caching, or to the number of seconds for which NFS ACCESS -results should be cached. A value of 2-10 seconds will substantially reduce network -traffic for many NFS operations. .It Ar nfs_server_enable (bool) If set to .Ar YES , @@ -930,14 +901,7 @@ most secure). See .Xr init 8 for the list of possible security levels and their effect on system operation. -.Sh FILES -.Bl -tag -width /etc/rc.conf -compact -.It Pa /etc/rc.conf -.El -.Pp -.Bl -tag -width /etc/rc.conf.local -compact -.It Pa /etc/rc.conf.local -.El + .Sh SEE ALSO .Xr gdb 1 , .Xr info 1 , @@ -951,7 +915,6 @@ on system operation. .Xr ifconfig 8 , .Xr inetd 8 , .Xr lpd 8 , -.Xr motd 5 , .Xr moused 8 , .Xr mrouted 8 , .Xr named 8 , diff --git a/share/man/man7/Makefile b/share/man/man7/Makefile index e0e17ef56aa4c..1c77b690aa00a 100644 --- a/share/man/man7/Makefile +++ b/share/man/man7/Makefile @@ -1,9 +1,9 @@ # @(#)Makefile 8.1 (Berkeley) 6/5/93 -# $Id: Makefile,v 1.8 1998/11/26 00:21:24 jkoshy Exp $ +# $Id: Makefile,v 1.6 1997/03/07 03:28:12 jmg Exp $ -#MISSING: eqnchar.7 ms.7 term.7 +#MISSING: eqnchar.7 man.7 ms.7 term.7 MAN7= ascii.7 clocks.7 environ.7 hier.7 hostname.7 intro.7 mailaddr.7 \ - man.7 mdoc.7 mdoc.samples.7 operator.7 ports.7 security.7 + mdoc.7 mdoc.samples.7 operator.7 ports.7 MLINKS= intro.7 miscellaneous.7 .include <bsd.prog.mk> diff --git a/share/man/man7/hier.7 b/share/man/man7/hier.7 index bade82e7b6070..6712a6ae5e2ea 100644 --- a/share/man/man7/hier.7 +++ b/share/man/man7/hier.7 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" @(#)hier.7 8.1 (Berkeley) 6/5/93 -.\" $Id: hier.7,v 1.15 1997/09/13 17:52:36 wosch Exp $ +.\" $Id: hier.7,v 1.14 1997/03/21 20:14:10 mpp Exp $ .\" .Dd June 5, 1993 .Dt HIER 7 @@ -301,7 +301,7 @@ ports collection (optional). .It Li sbin/ system daemons & system utilities (executed by users) .It Li share/ -architecture-independent files +architecture-independent ascii text files .Pp .Bl -tag -width "calendar/" -compact .It Li calendar/ diff --git a/share/man/man7/man.7 b/share/man/man7/man.7 deleted file mode 100644 index bccc9bf0e60cb..0000000000000 --- a/share/man/man7/man.7 +++ /dev/null @@ -1,343 +0,0 @@ -.\" Copyright (c) 1998. -.\" The FreeBSD Project. 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. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. -.\" 4. 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. -.\" -.\" $Id$ -.\" -.Dd November 30, 1998 -.Os -.Dt MAN 7 -.Sh NAME -.Nm man -.Nd quick reference guide for the -.Nm \-man -macro package -.Sh SYNOPSIS -.Nm groff -.Fl m Ns Ar an -.Ar -.Sh DESCRIPTION -The -.Nm \-man -package is a set of macros used to format -.Ux -manual pages. On -.Bx -systems, the use of -.Nm -is deprecated and the more expressive -.Nm mdoc -package is recommended in its place. -.Sh USAGE -.Ss Conventions -.Nm -macros are named using one or two upper case alphabetic characters. -Following regular -.Xr troff 1 -convention, each macro request starts with a -.Li "." -as the first character of a line. Arguments to macro requests -expecting printable text may consist of zero to six words. Some macros will -process the next input line if no arguments are supplied. For -example, a -.Li ".I" -request on a line by itself will cause the next input line to be set -in italics. -Whitespace characters may be embedded in an argument by enclosing -it in quotes. Type font and size are reset to their defaults before -each paragraph and after processing font size and face changing macros. -.Ss Indentation -The prevailing indent distance is remembered between successive -indented paragraphs and is reset to the default on reaching a -non-indented paragraph. Default units for indents are -.Dq ens . -.Ss Preprocessing -The -.Xr man 1 -program is conventionally used to format and display manual pages. If -the first line of the manual page source starts with the literal string -.Li \&\'\e" -.\" " bring emacs's font-lock mode back in sync ... -then the remaining letters on the line indicate preprocessors that -need to be run prior to formatting with -.Xr troff 1 . -Supported preprocessing directives are: -.Bl -column "Letter" "Preprocessor" -offset indent -.It Em Letter Ta Em Preprocessor -.It e Ta Xr eqn 1 -.It g Ta Xr grap 1 -.It p Ta Xr pic 1 -.It r Ta Xr refer 1 -.It t Ta Xr tbl 1 -.It v Ta Xr vgrind 1 -.El -.Ss Available Strings -The -.Nm -package has the following predefined strings: -.Bl -column "String" "XXXXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent -.It Em String Ta Em Description -.It "\e*R" Ta "registration symbol" -.It "\e*S" Ta "change to default font size" -.It "\e*(Tm" Ta "trademark symbol" -.It "\e*(lq" Ta "left quote" -.It "\e*(rq" Ta "right quote" -.El -.Pp -.Ss Available Macros -The available macros are presented in alphabetical order. -.Bl -tag -width "XXX XX" -.It ".B" Op Ar words -typeset -.Ar words -using a bold face. Does not cause a line break. If no -arguments are given the next text line is processed. -.It ".BI" Op Ar words -join -.Ar words -alternating bold and italic faces. Does not cause a line break. If -no arguments are given the next text line is processed. -.It ".BR" Op Ar words -join -.Ar words -alternating bold and roman faces. Does not cause a line break. If no -arguments are given the next text line is processed. -.It ".DT" -restore the default tab spacing of 0.5 inches. Does not cause a line -break. -.It ".HP" Op Ar indent -Begin a paragraph with a hanging indent and sets the prevailing indent -to -.Ar indent . -This request forces a line break. If -.Ar indent -is not specified, the value of the prevailing indent is used. -.It ".I" Op Ar words -typeset -.Ar words -using an italic face. Does not cause a line break. If no -arguments are given the next text line is processed. -.It ".IB" Op Ar words -join -.Ar words -alternating italic and bold faces. Does not cause a line break. If no -arguments are given the next text line is processed. -.It ".IP" Op Ar tag Op Ar indent -Begin an indented paragraph with tag -.Ar tag -and prevailing indent set to -.Ar indent . -If -.Ar tag -is not specified it is taken to be the null string -.Qq "" . -If -.Ar indent -is not specified it is taken to be the prevailing indent. -.It ".IR" Op Ar words -join -.Ar words -alternating italic and roman faces. Does not cause a line break. If no -arguments are given the next text line is processed. -.It ".LP" -begin a left-aligned paragraph. The prevailing indent is set to the -default. This request forces a line break. -.It "\&.P" -aliased to \&.LP. -.It ".PD" Op Ar distance -set the vertical distance between paragraphs to -.Ar distance . -If argument -.Ar distance -is not specified a value of 0.4v is used. -.It ".PP" -aliased to \&.LP. -.It ".RE" -end of a relative indent (see \&.RS below). This request forces a -line break and restores the prevailing indent to its previous value. -.It ".RB" Op Ar words -join -.Ar words -alternating roman and bold faces. Does not cause a line break. If no -arguments are given the next text line is processed. -.It ".RI" Op Ar words -join -.Ar words -alternating roman and italic faces. Does not cause a line break. If no -arguments are given the next text line is processed. -.It ".RS" Op Ar indent -start a relative indent, increasing the indentation by -.Ar indent . -If argument -.Ar indent -is not specified, the value of the prevailing indent is used. -.It ".SB" Op Ar words -typeset -.Ar words -using a bold face after reducing the font size by 1 point. -Does not cause a line break. If no arguments are given the next text -line is processed. -.It ".SH" Op Ar words -specifies a section heading. This request forces a line break. -It resets the prevailing indent and margins to their defaults. -.It ".SM" Op Ar words -typeset -.Ar words -after reducing the font size by 1 point. Does not cause a line break. -If no arguments are given the next text line is processed. -.It ".SS" Op Ar words -specifies a section subheading. This request forces a line -break. If no arguments are given the next text line is processed. -It resets the prevailing indent and margins to their defaults. -.It ".TH" Ar name Ar section Ar date Xo -.Op Ar footer Op Ar center -.Xc -Begin reference page -.Ar name -belonging to section -.Ar section . -The third argument -.Ar date , -is the date of the most recent change. If present, -.Ar footer -specifies the left page footer text and -.Ar center -specifies the center header text. This request must the very first -request in the manual page. -.It ".TP" Op Ar indent -begin an indented paragraph with the tag specified in the next text -line. If argument -.Ar indent -is given, it specifies the new value of the prevailing indent. -This request forces a line break. -.El -.Sh PAGE STRUCTURE -Most manual pages follow the general structure outlined below: -.Bl -tag -width ".SH NAME" -.It ".TH" Ar title Op Ar section-number -The very first macro request in a manual page has to be the \&.TH -request which establishes the name and title of the manual page. The -\&.TH request also establishes the number of the manual page section. -.It ".SH NAME" -The name, or list of names, by which the command is called, followed -by a dash and a one-line summary of the action performed. This -section should not contain any -.Nm troff -commands or escapes, or any macro requests. This section is used to -generate the database used by the -.Xr whatis 1 -command. -.It ".SH SYNOPSIS" -A brief summary of the usage of the command or function being -described. -.Bl -tag -width "Commands" -.It Commands -The syntax of the command and its arguments as would be typed on the -command line. Words that have to be typed exactly as printed are to -be presented in bold face. Arguments are indicated by the use of an -italic face. Arguments and command names so indicated should not be -capitalized, even when starting a sentence. -.Pp -Syntactic symbols used should appear in roman face: -.Bl -tag -width "XXX" -.It "[]" -square brackets are used to indicate optional arguments. -.It "|" -vertical bars are used to indicate a one of many exclusive choice. -Only one item from a list separated by vertical bars is to be selected. -.It "..." -an ellipsis following an argument is used to indicate that the -arguments can be repeated. When an ellipsis follows a bracketed set, -the expression within the brackets can be repeated. -.El -.It Functions -Required data declarations or -.Li "#include" -directives are to be shown first, followed by the function declaration. -.El -.It ".SH DESCRIPTION" -An overview of the command or functions external behavior, including -its interactions with files or data, how standard input, standard -output and standard error are handled. Internals and implementation -details are not normally specified. The question answered by this -section is "what does it do?" or "what is it for?". -.Pp -Literal text, filenames and references to items that appear elsewhere -in the reference manuals should be presented using a constant width -face. Arguments should be presented using an italic face. -.It ".SH OPTIONS" -The list of options together with a description of how each affects -the commands operation. -.It ".SH USAGE" -This section is optional and contains a detailed description of the -subcommands and input grammar understood by the command. -.It ".SH RETURN VALUES" -The list of return values a library routine could return to the caller, -with the conditions that cause these values to be returned. -.It ".SH EXIT STATUS" -The list of values returned as the exit status of the command, with -the conditions that cause these values to be returned. -.It ".SH FILES" -The list of files associated with the command or function. -.It ".SH SEE ALSO" -A comma separated list of related manual pages followed by references -to other published documentation. -.It ".SH DIAGNOSTICS" -A list of diagnostic messages with corresponding explanations. -.It ".SH BUGS" -Known defects and limitations, if any. -.El -.Sh FILES -.Bl -tag -width "/usr/share/lib/tmac/tmac.groff_an" -.It "/usr/share/lib/tmac/tmac.an" -Initial file defining the -.Nm -package. -.It "/usr/share/lib/tmac/tmac.groff_an" -.Nm groff -source for macro definitions. -.It "/usr/share/lib/tmac/man.local" -local modifications to the -.Nm -package. -.El -.Sh SEE ALSO -.Xr apropos 1 , -.Xr groff 1 , -.Xr man 1 , -.Xr nroff 1 , -.Xr troff 1 , -.Xr whatis 1 , -.Xr mdoc 7 , -.Xr mdoc.samples 7 -.Sh HISTORY -This manual page was written by -.An "Joseph Koshy" -.Ad Aq jkoshy@freebsd.org . diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7 index 48e8dba3924c9..2117a633d3060 100644 --- a/share/man/man7/mdoc.7 +++ b/share/man/man7/mdoc.7 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" @(#)mdoc.7 8.2 (Berkeley) 12/30/93 -.\" $Id: mdoc.7,v 1.7 1998/12/01 19:58:58 billf Exp $ +.\" $Id: mdoc.7,v 1.5 1997/03/19 20:31:37 mpp Exp $ .\" .Dd December 30, 1993 .Os @@ -342,11 +342,11 @@ Produces .It Li \&Pf Ta Yes Ta \&No Ta "Prefix string." .It Li \&Po Ta Yes Ta Yes Ta "Parenthesis open quote." .It Li \&Pq Ta Yes Ta Yes Ta "Parentheses quote." -.It Li \&Qc Ta Yes Ta Yes Ta "Straight Double close quote." +.It Li \&Qc Ta Yes Ta Yes Ta "Strait Double close quote." .It Li \&Ql Ta Yes Ta Yes Ta "Quoted literal." -.It Li \&Qo Ta Yes Ta Yes Ta "Straight Double open quote." -.It Li \&Qq Ta Yes Ta Yes Ta "Straight Double quote." -.It Li \&Re Ta \&No Ta \&No Ta "Reference end." +.It Li \&Qo Ta Yes Ta Yes Ta "Strait Double open quote." +.It Li \&Qq Ta Yes Ta Yes Ta "Strait Double quote." +.It Li \&Re Ta \&No Ta \&No Ta "Reference start." .It Li \&Rs Ta \&No Ta \&No Ta "Reference start." .It Li \&Rv Ta \&No Ta \&No Ta "Return values (sections two and three only)." .It Li \&Sc Ta Yes Ta Yes Ta "Single close quote." diff --git a/share/man/man7/mdoc.samples.7 b/share/man/man7/mdoc.samples.7 index 6de33236dbccd..d8a949585d50d 100644 --- a/share/man/man7/mdoc.samples.7 +++ b/share/man/man7/mdoc.samples.7 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93 -.\" $Id: mdoc.samples.7,v 1.16 1997/12/08 07:44:20 charnier Exp $ +.\" $Id: mdoc.samples.7,v 1.15 1997/03/20 16:04:04 mpp Exp $ .\" .\" This tutorial sampler invokes every macro in the package several .\" times and is guaranteed to give a worst case performance @@ -120,7 +120,7 @@ outlined as follows: .It "A manual page template" . .El .It -.Tn "TITLE MACROS" . +.Tn "INTRODUCTION OF TITLE MACROS" . .It .Tn "INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS" . .Bl -tag -width flag -compact -offset indent @@ -156,7 +156,6 @@ outlined as follows: .Bl -tag -width flag -compact -offset indent .It "AT&T Macro" . .It "BSD Macro" . -.It "FreeBSD Macro" . .It "UNIX Macro" . .It "Enclosure/Quoting Macros" .Bl -tag -width flag -compact -offset indent @@ -167,13 +166,13 @@ outlined as follows: .It "Single Quotes/Enclosure" . .It "Prefix Macro" . .El +.It "Extended Arguments" . .It "No\-Op or Normal Text Macro" . .It "No Space Macro" . .It "Section Cross References" . .It "References and Citations" . .It "Return Values (sections two and three only)" .It "Trade Names (Acronyms and Type Names)" . -.It "Extended Arguments" . .El .It .Tn "PAGE STRUCTURE DOMAIN" @@ -395,7 +394,7 @@ is created by .Ql \&.Fn fetch char\e *str .It Fn fetch "char *str" can also be created by -.Ql \&.Fn fetch "\\*qchar *str\\*q" +.Ql \&.Fn fetch "\\*q*char *str\\*q" .El .Pp If the @@ -445,7 +444,6 @@ Several example man pages can also be found in .Pa /usr/share/examples/mdoc . .Pp -.Ss A manual page template .Bd -literal -offset indent \&.\e" The following requests are required for all man pages. \&.Dd Month day, year @@ -596,7 +594,7 @@ The date should be written formally: .ne 5 .Dl January 25, 1989 .El -.Sh INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS +.Sh MANUAL DOMAIN .Ss What's in a name... The manual domain macro names are derived from the day to day informal language used to describe commands, subroutines and related @@ -804,7 +802,6 @@ escape them with Typical syntax is shown in the first content macro displayed below, .Ql \&.Ad . -.Sh MANUAL DOMAIN .Ss Address Macro The address macro identifies an address construct of the form addr1[,addr2[,addr3]]. @@ -824,9 +821,9 @@ of the form addr1[,addr2[,addr3]]. .El .Pp It is an error to call -.Ql \&.Ad +.Li \&.Ad without arguments. -.Ql \&.Ad +.Li \&.Ad is callable by other macros and is parsed. .Ss Author Name The @@ -857,7 +854,7 @@ without any arguments. .Ss Argument Macro The -.Ql \&.Ar +.Li \&.Ar argument macro may be used whenever a command line argument is referenced. .Pp @@ -878,12 +875,12 @@ a command line argument is referenced. .El .Pp If -.Ql \&.Ar +.Li \&.Ar is called without arguments .Ql Ar is assumed. The -.Ql \&.Ar +.Li \&.Ar macro is parsed and is callable. .Ss Configuration Declaration (section four only) The @@ -1173,7 +1170,7 @@ anywhere else in the man page without problems, but its main purpose is to present the function type in kernel normal form for the .Sx SYNOPSIS of sections two and three -(it causes a line break allowing the function name to appear +(it causes a page break allowing the function name to appear on the next line). .Pp .Dl Usage: .Ft type ... \*(Pu @@ -1561,7 +1558,7 @@ example of macro usage at its worst. .Ss No\-Op or Normal Text Macro The macro -.Ql \&.No +.Li \&.No is a hack for words in a macro command line which should .Em not @@ -1681,9 +1678,9 @@ macro is parsed and is callable by other macros. .Ss Extended Arguments The -.Ql \&.Xo +.Li \&.Xo and -.Ql \&.Xc +.Li \&.Xc macros allow one to extend an argument list on a macro boundary. Argument lists cannot @@ -1854,8 +1851,7 @@ name macro .Ql \&.Nm is required for sections 1, 5, 6, 7, 8. Section 4 manuals require a -.Ql ".Nm" , -.Ql ".Fd" +.Ql ".Nm" , ".Fd" or a .Ql ".Cd" configuration device usage macro. @@ -1999,14 +1995,12 @@ User specified sections may be added, for example, this section was set with: .Bd -literal -offset 14n -\&.Sh PAGE STRUCTURE DOMAIN +\&.Sh PAGE LAYOUT MACROS .Ed .Ss Paragraphs and Line Spacing. .Bl -tag -width 6n .It \&.Pp -The -.Ql \&.Pp -paragraph command may +The \&.Pp paragraph command may be used to specify a line space where necessary. The macro is not necessary after a .Ql \&.Sh @@ -2147,7 +2141,7 @@ and .Ql \&.Ek (end-keep). The only option that -.Ql \&.Bk +.Ql \&.Bl accepts is .Fl words and is useful for preventing line breaks in the middle of options. @@ -2532,7 +2526,7 @@ Here is the source text which produced the above example: \&.El .Ed .Pp -Here is a hanged list with two items: +Here is a hanged list with just one item: .Bl -hang -offset indent .It Em Hanged labels appear similar to tagged lists when the diff --git a/share/man/man7/ports.7 b/share/man/man7/ports.7 index 9669f881a0a9e..d86d3a6713ce0 100644 --- a/share/man/man7/ports.7 +++ b/share/man/man7/ports.7 @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: ports.7,v 1.8 1998/06/29 06:54:34 hoek Exp $ +.\" $Id: ports.7,v 1.7 1998/06/23 04:38:50 hoek Exp $ .\" .Dd January 25, 1998 .Dt PORTS 7 @@ -51,21 +51,14 @@ simply type .Ic make install to install the application. .Pp -It is possible to download and use ports from the FreeBSD repository -that are newer than the installed system; however it is important to -install the appropriate "Upgrade Kit" from http://www.FreeBSD.ORG/ports/ -first! The -.Xr portcheckout 1 -script (also a port, of course!) will help to download new ports. -.Pp For more information about using ports, see .Nm The Ports Collection (file:/usr/share/doc/handbook/ports.html --or-- -http://www.FreeBSD.ORG/handbook/ports.html). +http://www.freebsd.org/handbook/ports.html). For information about creating new ports, see .Nm Porting applications (file:/usr/share/doc/handbook/porting.html --or-- -http://www.FreeBSD.ORG/handbook/porting.html). +http://www.freebsd.org/handbook/porting.html). Both are part of the FreeBSD Handbook. .Pp .Sh TARGETS @@ -73,8 +66,7 @@ Both are part of the FreeBSD Handbook. Some of the targets work recursively through subdirectories. This lets you, for example, install all of the biology ports. The targets that do this are -.Ar build , checksum , clean , configure , -.Ar depends , extract , fetch , install , +.Ar build , checksum , clean , configure , extract , fetch , install , and .Ar package . .Pp @@ -254,6 +246,8 @@ Command to use to fetch files. Normally If set, overwrite any existing package registration on the system. .It Ev MOTIFLIB Location of libXm.{a,so}. +.It Ev PATCH_DEBUG +If defined, display verbose output when applying each patch. .It Ev INTERACTIVE If defined, only operate on a port if it requires interaction. .It Ev BATCH @@ -272,11 +266,7 @@ The big Kahuna. .Xr pkg_add 1 , .Xr pkg_create 1 , .Xr pkg_delete 1 , -.Xr pkg_info 1 , -.Xr portcheckout 1 -(a port), -.Xr pib 1 -(also a port). +.Xr pkg_info 1 . .Pp The FreeBSD handbook .Pp diff --git a/share/man/man7/security.7 b/share/man/man7/security.7 deleted file mode 100644 index d1d34eb5830c1..0000000000000 --- a/share/man/man7/security.7 +++ /dev/null @@ -1,446 +0,0 @@ -.\" Copyright (c) 1998, Matthew Dillon. Terms and conditions are those of -.\" the BSD Copyright as specified in the file "/usr/src/COPYRIGHT" in -.\" the source tree. -.\" -.\" $Id: security.7,v 1.3 1998/12/25 23:39:01 obrien Exp $ -.\" -.Dd December 20, 1998 -.Dt SECURITY 7 -.Os -.Sh NAME -.Nm security -.Nd introduction to security under FreeBSD -.Sh DESCRIPTION -.Pp -Security is a function that begins and ends with the system administrator. -While all -.Bx -systems are inherently multi-user capable, the job of building and -maintaining security mechanisms to keep those users 'honest' is probably -one of the single largest undertakings of the sysadmin. Machines are -only as secure as you make them, and security concerns are ever competing -with the human necessity for convenience. UNIX systems, -in general, are capable of running a huge number of simultaneous processes -and many of these processes operate as servers - meaning that external entities -can connect and talk to them. As yesterday's mini-computers and mainframes -become today's desktops, and as computers become networked and internetworked, -security becomes an ever bigger issue. -.Pp -Security concerns can be split up into several categories: -.Bl -enum -offset indent -.It -Denial of service attacks -.It -User account compromises -.It -Root compromise through accessible servers -.It -Root compromise via user accounts -.El -.Pp -A denial of service attack is an action that deprives the machine of needed -resources. Typically, D.O.S. attacks are brute-force mechanisms that attempt -to crash or otherwise make a machine unusable by overwhelming its servers or -network stack. Some D.O.S. attacks try to take advantages of bugs in the -networking stack to crash a machine with a single packet. The latter can -only be fixed by applying a bug fix to the kernel. Attacks on servers can -often be fixed by properly specifying options to servers to limit the load -they incur on the system under adverse conditions. Brute-force network -attacks are harder to deal with. A spoofed-packet attack, for example, is -nearly impossible to stop short of cutting your system off from the internet. -.Pp -A user account compromise is even more common then a D.O.S. attack. Many -sysadmins still run standard telnetd, rlogind, rshd, and ftpd servers on their -machines. These servers, by default, do not operate over encrypted -connections. The result is that if you have any moderate-sized user base, -one or more of your users logging into your system from a remote location -(which is the most common and convenient way to login to a system) will -have his or her password sniffed. The attentive system admin will analyze -his remote access logs occasionally looking for suspicious source addresses -even for successful logins. -.Pp -One must always assume that once an attacker has access to a user account, -the attacker can break root. However, the reality is that in a well secured -and maintained system, access to a user account does not necessarily give the -attacker access to root. The distinction is important because without access -to root the attacker cannot generally hide his tracks and may, at best, be -able to remove that user's files and crash the machine, but not touch anyone -else's files. -.Pp -System administrators must keep in mind that there are several ways to break -root on a machine. The attacker may know the root password, the attacker -may find a bug in a root-run server and be able to break root over a network -connection to that server, or the attacker may know of a bug in an suid-root -program that allows the attacker to break root once he has broken into a -user's account. -.Pp -Security remedies are always implemented in a multi-layered 'onion peel' -approach and can be categorized as follows: -.Bl -enum -offset indent -.It -Securing root and staff accounts -.It -Securing root - root-run servers and suid/sgid binaries -.It -Securing user accounts -.It -Securing the password file -.It -Securing the kernel core, raw devices, and filesystems -.It -Checking file integrity: binaries, configuration files, and so forth -.It -Paranoia -.El -.Sh SECURING THE ROOT ACCOUNT AND SECURING STAFF ACCOUNTS -.Pp -Don't bother securing staff accounts if you haven't secured the root -account. Most systems have a password assigned to the root account. The -first thing you do is assume that the password is 'always' compromised. -To secure the root account you make sure that it is not possible to login -to the root account using the root password from a random user account or -over the network. If you haven't already, configure telnetd, rlogind, and -all other servers that handle login operations to refuse root logins, period, -whether the right password is given or not. Allow direct root logins only -via the system console. The '/etc/ttys' file comes in handy here and is -secure by default on most systems, but a good sysadmin always checks to make -sure. -.Pp -Of course, as a sysadmin you have to be able to get to root, so we open up -a few holes. But we make sure these holes require additional password -verification to operate. One way to make root accessible is to add appropriate -staff accounts to the wheel group (in /etc/group). The staff members placed -in the wheel group are allowed to 'su' to root. You should never give staff -members native wheel access via their entry in the password file... put staff -in a 'staff' group or something and only add those that really need root to -the wheel group. Unfortunately the wheel mechanism still allows an intruder to -break root if the intruder has gotten hold of your password file - he need only -break the root password and the password of one of the staff accounts that -happens to be in the wheel group. So while the wheel mechanism is usable, -it isn't much safer then not having a wheel group at all. -.Pp -An indirect way to secure the root account is to secure your staff accounts -by using an alternative login access method and *'ing out the crypted password -for the staff accounts. This way an intruder may be able to steal the password -file but will not be able to break into any staff accounts (or, indirectly, -root, even if root has a crypted password associated with it). Staff members -get into their staff accounts through a secure login mechanism such as -kerberos(1) or ssh(1) (see /usr/ports/security/ssh) using a private/public -key pair. When you use something like kerberos you generally must secure -the machines which run the kerberos servers and your desktop workstation. -When you use a public/private key pair with ssh, you must generally secure -the machine you are logging in FROM (typically your workstation), but you can -also add an additional layer of protection to the key pair by password -protecting the key pair when you create it with ssh-keygen(1). Being able -to *-out the passwords for staff accounts also guarantees that staff members -can only login through secure access methods that you have setup. You can -thus force all staff members to use secure, encrypted connections for -all their sessions which closes an important hole used by many intruders: That -of sniffing the network from an unrelated, less secure machine. -.Pp -The more indirect security mechanisms also assume that you are logging in -from a more restrictive server to a less restrictive server. For example, -if your main box is running all sorts of servers, your workstation shouldn't - be running any. In order for your workstation to be reasonably secure -you should run as few servers as possible, up to and including no servers -at all, and you should run a password-protected screen blanker. - Of course, given physical access to -a workstation an attacker can break any sort of security you put on it. -This is definitely a problem that you should consider but you should also -consider the fact that the vast majority of break-ins occur remotely, over -a network, from people who do not have physical access to your workstation or -servers. -.Pp -Using something like kerberos also gives you the ability to disable or -change the password for a staff account in one place and have it immediately -effect all the machine the staff member may have an account on. If a staff -member's account gets compromised, the ability to instantly change his -password on all machines should not be underrated. With discrete passwords, -changing a password on N machines can be a mess. You can also impose -re-passwording restrictions with kerberos: not only can a kerberos ticket -be made to timeout after a while, but the kerberos system can require that -the user choose a new password after a certain period of time (say, once a -month). -.Sh SECURING ROOT - ROOT-RUN SERVERS AND SUID/SGID BINARIES -.Pp -The prudent sysadmin only runs the servers he needs to, no more, no less. Be -aware that third party servers are often the most bug-prone. For example, -running an old version of imapd or popper is like giving a universal root -ticket out to the entire world. Never run a server that you have not checked -out carefully. Many servers do not need to be run as root. For example, -the ntalk, comsat, and finger daemons can be run in special user 'sandboxes'. -A sandbox isn't perfect unless you go to a large amount of trouble, but the -onion approach to security still stands: If someone is able to break in -through a server running in a sandbox, they still have to break out of the -sandbox. The more layers the attacker must break through, the lower the -likelihood of his success. Root holes have historically been found in -virtually every server ever run as root, including basic system servers. -If you are running a machine through which people only login via sshd and -never login via telnetd or rshd or rlogind, then turn off those services! -.Pp -FreeBSD now defaults to running ntalkd, comsat, and finger in a sandbox. -Another program which may be a candidate for running in a sandbox is -named(8). The default rc.conf includes the arguments necessary to run -named in a sandbox in a commented-out form. Depending on whether you -are installing a new system or upgrading an existing system, the special -user accounts used by these sandboxes may not be installed. The prudent -sysadmin would research and implement sandboxes for servers whenever possible. -.Pp -There are a number of other servers that typically do not run in sandboxes: -sendmail, popper, imapd, ftpd, and others. There are alternatives to -some of these, but installing them may require more work then you are willing -to put (the convenience factor strikes again). You may have to run these -servers as root and rely on other mechanisms to detect break-ins that might -occur through them. -.Pp -The other big potential root hole in a system are the suid-root and sgid -binaries installed on the system. Most of these binaries, such as rlogin, -reside in /bin, /sbin, /usr/bin, or /usr/sbin. While nothing is 100% safe, -the system-default suid and sgid binaries can be considered reasonably safe. -Still, root holes are occasionally found in these binaries. A root hole -was found in Xlib in 1998 that made xterm (which is typically suid) vulnerable. -It is better to be safe then sorry and the prudent sysadmin will restrict suid -binaries that only staff should run to a special group that only staff can -access, and get rid of (chmod 000) any suid binaries that nobody uses. A -server with no display generally does not need an xterm binary. Sgid binaries -can be almost as dangerous. If an intruder can break an sgid-kmem binary the -intruder might be able to read /dev/kmem and thus read the crypted password -file, potentially compromising any passworded account. An intruder that breaks -the tty group can write to almost user's tty. If a user is running a terminal -program or emulator with a talk-back feature, the intruder can potentially -generate a data stream that causes the user's terminal to echo a command, which -is then run as that user. -.Sh SECURING USER ACCOUNTS -.Pp -User accounts are usually the most difficult to secure. While you can impose -Draconian access restrictions on your staff and *-out their passwords, you -may not be able to do so with any general user accounts you might have. If -you do have sufficient control then you may win out and be able to secure the -user accounts properly. If not, you simply have to be more vigilant in your -monitoring of those accounts. Use of ssh and kerberos for user accounts is -more problematic, but still a very good solution compared to a crypted -password. -.Sh SECURING THE PASSWORD FILE -.Pp -The only sure fire way is to *-out as many passwords as you can and -use ssh or kerberos for access to those accounts. Even though the -crypted password file (/etc/spwd.db) can only be read by root, it may -be possible for a intruder to obtain read access to that file even if the -attacker cannot obtain root-write access. -.Pp -Your security scripts should always check for and report changes to -the password file (see 'Checking file integrity' below). -.Sh SECURING THE KERNEL CORE, RAW DEVICES, AND FILESYSTEMS -.Pp -If an attacker breaks root he can do just about anything, but there -are certain conveniences. For example, most modern kernels have a -packet sniffing device driver built in. Under FreeBSD it is called -the 'bpf' device. A intruder will commonly attempt to run a packet sniffer -on a compromised machine. You do not need to give the intruder the -capability and most systems should not have the bpf device compiled in. -Unfortunately, there is another kernel feature called the Loadable Kernel -Module interface. An enterprising intruder can use an LKM to install -his own bpf device or other sniffing device on a running kernel. If you -do not need to use the module loader, turn it off in the kernel configuration -with the NO_LKM option. -.Pp -But even if you turn off the bpf device, and turn off the module loader, -you still have /dev/mem and /dev/kmem to worry about. For that matter, -the intruder can still write raw devices. To avoid this you have to run -the kernel at a higher secure level... at least securelevel 1. The securelevel -can be set with a sysctl on the kern.securelevel variable. Once you have -set the securelevel to 1, write access to raw devices will be denied and -special chflags flags, such as 'schg', will be enforced. You must also ensure -that the 'schg' flag is set on critical startup binaries, directories, and -script files - everything that gets run up to the point where the securelevel -is set. This might be overdoing it, and upgrading the system is much more -difficult when you operate at a higher secure level. You may compromise and -run the system at a higher secure level but not set the schg flag for every -system file and directory under the sun. -.Sh CHECKING FILE INTEGRITY: BINARIES, CONFIG FILES, ETC -.Pp -When it comes right down to it, you can only protect your core system -configuration and control files so much before the convenience factor -rears its ugly head. The last layer of your security onion is perhaps -the most important - detection. -.Pp -The only correct way to check a system's file integrity is via another, -more secure system. It is fairly easy to setup a 'secure' system: you -simply do not run any services on it. With a secure system in place you -can then give it access to other system's root spaces via ssh. This may -seem like a security breech, but you have to put your trust somewhere and -as long as you don't do something stupid like run random servers it really -is possible to build a secure machine. When I say 'secure' here, I assuming -physical access security as well, of course. Given a secure machine with -root access on all your other machines, you can then write security scripts -ON the secure machine to check the other machines on the system. The most -common way of checking is to have the security script scp(1) over a find -and md5 binary and then ssh a shell command to the remote machine to md5 -all the files in the system (or, at least, the /, /var, and /usr partitions!). -The security machine copies the results to a file and diff's them against -results from a previous run (or compares the results against its own -binaries), then emails each staff member a daily report of differences. -.Pp -Another way to do this sort of check is to NFS export the major filesystems -from every other machine to the security machine. This is somewhat more -network intensive but also virtually impossible for an intruder to detect -or spoof. -.Pp -A good security script will also check for changes to user and staff members -access configuration files: .rhosts, .shosts, .ssh/authorized_keys, and -so forth... files that might fall outside the prevue of the MD5 check. -.Pp -A good security script will check for suid and sgid binaries on all -filesystems and report their absolute existence as well as a diff against -the previous report or some baseline (say, make a baseline once a week). -While you can turn off the ability to run suid and sgid binaries on certain -filesystems through the 'nosuid' option in fstab/mount, you cannot turn this -off on root and anyone who breaks root can just install their binary their. -If you have a huge amount of user disk space, though, it may be useful to -disallow suid binaries and devices ('nodev' option) on the user partitions -so you do not have to scan them for such. I would scan them anyway, though, -at least once a week, since the object of this onion layer is detection of -a break-in. -.Pp -Process accounting (see accton(1)) is a relatively low-overhead feature of -the operating system which I recommend using as a post-break-in evaluation -mechanism. It is especially useful in tracking down how an intruder has -actually broken root on a system, assuming the file is still intact after -the break-in occurs. -.Pp -Finally, security scripts should process the log files and the logs themselves -should be generated in as secured a manner as possible - remote syslog can be -very useful. An intruder tries to cover his tracks, and log files are critical -to the sysadmin trying to track down the time and method of the initial break-in. -.Sh PARANOIA -.Pp -A little paranoia never hurts. As a rule, a sysadmin can add any number -of security features as long as they do not effect convenience, and -can add security features that do effect convenience with some added -thought. -.Sh SPECIAL SECTION ON D.O.S. ATTACKS -.Pp -This section covers Denial of Service attacks. A DOS attack is typically -a packet attack. While there isn't much you can do about modern spoofed -packet attacks that saturate your network, you can generally limit the damage -by ensuring that the attacks cannot take down your servers. -.Bl -enum -offset indent -.It -Limiting server forks -.It -Limiting springboard attacks (ICMP response attacks, ping broadcast, etc...) -.It -Kernel Route Cache -.El -.Pp -A common DOS attack is against a forking server that attempts to cause the -server to eat processes, file descriptors, and memory until the machine -dies. Inetd (see inetd(8)) has several options to limit this sort of attack. -It should be noted that while it is possible to prevent a machine from going -down it is not generally possible to prevent a service from being disrupted -by the attack. Read the inetd manual page carefully and pay specific attention -to the -c, -C, and -R options. Note that spoofed-IP attacks will circumvent -the -C option to inetd, so typically a combination of options must be used. -Some standalone servers have self-fork-limitation parameters. -.Pp -Sendmail has its -OMaxDaemonChildren option which tends to work much -better then trying to use sendmail's load limiting options due to the -load lag. You should specify a MaxDaemonChildren parameter when you start -sendmail high enough to handle your expected load but no so high that the -computer cannot handle that number of sendmails without falling on its face. -It is also prudent to run sendmail in queued mode (-ODeliveryMode=queued) -and to run the daemon (sendmail -bd) separate from the queue-runs -(sendmail -q15m). If you still want realtime delivery you can run the queue -at a much lower interval, such as -q1m, but be sure to specify a reasonable -MaxDaemonChildren option for that sendmail to prevent cascade failures. -.Pp -Syslogd can be attacked directly and it is strongly recommended that you use -the -s option whenever possible, and the -a option otherwise. -.Pp -You should also be fairly careful -with connect-back services such as tcpwrapper's reverse-identd, which can -be attacked directly. You generally do not want to use the reverse-ident -feature of tcpwrappers for this reason. -.Pp -It is a very good idea to protect internal services from external access -by firewalling them off at your border routers. The idea here is to prevent -saturation attacks from outside your LAN, not so much to protect internal -services from root network-based root compromise. Always configure an exclusive -firewall, i.e. 'firewall everything *except* ports A, B, C, D, and M-Z'. This -way you can firewall off all of your low ports except for certain specific -services such as named (if you are primary for a zone), ntalkd, sendmail, -and other internet-accessible services. -If you try to configure the firewall the other -way - as an inclusive or permissive firewall, there is a good chance that you -will forget to 'close' a couple of services or that you will add a new internal -service and forget to update the firewall. You can still open up the -high-numbered port range on the firewall to allow permissive-like operation -without compromising your low ports. Also take note that FreeBSD allows you to -control the range of port numbers used for dynamic binding via the various -net.inet.ip.portrange sysctl's (sysctl -a | fgrep portrange), which can also -ease the complexity of your firewall's configuration. I usually use a normal -first/last range of 4000 to 5000, and a hiport range of 49152 to 65535, then -block everything under 4000 off in my firewall ( except for certain specific -internet-accessible ports, of course ). -.Pp -Another common DOS attack is called a springboard attack - to attack a server -in a manner that causes the server to generate responses which then overload -the server, the local network, or some other machine. The most common attack -of this nature is the ICMP PING BROADCAST attack. The attacker spoofed ping -packets sent to your LAN's broadcast address with the source IP address set -to the actual machine they wish to attack. If your border routers are not -configured to stomp on ping's to broadcast addresses, your LAN winds up -generating sufficient responses to the spoofed source address to saturate the -victim, especially when the attacker uses the same trick on several dozen -broadcast addresses over several dozen different networks at once. Broadcast -attacks of over a hundred and twenty megabits have been measured. A second -common springboard attack is against the ICMP error reporting system. By -constructing packets that generate ICMP error responses, an attacker can -saturate a server's incoming network and cause the server to saturate its -outgoing network with ICMP responses. This type of attack can also crash the -server by running it out of mbuf's, especially if the server cannot drain the -ICMP responses it generates fast enough. The FreeBSD kernel has a new kernel -compile option called ICMP_BANDLIM which limits the effectiveness of these -sorts of attacks. The last major class of springboard attacks is related to -certain internal inetd services such as the udp echo service. An attacker -simply spoofs a UDP packet with the source address being server A's echo port, -and the destination address being server B's echo port, where server A and B -are both on your LAN. The two servers then bounce this one packet back and -forth between each other. The attacker can overload both servers and their -LANs simply by injecting a few packets in this manner. Similar problems -exist with the internal chargen port. A competent sysadmin will turn off all -of these inetd-internal test services. -.Pp -Spoofed packet attacks may also be used to overload the kernel route cache. -Refer to the net.inet.ip.rtexpire, rtminexpire, and rtmaxcache sysctl -parameters. A spoofed packet attack that uses a random source IP will cause -the kernel to generate a temporary cached route in the route table, viewable -with 'netstat -rna | fgrep W3'. These routes typically timeout in 1600 -seconds or so. If the kernel detects that the cached route table has gotten -too big it will dynamically reduce the rtexpire but will never decrease it to -less then rtminexpire. There are two problems: (1) The kernel does not react -quickly enough when a lightly loaded server is suddenly attacked, and (2) The -rtminexpire is not low enough for the kernel to survive a sustained attack. -If your servers are connected to the internet via a T3 or better it may be -prudent to manually override both rtexpire and rtminexpire via sysctl(8). -Never set either parameter to zero (unless you want to crash the machine :-)). -Setting both parameters to 2 seconds should be sufficient to protect the route -table from attack. - -.Sh SEE ALSO -.Pp -.Xr accton 1 , -.Xr chflags 1 , -.Xr find 1 , -.Xr kerberos 1 , -.Xr md5 1 , -.Xr ssh 1 , -.Xr sshd 1 , -.Xr syslogd 1 , -.Xr xdm 1 , -.Xr sysctl 8 -.Sh HISTORY -The -.Nm -manual page was originally written by Matthew Dillon and first appeared -in FreeBSD-3.0.1, December 1998. diff --git a/share/man/man8/rc.8 b/share/man/man8/rc.8 index f4a48395a20d5..88dfe6c006cdc 100644 --- a/share/man/man8/rc.8 +++ b/share/man/man8/rc.8 @@ -30,7 +30,7 @@ .\" SUCH DAMAGE. .\" .\" @(#)rc.8 8.2 (Berkeley) 12/11/93 -.\" $Id: rc.8,v 1.6 1998/12/12 23:08:34 dillon Exp $ +.\" $Id: rc.8,v 1.4 1998/02/26 02:44:17 jkh Exp $ .\" .Dd December 11, 1993 .Dt RC 8 @@ -56,16 +56,12 @@ is the command script which controls the automatic reboot (calling the other scripts) and .Nm rc.local is the script holding commands which are pertinent only -to a specific site. Typically, the /usr/local/etc/rc.d -mechanism is used instead of rc.local these days but if -you do want to use rc.local, /etc/rc still supports it. -In this case, rc.local should source /etc/rc.conf and -contain additional custom startup code for your system. +to a specific site. .Nm Rc.conf contains the global system configuration information referenced by the rc files, while .Nm rc.conf.local -contains the local system configuration. See rc.conf(5) +contains the local system configuration. .Pp .Nm Rc.shutdown is the command script which contains any necessary commands diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index 6a8e09f368428..6d1f81e1a1a30 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -1,4 +1,4 @@ -# $Id: Makefile,v 1.42 1998/12/22 19:47:48 dillon Exp $ +# $Id: Makefile,v 1.38 1998/09/15 10:26:57 gibbs Exp $ MAN9= MD5.9 \ VFS.9 VFS_FHTOVP.9 VFS_INIT.9 VFS_MOUNT.9 VFS_QUOTACTL.9 \ @@ -11,10 +11,10 @@ MAN9= MD5.9 \ VOP_PATHCONF.9 VOP_PRINT.9 VOP_RDWR.9 VOP_READDIR.9 \ VOP_READLINK.9 VOP_REALLOCBLKS.9 VOP_REMOVE.9 VOP_RENAME.9 \ VOP_STRATEGY.9 \ - at_exit.9 at_fork.9 at_shutdown.9 bios.9 boot.9 buf.9 cd.9 copy.9 \ + at_exit.9 at_fork.9 at_shutdown.9 bios.9 boot.9 cd.9 copy.9 \ devfs_add_devswf.9 devfs_link.9 devfs_remove_dev.9 devstat.9 \ - fetch.9 ifnet.9 inittodr.9 intro.9 kernacc.9 malloc.9 microseq.9 \ - mi_switch.9 namei.9 panic.9 physio.9 posix4.9 ppbconf.9 psignal.9 \ + fetch.9 ifnet.9 inittodr.9 intro.9 kernacc.9 malloc.9 \ + mi_switch.9 namei.9 panic.9 physio.9 posix4.9 psignal.9 \ resettodr.9 rtalloc.9 rtentry.9 scsiconf.9 sd.9 sleep.9 spl.9 st.9 \ store.9 style.9 suser.9 time.9 timeout.9 uio.9 \ vget.9 vnode.9 vput.9 vref.9 vrele.9 vslock.9 @@ -53,9 +53,7 @@ MLINKS+=at_exit.9 rm_at_exit.9 MLINKS+=at_fork.9 rm_at_fork.9 MLINKS+=at_shutdown.9 rm_at_shutdown.9 MLINKS+=copy.9 copyin.9 copy.9 copyinstr.9 copy.9 copyout.9 copy.9 copystr.9 -MLINKS+=devstat.9 devicestat.9 devstat.9 devstat_add_entry.9 -MLINKS+=devstat.9 devstat_remove_entry.9 devstat.9 devstat_start_transaction.9 -MLINKS+=devstat.9 devstat_end_transaction.9 +MLINKS+=devstat.9 devicestat.9 MLINKS+=fetch.9 fubyte.9 fetch.9 fuswintr.9 fetch.9 fusword.9 fetch.9 fuword.9 MLINKS+=ifnet.9 if_data.9 ifnet.9 ifaddr.9 ifnet.9 ifqueue.9 MLINKS+=kernacc.9 useracc.9 @@ -65,8 +63,6 @@ MLINKS+=posix4.9 p1003_1b.9 MLINKS+=psignal.9 gsignal.9 psignal.9 pgsignal.9 MLINKS+=rtalloc.9 rtalloc1.9 rtalloc.9 rtalloc_ign.9 MLINKS+=sleep.9 tsleep.9 sleep.9 wakeup.9 sleep.9 wakeup_one.9 -MLINKS+=sleep.9 asleep.9 sleep.9 await.9 -MLINKS+=buf.9 bp.9 MLINKS+=spl.9 spl0.9 MLINKS+=spl.9 splbio.9 spl.9 splclock.9 spl.9 splhigh.9 spl.9 splimp.9 MLINKS+=spl.9 splnet.9 spl.9 splsoftclock.9 spl.9 splsofttty.9 diff --git a/share/man/man9/buf.9 b/share/man/man9/buf.9 deleted file mode 100644 index 869c90e29476c..0000000000000 --- a/share/man/man9/buf.9 +++ /dev/null @@ -1,123 +0,0 @@ -.\" Copyright (c) 1998 -.\" The Regents of the University of California. 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. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. -.\" 4. 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. -.\" -.\" $Id: security.7,v 1.1 1998/12/20 20:12:17 dillon Exp $ -.\" -.Dd December 22, 1998 -.Dt BUF 9 -.Os -.Sh NAME -.Nm BUF/BP -.Nd Kernel Buffer I/O scheme used in FreeBSD VM system -.Sh DESCRIPTION -.Pp -The kernel implements a KVM abstraction of the buffer cache which allows it -to map potentially disparate vm_page's into contiguous KVM for use by -(mainly filesystem) devices and device I/O. This abstraction supports -block sizes from DEV_BSIZE (usually 512) to upwards of several pages or more. -It also supports a relatively primitive byte-granular valid range and dirty -range currently hardcoded for use by NFS. The code implementing the -VM Buffer abstraction is mostly concentrated in /usr/src/sys/kern/vfs_bio.c. -.Pp -One of the most important things to remember when dealing with buffer pointers -(struct buf) is that the underlying pages are mapped directly from the buffer -cache. No data copying occurs in the scheme proper, though some filesystems -such as UFS do have to copy a little when dealing with file fragments. The -second most important thing to remember is that due to the underlying page -mapping, the b_data base pointer in a buf is always *page* aligned, not -*block* aligned. When you have a VM buffer representing some b_offset and -b_size, the actual start of the buffer is (b_data + (b_offset & PAGE_MASK)) -and not just b_data. Finally, the VM system's core buffer cache supports -valid and dirty bits (m->valid, m->dirty) for pages in DEV_BSIZE chunks. Thus -a platform with a hardware page size of 4096 bytes has 8 valid and 8 dirty -bits. These bits are generally set and cleared in groups based on the device -block size of the device backing the page. Complete page's worth are often -refered to using the VM_PAGE_BITS_ALL bitmask (i.e. 0xFF if the hardware page -size is 4096). -.Pp -VM buffers also keep track of a byte-granular dirty range and valid range. -This feature is normally only used by the NFS subsystem. I'm not sure why it -is used at all, actually, since we have DEV_BSIZE valid/dirty granularity -within the VM buffer. If a buffer dirty operation creates a 'hole', -the dirty range will extend to cover the hole. If a buffer validation -operation creates a 'hole' the byte-granular valid range is left alone and -will not take into account the new extension. Thus the whole byte-granular -abstraction is considered a bad hack and it would be nice if we could get rid -of it completely. -.Pp -A VM buffer is capable of mapping the underlying VM cache pages into KVM in -order to allow the kernel to directly manipulate the data associated with -the (vnode,b_offset,b_size). The kernel typically unmaps VM buffers the moment -they are no longer needed but often keeps the 'struct buf' structure -instantiated and even bp->b_pages array instantiated despite having unmapped -them from KVM. If a page making up a VM buffer is about to undergo I/O, the -system typically unmaps it from KVM and replaces the page in the b_pages[] -array with a placemarker called bogus_page. The placemarker forces any kernel -subsystems referencing the associated struct buf to re-lookup the associated -page. I believe the placemarker hack is used to allow sophisticated devices -such as filesystem devices to remap underlying pages in order to deal with, -for example, remapping a file fragment into a file block. -.Pp -VM buffers are used to track I/O operations within the kernel. Unfortunately, -the I/O implementation is also somewhat of a hack because the kernel wants -to clear the dirty bit on the underlying pages the moment it queues the I/O -to the VFS device, not when the physical I/O is actually initiated. This -can create confusion within filesystem devices that use delayed-writes because -you wind up with pages marked clean that are actually still dirty. If not -treated carefully, these pages could be thrown away! Indeed, a number of -serious bugs related to this hack were not fixed until the 2.2.8/3.0.0 release. -The kernel uses an instantiated VM buffer (i.e. struct buf) to placemark pages -in this special state. The buffer is typically flagged B_DELWRI. When a -device no longer needs a buffer it typically flags it as B_RELBUF. Due to -the underlying pages being marked clean, the B_DELWRI|B_RELBUF combination must -be interpreted to mean that the buffer is still actually dirty and must be -written to its backing store before it can actually be released. In the case -where B_DELWRI is not set, the underlying dirty pages are still properly -marked as dirty and the buffer can be completely freed without losing that -clean/dirty state information. ( XXX do we have to check other flags in -regards to this situation ??? ). -.Pp -The kernel reserves a portion of its KVM space to hold VM Buffer's data -maps. Even though this is virtual space (since the buffers are mapped -from the buffer cache), we cannot make it arbitrarily large because -instantiated VM Buffers (struct buf's) prevent their underlying pages in the -buffer cache from being freed. This can complicate the life of the paging -system. -.Pp -.Sh SEE ALSO -.Pp -.Xr <fillmein> 9 -.Sh HISTORY -The -.Nm -manual page was originally written by Matthew Dillon and first appeared -in FreeBSD-3.0.1, December 1998. - diff --git a/share/man/man9/malloc.9 b/share/man/man9/malloc.9 index ee32f5b95e6ba..bcb69bd53bec4 100644 --- a/share/man/man9/malloc.9 +++ b/share/man/man9/malloc.9 @@ -85,7 +85,7 @@ the kernel version takes two more arguments. The argument further qualifies .Fn malloc No Ns 's operational characteristics as follows: -.Bl -tag -width indent +.Bl -tag -offset indent .It Dv M_NOWAIT Causes .Fn malloc @@ -95,45 +95,19 @@ if the request cannot be immediately fulfilled due to resource shortage. Otherwise, .Fn malloc may call sleep to wait for resources to be released by other processes. -If this flag is set, +If this flag is not set, .Fn malloc -will return -.Dv NULL -rather then block. Note that +will never return +.Dv NULL . +Note that .Dv M_WAITOK -is defined to be 0, meaning that blocking operation is the default. -.It Dv M_ASLEEP -Causes -.Fn malloc -to call -.Fn asleep -if the request cannot be immediately fulfilled due to a resource shortage. -M_ASLEEP is not useful alone and should always be or'd with M_NOWAIT to allow -malloc to call -.Fn asleep -and return -.Dv NULL -immediately. It is expected that the caller will at some point call -.Fn await -and then retry the allocation. Depending on the routine in question, the -caller may decide to propogate the temporary failure up the call chain -and actually have some other higher level routine block on the async wait -that -.Fn malloc -queued. -.It Dv M_WAITOK -indicates that it is Ok to wait for resources. It is unconveniently -defined as 0 so care should be taken never to compare against this value -directly or try to AND it as a flag. The default operation is to block -until the memory allocation succeeds. -.Fn malloc -can only return -.Dv NULL -if -.Dv M_NOWAIT -is specified. +is conveniently defined to be 0, and hence may be or'ed into the +.Fa flags +argument to indicate that it's Ok to wait for resources. .El .Pp +Currently, only one flag is defined. +.Pp The .Fa type argument is used to perform statistics on memory usage, and for @@ -163,23 +137,11 @@ malloc_type_t M_FOOBUF = { ... MALLOC(buf, struct foo_buf *, sizeof *buf, M_FOOBUF, M_NOWAIT); -.Ed +.Be .Sh RETURN VALUES .Fn malloc returns a kernel virtual address that is suitably aligned for storage of -any type of object, or -.Dv NULL -if the request could not be satisfied and -.Dv M_NOWAIT -was set. If -.Dv M_ASLEEP -was set and -.Fn malloc -returns -.Dv NULL , -it will call -.Fn asleep -as a side effect. +any type of object. .Sh SEE ALSO .Xr vmstat 8 .Sh DIAGNOSTICS diff --git a/share/man/man9/microseq.9 b/share/man/man9/microseq.9 deleted file mode 100644 index 630f18630089c..0000000000000 --- a/share/man/man9/microseq.9 +++ /dev/null @@ -1,118 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd June 6, 1998 -.Dt MICROSEQ 9 -.Os FreeBSD -.Sh NAME -.Nm microseq -.Nd -ppbus microseqencer developer's guide -.Sh SYNOPSIS -.Fd "#include <dev/ppbus/ppb_msq.h>" -.Sh DESCRIPTION -See -.Xr ppbus 4 -for ppbus description and general info about the microsequencer. -.Pp -The purpose of this document is to encourage developers to use the -microsequencer mechanism in order to have: -.Bl -enum -offset indent -.It -a uniform programming model -.It -efficient code -.El -.Sh INTERFACE -.Ss C structures -.Bd -literal -union ppb_insarg { - int i; - char c; - void *p; - int (* f)(void *, char *); -}; -.Ed -.Bd -literal -struct ppb_microseq { - int opcode; /* microins. opcode */ - union ppb_insarg arg[PPB_MS_MAXARGS]; /* arguments */ -}; -.Ed -.Ss Using microsequences -.Pp -To instanciate a microsequence, just declare an array of ppb_microseq -structures and initialize it as needed. You may either use defined macros -or code directly your microinstructions according to the ppb_microseq -definition. For example, -.Bd -literal - struct ppb_microseq select_microseq[] = { - - /* parameter list - */ - #define SELECT_TARGET MS_PARAM(0, 1, MS_TYP_INT) - #define SELECT_INITIATOR MS_PARAM(3, 1, MS_TYP_INT) - - /* send the select command to the drive */ - MS_DASS(MS_UNKNOWN), - MS_CASS(H_nAUTO | H_nSELIN | H_INIT | H_STROBE), - MS_CASS( H_AUTO | H_nSELIN | H_INIT | H_STROBE), - MS_DASS(MS_UNKNOWN), - MS_CASS( H_AUTO | H_nSELIN | H_nINIT | H_STROBE), - - /* now, wait until the drive is ready */ - MS_SET(VP0_SELTMO), -/* loop: */ MS_BRSET(H_ACK, 3 /* ready */), - MS_DBRA(-1 /* loop */), -/* error: */ MS_RET(1), -/* ready: */ MS_RET(0) - }; -.Ed -.Pp -Here, some parameters are undefined and must be filled before executing -the microsequence. In order to initialize seach a microsequence, one should -use the ppb_MS_init_msq() function like this: -.Bd -literal - ppb_MS_init_msq(select_microseq, 2, - SELECT_TARGET, 1 << target, - SELECT_INITIATOR, 1 << initiator); -.Ed -.Pp -and then execute the microsequence. -.Ss The microsequencer -The microsequencer is executed either at ppbus or adapter level (see -.Xr ppbus 4 -for info about ppbus system layers). -.Sh SEE ALSO -.Xr ppbus 4 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man9/ppbconf.9 b/share/man/man9/ppbconf.9 deleted file mode 100644 index 9b95e7287593e..0000000000000 --- a/share/man/man9/ppbconf.9 +++ /dev/null @@ -1,205 +0,0 @@ -.\" Copyright (c) 1998, Nicolas Souchu -.\" 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. -.\" -.\" -.Dd April 5, 1998 -.Dt PPBCONF 9 -.Os FreeBSD -.Sh NAME -.Nm ppbconf -.Nd -ppbus developer's guide -.Sh SYNOPSIS -.Fd "#include <dev/ppbus/ppbconf.h>" -.Sh DESCRIPTION -See -.Xr ppbus 4 -for ppbus description. -.Sh PPBUS STRUCTURES -Each ppbus layer -.Po -.Em adapter , -.Em ppbus -and -.Em device -.Pc -is described by one or more C structure. -.Ss The adapter layer -.Bd -literal -struct ppb_adapter { - - void (*intr_handler)(int); - void (*reset_epp_timeout)(int); - void (*ecp_sync)(int); - - int (*exec_microseq)(int, struct ppb_microseq *, int *); - - int (*setmode)(int, int); - - void (*outsb_epp)(int, char *, int); - void (*outsw_epp)(int, char *, int); - void (*outsl_epp)(int, char *, int); - void (*insb_epp)(int, char *, int); - void (*insw_epp)(int, char *, int); - void (*insl_epp)(int, char *, int); - - char (*r_dtr)(int); - char (*r_str)(int); - char (*r_ctr)(int); - char (*r_epp)(int); - char (*r_ecr)(int); - char (*r_fifo)(int); - - void (*w_dtr)(int, char); - void (*w_str)(int, char); - void (*w_ctr)(int, char); - void (*w_epp)(int, char); - void (*w_ecr)(int, char); - void (*w_fifo)(int, char); -}; -.Ed -.Pp -This structure is the interface between -.Xr ppc 4 -layer and upper ppbus system levels. For each ppc device, this -structure is filled with generic i/o functions that may be redefined if -needed for particular chipsets. -.Pp -Developers are really encouraged to use the -exec_microseq entry to avoid indirect function call overhead. See -.Xr microseq 9 -for more info. -.Ss The ppbus layer -.Bd -literal -struct ppb_driver -{ - struct ppb_device *(*probe)(struct ppb_data *ppb); - int (*attach)(struct ppb_device *pdp); - char *name; -}; -.Ed -.Bd -literal -struct ppb_data { - -#define PPB_PnP_PRINTER 0 -#define PPB_PnP_MODEM 1 -#define PPB_PnP_NET 2 -#define PPB_PnP_HDC 3 -#define PPB_PnP_PCMCIA 4 -#define PPB_PnP_MEDIA 5 -#define PPB_PnP_FDC 6 -#define PPB_PnP_PORTS 7 -#define PPB_PnP_SCANNER 8 -#define PPB_PnP_DIGICAM 9 -#define PPB_PnP_UNKNOWN 10 - int class_id; /* not a PnP device if class_id < 0 */ - - ushort mode; /* IEEE 1284-1994 mode - * NIBBLE, PS2, EPP, ECP */ - ushort avm; /* IEEE 1284-1994 available - * modes */ - - struct ppb_link *ppb_link; /* link to the adapter */ - struct ppb_device *ppb_owner; /* device which owns the bus */ - LIST_HEAD(, ppb_device) ppb_devs; /* list of devices on the bus */ - LIST_ENTRY(ppb_data) ppb_chain; /* list of busses */ -}; -.Ed -.Ss The device layer -.Bd -literal -/* microseqences used for GET/PUT operations */ -struct ppb_xfer { - struct ppb_microseq *prolog; /* loop prologue */ - struct ppb_microseq *body; /* loop body */ - struct ppb_microseq *epilog; /* loop epilogue */ -}; -.Ed -.Bd -literal -struct ppb_context { - int valid; /* 1 if the struct is valid */ - int mode; /* operating mode */ - - struct microseq *curpc; /* pc in curmsq */ - struct microseq *curmsq; /* currently executed microseq */ -}; -.Ed -.Bd -literal -struct ppb_device { - - int id_unit; /* unit of the device */ - char *name; /* name of the device */ - - ushort mode; /* current mode of the device */ - ushort avm; /* available modes of the device */ - - struct ppb_context ctx; /* context of the device */ - - /* mode dependent get msq. If NULL, - * IEEE1284 code is used */ - struct ppb_xfer - get_xfer[PPB_MAX_XFER]; - - /* mode dependent put msq. If NULL, - * IEEE1284 code is used */ - struct ppb_xfer - put_xfer[PPB_MAX_XFER]; - - void (*intr)(int); /* interrupt handler */ - - struct ppb_data *ppb; /* link to the ppbus */ - - LIST_ENTRY(ppb_device) chain; /* list of devices on the bus */ -}; -.Ed -.Ss Linking these structures all together -.Bd -literal -struct ppb_link { - - int adapter_unit; /* unit of the adapter */ - int base; /* base address of the port */ - int id_irq; /* != 0 if irq enabled */ - -#define EPP_1_9 0x0 /* default */ -#define EPP_1_7 0x1 - int epp_protocol; /* EPP protocol: 0=1.9, 1=1.7 */ - - struct ppb_adapter *adapter; /* link to the ppc adapter */ - struct ppb_data *ppbus; /* link to the ppbus */ -}; -.Ed -.Sh EXAMPLE -See vpo.c source file. -.Sh SEE ALSO -.Xr ppbus 4 , -.Xr ppi 4 , -.Xr microseq 9 -.Sh HISTORY -The -.Nm -manual page first appeared in -.Fx 3.0 . -.Sh AUTHOR -This -manual page was written by -.An Nicolas Souchu . diff --git a/share/man/man9/sleep.9 b/share/man/man9/sleep.9 index 2d9410b30a6c6..351de02e2cb6c 100644 --- a/share/man/man9/sleep.9 +++ b/share/man/man9/sleep.9 @@ -23,16 +23,14 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: sleep.9,v 1.12 1998/12/21 10:34:53 dillon Exp $ +.\" $Id: sleep.9,v 1.9 1997/04/11 17:49:56 bde Exp $ .\" " -.Dd December 17, 1998 +.Dd April 3, 1996 .Os .Dt SLEEP 9 .Sh NAME .Nm sleep , .Nm tsleep , -.Nm asleep , -.Nm await , .Nm wakeup .Nd wait for events .Sh SYNOPSIS @@ -41,10 +39,6 @@ .Fd #include <sys/proc.h> .Ft int .Fn tsleep "void *ident" "int priority" "const char *wmesg" "int timo" -.Ft int -.Fn asleep "void *ident" "int priority" "const char *wmesg" "int timo" -.Ft int -.Fn await "int priority" "int timo" .Ft void .Fn wakeup "void *ident" .Ft void @@ -112,107 +106,10 @@ is returned if the system call should be interrupted by the signal is the traditional form. It doesn't let you specify a timeout nor a .Ar wmesg , hence its use is deprecated. -.Pp -.Nm Asleep -implements the new asynchronous sleep function. It takes the same arguments -as -.Fn tsleep -and places the process on the appropriate wait queue, but -.Fn asleep -leaves the process runnable and returns immediately. The caller is then -expected to, at some point in the future, call -.Fn await -to actually wait for the previously queued wait condition. -If -.Fn asleep -is called several times, only the most recent call is effective. -.Fn asleep -may be called with an -.Ar ident -value of NULL -to remove any previously queued condition. -.Pp -.Nm Await -implements the new asynchronous wait function. When -.Fn asleep -is called on an identifier it associates the process with that -identifier but does not block. -.Fn await -will actually block the process until -.Fn wakeup -is called on that identifier any time after the -.Fn asleep . -If -.Fn wakeup -is called after you -.Fn asleep -but before you -.Fn await -then the -.Fn await -call is effectively a NOP. -If -.Fn await -is called multiple times without an intervening -.Fn asleep , -the -.Fn await -is effectively a NOP but will also call -.Fn mswitch -for safety. The -.Fn await -function allows you to override the priority and timeout values to be used. -If the value -1 is specified for an argument, the value is taken from the -previous -.Fn asleep -call. If -1 is passed for the priority you must be prepared to catch signal -conditions if the prior call to -.Fn asleep -specified it in its priority. If -1 is passed for the timeout you must be -prepared to catch a timeout condition if the prior call to -.Fn asleep -specified a timeout. When you use -1, it is usually a good idea to not make -assumptions as to the arguments used by the prior -.Fn asleep -call. -.Pp -The -.Fn asleep -and -.Fn await -functions are mainly used by the kernel to shift the burden of blocking -away from extremely low level routines and to push it onto their callers. -This in turn allows more complex interlocking code to -.Em backout -of a temporary resource failure -(such as lack of memory) in order to release major locks prior to actually -blocking, and to then retry the operation on wakeup. This key feature is -expected to be heavily used in SMP situations in order to allow code to make -better use of spinlocks. A spinlock, by its very nature, cannot be used -around code that might block. It is hoped that these capabilities will -make it easier to migrate the SMP master locks deeper into the kernel. -.Pp -These routines may also be used to avoid nasty spl*() calls to get around -race conditions with simple conditional test/wait interlocks. You simple -call -.Fn asleep -prior to your test, then conditonally -.Fn await -only if the test fails. It is usually a good idea to cancel an -.Fn asleep -if you wind up never calling the related -.Fn await , -but it is not required. If you do not want to waste cpu calling -.Fn asleep -unnecessarily, you can surround the whole thing with a second test. The -race condition is still handled by the inside -.Fn asleep -call. .Sh RETURN VALUES See above. .Sh SEE ALSO -.Xr ps 1 , -.Xr malloc 9 +.Xr ps 1 .Sh HISTORY The sleep/wakeup process synchronization mechanism is very old. It appeared in a very early version of Unix. @@ -220,12 +117,7 @@ appeared in a very early version of Unix. .Nm Tsleep appeared in .Bx 4.4 . -.Pp -.Nm Asleep/await -first appeared in FreeBSD-3.0.1 and is designed to shift the burden of blocking -away from extremely low level routines and push it up to their callers. .Sh AUTHORS This man page has been written by .ie t J\(:org Wunsch. -.el Joerg Wunsch. -asleep/await designed and written by Matthew Dillon. +.el Joerg Wunsch. diff --git a/share/man/man9/spl.9 b/share/man/man9/spl.9 index ef1a19cad830d..f4befd45aaf6a 100644 --- a/share/man/man9/spl.9 +++ b/share/man/man9/spl.9 @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: spl.9,v 1.6 1998/01/16 18:14:34 bde Exp $ +.\" $Id: spl.9,v 1.5 1997/04/13 14:49:09 bde Exp $ .\" " .Dd July 21, 1996 .Os @@ -84,7 +84,7 @@ Each driver that uses interrupts is normally assigned to an interrupt priority group by a keyword in its config line. For example: .Bd -literal -offset indent -device foo0 at isa? port 0x0815 irq 12 tty +device foo0 at isa? port 0x0815 irq 12 tty vector foointr .Ed .Pp assigns interrupt 12 to the |