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