xref: /freebsd/sys/conf/kmod.mk (revision 71fe318b852b8dfb3e799cb12ef184750f7f8eac)
1#	From: @(#)bsd.prog.mk	5.26 (Berkeley) 6/25/91
2# $FreeBSD$
3#
4# The include file <bsd.kmod.mk> handles installing Kernel Loadable Device
5# drivers (KLD's).
6#
7#
8# +++ variables +++
9#
10# CLEANFILES	Additional files to remove for the clean and cleandir targets.
11#
12# KMOD          The name of the kernel module to build.
13#
14# KMODDIR	Base path for kernel modules (see kld(4)). [/boot/kernel]
15#
16# KMODOWN	KLD owner. [${BINOWN}]
17#
18# KMODGRP	KLD group. [${BINGRP}]
19#
20# KMODMODE	KLD mode. [${BINMODE}]
21#
22# KMODLOAD	Command to load a kernel module [/sbin/kldload]
23#
24# KMODUNLOAD	Command to unload a kernel module [/sbin/kldunload]
25#
26# PROG          The name of the kernel module to build.
27#		If not supplied, ${KMOD}.o is used.
28#
29# SRCS          List of source files
30#
31# DESTDIR	Change the tree where the module gets installed. [not set]
32#
33# MFILES	Optionally a list of interfaces used by the module.
34#		This file contains a default list of interfaces.
35#
36# EXPORT_SYMS	A list of symbols that should be exported from the module,
37#		or the name of a file containing a list of symbols, or YES
38#		to export all symbols.  If not defined, no symbols are
39#		exported.
40#
41# +++ targets +++
42#
43# 	install:
44#               install the kernel module; if the Makefile
45#               does not itself define the target install, the targets
46#               beforeinstall and afterinstall may also be used to cause
47#               actions immediately before and after the install target
48#		is executed.
49#
50# 	load:
51#		Load KLD.
52#
53# 	unload:
54#		Unload KLD.
55#
56# bsd.obj.mk: clean, cleandir and obj
57# bsd.dep.mk: cleandepend, depend and tags
58#
59
60AWK?=		awk
61KMODLOAD?=	/sbin/kldload
62KMODUNLOAD?=	/sbin/kldunload
63OBJCOPY?=	objcopy
64
65.if defined(KMODDEPS)
66.error "Do not use KMODDEPS on 5.0+, use MODULE_VERSION/MODULE_DEPEND"
67.endif
68
69.include <bsd.init.mk>
70
71.SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S
72
73CFLAGS+=	${COPTS} -D_KERNEL ${CWARNFLAGS}
74CFLAGS+=	-DKLD_MODULE
75
76# Don't use any standard or source-relative include directories.
77# Since -nostdinc will annull any previous -I paths, we repeat all
78# such paths after -nostdinc.  It doesn't seem to be possible to
79# add to the front of `make' variable.
80_ICFLAGS:=	${CFLAGS:M-I*}
81CFLAGS+=	-nostdinc -I- ${INCLMAGIC} ${_ICFLAGS}
82
83# Add -I paths for system headers.  Individual KLD makefiles don't
84# need any -I paths for this.  Similar defaults for .PATH can't be
85# set because there are no standard paths for non-headers.
86CFLAGS+=	-I. -I@ -I@/dev
87
88# Add a -I path to standard headers like <stddef.h>.  Use a relative
89# path to src/include if possible.  If the @ symlink hasn't been built
90# yet, then we can't tell if the relative path exists.  Add both the
91# potential relative path and an absolute path in that case.
92.if exists(@)
93.if exists(@/../include)
94CFLAGS+=	-I@/../include
95.else
96CFLAGS+=	-I${DESTDIR}/usr/include
97.endif
98.else # !@
99CFLAGS+=	-I@/../include -I${DESTDIR}/usr/include
100.endif # @
101
102# Disallow common variables, and if we end up with commons from
103# somewhere unexpected, allocate storage for them in the module itself.
104CFLAGS+=	-fno-common
105LDFLAGS+=	-d -warn-common
106
107CFLAGS+=	${DEBUG_FLAGS}
108
109OBJS+=  ${SRCS:N*.h:R:S/$/.o/g}
110
111.if !defined(PROG)
112PROG=	${KMOD}.ko
113.endif
114
115.if !defined(DEBUG)
116FULLPROG=	${PROG}
117.else
118FULLPROG=	${PROG}.debug
119${PROG}: ${FULLPROG}
120	${OBJCOPY} --strip-debug ${FULLPROG} ${PROG}
121.endif
122
123${FULLPROG}: ${KMOD}.kld
124	${LD} -Bshareable ${LDFLAGS} -o ${.TARGET} ${KMOD}.kld
125
126EXPORT_SYMS?=	NO
127.if ${EXPORT_SYMS} != YES
128CLEANFILES+=	${.OBJDIR}/export_syms
129.endif
130
131${KMOD}.kld: ${OBJS}
132	${LD} ${LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
133.if defined(EXPORT_SYMS)
134.if ${EXPORT_SYMS} != YES
135.if ${EXPORT_SYMS} == NO
136	touch ${.OBJDIR}/export_syms
137.elif !exists(${.CURDIR}/${EXPORT_SYMS})
138	echo ${EXPORT_SYMS} > ${.OBJDIR}/export_syms
139.else
140	grep -v '^#' < ${EXPORT_SYMS} >  ${.OBJDIR}/export_syms
141.endif
142	awk -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
143		${.OBJDIR}/export_syms | \
144	xargs -J% ${OBJCOPY} % ${.TARGET}
145.endif
146.endif
147
148_ILINKS=@ machine
149
150all: objwarn ${PROG}
151
152beforedepend: ${_ILINKS}
153	@rm -f .depend
154
155# Ensure that the links exist without depending on it when it exists which
156# causes all the modules to be rebuilt when the directory pointed to changes.
157.for _link in ${_ILINKS}
158.if !exists(${.OBJDIR}/${_link})
159${OBJS}: ${_link}
160.endif
161.endfor
162
163# Search for kernel source tree in standard places.
164.for _dir in ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys
165.if !defined(SYSDIR) && exists(${_dir}/kern/)
166SYSDIR=	${_dir}
167.endif
168.endfor
169.if !defined(SYSDIR) || !exists(${SYSDIR}/kern)
170.error "can't find kernel source tree"
171.endif
172
173${_ILINKS}:
174	@case ${.TARGET} in \
175	machine) \
176		path=${SYSDIR}/${MACHINE_ARCH}/include ;; \
177	@) \
178		path=${SYSDIR} ;; \
179	esac ; \
180	path=`(cd $$path && /bin/pwd)` ; \
181	${ECHO} ${.TARGET} "->" $$path ; \
182	ln -s $$path ${.TARGET}
183
184CLEANFILES+= ${PROG} ${FULLPROG} ${KMOD}.kld ${OBJS} ${_ILINKS} symb.tmp tmp.o
185
186.if !target(install)
187
188_INSTALLFLAGS:=	${INSTALLFLAGS}
189.for ie in ${INSTALLFLAGS_EDIT}
190_INSTALLFLAGS:=	${_INSTALLFLAGS${ie}}
191.endfor
192
193.if defined(DEBUG)
194install.debug:
195	cd ${.CURDIR}; ${MAKE} -DINSTALL_DEBUG install
196.endif
197
198.if !target(realinstall)
199realinstall: _kmodinstall
200.ORDER: beforeinstall _kmodinstall
201.if defined(DEBUG) && defined(INSTALL_DEBUG)
202_kmodinstall:
203	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
204	    ${_INSTALLFLAGS} ${FULLPROG} ${DESTDIR}${KMODDIR}
205.else
206_kmodinstall:
207	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
208	    ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}
209
210.include <bsd.links.mk>
211
212.if !defined(NO_XREF)
213afterinstall: _kldxref
214.ORDER: realinstall _kldxref
215.ORDER: _installlinks _kldxref
216_kldxref:
217	@if type kldxref >/dev/null 2>&1; then \
218		${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
219		kldxref ${DESTDIR}${KMODDIR}; \
220	fi
221.endif
222.endif
223.endif !target(realinstall)
224
225.endif !target(install)
226
227.if !target(load)
228load:	${PROG}
229	${KMODLOAD} -v ${.OBJDIR}/${KMOD}.ko
230.endif
231
232.if !target(unload)
233unload:
234	${KMODUNLOAD} -v ${KMOD}
235.endif
236
237.for _src in ${SRCS:Mopt_*.h}
238CLEANFILES+=	${_src}
239.if !target(${_src})
240${_src}:
241	touch ${.TARGET}
242.endif
243.endfor
244
245MFILES?= kern/bus_if.m kern/device_if.m dev/iicbus/iicbb_if.m \
246    dev/iicbus/iicbus_if.m isa/isa_if.m \
247    libkern/iconv_converter_if.m \
248    dev/mii/miibus_if.m \
249    dev/pccard/card_if.m dev/pccard/power_if.m dev/pci/pci_if.m \
250    dev/pci/pcib_if.m dev/ppbus/ppbus_if.m dev/smbus/smbus_if.m \
251    dev/usb/usb_if.m dev/sound/pcm/ac97_if.m dev/sound/pcm/channel_if.m \
252    dev/sound/pcm/feeder_if.m dev/sound/pcm/mixer_if.m pci/agp_if.m \
253    opencrypto/crypto_if.m
254
255.for _srcsrc in ${MFILES}
256.for _ext in c h
257.for _src in ${SRCS:M${_srcsrc:T:R}.${_ext}}
258CLEANFILES+=	${_src}
259.if !target(${_src})
260.if !exists(@)
261${_src}: @
262.endif
263.if exists(@)
264${_src}: @/tools/makeobjops.awk @/${_srcsrc}
265.endif
266	${AWK} -f @/tools/makeobjops.awk @/${_srcsrc} -${_ext}
267.endif
268.endfor # _src
269.endfor # _ext
270.endfor # _srcsrc
271
272.for _ext in c h
273.if ${SRCS:Mvnode_if.${_ext}} != ""
274CLEANFILES+=	vnode_if.${_ext}
275.if !exists(@)
276vnode_if.${_ext}: @
277.endif
278.if exists(@)
279vnode_if.${_ext}: @/tools/vnode_if.awk @/kern/vnode_if.src
280.endif
281	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -${_ext}
282.endif
283.endfor
284
285regress:
286
287lint: ${SRCS}
288	${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
289
290.include <bsd.dep.mk>
291
292.if !exists(${DEPENDFILE})
293${OBJS}: ${SRCS:M*.h}
294.endif
295
296.include <bsd.obj.mk>
297.include <bsd.kern.mk>
298