diff options
Diffstat (limited to 'usr/src/man/man7d')
-rw-r--r-- | usr/src/man/man7d/afe.7d | 5 | ||||
-rw-r--r-- | usr/src/man/man7d/blkdev.7d | 13 | ||||
-rw-r--r-- | usr/src/man/man7d/elxl.7d | 13 | ||||
-rw-r--r-- | usr/src/man/man7d/i40e.7d | 113 | ||||
-rw-r--r-- | usr/src/man/man7d/iprb.7d | 12 | ||||
-rw-r--r-- | usr/src/man/man7d/mxfe.7d | 4 | ||||
-rw-r--r-- | usr/src/man/man7d/rtls.7d | 4 | ||||
-rw-r--r-- | usr/src/man/man7d/usba.7d | 34 | ||||
-rw-r--r-- | usr/src/man/man7d/xhci.7d | 29 |
9 files changed, 127 insertions, 100 deletions
diff --git a/usr/src/man/man7d/afe.7d b/usr/src/man/man7d/afe.7d index 9f7c380050..3fb7991769 100644 --- a/usr/src/man/man7d/afe.7d +++ b/usr/src/man/man7d/afe.7d @@ -36,8 +36,9 @@ PCI controllers originally produced by ADMtek and Infineon. .Lp These devices generally support the standard Fast Ethernet features, including 10BASE-T and 100BASE-TX, both full and half duplex operation, IEEE 802.3 -autonegotiation, etc. They also support full size MTUs (1500 bytes), -even when used with VLANs. Most of them also support flow control. +autonegotiation, etc. +They also support full size MTUs (1500 bytes), even when used with VLANs. +Most of them also support flow control. . .Lp The device driver supports the diff --git a/usr/src/man/man7d/blkdev.7d b/usr/src/man/man7d/blkdev.7d index 022dbe4b0d..44f5fec7db 100644 --- a/usr/src/man/man7d/blkdev.7d +++ b/usr/src/man/man7d/blkdev.7d @@ -20,17 +20,17 @@ The .Nm driver supports generic block-oriented devices, such as non-volatile -memory storage devices. It provides a hardware independent layer -for such storage devices, allowing them to concentrate on the -hardware-specific details, while +memory storage devices. +It provides a hardware independent layer for such storage devices, allowing them +to concentrate on the hardware-specific details, while .Nm takes care of all the other details, such as .Xr dkio 7I . .Lp The .Nm -driver only supports block-oriented, random-access devices. It does -not support traditional rotational media and does not support +driver only supports block-oriented, random-access devices. +It does not support traditional rotational media and does not support SCSI commands. .Lp The most typical use case for @@ -65,7 +65,8 @@ logical unit number as well. .It Va sn This is the .Em slice -number, representing a subset of the disk. See +number, representing a subset of the disk. +See .Xr dkio 7I . .El . diff --git a/usr/src/man/man7d/elxl.7d b/usr/src/man/man7d/elxl.7d index 2abd3f962e..cc49101dbd 100644 --- a/usr/src/man/man7d/elxl.7d +++ b/usr/src/man/man7d/elxl.7d @@ -32,16 +32,17 @@ The .Nm driver provides support for the 3Com Etherlink XL -family of Ethernet and Fast Ethernet PCI controllers. These are often known -by their part numbers, most often 3c905 or 3c900 variants. +family of Ethernet and Fast Ethernet PCI controllers. +These are often known by their part numbers, most often 3c905 or 3c900 variants. .Lp The 3c905 devices generally support some form of 100 Mbps Ethernet, -whereas the 3c900 devices usually only support 10 Mbps. Some devices -support legacy media such as 10BASE-15, 10BASE-2, and even 10BASE-FL. +whereas the 3c900 devices usually only support 10 Mbps. +Some devices support legacy media such as 10BASE-15, 10BASE-2, and even +10BASE-FL. . Where applicable, the devices support auto-negotiation, both full and -half duplex, etc. They also support full size MTUs (1500 bytes), -even when used with VLANs. +half duplex, etc. +They also support full size MTUs (1500 bytes), even when used with VLANs. . .Lp The device driver supports the diff --git a/usr/src/man/man7d/i40e.7d b/usr/src/man/man7d/i40e.7d index e7d157b667..992297fe7d 100644 --- a/usr/src/man/man7d/i40e.7d +++ b/usr/src/man/man7d/i40e.7d @@ -53,20 +53,22 @@ support the use of flow control through hardware pause frames. .Sh APPLICATION PROGRAMMING INTERFACE For each device supported by the .Nm -installed in the system, a character-special file will be created. This -file supports the Data Link Provider Interface (DLPI) which is documented +installed in the system, a character-special file will be created. +This file supports the Data Link Provider Interface (DLPI) which is documented in .Xr dlpi 7P . For most consumers, the use of .Xr libdlpi 3LIB , is recommended. .Pp -Each instance is assigned a unique ascending integer identifier. A -device which has multiple ports may appear to the system as separate -instances. The system does not provide a guarnatee on how these will be -presented. Using this instance identifier, one can determine the exact -character-special file to open. For example, the first instance -enumerated in the system, with id 0, would be named +Each instance is assigned a unique ascending integer identifier. +A device which has multiple ports may appear to the system as separate +instances. +The system does not provide a guarnatee on how these will be presented. +Using this instance identifier, one can determine the exact character-special +file to open. +For example, the first instance enumerated in the system, with id 0, would be +named .Sy i40e0 . It exists in the file system at .Pa /dev/i40e0 . @@ -74,8 +76,8 @@ It exists in the file system at The .Nm i40e driver always performs auto-negotiation and depending on the model may -negotiate to 40 Gbps, 25 Gbps, 10 Gbps, or 1 Gbps. At this time, the -driver requires the use of auto-negotiation. +negotiate to 40 Gbps, 25 Gbps, 10 Gbps, or 1 Gbps. +At this time, the driver requires the use of auto-negotiation. .Pp The .Nm @@ -83,10 +85,13 @@ driver is managed by the .Xr dladm 1M utility. .Xr dladm 1M -is the preferred interface for setting all properties. While -.Xr driver.conf based configuration is possible, +is the preferred interface for setting all properties. +While +.Xr driver.conf 4 +based configuration is possible, .Xr dladm 1M -is recommended. The +is recommended. +The .Nm driver may be joined into an aggregation based on the link aggregation control protocol (LACP) through @@ -95,10 +100,10 @@ control protocol (LACP) through The device supports the following properties which may be tuned through its driver.conf file, .Pa /kernel/drv/i40e.conf . -Most of these properties cannot be changed after the device has been -started. The device is started in response to a DLPI consumer opening -the device and binding to it. This happens when an IP interfaces is -plumbed or another +Most of these properties cannot be changed after the device has been started. +The device is started in response to a DLPI consumer opening the device and +binding to it. +This happens when an IP interfaces is plumbed or another .Xr dlpi 7P consumer such as .Xr snoop 1M @@ -106,11 +111,13 @@ or an LLDP daemon is started. .Pp Some properties may be tuned at runtime with the .Xr dladm 1M -utility. Properties that can be will have the name of the dladm property -called out explicitly. +utility. +Properties that can be will have the name of the dladm property called out +explicitly. .Pp -These properties are not considered stable at this time. They may change -and should not be relied on. They are considered +These properties are not considered stable at this time. +They may change and should not be relied on. +They are considered .Sy Volatile . It is not expected that administrators of the system will have to tune these values. @@ -129,7 +136,8 @@ The .Sy default_mtu property determines the starting MTU of the various device instances. Note that the device's MTU also determines the upper bound of the MTU of -all VNICs created over the device. The default MTU is +all VNICs created over the device. +The default MTU is .Sy 1500 . .Ed .It Sy mr_enable @@ -143,8 +151,9 @@ Maximum: The .Sy mr_enable proeprty determines whether or not support for multiple rings is enabled -for the device. The default is always to enable them. It is not -recommended to to disable them. +for the device. +The default is always to enable them. +It is not recommended to to disable them. .Ed .It Sy rx_ring_size .Bd -filled -compact @@ -157,10 +166,10 @@ Maximum: The .Sy rx_ring_size property determines the number of descriptors that will be used in each -receive ring on the card. Administrators should not normally need to -tune this value. Hardware requires that the ring size be a multiple of -32. The system will round up the set value to the nearest multiple of -32. +receive ring on the card. +Administrators should not normally need to tune this value. +Hardware requires that the ring size be a multiple of 32. +The system will round up the set value to the nearest multiple of 32. .Ed .It Sy tx_ring_size .Bd -filled -compact @@ -173,10 +182,10 @@ Maximum: The .Sy tx_ring_size property determines the number of descriptors that will be used in each -transmit ring on the card. Administrators should not normally need to -tune this value. Hardware requires that the ring size be a multiple of -32. The system will round up the set value to the nearest multiple of -32. +transmit ring on the card. +Administrators should not normally need to tune this value. +Hardware requires that the ring size be a multiple of 32. +The system will round up the set value to the nearest multiple of 32. .Ed .It Sy tx_resched_threshold .Bd -filled -compact @@ -189,11 +198,13 @@ Maximum: The .Sy tx_resched_threshold property determines the number of descriptors that must be available for -a frame to be transmitted. The maximum is variable. It is dependent on -the value of the +a frame to be transmitted. +The maximum is variable. +It is dependent on the value of the .Sy tx_ring_size -property. At least eight descriptors must be available for the device to -function correctly. +property. +At least eight descriptors must be available for the device to function +correctly. .Ed .It Sy rx_limit_per_intr .Bd -filled -compact @@ -206,9 +217,9 @@ Maximum: The .Sy rx_limit_per_intr property determines the maximum number of packets that will be processed -on a given ring during a single interrupt. This is done to try and -guarantee some amount of liveness in the system. It is not expected -that administrators will have to tune this value. +on a given ring during a single interrupt. +This is done to try and guarantee some amount of liveness in the system. +It is not expected that administrators will have to tune this value. .Ed .It Sy tx_hcksum_enable .Bd -filled -compact @@ -221,10 +232,10 @@ Maximum: The .Sy tx_hcksum_enable property controls whether or not the device enables support for hardware -checksuming of outgoing packets. The default is to always enable support -for this. Turning it off will increase latency and decrease throughput -when transmitting packets, but should be done if a hardware bug is -suspected. +checksuming of outgoing packets. +The default is to always enable support for this. +Turning it off will increase latency and decrease throughput when transmitting +packets, but should be done if a hardware bug is suspected. .Ed .It Sy rx_hcksum_enable .Bd -filled -compact @@ -237,10 +248,10 @@ Maximum: The .Sy rx_hcksum_enable property controls whether or not the device enables support for hardware -checksuming of incoming packets. The default is to always enable support -for this. Turning it off will increase latency and decrease throughput -when receiving packets, but should be done if a hardware bug is -suspected. +checksuming of incoming packets. +The default is to always enable support for this. +Turning it off will increase latency and decrease throughput when receiving +packets, but should be done if a hardware bug is suspected. .Ed .It Sy rx_dma_threshold .Bd -filled -compact @@ -256,9 +267,11 @@ The .Sy rx_dma_treshold indicates the size in bytes of a received frame, including all of its headers, at which the driver should not copy the frame but instead bind -DMA memory. By setting this property to its minimum, all frames will be -processed with DMA binding. By setting this property to its maximum, all -frames will be processed by copying the frame. +DMA memory. +By setting this property to its minimum, all frames will be processed with DMA +binding. +By setting this property to its maximum, all frames will be processed by copying +the frame. .Ed .El .Sh ARCHITECTURE diff --git a/usr/src/man/man7d/iprb.7d b/usr/src/man/man7d/iprb.7d index 2e7ca9a416..6ac7c445ac 100644 --- a/usr/src/man/man7d/iprb.7d +++ b/usr/src/man/man7d/iprb.7d @@ -32,14 +32,16 @@ The .Nm driver provides support for the Intel PRO/100 family of Fast Ethernet -PCI controllers. This includes support for Intel 82558, 82559, 82550, -and 82551 parts, as well as certain controllers found on certain Intel -southbridge controllers (ICH2 and ICH3). +PCI controllers. +This includes support for Intel 82558, 82559, 82550, and 82551 parts, as well as +certain controllers found on certain Intel southbridge controllers (ICH2 and +ICH3). .Lp These devices generally support the standard Fast Ethernet features, including 10BASE-T and 100BASE-TX, both full and half duplex operation, IEEE 802.3 -autonegotiation, etc. They also support full size MTUs (1500 bytes), -even when used with VLANs. Some of them also support flow control. +autonegotiation, etc. +They also support full size MTUs (1500 bytes), even when used with VLANs. +Some of them also support flow control. . .Lp The device driver supports the diff --git a/usr/src/man/man7d/mxfe.7d b/usr/src/man/man7d/mxfe.7d index 38253b4b5a..5b0f49fe76 100644 --- a/usr/src/man/man7d/mxfe.7d +++ b/usr/src/man/man7d/mxfe.7d @@ -37,8 +37,8 @@ PCI controllers. .Lp These devices generally support the standard Fast Ethernet features, including 10BASE-T and 100BASE-TX, both full and half duplex operation, IEEE 802.3 -autonegotiation, etc. They also support full size MTUs (1500 bytes), -even when used with VLANs. +autonegotiation, etc. +They also support full size MTUs (1500 bytes), even when used with VLANs. . .Lp The device driver supports the diff --git a/usr/src/man/man7d/rtls.7d b/usr/src/man/man7d/rtls.7d index 4389bf3141..f3159bb278 100644 --- a/usr/src/man/man7d/rtls.7d +++ b/usr/src/man/man7d/rtls.7d @@ -36,8 +36,8 @@ PCI controllers. .Lp These devices generally support the standard Fast Ethernet features, including 10BASE-T and 100BASE-TX, both full and half duplex operation, IEEE 802.3 -autonegotiation, etc. They also support full size MTUs (1500 bytes), -even when used with VLANs. +autonegotiation, etc. +They also support full size MTUs (1500 bytes), even when used with VLANs. . .Lp The device driver supports the diff --git a/usr/src/man/man7d/usba.7d b/usr/src/man/man7d/usba.7d index 87c61d6758..3565badc61 100644 --- a/usr/src/man/man7d/usba.7d +++ b/usr/src/man/man7d/usba.7d @@ -12,13 +12,13 @@ .Nd illumos USB Architecture (USBA) .Sh DESCRIPTION USB provides a low-cost means for attaching peripheral devices, including -mass-storage devices, keyboards, mice, and printers, to a system. For complete -information on the USB architecture, visit the USB website at +mass-storage devices, keyboards, mice, and printers, to a system. +For complete information on the USB architecture, visit the USB website at http://www.usb.org. .Pp -USBA supports 126 hot-pluggable USB devices per USB bus. The maximum data -transfer rate is 5 Gbits (SuperSpeed USB 3.0), 480 Mbits (high speed USB -2.0), 12 Mbits (full speed USB 1.x), or 1.5 Mbits (low speed USB 1.x). +USBA supports 126 hot-pluggable USB devices per USB bus. +The maximum data transfer rate is 5 Gbits (SuperSpeed USB 3.0), 480 Mbits (high +speed USB 2.0), 12 Mbits (full speed USB 1.x), or 1.5 Mbits (low speed USB 1.x). .Pp USBA adheres to the .Em Universal Serial Bus 3.0 @@ -38,9 +38,11 @@ Devices without a driver may be able to leverage .Xr libusb 3LIB . .Sh FILES Listed below are drivers and modules which either utilize or are utilized by -USBA. Drivers in -.Pa /kernel/drv\ -are 32 bit drivers (x86 only). Drivers in +USBA. +Drivers in +.Pa /kernel/drv +are 32 bit drivers (x86 only). +Drivers in .Pa /kernel/drv/sparcv9 or .Pa kernel/drv/amd64 @@ -117,7 +119,8 @@ are 64 bit drivers. .El .Sh DIAGNOSTICS The messages described below may appear on the system console as well as being -logged. All messages are formatted in the following manner: +logged. +All messages are formatted in the following manner: .Bl -tag -width Sy -offset 2n .It WARNING: Error message... .El @@ -125,14 +128,17 @@ logged. All messages are formatted in the following manner: .It Sy no driver found for device <device_name> (interface <number> node name=<node_name>) The installed software does not contain a supported driver for this -hardware. <number> is the interface number. <name> is either the device path name or the device name. +hardware. +<number> is the interface number. +<name> is either the device path name or the device name. .It Sy Draining callbacks timed out! -An internal error occurred. Please reboot your system. If this problem -persists, contact your system vendor. +An internal error occurred. +Please reboot your system. +If this problem persists, contact your system vendor. .El .Pp -The following messages may be logged into the system log. They are formatted in -the following manner: +The following messages may be logged into the system log. +They are formatted in the following manner: .Bd -literal -offset 2n <device path><usba<instance number>): message... .Ed diff --git a/usr/src/man/man7d/xhci.7d b/usr/src/man/man7d/xhci.7d index e2822fd19c..4f2836b97e 100644 --- a/usr/src/man/man7d/xhci.7d +++ b/usr/src/man/man7d/xhci.7d @@ -23,9 +23,9 @@ The .Nm driver supports PCI devices that implement versions 1.0 and 1.1 of the -Extensible Host Controller Inteface Specification. These devices provide -support for USB 3.0, USB 2.x, and USB 1.x devices and is integrated into -the broader illumos USB Architecture (USBA). +Extensible Host Controller Inteface Specification. +These devices provide support for USB 3.0, USB 2.x, and USB 1.x devices and is +integrated into the broader illumos USB Architecture (USBA). .Pp The .Nm @@ -38,15 +38,16 @@ and .Pp Administrators do not interact with the .Nm -driver directly. USB devices are managed with +driver directly. +USB devices are managed with .Xr cfgadm 1M . See .Xr cfgadm_usb 1M for more information on how to specifically manage USB devices and how they are laid out in the system. .Xr cfgadm 1M -is only used to manage devices at a USB level. For example, a USB NIC -would still be managed with +is only used to manage devices at a USB level. +For example, a USB NIC would still be managed with .Xr dladm 1M at a networking level. .Pp @@ -54,15 +55,16 @@ On some x86 systems USB ports may be routed to either an instance of the .Nm driver or an instance of the .Xr ehci 7D -driver. By default, all such ports are routed to the +driver. +By default, all such ports are routed to the .Nm driver, allowing those devices to operate at USB 3.x speed by default. -This is most common on Intel platforms and chipsets. While this is -controlled with the +This is most common on Intel platforms and chipsets. +While this is controlled with the .Sy xhci-reroute property discussed below, changing it may not be sufficient to change -the behavior. The BIOS or ACPI data for many x86 systems may toggle this -automatically. +the behavior. +The BIOS or ACPI data for many x86 systems may toggle this automatically. .Sh PROPERTIES The .Nm @@ -77,8 +79,9 @@ The .Sy xhci-reroute property determines whether or not USB ports are re-routed to the .Nm -driver. The default behavior is to route such ports. To disable this, -the property should be set to +driver. +The default behavior is to route such ports. +To disable this, the property should be set to .Sy 0 . Any other value, or the lack of the property, cause the default behavior to take place. |