关于U-Boot源码顶层Makefile

一、先介绍一些基本的Makefile常用知识

 

 

1、显示命令

         通常，make会把其要执行的命令行在命令执行前输出到屏幕上。

用@字符在命令行前时	不用@字符时
@echo 正在编译XXX模块......	echo 正在编译XXX模块......
make执行时，会输出：   正在编译XXX模块......	make执行时，会输出：   echo 正在编译XXX模块...... 正在编译XXX模块......

如带入make参数“-n”或“--just-print”执行make时，只显示命令，不执行命令，这个功能很有利于我们调试我们的Makefile，看看我们书写的命令执行起来是什么样的。make参数“-s”或“--slient”则是全面禁止命令的显示。

 

2、取文件函数notdir

$(notdir ;)

功能：从文件名序列;中取出非目录部分。非目录部分指最后一个反斜杠（“/”）之后的部分

返回：返回文件名序列;的非目录部分。

示例：

$(notdir src/foo.c hacks)

返回值是“foo.c hacks”。

 

3、字符串替换函数——subst

$(subst ;,;,;)

功能：把字串;中的;字符串替换成;	返回：函数返回被替换过后的字符串。
示例：	$(subst ee,EE,feet on the street)

把“feet on the street”中的“ee”替换成“EE”，返回结果是“fEEt on the strEEt”。

 

4、error函数，语法为：

$(error ;)

         产生一个致命的错误，;是错误信息。error函数不会在一被使用就会产生错误信息，所以如果把其定义在某个变量中，并在后续的脚本中使用这个变量，也是可以的。如：

 

示例一：	示例二：
ifdef ERROR_001     $(error error is $(ERROR_001))     endif	ERR = $(error found an error!)     .PHONY: err    err: ; $(ERR)
示例一会在变量ERROR_001定义了后执行时产生error调用	而示例二则在目录err被执行时才发生error调用

 

5、if 函数

函数参数可两个，也可三个。表达式1为真执行表达式2，否则执行表达式3。语法为：

$(if 表达式1,表达式2)

或是：

$(if 表达式1,表达式2，表达式3)

示例：

OBJTREE    := $(if $(BUILD_DIR),$(BUILD_DIR),$(CURDIR))

如果 $(BUILD_DIR) 非空，则 OBJTREE := $(BUILD_DIR) ,否则 OBJTREE := $(CURDIR)

 

 

6、ifdef语法：

Ifdef

变量或表达式

如果变量或表达式返回值非空，表达式为真，否则为假。ifdef只测试一个变量是否有值，不会把变量扩展到另外一个变量去。

 

示例一：	示例二：
bar =     foo = $(bar)     ifdef foo     frobozz = yes     else     frobozz = no     endif	foo =     ifdef foo     frobozz = yes     else     frobozz = no     endif
“$(frobozz)”值是“yes”	“$(frobozz)”值是“no”

 

比较参数“arg1”和“arg2”的值是否相同，如果不同，则为真。

ifneq (;, ;)

ifneq ';' ';'

ifneq ";" ";"

ifneq ";" ';'

ifneq ';' ";"

判断O是否非空，若非空，判断O的起源定义与来自命令行是否一样，不一样，把O的起源定义赋给BUILD_DIR

ifdef O

ifeq ("$(origin O)", "command line")

BUILD_DIR := $(O)

endif

endif

 

7、origin函数

origin函数不像其它的函数，他并不操作变量的值，他只是告诉你你的这个变量是哪里来的？其语法是：

$(origin ;)

注意，;是变量的名字，不应该是引用。所以你最好不要在;中使用“$”字符。Origin函数会以其返回值来告诉你这个变量的“出生情况”，下面，是origin函数的返回值:

“undefined”

如果;从来没有定义过，origin函数返回这个值“undefined”。

“default”

如果;是一个默认的定义，比如“CC”这个变量，这种变量我们将在后面讲述。

“environment”

如果;是一个环境变量，并且当Makefile被执行时，“-e”参数没有被打开。

“file”

如果;这个变量被定义在Makefile中。

“command line”

如果;这个变量是被命令行定义的。

“override”

如果;是被override指示符重新定义的。

“automatic”

如果;是一个命令运行中的自动化变量。关于自动化变量将在后面讲述。

 

8、shell函数

