xref: /freebsd/share/man/man4/rtwnfw.4 (revision 7453645f2a9411a3f9d982b768bcc323f41cf906)
12600131bSAdrian Chadd.\" Copyright (c) 2015 Kevin Lo
2*7453645fSAndriy Voskoboinyk.\" Copyright (c) 2016 Andriy Voskoboinyk
32600131bSAdrian Chadd.\" All rights reserved.
42600131bSAdrian Chadd.\"
52600131bSAdrian Chadd.\" Redistribution and use in source and binary forms, with or without
62600131bSAdrian Chadd.\" modification, are permitted provided that the following conditions
72600131bSAdrian Chadd.\" are met:
82600131bSAdrian Chadd.\" 1. Redistributions of source code must retain the above copyright
92600131bSAdrian Chadd.\"    notice, this list of conditions and the following disclaimer.
102600131bSAdrian Chadd.\" 2. The name of the author may not be used to endorse or promote products
112600131bSAdrian Chadd.\"    derived from this software without specific prior written permission.
122600131bSAdrian Chadd.\"
132600131bSAdrian Chadd.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
142600131bSAdrian Chadd.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
152600131bSAdrian Chadd.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
162600131bSAdrian Chadd.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
172600131bSAdrian Chadd.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
182600131bSAdrian Chadd.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
192600131bSAdrian Chadd.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
202600131bSAdrian Chadd.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
212600131bSAdrian Chadd.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
222600131bSAdrian Chadd.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
232600131bSAdrian Chadd.\"
242600131bSAdrian Chadd.\" $FreeBSD$
252600131bSAdrian Chadd.\"
262600131bSAdrian Chadd.Dd October 28, 2015
272600131bSAdrian Chadd.Dt RTWNFW 4
282600131bSAdrian Chadd.Os
292600131bSAdrian Chadd.Sh NAME
302600131bSAdrian Chadd.Nm rtwnfw
312600131bSAdrian Chadd.Nd "Firmware Module for Realtek Wireless driver"
322600131bSAdrian Chadd.Sh SYNOPSIS
332600131bSAdrian ChaddTo compile this module into the kernel,
342600131bSAdrian Chaddplace the following line in your
352600131bSAdrian Chaddkernel configuration file:
362600131bSAdrian Chadd.Bd -ragged -offset indent
372600131bSAdrian Chadd.Cd "device rtwnfw"
382600131bSAdrian Chadd.Ed
392600131bSAdrian Chadd.Pp
40*7453645fSAndriy VoskoboinykThis will include all firmware images inside the kernel.
412600131bSAdrian ChaddIf you want to pick only the firmware image for your network adapter choose one
422600131bSAdrian Chaddof the following:
432600131bSAdrian Chadd.Bd -ragged -offset indent
44*7453645fSAndriy Voskoboinyk.Cd "device rtwn-rtl8188eufw"
45*7453645fSAndriy Voskoboinyk.Cd "device rtwn-rtl8192cfwE_B"
46*7453645fSAndriy Voskoboinyk.Cd "device rtwn-rtl8192cfwE"
47*7453645fSAndriy Voskoboinyk.Cd "device rtwn-rtl8192cfwT"
482600131bSAdrian Chadd.Cd "device rtwn-rtl8192cfwU"
49*7453645fSAndriy Voskoboinyk.Cd "device rtwn-rtl8812aufw"
50*7453645fSAndriy Voskoboinyk.Cd "device rtwn-rtl8821aufw"
512600131bSAdrian Chadd.Ed
522600131bSAdrian Chadd.Pp
53*7453645fSAndriy VoskoboinykAlternatively, to load all firmware images as a
542600131bSAdrian Chaddmodule at boot time, place the following line in
552600131bSAdrian Chadd.Xr loader.conf 5 :
562600131bSAdrian Chadd.Bd -literal -offset indent
57*7453645fSAndriy Voskoboinykrtwn-rtl8188eufw_load="YES"
58*7453645fSAndriy Voskoboinykrtwn-rtl8192cfwE_B_load="YES"
59*7453645fSAndriy Voskoboinykrtwn-rtl8192cfwE_load="YES"
60*7453645fSAndriy Voskoboinykrtwn-rtl8192cfwT_load="YES"
612600131bSAdrian Chaddrtwn-rtl8192cfwU_load="YES"
62*7453645fSAndriy Voskoboinykrtwn-rtl8812aufw_load="YES"
63*7453645fSAndriy Voskoboinykrtwn-rtl8821aufw_load="YES"
642600131bSAdrian Chadd.Ed
652600131bSAdrian Chadd.Sh DESCRIPTION
66*7453645fSAndriy Voskoboinykrtwn-rtl8192cfwE and rtl8192cfwE_B modules provide access
67*7453645fSAndriy Voskoboinykto firmware sets for the Realtek RTL8188CE chip based PCIe adapters.
68*7453645fSAndriy VoskoboinykOther modules provide access to firmware sets for the Realtek RTL8188CUS,
69*7453645fSAndriy VoskoboinykRTL8188CE-VAU, RTL8188EUS, RTL8188RU, RTL8192CU, RTL8812AU and RTL8821AU
70*7453645fSAndriy Voskoboinykchip based USB WiFi adapters.
71*7453645fSAndriy VoskoboinykThey may be
72*7453645fSAndriy Voskoboinykstatically linked into the kernel, or loaded as a modules.
732600131bSAdrian Chadd.Pp
742600131bSAdrian ChaddFor the loaded firmware to be enabled for use the license at
752600131bSAdrian Chadd.Pa /usr/share/doc/legal/realtek.LICENSE
762600131bSAdrian Chaddmust be agreed to by adding the following line to
772600131bSAdrian Chadd.Xr loader.conf 5 :
782600131bSAdrian Chadd.Pp
792600131bSAdrian Chadd.Dl "legal.realtek.license_ack=1"
802600131bSAdrian Chadd.Sh FILES
812600131bSAdrian Chadd.Bl -tag -width ".Pa /usr/share/doc/legal/realtek.LICENSE" -compact
822600131bSAdrian Chadd.It Pa /usr/share/doc/legal/realtek.LICENSE
832600131bSAdrian Chadd.Nm
842600131bSAdrian Chaddfirmware license
852600131bSAdrian Chadd.El
862600131bSAdrian Chadd.Sh SEE ALSO
872600131bSAdrian Chadd.Xr rtwn 4 ,
882600131bSAdrian Chadd.Xr firmware 9
89