FREEBSD/freebsd.htm 0000755 0000000 0000000 00000103255 11716220100 011141 0 ustar
NOTE: This release includes two 10 gigabit FreeBSD Base Drivers for Intel Ethernet. These drivers are named em and igb. |
The igb driver supports all 82575 and 82576-based gigabit network connections.
The em driver supports all other gigabit network connections.
First identify your adapter. Then follow the appropriate steps for building, installing, and configuring the appropriate driver.
For information on how to identify your adapter, go to the Adapter & Driver ID Guide at:
http://support.intel.com/support/go/network/adapter/idguide.htm
For the latest Intel network drivers for FreeBSD, see:
http://support.intel.com/support/go/network/adapter/home.htm
NOTE: The Intel 82562v 10/100 Network Connection only supports 10/100 connectivity. |
Speed and Duplex Configuration
This file describes the FreeBSD* driver for Intel Ethernet. This driver has been developed for use with all community-supported versions of FreeBSD.
For questions related to hardware requirements, refer to the documentation supplied with your Gigabit adapter. All hardware requirements listed apply for use with FreeBSD.
NOTE: This driver package is to be used only as a standalone archive and the user should not attempt to incorporate it into the kernel source tree. |
In the instructions below, x.x.x is the driver version as indicated in the name of the driver tar file.
Move the base driver tar file to the directory of your choice. For example, use /home/username/em or /usr/local/src/em.
Untar/unzip the archive:
tar xzvf em-x.x.x.tar.gz
This will create an em-x.x.x directory.
To create a loadable module, perform the following steps.
To compile the module
cd em-x.x.x
make
To install the compiled module to the system
directory:
make install
If you want the driver to load automatically when the system is
booted:
1. Edit /boot/loader.conf, and add the following line.
if_em_load="YES"
To assign an IP address to the interface, enter the following:
ifconfig_em<interface_num> <IP_address>
Verify that the interface works. Enter the following, where <IP_address>
is the IP address for another machine on the same subnet as the interface
that is being tested:
ping <IP_address>
To configure the IP address to remain after reboot, edit
/etc/rc.conf, and create the appropriate ifconfig_em<interface_num> entry:
ifconfig_em<interface_num>="<ifconfig_settings>"
Example usage:
ifconfig_em0="inet 102.168.10.1 netmask
255.255.255.0"
NOTE: For assistance, see the ifconfig man page. |
By default, the adapter auto-negotiates the speed and duplex of the connection. If there is a specific need, the ifconfig utility can be used to configure the speed and duplex settings on the adapter. Example usage:
ifconfig emX <IP_address> media 100baseTX mediaopt full-duplex
NOTE: Only use mediaopt to set the driver to full-duplex. If mediaopt is not specified and you are not running at gigabit speed, the driver defaults to half-duplex. |
If the interface is currently forced to 100 full duplex, in order to change
to half duplex you must use this command:
ifconfig emX <IP_address>
media 100baseTX -mediaopt full-duplex
This driver supports the following media type options:
Media Type | Description |
---|---|
autoselect | Enables auto-negotiation for speed and duplex. |
10baseT/UTP | Sets speed to 10 Mbps. Use the ifconfig mediaopt option to select full-duplex mode. |
100baseTX | Sets speed to 100 Mbps. Use the ifconfig mediaopt option to select full-duplex mode. |
1000baseTX | Sets speed to 1000 Mbps. In this case, the driver supports only full-duplex mode. |
1000baseSX | Sets speed to 1000 Mbps. In this case, the driver supports only full-duplex mode. |
For more information on the ifconfig utility, see the ifconfig man page.
The driver supports Transmit/Receive Checksum Offload and Jumbo Frames on all but the 82542-based adapters. For specific adapters, refer to the Identifying Your Adapter section.
To enable Jumbo Frames, use the ifconfig utility to increase the Maximum Transmission Unit (MTU). The Jumbo Frames MTU range for Intel Adapters is 1500 to 16110 bytes, with a default value of 1500.
To modify MTU, enter the following:
ifconfig emX <hostname
or IP address> mtu 9000
To confirm the MTU used between two specific devices, use:
route get
<destination_IP_address>
NOTES:
|
To create a new VLAN interface:
ifconfig <vlan_name> create
To associate the VLAN interface with a physical interface and assign an IP address, netmask, and VLAN ID:
ifconfig <vlan_name> <ip_address> netmask <subnet_mask> vlan <vlan_id> vlandev <physical_interface>
Example:
ifconfig vlan10 10.0.0.1 netmask 255.255.255.0 vlan 10 vlandev em0
In this example, all packets will be marked on egress with 802.1Q VLAN tags, specifying a VLAN ID of 10.
To remove a VLAN interface:
ifconfig <vlan_name> destroy
NOTES: Device Polling is only valid for non-SMP kernels. | |
The driver has to be built into the kernel for Device Polling to be enabled in the driver. |
To enable polling in the driver, add the following options to the kernel configuration, and then recompile the kernel:
options DEVICE_POLLING
options HZ=1000
At runtime:
use sysctl kern.polling.enable=1 to
turn polling on
use sysctl kern.polling.enable=0 to turn polling off
Checksum offloading is not supported on 82542 Gigabit adapters.
Checksum offloading supports both TCP and UDP packets and is supported for both transmit and receive.
Checksum offloading can be enabled or disabled using ifconfig. Both transmit and receive offloading will be either enabled or disabled together. You cannot enable/disable one without the other.
To enable checksum offloading:
ifconfig emX rxcsum
To disable checksum offloading:
ifconfig emX -rxcsum
To confirm the current setting:
ifconfig emX
Look for the presence or absence of the following line:
options=3 <RXCSUM,TXCSUM>
The FreeBSD driver offers support for TSO (TCP Segmentation Offload). You can enable/disable it in two ways/places:
Doing this disables TSO in the stack and will affect all adapters.
To enable:
NOTES: By default only PCI-Express
adapters are ENABLED to do TSO. Others can be enabled by the user at their
own risk TSO is not supported on 82547 and 82544-based adapters, as well as older adapters. |
The FreeBSD driver offers MSIX support with 82574L-based network connections.
82574L-based network connections will use MSI-X by default.
MSI or MSI-X can be turned off by an entry in /etc/sysctl.conf
In some cases ports 3 and 4 wont pass traffic. Ports 1 and 2 don't show any errors and will pass traffic.
This issue MAY be resolved by updating to the latest BIOS. You can check your system's BIOS by downloading the Linux Firmware Developer Kit that can be obtained at http://www.linuxfirmwarekit.org/
There is a known compatibility issue where time to link is slow or link is not
established between 82541/82547 controllers and some switches. Known
switches include:
Planex
FXG-08TE
I-O Data
ETG-SH8
The driver can be compiled with the following changes:
Edit ./em.x.x.x/src/if_em.h to change the #define EM_MASTER_SLAVE
For example, change from:
#define EM_MASTER_SLAVE e1000_ms_hw_default
to:
#define EM_MASTER_SLAVE 2
Use one of the following options:
1 = Master mode
2 = Slave mode
3 = Auto master/slave
Setting 2 is recommended.
Recompile the module:
cd em-x.x.x
make clean
make
To install the compiled module in system directory:
make install
For general information and support, go to Support
If an issue is identified, support is through email only at: freebsd@intel.com
Speed and Duplex Configuration
This file describes the FreeBSD* driver for Intel Ethernet. This driver has been developed for use with all community-supported versions of FreeBSD.
For questions related to hardware requirements, refer to the documentation supplied with your Gigabit adapter. All hardware requirements listed apply for use with FreeBSD.
NOTE: This driver package is to be used only as a standalone archive and the user should not attempt to incorporate it into the kernel source tree. |
In the instructions below, x.x.x is the driver version as indicated in the name of the driver tar file.
Move the base driver tar file to the directory of your choice. For example, use /home/username/igb or /usr/local/src/igb.
Untar/unzip the archive:
tar xzvf igb-x.x.x.tar.gz
This will create an igb-x.x.x directory.
To create a loadable module, perform the following steps.
To compile the module
cd igb-x.x.x
make
To install the compiled module to the system
directory:
make install
If you want the driver to load automatically when the system is
booted:
1. Edit /boot/loader.conf, and add the following line.
if_igb_load="YES"
To assign an IP address to the interface, enter the following:
ifconfig_igb<interface_num> <IP_address>
Verify that the interface works. Enter the following, where <IP_address>
is the IP address for another machine on the same subnet as the interface
that is being tested:
ping <IP_address>
To configure the IP address to remain after reboot, edit
/etc/rc.conf, and create the appropriate ifconfig_igb<interface_num> entry:
ifconfig_igb<interface_num>="<ifconfig_settings>"
Example usage:
ifconfig_igb0="inet 102.168.10.1 netmask
255.255.255.0"
NOTE: For assistance, see the ifconfig man page. |
By default, the adapter auto-negotiates the speed and duplex of the connection. If there is a specific need, the ifconfig utility can be used to configure the speed and duplex settings on the adapter. Example usage:
ifconfig igbX <IP_address> media 100baseTX mediaopt full-duplex
NOTE: Only use mediaopt to set the driver to full-duplex. If mediaopt is not specified and you are not running at gigabit speed, the driver defaults to half-duplex. |
If the interface is currently forced to 100 full duplex, in order to change
to half duplex you must use this command:
ifconfig igbX <IP_address>
media 100baseTX -mediaopt full-duplex
This driver supports the following media type options:
Media Type | Description |
---|---|
autoselect | Enables auto-negotiation for speed and duplex. |
10baseT/UTP | Sets speed to 10 Mbps. Use the ifconfig mediaopt option to select full-duplex mode. |
100baseTX | Sets speed to 100 Mbps. Use the ifconfig mediaopt option to select full-duplex mode. |
1000baseTX | Sets speed to 1000 Mbps. In this case, the driver supports only full-duplex mode. |
1000baseSX | Sets speed to 1000 Mbps. In this case, the driver supports only full-duplex mode. |
For more information on the ifconfig utility, see the ifconfig man page.
The driver supports Transmit/Receive Checksum Offload and Jumbo Frames on all but the 82542-based adapters. For specific adapters, refer to the Identifying Your Adapter section.
To enable Jumbo Frames, use the ifconfig utility to set the Maximum Transmission Unit (MTU) size above its default of 1500 bytes.
The Jumbo Frames MTU range for Intel Adapters is 1500 to 9216. To modify the
setting, enter the following:
ifconfig igbX <hostname
or IP address> mtu 9000
To confirm the MTU used between two specific devices, use:
route get
<destination_IP_address>
NOTES:
|
To create a new VLAN interface:
ifconfig <vlan_name> create
To associate the VLAN interface with a physical interface and assign an IP address, netmask, and VLAN ID:
ifconfig <vlan_name> <ip_address> netmask <subnet_mask> vlan <vlan_id> vlandev <physical_interface>
Example:
ifconfig vlan10 10.0.0.1 netmask 255.255.255.0 vlan 10 vlandev igb0
In this example, all packets will be marked on egress with 802.1Q VLAN tags, specifying a VLAN ID of 10.
To remove a VLAN interface:
Intel Network Connection ifconfig <vlan_name> destroy
NOTES: Device Polling is only valid for non-SMP kernels. | |
The driver has to be built into the kernel for Device Polling to be enabled in the driver. |
To enable polling in the driver, add the following options to the kernel configuration, and then recompile the kernel:
options DEVICE_POLLING
options HZ=1000
At runtime:
use sysctl kern.polling.enable=1 to
turn polling on
use sysctl kern.polling.enable=0 to turn polling off
Checksum offloading is not supported on 82542 Gigabit adapters.
Checksum offloading supports both TCP and UDP packets and is supported for both transmit and receive.
Checksum offloading can be enabled or disabled using ifconfig. Both transmit and receive offloading will be either enabled or disabled together. You cannot enable/disable one without the other.
To enable checksum offloading:
ifconfig igbX rxcsum
To disable checksum offloading:
ifconfig igbX -rxcsum
To confirm the current setting:
ifconfig igbX
Look for the presence or absence of the following line:
options=3 <RXCSUM,TXCSUM>
The FreeBSD driver offers support for TSO (TCP Segmentation Offload). You can enable/disable it in two ways/places:
Doing this disables TSO in the stack and will affect all adapters.
To enable:
NOTES: By default only PCI-Express
adapters are ENABLED to do TSO. Others can be enabled by the user at their
own risk TSO is not supported on 82547 and 82544-based adapters, as well as older adapters. |
Large Receive Offload is available in the driver; it is on by default. It can be disabled by using:
ifconfig <interface_num> -lro
To enable:
ifconfig <interface_num> lro
Valid Range: 0-1
Default Value: 1 (enabled)
A link between two EEE-compliant devices will result in periodic bursts of data followed by long periods where in the link is in an idle state. This Low Power Idle (LPI) state is supported in both 1Gbps and 100Mbps link speeds.
NOTE: EEE support requires autonegotiation. |
Valid Range: 0-1
Default Value: 1 (enabled)
Enables or disables DMA Coalescing feature. DMA (Direct Memory Access) allows the network device to move packet data directly to the system's memory, reducing CPU utilitzation. However, the frequency and random intervals at which packets arrive do not allow the system to enter a lower power state. DMA Coalescing allows the adapter to collect packets before it initiates a DMA event. This may increase network latency but also increases the chances that the system will enter a lower power state.
Turning on DMA Coalescing may save energy with kernel 2.6.32 and later. InterruptThrottleRate (ITR) should be set to dynamic. This will impart the greatest chance for your system to consume less power. DMA Coalescing is effective in helping potentially saving the platform power only when it is enabled across all active ports.
A whitepaper containing information on how to best configure your platform is available on the Intel website.
In some cases ports 3 and 4 wont pass traffic. Ports 1 and 2 don't show any errors and will pass traffic.
This issue MAY be resolved by updating to the latest BIOS. You can check your system's BIOS by downloading the Linux Firmware Developer Kit that can be obtained at http://www.linuxfirmwarekit.org/
For general information and support, go to Support
If an issue is identified, support is through email only at: freebsd@intel.com
Last modified on 8/12/11 10:34a 5/05/05 8:51a