xref: /freebsd/sys/dev/qlxgbe/README.txt (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
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
65   - Add the following lines to /etc/sysctl.conf and reboot the machine prior
66     to installing the driver
67
68	kern.ipc.nmbjumbo9=262144
69	net.inet.tcp.recvbuf_max=262144
70	net.inet.tcp.recvbuf_inc=16384
71	kern.ipc.nmbclusters=1000000
72	kern.ipc.maxsockbuf=2097152
73	net.inet.tcp.recvspace=131072
74	net.inet.tcp.sendbuf_max=262144
75	net.inet.tcp.sendspace=65536
76
77   - If you do not want to reboot the system please run the following commands
78
79	login or su to root
80
81	sysctl kern.ipc.nmbjumbo9=262144
82	sysctl net.inet.tcp.recvbuf_max=262144
83	sysctl net.inet.tcp.recvbuf_inc=16384
84	sysctl kern.ipc.nmbclusters=1000000
85	sysctl kern.ipc.maxsockbuf=2097152
86	sysctl net.inet.tcp.recvspace=131072
87	sysctl net.inet.tcp.sendbuf_max=262144
88	sysctl net.inet.tcp.sendspace=65536
89
906. Compile options Makefile if building driver from sources
91	None
92
937. Contacting Support
94Please feel free to contact your QLogic approved reseller or QLogic
95Technical Support at any phase of integration for assistance. QLogic
96Technical Support can be reached by the following methods:
97Web:    http://support.qlogic.com
98E-mail: support@qlogic.com
99(c) Copyright 2013-14. All rights reserved worldwide. QLogic, the QLogic
100logo, and the Powered by QLogic logo are registered trademarks of
101QLogic Corporation. All other brand and product names are trademarks
102or registered trademarks of their respective owners.
103