atl1(7) - Linux man page

Name

atl1 -This file describes the Linux* Base Driver for the Atheros(R) L1 Gigabit Ethernet Adapters.

Synopsis

modprobe atl1 [<option>=<VAL1>,<VAL2>,...]
insmod atl1 [<option>=<VAL1>,<VAL2>,...]

Description

This driver is intended for 2.4.x and 2.6.x kernels. This driver includes support for Itanium(R)2-based systems.

This driver is only supported as a loadable module at this time. Atheros is not supplying patches against the kernel source to allow for static linking of the driver. For questions related to hardware requirements, refer to the documentation supplied with your Atttansic L1 adapter. All hardware requirements listed apply to use with Linux.

Options

The following optional parameters are used by entering them on the command line with the modprobe or insmod command. For example, with two L1 PCIE adapters, entering:

modprobe atl1 TxDescriptors=80,128
loads the atl1 driver with 80 TX descriptors for the first adapter and 128 TX descriptors for the second adapter.

IntModTimer

Valid Range: 50-65000

Default Value: 100

represents the minmum interval between interrupts controller generated.

RxDescriptors
Valid Range: 128-2047
Default Value:
512

number of receive descriptors allocated by the driver. Increasing this value allows the driver to buffer more incoming packets. Each descriptor is 28 bytes. A receive buffer is also allocated for each descriptor depending on the MTU setting.

NOTE: MTU designates the frame size. It only needs to be set for Jumbo Frames.

MediaType
Valid Settings: 0(auto-negotiate at all supported speeds), 1(only link at 100Mbps Full Duplex), 2(only link at 100Mbps Half Duplex), 3(only link at 10Mbps Full Duplex), 4(only link at 10Mbps Half Duplex)
Default Value:
0 (auto-negotiate at all supported speeds)

forces the line speed to the specified value in megabits per second (Mbps). If this parameter is not specified or is set to 0 and the link partner is set to auto-negotiate, the board auto-detects the correct speed.

TxDescriptors
Valid Range: 64-1023
Default Value:
256

number of transmit descriptors allocated by the driver. Increasing this value allows the driver to queue more transmits. Each descriptor is 16 bytes.

NOTE: Depending on the available system resources, the request for a higher number of transmit descriptors may be denied. In this case, use a lower number.

FlashVendor

Valid Range: 0(Atmel), 1(SST), 2(ST)
Default Value:
0

vendor of spi flash used by the ethernet Adapter.

Jumbo Frames

Jumbo Frames support is enabled by changing the MTU to a value larger than the default of 1500. Use the ifconfig command to increase the MTU size. For example:

ifconfig ethx mtu 3000 up
NOTE: Jumbo Frames are supported at 1000 Mbps only. Using Jumbo Frames at 10 or 100 Mbps may result in poor performance or loss of link.

Ethtool

The driver utilizes the ethtool interface for driver configuration and diagnostics, as well as displaying statistical information. Ethtool version 1.8.1 or later is required for this functionality.

The latest release of ethtool can be found from http://sf.net/projects/gkernel. The driver then must be recompiled in order to take advantage of the latest ethtool features.

Ethtool 1.6 only supports a limited set of ethtool options. Support for a more complete ethtool feature set can be enabled by upgrading ethtool to ethtool-1.8.1.

Support

For additional information, including supported adapters, building, and installation, see the Readme file included with the driver.

For general information, go to the Atheros support website at:

http://support.atheros.com
If an issue is identified with the released source code on the supported kernel with a supported adapter, email the specific information related to the issue to xiong.huang@atheros.com.