xref: /freebsd/share/man/man4/rtwnfw.4 (revision f7c32ed617858bcd22f8d1b03199099d50125721)
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.\" $FreeBSD$
25.\"
26.Dd January 3, 2019
27.Dt RTWNFW 4
28.Os
29.Sh NAME
30.Nm rtwnfw
31.Nd "Firmware Module for Realtek Wireless driver"
32.Sh SYNOPSIS
33To compile this module into the kernel,
34place the following line in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device rtwnfw"
38.Ed
39.Pp
40This will include all firmware images inside the kernel.
41If you want to pick only the firmware image for your network adapter choose one
42of the following:
43.Bd -ragged -offset indent
44.Cd "device rtwn-rtl8188eefw"
45.Cd "device rtwn-rtl8188eufw"
46.Cd "device rtwn-rtl8192cfwE_B"
47.Cd "device rtwn-rtl8192cfwE"
48.Cd "device rtwn-rtl8192cfwT"
49.Cd "device rtwn-rtl8192cfwU"
50.Cd "device rtwn-rtl8192eufw"
51.Cd "device rtwn-rtl8812aufw"
52.Cd "device rtwn-rtl8821aufw"
53.Ed
54.Pp
55Alternatively, to load all firmware images as a
56module at boot time, place the following line in
57.Xr loader.conf 5 :
58.Bd -literal -offset indent
59rtwn-rtl8188eefw_load="YES"
60rtwn-rtl8188eufw_load="YES"
61rtwn-rtl8192cfwE_B_load="YES"
62rtwn-rtl8192cfwE_load="YES"
63rtwn-rtl8192cfwT_load="YES"
64rtwn-rtl8192cfwU_load="YES"
65rtwn-rtl8192eufw_load="YES"
66rtwn-rtl8812aufw_load="YES"
67rtwn-rtl8821aufw_load="YES"
68.Ed
69.Sh DESCRIPTION
70rtwn-rtl8192cfwE and rtl8192cfwE_B modules provide access
71to firmware sets for the Realtek RTL8188CE chip based PCIe adapters.
72rtwn-rtl8188ee module provides access to firmware sets for the
73Realtek RTL8188EE chip based PCIe adapters.
74Other modules provide access to firmware sets for the Realtek RTL8188CUS,
75RTL8188CE-VAU, RTL8188EUS, RTL8188RU, RTL8192CU, RTL8192EU, RTL8812AU and
76RTL8821AU chip based USB WiFi adapters.
77They may be
78statically linked into the kernel, or loaded as a modules.
79.Pp
80For the loaded firmware to be enabled for use the license at
81.Pa /usr/share/doc/legal/realtek.LICENSE
82must be agreed to by adding the following line to
83.Xr loader.conf 5 :
84.Pp
85.Dl "legal.realtek.license_ack=1"
86.Sh FILES
87.Bl -tag -width ".Pa /usr/share/doc/legal/realtek.LICENSE" -compact
88.It Pa /usr/share/doc/legal/realtek.LICENSE
89.Nm
90firmware license
91.El
92.Sh SEE ALSO
93.Xr rtwn 4 ,
94.Xr firmware 9
95