shell函数的参数是操作系统Shell的命令。shell函数把执行操作系统命令后的输出作为函数返回。于是，可用操作系统命令以及字符串处理命令awk，sed等命令生成一个变量，如：

contents := $(shell cat foo)

files := $(shell echo *.c)

注意，这个函数会新生成一个Shell程序来执行命令，所以要注意其运行性能，如果Makefile中有一些比较复杂的规则，并大量使用这个函数，那么对于系统性能是有害的。特别是Makefile的隐晦的规则可能会让shell函数执行的次数比想像的多得多。

 

9、Makefile里的几种通配符：

“＝”左侧是变量，右侧是变量值，如：

foo = $(bar)，foo为变量，bar为变量foo值

 

“：＝”使用其定义变量时，前面的变量不能使用后面变量，如：

Y：＝ $(x) bar

x：＝ foo

all：

echo $(Y)

.PHONY all

执行该Makefile时

$ make -s all

bar

输出值为变量y的值，定义y值时x变量尚未定义，所以值为空。

 

“？＝”如果变量之前没被定义过，那变量值就被定义

 

“+＝”追加变量的值

 

#############################################################################################################################

 

 

二、Toplevel Makefile的简单分析：

 

###这是U-Boot1.1.6的顶层Makefile分析笔记,以smdk2410为例作简单介绍，删除了部分其它架构的代码 ###
###By HLinuxH 2011年4月18日  ###

###设置版本信息###
VERSION = 1
PATCHLEVEL = 1
SUBLEVEL = 6
EXTRAVERSION =
U_BOOT_VERSION = $(VERSION).$(PATCHLEVEL).$(SUBLEVEL)$(EXTRAVERSION)
VERSION_FILE = $(obj)include/version_autogenerated.h

####设置目标板CPU类型###
HOSTARCH := $(shell uname -m | \
    sed -e s/i.86/i386/ \
     -e s/sun4u/sparc64/ \
     -e s/arm.*/arm/ \
     -e s/sa110/arm/ \
     -e s/powerpc/ppc/ \
     -e s/macppc/ppc/)
###设置目标板操作系统类型###
HOSTOS := $(shell uname -s | tr '[:upper:]' '[:lower:]' | \
     sed -e 's/\(cygwin\).*/cygwin/')

export    HOSTARCH HOSTOS               #往下级Makefile传递HOSTARCH HOSTOS这两个变量

# Deal with colliding definitions from tcsh etc.
#用来处理来自tcsh的互相冲突的定义等等一般，shell可分两类。
#一类由 Bourne shell 衍生出来的包括sh，ksh，bash，与zsh。
#另一类由C shell衍生出来包括csh与tcsh。还有rc，有的认为它自成一类，有人认为该归类在Bourne shell。
VENDOR=                                 #开发商
#########################################################################
#U-boot 的编译过程可以支持向一个自己定义的路径生成最终的目标文件，这里提供了两种用法：
# U-boot build supports producing a object files to the separate external
# directory. Two use cases are supported:
#第一种用法：通过在终端执行命令make O=/dir(即你指定的生成的目标文件的存放目录)
# 1) Add O= to the make command line
# 'make O=/tmp/build all'
# 2) Set environement variable BUILD_DIR to point to the desired location
#第二种用法：通过设置环境变量来指定目标文件存放目录，如下所示：
# 'export BUILD_DIR=/tmp/build'
# 'make'
# The second approach can also be used with a MAKEALL script
#第二种方法也可以写成一个MAKEALL脚本，然后执行MAKEALL，如下所示:
# 'export BUILD_DIR=/tmp/build'
# './MAKEALL'
#命令行'O='设置会覆盖环境变量BUILD_DIR的设置
# Command line 'O=' setting overrides BUILD_DIR environent variable.
#如果都不采用上面两种方法，那么目标文件最终要存放到源码顶层目录，也就是U-BOOT顶层目录
# When none of the above methods is used the local build is performed and
# the object files are placed in the source directory.
#
###设置文件导出目录，默认在源码根目录下，一般没必要改。###
ifdef O                                 #判断变量'O' 在命令行中是否定义过
ifeq ("$(origin O)", "command line")    #如果变量'O' 在命令行中定义过
BUILD_DIR := $(O)                       #就把变量'O' 的值(目标文件存放目录)赋给BUILD_DIR
endif
endif

ifneq ($(BUILD_DIR),)
saved-output := $(BUILD_DIR)            #保存输出目录

# Attempt to create a output directory.
$(shell [ -d ${BUILD_DIR} ] || mkdir -p ${BUILD_DIR})  #如果目录不存在的话，建立一个输出目录

# Verify if it was successful.
BUILD_DIR := $(shell cd $(BUILD_DIR) && /bin/pwd)      #确认是否成功建立输出目录
$(if $(BUILD_DIR),,$(error output directory "$(saved-output)" does not exist))
                                        #不成功时，输出错误信息
endif # ifneq ($(BUILD_DIR),)

OBJTREE        := $(if $(BUILD_DIR),$(BUILD_DIR),$(CURDIR))
SRCTREE        := $(CURDIR)
TOPDIR        := $(SRCTREE)
LNDIR        := $(OBJTREE)
export    TOPDIR SRCTREE OBJTREE        #往下级Makefile传递前面所定义的目录路径

MKCONFIG    := $(SRCTREE)/mkconfig      #定义变量MKCONFIG值为源码目录下的脚本mkconfig
export MKCONFIG

ifneq ($(OBJTREE),$(SRCTREE))           #如果输出目录与源码目录不等，则标志REMOTE_BUILD项为1
REMOTE_BUILD     := 1
export REMOTE_BUILD
endif

# $(obj) and (src) are defined in config.mk but here in main Makefile
# we also need them before config.mk is included which is the case for
# some targets like unconfig, clean, clobber, distclean, etc.
ifneq ($(OBJTREE),$(SRCTREE))           #如果输出目录与源码根目录相等，则obj和src为空
obj := $(OBJTREE)/
src := $(SRCTREE)/
else
obj :=
src :=
endif
export obj src

#########################################################################
###关键字wildcard用于展开通配符，在这里好像不起什么作用###
ifeq ($(OBJTREE)/include/config.mk,$(wildcard $(OBJTREE)/include/config.mk))

# load ARCH, BOARD, and CPU configuration
include $(OBJTREE)/include/config.mk
export    ARCH CPU BOARD VENDOR SOC

###设置交叉编译工具目录，根据CPU类型为交叉编译工具加上相应的前缀###
ifndef CROSS_COMPILE
ifeq ($(HOSTARCH),ppc)
CROSS_COMPILE =
else
ifeq ($(ARCH),ppc)
CROSS_COMPILE = powerpc-linux-
endif
ifeq ($(ARCH),arm)
CROSS_COMPILE = arm-linux-            #一般我们都是用ARM的，改这个就可以了
endif
ifeq ($(ARCH),i386)
ifeq ($(HOSTARCH),i386)
CROSS_COMPILE =
else
CROSS_COMPILE = i386-linux-
endif
endif
ifeq ($(ARCH),mips)
CROSS_COMPILE = mips_4KC-
endif
ifeq ($(ARCH),nios)
CROSS_COMPILE = nios-elf-
endif
ifeq ($(ARCH),nios2)
CROSS_COMPILE = nios2-elf-
endif
ifeq ($(ARCH),m68k)
CROSS_COMPILE = m68k-elf-
endif
ifeq ($(ARCH),microblaze)
CROSS_COMPILE = mb-
endif
ifeq ($(ARCH),blackfin)
CROSS_COMPILE = bfin-elf-
endif
ifeq ($(ARCH),avr32)
CROSS_COMPILE = avr32-
endif
endif
endif

export    CROSS_COMPILE

# load other configuration
include $(TOPDIR)/config.mk

#########################################################################
# U-Boot objects....order is important (i.e. start must be first)
###OBJS变量的赋值，用于标识所有的.o文件（目标文件）依赖目标$(OBJS)###
OBJS = cpu/$(CPU)/start.o
ifeq ($(CPU),i386)
OBJS += cpu/$(CPU)/start16.o
OBJS += cpu/$(CPU)/reset.o
endif
ifeq ($(CPU),ppc4xx)
OBJS += cpu/$(CPU)/resetvec.o
endif
ifeq ($(CPU),mpc83xx)
OBJS += cpu/$(CPU)/resetvec.o
endif
ifeq ($(CPU),mpc85xx)
OBJS += cpu/$(CPU)/resetvec.o
endif
ifeq ($(CPU),mpc86xx)
OBJS += cpu/$(CPU)/resetvec.o
endif
ifeq ($(CPU),bf533)
OBJS += cpu/$(CPU)/start1.o    cpu/$(CPU)/interrupt.o    cpu/$(CPU)/cache.o
OBJS += cpu/$(CPU)/cplbhdlr.o    cpu/$(CPU)/cplbmgr.o    cpu/$(CPU)/flush.o
endif

