Sync usage with man page.

[netbsd-mini2440.git] / external / intel-fw-public / ipw3945 / dist / README.iwlwifi-3945-ucode

Intel PRO/Wireless 3945ABG/BG Network Connection Adapter\r
Copyright (C) 2006 - 2007 Intel Corporation.  All rights reserved.\r
\r
Microcode Package README.iwlwifi-3945-ucode\r
\r
INDEX\r
\r
1. OVERVIEW\r
2. INSTALLATION\r
3. LICENSE\r
\r
\r
1. OVERVIEW\r
\r
The file iwlwifi-3945.ucode provided in this package is required to be \r
present on your system in order for the Intel PRO/Wireless 3945ABG/BG Network\r
Connection Adapter driver for Linux (iwlwifi-3945) to be able to operate\r
on your system.\r
\r
On adapter initialization, and at varying times during the uptime of \r
the adapter, the microcode is loaded into the RAM on the network \r
adapter.  The microcode provides the low level MAC features including \r
radio control and high precision timing events (backoff, transmit, \r
etc.) while also providing varying levels of packet filtering which can \r
be used to keep the host from having to handle packets that are not of \r
interest given the current operating mode of the device.\r
\r
2. INSTALLATION\r
\r
The iwlwifi-3945 driver will look for the file iwlwifi-3945.ucode using the \r
kernel's firmware_loader infrastructure.  In order to function \r
correctly, you need to have this support enabled in your kernel.  When \r
you configure the kernel, you can find this option in the following \r
location:\r
\r
        Device Drivers ->\r
                Generic Driver Options ->\r
                        Hotplug firmware loading support\r
\r
\r
You can determine if your kernel currently has firmware loader support \r
by looking for the CONFIG_FW_LOADER definition on your kernel's \r
.config.\r
\r
In addition to having the firmware_loader support in your kernel, you \r
must also have a working hotplug and udev infrastructure configured.  \r
The steps for installing and configuring hotplug and udev are very \r
distribution specific. \r
\r
Once you have the firmware loader in place (or if you aren't sure and \r
you just want to try things to see if it works), you need to install \r
the microcode file into the appropriate location.\r
\r
Where that appropriate location is depends (again) on your system \r
distribution.  You can typically find this location by looking in the \r
hotplug configuration file for your distro:\r
\r
        % grep \"^FIRMWARE_DIR\" /etc/hotplug/firmware.agent\r
\r
This should give you output like:\r
\r
        FIRMWARE_DIR=/lib/firmware\r
\r
If it lists more than one directory, you only need to put the \r
microcode in one of them.  In the above example, installation is \r
simply:\r
\r
        % cp iwlwifi-3945.ucode /lib/firmware\r
\r
You can now load the driver (see the INSTALL and \r
README.iwlwifi-3945 provided with the iwlwifi-3945 package for \r
information on building and using that driver.)\r
\r
3. LICENSE\r
\r
The microcode in this package (iwlwifi-3945.ucode) is provided under the \r
terms of the following license (available in the file \r
LICENSE.iwlwifi-3945-ucode):\r
\r
Copyright (c) 2006 - 2007, Intel Corporation.\r
All rights reserved.\r
\r
Redistribution.  Redistribution and use in binary form, without \r
modification, are permitted provided that the following conditions are \r
met:\r
\r
* Redistributions must reproduce the above copyright notice and the \r
  following disclaimer in the documentation and/or other materials \r
  provided with the distribution. \r
* Neither the name of Intel Corporation nor the names of its suppliers \r
  may be used to endorse or promote products derived from this software \r
  without specific prior written permission. \r
* No reverse engineering, decompilation, or disassembly of this software \r
  is permitted.\r
\r
Limited patent license.  Intel Corporation grants a world-wide, \r
royalty-free, non-exclusive license under patents it now or hereafter \r
owns or controls to make, have made, use, import, offer to sell and \r
sell ("Utilize") this software, but solely to the extent that any \r
such patent is necessary to Utilize the software alone, or in \r
combination with an operating system licensed under an approved Open \r
Source license as listed by the Open Source Initiative at \r
http://opensource.org/licenses.  The patent license shall not apply to \r
any other combinations which include this software.  No hardware per \r
se is licensed hereunder.\r
\r
DISCLAIMER.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND \r
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, \r
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND \r
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \r
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, \r
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS \r
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND \r
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR \r
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE \r
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH \r
DAMAGE.\r
\r
------------------------------\r
Copyright (C) 2005 - 2007, Intel Corporation\r
\r
INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.  \r
EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, \r
INTEL ASSUMES NO LIABILITY WHATSOEVER, AND INTEL DISCLAIMS ANY EXPRESS OR \r
IMPLIED WARRANTY RELATING TO SALE AND/OR USE OF INTEL PRODUCTS, INCLUDING \r
LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, \r
MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT, OR OTHER \r
INTELLECTUAL PROPERTY RIGHT. \r
\r
This document is subject to change without notice. \r
\r
* Other names and brands may be claimed as the property of others.\r