Uboot顶层Makefile分析

转自：http://blog.csdn.net/zsy2020314/article/details/9309995

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

# (C) Copyright 2000-2012
# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
#
# See file CREDITS for list of people who contributed to this
# project.
#
# This program is free software; you can redistribute itand/or
# modify it under the terms of the GNU General Public Licenseas
# published by the Free Software Foundation; either version 2of
# the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will beuseful,
# but WITHOUT ANY WARRANTY; without even the implied warrantyof
# MERCHANTABILITY or FITNESS FOR A PARTICULARPURPOSE. 

   Seethe
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General PublicLicense
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA 02111-1307 USA

#########################################################################
# 从2008年10月，发行版的名称的含义发生了变化,从数字版本号变为使用时间戳作为版本号,
# 即使用发布年份和月份确定发布的版本号(VERSION和PATCHLEVEL),
# 额外的字段(SUBLEVEL和EXTRAVERSION)表示候选发布版或修复bug了的稳定版本
#
# 例子：
# U-Bootv2012.10      - 2012年10月发行版
# U-Bootv2012.10.1    -2012年10月稳定发行版1
# U-Boot v2012.10-rc1  - 2012年10月候选发行版1=

VERSION = 2012
PATCHLEVEL = 10
SUBLEVEL =
EXTRAVERSION =

#########################################################################
#如果子段SUBLEVEL不为空,则U_BOOT_VERSION=主版本号.补丁包号.子段+额外版本字段(例如:2012.10.1)
# 否则U_BOOT_VERSION=主版本号.补丁包号+额外版本字段(例如:2012.10-rc1)
ifneq "$(SUBLEVEL)" ""
U_BOOT_VERSION =$(VERSION).$(PATCHLEVEL).$(SUBLEVEL)$(EXTRAVERSION)
else
U_BOOT_VERSION = $(VERSION).$(PATCHLEVEL)$(EXTRAVERSION)
endif

#########################################################################
# 指定时间信息头文件 和 版本信息头文件
TIMESTAMP_FILE =$(obj)include/generated/timestamp_autogenerated.h
VERSION_FILE =$(obj)include/generated/version_autogenerated.h

# HOSTARCH这个变量的赋值,是通过执行一套shell程序来完成的,其中$(shellxxx)的语法就是在shell中执行xxx的命令.
# 这里的'|'就是linux中的管道处理符,'\'就是换行的连接符，表示下一行与本行是同行程序处理. uname-m，就是得到
# machine hardware name，中文翻译成机器硬件名。
# sed -e的意思，选项允许在同一行里执行多条命令，就是表示后面跟的是一串命令脚本，s/abc/def/的命令表达式，
# 就是表示要从标准输入中，查找到内容为abc的，然后替换成def。例如电脑使用Intel Core2系列的CPU，因此"uname–m"
# 输出"i686"。 "i686"可以匹配命令"sed -es/i.86/i386/"中的"i.86"，因此在执行Makefile时，HOSTARCH将被设置成"i386" 。
# 这样执行这一套程序下来，就知道了机器的硬件体系了。
HOSTARCH := $(shell uname -m | \
    sed -es/i.86/x86/ \
       -es/sun4u/sparc64/ \
       -es/arm.*/arm/ \
       -es/sa110/arm/ \
       -es/ppc64/powerpc/ \
       -es/ppc/powerpc/ \
       -es/macppc/powerpc/\
       -es/sh.*/sh/)

#########################################################################
# "uname –s"输出主机内核名字，本人使用Linux发行版Ubuntu11.10，因此"uname–s"结果是"Linux"。
# "tr '[:upper:]' '[:lower:]'"作用是将标准输入中的所有大写字母转换为响应的小写字母。
# 因此执行结果是将HOSTOS 设置为"linux"
HOSTOS := $(shell uname -s | tr '[:upper:]' '[:lower:]' | \
       sed -e's/ cygwincygwin.*/cygwin/')

