diff options
Diffstat (limited to 'static/freebsd/man4/rtwn.4 3.html')
| -rw-r--r-- | static/freebsd/man4/rtwn.4 3.html | 239 |
1 files changed, 239 insertions, 0 deletions
diff --git a/static/freebsd/man4/rtwn.4 3.html b/static/freebsd/man4/rtwn.4 3.html new file mode 100644 index 00000000..089c2f0a --- /dev/null +++ b/static/freebsd/man4/rtwn.4 3.html @@ -0,0 +1,239 @@ +<table class="head"> + <tr> + <td class="head-ltitle">RTWN(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">RTWN(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">rtwn</code> — <span class="Nd">Realtek + IEEE 802.11n/ac wireless network driver</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp"><code class="Cd">options RTWN_DEBUG</code> + <br/> + <code class="Cd">options RTWN_WITHOUT_UCODE</code></p> +<p class="Pp">To compile this driver into the kernel, place the following lines + in your kernel configuration file:</p> +<div class="Bd Pp Bd-indent"><code class="Cd">device rtwn</code> +<br/> +<code class="Cd">device rtwnfw</code> +<br/> +<code class="Cd">device rtwn_usb</code> +<br/> +<code class="Cd">device rtwn_pci</code> +<br/> +<code class="Cd">device wlan</code> +<br/> +<code class="Cd">device firmware</code></div> +<p class="Pp">Alternatively, to load the driver as a module at boot time, place + following lines in <a class="Xr">loader.conf(5)</a>:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>if_rtwn_pci_load="YES" +if_rtwn_usb_load="YES"</pre> +</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">rtwn</code> driver provides support for + 802.11n/ac wireless network PHYs supplied by <a class="Xr">rtwn_pci(4)</a> + and <a class="Xr">rtwn_usb(4)</a>.</p> +<p class="Pp">The <code class="Nm">rtwn</code> driver supports + <code class="Cm">station</code>, <code class="Cm">adhoc</code>, + <code class="Cm">hostap</code> and <code class="Cm">monitor</code> mode + operation. There are no limitations for number of + <code class="Cm">monitor</code> mode virtual interfaces; in addition to any + other virtual interface one <code class="Cm">station</code> interface can be + added (Note: RTL8821AU supports two non-monitor mode interfaces at the same + time).</p> +<p class="Pp">All chips have hardware support for WEP, AES-CCM and TKIP + encryption.</p> +<p class="Pp">The <code class="Nm">rtwn</code> driver can be configured at + runtime with <a class="Xr">ifconfig(8)</a>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1> +<p class="Pp">The <code class="Nm">rtwn</code> driver supports USB and PCI + devices with the following chipsets:</p> +<p class="Pp"></p> +<ul class="Bl-bullet Bd-indent Bl-compact"> + <li>Realtek 802.11n wireless 8188e (RTL8188E)</li> + <li>Realtek 802.11n wireless 8192c (RTL8192C)</li> + <li>Realtek 802.11n wireless 8192e (RTL8192E)</li> + <li>Realtek 802.11ac wireless 8812a (RTL8812A)</li> + <li>Realtek 802.11ac wireless 8821a (RTL8821A)</li> +</ul> +<p class="Pp">For specific devices, see <a class="Xr">rtwn_pci(4)</a> and + <a class="Xr">rtwn_usb(4)</a>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> +<dl class="Bl-tag Bl-compact"> + <dt><span class="Pa">/usr/share/doc/legal/realtek.LICENSE</span></dt> + <dd><code class="Nm">rtwn</code> firmware license</dd> +</dl> +<p class="Pp">The driver (if not compiled with <code class="Cd">options + RTWN_WITHOUT_UCODE</code>) may use following firmware files, which are + loaded when an interface is brought up:</p> +<p class="Pp"></p> +<div class="Bd-indent"> +<dl class="Bl-tag Bl-compact"> + <dt><span class="Pa">/boot/kernel/rtwn-rtl8188eefw.ko</span></dt> + <dd style="width: auto;"> </dd> + <dt><span class="Pa">/boot/kernel/rtwn-rtl8188eufw.ko</span></dt> + <dd style="width: auto;"> </dd> + <dt><span class="Pa">/boot/kernel/rtwn-rtl8192cfwE_B.ko</span></dt> + <dd style="width: auto;"> </dd> + <dt><span class="Pa">/boot/kernel/rtwn-rtl8192cfwE.ko</span></dt> + <dd style="width: auto;"> </dd> + <dt><span class="Pa">/boot/kernel/rtwn-rtl8192cfwT.ko</span></dt> + <dd style="width: auto;"> </dd> + <dt><span class="Pa">/boot/kernel/rtwn-rtl8192cfwU.ko</span></dt> + <dd style="width: auto;"> </dd> + <dt><span class="Pa">/boot/kernel/rtwn-rtl8192eufw.ko</span></dt> + <dd style="width: auto;"> </dd> + <dt><span class="Pa">/boot/kernel/rtwn-rtl8812aufw.ko</span></dt> + <dd style="width: auto;"> </dd> + <dt><span class="Pa">/boot/kernel/rtwn-rtl8821aufw.ko</span></dt> + <dd style="width: auto;"> </dd> +</dl> +</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> +<p class="Pp">Join an existing BSS network (i.e., connect to an access + point):</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">ifconfig wlan create wlandev rtwn0 + inet 192.0.2.20/24</code></div> +<p class="Pp">Join a specific BSS network with network name + <var class="Ar">my_net</var>:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">ifconfig wlan create wlandev rtwn0 + ssid my_net up</code></div> +<p class="Pp">Join a specific BSS network with 64-bit WEP encryption:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ifconfig wlan create wlandev rtwn0 ssid my_net \ + wepmode on wepkey 0x1234567890 weptxkey 1 up</pre> +</div> +<p class="Pp">Create an IBSS network with 128-bit WEP encryption on the channel + 4:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ifconfig wlan create wlandev rtwn0 wlanmode adhoc ssid my_net \ + wepmode on wepkey 0x01020304050607080910111213 weptxkey 1 \ + channel 4</pre> +</div> +<p class="Pp">Join/create an 802.11b IBSS network with network name + <var class="Ar">my_net</var>:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ifconfig wlan0 create wlandev rtwn0 wlanmode adhoc +ifconfig wlan0 inet 192.0.2.20/24 ssid my_net mode 11b</pre> +</div> +<p class="Pp">Create a host-based access point:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>ifconfig wlan0 create wlandev rtwn0 wlanmode hostap +ifconfig wlan0 inet 192.0.2.20/24 ssid my_ap</pre> +</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="LOADER_TUNABLES"><a class="permalink" href="#LOADER_TUNABLES">LOADER + TUNABLES</a></h1> +<p class="Pp">Tunables can be set at the <a class="Xr">loader(8)</a> prompt + before booting the kernel or stored in <a class="Xr">loader.conf(5)</a>.</p> +<dl class="Bl-tag"> + <dt id="dev.rtwn._d.hwcrypto"><var class="Va">dev.rtwn.%d.hwcrypto</var></dt> + <dd>This tunable controls how key slots are assigned: + <p class="Pp">0 - disable h/w crypto support. Features that require access + to frame contents (e.g., TCP/UDP/IP Rx checksum validation) will not + work;</p> + <p class="Pp">1 - use h/w crypto support for pairwise keys only;</p> + <p class="Pp">2 - use h/w crypto support for all keys; may not work for + multi-vap configurations.</p> + <p class="Pp">By default it is set to 1.</p> + </dd> + <dt id="dev.rtwn._d.ratectl"><var class="Va">dev.rtwn.%d.ratectl</var></dt> + <dd>This tunable switches between rate control implementations: + <p class="Pp">0 - no rate control;</p> + <p class="Pp">1 - driver sends 'tx complete' reports to net80211; algorithm + is controlled via net80211;</p> + <p class="Pp">2 - firmware-based rate control.</p> + <p class="Pp">By default it is set to 1; however driver may choose another + algorithm in case if it is not implemented</p> + <p class="Pp">Currently selected algorithm is reported via + <var class="Va">dev.rtwn.%d.ratectl_selected</var> read-only OID.</p> + </dd> + <dt id="dev.rtwn._d.rx_buf_size"><var class="Va">dev.rtwn.%d.rx_buf_size</var></dt> + <dd>(USB only) Controls size of temporary Rx buffer; smaller buffer size may + increase number of interrupts.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h1> +<dl class="Bl-diag"> + <dt>rtwn%d: could not read efuse byte at address 0x%x</dt> + <dd></dd> + <dt>rtwn%d: %s: cannot read rom, error %d</dt> + <dd>There was an error while reading ROM; device attach will be aborted. This + should not happen.</dd> + <dt>rtwn%d: failed loadfirmware of file %s</dt> + <dd>For some reason, the driver was unable to read the microcode file from the + filesystem. The file might be missing or corrupted. The driver will + disable firmware-dependent features.</dd> + <dt>rtwn%d: wrong firmware size (%zu)</dt> + <dd></dd> + <dt>rtwn%d: %s: failed to upload firmware %s (error %d)</dt> + <dd></dd> + <dt>rtwn%d: timeout waiting for firmware readiness</dt> + <dd>Firmware upload failed; the file might be corrupted. The driver will + disable firmware-dependent features. This should not happen.</dd> + <dt>rtwn%d: device timeout</dt> + <dd>A frame dispatched to the hardware for transmission did not complete in + time. The driver will reset the hardware. This should not happen.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">intro(4)</a>, <a class="Xr">netintro(4)</a>, + <a class="Xr">rtwn_pci(4)</a>, <a class="Xr">rtwn_usb(4)</a>, + <a class="Xr">rtwnfw(4)</a>, <a class="Xr">wlan(4)</a>, + <a class="Xr">wlan_amrr(4)</a>, <a class="Xr">wlan_ccmp(4)</a>, + <a class="Xr">wlan_tkip(4)</a>, <a class="Xr">wlan_wep(4)</a>, + <a class="Xr">wlan_xauth(4)</a>, <a class="Xr">networking(7)</a>, + <a class="Xr">hostapd(8)</a>, <a class="Xr">ifconfig(8)</a>, + <a class="Xr">wpa_supplicant(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Cm">urtwn</code> driver first appeared in + <span class="Ux">OpenBSD 4.9</span> and <span class="Ux">FreeBSD + 10.0</span>; the <code class="Nm">rtwn</code> driver first appeared in + <span class="Ux">OpenBSD 5.8</span> and <span class="Ux">FreeBSD + 11.0</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp">The <code class="Nm">rtwn</code> driver was initially written by + <span class="An">Stefan Sperling</span> + <<a class="Mt" href="mailto:stsp@openbsd.org">stsp@openbsd.org</a>> + and ported by <span class="An">Kevin Lo</span> + <<a class="Mt" href="mailto:kevlo@freebsd.org">kevlo@freebsd.org</a>>. + It was based on the <code class="Cm">urtwn</code> driver written by + <span class="An">Damien Bergamini</span> + <<a class="Mt" href="mailto:damien.bergamini@free.fr">damien.bergamini@free.fr</a>>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1> +<p class="Pp">The <code class="Nm">rtwn</code> driver currently does not + implement firmware-based rate control.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">November 10, 2024</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |