Differences between revisions 1 and 35 (spanning 34 versions)
Revision 1 as of 2005-01-11 11:21:45
Size: 361
Editor: anonymous
Comment:
Revision 35 as of 2009-02-11 06:46:22
Size: 11443
Editor: GeoffSimmons
Comment: Mention alternate NDISwrapper uses; 16-bit PCMCIA devices are unsupported.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## Auto-converted by kwiki2moinmoin v2005-10-07
["WiFi"]
#language en
||<tablestyle="width: 100%;" style="border: 0px hidden">~-[:DebianWiki/EditorGuide#translation:Translation(s)]: none-~||<style="text-align: right;border: 0px hidden"> (!) [:/Discussion:Discussion]||
Line 4: Line 4:
Some vendors do not release specifications of the hardware or provide a linux driver for their wireless network cards. This project provides a linux kernel module that loads and runs Ndis (Windows network driver API) drivers supplied by the vendors. = NDISwrapper =
This page describes how to install NDISwrapper on Debian systems.
[[TableOfContents(3)]]
== Introduction ==
Some vendors do not release hardware specifications and do not provide a Linux driver for their devices.
Line 6: Line 10:
The [http://ndiswrapper.sourceforge.net/ NDISwrapper] project provides a Linux kernel module that loads and runs Windows kernel API and NDIS ([wiki:WikiPedia:Network_Driver_Interface_Specification Network Driver Interface Specification]) API drivers supplied by the vendors within the Linux kernel. A Windows driver is then linked to this implementation so that the driver runs natively, as though it is in Windows, without binary emulation.
Line 7: Line 12:
See : NDISwrapper uses Windows XP driver files - which may have been supplied with your hardware - to operate your device. This driver wrapper is ''only'' available for use on the x86 and x86-64 architectures (Debian ["i386"] and [:DebianAMD64:AMD64] ports respectively).
Line 9: Line 14:
 * http://ndiswrapper.sourceforge.net/ While NDISwrapper is intended for use with ["WiFi"] devices, it may alternatively be used for other hardware classes, such as Ethernet adapters or USB-to-serial converters. This page assumes use of a wireless LAN device.

<!> 16-bit PC Card (PCMCIA) devices are not supported. WikiPedia:Cardbus devices are supported.

== Module Installation ==
=== Debian Packages ===
## Note: m-a will download 'ndiswrapper-source' and install the relevant 'ndiswrapper-utils-*' package (during apt's installation of 'ndiswrapper-modules-*', to fulfil package dependencies). You don't need to explicitly install these packages prior to invoking m-a a-i!
 1. Install the DebPkg:module-assistant and DebPkg:wireless-tools packages: {{{
aptitude install module-assistant wireless-tools
}}}
 1. Build and install a ndiswrapper-modules-* package for your system: {{{
m-a prepare
m-a a-i ndiswrapper
}}}
 1. Add {{{ndiswrapper}}} to the list of kernel modules to load at boot: {{{
echo ndiswrapper >> /etc/modules
}}}
 1. Insert the NDISwrapper module into the kernel: {{{
modprobe ndiswrapper
}}}
More information on building the NDISwrapper kernel module is described within {{{/usr/share/doc/ndiswrapper-source/README.Debian}}}.

Once the module is loaded, [#ndis_driver install a NDIS driver] and [#configure configure your wireless interface].

=== From Source ===
<!> The following procedure is only necessary for [:DebianEtch:Etch] systems which require a version of NDISwrapper greater than 1.28.

 1. Install necessary development packages, along with DebPkg:wireless-tools: {{{
aptitude install build-essential linux-headers-$(uname -r) wireless-tools
}}}
 1. Download and compile the NDISwrapper [http://sourceforge.net/project/showfiles.php?group_id=93482 source code].
 For example, to acquire and build NDISwrapper version 1.53: {{{
wget http://superb-east.dl.sourceforge.net/sourceforge/ndiswrapper/ndiswrapper-1.53.tar.gz
tar xvf ndiswrapper-1.53.tar.gz
cd ndiswrapper-1.53
make
su
make install
}}}
 1. Add {{{ndiswrapper}}} to the list of kernel modules to load at boot: {{{
echo ndiswrapper >> /etc/modules
}}}
 1. Insert the NDISwrapper module into the kernel: {{{
modprobe ndiswrapper
}}}

Once the module is loaded, [#ndis_driver install a NDIS driver] and [#configure configure your wireless interface].

[[Anchor(ndis_driver)]]
== NDIS Driver ==
{i} '''Windows XP''' drivers are required to be used. NDISwrapper does not support [wiki:WikiPedia:Network_Driver_Interface_Specification NDIS] 6 (Windows Vista) at this time.

You are required to provide the appropriate driver for your device. The first place you should check is the [http://ndiswrapper.sourceforge.net/joomla/index.php?/component/option,com_openwiki/Itemid,33/id,list/ NDISwrapper compatibility list] ([http://burnthesorbonne.com/?page_id=32 mirror]). It lists many models of wireless devices that are usable with NDISwrapper and the driver that works best.

If you can't find it there, the [http://www.linuxant.com/driverloader/drivers.php Linuxant Windows Driver] page has many drivers that work with NDISwrapper. It also has drivers for some 64-bit devices that don't offer native 64-bit drivers on the manufacturer's web page.

The final place you should examine is your driver CD or the manufacturer's web page. These often work, but sometimes they're broken or don't offer you full functionality. It's best to go with the ones listed on the NDISwrapper web page.

The driver you find may be packaged as a ZIP (.zip) archive or in the [wiki:WikiPedia:Portable_Executable Portable Executable] (.exe) format. The .exe file may just be a ZIP archive, you can run the {{{unzip}}} de-archiver (provided by the DebPkg:unzip package) to extract its contents.

Other .exe files may be !InstallShield installers or other installer formats. These require the use of utilities such as DebPkg:unshield or DebPkg:orange to extract the contents within.

If your drivers are within the [wiki:WikiPedia:Cabinet_(file_format) cabinet file format] (.cab), install DebPkg:cabextract and run {{{cabextract}}} on a file of interest, typically named {{{data2.cab}}}.

=== Installation ===
<!> The following procedure is specific to the "Dell Wireless Card 1390" (man: 14e4, dev: 4311) device and is provided as an '''example only'''. Consult the [http://ndiswrapper.sourceforge.net/joomla/index.php?/component/option,com_openwiki/Itemid,33/id,list/ NDISwrapper compatibility list] ([http://burnthesorbonne.com/?page_id=32 mirror]) for information on your specific device.

 1. Install the DebPkg:unzip package: {{{
aptitude install unzip
}}}
 1. Acquire an archive containing the NDIS driver from Dell's FTP site: {{{
wget http://ftp.us.dell.com/network/R151517.EXE
}}}
 1. Extract its contents: {{{
unzip -a R151517.EXE
}}}
 1. Install the NDIS driver: {{{
ndiswrapper -i DRIVER/bcmwl5.inf
}}}
 1. To verify NDIS driver installation, list the currently installed drivers: {{{
ndiswrapper -l
}}} You should receive the following output: {{{
bcmwl5 : driver installed
        device (14E4:4311) present
}}}

Refer to the NDISwrapper manual page for more information:
  * Debian Lenny/5.0: [http://manpages.debian.net/cgi-bin/man.cgi?query=ndiswrapper-1.9&apropos=0&sektion=8&manpath=Debian+Sid&format=html&locale=en ndiswrapper-1.9(8)]
  * Debian Etch/4.0: [http://manpages.debian.net/cgi-bin/man.cgi?query=ndiswrapper-1.9&apropos=0&sektion=8&manpath=Debian+4.0+etch&format=html&locale=en ndiswrapper-1.9(8)]
  * Debian Sarge/3.1: [http://manpages.debian.net/cgi-bin/man.cgi?query=ndiswrapper&apropos=0&sektion=8&manpath=Debian+3.1+sarge&format=html&locale=en ndiswrapper(8)]

You can alternatively use DebPkg:ndisgtk to install drivers to the system.

=== Uninstallation ===
To remove a previously installed NDIS driver from your system: {{{
ndiswrapper -e <driver>
}}}
For example: {{{
ndiswrapper -e bcmwl5
}}}

You can alternatively use DebPkg:ndisgtk to uninstall drivers from the system.

[[Anchor(configure)]]
== Configuration ==
 1. Verify your device has an available interface: {{{
iwconfig
}}}
 If your interface is not present, physically remove and insert the device, then run {{{iwconfig}}} again.

 1. Raise the interface to activate the radio, for example: {{{
ifconfig wlan0 up
}}}
 1. [:WiFi/HowToUse:Configure] your wireless interface as appropriate.

=== Insert / Hotplug ===
## Commented due to ndiswrapper being specified in /etc/modules at module installation time -- GeoffSimmons
##According to a !DebianEtch entry on the NDISwrapper wiki, an 'allow-hotplug wlan0' entry in /etc/network/interfaces is about all it takes to get the card to be automatically configured and brought up when inserted (beyond the required steps to configure the card for manually bringing the interface up.)
##
##http://ndiswrapper.sourceforge.net/mediawiki/index.php/InstallDebianEtch
##
##On Sarge this does not appear to be the case. Adding that line does not make hotplug 'just work'. This is most likely due to the lack of an entry for NDISwrapper in /lib/modules/<kernel version>/modules.pcimap. According to the hotplug overview when new hardware is detected the MODULE_DEVICE_TABLE map is consulted to determine which module is responsible for the device. Without that entry or some other help hotplug will not 'just work' for the device.
##
##The easiest workaround is to require the NDISwrapper module at boot so that it is always loaded and ready to claim the hardware. Just add it to the list in /etc/modules.
##
##The most difficult workaround (for many) may be to edit the NDISwrapper source and recompile so that it will make MODULE_DEVICE_TABLE entries for your hardware.
##
##http://www.linuxquestions.org/questions/showthread.php?t=360483 http://sourceforge.net/mailarchive/message.php?msg_id=6713442
##
##An inbetween workaround may be to modify /etc/hotplug/pci.agent to parse an /etc/hotplug/pci.handmap and have it include the hardware details necessary to load ndiswrapper when your card is inserted, like you can do with usb.handmap. This step and the re-coding are probably best left to the developers which leaves us with /etc/modules.
##
There seems to be a couple different ways documented to enable hotplugging on interfaces. Mentioned in the !DebianEtch page on the NDISwrapper wiki is the line allow-hotplug wlan0. The man page for the interfaces file confirms that this is the intended way to enable hotplug. In /etc/hotplug/net.agent, you are directed to include mapping hotplug stanzas in /etc/network/interfaces.

On a Debian 3.1 / Dell Inspiron 1200 system the allow-hotplug entry did not seem to be necessary. The map stanza seemed to be enough, once NDISwrapper was already loaded. YMMV.

== See Also ==
 * DebPkg:ndisgtk - A graphical frontend for ndiswrapper (available since Lenny).
 * DebPkg:cabextract - a program to extract Microsoft Cabinet files
 * DebPkg:orange - extracts CAB files from self-extracting installers
 * DebPkg:unshield - extracts CAB files from !InstallShield installers
 * [:WiFi/HowToUse:How to use a WiFi interface]

== External Links ==
 * [http://ndiswrapper.sourceforge.net/ NDISwrapper homepage];
  * [http://ndiswrapper.sourceforge.net/joomla/index.php?/component/option,com_openwiki/Itemid,33/id,list/ NDISwrapper compatibility list]
  * [http://burnthesorbonne.com/?page_id=32 NDISwrapper compatibility list] (Burn the Sorbonne mirror)
  * [http://ndiswrapper.sourceforge.net/joomla/index.php?/component/option,com_openwiki/Itemid,33/ Wiki]
  * irc://irc.freenode.net/#ndiswrapper - ["IRC"] channel

 * NDISwrapper manual pages:
  * Debian Lenny/5.0: [http://manpages.debian.net/cgi-bin/man.cgi?query=ndiswrapper-1.9&apropos=0&sektion=8&manpath=Debian+Sid&format=html&locale=en ndiswrapper-1.9(8)]
  * Debian Etch/4.0: [http://manpages.debian.net/cgi-bin/man.cgi?query=ndiswrapper-1.9&apropos=0&sektion=8&manpath=Debian+4.0+etch&format=html&locale=en ndiswrapper-1.9(8)]
  * Debian Sarge/3.1: [http://manpages.debian.net/cgi-bin/man.cgi?query=ndiswrapper&apropos=0&sektion=8&manpath=Debian+3.1+sarge&format=html&locale=en ndiswrapper(8)]

----
CategoryHardware | CategoryWireless

[:DebianWiki/EditorGuide#translation:Translation(s)]: none

(!) [:/Discussion:Discussion]


NDISwrapper

This page describes how to install NDISwrapper on Debian systems. ?TableOfContents(3)

Introduction

Some vendors do not release hardware specifications and do not provide a Linux driver for their devices.

The [http://ndiswrapper.sourceforge.net/ NDISwrapper] project provides a Linux kernel module that loads and runs Windows kernel API and NDIS ([wiki:Network_Driver_Interface_Specification Network Driver Interface Specification]) API drivers supplied by the vendors within the Linux kernel. A Windows driver is then linked to this implementation so that the driver runs natively, as though it is in Windows, without binary emulation.

NDISwrapper uses Windows XP driver files - which may have been supplied with your hardware - to operate your device. This driver wrapper is only available for use on the x86 and x86-64 architectures (Debian ["i386"] and [:DebianAMD64:AMD64] ports respectively).

While NDISwrapper is intended for use with ["WiFi"] devices, it may alternatively be used for other hardware classes, such as Ethernet adapters or USB-to-serial converters. This page assumes use of a wireless LAN device.

<!> 16-bit PC Card (PCMCIA) devices are not supported. Cardbus devices are supported.

Module Installation

Debian Packages

  1. Install the module-assistant and wireless-tools packages:

    aptitude install module-assistant wireless-tools
  2. Build and install a ndiswrapper-modules-* package for your system:

    m-a prepare
    m-a a-i ndiswrapper
  3. Add ndiswrapper to the list of kernel modules to load at boot:

    echo ndiswrapper >> /etc/modules
  4. Insert the NDISwrapper module into the kernel:

    modprobe ndiswrapper

More information on building the NDISwrapper kernel module is described within /usr/share/doc/ndiswrapper-source/README.Debian.

Once the module is loaded, [#ndis_driver install a NDIS driver] and [#configure configure your wireless interface].

From Source

<!> The following procedure is only necessary for [:DebianEtch:Etch] systems which require a version of NDISwrapper greater than 1.28.

  1. Install necessary development packages, along with wireless-tools:

    aptitude install build-essential linux-headers-$(uname -r) wireless-tools
  2. Download and compile the NDISwrapper [http://sourceforge.net/project/showfiles.php?group_id=93482 source code]. For example, to acquire and build NDISwrapper version 1.53:

    wget http://superb-east.dl.sourceforge.net/sourceforge/ndiswrapper/ndiswrapper-1.53.tar.gz
    tar xvf ndiswrapper-1.53.tar.gz
    cd ndiswrapper-1.53
    make
    su
    make install
  3. Add ndiswrapper to the list of kernel modules to load at boot:

    echo ndiswrapper >> /etc/modules
  4. Insert the NDISwrapper module into the kernel:

    modprobe ndiswrapper

Once the module is loaded, [#ndis_driver install a NDIS driver] and [#configure configure your wireless interface].

?Anchor(ndis_driver)

NDIS Driver

{i} Windows XP drivers are required to be used. NDISwrapper does not support [wiki:Network_Driver_Interface_Specification NDIS] 6 (Windows Vista) at this time.

You are required to provide the appropriate driver for your device. The first place you should check is the [http://ndiswrapper.sourceforge.net/joomla/index.php?/component/option,com_openwiki/Itemid,33/id,list/ NDISwrapper compatibility list] ([http://burnthesorbonne.com/?page_id=32 mirror]). It lists many models of wireless devices that are usable with NDISwrapper and the driver that works best.

If you can't find it there, the [http://www.linuxant.com/driverloader/drivers.php Linuxant Windows Driver] page has many drivers that work with NDISwrapper. It also has drivers for some 64-bit devices that don't offer native 64-bit drivers on the manufacturer's web page.

The final place you should examine is your driver CD or the manufacturer's web page. These often work, but sometimes they're broken or don't offer you full functionality. It's best to go with the ones listed on the NDISwrapper web page.

The driver you find may be packaged as a ZIP (.zip) archive or in the [wiki:Portable_Executable Portable Executable] (.exe) format. The .exe file may just be a ZIP archive, you can run the unzip de-archiver (provided by the unzip package) to extract its contents.

Other .exe files may be InstallShield installers or other installer formats. These require the use of utilities such as unshield or orange to extract the contents within.

If your drivers are within the [wiki:Cabinet_(file_format) cabinet file format] (.cab), install cabextract and run cabextract on a file of interest, typically named data2.cab.

Installation

<!> The following procedure is specific to the "Dell Wireless Card 1390" (man: 14e4, dev: 4311) device and is provided as an example only. Consult the [http://ndiswrapper.sourceforge.net/joomla/index.php?/component/option,com_openwiki/Itemid,33/id,list/ NDISwrapper compatibility list] ([http://burnthesorbonne.com/?page_id=32 mirror]) for information on your specific device.

  1. Install the unzip package:

    aptitude install unzip
  2. Acquire an archive containing the NDIS driver from Dell's FTP site:

    wget http://ftp.us.dell.com/network/R151517.EXE
  3. Extract its contents:

    unzip -a R151517.EXE
  4. Install the NDIS driver:

    ndiswrapper -i DRIVER/bcmwl5.inf
  5. To verify NDIS driver installation, list the currently installed drivers:

    ndiswrapper -l

    You should receive the following output:

    bcmwl5 : driver installed
            device (14E4:4311) present

Refer to the NDISwrapper manual page for more information:

You can alternatively use ndisgtk to install drivers to the system.

Uninstallation

To remove a previously installed NDIS driver from your system:

ndiswrapper -e <driver>

For example:

ndiswrapper -e bcmwl5

You can alternatively use ndisgtk to uninstall drivers from the system.

?Anchor(configure)

Configuration

  1. Verify your device has an available interface:

    iwconfig

    If your interface is not present, physically remove and insert the device, then run iwconfig again.

  2. Raise the interface to activate the radio, for example:

    ifconfig wlan0 up
  3. [:WiFi/HowToUse:Configure] your wireless interface as appropriate.

Insert / Hotplug

There seems to be a couple different ways documented to enable hotplugging on interfaces. Mentioned in the DebianEtch page on the NDISwrapper wiki is the line allow-hotplug wlan0. The man page for the interfaces file confirms that this is the intended way to enable hotplug. In /etc/hotplug/net.agent, you are directed to include mapping hotplug stanzas in /etc/network/interfaces.

On a Debian 3.1 / Dell Inspiron 1200 system the allow-hotplug entry did not seem to be necessary. The map stanza seemed to be enough, once NDISwrapper was already loaded. YMMV.

See Also

  • ndisgtk - A graphical frontend for ndiswrapper (available since Lenny).

  • cabextract - a program to extract Microsoft Cabinet files

  • orange - extracts CAB files from self-extracting installers

  • unshield - extracts CAB files from InstallShield installers

  • [:WiFi/HowToUse:How to use a WiFi interface]


CategoryHardware | CategoryWireless