declare_module(9) [freebsd man page]

DECLARE_MODULE(9)					   BSD Kernel Developer's Manual					 DECLARE_MODULE(9)

NAME

     DECLARE_MODULE -- kernel module declaration macro

SYNOPSIS

     #include <sys/param.h>
     #include <sys/kernel.h>
     #include <sys/module.h>

     DECLARE_MODULE(name, moduledata_t data, sub, order);

DESCRIPTION

     The DECLARE_MODULE() macro declares a generic kernel module.  It is used to register the module with the system, using the SYSINIT() macro.
     DECLARE_MODULE() is usually used within other macros, such as DRIVER_MODULE(9), DEV_MODULE(9) and SYSCALL_MODULE(9).  Of course, it can also
     be called directly, for example in order to implement dynamic sysctls.

     The arguments it expects are:

     name    The module name, which will be used in the SYSINIT() call to identify the module.

     data    A moduledata_t structure, which contains two main items, the official name of the module name, which will be used in the module_t
	     structure and a pointer to the event handler function of type modeventhand_t.

     sub     An argument directed to the SYSINIT() macro.  Valid values for this are contained in the sysinit_sub_id enumeration (see
	     <sys/kernel.h>) and specify the type of system startup interfaces.  The DRIVER_MODULE(9) macro uses a value of SI_SUB_DRIVERS here
	     for example, since these modules contain a driver for a device.  For kernel modules that are loaded at runtime, a value of
	     SI_SUB_EXEC is common.

     order   An argument for SYSINIT().  It represents the KLDs order of initialization within the subsystem.  Valid values are defined in the
	     sysinit_elem_order enumeration (<sys/kernel.h>).

SEE ALSO

     DEV_MODULE(9), DRIVER_MODULE(9), module(9), SYSCALL_MODULE(9)

     /usr/include/sys/kernel.h, /usr/share/examples/kld

AUTHORS

     This manual page was written by Alexander Langer <alex@FreeBSD.org>, inspired by the KLD Facility Programming Tutorial by Andrew Reiter
     <arr@watson.org>.

BSD
								  January 6, 2005							       BSD

DRIVER_MODULE(9)					   BSD Kernel Developer's Manual					  DRIVER_MODULE(9)

NAME

     DRIVER_MODULE, DRIVER_MODULE_ORDERED, EARLY_DRIVER_MODULE, EARLY_DRIVER_MODULE_ORDERED -- kernel driver declaration macro

SYNOPSIS

     #include <sys/param.h>
     #include <sys/kernel.h>
     #include <sys/bus.h>
     #include <sys/module.h>

     DRIVER_MODULE(name, busname, driver_t driver, devclass_t devclass, modeventhand_t evh, void *arg);

     DRIVER_MODULE_ORDERED(name, busname, driver_t driver, devclass_t devclass, modeventhand_t evh, void *arg, int order);

     EARLY_DRIVER_MODULE(name, busname, driver_t driver, devclass_t devclass, modeventhand_t evh, void *arg, enum sysinit_elem_order order,
	 int pass);

     EARLY_DRIVER_MODULE_ORDERED(name, busname, driver_t driver, devclass_t devclass, modeventhand_t evh, void *arg,
	 enum sysinit_elem_order order, int pass);

DESCRIPTION

     The DRIVER_MODULE() macro declares a kernel driver.  DRIVER_MODULE() expands to the real driver declaration, where the phrase name is used as
     the naming prefix for the driver and its functions.  Note that it is supplied as plain text, and not a char or char *.

     busname is the parent bus of the driver (PCI, ISA, PPBUS and others), e.g. 'pci', 'isa', or 'ppbus'.

     The identifier used in DRIVER_MODULE() can be different from the driver name.  Also, the same driver identifier can exist on different
     busses, which is a pretty clean way of making front ends for different cards using the same driver on the same or different busses.  For
     example, the following is allowed:

     DRIVER_MODULE(foo, isa, foo_driver, foo_devclass, NULL, NULL);

     DRIVER_MODULE(foo, pci, foo_driver, foo_devclass, NULL, NULL);

     driver is the driver of type driver_t, which contains the information about the driver and is therefore one of the two most important parts
     of the call to DRIVER_MODULE().

     The devclass argument contains the kernel-internal information about the device, which will be used within the kernel driver module.

     The evh argument is the event handler which is called when the driver (or module) is loaded or unloaded (see module(9)).

     The arg is unused at this time and should be a NULL pointer.

     The DRIVER_MODULE_ORDERED() macro allows a driver to be registered in a specific order.  This can be useful if a single kernel module con-
     tains multiple drivers that are inter-dependent.  The order argument should be one of the SYSINIT(9) initialization ordering constants
     (SI_ORDER_*).  The default order for a driver module is SI_ORDER_MIDDLE.  Typically a module will specify an order of SI_ORDER_ANY for a sin-
     gle driver to ensure it is registered last.

     The EARLY_DRIVER_MODULE() macro allows a driver to be registered for a specific pass level.  The boot time probe and attach process makes
     multiple passes over the device tree.  Certain critical drivers that provide basic services needed by other devices are attach during earlier
     passes.  Most drivers are attached in a final general pass.  A driver that attaches during an early pass must register for a specific pass
     level (BUS_PASS_*) via the pass argument.	Once a driver is registered it is available to attach to devices for all subsequent passes.

     The EARLY_DRIVER_MODULE_ORDERED() macro allows a driver to be registered both in a specific order and for a specific pass level.

SEE ALSO

     device(9), driver(9), module(9), SYSINIT(9)

AUTHORS

     This manual page was written by Alexander Langer <alex@FreeBSD.org>.

BSD
								  August 21, 2012							       BSD