diff options
| -rw-r--r-- | share/man/man4/vlan.4 | 66 | ||||
| -rw-r--r-- | share/man/man4/vr.4 | 51 | ||||
| -rw-r--r-- | share/man/man4/wb.4 | 67 |
3 files changed, 101 insertions, 83 deletions
diff --git a/share/man/man4/vlan.4 b/share/man/man4/vlan.4 index f5d7967e90c..dfbd4f43454 100644 --- a/share/man/man4/vlan.4 +++ b/share/man/man4/vlan.4 @@ -1,6 +1,6 @@ -.\" $OpenBSD: vlan.4,v 1.5 2000/06/12 14:40:49 chris Exp $ +.\" $OpenBSD: vlan.4,v 1.6 2000/07/02 15:59:14 aaron Exp $ .\" -.Dd 09 January 2000 +.Dd January 9, 2000 .Dt VLAN 4 .Os .Sh NAME @@ -11,29 +11,31 @@ .Sh DESCRIPTION The .Nm vlan -ethernet interface allows construction of virtual LANs when used in -conjunction with IEEE 802.1Q-compliant ethernet devices. +Ethernet interface allows construction of virtual LANs when used in +conjunction with IEEE 802.1Q-compliant Ethernet devices. .Pp This driver currently supports the following modes of operation: .Bl -tag -width abc -.It 802.1Q encapsulation over ethernet (Ethernet protocol 0x8100) +.It 802.1Q encapsulation over Ethernet (Ethernet protocol 0x8100) .Pp The 802.1Q header specifies the virtual LAN number, and thus allows an -ethernet switch (or other 802.1Q compliant network devices) to be aware of +Ethernet switch (or other 802.1Q compliant network devices) to be aware of which LAN the frame is part of, and in the case of a switch, which -port(s) the frame can go to. Frames transmitted through the vlan -interface will be diverted to the specified physical interface with -802.1Q vlan encapsulation. Frames with 802.1Q encapsulation received by -the parent interface with the correct vlan tag will be diverted to the -associated vlan pseudo-interface. +port(s) the frame can go to. +Frames transmitted through the vlan interface will be diverted to the specified +physical interface with 802.1Q vlan encapsulation. +Frames with 802.1Q encapsulation received by the parent interface with the +correct vlan tag will be diverted to the associated vlan pseudo-interface. .El .Pp Frame headers which normally contain the destination host, source host, and -protocol, are altered with additional information. After the source host, +protocol, are altered with additional information. +After the source host, a 32-bit 802.1Q header is included, with 16 bits for the ether type (0x8100), 3 bits for the priority field (not used in this implementation), 1 bit for -the canonical field (always 0), and 12 bits for the vlan identifier. Following -the vlan header is the actual ether type for the frame and length information. +the canonical field (always 0), and 12 bits for the vlan identifier. +Following the vlan header is the actual ether type for the frame and length +information. .Pp The network interfaces are named .Sy vlan Ns Ar 0 , @@ -56,21 +58,21 @@ The operation mode can be given as .Bl -tag -width bbb .It link0 The parent interface supports VLAN tagging/untagging in hardware, -this requires support from the ethernet driver as well. +this requires support from the Ethernet driver as well. .El .Pp to .Xr ifconfig 8 . .Pp .Sh SEE ALSO -.Xr netintro 4 , -.Xr ip 4 , .Xr bridge 4 , .Xr inet 4 , +.Xr ip 4 , +.Xr netintro 4 , .Xr ifconfig 8 .Pp All aspects of the vlan interface can be configured with -.Xr ifconfig 8 , +.Xr ifconfig 8 ; see its manual page for more information. .Pp A draft of IEEE 802.1Q standard can be obtained from @@ -79,32 +81,34 @@ or the final version can be purchased from the Institute of Electrical and Electronic Engineers, Inc. .Sh BUGS The 802.1Q specification allows for operation over FDDI and Token Ring -as well as Ethernet. -This driver only supports such operation with ethernet devices. +as well as Ethernet. +This driver only supports such operation with Ethernet devices. .Pp -Some ethernet chips (notably the Intel 82558 and 82559) automatically -discard frames that are larger then 1514 bytes. All ethernet +Some Ethernet chips (notably the Intel 82558 and 82559) automatically +discard frames that are larger then 1514 bytes. +All Ethernet chips sporting this sort of feature should allow for it to be turned off. Optimally, upon loading, the chip's driver would do this (The .Xr fxp 4 driver currently does for the Intel 82558/82559 chips.) -Refer to the hardware manual for your ethernet chip to determine +Refer to the hardware manual for your Ethernet chip to determine if it has this feature, and if so, for information on how to turn it off. A symptom of this problem is that small frames pass through the VLAN (such as a frame carrying an ICMP packet), but frames which are at MTU size -are dropped. When these frames are dropped, the TCP session will hang. +are dropped. +When these frames are dropped, the TCP session will hang. A temporary kludge is to set the MTU for each machine behind each VLAN to 1496 or less. .Pp -Some ethernet chips support 802.1Q tagging/untagging in hardware, but +Some Ethernet chips support 802.1Q tagging/untagging in hardware, but do not have the appropriate hooks in their driver to pass the frame -directly to if_vlan. The PCI device driver if_ti is able to do this, -use it as a reference. +directly to if_vlan. +The PCI device driver if_ti is able to do this, use it as a reference. .Pp This driver could be the basis for support of the Cisco ISL VLAN protocol, -detailed at http://www.cisco.com/warp/public/741/4.html. Unfortunately, -public reimplementation of this protocol is currently prevented by patent -(at least in the USA). +detailed at http://www.cisco.com/warp/public/741/4.html. +Unfortunately, public reimplementation of this protocol is currently prevented +by patent (at least in the USA). .Pp .Sh AUTHOR -Originally wollman@freebsd.org +Originally wollman@freebsd.org. diff --git a/share/man/man4/vr.4 b/share/man/man4/vr.4 index f40b5d9c03a..f5812818561 100644 --- a/share/man/man4/vr.4 +++ b/share/man/man4/vr.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vr.4,v 1.3 2000/04/03 21:19:37 aaron Exp $ +.\" $OpenBSD: vr.4,v 1.4 2000/07/02 15:59:14 aaron Exp $ .\" .\" Copyright (c) 1997, 1998 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. @@ -37,27 +37,27 @@ .Os .Sh NAME .Nm vr -.Nd VIA Technologies VT3043 and VT86C100A ethernet device driver +.Nd VIA Technologies VT3043 and VT86C100A Ethernet device driver .Sh SYNOPSIS .Cd "vr* at pci? dev ? function ?" .Sh DESCRIPTION The .Nm -driver provides support for PCI ethernet adapters and embedded +driver provides support for PCI Ethernet adapters and embedded controllers based on the VIA Technologies VT3043 Rhine I and -VT86C100A Rhine II fast ethernet controller chips. This includes -the D-Link DFE530-TX and various other commodity fast ethernet +VT86C100A Rhine II Fast Ethernet controller chips. +This includes the D-Link DFE530-TX and various other commodity Fast Ethernet cards. .Pp The VIA Rhine chips use bus master DMA and have a software interface -designed to resemble that of the DEC 21x4x "tulip" chips. The major -differences are that the receive filter in the Rhine chips is +designed to resemble that of the DEC 21x4x "tulip" chips. +The major differences are that the receive filter in the Rhine chips is much simpler and is programmed through registers rather than by downloading a special setup frame through the transmit DMA engine, -and that transmit and receive DMA buffers must be longword -aligned. The Rhine chips are meant to be interfaced with external -physical layer devices via an MII bus. They support both -10 and 100Mbps speeds in either full or half duplex. +and that transmit and receive DMA buffers must be longword aligned. +The Rhine chips are meant to be interfaced with external +physical layer devices via an MII bus. +They support both 10 and 100Mbps speeds in either full or half duplex. .Pp The .Nm @@ -71,14 +71,16 @@ the autoselected mode by adding media options to the appropriate .Pa /etc/hostname.vr%d 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 @@ -117,21 +119,23 @@ The driver failed to allocate an mbuf for the receiver ring. 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 +This message applies only to adapters which support power management. +Some operating systems place the controller in low power mode when shutting down, and some PCI BIOSes fail to bring the chip -out of this state before configuring it. The controller loses all of -its PCI configuration in the D3 state, so if the BIOS does not set -it back to full power mode in time, it won't be able to configure it -correctly. The driver tries to detect this condition and bring +out of this state before configuring it. +The controller loses all of its PCI configuration in the D3 state, so if the +BIOS does not set it back to full power mode in time, it won't be able to +configure it correctly. +The driver tries to detect this condition and bring the adapter back to the D0 (full power) state, but this may not be -enough to return the driver to a fully operational condition. If -you see this message at boot time and the driver fails to attach +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 .Ox , the card should be configured correctly. .El @@ -164,5 +168,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/man/man4/wb.4 b/share/man/man4/wb.4 index d327edc2c8c..490820a658a 100644 --- a/share/man/man4/wb.4 +++ b/share/man/man4/wb.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wb.4,v 1.2 1999/06/05 13:18:34 aaron Exp $ +.\" $OpenBSD: wb.4,v 1.3 2000/07/02 15:59:15 aaron Exp $ .\" .\" Copyright (c) 1997, 1998 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. @@ -38,24 +38,26 @@ .Sh NAME .Nm wb .Nd -Winbond W89C840F fast ethernet device driver +Winbond W89C840F Fast Ethernet device driver .Sh SYNOPSIS .Cd "wb* at pci? dev ? function ?" .Sh DESCRIPTION The .Nm -driver provides support for PCI ethernet adapters and embedded -controllers based on the Winbond W89C840F fast ethernet controller -chip. This includes the Trendware TE100-PCIE and various other cheap -boards. The 840F should not be confused with the 940F, which is +driver provides support for PCI Ethernet adapters and embedded +controllers based on the Winbond W89C840F Fast Ethernet controller chip. +This includes the Trendware TE100-PCIE and various other cheap boards. +The 840F should not be confused with the 940F, which is an NE2000 clone and only supports 10Mbps speeds. .Pp The Winbond controller uses bus master DMA and is designed to be -a DEC 'tulip' workalike. It differs from the standard DEC design +a DEC "tulip" workalike. +It differs from the standard DEC design in several ways: the control and status registers are spaced 4 bytes apart instead of 8, and the receive filter is programmed through registers rather than by downloading a special setup frame via -the transmit DMA engine. Using an external PHY, the Winbond chip +the transmit DMA engine. +Using an external PHY, the Winbond chip supports both 10 and 100Mbps speeds in either full or half duplex. .Pp The @@ -64,21 +66,24 @@ driver supports the following media types: .Pp .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It autoselect -Enable autoselection of the media type and options. This is only -supported if the PHY chip attached to the Winbond controller -supports NWAY autonegotiation. The user can manually override +Enable autoselection of the media type and options. +This is only supported if the PHY chip attached to the Winbond controller +supports NWAY autonegotiation. +The user can manually override the autoselected mode by adding media options to the appropriate -.Pa /etc/hostname.wbX +.Pa /etc/hostname.wb%d 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 @@ -117,21 +122,23 @@ The driver failed to allocate an mbuf for the receiver ring. The driver failed to allocate an mbuf for the transmitter ring when allocating a pad buffer or collapsing an mbuf chain into a cluster. .It "wb%d: chip is in D3 power state -- setting to D0" -This message applies only to adapters which support power -management. Some operating systems place the controller in low power +This message applies only to adapters which support power management. +Some operating systems place the controller in low power mode when shutting down, and some PCI BIOSes fail to bring the chip -out of this state before configuring it. The controller loses all of -its PCI configuration in the D3 state, so if the BIOS does not set -it back to full power mode in time, it won't be able to configure it -correctly. The driver tries to detect this condition and bring +out of this state before configuring it. +The controller loses all of its PCI configuration in the D3 state, so if the +BIOS does not set it back to full power mode in time, it won't be able +to configure it correctly. +The driver tries to detect this condition and bring the adapter back to the D0 (full power) state, but this may not be -enough to return the driver to a fully operational condition. If -you see this message at boot time and the driver fails to attach +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 .Ox , the card should be configured correctly. .El @@ -154,11 +161,13 @@ driver was written by .An Bill Paul Aq wpaul@ctr.columbia.edu . .Sh BUGS The Winbond chip seems to behave strangely in some cases when the -link partner switches modes. If for example both sides are set to -10Mbps half-duplex, and the other end is changed to 100Mbps -full-duplex, the Winbond's receiver suddenly starts writing trash -all over the RX descriptors. The +link partner switches modes. +If for example both sides are set to 10Mbps half-duplex, and the other end +is changed to 100Mbps full-duplex, the Winbond's receiver suddenly starts +writing trash all over the RX descriptors. +The .Nm driver handles this by forcing a reset of both the controller -chip and attached PHY. This is drastic, but it appears to be the -only way to recover properly from this condition. +chip and attached PHY. +This is drastic, but it appears to be the only way to recover properly from +this condition. |