summaryrefslogtreecommitdiffstats
path: root/share/examples
diff options
context:
space:
mode:
authorjulian <julian@FreeBSD.org>1997-02-02 07:35:59 +0000
committerjulian <julian@FreeBSD.org>1997-02-02 07:35:59 +0000
commite6b42ddfe105d779426250806c5071a8cfd39fec (patch)
tree3543d8ad84006a35c8ddf9b4c6d1fb9cee851528 /share/examples
parent5c0afad0d23f85e76dc71b2cc1bdf3e345b37a08 (diff)
downloadFreeBSD-src-e6b42ddfe105d779426250806c5071a8cfd39fec.zip
FreeBSD-src-e6b42ddfe105d779426250806c5071a8cfd39fec.tar.gz
Description of what the files in this directory do..
(create sample device drivers on request)
Diffstat (limited to 'share/examples')
-rw-r--r--share/examples/drivers/README45
1 files changed, 45 insertions, 0 deletions
diff --git a/share/examples/drivers/README b/share/examples/drivers/README
new file mode 100644
index 0000000..d6765bd
--- /dev/null
+++ b/share/examples/drivers/README
@@ -0,0 +1,45 @@
+Sat Feb 1 23:30:12 PST 1997 <Julian Elischer>
+
+These files are shell scripts.
+
+They will, when run, create an example skeleton driver
+for you. You can use this driver as a starting point for
+writing drivers for your own devices. They have all the hooks needed
+for intiialisation, probing, attaching, as well as DEVFS
+node creation. They also create sample ioctl commands and a sample
+ioctl definition .h file in /sys/sys. In othe rwords they are fully
+functional in a 'skeleton' sort of a way. They support multiple devices
+so that you may have several of your 'foobar' devices probed and atached
+at once.
+
+I expect that these scripts will improve with time.
+
+At present these scripts also link the newly created driver into
+the kernel sources in /sys. Possibly a better way would be
+to make them interactive. (and ask what kernel tree to use as well as
+a name for the driver.).
+
+There are presently two scripts.
+One for making a real device driver for ISA devices, and
+one for making a device driver for pseudo devices (e.g. /dev/null).
+Hopefully they will be joined by similar scripts for creating
+skeletons for PCI and EISA devices as well.
+
+Give them a single argument: the name of the driver.
+They will use this given name in many places within the driver,
+both in lower and upper case form. (conforming to normal usage).
+
+The skeleton driver should already link with the kernel
+and in fact the shell script will compile a kernel with the new
+drive linked in.. The new kernel should still be
+runnable and the new driver should be
+fully callable (once you get your device to probe).
+You should simply edit the driver and continue to use
+'make' (as done in the script) until your driver does what you want.
+
+The driver will end up in /sys/i386/isa for the device driver script,
+and in /sys/dev for the pseudo driver script.
+
+
+
+
OpenPOWER on IntegriCloud