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