README revision 1.12 
1	$NetBSD: README,v 1.12 2020/02/07 19:22:21 pgoyette Exp $
2
3                           Kernel Developer's Manual
4
5DESCRIPTION
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     * mapper          - basic implementation of mmap
14     * panic_string    - shows how panic is being called through a device
15     * ping            - basic ioctl(9)
16     * ping_block      - basic ioctl(9) with a block device
17     * properties      - handle incoming properties during the module load
18     * readhappy       - basic implementation of read(9) with happy numbers
19     * readhappy_mpsafe- demonstrates how to make a module MPSAFE
20     * sysctl          - demonstrates adding a sysctl handle dynamically
21
22     To build the examples you need a local copy of NetBSD sources. You also
23     need the comp set with toolchain. To build the module just enter a
24     directory with example modules and use make(1):
25
26         # make
27
28     To load, unload, and stat the module use modload(8), modunload(8) and
29     modstat(8).
30
31     The S parameter in the Makefile files points to src/sys and it can be
32     overloaded in this way:
33
34         # make S=/data/netbsd/src/sys
35
36     The code of a module does not need to be in src/sys unless it uses
37     the autoconf(9) framework.
38
39     A cross-build of a module for a target platform is possible with the
40     build.sh framework. You need to generate the toolchain and set
41     appropriately PATH to point bin/ in the TOOLDIR path. An example command
42     to cross-build a module with the amd64 toolchain is as follows:
43
44        # nbmake-amd64 S=/data/netbsd/src/sys
45
46
47     The example modules should not be used on a production machine.
48
49     All modules that create a cdevsw (or bdevsw) should be verified that
50     the major number(s) should not conflict with a real device.
51
52SEE ALSO
53     modctl(2), module(7), modload(8), modstat(8), modunload(8), module(9),
54     intro(9lua)
55
56HISTORY
57     An example of handling incoming properties first appeared in NetBSD 5.0
58     and was written by Julio Merino with further modifications by Martin
59     Husemann, Adam Hamsik, John Nemeth and Mindaugas Rasiukevicius.
60
61     This document and additional modules (hello, readhappy, properties,
62     ping, luahello and luareadhappy) first appeared in NetBSD 8.0; they were
63     written by Kamil Rytarowski.
64
65     The readhappy_mpsafe, executor and sysctls modules first appeared in NetBSD
66     9.0 and were authored by Siddharth Muralee.
67
68     The panic_string module first appeared in NetBSD 9.0 and was authored by
69     Harry Pantazis.
70
71     The mapper module first appeared in NetBSD 9.0 and was authored by
72     Akul Pillai.
73     
74     The ping_block module first appeared in NetBSD 10.0 and was authored by
75     Nisarg Joshi.
76
77AUTHORS
78     This document was written by Kamil Rytarowski.
79