2 .\" Bill Paul <wpaul@windriver.com>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by Bill Paul.
15 .\" 4. Neither the name of the author nor the names of any co-contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29 .\" THE POSSIBILITY OF SUCH DAMAGE.
31 .\" $FreeBSD: src/share/man/man4/man4.i386/ndis.4,v 1.9 2004/12/21 01:09:34 brueffer Exp $
32 .\" $DragonFly: src/share/man/man4/man4.i386/ndis.4,v 1.6 2008/07/26 16:25:41 swildner Exp $
39 .Nd NDIS miniport driver wrapper
41 .\".Cd "options NDISAPI"
47 driver is a wrapper designed to allow binary
50 network drivers to be used with
54 driver is provided in source code form and must be combined with
57 driver supplied with your network adapter.
62 kernel subsystem to relocate and link the
65 that it can be used in conjunction with native code.
68 subsystem provides an interface between the NDIS API and the
70 networking infrastructure.
74 fooled into thinking it is running on
79 driver is only useful on x86 machines.
81 To build a functional driver, the user must have a copy of the
82 driver distribution media for his or her card.
83 From this distribution,
84 the user must extract two files: the
86 file containing the driver
87 binary code, and its companion
89 file, which contains the
90 definitions for driver-specific registry keys and other installation
91 data such as device identifiers.
92 These two files can be converted
94 .Pa ndis_driver_data.h
98 This file contains a binary image of the driver plus
102 driver loads, it will create
104 nodes for each registry key extracted from the
110 driver is designed to support mainly Ethernet and wireless
111 network devices with PCI and PCMCIA bus attachments.
113 devices are also supported as a subset of PCI.)
115 support many different media types and speeds.
117 however, is that there is no consistent way to learn if an
118 Ethernet device is operating in full or half duplex mode.
119 The NDIS API allows for a generic means for determining link
120 state and speed, but not the duplex setting.
122 driver-specific registry keys to control the media setting
123 which can be configured via the
133 .It "ndis%d: watchdog timeout"
134 A packet was queued for transmission and a transmit command was
135 issued, however the device failed to acknowledge the transmission
136 before a timeout expired.
147 .%T "NDIS 5.1 specification"
148 .%O http://www.microsoft.com
153 device driver first appeared in
155 and was imported into
161 driver was written by
162 .An Bill Paul Aq wpaul@windriver.com .