diff --git a/share/man/man3/fpgetround.3 b/share/man/man3/fpgetround.3 index bfc4368c6693..7dce03a16e42 100644 --- a/share/man/man3/fpgetround.3 +++ b/share/man/man3/fpgetround.3 @@ -107,7 +107,8 @@ .Fn fpresetsticky "fp_except_t sticky" .Sh DESCRIPTION When a floating point exception is detected, the exception sticky flag is -set and the exception mask is tested. If the mask is set, then a trap +set and the exception mask is tested. +If the mask is set, then a trap occurs. These routines allow both setting the floating point exception masks, and resetting the exception sticky flags after an exception is detected. In addition, they allow setting the floating point rounding mode diff --git a/share/man/man3/pthread.3 b/share/man/man3/pthread.3 index ee579916e370..d9152d9907c2 100644 --- a/share/man/man3/pthread.3 +++ b/share/man/man3/pthread.3 @@ -40,7 +40,8 @@ POSIX threads are a set of functions that support applications with requirements for multiple flows of control, called .Fa threads , -within a process. Multithreading is used to improve the performance of a +within a process. +Multithreading is used to improve the performance of a program. .Pp The POSIX thread functions are summarized in this section in the following diff --git a/share/man/man4/an.4 b/share/man/man4/an.4 index 1a26d642b50b..2743c6706493 100644 --- a/share/man/man4/an.4 +++ b/share/man/man4/an.4 @@ -44,9 +44,12 @@ Aironet Communications 4500/4800 wireless network adapter driver The .Nm driver provides support for Aironet Communications 4500 and 4800 -wireless network adapters. This includes the ISA, PCI and PCMCIA -varieties. The 4500 series adapters operate at 1 and 2Mbps while -the 4800 series can operate at 1, 2, 5.5 and 11Mbps. The ISA, PCI +wireless network adapters. +This includes the ISA, PCI and PCMCIA +varieties. +The 4500 series adapters operate at 1 and 2Mbps while +the 4800 series can operate at 1, 2, 5.5 and 11Mbps. +The ISA, PCI and PCMCIA devices are all based on the same core PCMCIA modules and all have the same programming interface, however unlike the Lucent WaveLAN/IEEE cards, the ISA and PCI cards appear to the @@ -56,23 +59,27 @@ support. The PCMCIA Aironet cards require pccard support, including the kernel pccard driver support and the .Xr pccardd 8 -daemon. ISA cards can either be configured to use ISA Plug and Play +daemon. +ISA cards can either be configured to use ISA Plug and Play or to use a particular I/O address and IRQ by properly setting the DIP switches on the board. (The default switch setting is for plug and play.) The .Nm driver has Plug and Play support and will work in either configuration, however when using a hard-wired I/O address and IRQ, the driver -configuration and the NIC's switch settings must agree. PCI cards +configuration and the NIC's switch settings must agree. +PCI cards require no switch settings of any kind and will be automatically probed and attached. .Pp All host/device interaction with the Aironet cards is via programmed I/O. The Aironet devices support 802.11 and 802.3 frames, power management, -BSS (infrastructure) and IBSS (ad-hoc) operation modes. The +BSS (infrastructure) and IBSS (ad-hoc) operation modes. +The .Nm driver encapsulates all IP and ARP traffic as 802.11 frames, however -it can receive either 802.11 or 802.3 frames. Transmit speed is +it can receive either 802.11 or 802.3 frames. +Transmit speed is selectable between 1Mbps, 2Mbps, 5.5Mbps, 11Mbps or "auto" (the NIC automatically chooses the best speed). .Pp @@ -81,7 +88,8 @@ By default, the driver configures the Aironet card for ad-hoc operation with an SSID of "ANY." In this mode, stations can communicate among each other without the aid of an access -point. To join a service set, the driver must be set for BSS mode using +point. +To join a service set, the driver must be set for BSS mode using the .Xr ancontrol 8 utility. diff --git a/share/man/man4/atkbdc.4 b/share/man/man4/atkbdc.4 index 40a06ee098ac..c8c6d08892d9 100644 --- a/share/man/man4/atkbdc.4 +++ b/share/man/man4/atkbdc.4 @@ -76,8 +76,10 @@ wait before eventually giving up -- the driver will wait .Fa X * .Fa Y -msecs at most. If the drivers seem unable to detect -devices, you may want to increase these values. The default values are +msecs at most. +If the drivers seem unable to detect +devices, you may want to increase these values. +The default values are 200 msec for .Fa X and 5 diff --git a/share/man/man4/aue.4 b/share/man/man4/aue.4 index 76187d33282b..89bcac437b6c 100644 --- a/share/man/man4/aue.4 +++ b/share/man/man4/aue.4 @@ -53,13 +53,16 @@ SMC 2202USB. .Pp The Pegasus contains a 10/100 ethernet MAC with MII interface and is designed to work with both -ethernet and HomePNA transceivers. Although designed to interface with +ethernet and HomePNA transceivers. +Although designed to interface with 100Mbps peripherals, the existing USB standard specifies a maximum -transfer speed of 12Mbps. Users should therefore not expect to actually +transfer speed of 12Mbps. +Users should therefore not expect to actually achieve 100Mbps speeds with these devices. .Pp The Pegasus supports a 64-bit multicast hash table, single perfect -filter entry for the station address and promiscuous mode. Packets are +filter entry for the station address and promiscuous mode. +Packets are received and transmitted over separate USB bulk transfer endpoints. .Pp The @@ -74,21 +77,25 @@ the autoselected mode by adding media options to the .Pa /etc/rc.conf file. .It 10baseT/UTP -Set 10Mbps operation. The +Set 10Mbps operation. +The .Ar mediaopt option can also be used to enable .Ar full-duplex -operation. Not specifying +operation. +Not specifying .Ar full duplex implies .Ar half-duplex mode. .It 100baseTX -Set 100Mbps (fast ethernet) operation. The +Set 100Mbps (fast ethernet) operation. +The .Ar mediaopt option can also be used to enable .Ar full-duplex -operation. Not specifying +operation. +Not specifying .Ar full duplex implies .Ar half-duplex @@ -101,7 +108,8 @@ driver supports the following media options: .Pp .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It full-duplex -Force full duplex operation. The interface will operate in +Force full duplex operation. +The interface will operate in half duplex mode if this media option is not specified. .El .Pp diff --git a/share/man/man4/bridge.4 b/share/man/man4/bridge.4 index 564450cd33dd..f11ab53f9f14 100644 --- a/share/man/man4/bridge.4 +++ b/share/man/man4/bridge.4 @@ -9,7 +9,8 @@ .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 +interfaces. +This is achieved using the following option .Bd -literal options BRIDGE .Ed @@ -28,10 +29,12 @@ Set to 1 to enable bridging, set to 0 to disable it Set to 1 to enable .Nm ipfw -filtering on bridged packets. Note that +filtering on bridged packets. +Note that .Nm ipfw rules only apply -to IP packets. Non-IP packets are subject to the default +to IP packets. +Non-IP packets are subject to the default .Nm ipfw rule .Pq number 65535 @@ -45,7 +48,8 @@ bridge. .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 +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, diff --git a/share/man/man4/cd.4 b/share/man/man4/cd.4 index a3b354fa24ab..2ffad2cbe387 100644 --- a/share/man/man4/cd.4 +++ b/share/man/man4/cd.4 @@ -61,7 +61,8 @@ As the .Tn SCSI adapter is probed during boot, the .Tn SCSI -bus is scanned for devices. Any devices found which answer as CDROM +bus is scanned for devices. +Any devices found which answer as CDROM (type 5) or WORM (type 4) type devices will be `attached' to the .Nm driver. @@ -370,11 +371,13 @@ The audio code in the .Nm driver only support .Tn SCSI-2 -standard audio commands. Because many +standard audio commands. +Because many .Tn CD-ROM manufacturers have not followed the standard, there are many .Tn CD-ROM -drives for which audio will not work. Some work is planned to support +drives for which audio will not work. +Some work is planned to support some of the more common `broken' .Tn CD-ROM drives; however, this is not yet under way. diff --git a/share/man/man4/ch.4 b/share/man/man4/ch.4 index de958eac69e4..d000c1474d82 100644 --- a/share/man/man4/ch.4 +++ b/share/man/man4/ch.4 @@ -38,7 +38,8 @@ The .Xr ch driver provides support for a .Em SCSI -media changer. It allows many slots of media to be multiplexed between +media changer. +It allows many slots of media to be multiplexed between a number of drives. The changer device may optionally be equipped with a bar code reader, which reads label informationen attached to the media. @@ -48,7 +49,8 @@ before a SCSI changer can be configured. .Pp As the SCSI adapter is probed during boot, the .Em SCSI -bus is scanned for devices. Any devices found which answer as 'Changer' +bus is scanned for devices. +Any devices found which answer as 'Changer' type devices will be 'attached' to the .Nm driver. @@ -91,7 +93,8 @@ Data transfer element (drive). .Pp The following .Xr ioctl 2 -calls apply to the changer. They are defined +calls apply to the changer. +They are defined in the header file .Aq Pa sys/chio.h . .Pp diff --git a/share/man/man4/csa.4 b/share/man/man4/csa.4 index bfb887b3a5f8..dfb60f57a387 100644 --- a/share/man/man4/csa.4 +++ b/share/man/man4/csa.4 @@ -47,7 +47,8 @@ Crystal Semiconductor CS428x Audio Controller .El .Pp Some onboard CS4610 chips accompany with not CS4297 AC97 -codec but CS423x ISA codec. Such the configuration is not +codec but CS423x ISA codec. +Such the configuration is not sypported by .Nm yet. diff --git a/share/man/man4/cue.4 b/share/man/man4/cue.4 index 31c65155ce41..7b700b516576 100644 --- a/share/man/man4/cue.4 +++ b/share/man/man4/cue.4 @@ -51,7 +51,8 @@ Access Technology Corporation's USB-EL1210A chipset, including the CATC Netmate and Netmate II, and the Belkin F5U111. .Pp The USB-EL1210A supports a 512-bit multicast hash filter, single perfect -filter entry for the station address and promiscuous mode. Packets are +filter entry for the station address and promiscuous mode. +Packets are received and transmitted over separate USB bulk transfer endpoints. .Pp The CATC adapter supports only 10mbps half-duplex mode, hence there diff --git a/share/man/man4/da.4 b/share/man/man4/da.4 index 0d442cfd4ed8..0c6c64dd789a 100644 --- a/share/man/man4/da.4 +++ b/share/man/man4/da.4 @@ -164,13 +164,15 @@ drives incorporate their own bad-block mapping so this command is not implemented. .It Dv DIOCGDINFO Read, from the kernel, the in-core copy of the disklabel for the -drive. This may be a fictitious disklabel if the drive has never +drive. +This may be a fictitious disklabel if the drive has never been initialized, in which case it will contain information read from the .Tn SCSI inquiry commands. .It Dv DIOCSDINFO -Give the driver a new disklabel to use. The driver +Give the driver a new disklabel to use. +The driver .Em will not write the new disklabel to the disk. @@ -178,7 +180,8 @@ disklabel to the disk. Enable or disable the driver's software write protect of the disklabel on the disk. .It Dv DIOCWDINFO -Give the driver a new disklabel to use. The driver +Give the driver a new disklabel to use. +The driver .Em will write the new disklabel to the disk. .El diff --git a/share/man/man4/dc.4 b/share/man/man4/dc.4 index ce0cc78c44a8..4f826eb2fb66 100644 --- a/share/man/man4/dc.4 +++ b/share/man/man4/dc.4 @@ -64,28 +64,36 @@ Lite-On/Macronix 82c115 PNIC II .El .Pp All of these chips have the same general register layout, DMA -descriptor format and method of operation. All of the clone chips -are based on the 21143 design with various modifications. The +descriptor format and method of operation. +All of the clone chips +are based on the 21143 design with various modifications. +The 21143 itself has support for 10baseT, BNC, AUI, MII and symbol media attachments, 10 and 100Mbps speeds in full or half duplex, -built in NWAY autonegotiation and wake on LAN. The 21143 also +built in NWAY autonegotiation and wake on LAN. +The 21143 also offers several receive filter programming options including perfect filtering, inverse perfect filtering and hash table filtering. .Pp Some clone chips duplicate the 21143 fairly closely while others -only maintain superficial simularities. Some support only MII -media attachments. Others use different receiver filter programming -mechanisms. At least one supports only chained DMA descriptors +only maintain superficial simularities. +Some support only MII +media attachments. +Others use different receiver filter programming +mechanisms. +At least one supports only chained DMA descriptors (most support both chained descriptors and contiguously allocated fixed size rings). Some chips (especially the PNIC) also have -peculiar bugs. The +peculiar bugs. +The .Nm driver does its best to provide generalized support for all of these chipsets in order to keep special case code to a minimun. .Pp These chips are used by many vendors which makes it -difficult provide a complete list of all supported cards. The +difficult provide a complete list of all supported cards. +The following NICs are known to work with the .Nm driver at this time: @@ -146,24 +154,29 @@ Note: the built-in NWAY autonegotiation on the original PNIC 82c168 chip is horribly broken and is not supported by the .Nm driver at this time: the chip will operate in any speed or duplex -mode, however these must be set manually. The original 82c168 appears +mode, however these must be set manually. +The original 82c168 appears on very early revisions of the LinkSys LNE100TX and Matrox FastNIC. .It 10baseT/UTP -Set 10Mbps operation. The +Set 10Mbps operation. +The .Ar mediaopt option can also be used to enable .Ar full-duplex -operation. Not specifying +operation. +Not specifying .Ar full duplex implies .Ar half-duplex mode. .It 100baseTX -Set 100Mbps (fast ethernet) operation. The +Set 100Mbps (fast ethernet) operation. +The .Ar mediaopt option can also be used to enable .Ar full-duplex -operation. Not specifying +operation. +Not specifying .Ar full duplex implies .Ar half-duplex @@ -176,7 +189,8 @@ driver supports the following media options: .Pp .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It full-duplex -Force full duplex operation. The interface will operate in +Force full duplex operation. +The interface will operate in half duplex mode if this media option is not specified. .El .Pp @@ -193,40 +207,49 @@ A fatal initialization error has occurred. .It "dc%d: watchdog timeout" A packet was queued for transmission and a transmit command was issued, however the device failed to acknowledge the transmission -before a timeout expired. This can happen if the device is unable +before a timeout expired. +This can happen if the device is unable to deliver interrupts for some reason, of if there is a problem with the network connection (cable). .It "dc%d: no memory for rx list" The driver failed to allocate an mbuf for the receiver ring. .It "dc%d: TX underrun -- increasing TX threshold" The device generated a transmit underrun error while attempting to -DMA and transmit a packet. This happens if the host is not able to -DMA the packet data into the NIC's FIFO fast enough. The driver +DMA and transmit a packet. +This happens if the host is not able to +DMA the packet data into the NIC's FIFO fast enough. +The driver will dynamically increase the transmit start threshold so that more data must be DMAed into the FIFO before the NIC will start transmitting it onto the wire. .It "dc%d: TX underrun -- using store and forward mode" The device continued to generate transmit underruns even after all possible transmit start threshold settings had been tried, so the -driver programmed the chip for store and forward mode. In this mode, +driver programmed the chip for store and forward mode. +In this mode, the NIC will not begin transmission until the entire packet has been transfered into its FIFO memory. .It "dc%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 +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 +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 +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 +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 +operating system. +If you power down your system prior to booting .Fx , the card should be configured correctly. .El @@ -272,13 +295,16 @@ driver was written by .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 +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 +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. .Pp The original 82c168 PNIC chip has built in NWAY support which is @@ -293,7 +319,8 @@ autonegotiation and work correctly.) The .Nm driver programs 82c168 and 82c169 PNIC chips to use the store and -forward setting for the transmit start threshold by default. This +forward setting for the transmit start threshold by default. +This is to work around problems with some NIC/PCI bus combinations where the PNIC can transmit corrupt frames when operating at 100Mbps, probably due to PCI DMA burst transfer errors. @@ -301,16 +328,19 @@ probably due to PCI DMA burst transfer errors. The 82c168 and 82c169 PNIC chips also have a receiver bug that sometimes manifests during periods of heavy receive and transmit activity, where the chip will improperly DMA received frames to -the host. The chips appear to upload several kilobytes of garbage +the host. +The chips appear to upload several kilobytes of garbage data along with the received frame data, dirtying several RX buffers -instead of just the expected one. The +instead of just the expected one. +The .Nm driver detects this condition and will salvage the frame, however it incurs a serious performance penalty in the process. .Pp The PNIC chips also sometimes generate a transmit underrun error when the driver attempts to download the receiver filter setup frame, which -can result in the receive filter being incorrectly programmed. The +can result in the receive filter being incorrectly programmed. +The .Nm driver will watch for this condition and requeue the setup frame until it is transfered successfully. @@ -318,11 +348,13 @@ it is transfered successfully. The ADMtek AL981 chip (and possibly the AN985 as well) has been observed to sometimes wedge on transmit: this appears to happen when the driver queues a sequence of frames which cause it to wrap from the end of the -the transmit descriptor ring back to the beginning. The +the transmit descriptor ring back to the beginning. +The .Nm driver attempts to avoid this condition by not queing any frames past the end of the transmit ring during a single invocation of the .Fn dc_start -routine. This workaround has a negligible impact on transmit performance. +routine. +This workaround has a negligible impact on transmit performance. diff --git a/share/man/man4/divert.4 b/share/man/man4/divert.4 index f15307b17fe4..83ce104aa834 100644 --- a/share/man/man4/divert.4 +++ b/share/man/man4/divert.4 @@ -19,7 +19,8 @@ can be bound to a specific .Nm port via the .Xr bind 2 -system call. The IP address in the bind is ignored; only the port +system call. +The IP address in the bind is ignored; only the port number is significant. A divert socket bound to a divert port will receive all packets diverted to that port by some (here unspecified) kernel mechanism(s). @@ -29,7 +30,8 @@ re-enter kernel IP packet processing. Divert sockets are normally used in conjunction with FreeBSD's packet filtering implementation and the .Xr ipfw 8 -program. By reading from and writing to a divert socket, matching packets +program. +By reading from and writing to a divert socket, matching packets can be passed through an arbitrary ``filter'' as they travel through the host machine, special routing tricks can be done, etc. .Sh READING PACKETS @@ -71,7 +73,8 @@ incoming and full packet routing is done. In the latter case, the IP address specified must match the address of some local interface, or an interface name -must be found after the IP address. If an interface name is found, +must be found after the IP address. +If an interface name is found, that interface will be used and the value of the IP address will be ignored (other than the fact that it is not .Dv INADDR_ANY @@ -88,7 +91,8 @@ simplifies things (see below). .Pp The port part of the socket address passed to the .Xr sendto 2 -contains a tag that should be meaningful to the diversion module. In the +contains a tag that should be meaningful to the diversion module. +In the case of .Xr Ipfw 8 the tag is interpretted as the rule number @@ -155,9 +159,11 @@ could be cleaner, and it's too dependent on .Xr ipfw 8 . .Pp It's questionable whether incoming fragments should be reassembled -before being diverted. For example, if only some fragments of a +before being diverted. +For example, if only some fragments of a packet destined for another machine don't get routed through the -local machine, the packet is lost. This should probably be +local machine, the packet is lost. +This should probably be a settable socket option in any case. .Sh AUTHORS .An Archie Cobbs Aq archie@whistle.com , diff --git a/share/man/man4/dummynet.4 b/share/man/man4/dummynet.4 index 62b89d5c039c..d74ca1ea9ab9 100644 --- a/share/man/man4/dummynet.4 +++ b/share/man/man4/dummynet.4 @@ -30,7 +30,8 @@ A dummynet is characterized by a bandwidth, delay, queue size, and loss rate, which can be configured with the .Nm ipfw -program. Pipes are +program. +Pipes are numbered from 1 to 65534, and packets can be passed through multiple pipes depending on the ipfw configuration. .Pp @@ -85,7 +86,8 @@ 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 +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 @@ -96,7 +98,8 @@ destination, or passed again through the rules, starting from the one after the matching rule. .Pp .Nm dummynet -performs its task once per timer tick. The granularity of operation is +performs its task once per timer tick. +The granularity of operation is thus controlled by the kernel option .Bd -literal options HZ @@ -104,9 +107,11 @@ thus controlled by the kernel option 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, +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 +time to output packets. +So, reducing the granularity too much might actually cause ticks to be missed thus reducing the accuracy of operation. @@ -177,6 +182,7 @@ dummynet. dummynet was initially implemented as a testing tool for TCP congestion control by Luigi Rizzo , as described on ACM Computer -Communication Review, Jan.97 issue. Later it has been then modified +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/fdc.4 b/share/man/man4/fdc.4 index 4b109b498414..9ad3931e38c1 100644 --- a/share/man/man4/fdc.4 +++ b/share/man/man4/fdc.4 @@ -39,13 +39,16 @@ PC architecture floppy disk controller driver .Cd device fd1 at fdc0 drive 1 .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 +In /dev for each floppy device a number of minor devices are present. +The /dev/fd* devices with trailing alphabetic characters are used to indicate .Sq partitions -on the floppy disk. The /dev/fd*. are devices that +on the floppy disk. +The /dev/fd*. are devices that indicate the size of the floppy disk (so: 720kB, 1440kB etc). The latter are used for formatting disks using fdformat or for accessing different -density disks in multidensity drive. Example: 720kB disk in a 1.44Mb drive. +density disks in multidensity drive. +Example: 720kB disk in a 1.44Mb drive. .Pp Normally, the driver will ask the system's CMOS memory to obtain the floppy drive configuration. Some machines do not store any form of a diff --git a/share/man/man4/gusc.4 b/share/man/man4/gusc.4 index aa9a6bb185cf..f8504e693a21 100644 --- a/share/man/man4/gusc.4 +++ b/share/man/man4/gusc.4 @@ -50,7 +50,8 @@ Gravis UltraSound PnP Gravis UltraSound MAX .El .Pp -The value of flags specifies the secondary DMA channel. If the secondary +The value of flags specifies the secondary DMA channel. +If the secondary DMA channel is C, set the flags to (C | 0x10). For a sound card without the secondary DMA channel, the flags should be set to zero. .Sh DIAGNOSTICS diff --git a/share/man/man4/iic.4 b/share/man/man4/iic.4 index f023058c663a..ea69705be4a2 100644 --- a/share/man/man4/iic.4 +++ b/share/man/man4/iic.4 @@ -38,7 +38,8 @@ 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 +instance. +In order to control I2C devices, use /dev/iic? with the following ioctls: .Pp .Bl -column "Ioctls" -compact diff --git a/share/man/man4/iicbus.4 b/share/man/man4/iicbus.4 index becee870a345..3b494def642d 100644 --- a/share/man/man4/iicbus.4 +++ b/share/man/man4/iicbus.4 @@ -45,25 +45,33 @@ 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 +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 +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 +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 +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 +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. +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 @@ -76,9 +84,11 @@ Some I2C device drivers are available: .It Sy iicsmb Ta "I2C to SMB software bridge" .El .Sh INTERFACES -The I2C protocol may be implemented by hardware or software. Software +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 +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 diff --git a/share/man/man4/inet.4 b/share/man/man4/inet.4 index b4bc113a59ab..b3b0ff23c521 100644 --- a/share/man/man4/inet.4 +++ b/share/man/man4/inet.4 @@ -230,7 +230,8 @@ It is not guaranteed that every packet will be fast-forwarded. Boolean: enable/disable sending of ICMP redirects in response to unforwardable .Tn IP -packets. Defaults to on. +packets. +Defaults to on. .It Dv IPCTL_DEFTTL .Pq ip.ttl Integer: default time-to-live diff --git a/share/man/man4/intpm.4 b/share/man/man4/intpm.4 index 09e3f0b3448d..68c04b6cbb9d 100644 --- a/share/man/man4/intpm.4 +++ b/share/man/man4/intpm.4 @@ -42,8 +42,10 @@ .Sh DESCRIPTION This driver provides access to .Tn Intel PIIX4 PCI Controller function 3 , -Power management controller. Currently, only smbus controller -function is implemented. But it also have bus idle monitoring function. It +Power management controller. +Currently, only smbus controller +function is implemented. But it also have bus idle monitoring function. +It will display mapped I/O address for bus monitoring function when attaching. .Sh SEE ALSO @@ -59,6 +61,8 @@ This manual page was written by .An Takanori Watanabe Aq takawata@shidahara1.planet.sci.kobe-u.ac.jp . .Sh BUGS -This device requires IRQ 9 exclusively. To use this, you should enable +This device requires IRQ 9 exclusively. +To use this, you should enable ACPI function in BIOS configuration, or PnP mechanism assigns conflicted -IRQ for PnP ISA card. And don't use IRQ 9 for Non-PnP ISA cards. +IRQ for PnP ISA card. +And don't use IRQ 9 for Non-PnP ISA cards. diff --git a/share/man/man4/ip.4 b/share/man/man4/ip.4 index ed8a2bcd9d9b..f631f1d6cf71 100644 --- a/share/man/man4/ip.4 +++ b/share/man/man4/ip.4 @@ -103,7 +103,8 @@ header for .Dv SOCK_STREAM and .Dv SOCK_DGRAM -sockets. For example, +sockets. +For example, .Bd -literal int tos = IPTOS_LOWDELAY; /* see */ setsockopt(s, IPPROTO_IP, IP_TOS, &tos, sizeof(tos)); @@ -137,7 +138,8 @@ cmsg_type = IP_RECVDSTADDR .Pp .Dv IP_PORTRANGE may be used to set the port range used for selecting a local port number -on a socket with an unspecified (zero) port number. It has the following +on a socket with an unspecified (zero) port number. +It has the following possible values: .Bl -tag -width IP_PORTRANGE_DEFAULT .It Dv IP_PORTRANGE_DEFAULT diff --git a/share/man/man4/ipfirewall.4 b/share/man/man4/ipfirewall.4 index c5c3e7437b3f..e857ee771b81 100644 --- a/share/man/man4/ipfirewall.4 +++ b/share/man/man4/ipfirewall.4 @@ -17,13 +17,16 @@ .Sh DESCRIPTION Ipfirewall (alias ipfw) is a system facility which allows filtering, redirecting, and other operations on IP packets travelling through -system interfaces. Packets are matched by applying an ordered list +system interfaces. +Packets are matched by applying an ordered list of pattern rules against each packet until a match is found, at -which point the corresponding action is taken. Rules are numbered +which point the corresponding action is taken. +Rules are numbered from 1 to 65534; multiple rules may share the same number. .Pp There is one rule that always exists, rule number 65535. This rule -normally causes all packets to be dropped. Hence, any packet which does not +normally causes all packets to be dropped. +Hence, any packet which does not match a lower numbered rule will be dropped. However, a kernel compile time option .Dq IPFIREWALL_DEFAULT_TO_ACCEPT @@ -43,7 +46,8 @@ IP_FW_DEL deletes all rules having the matching rule number. IP_FW_GET returns the (first) rule having the matching rule number. .Pp IP_FW_ZERO zeros the statistics associated with all rules having the -matching rule number. If the rule number is zero, all rules are zeroed. +matching rule number. +If the rule number is zero, all rules are zeroed. .Pp IP_FW_FLUSH removes all rules (except 65535). .Pp @@ -171,7 +175,8 @@ Options in the kernel configuration file: When packets match a rule with the IP_FW_F_PRN bit set, a message is logged to the console if IPFIREWALL_VERBOSE has been enabled; IPFIREWALL_VERBOSE_LIMIT limits the maximum number of times each -rule can cause a log message. These variables are also +rule can cause a log message. +These variables are also available via the .Xr sysctl 3 interface. @@ -179,7 +184,7 @@ interface. [EINVAL] The IP option field was improperly formed; an option field was shorter than the minimum value or longer than - the option buffer provided. A structural error in + the option buffer provided. A structural error in ip_fw structure occurred (n_src_p+n_dst_p too big, ports set for ALL/ICMP protocols etc.). An invalid rule number was used. diff --git a/share/man/man4/isp.4 b/share/man/man4/isp.4 index a5e1bd9ebfa8..c16c7329e7cc 100644 --- a/share/man/man4/isp.4 +++ b/share/man/man4/isp.4 @@ -103,7 +103,8 @@ General configuration options for all adapters include: .Cd options SCSI_ISP_PREFER_MEM_MAP .sp for which the option value is a bit mask of units for which you want this -option to apply. The options are, respectively, for not loading new firmware +option to apply. +The options are, respectively, for not loading new firmware at startup, ignoring card NVRAM settings, and preferring memory mapped versus I/O port PCI access methods. .Pp @@ -133,14 +134,17 @@ Configuration options specific to Fibre Channel Cards are: .Cd options SCSI_ISP_WWN .sp The first option is a bit mask of units for which you want to enable full -duplex mode. This typically would only make sense if fabric support is +duplex mode. +This typically would only make sense if fabric support is enabled and you are directly connected to a switch. The second defines whether Fibre Channel Fabric support should be enabled. The third defines whether whether the first level SCC lun support should be enabled- this converts the normal 16 Logical Unit support to support for -65536 Logical Units. The last option should be a string that defines an +65536 Logical Units. +The last option should be a string that defines an overriding World Wide Node Name (WWNN) should you wish to override NVRAM -settings. It is recommended that you compile in firmware if you select +settings. +It is recommended that you compile in firmware if you select any of these options. .Sh BOOT OPTIONS .Pp @@ -192,7 +196,8 @@ Simple Name Server subcommand which some switches don't handle as well as they should. .Pp Sometimes, when booting, the driver gets stuck waiting for the Fibre Channel -f/w to tell it that the loop port database is ready. In this case you'll +f/w to tell it that the loop port database is ready. +In this case you'll see an announcement that the loop state has a value of 0x1. To unwedge the system, unplug and replug the fibre channel connection, or otherwise cause a LIP (Loop Initialization Primitive sequence)- this will kick the f/w diff --git a/share/man/man4/keyboard.4 b/share/man/man4/keyboard.4 index 1e8c82e0b8a1..aeeb4f69b9bc 100644 --- a/share/man/man4/keyboard.4 +++ b/share/man/man4/keyboard.4 @@ -9,11 +9,13 @@ .Nd pc keyboard interface .Sh DESCRIPTION -The PC keyboard is used as the console character input device. The keyboard +The PC keyboard is used as the console character input device. +The keyboard is owned by the current virtual console. To switch between the virtual consoles use the sequence .Ar ALT+Fn , -which means hold down ALT and press one of the function keys. The +which means hold down ALT and press one of the function keys. +The virtual console with the same number as the function key is then selected as the current virtual console and given exclusive use of the keyboard and display. @@ -22,11 +24,15 @@ The console allows entering values that are not physically present on the keyboard via a special keysequence. To use this facility press and hold down ALT, then enter a decimal number from 0-255 via the numerical keypad, then -release ALT. The entered value is then used as the ASCII value for one -character. This way it is possible to enter any ASCII value, not present +release ALT. +The entered value is then used as the ASCII value for one +character. +This way it is possible to enter any ASCII value, not present on the keyboard. -The console driver also includes a history function. It is activated by -pressing the scroll-lock key. This holds the display, and enables the cursor +The console driver also includes a history function. +It is activated by +pressing the scroll-lock key. +This holds the display, and enables the cursor arrows for scrolling up and down through the last scrolled out lines. The keyboard is configurable to suit the individual user and the different @@ -44,13 +50,16 @@ The keys on the keyboard can have any of the following functions: The keyboard is seen as a number of keys numbered from 1 to n. This -number is often referred to as the "scancode" for a given key. The number +number is often referred to as the "scancode" for a given key. +The number of the key is transmitted as an 8 bit char with bit 7 as 0 when a key is -pressed, and the number with bit 7 as 1 when released. This makes it +pressed, and the number with bit 7 as 1 when released. +This makes it possible to make the mapping of the keys fully configurable. The meaning of every key is programmable via the PIO_KEYMAP ioctl call, that -takes a structure keymap_t as argument. The layout of this structure is as +takes a structure keymap_t as argument. +The layout of this structure is as follows: .Pp .Bd -literal -offset indent @@ -65,10 +74,12 @@ follows: .Ed .Pp The field n_keys tells the system how many keydefinitions (scancodes) -follows. Each scancode is then specified in the key_t substructure. +follows. +Each scancode is then specified in the key_t substructure. Each scancode can be translated to any of 8 different values, depending -on the shift, control, and alt state. These eight possibilities are +on the shift, control, and alt state. +These eight possibilities are represented by the map array, as shown below: alt @@ -83,7 +94,8 @@ scancode 0x1E. The eight states are as shown, giving the 'A' key its normal behavior. The spcl field is used to give the key "special" treatment, and is interpreted as follows. -Each bit corresponds to one of the states above. If the bit is 0 the +Each bit corresponds to one of the states above. +If the bit is 0 the key emits the number defined in the corresponding map[] entry. If the bit is 1 the key is "special". This means it does not emit anything; instead it changes the "state". That means it is a shift, @@ -96,7 +108,8 @@ num-lock (2), both (3) or ignore both (0). The .Xr kbdcontrol 1 utility is used to load such a description into/outof -the kernel at runtime. This makes it possible to change the key +the kernel at runtime. +This makes it possible to change the key assignments at runtime, or more important to get (GIO_KEYMAP ioctl) the exact key meanings from the kernel (fx. used by the X server). diff --git a/share/man/man4/kld.4 b/share/man/man4/kld.4 index 308d7b6bed43..b950202095f0 100644 --- a/share/man/man4/kld.4 +++ b/share/man/man4/kld.4 @@ -35,7 +35,8 @@ The LKM (Loadable Kernel Modules) facility has been deprecated in FreeBSD 3.0 and above in favor of the .Nm -interface. This interface, like its +interface. +This interface, like its predecessor, allows the system administrator to dynamically add and remove functionality from a running system. This ability also helps software developers to develop new parts of the kernel without constantly rebooting diff --git a/share/man/man4/kue.4 b/share/man/man4/kue.4 index 6d41aaae514c..4b6bc75abe1b 100644 --- a/share/man/man4/kue.4 +++ b/share/man/man4/kue.4 @@ -53,7 +53,8 @@ Entrega NET-USB-E45, the ATen UC10T, the Netgear EA101, the D-Link DSB-650 and the SMC 2102USB and 2104USB. .Pp The KL5KLUSB101B supports a 128-entry multicast filter, single perfect -filter entry for the station address and promiscuous mode. Packets are +filter entry for the station address and promiscuous mode. +Packets are received and transmitted over separate USB bulk transfer endpoints. .Pp The Kawasaki adapter supports only 10mbps half-duplex mode, hence there diff --git a/share/man/man4/lpt.4 b/share/man/man4/lpt.4 index 31fe401ddd36..8f0bd0ff6878 100644 --- a/share/man/man4/lpt.4 +++ b/share/man/man4/lpt.4 @@ -59,8 +59,11 @@ driver is the port of the original lpt driver to the system. .Pp One purpose of this port was to allow parallel port sharing with other -parallel devices. Secondly, inb()/outb() calls have been replaced by ppbus -function calls. lpt is now arch-independent thanks to the ppbus interface. See +parallel devices. +Secondly, inb()/outb() calls have been replaced by ppbus +function calls. +lpt is now arch-independent thanks to the ppbus interface. +See .Xr ppbus 4 for more info about the ppbus system. .Pp @@ -76,12 +79,14 @@ command. .Pp Depending on your hardware, extended capabilities may be configured with the .Xr lptcontrol 8 -command. With an ECP/ISA port, you can take advantage +command. +With an ECP/ISA port, you can take advantage of FIFO and DMA. .Pp In order to retrieve printer info from /dev/lpt0, just apply the .Nm cat -command to the device. If the printer supports IEEE1284 nibble mode and has +command to the device. +If the printer supports IEEE1284 nibble mode and has data to send to the host, you'll get it. .Sh SEE ALSO .Xr ppbus 4 , diff --git a/share/man/man4/mem.4 b/share/man/man4/mem.4 index 3dba95e51753..b3acf9f69bbf 100644 --- a/share/man/man4/mem.4 +++ b/share/man/man4/mem.4 @@ -134,7 +134,8 @@ int mo_arg[2]; .Pp The .Fa MEMRANGE_GET -ioctl is used to retrieve current memory range attributes. If +ioctl is used to retrieve current memory range attributes. +If .Fa mo_arg[0] is set to 0, it will be updated with the total number of memory range descriptors. If greater than 0, the array at diff --git a/share/man/man4/mouse.4 b/share/man/man4/mouse.4 index c87c342f426c..0edf78386a34 100644 --- a/share/man/man4/mouse.4 +++ b/share/man/man4/mouse.4 @@ -84,7 +84,8 @@ Always zero. .It bit 2 Left button status; cleared if pressed, otherwise set. .It bit 1 -Middle button status; cleared if pressed, otherwise set. Always one, +Middle button status; cleared if pressed, otherwise set. +Always one, if the device does not have the middle button. .It bit 0 Right button status; cleared if pressed, otherwise set. @@ -104,21 +105,26 @@ The second half of the vertical movement count in two's complement; -128 through 127. To obtain the full vertical movement count, add the byte 3 and 5. .It Byte 6 -The bit 7 is always zero. The lower 7 bits encode the first half of +The bit 7 is always zero. +The lower 7 bits encode the first half of Z axis movement count in two's complement; -64 through 63. .It Byte 7 -The bit 7 is always zero. The lower 7 bits encode the second half of +The bit 7 is always zero. +The lower 7 bits encode the second half of the Z axis movement count in two's complement; -64 through 63. To obtain the full Z axis movement count, add the byte 6 and 7. .It Byte 8 -The bit 7 is always zero. The bits 0 through 6 reflect the state +The bit 7 is always zero. +The bits 0 through 6 reflect the state of the buttons 4 through 10. -If a button is pressed, the corresponding bit is cleared. Otherwise +If a button is pressed, the corresponding bit is cleared. +Otherwise the bit is set. .El .Pp The first 5 bytes of this format is compatible with the MouseSystems -format. The additional 3 bytes have their MSBs always set to zero. +format. +The additional 3 bytes have their MSBs always set to zero. Thus, if the user program can interpret the MouseSystems data format and tries to find the first byte of the format by detecting the bit pattern 10000xxxb, @@ -130,8 +136,10 @@ Refer to manual pages of individual drivers for details. .Sh IOCTLS The following .Xr ioctl 2 -commands are defined for the mouse drivers. The degree of support -varies from one driver to another. This section gives general +commands are defined for the mouse drivers. +The degree of support +varies from one driver to another. +This section gives general description of the commands. Refer to manual pages of individual drivers for specific details. .Pp @@ -159,7 +167,8 @@ typedef struct mousehw { .Pp The .Dv buttons -field holds the number of buttons detected by the driver. The driver +field holds the number of buttons detected by the driver. +The driver may put an arbitrary value, such as two, in this field, if it cannot determine the exact number. .Pp @@ -195,7 +204,8 @@ constants. .Pp The .Dv hwid -is the ID value returned by the pointing device. It +is the ID value returned by the pointing device. +It depend on the interface type; refer to the manual page of specific mouse drivers for possible values. .Pp @@ -251,7 +261,8 @@ The array holds a bit mask and pattern to detect the first byte of the data packet. .Dv syncmask[0] -is the bit mask to be ANDed with a byte. If the result is equal to +is the bit mask to be ANDed with a byte. +If the result is equal to .Dv syncmask[1] , the byte is likely to be the first byte of the data packet. Note that this method of detecting the first byte is not 100% reliable, @@ -267,7 +278,8 @@ Only .Dv level and .Dv accelfactor -may be modifiable. Setting values in the other field does not generate +may be modifiable. +Setting values in the other field does not generate error and has no effect. .Pp If you do not want to change the current setting of a field, put -1 @@ -358,7 +370,8 @@ field will also be set. .Pp The other fields hold movement counts since the last .Dv MOUSE_GETSTATUS -call. The internal counters will be reset after every call to this +call. +The internal counters will be reset after every call to this command. .El .Sh FILES diff --git a/share/man/man4/mtio.4 b/share/man/man4/mtio.4 index 524ea6391e16..9b471ae11953 100644 --- a/share/man/man4/mtio.4 +++ b/share/man/man4/mtio.4 @@ -57,7 +57,8 @@ unmounting of a tape. .Pp The rewind devices automatically rewind when the last requested read, write or seek has finished, or the end of the tape -has been reached. The letter +has been reached. +The letter .Ql n is usually prepended to the name of the no-rewind devices. diff --git a/share/man/man4/netintro.4 b/share/man/man4/netintro.4 index 40c641797896..ab92408ec838 100644 --- a/share/man/man4/netintro.4 +++ b/share/man/man4/netintro.4 @@ -124,7 +124,8 @@ information regarding the support for each protocol family. .Sh ADDRESSING Associated with each protocol family is an address format. All network address adhere to a general structure, -called a sockaddr, described below. However, each protocol +called a sockaddr, described below. +However, each protocol imposes finer and more specific structure, generally renaming the variant, which is discussed in the protocol family manual page alluded to above. diff --git a/share/man/man4/null.4 b/share/man/man4/null.4 index 518aab86b7b5..7a1d17f16500 100644 --- a/share/man/man4/null.4 +++ b/share/man/man4/null.4 @@ -43,7 +43,8 @@ The .Nm device accepts and reads data as any ordinary (and willing) file \- -but throws it away. The length of the +but throws it away. +The length of the .Nm null device is always zero. .Sh FILES diff --git a/share/man/man4/ohci.4 b/share/man/man4/ohci.4 index a529e9e7efa4..937ec0d25b96 100644 --- a/share/man/man4/ohci.4 +++ b/share/man/man4/ohci.4 @@ -41,7 +41,8 @@ .Sh DESCRIPTION The .Nm -driver provides support for OHCI-type PCI based USB controllers. This +driver provides support for OHCI-type PCI based USB controllers. +This includes .Bl -tag -width xxxxx .It AcerLabs M5237 (Aladdin-V) diff --git a/share/man/man4/pcm.4 b/share/man/man4/pcm.4 index 4ff67f2dfb3a..241f85be4fc1 100644 --- a/share/man/man4/pcm.4 +++ b/share/man/man4/pcm.4 @@ -40,9 +40,11 @@ For a card without bridge driver support, and a non-PnP card: .Sh DESCRIPTION The .Nm -driver provides support for PCM audio play and capture. This driver +driver provides support for PCM audio play and capture. +This driver also supports various PCI and WSS/MSS compatible ISA sound cards, and -AC97 mixer. True full duplex operation is available on most cards. +AC97 mixer. +True full duplex operation is available on most cards. .Pp If your sound card is supported by a bridge driver, .Nm @@ -55,13 +57,16 @@ cards). Flags are set to 0 for cards not using a secondary DMA channel, or to 0x10 + C to specify channel C. .Pp The driver works best with WSS/MSS cards, which have a very clean -architecture and an orthogonal set of features. They also happen to be +architecture and an orthogonal set of features. +They also happen to be among the cheapest audio cards on the market. .Pp The driver does its best to recognize the installed harware and drive it correctly, so that you don't have to give too many details in the -kernel config files. For PCI and ISA PnP cards this is actually easy -since they identify themselves. For legacy ISA cards, the driver looks +kernel config files. +For PCI and ISA PnP cards this is actually easy +since they identify themselves. +For legacy ISA cards, the driver looks for MSS cards at addresses 0x530 and 0x604 (obviously, unless overridden in the kernel config file by specifying an address). @@ -77,7 +82,8 @@ list of the supported ioctls. .Sh SUPPORTED CARDS .Pp -Below we include a list of supported codecs/cards. If your sound card +Below we include a list of supported codecs/cards. +If your sound card is not listed here, it may be supported by a bridge driver. .Bl -tag -width 2m % begin list @@ -88,13 +94,15 @@ This chipset is used, among others, on the A/Open AW35 and AW32, on some Intel motherboards, and (the CS4231) on some non-PnP cards. .Pp The CS4232 is reported as buggy in the Voxware documentation but -I am not sure if this is true. On one of my Intel motherboards, +I am not sure if this is true. +On one of my Intel motherboards, capture does not work simply because the capture DMA channel is not wired to the ISA DMA controller. .It Yamaha OPL-SAx (ISA) .Pp -Works perfectly in all modes. This chip is used in several PnP cards, +Works perfectly in all modes. +This chip is used in several PnP cards, but also (in non-PnP mode) on motherboards and laptops (e.g. the Toshiba Libretto). diff --git a/share/man/man4/pcvt.4 b/share/man/man4/pcvt.4 index 038a8ee86ebc..89c5fc966f22 100644 --- a/share/man/man4/pcvt.4 +++ b/share/man/man4/pcvt.4 @@ -73,7 +73,8 @@ the probably most important is an emulation of a wide range of DEC VT-220 .if t \(tm .if n (TM) -functionality. See +functionality. +See .Sx Features for a detailed description. .Pp @@ -213,23 +214,28 @@ release, you should define The .Nm pcvt driver has been designed to be highly configurable in order to satisfy -everyone's needs. The preferred way for those configurations is to +everyone's needs. +The preferred way for those configurations is to provide appropriate .Em options lines within the config file, possibly overriding the built-in default -values. Therefore it is possible to compile several distinct kernels +values. +Therefore it is possible to compile several distinct kernels with different driver behaviour on a single machine. The following list gives a short overview of the available configuration -options. Refer to the file +options. +Refer to the file .Pa i386/isa/pcvt/pcvt_hdr.h in the kernel source tree for detailed documentation. Note: the following conventions apply to all the Boolean options. If an option is given with no value, a value of 1 .Pq activated -is substituted. If an option value is given as 0, this options is -deactivated. Any other value is substituted by 1, too. If an option +is substituted. +If an option value is given as 0, this options is +deactivated. Any other value is substituted by 1, too. +If an option is omitted, a built-in default is assumed. .Bl -tag -width indent -compact @@ -241,7 +247,8 @@ Default: 8 .It Em PCVT_VT220KEYB If activated, a keyboard layout resembling a DEC VT200 (TM) is generated. -If deactivated, a mixture between VT220 and HP is used. See the files +If deactivated, a mixture between VT220 and HP is used. +See the files .Pa Keyboard.VT and .Pa Keyboard.HP @@ -257,7 +264,8 @@ Enables the builtin screensaver feature. Default: on .It Em PCVT_PRETTYSCRNS -If enabled, a blinking-star screensaver is used. If disabled, the screen +If enabled, a blinking-star screensaver is used. +If disabled, the screen is simply blanked .Pq which might be useful for energy-saving monitors . .br @@ -293,7 +301,8 @@ utility. Default: off .It Em PCVT_EMU_MOUSE -Emulate a three-button mouse via the keypad. Useful for notebooks when +Emulate a three-button mouse via the keypad. +Useful for notebooks when running XFree86. See .Sx Mouse emulation below. @@ -305,7 +314,8 @@ If enabled, a sequence composed of .Aq Em esc , followed by the normal key code is emitted if a key is pressed with the .Aq Em Alt -key modifier. If disabled, then normal key code with the value +key modifier. +If disabled, then normal key code with the value .Em 0x80 added is sent. .br @@ -314,7 +324,8 @@ Default: off .El Note that there are further options available which are mainly used for -debugging purposes or as a workaround for hardware problems. They are +debugging purposes or as a workaround for hardware problems. +They are found in .Pa i386/isa/pcvt/pcvt_hdr.h along with their documentation. @@ -351,10 +362,12 @@ set current typematic value, similar to above command. Symbolic values are available for the appropriate constants. To specify the initial typematic delay time, they are KBD_TPD250 for 250 ms through -KBD_TPD1000 for 1000 ms, in steps of 250 ms. The typematic repeat +KBD_TPD1000 for 1000 ms, in steps of 250 ms. +The typematic repeat rates are KBD_TPM300, specifying 30.0 characters per second through -KBD_TPM20 for 2.0 characters per second. The intermediate values +KBD_TPM20 for 2.0 characters per second. +The intermediate values are: 30.0, 26.7, 24.0, 21.8, 20.0, 18.5, 17.1, 16.0, 15.0, 13.3, 12.0, 10.9, 10.0, 9.2, 8.6, 8.0, 7.5, 6.7, 6.0, 5.5, 5.0, 4.6, 4.3, 4.0, 3.7, 3.3, 3.0, 2.7, 2.5, 2.3, 2.1, 2.0 characters per second. @@ -367,7 +380,8 @@ get key repetition switch, and set key repetition switch .El -again take a pointer to int as argument. They manipulate the +again take a pointer to int as argument. +They manipulate the drivers internal keyboard repetition flag, possible values are: KBD_REPEATOFF or KBD_REPEATON. @@ -411,9 +425,11 @@ set new key assignment values, and get original key assignment values .El -arrange those functions. The take a pointer to a +arrange those functions. +The take a pointer to a .Em struct kbd_ovlkey -as argument as described below. In addition, +as argument as described below. +In addition, .Bl -tag -width 20n -offset indent -compact .It KBDRMKEY @@ -493,23 +509,28 @@ key is bound to a function. The mouse emulator .Pq if configured in -fakes a three-button mouse using the Mouse Systems protocol. The first +fakes a three-button mouse using the Mouse Systems protocol. +The first .Nm pcvt -device node not used by a virtual screen is the mouse device. I.\& e., +device node not used by a virtual screen is the mouse device. +I.\& e., for the default value of 8 virtual screens, .Pa /dev/ttyv0 through .Pa /dev/ttyv7 would refer to the virtual screens, and .Pa /dev/ttyv8 -were the mouse emulator device. The mouse emulation is turned on by +were the mouse emulator device. +The mouse emulation is turned on by pressing the .Aq Em NumLock key. The pointer is moved by the numerical keypad keys, into the -obvious directions. The pointer is initially moved in single steps, +obvious directions. +The pointer is initially moved in single steps, and is accelerated after an adjustable time .Pq default: 500 ms -by about 6 times. The mouse buttons are emulated by three normal +by about 6 times. +The mouse buttons are emulated by three normal keys, by default the function keys .Aq Em \&F1 , .Aq Em \&F2 , @@ -517,9 +538,11 @@ and .Aq Em \&F3 . There are two selectable flavors available: normal and .Dq sticky -buttons. Normal buttons behave as expected. +buttons. +Normal buttons behave as expected. .Dq Sticky -buttons are notified as button-press on the first keypress. They +buttons are notified as button-press on the first keypress. +They .Dq stick until the key is pressed again .Pq or another button-emulating key instead . @@ -557,7 +580,8 @@ struct mousedefs { .Em Downloadable character set interface EGA and VGA video adaptors provide the capability of downloadable -software fonts. Since the +software fonts. +Since the .Sq native character set of any IBM-compatible PC video board does not allow the full interpretation of DEC multinational character set or ISO Latin-1 @@ -572,7 +596,8 @@ get font attr .El are used to manipulate the drivers information about a downloaded -font. The take a pointer to a +font. +The take a pointer to a .Em struct vgafontattr as argument: .Bd -literal @@ -654,7 +679,8 @@ get screen info, provide an interface to some general driver internal variables which might modify the behaviour of the screens, or which might simply be used to force the driver to switch -to one certain screen. Their argument is a pointer to the structure: +to one certain screen. +Their argument is a pointer to the structure: .Bd -literal struct screeninfo { int adaptor_type; /* type of video adaptor installed */ @@ -704,7 +730,8 @@ sets the number of columns for the current screen, its parameter is a pointer to an integer containing either a value of 80, or a value of 132. Note that setting the number of columns to 132 is -only supported on VGA adaptors. Any unsupported numbers cause the ioctl +only supported on VGA adaptors. +Any unsupported numbers cause the ioctl to fail with .Em errno .Pq see Xr intro 2 @@ -719,7 +746,8 @@ for each of the 256 internal color codes, each lying in the range of 0 through 63 (with 63 representing the brightest value for a base color). Thus, these adaptors map each color code to a color of a .Dq palette -out of 262144 colors. The commands +out of 262144 colors. +The commands .Bl -tag -width 20n -offset indent -compact .It VGAREADPEL @@ -728,7 +756,8 @@ read VGA palette entry, and write VGA palette entry .El -establish an interface to these palette registers. Their argument is +establish an interface to these palette registers. +Their argument is a pointer to: .Bd -literal struct vgapel { @@ -794,7 +823,8 @@ struct pcvtinfo { Depending on the configuration of a .Nm pcvt -driver, their might be a simple screen saver available. It is controlled +driver, their might be a simple screen saver available. +It is controlled by the command .Bl -tag -width 20n -offset indent -compact @@ -802,7 +832,8 @@ by the command set timeout for screen saver in seconds; 0 turns it off, .El -taking a pointer to an integer as argument. Despite of its command name, +taking a pointer to an integer as argument. +Despite of its command name, this is available on .Em any kind of adaptor if configured in by the @@ -815,13 +846,16 @@ option Release 3.00 of this .Nm pcvt driver supports a subset of the USL-style commands used to control -the virtual terminal interface. This feature is mainly intended to +the virtual terminal interface. +This feature is mainly intended to allow .Em XFree86 , release 2.0 or higher, to switch between virtual screens even when -running an X server. They are ugly with respect to the implied semantics +running an X server. +They are ugly with respect to the implied semantics .Pq i.\& e., they break Berkeley semantics -and are therefore not recommended for common use. See the file +and are therefore not recommended for common use. +See the file .Pa i386/include/pcvt_ioctl.h for their documentation. @@ -881,7 +915,8 @@ implementation .Xr config 8 , .Xr ispcvt 8 .Sh BUGS -Certainly existent. See the file +Certainly existent. +See the file .Pa BugList in the Documentation directory for an up-to-date list. diff --git a/share/man/man4/ppbus.4 b/share/man/man4/ppbus.4 index bf3458f974b4..3ca7453c06d9 100644 --- a/share/man/man4/ppbus.4 +++ b/share/man/man4/ppbus.4 @@ -98,9 +98,11 @@ ppc makes chipset detection and initialization 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, +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 +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: @@ -125,21 +127,26 @@ checked for no errors and that it is not busy, and then a data Strobe is generated by the software 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 +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 +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 +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, +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 +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 @@ -157,20 +164,25 @@ 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. .Pp -The EPP mode has two types of cycle: address and data. What makes the +The EPP mode has two types of cycle: address and data. +What makes the difference at hardware level is the strobe of the byte placed on the data -lines. Data are strobed with nAutofeed, addresses are strobed with +lines. +Data are strobed with nAutofeed, addresses are strobed with nSelectin signals. .Pp A particularity of the ISA implementation of the EPP protocol is that an -EPP cycle fits in an ISA cycle. In this fashion, parallel port peripherals can +EPP cycle fits in an ISA cycle. +In this fashion, parallel port peripherals can operate at close to the same performance levels as an equivalent ISA plug-in card. .Pp At software level, you may implement the protocol you wish, using data and -address cycles as you want. This is for the IEEE1284 compatible part. Then, +address cycles as you want. This is for the IEEE1284 compatible part. +Then, peripheral vendors may implement protocol handshake with the following -status lines: PError, nFault and Select. Try to know how these lines toggle +status lines: PError, nFault and Select. +Try to know how these lines toggle with your peripheral, allowing the peripheral to request more data, stop the transfer and so on. .Pp @@ -178,41 +190,51 @@ At any time, the peripheral may interrupt the host with the nAck signal without disturbing the current transfer. .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 +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 asynchronous, fully interlocked, bidirectional -parallel communications between hosts and printers or other peripherals. It +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 specifies dialog handshake -at signal level. One should refer to architecture specific documentation in +at signal level. +One should refer to architecture specific documentation in order to manipulate machine dependent registers, mapped memory or other methods 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. +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 +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 negotiation because it -is compatible. Any other mode must be firstly negotiated by the host to check +is compatible. +Any other mode must be firstly negotiated 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 +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 negotiated to permit the peripheral to -request transfer. Interrupt lines may be dedicated to the requesting signals +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 +But peripheral requests are only a hint to the master host. +If the host accepts the transfer, it must firstly negotiate the reverse mode and then -starts the transfer. At any time during reverse transfer, the host may +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 @@ -221,14 +243,17 @@ as a set of procedures that perform high level functions like negotiation, termination, transfer in any mode without bothering you with low level characteristics of the standard. .Pp -IEEE1284 interacts with the ppbus system as least as possible. That means +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 negotiate -function doesn't do it for you. And of course, release it later. +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 +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 @@ -255,7 +280,8 @@ one, current and available modes are separated. .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 +disturbing upper layers. +For example, most chipsets support NIBBLE mode as native and emulated with ECP and/or EPP. .Pp This architecture should support IEEE1284-1994 modes. @@ -263,7 +289,8 @@ This architecture should support IEEE1284-1994 modes. .Ss The boot process The boot process starts with the probe phasis of the .Xr ppc 4 -driver during ISA bus (PC architecture) initialization. During attachment of +driver during ISA bus (PC architecture) initialization. +During attachment of the ppc driver, a new ppbus structure is allocated, then probe and attachment for this new bus node are called. .Pp @@ -273,10 +300,12 @@ 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 +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 +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 @@ -285,19 +314,24 @@ newbus .Fn BUS_SETUP_INTR and .Fn BUS_TEARDOWN_INTR -functions. But, in order to attach a handler, drivers must -own the bus. Consequently, a ppbus request is mandatory in order to call the above +functions. +But, in order to attach a handler, drivers must +own the bus. +Consequently, a ppbus request is mandatory in order to call the above functions (see existing drivers for more info). Note that the interrupt handler is automatically released when the ppbus is released. .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 +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 +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 diff --git a/share/man/man4/psm.4 b/share/man/man4/psm.4 index 609705ccf054..f0785eed0b0c 100644 --- a/share/man/man4/psm.4 +++ b/share/man/man4/psm.4 @@ -61,9 +61,12 @@ Basic PS/2 style pointing device has two or three buttons. Some devices may have a roller or a wheel and/or additional buttons. .Ss Device Resolution The PS/2 style pointing device usually has several grades of resolution, -that is, sensitivity of movement. They are typically 25, 50, 100 and 200 -pulse per inch. Some devices may have finer resolution. -The current resolution can be changed at runtime. The +that is, sensitivity of movement. +They are typically 25, 50, 100 and 200 +pulse per inch. +Some devices may have finer resolution. +The current resolution can be changed at runtime. +The .Nm driver allows the user to initially set the resolution via the driver flag @@ -133,7 +136,8 @@ Always one. .\" the pad, otherwise the bit is set. .\" Most, if not all, other devices always set this bit. .It bit 2 -Middle button status; set if pressed. For devices without the middle +Middle button status; set if pressed. +For devices without the middle button, this bit is always zero. .It bit 1 Right button status; set if pressed. @@ -165,7 +169,8 @@ driver can somewhat `accelerate' the movement of the pointing device. The faster you move the device, the further the pointer travels on the screen. The driver has an internal variable which governs the effect of -the acceleration. Its value can be modified via the driver flag +the acceleration. +Its value can be modified via the driver flag or via an ioctl call. .Ss Device Number The minor device number of the @@ -198,7 +203,8 @@ the power saving mode, though it will eventually become available. There are reports that stimulating the device by performing I/O will help -waking up the device quickly. This option will add a piece of code +waking up the device quickly. +This option will add a piece of code to the .Nm driver to hook @@ -217,13 +223,17 @@ The .Nm driver will attempt to reset the pointing device during the boot process. It sometimes takes a long while before the device will respond after -reset. These options control how long the driver should wait before -it eventually gives up waiting. The driver will wait +reset. +These options control how long the driver should wait before +it eventually gives up waiting. +The driver will wait .Fa X * .Fa Y -msecs at most. If the driver seems unable to detect your pointing -device, you may want to increase these values. The default values are +msecs at most. +If the driver seems unable to detect your pointing +device, you may want to increase these values. +The default values are 200 msec for .Fa X and 5 @@ -232,14 +242,16 @@ for .It Em PSM_DEBUG=N, KBDIO_DEBUG=N Sets the debug level to .Fa N . -The default debug level is zero. See +The default debug level is zero. +See .Sx DIAGNOSTICS for debug logging. .El .Ss Driver Flags The .Nm -driver accepts the following driver flags. Set them in the +driver accepts the following driver flags. +Set them in the kernel configuration file or in the User Configuration Menu at the boot time .Pq see Xr boot 8 . @@ -247,10 +259,12 @@ the boot time .Bl -tag -width MOUSE .It bit 0..3 RESOLUTION This flag specifies the resolution of the pointing device. -It must be zero through four. The greater the value +It must be zero through four. +The greater the value is, the finer resolution the device will select. Actual resolution selected by this field varies according to the model -of the device. Typical resolutions are: +of the device. +Typical resolutions are: .Pp .Bl -tag -width 0_(medium_high)__ -compact .It Em 1 (low) @@ -269,13 +283,15 @@ device (whatever it is). This flag controls the amount of acceleration effect. The smaller the value of this flag is, more sensitive the movement becomes. The minimum value allowed, thus the value for the most sensitive setting, -is one. Setting this flag to zero will completely disables the +is one. +Setting this flag to zero will completely disables the acceleration effect. .It bit 8 NOCHECKSYNC The .Nm driver tries to detect the first byte of the data packet by checking -the bit pattern of that byte. Although this method should work with most +the bit pattern of that byte. +Although this method should work with most PS/2 pointing devices, it may interfere with some devices which are not so compatible with known devices. If you think your pointing device is not functioning as expected, @@ -363,7 +379,8 @@ The driver currently can detect the 3 button mouse from Logitech and report accordingly. The 3 button mouse from the other manufacturer may or may not be -reported correctly. However, it will not affect the operation of +reported correctly. +However, it will not affect the operation of the driver. .Pp The @@ -446,11 +463,13 @@ The .Dv resolution of the pointing device must be one of .Dv MOUSE_RES_XXX -constants or a positive value. The greater the value +constants or a positive value. +The greater the value is, the finer resolution the mouse will select. Actual resolution selected by the .Dv MOUSE_RES_XXX -constant varies according to the model of mouse. Typical resolutions are: +constant varies according to the model of mouse. +Typical resolutions are: .Pp .Bl -tag -width MOUSE_RES_MEDIUMHIGH__ -compact .It Dv MOUSE_RES_LOW @@ -471,7 +490,8 @@ It must be zero or greater. If it is zero, acceleration is disabled. .Pp The .Dv packetsize -field specifies the length of the data packet. It depends on the +field specifies the length of the data packet. +It depends on the operation level and the model of the pointing device. .Pp .Bl -tag -width level_0__ -compact @@ -488,7 +508,8 @@ The array holds a bit mask and pattern to detect the first byte of the data packet. .Dv syncmask[0] -is the bit mask to be ANDed with a byte. If the result is equal to +is the bit mask to be ANDed with a byte. +If the result is equal to .Dv syncmask[1] , the byte is likely to be the first byte of the data packet. Note that this detection method is not 100% reliable, @@ -504,7 +525,8 @@ Only .Dv level and .Dv accelfactor -may be modifiable. Setting values in the other field does not generate +may be modifiable. +Setting values in the other field does not generate error and has no effect. .Pp If you do not want to change the current setting of a field, put -1 @@ -672,13 +694,15 @@ Reserved. .It bit 6 0 - stream mode, 1 - remote mode. In the stream mode, the pointing device sends the device status -whenever its state changes. In the remote mode, the host computer +whenever its state changes. +In the remote mode, the host computer must request the status to be sent. The .Nm driver puts the device in the stream mode. .It bit 5 -Set if the pointing device is currently enabled. Otherwise zero. +Set if the pointing device is currently enabled. +Otherwise zero. .It bit 4 0 - 1:1 scaling, 1 - 2:1 scaling. 1:1 scaling is the default. @@ -696,7 +720,8 @@ Right button status; set if pressed. .It bit 7 Reserved. .It bit 6..0 -Resolution code: zero through three. Actual resolution for +Resolution code: zero through three. +Actual resolution for the resolution code varies from one device to another. .El .It Byte 3 @@ -728,12 +753,14 @@ Add these options to your kernel configuration file if the device does not seem to work properly after the system is resumed. .Pp Some PS/2 mouse models from MouseSystems require to be put in the -high resolution mode to work properly. Use the driver flag to +high resolution mode to work properly. +Use the driver flag to set resolution. .Pp There is not a guaranteed way to re-synchronize with the first byte of the packet once we are out of synchronization with the data -stream. However, if you are using the \fIXFree86\fP server and experiencing +stream. +However, if you are using the \fIXFree86\fP server and experiencing the problem, you may be able to make the X server synchronize with the mouse by switching away to a virtual terminal and getting back to the X server, unless the X server is accessing the mouse via @@ -742,7 +769,8 @@ Clicking any button without moving the mouse may also work. .Sh BUGS The ioctl command .Dv MOUSEIOCREAD -has been removed. It was never functional anyway. +has been removed. +It was never functional anyway. .Sh SEE ALSO .Xr ioctl 2 , .Xr syslog 3 , diff --git a/share/man/man4/rl.4 b/share/man/man4/rl.4 index e7d3719dd8e1..40fa7e19d88b 100644 --- a/share/man/man4/rl.4 +++ b/share/man/man4/rl.4 @@ -44,7 +44,8 @@ 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, +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 @@ -53,16 +54,20 @@ 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 +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 +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 +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 +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. @@ -73,21 +78,25 @@ driver supports the following media types: .Pp .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It autoselect -Enable autoselection of the media type and options. This is only +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 +supports NWAY autonegotiation. +The user can manually override the autoselected mode by adding media options to the .Pa /etc/rc.conf file. .It 10baseT/UTP -Set 10Mbps operation. The +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 +Set 100Mbps (fast ethernet) operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -127,20 +136,25 @@ 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 +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 +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 +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 +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 +operating system. +If you power down your system prior to booting .Fx , the card should be configured correctly. .El @@ -166,20 +180,26 @@ driver was written by .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 +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 +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 +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 +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 +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 @@ -189,5 +209,6 @@ 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 +available packets. +Neither this magic value nor its significance are documented anywhere in the RealTek data sheets. diff --git a/share/man/man4/sa.4 b/share/man/man4/sa.4 index 1d0a0130b5b9..46b987e0acfb 100644 --- a/share/man/man4/sa.4 +++ b/share/man/man4/sa.4 @@ -60,12 +60,14 @@ driver is based around the concept of a which is defined as the period between the time that a tape is mounted, and the time when it is unmounted. Any parameters set during a mount session remain in effect for the remainder of the session or -until replaced. The tape can be unmounted, bringing the session to a +until replaced. +The tape can be unmounted, bringing the session to a close in several ways. These include: .Bl -enum .It Closing a `rewind device', -referred to as sub-mode 00 below. An example is +referred to as sub-mode 00 below. +An example is .Pa /dev/rsa0 . .It Using the MTOFFL @@ -77,7 +79,8 @@ command of .El .Pp It should be noted that tape devices are exclusive open devices, except in -the case where a control mode device is opened. In the latter case, exclusive +the case where a control mode device is opened. +In the latter case, exclusive access is only sought when needed (e.g., to set parameters). .Sh SUB-MODES Bits 0 and 1 of the minor number are interpreted as @@ -95,7 +98,8 @@ No other head positioning takes place. Any further reads or writes will occur directly after the last read, or the written file mark. .It 10 -A close will rewind the device. If the tape has been +A close will rewind the device. +If the tape has been written, then a file mark will be written before the rewind is requested. On completion of the rewind an unload command will be issued. The device is unmounted. @@ -117,7 +121,8 @@ written to the tape. One can never read or write .Em part of a record from tape (though you may request a larger block and read a smaller record); nor can one read multiple blocks. Data from a -single write is therefore read by a single read. The block size used +single write is therefore read by a single read. +The block size used may be any value supported by the device, the .Tn SCSI adapter and the system (usually between 1 byte and 64 Kbytes, @@ -125,13 +130,15 @@ sometimes more). .Pp When reading a variable record/block from the tape, the head is logically considered to be immediately after the last item read, -and before the next item after that. If the next item is a file mark, +and before the next item after that. +If the next item is a file mark, but it was never read, then the next process to read will immediately hit the file mark and receive an end-of-file notification. .It Fixed block-size: Data written by the user is passed to the tape as a succession of fixed size blocks. It may be contiguous in memory, but it is -considered to be a series of independent blocks. One may never write +considered to be a series of independent blocks. +One may never write an amount of data that is not an exact multiple of the blocksize. One may read and write the same data as a different set of records, In other words, blocks that were written together may be read separately, @@ -145,7 +152,8 @@ of 0. (As above, if the file mark is never read, it remains for the next process to read if in no-rewind mode.) .El .Sh FILE MARK HANDLING -The handling of file marks on write is automatic. If the user has +The handling of file marks on write is automatic. +If the user has written to the tape, and has not done a read since the last write, then a file mark will be written to the tape when the device is closed. If a rewind is requested after a write, then the driver diff --git a/share/man/man4/sbc.4 b/share/man/man4/sbc.4 index 0d8c8e377622..1e3f2159f95e 100644 --- a/share/man/man4/sbc.4 +++ b/share/man/man4/sbc.4 @@ -52,14 +52,16 @@ Advance Asound 100, 110 and Logic ALS120 ESS ES1868, ES1869, ES1879 and ES1888 .El .Pp -The value of flags specifies the secondary DMA channel. If the secondary +The value of flags specifies the secondary DMA channel. +If the secondary DMA channel is C, set the flags to (C | 0x10). For a sound card without the secondary DMA channel, the flags should be set to zero. .Sh DIAGNOSTICS .Bl -tag -width 2m % begin list .It sb_dspwr(XX) timed out. .Pp -A command to the DSP has timed out. Check the I/O port configuration. +A command to the DSP has timed out. +Check the I/O port configuration. .It bad irq XX (5/7/9/10 valid) .Pp The IRQ given to the driver is not valid. diff --git a/share/man/man4/screen.4 b/share/man/man4/screen.4 index fe06591c4a05..19744af7b079 100644 --- a/share/man/man4/screen.4 +++ b/share/man/man4/screen.4 @@ -17,7 +17,8 @@ ttyv0 - ttyvb in Each of these files correspond to a separate virtual console. All virtual console devices can be open at once, but only one is -active at a time. The active virtual console "owns" the keyboard and +active at a time. +The active virtual console "owns" the keyboard and display screen. .Pp Output to a virtual console that not currently is on the display is @@ -29,10 +30,12 @@ Any output written to .Pp To switch between the virtual consoles one uses the sequence .Ar ALT+Fn -, which means hold down ALT and press one of the function keys. The +, which means hold down ALT and press one of the function keys. +The virtual console with the same number as the function key is then selected as the current virtual console, and given exclusive use of -the keyboard and display. This switch sequence can be changed via +the keyboard and display. +This switch sequence can be changed via the keyboard mapping ioctl call (see keyboard.4) .Pp @@ -40,14 +43,19 @@ The console allows entering values that are not physically present on the keyboard via a special keysequence. To use this facility press and hold down ALT, then enter a decimal number from 0-255 via the numerical keypad, then -release ALT. The entered value is then used as the ASCII value for one -character. This way it is possible to enter any ASCII value. -The console driver also includes a history function. It is activated by -pressing the scroll-lock key. This holds the display, and enables the cursor +release ALT. +The entered value is then used as the ASCII value for one +character. +This way it is possible to enter any ASCII value. +The console driver also includes a history function. +It is activated by +pressing the scroll-lock key. +This holds the display, and enables the cursor arrows for scrolling up and down through the last scrolled out lines. The console understands a subset of the ANSI x3.64 character -sequences. For compatibility with the old pccons, the PC3 character +sequences. +For compatibility with the old pccons, the PC3 character sequences is also supported. .Pp .Bd -literal diff --git a/share/man/man4/scsi.4 b/share/man/man4/scsi.4 index 401da7200c9e..2c77ba7dafa3 100644 --- a/share/man/man4/scsi.4 +++ b/share/man/man4/scsi.4 @@ -60,7 +60,8 @@ of drivers to control various .Tn SCSI devices, and to utilize different .Tn SCSI -host adapters through host adapter drivers. When the system probes the +host adapters through host adapter drivers. +When the system probes the .Tn SCSI busses, it attaches any devices it finds to the appropriate drivers. The @@ -172,17 +173,21 @@ then the first non-wired disk shall come on line as .Em da2 . .Sh ADAPTERS The system allows common device drivers to work through many different -types of adapters. The adapters take requests from the upper layers and do +types of adapters. +The adapters take requests from the upper layers and do all IO between the .Em SCSI -bus and the system. The maximum size of a transfer is governed by the -adapter. Most adapters can transfer 64KB in a single operation, however +bus and the system. +The maximum size of a transfer is governed by the +adapter. +Most adapters can transfer 64KB in a single operation, however many can transfer larger amounts. .Sh TARGET MODE Some adapters support .Em target mode in which the system is capable of operating as a device, responding to -operations initiated by another system. Target mode is supported for +operations initiated by another system. +Target mode is supported for some adapters, but is not yet complete for this version of the CAM .Tn SCSI subsystem. @@ -191,7 +196,8 @@ see other scsi device entries. .Sh DIAGNOSTICS When the kernel is compiled with options CAMDEBUG, an XPT_DEBUG CCB can be used to enable various amounts of tracing information on any -specific device. Devices not being traced will not produce trace information. +specific device. +Devices not being traced will not produce trace information. There are currently four debugging flags that may be turned on: .Bl -tag -width CAM_DEBUG_SUBTRACE .It Dv CAM_DEBUG_INFO diff --git a/share/man/man4/ses.4 b/share/man/man4/ses.4 index 617d23770c54..535442f540e3 100644 --- a/share/man/man4/ses.4 +++ b/share/man/man4/ses.4 @@ -125,5 +125,6 @@ The driver was written for the .Tn CAM .Tn SCSI -subsystem by Matthew Jacob. This is a functional equivalent of a similar +subsystem by Matthew Jacob. +This is a functional equivalent of a similar driver available in Solaris, Relase 7. diff --git a/share/man/man4/sf.4 b/share/man/man4/sf.4 index 8adeacf7998a..efbad00cac12 100644 --- a/share/man/man4/sf.4 +++ b/share/man/man4/sf.4 @@ -44,7 +44,8 @@ Adaptec AIC-6915 "Starfire" PCI fast ethernet adapter driver The .Nm driver provides support for Adaptec Duralink fast ethernet adapters -based on the Adaptec AIC-6915 "Starfire" chipset. This includes the +based on the Adaptec AIC-6915 "Starfire" chipset. +This includes the following: .Bl -bullet -offset indent .It @@ -59,17 +60,21 @@ ANA-69011 32-bit single port 10/100baseTX adapter ANA-62020 64-bit single port 100baseFX adapter .El .Pp -The AIC-6915 is a bus master controller with an MII interface. It +The AIC-6915 is a bus master controller with an MII interface. +It supports high and low priority transmit and receive queues, TCP/IP checksum offload, multiple DMA descriptor formats and both polling -and producer/consumer DMA models. The AIC-6915 receive filtering +and producer/consumer DMA models. +The AIC-6915 receive filtering options include a 16 entry perfect filter, a 512-bit hash table for multicast addresses, a 512-bit hash table for priority address -matching and VLAN filtering. An external MII-compliant transceiver +matching and VLAN filtering. +An external MII-compliant transceiver is required for media interfacing. .Pp Multiport adapters consist of several AIC-6915 controllers connected -via a PCI to PCI bridge. Each controller is treated as a separate +via a PCI to PCI bridge. +Each controller is treated as a separate interface by the .Nm driver. @@ -86,7 +91,8 @@ the autoselected mode by adding media options to the .Pa /etc/rc.conf file. .It 10baseT/UTP -Set 10Mbps operation. The +Set 10Mbps operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -94,7 +100,8 @@ or .Ar half-duplex modes. .It 100baseTX -Set 100Mbps (fast ethernet) operation. The +Set 100Mbps (fast ethernet) operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -119,7 +126,8 @@ For more information on configuring this device, see .Sh DIAGNOSTICS .Bl -diag .It "sf%d: couldn't map memory" -A fatal initialization error has occurred. This may +A fatal initialization error has occurred. +This may happen if the PCI BIOS not configured the device, which may be because the BIOS has been configured for a "Plug and Play" operating system. The "Plug and Play OS" setting int he BIOS should be set to "no" or diff --git a/share/man/man4/si.4 b/share/man/man4/si.4 index 74cd088e6ab7..428f5e1353ee 100644 --- a/share/man/man4/si.4 +++ b/share/man/man4/si.4 @@ -24,14 +24,17 @@ port version. The "XIO" and "SX" modules come only in 8 port versions. .Pp The host adapter polls and transfers data between the modules and the rest -of the machine. The Host adapter provides a 256 byte transmit and 256 byte +of the machine. +The Host adapter provides a 256 byte transmit and 256 byte receive FIFO for each of the 32 ports that it can maintain. .Pp The XIO modules can operate each of their 8 ports at 115,200 baud. -The SI version can run at 57,600 baud. The SX modules can operate each of their +The SI version can run at 57,600 baud. +The SX modules can operate each of their 8 ports at up to 921,600 baud. .Pp -SX modules are only supported when connected to an SX host card. SI or +SX modules are only supported when connected to an SX host card. +SI or XIO modules are supported on any host card. .Pp The host adapter uses a shared memory block in the traditional ISA bus @@ -39,7 +42,8 @@ The host adapter uses a shared memory block in the traditional ISA bus range, but requires the memory range to be explicitly non-cached. The driver does not yet support this mode of operation. .Pp -SX ISA Host cards have an 8/16 bit mode switch or jumper on them. This switch +SX ISA Host cards have an 8/16 bit mode switch or jumper on them. +This switch or jumper MUST be set for 8 bit mode. .Pp The ISA adapters can use Irq's 11, 12 or 15 (and 9 and 10 in the case of @@ -55,7 +59,8 @@ The si device driver also responds to the utility for configuring drain-on-close timeouts. .Pp The driver also defines 3 sysctl variables that can be manipulated: -machdep.si_debug sets the debug level for the whole driver. It depends +machdep.si_debug sets the debug level for the whole driver. +It depends on the driver being compiled with SI_DEBUG. machdep.si_pollrate sets how often per second the driver polls for lost interrupts. machdep.si_realpoll sets whether or not the card will treat the @@ -75,7 +80,8 @@ Due to the lack of available interrupts, only 3 ISA SI/XIO host cards can be used at once. .Pp The lowest 5 bits of the minor device number are used to select the port -number on the module cluster. The next 2 bits select which of 4 host adapter +number on the module cluster. +The next 2 bits select which of 4 host adapter cards. This allows a maximum of 128 ports on this driver. .Pp Bit 7 is used to differentiate a tty/dialin port (bit 7=0) and a diff --git a/share/man/man4/sio.4 b/share/man/man4/sio.4 index 214475d0b280..a9691d97903a 100644 --- a/share/man/man4/sio.4 +++ b/share/man/man4/sio.4 @@ -316,7 +316,8 @@ As shown, hex addresses can be and for clarity probably should be used instead. .Pp Note that on the AST/4 the card's dipswitches should .Em not -be set to use interrupt sharing. AST/4-like interrupt sharing is only used when +be set to use interrupt sharing. +AST/4-like interrupt sharing is only used when .Em multiple AST/4 cards are installed in the same system. The sio driver does not support more than 1 AST/4 on one IRQ. diff --git a/share/man/man4/sis.4 b/share/man/man4/sis.4 index 822c596f6b83..572f3c0a32ad 100644 --- a/share/man/man4/sis.4 +++ b/share/man/man4/sis.4 @@ -48,8 +48,10 @@ controllers based on the Silicon Integrated Systems SiS 900 and SiS 7016 fast ethernet controller chips. .Pp The SiS 900 is a 100Mbps ethernet MAC and MII-compliant transceiver -in a single package. It uses a bus master DMA and a scatter/gather -descriptor scheme. The SiS 7016 is similar to the SiS 900 except +in a single package. +It uses a bus master DMA and a scatter/gather +descriptor scheme. +The SiS 7016 is similar to the SiS 900 except that it has no internal PHY, requiring instead an external transceiver to be attached to its MII interface. The SiS 900 and SiS 7016 both have a 128-bit multicast hash filter @@ -67,14 +69,16 @@ the autoselected mode by adding media options to the .Pa /etc/rc.conf fine. .It 10baseT/UTP -Set 10Mbps operation. The +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 +Set 100Mbps (fast ethernet) operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -112,20 +116,25 @@ The driver failed to allocate an mbuf for the transmitter ring when allocating a pad buffer or collapsing an mbuf chain into a clusisr. .It "sis%d: chip is in D3 power state -- setting to D0" This message applies only to adapters which support power -management. Some operating sysisms place the controller in low power +management. +Some operating sysisms 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 +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 +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 +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 sysism. If you power down your sysism prior to booting +operating sysism. +If you power down your sysism prior to booting .Fx , the card should be configured correctly. .El diff --git a/share/man/man4/sk.4 b/share/man/man4/sk.4 index 731d78369c5f..5b0cfcd67e79 100644 --- a/share/man/man4/sk.4 +++ b/share/man/man4/sk.4 @@ -56,24 +56,29 @@ SK-9844 SK-NET GE-SX dual port, multimode fiber adapter .El .Pp The SysKonnect adapters consist of two main components: the XaQti Corp. -XMAC II gigabit MAC and the SysKonnect GEnesis controller ASIC. The +XMAC II gigabit MAC and the SysKonnect GEnesis controller ASIC. +The XMAC provides the gigabit MAC and PHY suspport while the GEnesis provides an interface to the PCI bus, DMA support, packet buffering -and arbitration. The GEnesis can control up to two XMACs simultaneously, +and arbitration. +The GEnesis can control up to two XMACs simultaneously, allowing dual-port NIC configurations. .Pp The .Nm driver configures dual port SysKonnect adapters such that each XMAC -is treated as a separate logical network interface. Both ports can +is treated as a separate logical network interface. +Both ports can operate indepenently of each other and can be connected to separate -networks. The SysKonnect driver software currently only uses the +networks. +The SysKonnect driver software currently only uses the second port on dual port adapters for failover purposes: if the link on the primary port fails, the SysKonnect driver will automatically switch traffic onto the second port. .Pp The XaQti XMAC II supports full and half duplex operation with -autonegotiation. The XMAC also supports unlimited frame sizes. +autonegotiation. +The XMAC also supports unlimited frame sizes. Support for jumbo frames is provided via the interface MTU setting. Selecting an MTU larger than 1500 bytes with the .Xr ifconfig 8 @@ -93,7 +98,8 @@ the autoselected mode by adding media options to the .Pa /etc/rc.conf file. .It 1000baseSX -Set 1000Mbps (gigabit ethernet) operation. Both +Set 1000Mbps (gigabit ethernet) operation. +Both .Ar full-duplex and .Ar half-duplex @@ -125,7 +131,8 @@ A fatal initialization error has occurred. The driver failed to allocate memory for per-device instance information during initialization. .It "sk%d: failed to enable memory mapping!" -The driver failed to initialize PCI shared memory mapping. This might +The driver failed to initialize PCI shared memory mapping. +This might happen if the card is not in a bus-master slot. .It "sk%d: no memory for jumbo buffers!" The driver failed to allocate memory for jumbo frames during diff --git a/share/man/man4/smb.4 b/share/man/man4/smb.4 index 95ec1fd0588c..b8e781819a02 100644 --- a/share/man/man4/smb.4 +++ b/share/man/man4/smb.4 @@ -38,7 +38,8 @@ 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 +instance. +In order to control SMB devices, use /dev/smb? with the following ioctls: .Pp .Bl -column "System Management Bus ioctls" -compact diff --git a/share/man/man4/smbus.4 b/share/man/man4/smbus.4 index a572591c7642..4899bdd02684 100644 --- a/share/man/man4/smbus.4 +++ b/share/man/man4/smbus.4 @@ -46,7 +46,8 @@ and to utilize different SMB controllers (I2C, PIIX4, Brooktree848, vm86...). 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 +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 diff --git a/share/man/man4/snd_csa.4 b/share/man/man4/snd_csa.4 index bfb887b3a5f8..dfb60f57a387 100644 --- a/share/man/man4/snd_csa.4 +++ b/share/man/man4/snd_csa.4 @@ -47,7 +47,8 @@ Crystal Semiconductor CS428x Audio Controller .El .Pp Some onboard CS4610 chips accompany with not CS4297 AC97 -codec but CS423x ISA codec. Such the configuration is not +codec but CS423x ISA codec. +Such the configuration is not sypported by .Nm yet. diff --git a/share/man/man4/snd_gusc.4 b/share/man/man4/snd_gusc.4 index aa9a6bb185cf..f8504e693a21 100644 --- a/share/man/man4/snd_gusc.4 +++ b/share/man/man4/snd_gusc.4 @@ -50,7 +50,8 @@ Gravis UltraSound PnP Gravis UltraSound MAX .El .Pp -The value of flags specifies the secondary DMA channel. If the secondary +The value of flags specifies the secondary DMA channel. +If the secondary DMA channel is C, set the flags to (C | 0x10). For a sound card without the secondary DMA channel, the flags should be set to zero. .Sh DIAGNOSTICS diff --git a/share/man/man4/snd_sbc.4 b/share/man/man4/snd_sbc.4 index 0d8c8e377622..1e3f2159f95e 100644 --- a/share/man/man4/snd_sbc.4 +++ b/share/man/man4/snd_sbc.4 @@ -52,14 +52,16 @@ Advance Asound 100, 110 and Logic ALS120 ESS ES1868, ES1869, ES1879 and ES1888 .El .Pp -The value of flags specifies the secondary DMA channel. If the secondary +The value of flags specifies the secondary DMA channel. +If the secondary DMA channel is C, set the flags to (C | 0x10). For a sound card without the secondary DMA channel, the flags should be set to zero. .Sh DIAGNOSTICS .Bl -tag -width 2m % begin list .It sb_dspwr(XX) timed out. .Pp -A command to the DSP has timed out. Check the I/O port configuration. +A command to the DSP has timed out. +Check the I/O port configuration. .It bad irq XX (5/7/9/10 valid) .Pp The IRQ given to the driver is not valid. diff --git a/share/man/man4/splash.4 b/share/man/man4/splash.4 index c385634a0eaf..6004b2fbbe25 100644 --- a/share/man/man4/splash.4 +++ b/share/man/man4/splash.4 @@ -54,7 +54,8 @@ If you specify .Fl c or .Fl v -boot option when loading kernel, the splash image will not appear. However, it +boot option when loading kernel, the splash image will not appear. +However, it is still loaded and can be used as a screen saver later: see below. .Pp In order to display the bitmap, the bitmap file itself and the @@ -137,7 +138,8 @@ key: the defaults are .Em Shift-Pause on the AT enhanced keyboard and .Em Shift-Ctrl-NumLock/Pause -on the AT 84 keyboard. You can change the +on the AT 84 keyboard. +You can change the .Ar saver key by modifying the keymap .Pq see Xr kbdcontrol 1 , Xr keymap 5 , diff --git a/share/man/man4/ste.4 b/share/man/man4/ste.4 index e6c97845f95f..342f39c569f5 100644 --- a/share/man/man4/ste.4 +++ b/share/man/man4/ste.4 @@ -45,13 +45,17 @@ The .Nm driver provides support for PCI ethernet adapters and embedded controllers based on the Sundance Technologies ST201 PCI fast -ethernet controller chip. This includes the D-Link DFE-550TX. +ethernet controller chip. +This includes the D-Link DFE-550TX. .Pp The Sundance ST201 uses bus master DMA and is designed to be a -3Com Etherlink XL workalike. It uses the same DMA descriptor +3Com Etherlink XL workalike. +It uses the same DMA descriptor structure and is very similar in operation, however its register -layout is different. The ST201 has a 64-bit multicast hash filter -and a single perfect filter entry for the station address. IT +layout is different. +The ST201 has a 64-bit multicast hash filter +and a single perfect filter entry for the station address. +IT supports both 10 and 100Mbps speeds in either full or half duplex using an MII transceiver. .Pp @@ -67,14 +71,16 @@ the autoselected mode by adding media options to the .Pa /etc/rc.conf fine. .It 10baseT/UTP -Set 10Mbps operation. The +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 +Set 100Mbps (fast ethernet) operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -112,20 +118,25 @@ 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 "ste%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 +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 +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 +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 +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 +operating system. +If you power down your system prior to booting .Fx , the card should be configured correctly. .El diff --git a/share/man/man4/sysmouse.4 b/share/man/man4/sysmouse.4 index 7817eaa6faa7..eed07eae063e 100644 --- a/share/man/man4/sysmouse.4 +++ b/share/man/man4/sysmouse.4 @@ -85,7 +85,8 @@ Always zero. .It bit 2 Left button status; cleared if pressed, otherwise set. .It bit 1 -Middle button status; cleared if pressed, otherwise set. Always one, +Middle button status; cleared if pressed, otherwise set. +Always one, if the device does not have the middle button. .It bit 0 Right button status; cleared if pressed, otherwise set. @@ -231,7 +232,8 @@ is always 0. .Pp The .Dv packetsize -field specifies the length of the data packet. It depends on the +field specifies the length of the data packet. +It depends on the operation level. .Pp .Bl -tag -width level_0__ -compact @@ -246,7 +248,8 @@ The array holds a bit mask and pattern to detect the first byte of the data packet. .Dv syncmask[0] -is the bit mask to be ANDed with a byte. If the result is equal to +is the bit mask to be ANDed with a byte. +If the result is equal to .Dv syncmask[1] , the byte is likely to be the first byte of the data packet. Note that this method of detecting the first byte is not 100% reliable, @@ -258,7 +261,8 @@ as specified in .Ar mode . Only .Dv level -may be modifiable. Setting values in the other field does not generate +may be modifiable. +Setting values in the other field does not generate error and has no effect. .\" .Pp .\" .It Dv MOUSE_GETVARS Ar mousevar_t *vars @@ -342,7 +346,8 @@ The signal to be delivered is set in .Dv u.mode . .El .Pp -The above operations are for virtual consoles. The operations defined +The above operations are for virtual consoles. +The operations defined below are for the console control device and used by .Xr moused 8 to pass mouse data to the console driver. @@ -361,7 +366,8 @@ requested or performs cut and paste operations if the current console is a text interface. .It Dv MOUSE_BUTTONEVENT .Dv u.data -specifies a button and its click count. The console driver will +specifies a button and its click count. +The console driver will use this information for signal delivery if requested or for cut and paste operations if the console is in text mode. .El @@ -394,7 +400,8 @@ and .Dv z represent movement of the mouse along respective directions. .Dv buttons -tells the state of buttons. It encodes up to 31 buttons in the bit 0 though +tells the state of buttons. +It encodes up to 31 buttons in the bit 0 though the bit 30. If a button is held down, the corresponding bit is set. .Pp .It Dv mode @@ -407,7 +414,8 @@ struct mouse_mode { .Pp The .Dv signal -field specifies the signal to be delivered to the process. It must be +field specifies the signal to be delivered to the process. +It must be one of the values defined in .Ao Pa signal.h Ac . The diff --git a/share/man/man4/termios.4 b/share/man/man4/termios.4 index 64140b36dba3..67e6804c6c1b 100644 --- a/share/man/man4/termios.4 +++ b/share/man/man4/termios.4 @@ -237,7 +237,8 @@ upon receiving the character. .Pp Two general kinds of input processing are available, determined by whether the terminal device file is in canonical mode or noncanonical -mode. Additionally, +mode. +Additionally, input characters are processed according to the .Fa c_iflag and @@ -924,10 +925,12 @@ is set, start/stop output control is enabled. A received character suspends output and a received .Dv START character -restarts output. If +restarts output. +If .Dv IXANY is also set, then any character may -restart output. When +restart output. +When .Dv IXON is set, .Dv START diff --git a/share/man/man4/ti.4 b/share/man/man4/ti.4 index 383fb56756b5..294098da348c 100644 --- a/share/man/man4/ti.4 +++ b/share/man/man4/ti.4 @@ -43,19 +43,26 @@ Alteon Networks Tigon I and Tigon II gigabit ethernet driver The .Nm driver provides support for PCI gigabit ethernet adapters based on -the Alteon Networks Tigon gigabit ethernet controller chip. The Tigon +the Alteon Networks Tigon gigabit ethernet controller chip. +The Tigon contains an embedded R4000 CPU, gigabit MAC, dual DMA channels and -a PCI interface unit. The Tigon II contains two R4000 CPUs and other -refinements. Either chip can be used in either a 32-bit or 64-bit PCI -slot. Communication with the chip is achieved via PCI shared memory -and bus master DMA. The Tigon I and II support hardware multicast +a PCI interface unit. +The Tigon II contains two R4000 CPUs and other +refinements. +Either chip can be used in either a 32-bit or 64-bit PCI +slot. +Communication with the chip is achieved via PCI shared memory +and bus master DMA. +The Tigon I and II support hardware multicast address filtering, VLAN tag extraction and insertion, and jumbo -ethernet frames sizes up to 9000 bytes. Note that the Tigon I chipset +ethernet frames sizes up to 9000 bytes. +Note that the Tigon I chipset is no longer in active production: all new adapters should come equipped with Tigon II chipsets. .Pp There are several PCI boards available from both Alteon and other -vendors that use the Tigon chipset under OEM contract. The +vendors that use the Tigon chipset under OEM contract. +The .Nm driver has been tested with the following Tigon-based adapters: .Bl -bullet -offset indent @@ -77,7 +84,8 @@ Silicon Graphics PCI gigabit ethernet adapter .Pp While the Tigon chipset supports 10, 100 and 1000Mbps speeds, support for 10 and 100Mbps speeds is only available on boards with the proper -transceivers. Most adapters are only designed to work at 1000Mbps, +transceivers. +Most adapters are only designed to work at 1000Mbps, however the driver should support those NICs that work at lower speeds as well. .Pp @@ -90,7 +98,8 @@ such as file transfers and data streaming. .Pp Support for vlans is also available using the .Xr vlan 4 -mechanism. See the +mechanism. +See the .Xr vlan 4 man page for more details. .Pp @@ -106,14 +115,16 @@ the autoselected mode by adding media options to the .Pa /etc/rc.conf file. .It 10baseT/UTP -Set 10Mbps operation. The +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 +Set 100Mbps (fast ethernet) operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -121,7 +132,8 @@ or .Ar half-duplex modes. .It 1000baseSX -Set 1000Mbps (gigabit ethernet) operation. Only full +Set 1000Mbps (gigabit ethernet) operation. +Only full .Ar full-duplex mode is supported at this speed. .El @@ -149,21 +161,25 @@ A fatal initialization error has occurred. The driver failed to allocate memory for per-device instance information during initialization. .It "ti%d: failed to enable memory mapping!" -The driver failed to initialize PCI shared memory mapping. This might +The driver failed to initialize PCI shared memory mapping. +This might happen if the card is not in a bus-master slot. .It "ti%d: no memory for jumbo buffers!" The driver failed to allocate memory for jumbo frames during initialization. .It "ti%d: bios thinks we're in a 64 bit slot, but we aren't" The BIOS has programmed the NIC as though it had been installed in -a 64-bit PCI slot, but in fact the NIC is in a 32-bit slot. This happens -as a result of a bug in some BIOSes. This can be worked around on the +a 64-bit PCI slot, but in fact the NIC is in a 32-bit slot. +This happens +as a result of a bug in some BIOSes. +This can be worked around on the Tigon II, but on the Tigon I initialization will fail. .It "ti%d: board self-diagnostics failed!" The ROMFAIL bit in the CPU state register was set after system startup, indicating that the on-board NIC diagnostics failed. .It "ti%d: unknown hwrev" -The driver detected a board with an unsupported hardware revision. The +The driver detected a board with an unsupported hardware revision. +The .Nm driver supports revision 4 (Tigon 1) and revision 6 (Tigon 2) chips and has firmware only for those devices. diff --git a/share/man/man4/tl.4 b/share/man/man4/tl.4 index 2b19f3f8b952..367236277d56 100644 --- a/share/man/man4/tl.4 +++ b/share/man/man4/tl.4 @@ -44,10 +44,12 @@ Texas Instruments ThunderLAN ethernet device driver The .Nm driver provides support for PCI ethernet adapters based on the Texas -Instruments ThunderLAN ethernet controller chip. This includes a large +Instruments ThunderLAN ethernet controller chip. +This includes a large number of Compaq PCI-bus ethernet adapters as well as the integrated ethernet controllers built in to several models of Compaq Prosignia -servers and Compaq Deskpro desktop machines. This driver also supports +servers and Compaq Deskpro desktop machines. +This driver also supports the Olicom OC-2135/2138, OC-2325 and OC-2326 10/100 TX UTP adapters and the Racore 8165 10/100baseTX and 8148 10baseT/100baseTX/100baseFX multi-personality cards. @@ -55,11 +57,14 @@ multi-personality cards. The ThunderLAN controller has a standard MII interface that supports up to 32 physical interface devices (PHYs). It also has a built-in 10baseT PHY hardwired at MII address 31, which may be used in some -10Mbps-only hardware configurations. In 100Mbps configurations, a +10Mbps-only hardware configurations. +In 100Mbps configurations, a National Semiconductor DP83840A or other MII-compliant PHY may be -attached to the ThunderLAN's MII bus. If a DP83840A or equivalent +attached to the ThunderLAN's MII bus. +If a DP83840A or equivalent is available, the ThunderLAN chip can operate at either 100Mbps or -10Mbps in either half-duplex or full-duplex modes. The ThunderLAN's +10Mbps in either half-duplex or full-duplex modes. +The ThunderLAN's built-in PHY and the DP83840A also support autonegotiation. .Pp The @@ -68,7 +73,8 @@ driver supports the following media types: .Pp .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It autoselect -Enable autoselection of the media type and options. Note that this +Enable autoselection of the media type and options. +Note that this option is only available on those PHYs that support autonegotiation. Also, the PHY will not advertise those modes that have been explcitly disabled using the following media options. diff --git a/share/man/man4/tun.4 b/share/man/man4/tun.4 index 9785d7f01157..5a384188ed3b 100644 --- a/share/man/man4/tun.4 +++ b/share/man/man4/tun.4 @@ -72,7 +72,8 @@ is exclusive-open .Po it cannot be opened if it is already open .Pc -and is restricted to the super-user. A +and is restricted to the super-user. +A .Fn read call will return an error .Pq Er EHOSTDOWN @@ -97,7 +98,8 @@ to the network interface output routine .Pq Sq Li tunoutput . The destination address is in .Sq Li struct sockaddr -format. The actual length of the prepended address is in the member +format. +The actual length of the prepended address is in the member .Sq Li sa_len . The packet data follows immediately. A diff --git a/share/man/man4/uhci.4 b/share/man/man4/uhci.4 index f963bcda3dd7..c6fa9a3c339a 100644 --- a/share/man/man4/uhci.4 +++ b/share/man/man4/uhci.4 @@ -43,7 +43,8 @@ UHCI USB Host Controller Driver .Sh DESCRIPTION The .Nm -driver provides support for UHCI-type PCI based USB controllers. This +driver provides support for UHCI-type PCI based USB controllers. +This includes .Bl -tag -width xxxxx .It Intel 82371AB/EB (PIIX4) diff --git a/share/man/man4/ukbd.4 b/share/man/man4/ukbd.4 index 6a0fb358ecc4..391e81738fd3 100644 --- a/share/man/man4/ukbd.4 +++ b/share/man/man4/ukbd.4 @@ -62,8 +62,10 @@ sh MAKEDEV kbd0 kbd1 .Ed .Pp If both an AT keyboard as well as USB keyboards are used at the same time, the -AT keyboard will appear as kbd0 in /dev. The USB keyboards will be kbd1, kbd2, -etc. You can see some information about the keyboard with the following command: +AT keyboard will appear as kbd0 in /dev. +The USB keyboards will be kbd1, kbd2, +etc. +You can see some information about the keyboard with the following command: .Bd -literal -offset indent kbdcontrol -i < /dev/kbd1 .Ed @@ -88,7 +90,8 @@ to be used as the console. If you want to use a USB keyboard as your default and not use an AT keyboard at all, you will have to remove the .Nm atkbd0 -from the kernel configuration file. Because of the order of the device +from the kernel configuration file. +Because of the order of the device initialisation, the USB keyboard will be detected AFTER the console driver initialises itself and you have to explicitly tellthe console driver to use the existence of the USB keyboard. This can be done in diff --git a/share/man/man4/umass.4 b/share/man/man4/umass.4 index e2f2010764ef..adc16b1e7e9f 100644 --- a/share/man/man4/umass.4 +++ b/share/man/man4/umass.4 @@ -42,7 +42,8 @@ The .Nm driver provides support for Mass Storage devices that attach to the USB -port. Supported are +port. +Supported are .Bl -tag -compact -width xxxxxx .It Iomega Zip 100 drive .El @@ -51,7 +52,8 @@ and one of .Nm uhci or .Nm ohci -must be configured in the kernel as well. Last but not least, support for +must be configured in the kernel as well. +Last but not least, support for SCSI drives, .Nm da .Sh EXAMPLE @@ -66,7 +68,8 @@ driver to the kernel. .Pp .Dl camcontrol rescan 0 .Pp -Rescan a Zip drive that was added after boot. The command above +Rescan a Zip drive that was added after boot. +The command above assumes that the Zip drive is the first SCSI bus in the system. .Pp .Dl disklabel -w -r da0 zip100 diff --git a/share/man/man4/ums.4 b/share/man/man4/ums.4 index 6871be32dd4f..22425ffdf48f 100644 --- a/share/man/man4/ums.4 +++ b/share/man/man4/ums.4 @@ -41,7 +41,8 @@ .Sh DESCRIPTION The .Nm -driver provides support for mice that attach to the USB port. Supported are +driver provides support for mice that attach to the USB port. +Supported are mice with any number of buttons and mice with a wheel. .Nm usb and one of @@ -54,7 +55,8 @@ The /dev/ums device presents the mouse as a .Ar sysmouse or .Ar mousesystems -type device. See +type device. +See .Nm moused for an explanation of these mouse types. .Sh FILES diff --git a/share/man/man4/usb.4 b/share/man/man4/usb.4 index a6db0a1a8c48..8dded70fe814 100644 --- a/share/man/man4/usb.4 +++ b/share/man/man4/usb.4 @@ -47,7 +47,8 @@ devices. The .Nm driver has three layers: the controller, the bus, and the -device layer. The controller attaches to a physical bus +device layer. +The controller attaches to a physical bus (like .Xr pci 4 ). The @@ -202,7 +203,8 @@ and .Va addr contain the topological information for the device. .Va devnames -contains the device names of the connected drivers. For example the +contains the device names of the connected drivers. +For example the third USB Zip drive connected will be .Li umass2 . The @@ -220,7 +222,8 @@ field shows the current configuration of the device. .Pp .Va lowspeed indicates whether the device is a full speed (0) or low speed (1) -device. The +device. +The .Va power field shows the power consumption in milli-amps drawn at 5 volts, or zero if the device is self powered. diff --git a/share/man/man4/vga.4 b/share/man/man4/vga.4 index 53543d11ca18..7e6f45620e20 100644 --- a/share/man/man4/vga.4 +++ b/share/man/man4/vga.4 @@ -59,9 +59,11 @@ as other drivers. .Pp The .Nm -driver supports the standard video cards: MDA, CGA, EGA and VGA. In +driver supports the standard video cards: MDA, CGA, EGA and VGA. +In addition, the driver can utilize VESA BIOS extensions if the video card -supports them. VESA support can either be statically included in the kernel +supports them. +VESA support can either be statically included in the kernel or can be loaded as a separate module. .Pp In order to statically link the VESA support to the kernel, the diff --git a/share/man/man4/vpo.4 b/share/man/man4/vpo.4 index cce6669afaf5..96f4a235cc64 100644 --- a/share/man/man4/vpo.4 +++ b/share/man/man4/vpo.4 @@ -40,7 +40,8 @@ For one or more SCSI busses: 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 +in the Iomega ZIP drive. +But it should also work with the Iomega Jaz Traveller parallel to SCSI interface. .Pp The driver has been extended to the ZIP+ drive which is based on the @@ -49,7 +50,8 @@ Iomega Matchmaker Parallel to SCSI interface. The driver should let you use a printer connected to the drive while transfering data. .Pp -DOS and FreeBSD filesystems are supported. When mounting a DOS filesystem or +DOS and FreeBSD filesystems are supported. +When mounting a DOS filesystem or formating a FreeBSD filesystem, check the slice of the disk with the .Xr fdisk 8 utility. diff --git a/share/man/man4/vr.4 b/share/man/man4/vr.4 index 6c27b6465bf0..cf146237d5b3 100644 --- a/share/man/man4/vr.4 +++ b/share/man/man4/vr.4 @@ -45,19 +45,23 @@ 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 +VT86C100A Rhine II fast ethernet controller chips. +This includes the D-Link DFE530-TX, the Hawking Technologies PN102TX, the AOpen/Acer ALN-320, and various other commodity fast ethernet cards. .Pp The VIA Rhine chips use bus master DMA and have a descriptor layout -designed to resemble that of the DEC 21x4x "tulip" chips. The register +designed to resemble that of the DEC 21x4x "tulip" chips. +The register layout is different however and 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. 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 +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 @@ -72,14 +76,16 @@ the autoselected mode by adding media options to the .Pa /etc/rc.conf file. .It 10baseT/UTP -Set 10Mbps operation. The +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 +Set 100Mbps (fast ethernet) operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -119,20 +125,25 @@ 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 +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 +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 +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 +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 +operating system. +If you power down your system prior to booting .Fx , the card should be configured correctly. .El @@ -163,5 +174,6 @@ 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 +be avoided. +On faster machines (e.g. a Pentium II), the performance impact is much less noticable. diff --git a/share/termcap/termcap.5 b/share/termcap/termcap.5 index 14e23180c2f9..3dbcd89d3d67 100644 --- a/share/termcap/termcap.5 +++ b/share/termcap/termcap.5 @@ -121,7 +121,8 @@ The following suffixes should be used where possible: .Ed .Sh CAPABILITIES The description field attempts to convey the semantics of the -capability. You may find some codes in the description field: +capability. +You may find some codes in the description field: .Pp .Bl -tag -width #[1-9] .It (P)