API tools faq
paste
Advertisement
Guest User

readme driver FC

a guest
Mar 22nd, 2014
128
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 13.84 KB | None | 0 0
raw download clone embed print report
  1. ########################################################################
  2. # Release notes for the BSD NIC driver for OneConnect CNA using SLI-4.
  3. ########################################################################
  4.  
  5. OCE Release: "806:2.0.1:145"
  6.  
  7. #
  8. #-
  9. # Copyright (C) 2013 Emulex
  10. # All rights reserved.
  11. #
  12. # Redistribution and use in source and binary forms, with or without
  13. # modification, are permitted provided that the following conditions are met:
  14. #
  15. # 1. Redistributions of source code must retain the above copyright notice,
  16. # this list of conditions and the following disclaimer.
  17. #
  18. # 2. Redistributions in binary form must reproduce the above copyright
  19. # notice, this list of conditions and the following disclaimer in the
  20. # documentation and/or other materials provided with the distribution.
  21. #
  22. # 3. Neither the name of the Emulex Corporation nor the names of its
  23. # contributors may be used to endorse or promote products derived from
  24. # this software without specific prior written permission.
  25. #
  26. # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  27. # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28. # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29. # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  30. # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  31. # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  32. # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  33. # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  34. # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35. # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  36. # POSSIBILITY OF SUCH DAMAGE.
  37. #
  38. # Contact Information:
  39. # [email protected]
  40. #
  41. # Emulex
  42. # 3333 Susan Street
  43. # Costa Mesa, CA 92626
  44. #
  45.  
  46. ########################################################################
  47. # Getting started
  48. ########################################################################
  49.  
  50. System requirements (recommended):
  51.  
  52. OS: FreeBSD 8.2
  53. Arch: AMD64
  54. PCI-X: MSI-x support
  55. CPU: Dual-core or better
  56.  
  57. This is a SOURCE release. Extract the files into a work directory on
  58. a BSD system capable of performing kernel builds.
  59.  
  60. Files in this release are as follows:
  61.  
  62. dev/oce/README
  63. dev/oce/loadit
  64. dev/oce/oce_buf.h
  65. dev/oce/oce_hw.c
  66. dev/oce/oce_hw.h
  67. dev/oce/oce_hw_eth.h
  68. dev/oce/oce_if.c
  69. dev/oce/oce_if.h
  70. dev/oce/oce_info.c
  71. dev/oce/oce_info.h
  72. dev/oce/oce_info_data.h
  73. dev/oce/oce_io.h
  74. dev/oce/oce_mbox.c
  75. dev/oce/oce_queue.c
  76. dev/oce/oce_rx.c
  77. dev/oce/oce_tx.c
  78. dev/oce/oce_util.c
  79. dev/oce/Makefile
  80. dev/oce/doc/Makefile
  81. dev/oce/doc/Config.doxy
  82. dev/oce/doc/Copyright
  83.  
  84.  
  85. ########################################################################
  86. # Driver Documentation
  87. ########################################################################
  88.  
  89. To build driver documentation, change directory to dev/oce/doc and type:
  90.  
  91. make
  92. firefox html/index.html
  93.  
  94. Note: Requires doxygen, graphviz, mscgen packages:
  95.  
  96. sudo pkg_add -r doxygen
  97. sudo pkg_add -r graphviz
  98. sudo pkg_add -r mscgen
  99.  
  100. If mscgen package not found then build and install it from source.
  101. Source for FreeBSD packages can be found here:
  102.  
  103. ftp://ftp.freebsd.org/pub/FreeBSD/ports/distfiles/
  104.  
  105. ########################################################################
  106. # Driver Build
  107. ########################################################################
  108.  
  109. To build the kernel module, change directory to dev/oce and type:
  110.  
  111. make oce.ko
  112.  
  113. This will build the oce.ko loadable kernel object module.
  114. This command must be exectued in the same directory as the
  115. oce.ko file, or the complete path to the oce.ko file must
  116. be provided instead of ./oce.ko.
  117.  
  118. ########################################################################
  119. # Driver Load/Unload
  120. ########################################################################
  121.  
  122.  
  123. To load the kernel module type:
  124.  
  125. sudo kldload ./oce.ko
  126.  
  127. To unload the kernel module type:
  128.  
  129. sudo kldunload oce
  130.  
  131. Or simply use the "dev/oce/loadit" script. See script for
  132. setting options.
  133.  
  134.  
  135. ########################################################################
  136. # Driver Statistics
  137. ########################################################################
  138.  
  139. To view device driver statistics simply type:
  140.  
  141. sysctl -a | grep oce
  142.  
  143. To view function call statistics simply type:
  144.  
  145. ifconfig
  146.  
  147. Note: OCE_TRACE_FUNC must be enabled (see 'loadit' script).
  148.  
  149.  
  150. ########################################################################
  151. # Driver Exercises
  152. ########################################################################
  153.  
  154. The ping, ttcp and netperf programs can be usefull for
  155. exercising adaptor interface traffic.
  156.  
  157. On the 1st host machine type:
  158.  
  159. ./loadit 1
  160.  
  161. Note: assigns 192.168.100.1 to oce0, 192.168.101.1 to oce1
  162.  
  163. On the 2nd host machine type:
  164.  
  165. ./loadit 2
  166.  
  167. Note: assigns 192.168.100.2 to oce0, 192.168.101.2 to oce1
  168.  
  169. For 'ping' on host1 type:
  170.  
  171. ping 192.168.100.2
  172. ping 192.168.101.2
  173.  
  174. For 'ping' on host2 type:
  175.  
  176. ping 192.168.100.1
  177. ping 192.168.101.1
  178.  
  179. For 'ttcp' RX on host1 type:
  180.  
  181. ttcp -r -s -n 54321
  182.  
  183. For 'ttcp' TX on host2 type:
  184.  
  185. ttcp -t -s -n 44444 192.168.100.1
  186.  
  187. For 'netperf' server on host1 type:
  188.  
  189. netserver -L 192.168.100.1,inet
  190.  
  191. For 'netperf' client on host2 type:
  192.  
  193. netperf -L 192.168.100.2,inet -H 192.168.100.1,inet
  194.  
  195.  
  196. ########################################################################
  197. # Driver Parameters
  198. ########################################################################
  199.  
  200. Kernel module parameters:
  201.  
  202. disable_msix:
  203. kenv name: hw.oce.disable_msix
  204. sysctl name: <NOT APPLICABLE>
  205. default: 0
  206. allowed values: 0, 1
  207.  
  208. 0 allows MSIx interrupts to be used, if available.
  209. 1 will cause the INTx interrupt to be used, even
  210. if MSIx is available.
  211.  
  212. This parameter is not available via sysctl.
  213.  
  214. max_rsp_handled:
  215. kenv name: hw.oce.max_rsp_handled
  216. sysctl name: dev.oceX.max_rsp_handled
  217. default: 512
  218. allowed values: 1 - 1024
  219.  
  220. The maximum number of receive frames that will be
  221. processed during a single receive frame interrupt.
  222.  
  223. enable_csum:
  224. kenv name: hw.oce.enable_csum
  225. sysctl name: <NOT APPLICABLE>
  226. default: 1
  227. allowd values: 0, 1
  228.  
  229. A setting of 1 will cause the driver to indicate
  230. to the network layers above that the adapter is capable
  231. of performing TCP, UDP, and IP checksum offload.
  232. A setting of 0 will disable this feature.
  233.  
  234. trace_enable:
  235. kenv name: hw.oce.trace_enable
  236. sysctl name: dev.oceX.trace_enable
  237. default: 0x00000001
  238. allowed values: 0-0xffffffff
  239.  
  240. Each bit corresponds to a trace flag. Each trace flag
  241. turns on a separate set of trace messages. Bit 0
  242. corresponds to ERROR, so it should always be enabled
  243. to show unexpeced errors. Trace messages are emitted
  244. to the console and the /var/log/messages file.
  245.  
  246. The different sets of trace messages are indicated below:
  247.  
  248. OCE_TRACE_ERROR 0x00000001
  249. OCE_TRACE_ENTRY_EXIT 0x00000002
  250. OCE_TRACE_IOCTL 0x00000004
  251. OCE_TRACE_MAILBOX 0x00000008
  252. OCE_TRACE_INIT 0x00000010
  253. OCE_TRACE_INTR 0x00000020
  254. OCE_TRACE_FAST_INTR 0x00000040
  255. OCE_TRACE_TX 0x00000080
  256. OCE_TRACE_RX 0x00000100
  257. OCE_TRACE_PCI 0x00000200
  258. OCE_TRACE_UNHANDLED 0x00000400
  259. OCE_TRACE_IF 0x00000800
  260. OCE_TRACE_RING_BUF 0x00001000
  261. OCE_TRACE_FUNC 0x00002000
  262. OCE_TRACE_STRUCT 0x00004000
  263. OCE_TRACE_STATS 0x00008000
  264. OCE_TRACE_HEXDUMPS 0x00010000
  265. OCE_TRACE_FLAGS 0x00020000
  266.  
  267. OCE_TRACE_NONE 0x00000000
  268. OCE_TRACE_ALL 0xFFFFFFFF
  269.  
  270. Note: see 'loadit' script for setting trace_enable parameters.
  271.  
  272.  
  273. ########################################################################
  274. # Driver Statistics Instrumentation
  275. ########################################################################
  276.  
  277. Accessing Statistics:
  278.  
  279. For FreeBSD the mechanism to access device driver adaptor
  280. statistics and instrumenation counters is the "sysctl"
  281. command:
  282.  
  283. For a list of all OCE device driver statistics type:
  284.  
  285. sysctl -a | grep oce
  286.  
  287. ########################################################################
  288. # Driver Supported Features
  289. ########################################################################
  290.  
  291. This is a "basic" target mode NIC driver release and therefore
  292. does not (as yet) include support for advanced EMULEX driver
  293. features such as SR-IOV, MR-IOV, QGroups, HDS and VMQ.
  294.  
  295. This driver spupports *both* the EMULEX BE3 (Tomcat) and
  296. EMULEX XE201 (Lancer) converged network adapters. Please
  297. contact EMULEX concerning availablity of updates to this driver.
  298.  
  299. The following table lists the current disposition of features
  300. for the EMULEX FreeBSD OneConnect 10Gb Ethernet (OCE) device
  301. driver for BE3 and Lacer adpaptors:
  302.  
  303. --------------------------------------------------------
  304. Features Support: Emulex FreeBSD OCE device driver.
  305. --------------------------------------------------------
  306.  
  307. OS FreeBSD 8.2
  308. Architecture AMD64
  309. --------------------- ---------------------------
  310. Feature Support
  311. --------------------- ---------------------------
  312. BE3/Tomcat Yes
  313. XE201/Lancer Yes
  314. Lancer A0-chip errata Yes
  315. 2-port Yes
  316. 4-port Planned
  317. Multicore Yes
  318. Multiprocessor Yes
  319. PCI-E Yes
  320. Statistics Yes
  321. Jumbo Packets Yes
  322. VLAN Yes
  323. Multicast Yes
  324. RSS Yes (4RQ/port, >4 planned)
  325. TSO/LSO Yes
  326. Software LRO Yes
  327. CSO Yes
  328. SR IOV Planned
  329. MR IOV Planned
  330. Bonding Yes
  331. PXE Yes
  332. MSI-x Yes (32/BE3, 1024/XE201)
  333. Debug Yes
  334. Diagnostics Planned
  335. Promiscuous-mode Yes
  336.  
  337.  
  338. ########################################################################
  339. # Driver Errata and workarounds:
  340. ########################################################################
  341.  
  342. The following lists known errata pertinate to this release of the
  343. BSD NIC driver for OneConnect BE3 and XE201 CNA's using SLI-4.
  344.  
  345.  
  346. 1) Disabling MSI-x is not supported.
  347.  
  348. 2) The FreeBSD "ifconfig" command includes capabilities
  349. or dynamically modifying and setting TSO offload and
  350. IP, UDP and TCP checksum offload. Dynamically modifing these
  351. options is not supported. The driver supports static (driver
  352. load tunable and sysctl CSO parameters.
  353.  
  354. 3) Device driver performance has not been optimized.
  355. Optimizations will be addressed in future releases.
  356.  
  357. Lancer A0 is the first generation chipset. Emulex has performed
  358. an engineering analysis of A0 chipset errata from the FreeBSD
  359. device driver perspective. The following outlines the results of
  360. the analysis as well and pending work planned for implementation.
  361.  
  362. 1) RQ entry starvation may cause port blocking resulting in
  363. dropping of packets/frames.
  364. -> Driver implements policy for dropping packets on stalled
  365. RX queues.
  366.  
  367. 2) MSI/MSI-X interrupt is received in the driver before related
  368. Event Queue entry.
  369. -> Implemented lost interrupt EQ workaround.
  370.  
  371. 3) IOC XE201 does not generate an interrupt until the coalesce
  372. count is reached.
  373.  
  374. 4) Zero-length BDEs may generate invalid DMA commands.
  375. -> Reasonable behavior, driver should avoid setting the
  376. length of valid DMA buffer data descriptors to zero
  377. (a non-nonsensical value).
  378.  
  379. 5) SLI Port issues DMA requests inappropriately.
  380. -> Driver implement DMA mappings release delay.
  381.  
  382. 6) NIC packets always drop with L3/L4 checksum errors.
  383. -> Driver implemented SLI-4 option default as no-L3/L4 error
  384. notification.
  385.  
  386. 7) Unnecessary padding added to 64B packets in some fields.
  387. -> Non-issue: not visible over link or to the driver.
  388.  
  389. 8) Short TCP IPv4 packets (<60 bytes) with TCP checksum
  390. offload transmitted with an incorrect TCP checksum.
  391. -> Workqueue packet length must reflect data, not padding
  392. for checksum to be correct.
  393.  
  394. 9) Receive packets must not have two (or more) VNTAGs.
  395. -> Normal behavior, driver statistics will note dropped packets.
  396.  
  397. 10) Hardware Large Receive Offload (LRO) is not supported.
  398. -> Implemented software LRO in the driver.
  399.  
  400. 12) Transmit restrictions in Ethernet packet headers.
  401. -> Driver implement Tx packet length tracking.
  402.  
  403. 13) Incorrect indication in CQE on TCP/IDP IPv4/IPv6 checksums.
  404. -> Driver implements recommended workaround given in errata.
  405.  
  406. 14) The IOC XE201 indicates incorrect number of fragments in
  407. the completion for an HDS packet.
  408. -> Driver implements recommended workaround given in errata.
  409.  
  410. 15) The IOC XE201 does not forward packets with L3/L4 illegal
  411. or truncated headers.
  412. -> Normal expected behavior, adaptor statistics do reflect
  413. dropped packets.
  414.  
  415. 16) The NIC driver may not be informed of truncated L4 payload.
  416. -> Normal expected behavior is L4 layer catches and correctly
  417. processes.
  418.  
  419. 17) Ethernet packets may be misprocessed if the L2 header
  420. contains too many tag bytes.
  421. -> Normal expected behavior for non-standard frames.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!