From 01525dcf27bf9a0bec5b8dec7f369a809b96dfc0 Mon Sep 17 00:00:00 2001
From: Huang Xin <xajhuang@163.com>
Date: Tue, 21 May 2019 17:10:24 +0800
Subject: [PATCH] Add readme

---
 Readme.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..3edc395
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,75 @@
+ld           Makefile和编译脚本目录               
+├── common          公共 代码/头文件/配置文件 目录
+├── modules         linux内核态源代码目录
+│   └── demo        内核态驱动程序 demo 目录
+└── user            用户态源代码目录
+    └── demo        用户态应用程序 demo 目录
+</pre>
+&nbsp;  
+    
+>#### **注意事项：**
+>1. 内核态功能相关代码存放于 modules 目录下  
+>2. 用户态功能相关代码存放与 user 目录下
+>3. 每个独立的功能以子目录方式存放到适当的目录下
+>4. user 与 modules 目录中共有的源代码和头文件以及配置文件必须存放到 common 目录中 
+>5. 不得把相同功能、相同定义、相同配置的内容独立放到各自的 user 和 modules 目录中
+
+&nbsp;  
++ ## **编译方法**
+    1. #### 从仓库获取最新代码   
+    ``` bash 
+    git clone https://git.komect.net:SDX/vBRAS.git 
+    ```
+	或
+    ``` bash 
+    git pull
+    ``` 
+    2.  #### 安装必要软件(UBuntu)
+	   ```  bash
+	    sudo ./fsl-qoriq-glibc-x86_64-fsl-toolchain-aarch64-toolchain-2.4.1.sh
+	    sudo apt-get -y install git u-boot-tools device-tree-compiler autoconf curl flex 
+	    sudo apt-get -y install automake dh-autoreconf libssl-dev openssl libpcap-dev bc
+	    sudo apt-get -y install python-pip qemu-utils libncurses5-dev python-crypto bison
+	    ```
+    3.  #### 安装 linux 内核源代码
+	    ``` bash 
+	    sudo mkdir -p /opt/fsl-kernel /opt/fsl-kernel/arm64 /opt/fsl-kernel/x86
+	    sudo chmod 777 /opt/fsl-kernel -R
+	    cp ./vBRAS/Platform/kernel/linux-4.9.140.tar.gz /opt/fsl-kernel
+	    cd /opt/fsl-kernel
+	    tar -xvaf ./linux-4.9.140.tar.gz ./
+	    cp ./linux-4.9.140 ./x86
+	    cp ./linux-4.9.140 ./arm64
+	    ```  
+	4. #### 设置环境变量
+		在 ~/.bashrc 文件末尾加上以下几行配置
+		``` bash 
+		export HUACHENG_LINUX_KERNEL=/opt/fsl-kernel/x86/linux-4.9.140
+		export HUACHENG_ARM64_KERNEL=/opt/fsl-kernel/arm64/linux-4.9.140
+		export SDKTARGETSYSROOT=/opt/fsl-qoriq/2.4.1/sysroots/aarch64-fsl-linux
+	    export PATH=/opt/fsl-qoriq/2.4.1/sysroots/x86_64-fslsdk-linux/usr/bin:/opt/fsl-qoriq/2.4.1/sysroots/x86_64-fslsdk-linux/usr/sbin:/opt/fsl-qoriq/2.4.1/sysroots/x86_64-fslsdk-linux/bin:/opt/fsl-qoriq/2.4.1/sysroots/x86_64-fslsdk-linux/sbin:/opt/fsl-qoriq/2.4.1/sysroots/x86_64-fslsdk-linux/usr/bin/../x86_64-fslsdk-linux/bin:/opt/fsl-qoriq/2.4.1/sysroots/x86_64-fslsdk-linux/usr/bin/aarch64-fsl-linux:/opt/fsl-qoriq/2.4.1/sysroots/x86_64-fslsdk-linux/usr/bin/aarch64-fsl-linux-musl:$PATH
+	    source ~/.bashrc
+	    ```
+    5. #### 编译内核
+		- x64_86
+        ``` bash 
+        cd /opt/fsl-kernel/x86/linux-4.9.140 && make -j
+        ```  
+	    - arm64
+        ``` bash 
+        cd /opt/fsl-kernel/arm64/linux-4.9.140 && unset LDFLAS
+        ```
+		修改 Makefile 文件第 257、258 两行
+	    ``` bash 
+		  ARCH ?= $(SUBARCH)
+		  CROSS_COMPILE ?= $(CONFIG_CROSS_COMPILE:"%"=%)
+	    ```
+	    为
+	    ``` bash 
+	    ARCH ?= arm64
+	    CROSS_COMPILE ?= aarch64-fsl-linux-  
+	    ```
+		然后运行 make 命令进行编译
+ 
++ ## **安装方法**
+&nbsp;