OBJS := $(addprefix $(obj),$(OBJS))
###LIBS变量的赋值，用于标识所有的.a文件（库文件）。###
###依赖目标$(LIBS)，这个目标太多，都是每个子目录的库文件*.a ，通过执行相应子目录下的make来完成###
LIBS = lib_generic/libgeneric.a
LIBS += board/$(BOARDDIR)/lib$(BOARD).a
LIBS += cpu/$(CPU)/lib$(CPU).a
ifdef SOC
LIBS += cpu/$(CPU)/$(SOC)/lib$(SOC).a
endif
LIBS += lib_$(ARCH)/lib$(ARCH).a
LIBS += fs/cramfs/libcramfs.a fs/fat/libfat.a fs/fdos/libfdos.a fs/jffs2/libjffs2.a \
    fs/reiserfs/libreiserfs.a fs/ext2/libext2fs.a
LIBS += net/libnet.a
LIBS += disk/libdisk.a
LIBS += rtc/librtc.a
LIBS += dtt/libdtt.a
LIBS += drivers/libdrivers.a
LIBS += drivers/nand/libnand.a
LIBS += drivers/nand_legacy/libnand_legacy.a
LIBS += drivers/sk98lin/libsk98lin.a
LIBS += post/libpost.a post/cpu/libcpu.a
LIBS += common/libcommon.a
LIBS += $(BOARDLIBS)

LIBS := $(addprefix $(obj),$(LIBS))
.PHONY : $(LIBS)                   #.PHONY指明LIBS为伪目标

# Add GCC lib
###-L指定库搜索路径，-l指定需要链接的库libgcc.a或者是libgcc.so###
PLATFORM_LIBS += -L $(shell dirname `$(CC) $(CFLAGS) -print-libgcc-file-name`) -lgcc

# The "tools" are needed early, so put this first
# Don't include stuff already done in $(LIBS)
SUBDIRS    = tools \            #执行tools ,examples ,post,post\cpu 子目录下面的make文件。
     examples \
     post \
     post/cpu
.PHONY : $(SUBDIRS)

ifeq ($(CONFIG_NAND_U_BOOT),y)
NAND_SPL = nand_spl
U_BOOT_NAND = $(obj)u-boot-nand.bin
endif

__OBJS := $(subst $(obj),,$(OBJS))
__LIBS := $(subst $(obj),,$(LIBS))

#########################################################################
#########################################################################
###ALL为生成的目标文件，在这里，可以添加生成反汇编文件的代码###
ALL = $(obj)u-boot.srec $(obj)u-boot.bin $(obj)System.map $(U_BOOT_NAND)
###伪定义用于生成$(ALL)指定的文件###
all:        $(ALL)

$(obj)u-boot.hex:    $(obj)u-boot
        $(OBJCOPY) ${OBJCFLAGS} -O ihex $< $@

$(obj)u-boot.srec:    $(obj)u-boot
        $(OBJCOPY) ${OBJCFLAGS} -O srec $< $@

$(obj)u-boot.bin:    $(obj)u-boot
        $(OBJCOPY) ${OBJCFLAGS} -O binary $< $@

$(obj)u-boot.img:    $(obj)u-boot.bin
        ./tools/mkimage -A $(ARCH) -T firmware -C none \
        -a $(TEXT_BASE) -e 0 \
        -n $(shell sed -n -e 's/.*U_BOOT_VERSION//p' $(VERSION_FILE) | \
            sed -e 's/"[     ]*$$/ for $(BOARD) board"/') \
        -d $< $@

$(obj)u-boot.dis:    $(obj)u-boot
        $(OBJDUMP) -d $< > $@
