Changeset View
Standalone View
share/man/man4/em.4
Show All 39 Lines | |||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
To compile this driver into the kernel, | To compile this driver into the kernel, | ||||
place the following line in your | place the following line in your | ||||
kernel configuration file: | kernel configuration file: | ||||
.Bd -ragged -offset indent | .Bd -ragged -offset indent | ||||
.Cd "device em" | .Cd "device em" | ||||
.Ed | .Ed | ||||
.Pp | .Pp | ||||
Optional multiqueue support is available via the following kernel | |||||
compile options: | |||||
.Bd -ragged -offset indent | |||||
.Cd "options EM_MULTIQUEUE" | |||||
.Ed | |||||
.Pp | |||||
Note: Activating EM_MULTIQUEUE support is not supported by Intel. | |||||
.Pp | |||||
Alternatively, to load the driver as a | Alternatively, to load the driver as a | ||||
erj: Note: Activating EM_MULTIQUEUE support **will** disable MSI-X features
by default. Until… | |||||
Done Inline ActionsDo you guys want this *verbatim* in the man page? Sounds kind of scary. :-) sbruno: Do you guys want this *verbatim* in the man page? Sounds kind of scary. :-) | |||||
Done Inline ActionsPassive->active: s/will disable/disables/ Agreed with sbruno. This kind of implies "not done". Maybe it should be in the BUGS section? wblock: Passive->active: s/will disable/disables/
Avoid "you" and "your": "the system when… | |||||
module at boot time, place the following line in | module at boot time, place the following line in | ||||
.Xr loader.conf 5 : | .Xr loader.conf 5 : | ||||
.Bd -literal -offset indent | .Bd -literal -offset indent | ||||
if_em_load="YES" | if_em_load="YES" | ||||
.Ed | .Ed | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
The | The | ||||
.Nm | .Nm | ||||
▲ Show 20 Lines • Show All 135 Lines • ▼ Show 20 Lines | |||||
Intel PRO/1000 XT Server Adapter (82544) | Intel PRO/1000 XT Server Adapter (82544) | ||||
.El | .El | ||||
.Sh LOADER TUNABLES | .Sh LOADER TUNABLES | ||||
Tunables can be set at the | Tunables can be set at the | ||||
.Xr loader 8 | .Xr loader 8 | ||||
prompt before booting the kernel or stored in | prompt before booting the kernel or stored in | ||||
.Xr loader.conf 5 . | .Xr loader.conf 5 . | ||||
.Bl -tag -width indent | .Bl -tag -width indent | ||||
.It Va hw.em.eee_setting | |||||
Disable or Enable Energy Efficient Ethernet. Default 1 (disabled). | |||||
Done Inline ActionsDisable or Enable Energy Efficient Ethernet. Default 1 (disabled). erj: Disable or **Enable** Energy Efficient Ethernet. Default 1 (disabled). | |||||
Done Inline ActionsCapitalizing "enable" implies that it is a value the user sets. Should be lower case. (And 1 to disable is unexpected, but that has probably been mentioned already.) The second sentence should be on a new line: Disable or enable Energy Efficient Ethernet. wblock: Capitalizing "enable" implies that it is a value the user sets. Should be lower case. (And 1… | |||||
.It Va hw.em.msix | |||||
Enable or Disable MSI-X style interrupts. Default 1 (on). | |||||
Done Inline ActionsAs above, don't capitalize "disable", and start a new sentence on a new line. wblock: As above, don't capitalize "disable", and start a new sentence on a new line. | |||||
.It Va hw.em.smart_pwr_down | |||||
Enable or Disable smart power down features on newer adapters. Default 0 (off). | |||||
Done Inline ActionsAs above. wblock: As above. | |||||
.It Va hw.em.sbp | |||||
Show bad packets when in promiscuous mode. Default 0 (off). | |||||
Done Inline ActionsNew sentence should be on a new line. wblock: New sentence should be on a new line. | |||||
.It Va hw.em.rxd | .It Va hw.em.rxd | ||||
Number of receive descriptors allocated by the driver. | Number of receive descriptors allocated by the driver. | ||||
The default value is 1024 for adapters newer than 82547, | The default value is 1024 for adapters newer than 82547, | ||||
and 256 for older ones. | and 256 for older ones. | ||||
The 82542 and 82543-based adapters can handle up to 256 descriptors, | The 82542 and 82543-based adapters can handle up to 256 descriptors, | ||||
while others can have up to 4096. | while others can have up to 4096. | ||||
.It Va hw.em.txd | .It Va hw.em.txd | ||||
Number of transmit descriptors allocated by the driver. | Number of transmit descriptors allocated by the driver. | ||||
Show All 15 Lines | |||||
This value delays the generation of transmit interrupts in units of | This value delays the generation of transmit interrupts in units of | ||||
1.024 microseconds. | 1.024 microseconds. | ||||
The default value is 64. | The default value is 64. | ||||
.It Va hw.em.tx_abs_int_delay | .It Va hw.em.tx_abs_int_delay | ||||
If | If | ||||
.Va hw.em.tx_int_delay | .Va hw.em.tx_int_delay | ||||
is non-zero, this tunable limits the maximum delay in which a transmit | is non-zero, this tunable limits the maximum delay in which a transmit | ||||
interrupt is generated. | interrupt is generated. | ||||
.It Va hw.em.num_rx_queues | |||||
.It Va hw.em.num_tx_queues | |||||
Done Inline Actions"h/w" would be better as just "hardware", and "we" is unnecessary. "Max 2" is a sentence fragment, probably best added to the previous sentence as an aside. Also, new sentences on new lines: Number of hardware queues to be run on this adapter (maximum of 2). wblock: "h/w" would be better as just "hardware", and "we" is unnecessary. "Max 2" is a sentence… | |||||
Number of h/w queues that we will run on this adapter. Max 2. Defaults to 1. | |||||
Only valid with kernel configuration | |||||
.Cd "options EM_MULTIQUEUE". | |||||
.El | .El | ||||
.Sh FILES | .Sh FILES | ||||
.Bl -tag -width /dev/led/em* | .Bl -tag -width /dev/led/em* | ||||
.It Pa /dev/led/em* | .It Pa /dev/led/em* | ||||
identification LED device nodes | identification LED device nodes | ||||
.El | .El | ||||
.Sh EXAMPLES | .Sh EXAMPLES | ||||
Make the identification LED of em0 blink: | Make the identification LED of em0 blink: | ||||
▲ Show 20 Lines • Show All 51 Lines • Show Last 20 Lines |
Note: Activating EM_MULTIQUEUE support will disable MSI-X features
by default. Until these issues are resolved, activating MSI-X will crash
your system with EM_MULTIQUEUE enabled.