xref: /freebsd/share/man/man9/MODULE_DEPEND.9 (revision 397e83df75e0fcd0d3fcb95ae4d794cb7600fc89)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2001 Alexander Langer
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
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.
17.\"
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.
28.\"
29.Dd January 11, 2005
30.Dt MODULE_DEPEND 9
31.Os
32.Sh NAME
33.Nm MODULE_DEPEND
34.Nd set kernel module dependencies
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/module.h
38.Fn MODULE_DEPEND "name" "moddepend" "int minversion" "int prefversion" "int maxversion"
39.Sh DESCRIPTION
40The
41.Fn MODULE_DEPEND
42macro sets a dependency on another kernel module with name
43.Fa moddepend ,
44which has registered
45its version with
46.Fn MODULE_VERSION .
47.Pp
48The
49.Fn MODULE_DEPEND
50macro provides hints to the kernel
51.Xr loader 8
52and to the kernel linker to ensure that the named dependency is loaded
53prior to the existing module.
54It does not change or dictate the order in which modules are
55initialized at runtime.
56.Pp
57Three versions must be specified for
58.Fa moddepend :
59.Bl -tag -width ".Fa prefversion"
60.It Fa minversion
61The minimum version on which the current module can depend.
62.It Fa maxversion
63The maximum version on which the current module can depend.
64.It Fa prefversion
65The preferred version on which the current module can depend.
66.El
67.Sh EXAMPLES
68.Bd -literal
69MODULE_DEPEND(foo, bar, 1, 3, 4);
70.Ed
71.Sh SEE ALSO
72.Xr DECLARE_MODULE 9 ,
73.Xr module 9 ,
74.Xr MODULE_VERSION 9
75.Sh AUTHORS
76.An -nosplit
77This manual page was written by
78.An Alexander Langer Aq Mt alex@FreeBSD.org .
79