TQ210——S5PV210 uboot顶层mkconfig分析

#################################################################################################
# SHELL常用内部参数：　　
# $# —— 传递给程序的总的参数数目
# $? —— 上一个代码或者shell程序在shell中退出的情况，如果正常退出则返回0，反之为非0值。
# $* —— 传递给程序的所有参数组成的字符串。
# $n —— 表示第几个参数，$1 表示第一个参数，$2 表示第二个参数 ... 
# $0 —— 当前程序的名称
# $@ —— 以"参数1" "参数2" ... 形式保存所有参数
# $$ —— 本程序的(进程ID号)PID
# $! —— 上一个命令的PID 
# 下面对$?多做些说明，当补充shell知识吧
# 切记:$?永远表示shell命令最后一次执行后的退出状态,当函数执行完毕后,如果又执行了其它命
# 令，则$?不再表示函数执行后的状态,而表示其它命令的退出状态.
#-a  表示(and)两个条件同时成立
# -eq 表示两数值相等
# -gt 表示n1大于n2，即前面大于后面
# -lt 表示n1小于n2，即前面小于后面
# "\("  "\)"是对圆括号的转义,转成普通圆括号"()"来包裹条件表达式
# if[...]中的表达式意思为:如果传递给mkconfig的参数个数($#)等于2个并且第1个变量为
# "-A"($1)，则执行出错提示.那么$0,$1,$2,...是什么呢？我们看Makefile中是怎么执行make TQ210_config这个伪目标的.
###########################################################################
# 指定解释器，使用-e相当于 #! /bin/bash
#!/bin/sh -e

# Script to create header files and links to configure
# U-Boot for a specific board.
#
# Parameters:  Target  Architecture  CPU  Board [VENDOR] [SOC]
#
# (C) 2002-2006 DENX Software Engineering, Wolfgang Denk <wd@denx.de>
#
############################################################################
# 默认创建一个新的配置文件
# 执行make TQ210_config的时候打印输出单板名TQ210
APPEND=no	# Default: Create new config file
BOARD_NAME=""	# Name to print in make output

# SHELL的一些内部参数最开始有描述，以后不再多说！
############################################################################
# 执行make TQ210_config的时候，这个过程会调用uboot根目录下的mkconfig文件，
# 会有6个参数传入，如下
#   $0	       $1	    $2	  $3	 $4	      $5	   $6	 $# 
# mkconfig	 TQ210	   arm	s5pv210	TQ210	samsung	s5pv210	 6
#         BOARD_NAME   ARCH	  CPU	BOARD	 VENDOR	  SOC	
# $# -gt 0表示$#不为0时执行，显然这里不会执行。
# shift的作用是使$1=$2，$2=$3，$3=$4….，而原来的$1将丢失。因此while循环的作用是，
# 依次处理传递给mkconfig脚本的选项(--,-a,-n,-t,*)。由于我们并没有传递给mkconfig任何的选
# 项，因此while循环中的代码不起作用。
while [ $# -gt 0 ] ; do
	case "$1" in
	--) shift ; break ;;
	-a) shift ; APPEND=yes ;;
	-n) shift ; BOARD_NAME="${1%%_config}" ; shift ;;
	*)  break ;;
	esac
done

