kernel/usb4bsd: Sync urtwn(4) with current FreeBSD.
[dragonfly.git] / share / man / man4 / urtwnfw.4
1 .\"
2 .\" Copyright (c) 2013 Kevin Lo
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: head/share/man/man4/urtwnfw.4 264912 2014-04-25 08:01:22Z kevlo $
25 .\"
26 .Dd July 30, 2014
27 .Dt URTWNFW 4
28 .Os
29 .Sh NAME
30 .Nm urtwnfw
31 .Nd "Firmware Module for Realtek Wireless driver"
32 .Sh SYNOPSIS
33 To compile this module into the kernel,
34 place the following line in your
35 kernel configuration file:
36 .Bd -ragged -offset indent
37 .Cd "device urtwnfw"
38 .Ed
39 .\".Pp
40 .\"This will include three firmware images inside the kernel.
41 .\"If you want to pick only the firmware image for your network adapter choose one
42 .\"of the following:
43 .\".Bd -ragged -offset indent
44 .\".Cd "device urtwn-rtl8192cfwT"
45 .\".Cd "device urtwn-rtl8192cfwU"
46 .\".Cd "device urtwn-rtl8188eufw"
47 .\".Ed
48 .Pp
49 Alternatively, to load the driver as a
50 module at boot time, place the following line in
51 .Xr loader.conf 5 :
52 .Bd -literal -offset indent
53 urtwn-rtl8192cfwT_load="YES"
54 urtwn-rtl8192cfwU_load="YES"
55 urtwn-rtl8188eufw_load="YES"
56 .Ed
57 .Sh DESCRIPTION
58 This module provides access to firmware sets for the
59 Realtek RTL8188CUS, RTL8188CE-VAU, RTL8188EUS, RTL8188RU and RTL8192CU
60 chip based USB WiFi adapters.
61 It may be
62 statically linked into the kernel, or loaded as a module.
63 .Pp
64 For the loaded firmware to be enabled for use the license at
65 .Pa /usr/share/doc/legal/realtek/LICENSE
66 must be agreed to by adding the following line to
67 .Xr loader.conf 5 :
68 .Pp
69 .Dl "legal.realtek.license_ack=1"
70 .Sh FILES
71 .Bl -tag -width ".Pa /usr/share/doc/legal/realtek/LICENSE" -compact
72 .It Pa /usr/share/doc/legal/realtek/LICENSE
73 .Nm
74 firmware license
75 .El
76 .Sh SEE ALSO
77 .Xr urtwn 4 ,
78 .Xr firmware 9