freebsd-nq/usr.sbin/ndiscvt/ndiscvt.8

.\" Copyright (c) 2003
.\"	Bill Paul <wpaul@windriver.com> All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by Bill Paul.
.\" 4. Neither the name of the author nor the names of any co-contributors
.\"    may be used to endorse or promote products derived from this software
.\"   without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd December 10, 2003
.Dt NDISCVT 8
.Os
.Sh NAME
.Nm ndiscvt
.Nd Convert Windows(r) NDIS drivers for use with FreeBSD
.Sh SYNOPSIS
.Nm
.Op Fl i Ar <inffile>
.Fl s Ar <sysfile>
.Op Fl n Ar devname
.Op Fl o Ar <outfile>
.Sh DESCRIPTION
The
.Nm
utility transforms a Windows(r) NDIS driver into a data file which
is used to build an
.Xr ndis 4
compatibility driver module. Windows(r) drivers consist of two main
parts: a .SYS file, which contains the actual driver executable code,
and a .INF file, which provides the Windows(r) installer with device
identifier information and a list of driver-specific registry keys.
The
.Nm
utility can convert these files into a header file that is compiled
into
.Pa if_ndis.c
to create an object code module that can be linked into
the
.Fx
kernel.
.Pp
The .INF file is typically required since only it contains device
identification data such as PCI vendor and device IDs or PCMCIA
indentifier strings. The .INF file may be optionally omitted however,
in which case the
.Nm
utility will only perform the conversion of the .SYS file. This is
useful for debugging purposes only.
.Pp
.Sh OPTIONS
The options are as follows:
.Bl -tag -width indent
.It Op Fl i Ar <inffile>
Open and parse the specified .INF file when performing conversion.
The
.Nm
utility will parse this file and emit a device identification
structure and registry key configuration structures which will be
used by the
.Xr ndis 4
driver and
.Xr ndisapi 9
kernel subsystem.
If this is omitted,
.Nm
will emit a dummy configuration structure only.
.It Fl s Ar <sysfile>
Open and parse the specified .SYS file. This file must contain
a Windows(r) driver image. The
.Nm
utility will perform some manipulation of the sections within the
executable file to make runtime linking within the kernel a little
easier and then convert the image into a data array.
.It Op Fl n Ar devname
Specify an alternate name for the network device/interface which will
be created when the driver is instantiated. If you need to load more
than one NDIS driver into your system (i.e. if you have two different
network cards in your system which require NDIS driver support), each
module you create must have a unique name. Device can not be larger
than IFNAMSIZ. If no name is specified, the driver will use the
default a default name (``ndis'').
.It Op Fl o Ar <outfile>
Specify the output file in which to place the resulting data. This
can be any file pathname. If
.Ar <outfile>
is a single dash, the data will be written to the standard output.
The
.Pa if_ndis.c
module expects to find the driver data in a file called
.Pa ndis_driver_data.h ,
so it is recommended that this name be used.
.El
.Sh SEE ALSO
.Xr ndis 4 ,
.Xr ndisapi 9
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 5.3.
.Sh AUTHORS
The
.Nm
utility was written by
.An Bill Paul Aq wpaul@windriver.com .
The
.Xr lex 1
and
.Xr yacc 1
INF file parser was written by
.An Matthew Dodd Aq mdodd@freebsd.org .
Commit the ndiscvt(8) utility too. (Missed it in the last import.) 2003-12-11 22:38:14 +00:00			`.\" Copyright (c) 2003`
			`.\" Bill Paul <wpaul@windriver.com> All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by Bill Paul.`
			`.\" 4. Neither the name of the author nor the names of any co-contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD`
			`.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR`
			`.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF`
			`.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS`
			`.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN`
			`.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)`
			`.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF`
			`.\" THE POSSIBILITY OF SUCH DAMAGE.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
			`.Dd December 10, 2003`
			`.Dt NDISCVT 8`
			`.Os`
			`.Sh NAME`
			`.Nm ndiscvt`
			`.Nd Convert Windows(r) NDIS drivers for use with FreeBSD`
			`.Sh SYNOPSIS`
			`.Nm`
			`.Op Fl i Ar <inffile>`
			`.Fl s Ar <sysfile>`
Clean up ndiscvt a bit (leaving out the -i flag didn't work) and add copyrights to the inf parser files. Add a -n flag to ndiscvt to allow the user to override the default device name of NDIS devices. Instead of "ndis0, ndis1, etc..." you can have "foo0, foo1, etc..." This allows you to have more than one kind of NDIS device in the kernel at the same time. Convert from printf() to device_printf() in if_ndis.c, kern_ndis.c and subr_ndis.c. Create UMA zones for ndis_packet and ndis_buffer structs allocated on transmit. The zones are created and destroyed in the modevent handler in kern_ndis.c. printf() and UMA changes submitted by green@freebsd.org 2004-01-02 04:31:06 +00:00			`.Op Fl n Ar devname`
Commit the ndiscvt(8) utility too. (Missed it in the last import.) 2003-12-11 22:38:14 +00:00			`.Op Fl o Ar <outfile>`
			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`utility transforms a Windows(r) NDIS driver into a data file which`
			`is used to build an`
			`.Xr ndis 4`
			`compatibility driver module. Windows(r) drivers consist of two main`
			`parts: a .SYS file, which contains the actual driver executable code,`
			`and a .INF file, which provides the Windows(r) installer with device`
			`identifier information and a list of driver-specific registry keys.`
			`The`
			`.Nm`
			`utility can convert these files into a header file that is compiled`
Correct a typo in the text. Remove BUGS section since the bug it describes has been fixed. Spell Matt Dodd's name correctly. (Oops.) 2003-12-23 18:09:59 +00:00			`into`
Commit the ndiscvt(8) utility too. (Missed it in the last import.) 2003-12-11 22:38:14 +00:00			`.Pa if_ndis.c`
			`to create an object code module that can be linked into`
			`the`
			`.Fx`
			`kernel.`
			`.Pp`
			`The .INF file is typically required since only it contains device`
			`identification data such as PCI vendor and device IDs or PCMCIA`
			`indentifier strings. The .INF file may be optionally omitted however,`
			`in which case the`
			`.Nm`
			`utility will only perform the conversion of the .SYS file. This is`
			`useful for debugging purposes only.`
			`.Pp`
			`.Sh OPTIONS`
			`The options are as follows:`
			`.Bl -tag -width indent`
			`.It Op Fl i Ar <inffile>`
			`Open and parse the specified .INF file when performing conversion.`
			`The`
			`.Nm`
			`utility will parse this file and emit a device identification`
			`structure and registry key configuration structures which will be`
			`used by the`
			`.Xr ndis 4`
			`driver and`
			`.Xr ndisapi 9`
			`kernel subsystem.`
			`If this is omitted,`
			`.Nm`
			`will emit a dummy configuration structure only.`
			`.It Fl s Ar <sysfile>`
			`Open and parse the specified .SYS file. This file must contain`
			`a Windows(r) driver image. The`
			`.Nm`
			`utility will perform some manipulation of the sections within the`
			`executable file to make runtime linking within the kernel a little`
			`easier and then convert the image into a data array.`
Clean up ndiscvt a bit (leaving out the -i flag didn't work) and add copyrights to the inf parser files. Add a -n flag to ndiscvt to allow the user to override the default device name of NDIS devices. Instead of "ndis0, ndis1, etc..." you can have "foo0, foo1, etc..." This allows you to have more than one kind of NDIS device in the kernel at the same time. Convert from printf() to device_printf() in if_ndis.c, kern_ndis.c and subr_ndis.c. Create UMA zones for ndis_packet and ndis_buffer structs allocated on transmit. The zones are created and destroyed in the modevent handler in kern_ndis.c. printf() and UMA changes submitted by green@freebsd.org 2004-01-02 04:31:06 +00:00			`.It Op Fl n Ar devname`
			`Specify an alternate name for the network device/interface which will`
			`be created when the driver is instantiated. If you need to load more`
			`than one NDIS driver into your system (i.e. if you have two different`
			`network cards in your system which require NDIS driver support), each`
			`module you create must have a unique name. Device can not be larger`
			`than IFNAMSIZ. If no name is specified, the driver will use the`
			default a default name (``ndis'').
Commit the ndiscvt(8) utility too. (Missed it in the last import.) 2003-12-11 22:38:14 +00:00			`.It Op Fl o Ar <outfile>`
			`Specify the output file in which to place the resulting data. This`
			`can be any file pathname. If`
			`.Ar <outfile>`
			`is a single dash, the data will be written to the standard output.`
			`The`
			`.Pa if_ndis.c`
			`module expects to find the driver data in a file called`
			`.Pa ndis_driver_data.h ,`
			`so it is recommended that this name be used.`
			`.El`
			`.Sh SEE ALSO`
			`.Xr ndis 4 ,`
			`.Xr ndisapi 9`
			`.Sh HISTORY`
			`The`
			`.Nm`
			`utility first appeared in`
			`.Fx 5.3.`
			`.Sh AUTHORS`
			`The`
			`.Nm`
			`utility was written by`
			`.An Bill Paul Aq wpaul@windriver.com .`
			`The`
			`.Xr lex 1`
			`and`
			`.Xr yacc 1`
			`INF file parser was written by`
Correct a typo in the text. Remove BUGS section since the bug it describes has been fixed. Spell Matt Dodd's name correctly. (Oops.) 2003-12-23 18:09:59 +00:00			`.An Matthew Dodd Aq mdodd@freebsd.org .`