Docs/Kconfig: Update: osdl.org -> linuxfoundation.org
[linux-2.6.git] / Documentation / networking / vxge.txt
1 Neterion's (Formerly S2io) X3100 Series 10GbE PCIe Server Adapter Linux driver
2 ==============================================================================
3
4 Contents
5 --------
6
7 1) Introduction
8 2) Features supported
9 3) Configurable driver parameters
10 4) Troubleshooting
11
12 1) Introduction:
13 ----------------
14 This Linux driver supports all Neterion's X3100 series 10 GbE PCIe I/O
15 Virtualized Server adapters.
16 The X3100 series supports four modes of operation, configurable via
17 firmware -
18         Single function mode
19         Multi function mode
20         SRIOV mode
21         MRIOV mode
22 The functions share a 10GbE link and the pci-e bus, but hardly anything else
23 inside the ASIC. Features like independent hw reset, statistics, bandwidth/
24 priority allocation and guarantees, GRO, TSO, interrupt moderation etc are
25 supported independently on each function.
26
27 (See below for a complete list of features supported for both IPv4 and IPv6)
28
29 2) Features supported:
30 ----------------------
31
32 i)   Single function mode (up to 17 queues)
33
34 ii)  Multi function mode (up to 17 functions)
35
36 iii) PCI-SIG's I/O Virtualization
37        - Single Root mode: v1.0 (up to 17 functions)
38        - Multi-Root mode: v1.0 (up to 17 functions)
39
40 iv)  Jumbo frames
41        X3100 Series supports MTU up to 9600 bytes, modifiable using
42        ifconfig command.
43
44 v)   Offloads supported: (Enabled by default)
45        Checksum offload (TCP/UDP/IP) on transmit and receive paths
46        TCP Segmentation Offload (TSO) on transmit path
47        Generic Receive Offload (GRO) on receive path
48
49 vi)  MSI-X: (Enabled by default)
50        Resulting in noticeable performance improvement (up to 7% on certain
51        platforms).
52
53 vii) NAPI: (Enabled by default)
54        For better Rx interrupt moderation.
55
56 viii)RTH (Receive Traffic Hash): (Enabled by default)
57        Receive side steering for better scaling.
58
59 ix)  Statistics
60        Comprehensive MAC-level and software statistics displayed using
61        "ethtool -S" option.
62
63 x)   Multiple hardware queues: (Enabled by default)
64        Up to 17 hardware based transmit and receive data channels, with
65        multiple steering options (transmit multiqueue enabled by default).
66
67 3) Configurable driver parameters:
68 ----------------------------------
69
70 i)  max_config_dev
71        Specifies maximum device functions to be enabled.
72        Valid range: 1-8
73
74 ii) max_config_port
75        Specifies number of ports to be enabled.
76        Valid range: 1,2
77        Default: 1
78
79 iii)max_config_vpath
80        Specifies maximum VPATH(s) configured for each device function.
81        Valid range: 1-17
82
83 iv) vlan_tag_strip
84        Enables/disables vlan tag stripping from all received tagged frames that
85        are not replicated at the internal L2 switch.
86        Valid range: 0,1 (disabled, enabled respectively)
87        Default: 1
88
89 v)  addr_learn_en
90        Enable learning the mac address of the guest OS interface in
91        virtualization environment.
92        Valid range: 0,1 (disabled, enabled respectively)
93        Default: 0
94
95 4) Troubleshooting:
96 -------------------
97
98 To resolve an issue with the source code or X3100 series adapter, please collect
99 the statistics, register dumps using ethool, relevant logs and email them to
100 support@neterion.com.