ixgbe/base: update readme
[dpdk.git] / mk / rte.module.mk
1 #   BSD LICENSE
2 #
3 #   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
4 #   All rights reserved.
5 #
6 #   Redistribution and use in source and binary forms, with or without
7 #   modification, are permitted provided that the following conditions
8 #   are met:
9 #
10 #     * Redistributions of source code must retain the above copyright
11 #       notice, this list of conditions and the following disclaimer.
12 #     * Redistributions in binary form must reproduce the above copyright
13 #       notice, this list of conditions and the following disclaimer in
14 #       the documentation and/or other materials provided with the
15 #       distribution.
16 #     * Neither the name of Intel Corporation nor the names of its
17 #       contributors may be used to endorse or promote products derived
18 #       from this software without specific prior written permission.
19 #
20 #   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 #   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 #   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 #   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 #   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 #   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 #   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 #   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 #   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
32 ##### if sourced from kernel Kbuild system
33 ifneq ($(KERNELRELEASE),)
34 override EXTRA_CFLAGS = $(MODULE_CFLAGS) $(EXTRA_KERNEL_CFLAGS)
35 obj-m          += $(MODULE).o
36 ifneq ($(MODULE),$(notdir $(SRCS-y:%.c=%)))
37 $(MODULE)-objs += $(notdir $(SRCS-y:%.c=%.o))
38 endif
39
40 ##### if launched from rte build system
41 else
42
43 include $(RTE_SDK)/mk/internal/rte.install-pre.mk
44 include $(RTE_SDK)/mk/internal/rte.clean-pre.mk
45 include $(RTE_SDK)/mk/internal/rte.build-pre.mk
46 include $(RTE_SDK)/mk/internal/rte.depdirs-pre.mk
47
48 # VPATH contains at least SRCDIR
49 VPATH += $(SRCDIR)
50
51 _BUILD = $(MODULE).ko
52 _INSTALL = $(INSTALL-FILES-y) $(SYMLINK-FILES-y) \
53         $(RTE_OUTPUT)/kmod/$(MODULE).ko
54 _CLEAN = doclean
55
56 SRCS_LINKS = $(addsuffix _link,$(SRCS-y))
57
58 compare = $(strip $(subst $(1),,$(2)) $(subst $(2),,$(1)))
59
60 .PHONY: all
61 all: install
62
63 .PHONY: install
64 install: build _postinstall
65
66 _postinstall: build
67
68 .PHONY: build
69 build: _postbuild
70
71 # Link all sources in build directory
72 %_link: FORCE
73         $(if $(call compare,$(notdir $*),$*),\
74         @if [ ! -f $(notdir $(*)) ]; then ln -nfs $(SRCDIR)/$(*) . ; fi,\
75         @if [ ! -f $(notdir $(*)) ]; then ln -nfs $(SRCDIR)/$(*) . ; fi)
76
77 # build module
78 $(MODULE).ko: $(SRCS_LINKS)
79         @if [ ! -f $(notdir Makefile) ]; then ln -nfs $(SRCDIR)/Makefile . ; fi
80         @$(MAKE) -C $(RTE_KERNELDIR) M=$(CURDIR) O=$(RTE_KERNELDIR) \
81                 CC="$(KERNELCC)" CROSS_COMPILE=$(CROSS) V=$(if $V,1,0)
82
83 # install module in $(RTE_OUTPUT)/kmod
84 $(RTE_OUTPUT)/kmod/$(MODULE).ko: $(MODULE).ko
85         @echo INSTALL-MODULE $(MODULE).ko
86         @[ -d $(RTE_OUTPUT)/kmod ] || mkdir -p $(RTE_OUTPUT)/kmod
87         @cp -f $(MODULE).ko $(RTE_OUTPUT)/kmod
88
89 # install module
90 modules_install:
91         @$(MAKE) -C $(RTE_KERNELDIR) M=$(CURDIR) O=$(RTE_KERNELDIR) \
92                 modules_install
93
94 .PHONY: clean
95 clean: _postclean
96
97 # do a make clean and remove links
98 .PHONY: doclean
99 doclean:
100         @if [ ! -f $(notdir Makefile) ]; then ln -nfs $(SRCDIR)/Makefile . ; fi
101         $(Q)$(MAKE) -C $(RTE_KERNELDIR) M=$(CURDIR) O=$(RTE_KERNELDIR) clean
102         @$(foreach FILE,$(SRCS-y) $(SRCS-n) $(SRCS-),\
103                 if [ -h $(notdir $(FILE)) ]; then rm -f $(notdir $(FILE)) ; fi ;)
104         @if [ -h $(notdir Makefile) ]; then rm -f $(notdir Makefile) ; fi
105         @rm -f $(_BUILD_TARGETS) $(_INSTALL_TARGETS) $(_CLEAN_TARGETS) \
106                 $(INSTALL-FILES-all)
107
108 include $(RTE_SDK)/mk/internal/rte.install-post.mk
109 include $(RTE_SDK)/mk/internal/rte.clean-post.mk
110 include $(RTE_SDK)/mk/internal/rte.build-post.mk
111 include $(RTE_SDK)/mk/internal/rte.depdirs-post.mk
112
113 .PHONY: FORCE
114 FORCE:
115
116 endif