xref: /freebsd/sys/dev/qlxgbe/README.txt (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
1# $FreeBSD$
2
3			README File
4		QLogic 8300 series Dual Port
510 Gigabit Ethernet & CNA Adapter Driver for FreeBSD 9.x/10.x
6
7		QLogic Corporation.
8		All rights reserved.
9
10
11Table of Contents
121. Package Contents
132. OS Support
143. Supported Features
154. Using the Driver
16   4.1 Installing the driver
17   4.2 Removing the driver
185. Driver Parameters
196. Additional Notes
207. Contacting Support
21
221. Package Contents
23 * Documentation
24   - README (this document) version:1.0
25   - Release Notes Version:1.0
26 * Driver (if_qlxgbe.ko)
27	- FreeBSD 9.x/10.x
28 * Firmware: pre-flashed on QLogic adapter;
29
302. OS Support
31
32The Qlogic 83xx 10Gigabit Ethernet/CNA driver is compatible with the
33following OS platforms:
34 * FreeBSD 9.x/10.x (64-bit) [Intel EM64T, AMD64]
35
363. Supported Features
3710Gigabit Ethernet NIC/CNA driver supports following features
38
39* Large Segment Offload over TCP IPV4
40* Large Segment Offload over TCP IPV6
41* Receive Side scaling
42* TCP over IPv4 checksum offload
43* UDP over IPv4 checksum offload
44* IPV4 checksum offload
45* TCP over IPv6 checksum offload
46* UDP over IPv6 checksum offload
47* Jumbo frames
48* VLAN Tag
49
50
514. Using the driver
52
53 4.1 Installing the driver
54
55   - copy the driver file (if_qlxgbe.ko) into some directory (say qla_driver)
56   - cd <to qla_driver>
57   - kldload -v ./if_qlxgbe.ko
58
59 4.2 Removing the driver
60
61  - kldunload if_qlxgbe
62
635. Parameters to set prior to installing the driver
64     Please run  "sysctl kern.ipc" and "sysctl net.inet.tcp" and see if these
65     values are already greater than shown below. Change only those which
66     are less than shown below.
67
68   - Add the following lines to /etc/sysctl.conf and reboot the machine prior
69     to installing the driver
70
71	kern.ipc.nmbjumbo9=2000000
72	kern.ipc.nmbclusters=1000000
73	net.inet.tcp.recvbuf_max=262144
74	net.inet.tcp.recvbuf_inc=16384
75	kern.ipc.maxsockbuf=2097152
76	net.inet.tcp.recvspace=131072
77	net.inet.tcp.sendbuf_max=262144
78	net.inet.tcp.sendspace=65536
79
80   - If you do not want to reboot the system please run the following commands
81
82	login or su to root
83
84	sysctl kern.ipc.nmbjumbo9=2000000
85	sysctl kern.ipc.nmbclusters=1000000
86	sysctl net.inet.tcp.recvbuf_max=262144
87	sysctl net.inet.tcp.recvbuf_inc=16384
88	sysctl kern.ipc.maxsockbuf=2097152
89	sysctl net.inet.tcp.recvspace=131072
90	sysctl net.inet.tcp.sendbuf_max=262144
91	sysctl net.inet.tcp.sendspace=65536
92
936. Compile options Makefile if building driver from sources
94	None
95
967. Contacting Support
97Please feel free to contact your QLogic approved reseller or QLogic
98Technical Support at any phase of integration for assistance. QLogic
99Technical Support can be reached by the following methods:
100Web:    http://support.qlogic.com
101E-mail: support@qlogic.com
102(c) Copyright 2013-14. All rights reserved worldwide. QLogic, the QLogic
103logo, and the Powered by QLogic logo are registered trademarks of
104QLogic Corporation. All other brand and product names are trademarks
105or registered trademarks of their respective owners.
106