share/man/man4/iwm.4

   1 .\" Copyright (c) 2004-2006
   2 .\"     Damien Bergamini <damien.bergamini@free.fr>. 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 unmodified, this list of conditions, and the following
   9 .\"    disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd November 7, 2019
  29 .Dt IWM 4
  30 .Os
  31 .Sh NAME
  32 .Nm iwm
  33 .Nd Intel IEEE 802.11ac wireless network driver
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 include the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device iwm"
  40 .Cd "device pci"
  41 .Cd "device wlan"
  42 .Cd "device firmware"
  43 .Ed
  44 .Pp
  45 You also need to select a firmware for your device.
  46 Choose one from:
  47 .Bd -ragged -offset indent
  48 .Cd "device iwm3160fw"
  49 .Cd "device iwm3168fw"
  50 .Cd "device iwm7260fw"
  51 .Cd "device iwm7265fw"
  52 .Cd "device iwm8000Cfw"
  53 .Cd "device iwm8265fw"
  54 .Cd "device iwm9000fw"
  55 .Cd "device iwm9260fw"
  56 .Ed
  57 .Pp
  58 Or you can use
  59 .Bd -ragged -offset indent
  60 .Cd "device iwmfw"
  61 .Ed
  62 .Pp
  63 to include them all.
  64 .Pp
  65 Alternatively, to load the driver as a
  66 module at boot time, place the following lines in
  67 .Xr loader.conf 5 :
  68 .Bd -literal -offset indent
  69 if_iwm_load="YES"
  70 iwm3160fw_load="YES"
  71 iwm3168fw_load="YES"
  72 iwm7260fw_load="YES"
  73 iwm7265fw_load="YES"
  74 iwm8000Cfw_load="YES"
  75 iwm8265fw_load="YES"
  76 iwm9000fw_load="YES"
  77 iwm9260fw_load="YES"
  78 .Ed
  79 .Sh DESCRIPTION
  80 The
  81 .Nm
  82 driver provides support for:
  83 .Pp
  84 .Bl -tag -width Ds -offset indent -compact
  85 .It Intel Dual Band Wireless AC 3160
  86 .It Intel Dual Band Wireless AC 3165
  87 .It Intel Dual Band Wireless AC 3168
  88 .It Intel Dual Band Wireless AC 7260
  89 .It Intel Dual Band Wireless AC 7265
  90 .It Intel Dual Band Wireless AC 8260
  91 .It Intel Dual Band Wireless AC 9260
  92 .It Intel Dual Band Wireless AC 9270
  93 .It Intel Dual Band Wireless AC 946X
  94 .It Intel Dual Band Wireless AC 9560
  95 .El
  96 .Pp
  97 .Nm
  98 supports
  99 .Cm station
 100 mode operation.
 101 Only one virtual interface may be configured at any time.
 102 For more information on configuring this device, see
 103 .Xr ifconfig 8 .
 104 .Pp
 105 This driver requires the firmware built with the
 106 .Nm iwmfw
 107 module to work.
 108 .Sh EXAMPLES
 109 Join an existing BSS network (i.e., connect to an access point):
 110 .Bd -literal -offset indent
 111 ifconfig wlan create wlandev iwm0 inet 192.168.0.20 \e
 112     netmask 0xffffff00
 113 .Ed
 114 .Pp
 115 Join a specific BSS network with network name
 116 .Dq Li my_net :
 117 .Pp
 118 .Dl "ifconfig wlan create wlandev iwm0 ssid my_net up"
 119 .Pp
 120 Join a specific BSS network with 64-bit WEP encryption:
 121 .Bd -literal -offset indent
 122 ifconfig wlan create wlandev iwm0 ssid my_net \e
 123         wepmode on wepkey 0x1234567890 weptxkey 1 up
 124 .Ed
 125 .Pp
 126 Join a specific BSS network with 128-bit WEP encryption:
 127 .Bd -literal -offset indent
 128 ifconfig wlan create wlandev iwm0 wlanmode adhoc ssid my_net \e
 129     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 130 .Ed
 131 .Sh DIAGNOSTICS
 132 .Bl -diag
 133 .It "iwm%d: device timeout"
 134 The driver will reset the hardware.
 135 This should not happen.
 136 .It "iwm%d: firmware error"
 137 The onboard microcontroller crashed for some reason.
 138 The driver will reset the hardware.
 139 This should not happen.
 140 .It "iwm%d: timeout waiting for firmware initialization to complete"
 141 The onboard microcontroller failed to initialize in time.
 142 This should not happen.
 143 .It "iwm%d: could not load firmware image '%s'"
 144 The driver failed to load the firmware image using the
 145 .Xr firmware 9
 146 subsystem.
 147 Verify the
 148 .Xr iwmfw 4
 149 firmware module is present.
 150 .It "iwm%d: could not load boot firmware"
 151 An attempt to upload the boot firmware image to the onboard microcontroller
 152 failed.
 153 This should not happen.
 154 .It "iwm%d: could not load microcode"
 155 An attempt to upload the microcode image to the onboard microcontroller failed.
 156 This should not happen.
 157 .It "iwm%d: could not load main firmware"
 158 An attempt to upload the main firmware image to the onboard microcontroller
 159 failed.
 160 This should not happen.
 161 .El
 162 .Sh SEE ALSO
 163 .Xr iwmfw 4 ,
 164 .Xr pci 4 ,
 165 .Xr wlan 4 ,
 166 .Xr wlan_ccmp 4 ,
 167 .Xr wlan_tkip 4 ,
 168 .Xr wlan_wep 4 ,
 169 .Xr ifconfig 8 ,
 170 .Xr wpa_supplicant 8