3 .\" Copyright (c) 2000 Alexander Langer
5 .\" All rights reserved.
7 .\" This program is free software.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 .\" $FreeBSD: src/share/man/man9/DECLARE_MODULE.9,v 1.2.2.3 2001/12/17 11:30:18 ru Exp $
30 .\" $DragonFly: src/share/man/man9/DECLARE_MODULE.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
37 .Nd kernel module declaration macro
40 .Fn DECLARE_MODULE "name" "moduledata_t data" "sub" "order"
44 macro declares a generic kernel module.
45 It is used to register the module with the system, using the
49 is usually used within other macros, such as
53 .Xr SYSCALL_MODULE 9 .
54 However, it can be called directly of course, for example in
55 order to implement dynamic sysctls.
61 is the name of the module, which will be used in the
63 call to identify the module.
68 structure, which contains two main items, the official name of the
69 module name, which will be used in the
71 structure and a pointer to the event handler function of type
75 is an argument directed to the
78 Valid values for this are contained in the
83 and specify the type of system startup interfaces.
88 here for example, since these modules contain a driver for a device.
89 For kernel modules that are loaded at runtime, a value of
95 value is another argument for
97 It represents the KLDs order of initialization within the subsystem.
98 Valid values are defined in the
99 .Vt sysinit_elem_order
104 .Xr DRIVER_MODULE 9 ,
108 .Pa /usr/include/sys/kernel.h ,
109 .Pa /usr/share/examples/kld
112 This manual page was written by
113 .An Alexander Langer Aq alex@FreeBSD.org ,
114 inspired by the KLD Facility Programming Tutorial by
115 .An Andrew Reiter Aq arr@watson.org .