xref: /freebsd/share/man/man4/rtwnfw.4 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1.\" Copyright (c) 2015 Kevin Lo
2.\" Copyright (c) 2016 Andriy Voskoboinyk
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. The name of the author may not be used to endorse or promote products
11.\"    derived from this software without specific prior written permission.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23.\"
24.Dd January 3, 2019
25.Dt RTWNFW 4
26.Os
27.Sh NAME
28.Nm rtwnfw
29.Nd "Firmware Module for Realtek Wireless driver"
30.Sh SYNOPSIS
31To compile this module into the kernel,
32place the following line in your
33kernel configuration file:
34.Bd -ragged -offset indent
35.Cd "device rtwnfw"
36.Ed
37.Pp
38This will include all firmware images inside the kernel.
39If you want to pick only the firmware image for your network adapter choose one
40of the following:
41.Bd -ragged -offset indent
42.Cd "device rtwn-rtl8188eefw"
43.Cd "device rtwn-rtl8188eufw"
44.Cd "device rtwn-rtl8192cfwE_B"
45.Cd "device rtwn-rtl8192cfwE"
46.Cd "device rtwn-rtl8192cfwT"
47.Cd "device rtwn-rtl8192cfwU"
48.Cd "device rtwn-rtl8192eufw"
49.Cd "device rtwn-rtl8812aufw"
50.Cd "device rtwn-rtl8821aufw"
51.Ed
52.Pp
53Alternatively, to load all firmware images as a
54module at boot time, place the following line in
55.Xr loader.conf 5 :
56.Bd -literal -offset indent
57rtwn-rtl8188eefw_load="YES"
58rtwn-rtl8188eufw_load="YES"
59rtwn-rtl8192cfwE_B_load="YES"
60rtwn-rtl8192cfwE_load="YES"
61rtwn-rtl8192cfwT_load="YES"
62rtwn-rtl8192cfwU_load="YES"
63rtwn-rtl8192eufw_load="YES"
64rtwn-rtl8812aufw_load="YES"
65rtwn-rtl8821aufw_load="YES"
66.Ed
67.Sh DESCRIPTION
68rtwn-rtl8192cfwE and rtl8192cfwE_B modules provide access
69to firmware sets for the Realtek RTL8188CE chip based PCIe adapters.
70rtwn-rtl8188ee module provides access to firmware sets for the
71Realtek RTL8188EE chip based PCIe adapters.
72Other modules provide access to firmware sets for the Realtek RTL8188CUS,
73RTL8188CE-VAU, RTL8188EUS, RTL8188RU, RTL8192CU, RTL8192EU, RTL8812AU and
74RTL8821AU chip based USB WiFi adapters.
75They may be
76statically linked into the kernel, or loaded as a modules.
77.Pp
78For the loaded firmware to be enabled for use the license at
79.Pa /usr/share/doc/legal/realtek.LICENSE
80must be agreed to by adding the following line to
81.Xr loader.conf 5 :
82.Pp
83.Dl "legal.realtek.license_ack=1"
84.Sh FILES
85.Bl -tag -width ".Pa /usr/share/doc/legal/realtek.LICENSE" -compact
86.It Pa /usr/share/doc/legal/realtek.LICENSE
87.Nm
88firmware license
89.El
90.Sh SEE ALSO
91.Xr rtwn 4 ,
92.Xr firmware 9
93