From 02f0dcc5aa0a6aec8aad479d370c97146bbff265 Mon Sep 17 00:00:00 2001
From: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
Date: Tue, 24 Jun 2014 16:45:01 +0530
Subject: [PATCH] embeddesw: Add initial code support

Added initial support Xilinx Embedded Software.

Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
Reviewed-by: Srikanth Vemula <svemula@xilinx.com>
---
 README.txt | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 86 insertions(+)
 create mode 100644 README.txt

diff --git a/README.txt b/README.txt
new file mode 100644
index 00000000..bbb884bc
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,86 @@
+embeddedsw.git - repo for standalone software
+
+All software is version less and divided into three directories
+	- lib
+		contains bsp, zynq fsbl and software services like xilisf
+	- XilinxProcessorIPLib
+		contains all drivers
+	- ThirdParty
+		software from third party like light weight IP stack
+
+Every driver/lib/apps/services has these sub-directories
+
+1. data		- contains tcl, mdd, testapp tcl or header files used in SDK
+2. doc		- documentation of source code in form of pdf or html
+3. examples	- illustrating different use cases of driver
+4. src		- driver interface code implementing functionality of IP
+
+
+<repo>
+|-XilinxProcessorIPLib
+|	|- drivers
+|		|- uartps
+|			|- data
+|			|- src
+|			|- doc
+|			|- examples
+|
+|-lib
+|	|- bsp
+|		|- standalone
+|			|- data
+|			|- src
+|				|- cortexa9
+|				|- microblaze
+|				|- common
+|				|- profile
+|			|- doc
+|		|- xilkernel
+|			|- data
+|			|- doc
+|			|- src
+|	|- sw_apps
+|		|- zynq_fsbl [described below]
+|	|- sw_services
+|		|- xilffs
+|		|- xilskey
+|		|- xilmfs
+|		|- xilrsa
+|		|- xilflash
+|		|- xilisf
+|
+|	Note - All these are libraries and utilize drivers
+|
+|-ThirdParty
+|	|- sw_services
+|        	|- lwip140
+
+
+Building FSBL from git:
+
+FSBL has 3 directories.
+	1. data - It contains files for SDK
+	2. src  - It contains the FSBK source files
+	3. misc - It contains miscelanious files required to
+		  compile FSBL for zc702, zc706, zed and
+		  microzed boards.
+		  It also contains the ps7_init_gpl.[c/h] with gpl
+		  header in respective board directories.
+
+
+How to compile FSBL:
+	1.Go to the Fsbl src directory "lib/sw_apps/zynq_fsbl/src/"
+	2. make "BOARD=<>" "CC=<>"
+		a. Values for BOARD  are zc702, zc706, zed, microzed
+		b. Value for CC is arm-xilinx-eabi-gcc. Default value is also same.
+	3.Give "make" to compile the fsbl with BSP. By default it is
+	  built for zc702 board with arm-xilinx-eabi-gcc compiler
+	4.Below are the examples for compiling for different options
+		a. To generate Fsbl for zc706 board
+			i.make "BOARD=zc706"
+		b.To generate Fsbl for zc702 board with debug enable
+		  and RSA support
+			i.make "BOARD=zc702" "CFLAGS=-DFSBL_DEBUG_INFO -DRSA_SUPPORT"
+		c.To generate Fsbl for zc706 board and compile with arm-xilinx-eabi-gcc
+		  with MMC support
+			i.make "BOARD=zc706" "CC=arm-xilinx-eabi-gcc" "CFLAGS=-DMMC_SUPPORT"