xref: /freebsd/share/man/man4/rtwnfw.4 (revision 2600131bd63b70eb0523a0cbfb034a92dddde963)
1*2600131bSAdrian Chadd.\" Copyright (c) 2015 Kevin Lo
2*2600131bSAdrian Chadd.\" All rights reserved.
3*2600131bSAdrian Chadd.\"
4*2600131bSAdrian Chadd.\" Redistribution and use in source and binary forms, with or without
5*2600131bSAdrian Chadd.\" modification, are permitted provided that the following conditions
6*2600131bSAdrian Chadd.\" are met:
7*2600131bSAdrian Chadd.\" 1. Redistributions of source code must retain the above copyright
8*2600131bSAdrian Chadd.\"    notice, this list of conditions and the following disclaimer.
9*2600131bSAdrian Chadd.\" 2. The name of the author may not be used to endorse or promote products
10*2600131bSAdrian Chadd.\"    derived from this software without specific prior written permission.
11*2600131bSAdrian Chadd.\"
12*2600131bSAdrian Chadd.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
13*2600131bSAdrian Chadd.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
14*2600131bSAdrian Chadd.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
15*2600131bSAdrian Chadd.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
16*2600131bSAdrian Chadd.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
17*2600131bSAdrian Chadd.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
18*2600131bSAdrian Chadd.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
19*2600131bSAdrian Chadd.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20*2600131bSAdrian Chadd.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
21*2600131bSAdrian Chadd.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22*2600131bSAdrian Chadd.\"
23*2600131bSAdrian Chadd.\" $FreeBSD$
24*2600131bSAdrian Chadd.\"
25*2600131bSAdrian Chadd.Dd October 28, 2015
26*2600131bSAdrian Chadd.Dt RTWNFW 4
27*2600131bSAdrian Chadd.Os
28*2600131bSAdrian Chadd.Sh NAME
29*2600131bSAdrian Chadd.Nm rtwnfw
30*2600131bSAdrian Chadd.Nd "Firmware Module for Realtek Wireless driver"
31*2600131bSAdrian Chadd.Sh SYNOPSIS
32*2600131bSAdrian ChaddTo compile this module into the kernel,
33*2600131bSAdrian Chaddplace the following line in your
34*2600131bSAdrian Chaddkernel configuration file:
35*2600131bSAdrian Chadd.Bd -ragged -offset indent
36*2600131bSAdrian Chadd.Cd "device rtwnfw"
37*2600131bSAdrian Chadd.Ed
38*2600131bSAdrian Chadd.Pp
39*2600131bSAdrian ChaddThis will include three firmware images inside the kernel.
40*2600131bSAdrian ChaddIf you want to pick only the firmware image for your network adapter choose one
41*2600131bSAdrian Chaddof the following:
42*2600131bSAdrian Chadd.Bd -ragged -offset indent
43*2600131bSAdrian Chadd.Cd "device rtwn-rtl8192cfwU"
44*2600131bSAdrian Chadd.Cd "device rtwn-rtl8192cfwU_B"
45*2600131bSAdrian Chadd.Ed
46*2600131bSAdrian Chadd.Pp
47*2600131bSAdrian ChaddAlternatively, to load the driver as a
48*2600131bSAdrian Chaddmodule at boot time, place the following line in
49*2600131bSAdrian Chadd.Xr loader.conf 5 :
50*2600131bSAdrian Chadd.Bd -literal -offset indent
51*2600131bSAdrian Chaddrtwn-rtl8192cfwU_load="YES"
52*2600131bSAdrian Chaddrtwn-rtl8192cfwU_B_load="YES"
53*2600131bSAdrian Chadd.Ed
54*2600131bSAdrian Chadd.Sh DESCRIPTION
55*2600131bSAdrian ChaddThis module provides access to firmware sets for the
56*2600131bSAdrian ChaddRealtek RTL8188CE chip based PCIe adapters.
57*2600131bSAdrian ChaddIt may be
58*2600131bSAdrian Chaddstatically linked into the kernel, or loaded as a module.
59*2600131bSAdrian Chadd.Pp
60*2600131bSAdrian ChaddFor the loaded firmware to be enabled for use the license at
61*2600131bSAdrian Chadd.Pa /usr/share/doc/legal/realtek.LICENSE
62*2600131bSAdrian Chaddmust be agreed to by adding the following line to
63*2600131bSAdrian Chadd.Xr loader.conf 5 :
64*2600131bSAdrian Chadd.Pp
65*2600131bSAdrian Chadd.Dl "legal.realtek.license_ack=1"
66*2600131bSAdrian Chadd.Sh FILES
67*2600131bSAdrian Chadd.Bl -tag -width ".Pa /usr/share/doc/legal/realtek.LICENSE" -compact
68*2600131bSAdrian Chadd.It Pa /usr/share/doc/legal/realtek.LICENSE
69*2600131bSAdrian Chadd.Nm
70*2600131bSAdrian Chaddfirmware license
71*2600131bSAdrian Chadd.El
72*2600131bSAdrian Chadd.Sh SEE ALSO
73*2600131bSAdrian Chadd.Xr rtwn 4 ,
74*2600131bSAdrian Chadd.Xr firmware 9
75