share/man/man9/DECLARE_MODULE.9

   1 .\" Copyright (c) 2000 Alexander Langer
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/DECLARE_MODULE.9,v 1.2.2.3 2001/12/17 11:30:18 ru Exp $
  28 .\"
  29 .Dd March 3, 2001
  30 .Dt DECLARE_MODULE 9
  31 .Os
  32 .Sh NAME
  33 .Nm DECLARE_MODULE
  34 .Nd kernel module declaration macro
  35 .Sh SYNOPSIS
  36 .In sys/module.h
  37 .Fn DECLARE_MODULE "name" "moduledata_t data" "sub" "order"
  38 .Sh DESCRIPTION
  39 The
  40 .Fn DECLARE_MODULE
  41 macro declares a generic kernel module.
  42 It is used to register the module with the system, using the
  43 .Fn SYSINIT
  44 macro.
  45 .Fn DECLARE_MODULE
  46 is usually used within other macros, such as
  47 .Xr DRIVER_MODULE 9 ,
  48 .Xr DEV_MODULE 9
  49 and
  50 .Xr SYSCALL_MODULE 9 .
  51 However, it can be called directly of course, for example in
  52 order to implement dynamic sysctls.
  53 .Pp
  54 The arguments to
  55 .Fn DECLARE_MODULE :
  56 .Pp
  57 .Fa name
  58 is the name of the module, which will be used in the
  59 .Fn SYSINIT
  60 call to identify the module.
  61 .Pp
  62 .Fa data
  63 is a pointer to the
  64 .Vt moduledata_t
  65 structure, which contains two main items, the official name of the
  66 module, which will be used in the
  67 .Vt module
  68 structure and a pointer to the event handler function of type
  69 .Vt modeventhand_t .
  70 .Pp
  71 .Fa sub
  72 is an argument directed to the
  73 .Fn SYSINIT
  74 macro.
  75 Valid values for this are contained in the
  76 .Vt sysstem_sub_id
  77 enumeration
  78 (see
  79 .In sys/kernel.h )
  80 and specify the type of system startup interfaces.
  81 The
  82 .Xr DRIVER_MODULE 9
  83 macro uses a value of
  84 .Dv SI_SUB_DRIVERS
  85 here for example, since these modules contain a driver for a device.
  86 For kernel modules that are loaded at runtime, a value of
  87 .Dv SI_SUB_EXEC
  88 is common.
  89 .Pp
  90 The
  91 .Fa order
  92 value is another argument for
  93 .Fn SYSINIT .
  94 It represents the KLDs order of initialization within the subsystem.
  95 Valid values are defined in the
  96 .Vt sysinit_elem_order
  97 enumeration (see
  98 .In sys/kernel.h ) .
  99 .Sh SEE ALSO
 100 .Xr DEV_MODULE 9 ,
 101 .Xr DRIVER_MODULE 9 ,
 102 .Xr module 9 ,
 103 .Xr SYSCALL_MODULE 9
 104 .Pp
 105 .In sys/kernel.h ,
 106 .Pa /usr/share/examples/kld
 107 .Sh AUTHORS
 108 .An -nosplit
 109 This manual page was written by
 110 .An Alexander Langer Aq Mt alex@FreeBSD.org ,
 111 inspired by the KLD Facility Programming Tutorial by
 112 .An Andrew Reiter Aq Mt arr@watson.org .