summaryrefslogtreecommitdiffstats
path: root/usr.sbin/ndiscvt
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2005-01-11 11:47:22 +0000
committerru <ru@FreeBSD.org>2005-01-11 11:47:22 +0000
commit16dc33fabf01a24ed6c62a632bec7c7856aaf1c9 (patch)
treef589f42b0a32796610fcf838d714f42ae5d07fe7 /usr.sbin/ndiscvt
parentf72a2cd4bdaf82cd60629765401bb66d607548a4 (diff)
downloadFreeBSD-src-16dc33fabf01a24ed6c62a632bec7c7856aaf1c9.zip
FreeBSD-src-16dc33fabf01a24ed6c62a632bec7c7856aaf1c9.tar.gz
Scheduled mdoc(7) sweep.
Diffstat (limited to 'usr.sbin/ndiscvt')
-rw-r--r--usr.sbin/ndiscvt/ndiscvt.871
1 files changed, 34 insertions, 37 deletions
diff --git a/usr.sbin/ndiscvt/ndiscvt.8 b/usr.sbin/ndiscvt/ndiscvt.8
index 7c5294d..16d4292 100644
--- a/usr.sbin/ndiscvt/ndiscvt.8
+++ b/usr.sbin/ndiscvt/ndiscvt.8
@@ -153,52 +153,51 @@ Generate both an
file and
an
.Pa ndis_driver.data.o
-file. The latter file will contain a copy of the
+file.
+The latter file will contain a copy of the
.Tn Windows\[rg]
.Pa .SYS
driver image encoded as a
.Fx
ELF object file
-.Po
-created with
-.Xr objcopy 1
-.Pc .
+(created with
+.Xr objcopy 1 ) .
Turning the
.Tn Windows\[rg]
driver image directly into an object code file saves disk space
and compilation time.
.It Fl f Ar firmfile
A few NDIS drivers come with additional files that the core
-driver module will load during initialization time. Typically,
+driver module will load during initialization time.
+Typically,
these files contain firmware which the driver will transfer to
-the device in order to make it fully operational. In
+the device in order to make it fully operational.
+In
.Tn Windows\[rg] ,
these files are usually just copied into one of the system
directories along with the driver itself.
.Pp
In
.Fx
-there are two mechanism for loading these files. If the driver
+there are two mechanism for loading these files.
+If the driver
is built as a loadable kernel module which is loaded after the
kernel has finished booting
-.Po
-and after the root filesystem has
-been mounted
-.Pc ,
+(and after the root file system has
+been mounted),
the extra files can simply be copied to the
.Pa /compat/ndis
directory, and they will be loaded into the kernel on demand when the
the driver needs them.
.Pp
If however the driver is required to bootstrap the system
-.Po
-i.e. if
+(i.e., if
the NDIS-based network interface is to be used for diskless/PXE
-booting
-.Pc ,
+booting),
the files need to be pre-loaded by the bootstrap
loader in order to be accessible, since the driver will need them
-before the root filesystem has been mounted. However, the bootstrap
+before the root file system has been mounted.
+However, the bootstrap
loader is only able to load files that are shared
.Fx
binary objects.
@@ -208,20 +207,19 @@ The
flag can be used to convert an arbitrary file
.Ar firmfile
into shared object format
-.Po
-the actual conversion is done using
+(the actual conversion is done using
the
.Xr objcopy 1
and
.Xr ld 1
-commands
-.Pc .
+commands).
The resulting files can then be copied to the
.Pa /boot/kernel
directory, and can be pre-loaded directly from the boot loader
prompt, or automatically by editing the
.Xr loader.conf 5
-file. If desired, the files can also be loaded into memory
+file.
+If desired, the files can also be loaded into memory
at runtime using the
.Xr kldload 8
command.
@@ -232,7 +230,8 @@ code will first search for a loaded kernel module that matches the
name specified in the open request, and if that fails, it will then
try to open the file from the
.Pa /compat/ndis
-directory as well. Note that during kernel bootstrap, the ability
+directory as well.
+Note that during kernel bootstrap, the ability
to open files from
.Pa /compat/ndis
is disabled: only the module search will be performed.
@@ -242,32 +241,30 @@ When using the
flag,
.Nm
will generate both a relocatable object file
-.Po
-with a
+(with a
.Pa .o
-extension
-.Pc
+extension)
and a shared object file
-.Po
-with a
+(with a
.Pa .ko
-extension
-.Pc
-. The shared object is the one that should be placed in
+extension).
+The shared object is the one that should be placed in
the
.Pa /boot/kernel
-directory. The relocatable object file is useful if the user wishes
+directory.
+The relocatable object file is useful if the user wishes
to create a completely static kernel image: the object file can be
-linked into the kernel directly along with the driver itself. Some
+linked into the kernel directly along with the driver itself.
+Some
editing of the kernel configuration files will be necessary in order
to have the extra object included in the build.
.El
.Sh SEE ALSO
-.Xr kldload 8 ,
.Xr ld 1 ,
+.Xr objcopy 1 ,
.Xr ndis 4 ,
-.Xr ndisapi 9 ,
-.Xr objcopy 1
+.Xr kldload 8 ,
+.Xr ndisapi 9
.Sh HISTORY
The
.Nm
OpenPOWER on IntegriCloud