Big mess 'o changes:

- Give ndiscvt(8) the ability to process a .SYS file directly into
  a .o file so that we don't have to emit big messy char arrays into
  the ndis_driver_data.h file. This behavior is currently optional, but
  may become the default some day.

- Give ndiscvt(8) the ability to turn arbitrary files into .ko files
  so that they can be pre-loaded or kldloaded. (Both this and the
  previous change involve using objcopy(1)).

- Give NdisOpenFile() the ability to 'read' files out of kernel memory
  that have been kldloaded or pre-loaded, and disallow the use of
  the normal vn_open() file opening method during bootstrap (when no
  filesystems have been mounted yet). Some people have reported that
  kldloading if_ndis.ko works fine when the system is running multiuser
  but causes a panic when the modile is pre-loaded by /boot/loader. This
  happens with drivers that need to use NdisOpenFile() to access
  external files (i.e. firmware images). NdisOpenFile() won't work
  during kernel bootstrapping because no filesystems have been mounted.
  To get around this, you can now do the following:

        o Say you have a firmware file called firmware.img
        o Do: ndiscvt -f firmware.img -- this creates firmware.img.ko
        o Put the firmware.img.ko in /boot/kernel
        o add firmware.img_load="YES" in /boot/loader.conf
        o add if_ndis_load="YES" and ndis_load="YES" as well

  Now the loader will suck the additional file into memory as a .ko. The
  phony .ko has two symbols in it: filename_start and filename_end, which
  are generated by objcopy(1). ndis_open_file() will traverse each module
  in the module list looking for these symbols and, if it finds them, it'll
  use them to generate the file mapping address and length values that
  the caller of NdisOpenFile() wants.

  As a bonus, this will even work if the file has been statically linked
  into the kernel itself, since the "kernel" module is searched too.
  (ndiscvt(8) will generate both filename.o and filename.ko for you).

- Modify the mechanism used to provide make-pretend FASTCALL support.
  Rather than using inline assembly to yank the first two arguments
  out of %ecx and %edx, we now use the __regparm__(3) attribute (and
  the __stdcall__ attribute) and use some macro magic to re-order
  the arguments and provide dummy arguments as needed so that the
  arguments passed in registers end up in the right place. Change
  taken from DragonflyBSD version of the NDISulator.

2 files changed, 265 insertions, 12 deletions

diff --git a/usr.sbin/ndiscvt/ndiscvt.8 b/usr.sbin/ndiscvt/ndiscvt.8
index 6ba8a5b..7c5294d 100644
--- a/usr.sbin/ndiscvt/ndiscvt.8
+++ b/usr.sbin/ndiscvt/ndiscvt.8
@@ -41,10 +41,13 @@ NDIS drivers for use with
 .Fx
 .Sh SYNOPSIS
 .Nm
+.Op Fl O
 .Op Fl i Ar inffile
 .Fl s Ar sysfile
 .Op Fl n Ar devname
 .Op Fl o Ar outfile
+.Nm
+.Op Fl f Ar firmfile
 .Sh DESCRIPTION
 The
 .Nm
@@ -144,10 +147,127 @@ The
 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.
+.It Fl O
+Generate both an
+.Pa ndis_driver_data.h
+file and
+an
+.Pa ndis_driver.data.o
+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 .
+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,
+these files contain firmware which the driver will transfer to
+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
+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 ,
+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
+the NDIS-based network interface is to be used for diskless/PXE
+booting
+.Pc ,
+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
+loader is only able to load files that are shared
+.Fx
+binary objects.
+.Pp
+The
+.Fl f
+flag can be used to convert an arbitrary file
+.Ar firmfile
+into shared object format
+.Po
+the actual conversion is done using
+the
+.Xr objcopy 1
+and
+.Xr ld 1
+commands
+.Pc .
+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
+at runtime using the
+.Xr kldload 8
+command.
+.Pp
+When an NDIS driver tries to open an external file, the
+.Xr ndisapi 9
+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
+to open files from
+.Pa /compat/ndis
+is disabled: only the module search will be performed.
+.Pp
+When using the
+.Fl f
+flag,
+.Nm
+will generate both a relocatable object file
+.Po
+with a
+.Pa .o
+extension
+.Pc
+and a shared object file
+.Po
+with a
+.Pa .ko
+extension
+.Pc
+. 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
+to create a completely static kernel image: the object file can be
+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 ndis 4 ,
-.Xr ndisapi 9
+.Xr ndisapi 9 ,
+.Xr objcopy 1
 .Sh HISTORY
 The
 .Nm
diff --git a/usr.sbin/ndiscvt/ndiscvt.c b/usr.sbin/ndiscvt/ndiscvt.c
index d1a29b3..8c78d54 100644
--- a/usr.sbin/ndiscvt/ndiscvt.c
+++ b/usr.sbin/ndiscvt/ndiscvt.c
@@ -42,7 +42,9 @@ __FBSDID("$FreeBSD$");
 #include <stdio.h>
 #include <errno.h>
 #include <string.h>
+#include <libgen.h>
 #include <err.h>
+#include <ctype.h>
 
 #include <compat/ndis/pe_var.h>
 