###对于smdk2410,LDSCRIPT即连接脚本文件是board/smdk2410/u-boot.lds###
###定义了连接时各个目标文件是如何组织的###
$(obj)u-boot:        depend version $(SUBDIRS) $(OBJS) $(LIBS) $(LDSCRIPT)
        UNDEF_SYM=`$(OBJDUMP) -x $(LIBS) |sed -n -e 's/.*\(__u_boot_cmd_.*\)/-u\1/p'|sort|uniq`;\
        cd $(LNDIR) && $(LD) $(LDFLAGS) $$UNDEF_SYM $(__OBJS) \
            --start-group $(__LIBS) --end-group $(PLATFORM_LIBS) \
            -Map u-boot.map -o u-boot

$(OBJS):
        $(MAKE) -C cpu/$(CPU) $(if $(REMOTE_BUILD),$@,$(notdir $@))

$(LIBS):
        $(MAKE) -C $(dir $(subst $(obj),,$@))

$(SUBDIRS):
        $(MAKE) -C $@ all

$(NAND_SPL):    version
        $(MAKE) -C nand_spl/board/$(BOARDDIR) all

$(U_BOOT_NAND):    $(NAND_SPL) $(obj)u-boot.bin
        cat $(obj)nand_spl/u-boot-spl-16k.bin $(obj)u-boot.bin > $(obj)u-boot-nand.bin
###在版本文件VERSION_FILE中生成版本信息###
version:
        @echo -n "#define U_BOOT_VERSION \"U-Boot " > $(VERSION_FILE); \
        echo -n "$(U_BOOT_VERSION)" >> $(VERSION_FILE); \
        echo -n $(shell $(CONFIG_SHELL) $(TOPDIR)/tools/setlocalversion \
             $(TOPDIR)) >> $(VERSION_FILE); \
        echo "\"" >> $(VERSION_FILE)

gdbtools:
        $(MAKE) -C tools/gdb all || exit 1

updater:
        $(MAKE) -C tools/updater all || exit 1

env:
        $(MAKE) -C tools/env all || exit 1
###生成各个子目录的.depend文件（各个目标文件的依赖文件）。###
###生成方法：调用每个子目录的make _depend。###
depend dep:
        for dir in $(SUBDIRS) ; do $(MAKE) -C $$dir _depend ; done

tags ctags:
        ctags -w -o $(OBJTREE)/ctags `find $(SUBDIRS) include \
                lib_generic board/$(BOARDDIR) cpu/$(CPU) lib_$(ARCH) \
                fs/cramfs fs/fat fs/fdos fs/jffs2 \
                net disk rtc dtt drivers drivers/sk98lin common \
            \( -name CVS -prune \) -o \( -name '*.[ch]' -print \)`

etags:
        etags -a -o $(OBJTREE)/etags `find $(SUBDIRS) include \
                lib_generic board/$(BOARDDIR) cpu/$(CPU) lib_$(ARCH) \
                fs/cramfs fs/fat fs/fdos fs/jffs2 \
                net disk rtc dtt drivers drivers/sk98lin common \
            \( -name CVS -prune \) -o \( -name '*.[ch]' -print \)`

$(obj)System.map:    $(obj)u-boot
        @$(NM) $< | \
        grep -v '\(compiled\)\|\(\.o$$\)\|\( [aUw] \)\|\(\.\.ng$$\)\|\(LASH[RL]DI\)' | \
        sort > $(obj)System.map

#########################################################################
else
all $(obj)u-boot.hex $(obj)u-boot.srec $(obj)u-boot.bin \
$(obj)u-boot.img $(obj)u-boot.dis $(obj)u-boot \
$(SUBDIRS) version gdbtools updater env depend \
dep tags ctags etags $(obj)System.map:
    @echo "System not configured - see README" >&2
    @ exit 1
endif

.PHONY : CHANGELOG
CHANGELOG:
    git log --no-merges U-Boot-1_1_5.. | \
    unexpand -a | sed -e 's/\s\s*$$//' > $@

#########################################################################
###每次进行重新配置的时候都要执行下面的这段代码, 用于清除上个工程留下的文件###
unconfig:
    @rm -f $(obj)include/config.h $(obj)include/config.mk \
        $(obj)board/*/config.tmp $(obj)board/*/*/config.tmp

###中间部分删除很多其它架构的代码，方便分析###
#========================================================================
# ARM
#========================================================================