#########################################################################
# "

BASH"的作用实质上是生成了字符串"$BASH"（前一个$号的作用是指明第二个$是普通的字符）。 
#若执行当前Makefile的shell中定义了"$BASH"环境变量，且文件"$BASH"是可执行文件，则SHELL的值为"$BASH"。 
#否则，若"/bin/bash"是可执行文件，则SHELL值为"/bin/bash"。若以上两条都不成立，则将"sh"赋值给SHELL变量。 
SHELL := $(shell if [ -x "BASH"的作用实质上是生成了字符串"$BASH"（前一个$号的作用是指明第二个$是普通的字符）。 #若执行当前Makefile的shell中定义了"$BASH"环境变量，且文件"$BASH"是可执行文件，则SHELL的值为"$BASH"。 #否则，若"/bin/bash"是可执行文件，则SHELL值为"/bin/bash"。若以上两条都不成立，则将"sh"赋值给SHELL变量。 SHELL := $(shell if [ -x "

BASH" ]; then echo $$BASH; \
    else if [ -x/bin/bash ]; then echo /bin/bash; \
    else echosh; fi; fi)

#########################################################################
# export相当于C语言中的extern，把变量输出到全局，这样这些变量将设置为环境变量
# 注意:export的语意就是将自定义变量转成环境变量,在系统的任何地方你都可以使用这个变量!
export   HOSTARCH HOSTOS SHELL

# 定义生产厂家名
VENDOR=

#########################################################################
# 检查是否禁止在编译过程中向终端输出信息，利用findstring函数检查变量 MAKEFLAGS 是否为参数's'
# 当编译U-boot的时候，我们会输入make [选项] [目标] ...如果输入:make -s，则MAKEFLAGS =s
# XECHO = echo 编译时将输出编译信息，否则则安静编译,不用输出信息
ifeq (,$(findstring s,$(MAKEFLAGS)))
XECHO = echo
else
XECHO = :
endif

#########################################################################
#
# U-boot build supports producing a object files to the separateexternal
# directory. Two use cases are supported:
#
# 1) Add O= to the make command line
# 'make O=/tmp/build all'
#
# 2) Set environement variable BUILD_DIR to point to the desiredlocation
# 'export BUILD_DIR=/tmp/build'
# 'make'
#
# The second approach can also be used with a MAKEALL script
# 'export BUILD_DIR=/tmp/build'
# './MAKEALL'
#
# Command line 'O=' setting overrides BUILD_DIR environentvariable.
#
# When none of the above methods is used the local build isperformed and
# the object files are placed in the source directory.
#

#########################################################################
# U-boot支持定义源码及生成的目标文件存放的目录的功能。有两种方法可以实现：
# 1)指定编译参数 O=目录，例如:make O= /tmp/build all
# 2)设置环境变量BUILD_DIR，该变量指定目录并设置为设置为环境变量
#   例如:exportBUILD_DIR=/tmp/build 然后 make
# 第二种方法同样可以用在一个 MAKEALL脚本
# 例如:export BUILD_DIR=/tmp/build  然后执行之./MAKEALL
# 命令行参数的设置会覆盖到  BUILD_DIR这一环境变量
# 如果不指定任何目录，则编译生成的目标文件存放在源代码的顶层目录下
#
# 下面解释一下几行脚本，如果参数O不为空(即使用了O参数)，则利用函数origin返回的参数O的来源
# 函数$( origin, variable) 输出的结果是一个字符串，输出结果由变量variable定义的方式决定，
# 若variable在命令行中定义过，则origin函数返回值为"command line"。
# 假若在命令行中执行了“export BUILD_DIR=/tmp/build”的命令，则“$(originO)”值为“command line”，
# 而BUILD_DIR被设置为“/tmp/build”。
ifdef O
ifeq ("$(origin O)", "command line")
BUILD_DIR := $(O)
endif
endif

#########################################################################
# 如果BUILD_DIR不为空，也就是指定了创建目录，则把路径保存在saved-output中以备使用
ifneq ($(BUILD_DIR),)
saved-output := $(BUILD_DIR)

#########################################################################
# 判断BUILD_DIR变中存放的目录是否存在，如果不存在则创建目录
$(shell [ -d ${BUILD_DIR} ] || mkdir -p ${BUILD_DIR})

#########################################################################
# 接下来这一段就是执行cd命令，进入到新建的目录里，然后执行pwd命令来得到当前目录的真实位置。
#为什么需要这样做呢，因为前面的创建目录工作可能不成功，所以导致后面的cd命令也没有进去，所以需要后面的pwd命令来确认一下。
#接下来的if用了一个三段式的形式，#if(a,b,c)这样的形式，执行步骤为，先判断a的真假，如果为真，则执行b，如果为假，则执行c。
# 所以这里的意思就是判断目录建成没有建成，如果建成，则什么也不干，没建成，就使用error，输出错误信息且退出。
BUILD_DIR := $(shell cd $(BUILD_DIR) && /bin/pwd)
$(if $(BUILD_DIR),,$(error output directory "$(saved-output)" doesnot exist))
endif # ifneq ($(BUILD_DIR),)

#########################################################################
# 下面是普通的变量赋值，其它目录变量定义如下，OBJTREE和LNDIR为存放生成文件的目录，
# TOPDIR与SRCTREE为源码所在目录；CURDIR变量指示Make当前的工作目录，由于当前
# Make在U-Boot顶层目录执行Makefile，因此CURDIR此时就是U-Boot顶层目录。
# 例如U-boot源码在"/temp/bootloader/u-boot2012-10"目录中，则
# OBJTREE = SRCTREE = TOPDIR = LNDIR = /temp/bootloa
# 最后设置这些变量设置为环境变量
OBJTREE       := $(if$(BUILD_DIR),$(BUILD_DIR),$(CURDIR))
SPLTREE       :=$(OBJTREE)/spl
SRCTREE       :=$(CURDIR)
TOPDIR       :=$(SRCTREE)
LNDIR       :=$(OBJTREE)
export    TOPDIRSRCTREE OBJTREE SPLTREE

#########################################################################
# MKCONFIG指向源码根目录下的mkconfig脚本文件，并设置为设置为环境变量
MKCONFIG    :=$(SRCTREE)/mkconfig
export MKCONFIG

#########################################################################
# 如果存放生成文件的目录和源码目录一致则REMOTE_BUILD = 1，并设置为设置为环境变量
ifneq ($(OBJTREE),$(SRCTREE))
REMOTE_BUILD   := 1
export REMOTE_BUILD
endif

#########################################################################
# $(obj) and (src) are defined in config.mk but here in mainMakefile
# we also need them before config.mk is included which is the casefor
# some targets like unconfig, clean, clobber, distclean, etc.

#$(obj)和$(src)在config.mk中有定义，但是在包含config.mk之前主Makefile在执行某些目标
# 如unconfig, clean, clobber, distclean,etc等的时候同样需要$(obj)和$(src)
# 判断如果OBJTREE和SRCTREE不是同一个目录，则分别指定各自目录给obj和src，并设置为设置为环境变量
# obj = 编译文件的输出目录  src =U-boot代码的顶层目录，一般我们默认使用U-boot源码顶层目录
# 作为编译输出文件的存放目录，一般OBJTREE和SRCTREE是相同的路径，则obj和src为空
ifneq ($(OBJTREE),$(SRCTREE))
obj := $(OBJTREE)/
src := $(SRCTREE)/
else
obj :=
src :=
endif
export obj src

#########################################################################
# 把CDPATH变量设为文件私有，这佯做是为了防止冲突
unexport CDPATH

#########################################################################
# The "tools" are needed early, so put this first
# Don't include stuff already done in $(LIBS)
# The "examples" conditionally depend on U-Boot (say, whenUSE_PRIVATE_LIBGCC
# is "yes"), so compile examples after U-Boot is compiled.

#########################################################################
#　"tool"里边的工具是马上要用到的，所以把它放在首位。不要把已经做好的东西包含在$(LIBS)中，
#因为"examples"里边的例子是有条件(即,当USE_PRIVATE_LIBGCC为yes的时候)的依赖U-boot的，
# 所以U-Boot编译完成后再编译examples

SUBDIR_TOOLS = tools
SUBDIR_EXAMPLES = examples/standalone examples/api
SUBDIRS = $(SUBDIR_TOOLS)

#########################################################################
# 其中VERSION_FILE =$(obj)include/generated/version_autogenerated.h
# TIMESTAMP_FILE =$(obj)include/generated/timestamp_autogenerated.h
# 即前面定义的版本信息头文件和时间信息头文件 .PHONY修饰为为目标
.PHONY : $(SUBDIRS) $(VERSION_FILE) $(TIMESTAMP_FILE)

#########################################################################
# 检查一下include目录下是否存在config.mk文件，具体解释如下:wildcard函数是取匹配模式的文件名
# $(wildcard$(obj)include/config.mk)就会返回符合$(obj)include/config.mk的文件名
# 如果include下存在config.mk文件，则$(wildcard$(obj)include/config.mk)就会
# 返回$(obj)include/config.mk，如果不存在config.mk文件，则返回值为空，如此便完成了检查
# include目录下是否存在config.mk文件。
# 为什么要检查config.mk存在与否呢？原因是:我们在编译U-boot前必须配置目标板的信息，也就是要执行
# makexxx_config，xxx为目标板的名称，执行了这一步，会在$(obj)include/中生成一个config.mk
# 文件，里边一般记录有5个变量信息，这是U-boot必须获得的信息，没有它们U-boot就不能编译，会跳转到该
# ifeq的else分支执行，也就是提示错，else分支在文件尾部。
# 信息:System not configured - see README
#    make ***[all] error 1
# 所以如果没有make xxx_config，直接make是编译不过去的，通过这样的判断U-boot就知道你是否已经做过
# make xxx_config这一步了。(PS:一句ifeq可谓意味深长，巧妙至极!)
#
ifeq ($(obj)include/config.mk,$(wildcard$(obj)include/config.mk))

#########################################################################
# Include autoconf.mk before config.mk so that the config optionsare available
# to all top level build files.  We need the dummyall: target to prevent the
# dependency target in autoconf.mk.dep from being thedefault.

#########################################################################
# 在加载config.mk文件之前先加载autoconf.mk，这样就可以使配置选项对所有顶层编译文件有效。
# 我们要需要定义一个all:伪目标来防止autoconf.mk.dep中的依赖目标成为默认目标
#在include目录下：autoconf.mk文件中是一些和目标板相关的配置，autoconf.mk.dep则为一些列的
# .h头文件的包含
all:
sinclude $(obj)include/autoconf.mk.dep
sinclude $(obj)include/autoconf.mk

#########################################################################
#如果在config.mk中定义了CONFIG_SANDBOX选项，这把SUBDIR_EXAMPLES追加到SUBDIRS中
# 其中SUBDIR_EXAMPLES = examples/standalone examples/api
ifndef CONFIG_SANDBOX
SUBDIRS += $(SUBDIR_EXAMPLES)
endif

#########################################################################
# 加载$(obj)include/config.mk，导出ARCH CPU BOARD VENDOR SOC5个变量
# ARCH = 目标板的CPU架构   CPU =具体使用的CPU型号   BOARD =目标板名称  SOC = 芯片名称
# 例如:对于一个三星S5pv210的板子:ARCH=arm  CPU=CortexA8BOARD=HY210 SOC=S5pv210
include $(obj)include/config.mk
export    ARCHCPU BOARD VENDOR SOC

#########################################################################
# 判断如果宿主机的架构和目标板的架构是同一种架构，则CROSS_COMPILE为空，也即采用宿主机默认的交叉编译链
# 通常我们将目标板使用的交叉工具链安装好以后，在宿主机中设置环境变量，指定开发板使用的交叉编译链
# 如果不采用设置环境变量的方法，则应该在使用make的时候指定工具链，例如:makeCROSS_COMPILE=arm-linux-
ifeq ($(HOSTARCH),$(ARCH))
CROSS_COMPILE ?=
endif

#########################################################################
# 加载config.mk
include $(TOPDIR)/config.mk

#########################################################################
# If board code explicitly specified LDSCRIPT orCONFIG_SYS_LDSCRIPT, use
# that (or fail if absent).  Otherwise, search fora linker script in a
# standard location.

#########################################################################
# 如果板子代码明确指定了LDSCRIPT或者CONFIG_SYS_LDSCRIPT，则就使用(或则失败，如果不存在的话)
# 否则，在标准的位置中搜索链接脚本文件
LDSCRIPT_MAKEFILE_DIR = $(dir $(LDSCRIPT))

#########################################################################
# 这里LDSCRIPT和CONFIG_SYS_LDSCRIPT均没有定义，所以下面几句脚本均没执行。
# 注意：如果CONFIG_SYS_LDSCRIPT有定义也是在include/autoconf.mk中定义
ifndef LDSCRIPT
    #LDSCRIPT :=$(TOPDIR)/board/$(BOARDDIR)/u-boot.lds.debug
    ifdefCONFIG_SYS_LDSCRIPT
       # need tostrip off double quotes
       LDSCRIPT :=$(subst ",,$(CONFIG_SYS_LDSCRIPT))
    endif
endif

#########################################################################
# 如果没有指定链接脚本，接下来会从下面几个地方搜索:
ifndef LDSCRIPT
   #########################################################################
    #如果定义了CONFIG_NAND_U_BOOT,则在$(TOPDIR)/board/$(BOARDDIR)目录中搜索
    ifeq($(CONFIG_NAND_U_BOOT),y)
       LDSCRIPT :=$(TOPDIR)/board/$(BOARDDIR)/u-boot-nand.lds
       # ifeq($(wildcard$(LDSCRIPT)),)这句的意思是如果$(TOPDIR)/board/$(BOARDDIR)下
       #不存在u-boot-nand.lds文件，则转到$(TOPDIR)/$(CPUDIR)目录中去搜索u-boot-nand.lds文件
       ifeq($(wildcard $(LDSCRIPT)),)
          LDSCRIPT :=$(TOPDIR)/$(CPUDIR)/u-boot-nand.lds
       endif
    endif
   #########################################################################
    #如果上面定义了CONFIG_NAND_U_BOOT并且搜索到了u-boot-nand.lds的话，则后面几个
    # ifeq($(wildcard $(LDSCRIPT)),)均不执行，如果上面进行过了搜索而仍没有找到链接脚本的话
    #则继续在$(TOPDIR)/board/$(BOARDDIR)目录中搜索u-boot.lds文件(根据运行条件不同名称稍有不同哦^_^!)
    ifeq($(wildcard $(LDSCRIPT)),)
       LDSCRIPT :=$(TOPDIR)/board/$(BOARDDIR)/u-boot.lds
    endif
   #########################################################################
    #如果$(TOPDIR)/board/$(BOARDDIR)目录中没有u-boot.lds文件则转到$(TOPDIR)/$(CPUDIR)目录中去搜索
    ifeq($(wildcard $(LDSCRIPT)),)
       LDSCRIPT :=$(TOPDIR)/$(CPUDIR)/u-boot.lds
    endif
   #########################################################################
    #如果$(TOPDIR)/$(CPUDIR)目录中没有u-boot.lds文件则转到$(TOPDIR)/arch/$(ARCH)目录中去搜索