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