Home | History | Annotate | Line # | Download | only in examples
README revision 1.4.10.2 
      1 	$NetBSD: README,v 1.4.10.2 2017/12/03 11:38:53 jdolecek Exp $
      2 
      3                            Kernel Developer's Manual
      4 
      5 DESCRIPTION
      6      The kernel example dynamic modules.
      7 
      8      This directory contains the following example modules:
      9      * hello           - the simplest `hello world' module
     10      * properties      - handle incoming properties during the module load
     11      * readhappy       - basic implementation of read(9) with happy numbers
     12      * ping            - basic ioctl(9)
     13      * luahello        - the simplest `hello world' Lua module
     14      * luareadhappy    - demonstrates calling Lua code from C
     15 
     16      To build the examples you need a local copy of NetBSD sources. You also
     17      need the comp set with toolchain. To build the module just enter a
     18      directory with example modules and use make(1):
     19 
     20          # make
     21 
     22      To load, unload, and stat the module use modload(8), modunload(8) and
     23      modstat(8).
     24 
     25      The S parameter in the Makefile files points to src/sys and it can be
     26      overloaded in this way:
     27 
     28          # make S=/data/netbsd/src/sys
     29 
     30      The code of a module does not need to be in src/sys unless you use
     31      the autoconf(9) framework.
     32 
     33      A cross-built of a module for a target platform is possible with the
     34      build.sh framework. You need to generate the toolchain and set
     35      appropriately PATH to point bin/ in the TOOLDIR path. An example command
     36      to cross-build a module with the amd64 toolchain is as follows:
     37 
     38         # nbmake-amd64 S=/data/netbsd/src/sys
     39 
     40 
     41      The example modules should not be used on a production machine.
     42 
     43      All modules that create a cdevsw should be verified that the major number
     44      should not conflict with a real device.
     45 
     46 SEE ALSO
     47      modctl(2), module(7), modload(8), modstat(8), modunload(8), module(9),
     48      intro(9lua)
     49 
     50 HISTORY
     51      An example of handling incoming properties first appeared in NetBSD 5.0
     52      and was written by Julio Merino with further modifications by Martin
     53      Husemann, Adam Hamsik, John Nemeth and Mindaugas Rasiukevicius.
     54 
     55      This document and additional modules (hello, readhappy, properties,
     56      ping, luahello and luareadhappy) first appeared in NetBSD 8.0; they were
     57      written by Kamil Rytarowski.
     58 
     59 AUTHORS
     60      This document was written by Kamil Rytarowski.
     61