33db29a0ec1c42adcc62a23a8b152dca9b9df23a
[dragonfly.git] / sys / conf / kmod.mk
1 #       From: @(#)bsd.prog.mk   5.26 (Berkeley) 6/25/91
2 # $FreeBSD: src/sys/conf/kmod.mk,v 1.82.2.15 2003/02/10 13:11:50 nyan Exp $
3 #
4 # The include file <bsd.kmod.mk> handles installing Kernel Loadable Device
5 # drivers (KLD's).
6 #
7 #
8 # +++ variables +++
9 # CLEANFILES    Additional files to remove for the clean and cleandir targets.
10 #
11 # KMOD          The name of the kernel module to build.
12 #
13 # KMODDIR       Base path for kernel modules (see kld(4)).
14 #               [${DESTKERNDIR}]
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 # DESTKERNDIR   Change the tree where the kernel and the modules get
32 #               installed. [/boot]  ${DESTDIR} changes the root of the tree
33 #               pointed to by ${DESTKERNDIR}.
34 #
35 # MFILES        Optionally a list of interfaces used by the module.
36 #               This file contains a default list of interfaces.
37 #
38 # FIRMWS        Firmware module in the form filename:shortname:version
39 #
40 # +++ targets +++
41 #
42 #       install:
43 #               install the kernel module and its manual pages; if the Makefile
44 #               does not itself define the target install, the targets
45 #               beforeinstall and afterinstall may also be used to cause
46 #               actions immediately before and after the install target
47 #               is executed.
48 #
49 #       load:
50 #               Load KLD.
51 #
52 #       unload:
53 #               Unload KLD.
54 #
55 # bsd.obj.mk: clean, cleandir and obj
56 # bsd.dep.mk: cleandepend, depend and tags
57 #
58
59 OBJCOPY?=       objcopy
60 KMODLOAD?=      /sbin/kldload
61 KMODUNLOAD?=    /sbin/kldunload
62
63 KMODDIR?=       ${DESTKERNDIR}
64 KMODOWN?=       ${BINOWN}
65 KMODGRP?=       ${BINGRP}
66 KMODMODE?=      ${BINMODE}
67
68 .include <bsd.init.mk>
69
70 .SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S
71
72 CFLAGS+=        ${COPTS} -D_KERNEL ${CWARNFLAGS}
73 CFLAGS+=        -DKLD_MODULE
74
75 # Don't use any standard include directories.
76 # Since -nostdinc will annull any previous -I paths, we repeat all
77 # such paths after -nostdinc.  It doesn't seem to be possible to
78 # add to the front of `make' variable.
79 #
80 # Don't use -I- anymore, source-relative includes are desireable.
81 _ICFLAGS:=      ${CFLAGS:M-I*}
82 CFLAGS+=        -nostdinc ${_ICFLAGS}
83
84 # Add -I paths for system headers.  Individual KLD makefiles don't
85 # need any -I paths for this.  Similar defaults for .PATH can't be
86 # set because there are no standard paths for non-headers.
87 #
88 # NOTE!  Traditional architecture paths such as <i386/i386/blah.h>
89 # must run through the "machine_base" softlink using 
90 # <machine_base/i386/blah.h>.  An explicit cross-architecture path must
91 # operate relative to /usr/src/sys using e.g. <arch/i386/i386/blah.h>
92 #
93 CFLAGS+=        -I. -I@
94
95 # Add -I paths for headers in the kernel build directory
96 #
97 .if defined(BUILDING_WITH_KERNEL)
98 CFLAGS+=        -I${BUILDING_WITH_KERNEL}
99 _MACHINE_FWD=   ${BUILDING_WITH_KERNEL}
100 .else
101 .if defined(MAKEOBJDIRPREFIX)
102 _MACHINE_FWD=   ${MAKEOBJDIRPREFIX}/${SYSDIR}/forwarder_${MACHINE_ARCH}
103 .else
104 _MACHINE_FWD=   ${.OBJDIR}/forwarder_${MACHINE_ARCH}
105 CLEANDIRS+=     ${_MACHINE_FWD}
106 .endif
107 .endif
108 CFLAGS+=        -I${_MACHINE_FWD}/include
109 .include "kern.fwd.mk"
110
111 # Add a -I path to standard headers like <stddef.h>.  Use a relative
112 # path to src/include if possible.  If the @ symlink hasn't been built
113 # yet, then we can't tell if the relative path exists.  Add both the
114 # potential relative path and an absolute path in that case.
115 .if exists(@)
116 .if exists(@/../include)
117 CFLAGS+=        -I@/../include
118 .else
119 CFLAGS+=        -I${DESTDIR}/usr/include
120 .endif
121 .else # !@
122 CFLAGS+=        -I@/../include -I${DESTDIR}/usr/include
123 .endif # @
124
125 .if defined(BUILDING_WITH_KERNEL) && \
126     exists(${BUILDING_WITH_KERNEL}/opt_global.h)
127 CFLAGS+=        -include ${BUILDING_WITH_KERNEL}/opt_global.h
128 .endif
129
130 CFLAGS+=        ${DEBUG_FLAGS}
131 .if ${MACHINE_ARCH} == x86_64
132 CFLAGS+=        -fno-omit-frame-pointer
133 .endif
134
135 .include <bsd.patch.mk>
136
137 .if defined(FIRMWS)
138 AWK=/usr/bin/awk
139 .if !exists(@)
140 ${KMOD:S/$/.c/}: @
141 .else
142 ${KMOD:S/$/.c/}: @/tools/fw_stub.awk
143 .endif
144         ${AWK} -f @/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
145             ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
146
147 SRCS+=  ${KMOD:S/$/.c/}
148 CLEANFILES+=    ${KMOD:S/$/.c/}
149
150 .for _firmw in ${FIRMWS}
151 ${_firmw:C/\:.*$/.fwo/}:        ${_firmw:C/\:.*$//}
152         @${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
153         @if [ -e ${_firmw:C/\:.*$//} ]; then                    \
154                 ${LD} -b binary --no-warn-mismatch ${LDFLAGS}   \
155                     -r -d -o ${.TARGET} ${_firmw:C/\:.*$//};    \
156         else                                                    \
157                 ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
158                 ${LD} -b binary --no-warn-mismatch ${LDFLAGS}   \
159                     -r -d -o ${.TARGET} ${_firmw:C/\:.*$//};    \
160                 rm ${_firmw:C/\:.*$//};                         \
161         fi
162
163 OBJS+=  ${_firmw:C/\:.*$/.fwo/}
164 .endfor
165 .endif
166
167 OBJS+=  ${SRCS:N*.h:N*.patch:R:S/$/.o/g}
168
169 .if !defined(PROG)
170 PROG=   ${KMOD}.ko
171 .endif
172
173 .if ${MACHINE_ARCH} != x86_64
174 ${PROG}: ${KMOD}.kld
175         ${LD} -Bshareable ${LDFLAGS} -o ${.TARGET} ${KMOD}.kld
176 .endif
177
178 .if ${MACHINE_ARCH} != x86_64
179 ${KMOD}.kld: ${OBJS}
180         ${LD} ${LDFLAGS} -r -o ${.TARGET} ${OBJS}
181 .else
182 ${PROG}: ${OBJS}
183         ${LD} ${LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
184 .endif
185
186 # links to platform and cpu architecture include files.  If we are
187 # building with a kernel these already exist in the kernel build dir.
188 # '@' is a link to the system source.
189 .if defined(BUILDING_WITH_KERNEL)
190 _ILINKS=@
191 .else
192 _ILINKS=@ machine_base machine cpu_base cpu
193 .endif
194
195 .if defined(ARCH)
196 _ILINKS+=${ARCH}
197 .endif
198
199 all: objwarn fwheaders ${PROG}
200
201 beforedepend: fwheaders
202 fwheaders: ${_ILINKS} ${FORWARD_HEADERS_COOKIE}
203 # Ensure that the links exist without depending on it when it exists which
204 # causes all the modules to be rebuilt when the directory pointed to changes.
205 .for _link in ${_ILINKS}
206 .if !exists(${.OBJDIR}/${_link})
207 ${OBJS}: ${_link}
208 .endif
209 .endfor
210
211 # Search for kernel source tree in standard places.
212 .for _dir in ${.CURDIR}/../.. ${.CURDIR}/../../.. ${.CURDIR}/../../../.. /sys /usr/src/sys
213 .if !defined(SYSDIR) && exists(${_dir}/kern/)
214 SYSDIR= ${_dir}
215 .endif
216 .endfor
217 .if !defined(SYSDIR) || !exists(${SYSDIR}/kern)
218 .error "can't find kernel source tree"
219 .endif
220 S=      ${SYSDIR}
221
222 #       path=`(cd $$path && /bin/pwd)` ; 
223
224 ${_ILINKS}:
225         @case ${.TARGET} in \
226         machine) \
227                 path=${SYSDIR}/platform/${MACHINE_PLATFORM}/include ;; \
228         machine_base) \
229                 path=${SYSDIR}/platform/${MACHINE_PLATFORM} ;; \
230         cpu) \
231                 path=${SYSDIR}/cpu/${MACHINE_ARCH}/include ;; \
232         cpu_base) \
233                 path=${SYSDIR}/cpu/${MACHINE_ARCH} ;; \
234         @) \
235                 path=${SYSDIR} ;; \
236         arch_*) \
237                 path=${.CURDIR}/${MACHINE_ARCH} ;; \
238         esac ; \
239         ${ECHO} ${.TARGET} "->" $$path ; \
240         ${LN} -s $$path ${.TARGET}
241
242 CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS} ${_ILINKS} symb.tmp tmp.o
243
244 .if !target(install)
245
246 _INSTALLFLAGS:= ${INSTALLFLAGS}
247 .for ie in ${INSTALLFLAGS_EDIT}
248 _INSTALLFLAGS:= ${_INSTALLFLAGS${ie}}
249 .endfor
250
251 .if !target(realinstall)
252 realinstall: _kmodinstall
253 .ORDER: beforeinstall _kmodinstall
254 _kmodinstall:
255 .if defined(INSTALLSTRIPPEDMODULES)
256         ${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
257             ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}
258         ${OBJCOPY} --strip-debug ${DESTDIR}${KMODDIR}/${PROG}
259 .else
260         ${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
261             ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}
262 .endif
263 .endif # !target(realinstall)
264
265 .include <bsd.links.mk>
266
267 .endif # !target(install)
268
269 .if !target(load)
270 load:   ${PROG}
271         ${KMODLOAD} -v ./${KMOD}.ko
272 .endif
273
274 .if !target(unload)
275 unload:
276         ${KMODUNLOAD} -v ${KMOD}
277 .endif
278
279 .for _src in ${SRCS:Mopt_*.h} ${SRCS:Muse_*.h}
280 CLEANFILES+=    ${_src}
281 .if !target(${_src})
282 .if defined(BUILDING_WITH_KERNEL) && exists(${BUILDING_WITH_KERNEL}/${_src})
283 ${_src}: ${BUILDING_WITH_KERNEL}/${_src}
284 # we do not have to copy these files any more, the kernel build
285 # directory is included in the path now.
286 #       cp ${BUILDING_WITH_KERNEL}/${_src} ${.TARGET}
287 .else
288 ${_src}:
289         touch ${.TARGET}
290 .endif  # BUILDING_WITH_KERNEL
291 .endif
292 .endfor
293
294 MFILES?= kern/bus_if.m kern/device_if.m bus/iicbus/iicbb_if.m \
295     bus/iicbus/iicbus_if.m bus/isa/isa_if.m dev/netif/mii_layer/miibus_if.m \
296     bus/pccard/card_if.m bus/pccard/power_if.m bus/pci/pci_if.m \
297     bus/pci/pcib_if.m \
298     bus/ppbus/ppbus_if.m bus/smbus/smbus_if.m bus/usb/usb_if.m \
299     dev/acpica5/acpi_if.m dev/disk/nata/ata_if.m \
300     dev/sound/pcm/ac97_if.m dev/sound/pcm/channel_if.m \
301     dev/sound/pcm/feeder_if.m dev/sound/pcm/mixer_if.m \
302     libiconv/iconv_converter_if.m dev/agp/agp_if.m opencrypto/cryptodev_if.m \
303     bus/mmc/mmcbus_if.m bus/mmc/mmcbr_if.m
304
305 .for _srcsrc in ${MFILES}
306 .for _ext in c h
307 .for _src in ${SRCS:M${_srcsrc:T:R}.${_ext}}
308 CLEANFILES+=    ${_src}
309 .if !target(${_src})
310 ${_src}: @
311 .if exists(@)
312 ${_src}: @/tools/makeobjops.awk @/${_srcsrc}
313 .endif
314
315 .if defined(BUILDING_WITH_KERNEL) && \
316     exists(${BUILDING_WITH_KERNEL}/${_src})
317 .else
318         awk -f @/tools/makeobjops.awk -- -${_ext} @/${_srcsrc}
319 .endif
320 .endif
321 .endfor # _src
322 .endfor # _ext
323 .endfor # _srcsrc
324
325 #.for _ext in c h
326 #.if ${SRCS:Mvnode_if.${_ext}} != ""
327 #CLEANFILES+=   vnode_if.${_ext}
328 #vnode_if.${_ext}: @
329 #.if exists(@)
330 #vnode_if.${_ext}: @/tools/vnode_if.awk @/kern/vnode_if.src
331 #.endif
332 #       awk -f @/tools/vnode_if.awk -- -${_ext} @/kern/vnode_if.src
333 #.endif
334 #.endfor
335
336 .if !empty(SRCS:Massym.s)
337 CLEANFILES+=    assym.s genassym.o
338 assym.s: genassym.o
339 .if defined(BUILDING_WITH_KERNEL)
340 genassym.o: opt_global.h
341 .endif
342 .if !exists(@)
343 assym.s: @
344 .else
345 assym.s: @/kern/genassym.sh
346 .endif
347         sh @/kern/genassym.sh genassym.o > ${.TARGET}
348 .if exists(@)
349 genassym.o: @/platform/${MACHINE_PLATFORM}/${MACHINE_ARCH}/genassym.c          
350 .endif
351 genassym.o: @ ${SRCS:Mopt_*.h}
352         ${CC} -c ${CFLAGS:N-fno-common:N-mcmodel=small} ${WERROR} \
353         @/platform/${MACHINE_PLATFORM}/${MACHINE_ARCH}/genassym.c
354 .endif
355
356 regress:
357
358 .include <bsd.dep.mk>
359
360 .if !exists(${DEPENDFILE})
361 ${OBJS}: ${SRCS:M*.h}
362 .endif
363
364 .include <bsd.obj.mk>
365 .include "bsd.kern.mk"
366
367 # Behaves like MODULE_OVERRIDE
368 .if defined(KLD_DEPS)
369 all: _kdeps_all
370 _kdeps_all: @
371 .for _mdep in ${KLD_DEPS}
372         cd ${SYSDIR}/${_mdep} && make all
373 .endfor
374 depend: _kdeps_depend
375 _kdeps_depend: @
376 .for _mdep in ${KLD_DEPS}
377         cd ${SYSDIR}/${_mdep} && make depend
378 .endfor
379 install: _kdeps_install
380 _kdeps_install: @
381 .for _mdep in ${KLD_DEPS}
382         cd ${SYSDIR}/${_mdep} && make install
383 .endfor
384 clean: _kdeps_clean
385 _kdeps_clean: @
386 .for _mdep in ${KLD_DEPS}
387         cd ${SYSDIR}/${_mdep} && make clean
388 .endfor
389 .endif