###########################################################################
# 如果BOARD_NAME为空则什么都不做；否则赋值为$1，即TQ210
# 此句赋值BOARD_NAME = TQ210
[ "${BOARD_NAME}" ] || BOARD_NAME="$1"
###########################################################################
# 检查如果传进来的变量个数，如果小于4个则退出，若大于6个也要退出
[ $# -lt 4 ] && exit 1
[ $# -gt 6 ] && exit 1

###########################################################################
# shell中打印出“Configuring for TQ210 board...”
echo "Configuring for ${BOARD_NAME} board..."

#
# Create link to architecture specific headers
#
###########################################################################
# 如果源码顶层目录(SRCTREE)和存放编译生成文件的目录(OBJTREE)不同就在
# 存放编译生成文件的目录(OBJTREE)建立两个文件include和include2
# 进入include2目录，删除asm文件夹
# 建立一个软连接asm，链接指向 ${SRCTREE}/include/asm-arm
# 然后到当前目录的上层目录进入include文件夹
# 删除asm-arm和asm文件夹
# 在当前目录创建asm-arm文件夹，建立软连接asm指向asm-arm
if [ "$SRCTREE" != "$OBJTREE" ] ; then
	mkdir -p ${OBJTREE}/include
	mkdir -p ${OBJTREE}/include2
	cd ${OBJTREE}/include2
	rm -f asm
	ln -s ${SRCTREE}/include/asm-$2 asm
	LNPREFIX="../../include2/asm/"
	cd ../include
	rm -rf asm-$2
	rm -f asm
	mkdir asm-$2
	ln -s asm-$2 asm
###########################################################################
# 如果源码顶层目录(SRCTREE)和存放编译生成文件的目录(OBJTREE)相同，
# 进入include目录，删除asm目录，建立一个软连接asm指向当前目录的asm-arm
# 
else
	cd ./include
	rm -f asm
	ln -s asm-$2 asm
fi

###########################################################################
# 删除asm-arm/arch，建立软连接实际上是对链接的目标进行操作，
rm -f asm-$2/arch

###########################################################################
#
if [ -z "$6" -o "$6" = "NULL" ] ; then
	ln -s ${LNPREFIX}arch-$3 asm-$2/arch
else
	ln -s ${LNPREFIX}arch-$6 asm-$2/arch
fi

# create link for s3c24xx SoC
if [ "$3" = "s3c24xx" ] ; then
	rm -f regs.h
	ln -s $6.h regs.h
	rm -f asm-$2/arch
	ln -s arch-$3 asm-$2/arch
fi

# create link for s3c64xx SoC
if [ "$3" = "s3c64xx" ] ; then
	rm -f regs.h
	ln -s $6.h regs.h
	rm -f asm-$2/arch
	ln -s arch-$3 asm-$2/arch
fi

# create link for s5pc1xx SoC
if [ "$3" = "s5pc1xx" ] ; then
        rm -f regs.h
        ln -s $6.h regs.h
        rm -f asm-$2/arch
        ln -s arch-$3 asm-$2/arch
fi

# create link for s5pc11x SoC
if [ "$3" = "s5pc11x" ] ; then
        rm -f regs.h
        ln -s $6.h regs.h
        rm -f asm-$2/arch
        ln -s arch-$3 asm-$2/arch
fi

# create link for s5pv210 SoC
########################################################
# TQ210使用的是s5pv210,所以会执行这段代码
# 删除regs.h文件，
# 创建链接文件regs.h指向s5pv210.h
# 删除asm-arm/arch，
# 创建软连接asm-arm/arch指向arch-s5pv210
if [ "$3" = "s5pv210" ] ; then
        rm -f regs.h
        ln -s $6.h regs.h
        rm -f asm-$2/arch
        ln -s arch-$3 asm-$2/arch
fi

# create link for s5p64xx SoC
if [ "$3" = "s5p64xx" ] ; then
	rm -f regs.h
	ln -s $6.h regs.h
	rm -f asm-$2/arch
	ln -s arch-$3 asm-$2/arch
fi

# create link for s5p644x SoC
if [ "$3" = "s5p644x" ] ; then
	rm -f regs.h
	ln -s $6.h regs.h
	rm -f asm-$2/arch
	ln -s arch-$3 asm-$2/arch
fi

###########################################################################
# 如果架构是arm架构，则删除当前目录(此时当前目录是U-boot源码顶层目录/include)下的
# asm-arm/proc目录建立软链接ln -s proc-armv asm-arm/proc
if [ "$2" = "arm" ] ; then
	rm -f asm-$2/proc
	ln -s ${LNPREFIX}proc-armv asm-$2/proc
fi

# create link for s3c64xx-mp SoC
if [ "$3" = "s3c64xx-mp" ] ; then
	rm -f regs.h
	ln -s $6.h regs.h
	rm -f asm-$2/arch
	ln -s arch-$3 asm-$2/arch
fi

#
# Create include file for Make
#
###########################################################################
# 生成make的头文件config.mk
# ARCH=arm，CPU=s5pv210,BOARD=TQ210,加入到config.h中
# > config.mk是强行覆盖创建config.mk然后把数据导入config.mk中
# VENDOR=samsung,SOC=s5pv210加入到config.mk
echo "ARCH   = $2" >  config.mk
echo "CPU    = $3" >> config.mk
echo "BOARD  = $4" >> config.mk

[ "$5" ] && [ "$5" != "NULL" ] && echo "VENDOR = $5" >> config.mk

[ "$6" ] && [ "$6" != "NULL" ] && echo "SOC    = $6" >> config.mk

#
# Create board specific header file
#
###################################################################
# 创建指定的配置头文件，默认APPEND=no（本文件开头有赋值）
# 执行else，创建新的config.h文件
if [ "$APPEND" = "yes" ]	# Append to existing config file
then
	echo >> config.h
else
	> config.h		# Create new config file
fi
###################################################################
# 在config中会显示/* Automatically generated - do not edit */
# #include <configs/TQ210.h>加入到config.h中
echo "/* Automatically generated - do not edit */" >>config.h
echo "#include <configs/$1.h>" >>config.h

# 返回成功状态
exit 0