###中间部分删除很多其它架构的代码，方便分析###

########################################################################
## ARM Integrator boards - see doc/README-integrator for more info.

###中间部分删除很多其它架构的代码，方便分析###

###用来配置smdk2410目标板的命令###
smdk2410_config    :    unconfig
    @$(MKCONFIG) $(@:_config=) arm arm920t smdk2410 NULL s3c24x0

###说明：
###    arm: CPU的架构(ARCH)
###    arm920t: CPU的类型(CPU)，其对应于cpu/arm920t子目录
###    smdk2410: 开发板的型号(BOARD)，对应于board/smdk2410目录
###    NULL: 开发者/或经销商(vender)
###    s3c24x0: 片上系统(SOC)

###中间部分删除很多其它架构的代码，方便分析###

#########################################################################
#########################################################################
#########################################################################
###clean是伪目标，用于清除编译产生的一些文件###
clean:
    find $(OBJTREE) -type f \
        \( -name 'core' -o -name '*.bak' -o -name '*~' \
        -o -name '*.o' -o -name '*.a' \) -print \
        | xargs rm -f
    rm -f $(obj)examples/hello_world $(obj)examples/timer \
     $(obj)examples/eepro100_eeprom $(obj)examples/sched \
     $(obj)examples/mem_to_mem_idma2intr $(obj)examples/82559_eeprom \
     $(obj)examples/smc91111_eeprom $(obj)examples/interrupt \
     $(obj)examples/test_burst
    rm -f $(obj)tools/img2srec $(obj)tools/mkimage $(obj)tools/envcrc \
        $(obj)tools/gen_eth_addr
    rm -f $(obj)tools/mpc86x_clk $(obj)tools/ncb
    rm -f $(obj)tools/easylogo/easylogo $(obj)tools/bmp_logo
    rm -f $(obj)tools/gdb/astest $(obj)tools/gdb/gdbcont $(obj)tools/gdb/gdbsend
    rm -f $(obj)tools/env/fw_printenv $(obj)tools/env/fw_setenv
    rm -f $(obj)board/cray/L1/bootscript.c $(obj)board/cray/L1/bootscript.image
    rm -f $(obj)board/netstar/eeprom $(obj)board/netstar/crcek $(obj)board/netstar/crcit
    rm -f $(obj)board/netstar/*.srec $(obj)board/netstar/*.bin
    rm -f $(obj)board/trab/trab_fkt $(obj)board/voiceblue/eeprom
    rm -f $(obj)board/integratorap/u-boot.lds $(obj)board/integratorcp/u-boot.lds
    rm -f $(obj)include/bmp_logo.h
    rm -f $(obj)nand_spl/u-boot-spl $(obj)nand_spl/u-boot-spl.map

clobber:    clean
    find $(OBJTREE) -type f \( -name .depend \
        -o -name '*.srec' -o -name '*.bin' -o -name u-boot.img \) \
        -print0 \
        | xargs -0 rm -f
    rm -f $(OBJS) $(obj)*.bak $(obj)ctags $(obj)etags $(obj)TAGS $(obj)include/version_autogenerated.h
    rm -fr $(obj)*.*~
    rm -f $(obj)u-boot $(obj)u-boot.map $(obj)u-boot.hex $(ALL)
    rm -f $(obj)tools/crc32.c $(obj)tools/environment.c $(obj)tools/env/crc32.c
    rm -f $(obj)tools/inca-swap-bytes $(obj)cpu/mpc824x/bedbug_603e.c
    rm -f $(obj)include/asm/proc $(obj)include/asm/arch $(obj)include/asm
    [ ! -d $(OBJTREE)/nand_spl ] || find $(obj)nand_spl -lname "*" -print | xargs rm -f

ifeq ($(OBJTREE),$(SRCTREE))
mrproper \
distclean:    clobber unconfig
else
mrproper \
distclean:    clobber unconfig
    rm -rf $(OBJTREE)/*
endif

backup:
    F=`basename $(TOPDIR)` ; cd .. ; \
    gtar --force-local -zcvf `date "+$$F-%Y-%m-%d-%T.tar.gz"` $$F

#########################################################################

 

 

#############################################################################################################################

整理了几天，终于整完了，有点困，小睡一会。By HLinuxH 2011.4.18

#############################################################################################################################