s2io.txt 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  1. Release notes for Neterion's (Formerly S2io) Xframe I/II PCI-X 10GbE driver.
  2. Contents
  3. =======
  4. - 1. Introduction
  5. - 2. Identifying the adapter/interface
  6. - 3. Features supported
  7. - 4. Command line parameters
  8. - 5. Performance suggestions
  9. - 6. Available Downloads
  10. 1. Introduction:
  11. This Linux driver supports Neterion's Xframe I PCI-X 1.0 and
  12. Xframe II PCI-X 2.0 adapters. It supports several features
  13. such as jumbo frames, MSI/MSI-X, checksum offloads, TSO, UFO and so on.
  14. See below for complete list of features.
  15. All features are supported for both IPv4 and IPv6.
  16. 2. Identifying the adapter/interface:
  17. a. Insert the adapter(s) in your system.
  18. b. Build and load driver
  19. # insmod s2io.ko
  20. c. View log messages
  21. # dmesg | tail -40
  22. You will see messages similar to:
  23. eth3: Neterion Xframe I 10GbE adapter (rev 3), Version 2.0.9.1, Intr type INTA
  24. eth4: Neterion Xframe II 10GbE adapter (rev 2), Version 2.0.9.1, Intr type INTA
  25. eth4: Device is on 64 bit 133MHz PCIX(M1) bus
  26. The above messages identify the adapter type(Xframe I/II), adapter revision,
  27. driver version, interface name(eth3, eth4), Interrupt type(INTA, MSI, MSI-X).
  28. In case of Xframe II, the PCI/PCI-X bus width and frequency are displayed
  29. as well.
  30. To associate an interface with a physical adapter use "ethtool -p <ethX>".
  31. The corresponding adapter's LED will blink multiple times.
  32. 3. Features supported:
  33. a. Jumbo frames. Xframe I/II supports MTU upto 9600 bytes,
  34. modifiable using ifconfig command.
  35. b. Offloads. Supports checksum offload(TCP/UDP/IP) on transmit
  36. and receive, TSO.
  37. c. Multi-buffer receive mode. Scattering of packet across multiple
  38. buffers. Currently driver supports 2-buffer mode which yields
  39. significant performance improvement on certain platforms(SGI Altix,
  40. IBM xSeries).
  41. d. MSI/MSI-X. Can be enabled on platforms which support this feature
  42. (IA64, Xeon) resulting in noticeable performance improvement(upto 7%
  43. on certain platforms).
  44. e. NAPI. Compile-time option(CONFIG_S2IO_NAPI) for better Rx interrupt
  45. moderation.
  46. f. Statistics. Comprehensive MAC-level and software statistics displayed
  47. using "ethtool -S" option.
  48. g. Multi-FIFO/Ring. Supports up to 8 transmit queues and receive rings,
  49. with multiple steering options.
  50. 4. Command line parameters
  51. a. tx_fifo_num
  52. Number of transmit queues
  53. Valid range: 1-8
  54. Default: 1
  55. b. rx_ring_num
  56. Number of receive rings
  57. Valid range: 1-8
  58. Default: 1
  59. c. tx_fifo_len
  60. Size of each transmit queue
  61. Valid range: Total length of all queues should not exceed 8192
  62. Default: 4096
  63. d. rx_ring_sz
  64. Size of each receive ring(in 4K blocks)
  65. Valid range: Limited by memory on system
  66. Default: 30
  67. e. intr_type
  68. Specifies interrupt type. Possible values 1(INTA), 2(MSI), 3(MSI-X)
  69. Valid range: 1-3
  70. Default: 1
  71. 5. Performance suggestions
  72. General:
  73. a. Set MTU to maximum(9000 for switch setup, 9600 in back-to-back configuration)
  74. b. Set TCP windows size to optimal value.
  75. For instance, for MTU=1500 a value of 210K has been observed to result in
  76. good performance.
  77. # sysctl -w net.ipv4.tcp_rmem="210000 210000 210000"
  78. # sysctl -w net.ipv4.tcp_wmem="210000 210000 210000"
  79. For MTU=9000, TCP window size of 10 MB is recommended.
  80. # sysctl -w net.ipv4.tcp_rmem="10000000 10000000 10000000"
  81. # sysctl -w net.ipv4.tcp_wmem="10000000 10000000 10000000"
  82. Transmit performance:
  83. a. By default, the driver respects BIOS settings for PCI bus parameters.
  84. However, you may want to experiment with PCI bus parameters
  85. max-split-transactions(MOST) and MMRBC (use setpci command).
  86. A MOST value of 2 has been found optimal for Opterons and 3 for Itanium.
  87. It could be different for your hardware.
  88. Set MMRBC to 4K**.
  89. For example you can set
  90. For opteron
  91. #setpci -d 17d5:* 62=1d
  92. For Itanium
  93. #setpci -d 17d5:* 62=3d
  94. For detailed description of the PCI registers, please see Xframe User Guide.
  95. b. Ensure Transmit Checksum offload is enabled. Use ethtool to set/verify this
  96. parameter.
  97. c. Turn on TSO(using "ethtool -K")
  98. # ethtool -K <ethX> tso on
  99. Receive performance:
  100. a. By default, the driver respects BIOS settings for PCI bus parameters.
  101. However, you may want to set PCI latency timer to 248.
  102. #setpci -d 17d5:* LATENCY_TIMER=f8
  103. For detailed description of the PCI registers, please see Xframe User Guide.
  104. b. Use 2-buffer mode. This results in large performance boost on
  105. certain platforms(eg. SGI Altix, IBM xSeries).
  106. c. Ensure Receive Checksum offload is enabled. Use "ethtool -K ethX" command to
  107. set/verify this option.
  108. d. Enable NAPI feature(in kernel configuration Device Drivers ---> Network
  109. device support ---> Ethernet (10000 Mbit) ---> S2IO 10Gbe Xframe NIC) to
  110. bring down CPU utilization.
  111. ** For AMD opteron platforms with 8131 chipset, MMRBC=1 and MOST=1 are
  112. recommended as safe parameters.
  113. For more information, please review the AMD8131 errata at
  114. http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/26310.pdf
  115. 6. Available Downloads
  116. Neterion "s2io" driver in Red Hat and Suse 2.6-based distributions is kept up
  117. to date, also the latest "s2io" code (including support for 2.4 kernels) is
  118. available via "Support" link on the Neterion site: http://www.neterion.com.
  119. For Xframe User Guide (Programming manual), visit ftp site ns1.s2io.com,
  120. user: linuxdocs password: HALdocs
  121. 7. Support
  122. For further support please contact either your 10GbE Xframe NIC vendor (IBM,
  123. HP, SGI etc.) or click on the "Support" link on the Neterion site:
  124. http://www.neterion.com.