@@ -157,25 +159,130 @@ int insert_padding(imgbase, imglen)
 static void
 usage(void)
 {
-	fprintf(stderr, "Usage: %s [-i <inffile>] -s <sysfile> "
+	fprintf(stderr, "Usage: %s [-O] [-i <inffile>] -s <sysfile> "
 	    "[-n devname] [-o outfile]\n", __progname);
+	fprintf(stderr, "       %s -f <firmfile>\n", __progname);
+
 	exit(1);
 }
 
+static void
+bincvt(char *sysfile, char *outfile, void *img, int fsize)
+{
+	char			*ptr;
+	char			tname[] = "/tmp/ndiscvt.XXXXXX";
+	char			sysbuf[1024];
+	FILE			*binfp;
+
+	mkstemp(tname);
+
+	binfp = fopen(tname, "a+");
+	if (binfp == NULL)
+		err(1, "opening %s failed", tname);
+
+	if (fwrite(img, fsize, 1, binfp) != 1)
+		err(1, "failed to output binary image");
+
+	fclose(binfp);
+
+	outfile = strdup(basename(outfile));
+	if (strchr(outfile, '.'))
+		*strchr(outfile, '.') = '\0';
+
+	snprintf(sysbuf, sizeof(sysbuf),
+	    "objcopy -I binary -O elf32-i386-freebsd -B i386 %s %s.o\n",
+	    tname, outfile);
+	printf("%s", sysbuf);
+	system(sysbuf);
+	unlink(tname);
+
+	ptr = tname;
+	while (*ptr) {
+		if (*ptr == '/' || *ptr == '.')
+			*ptr = '_';
+		ptr++;
+	}
+
+	snprintf(sysbuf, sizeof(sysbuf),
+	    "objcopy --redefine-sym _binary_%s_start=%s_drv_data_start "
+	    "--strip-symbol _binary_%s_size "
+	    "--redefine-sym _binary_%s_end=%s_drv_data_end %s.o %s.o\n",
+	    tname, sysfile, tname, tname, sysfile, outfile, outfile);
+	printf("%s", sysbuf);
+	system(sysbuf);
+
+	return;
+}
+   
+static void
+firmcvt(char *firmfile)
+{
+	char			*basefile, *outfile, *ptr;
+	char			sysbuf[1024];
+
+	outfile = basename(firmfile);
+	basefile = strdup(outfile);
+
+	snprintf(sysbuf, sizeof(sysbuf),
+	    "objcopy -I binary -O elf32-i386-freebsd -B i386 %s %s.o\n",
+	    firmfile, outfile);
+	printf("%s", sysbuf);
+	system(sysbuf);
+
+	ptr = firmfile;
+	while (*ptr) {
+		if (*ptr == '/' || *ptr == '.')
+			*ptr = '_';
+		ptr++;
+	}
+	ptr = basefile;
+	while (*ptr) {
+		if (*ptr == '/' || *ptr == '.')
+			*ptr = '_';
+		else
+			*ptr = tolower(*ptr);
+		ptr++;
+	}
+
+	snprintf(sysbuf, sizeof(sysbuf),
+	    "objcopy --redefine-sym _binary_%s_start=%s_start "
+	    "--strip-symbol _binary_%s_size "
+	    "--redefine-sym _binary_%s_end=%s_end %s.o %s.o\n",
+	    firmfile, basefile, firmfile, firmfile,
+	    basefile, outfile, outfile);
+	ptr = sysbuf;
+	printf("%s", sysbuf);
+	system(sysbuf);
+
+	snprintf(sysbuf, sizeof(sysbuf),
+	    "ld -Bshareable -d -warn-common -o %s.ko %s.o\n",
+	    outfile, outfile);
+	printf("%s", sysbuf);
+	system(sysbuf);
+
+	free(basefile);
+
+	exit(0);
+}
+
 int
 main(int argc, char *argv[])
 {
-	FILE		*fp, *outfp;
-	void		*img;
-	int		n, fsize, cnt;
-	unsigned char	*ptr;
-	int		i;
-	char		*inffile = NULL, *sysfile = NULL, *outfile = NULL;
-	char		*dname = NULL;
-	int		ch;
-
-	while((ch = getopt(argc, argv, "i:s:o:n:")) != -1) {
+	FILE			*fp, *outfp;
+	int			i, bin = 0;
+	void			*img;
+	int			n, fsize, cnt;
+	unsigned char		*ptr;
+	char			*inffile = NULL, *sysfile = NULL;
+	char			*outfile = NULL, *firmfile = NULL;
+	char			*dname = NULL;
+	int			ch;
+
+	while((ch = getopt(argc, argv, "i:s:o:n:f:O")) != -1) {
 		switch(ch) {
+		case 'f':
+			firmfile = optarg;
+			break;
 		case 'i':
 			inffile = optarg;
 			break;
@@ -188,12 +295,18 @@ main(int argc, char *argv[])
 		case 'n':
 			dname = optarg;
 			break;
+		case 'O':
+			bin = 1;
+			break;
 		default:
 			usage();
 			break;
 		}
 	}
 
+	if (firmfile != NULL)
+		firmcvt(firmfile);
+
 	if (sysfile == NULL)
 		usage();
 
@@ -253,6 +366,25 @@ main(int argc, char *argv[])
 	}
 
 	fprintf(outfp, "\n#ifdef NDIS_IMAGE\n");
+
+	if (bin) {
+		sysfile = strdup(basename(sysfile));
+		ptr = sysfile;
+		while (*ptr) {
+			if (*ptr == '.')
+				*ptr = '_';
+			ptr++;
+		}
+		fprintf(outfp,
+		    "\nextern unsigned char %s_drv_data_start[];\n",
+		    sysfile);
+		fprintf(outfp, "static unsigned char *drv_data = "
+		    "%s_drv_data_start;\n\n", sysfile);
+		bincvt(sysfile, outfile, img, fsize);
+		goto done;
+	}
+
+
 	fprintf(outfp, "\nextern unsigned char drv_data[];\n\n");
 
 	fprintf(outfp, "__asm__(\".data\");\n");
@@ -282,6 +414,7 @@ main(int argc, char *argv[])
 done:
 
 	fprintf(outfp, "#endif /* NDIS_IMAGE */\n");
+
 	if (fp != NULL)
 		fclose(fp);
 	fclose(outfp);