update README files for artik053
authorsunghan <sh924.chang@samsung.com>
Thu, 20 Apr 2017 08:44:10 +0000 (17:44 +0900)
committersunghan <sh924.chang@samsung.com>
Thu, 20 Apr 2017 12:18:28 +0000 (21:18 +0900)
README.md
build/configs/README.txt
build/configs/artik053/README.md [new file with mode: 0644]
build/configs/sidk_s5jt200/README.md

index 75bbd07..43a03f5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
 
 lightweight RTOS-based platform to support low-end IoT devices.
 
-You can find project details on our [Tizen wiki](https://wiki.tizen.org/wiki/Tizen_RT).
+Please find project details on our [Tizen wiki](https://wiki.tizen.org/wiki/Tizen_RT).
 
 ## Quick Start
 ### Getting the toolchain
@@ -51,14 +51,22 @@ make
 Built binaries are in $TIZENRT_BASEDIR/build/output/bin.
 
 ## Supported Board
+
+ARTIK053 [[details]](build/configs/artik053/README.md)
+
 sidk_s5jt200 [[details]](build/configs/sidk_s5jt200/README.md)
 
-Tizen RT currently supports one board called sidk_s5jt200. However, this board is not available in public markets till now. sidk_s5jt200 or other boards for Tizen RT will be coming soon.
-  sidk_s5jt200 stands for Samsung IoT Development Kit for S5JT200 chipset.
+Tizen RT currently supports only two boards called artik053 and sidk_s5jt200.
+However, those are not available in public markets till now.
+sidk_s5jt200 or other boards for Tizen RT will be coming soon.
 
 ## Configuration Sets
-There are three configuration sets for sidk_s5jt200, including 'tc', 'kernel_sample', and 'hello_with_tash'.
-'tc' is a configuration set for runnig unit test cases, 'kernel_sample' for running kernel functions, and 'hello_with_tash' for running a hello example.
-You can modify the configuration by using the menuconfig tool on the 'os' folder, but all configuration combinations are not fully tested yet.
-The IPv4 network stack based on LWIP is included, but Wi-Fi related codes such as wpa_supplicant are not included.
-Wi-Fi will be added in 2017.
+
+To build a Tizen RT application, use the default configuration files named 'defconfig' under 'build/configs/<board>/' folder.
+
+To customize your application with specific configuration settings, using the menuconfig tool is recommended  at os folder as shown:
+```bash
+make menuconfig
+```
+Please keep in mind that we are actively working on board configurations, and will be posting our updates on the README files under each config
+
index de016a5..a35102f 100644 (file)
@@ -140,9 +140,13 @@ docs/TinyAra_Config_Variables.html.
 Supported Boards
 ^^^^^^^^^^^^^^^^
 
+configs/artik053
+  ARTIK-053 Starter Kit which is an evaluation board based on SAMSUNG S5JT200 WiFi SoC
+
 configs/sidk_s5jt200
   Samsung IoT Development Kit for S5JT200
 
+
 Configuring TinyAra
 ^^^^^^^^^^^^^^^^^^^
 
diff --git a/build/configs/artik053/README.md b/build/configs/artik053/README.md
new file mode 100644 (file)
index 0000000..f6c00d2
--- /dev/null
@@ -0,0 +1,60 @@
+# ARTIK 053
+
+The ARTIK 053 is a SOC for Wi-Fi™ IoT solutions. The ARTIK 053 has a Wi-Fi subsystem, security subsystem, and application subsystem.
+
+## Information
+
+will be updated
+
+## Environment Set-up
+### On Chip Debugger installation
+
+OpenOCD is used to program and debug.
+
+OpenOCD v0.10.0 is recommended and can be installed like below,
+but pre-built OpenOCD binaray on tools/openocd/linux64(or 32) can be used without installing.
+```bash
+sudo apt-get build-dep openocd
+git clone --depth 1 -b v0.10.0 https://git.code.sf.net/p/openocd/code openocd-code
+cd openocd-code
+./bootstrap
+./configure
+make
+sudo make install
+```
+
+Set the OPENOCD_SCRIPTS to environment variable.
+This step is needed to program a binary at os folder.
+```bash
+export OPENOCD_SCRIPTS=$TIZENRT_BASEDIR/build/configs/artik053/tools/openocd
+```
+TIZENRT_BASEDIR was set at 'Getting the sources' tab of [[Quick Start]](../../../README.md).
+
+## How to program a binary
+
+At first, the complete set of binaries are needed to program.
+After buiding a Tizen RT, execute below at os folder.
+```bash
+openocd -f artik053.cfg -c ' \
+    flash_write bl1    ../build/configs/artik053/bin/bl1.bin;      \
+    flash_write bl2    ../build/configs/artik053/bin/bl2.bin;      \
+    flash_write sssfw  ../build/configs/artik053/bin/sssfw.bin;    \
+    flash_write wlanfw ../build/configs/artik053/bin/wlanfw.bin;   \
+    flash_write os     ../build/output/bin/tinyara_head.bin;       \
+    exit'
+```
+
+Once the complete binaries are successfully programmed, each partition can be updated seperately with new one.
+```bash
+openocd -f artik053.cfg -c ' \
+    flash_write os ../build/output/bin/tinyara_head.bin; exit'
+```
+
+## Configuration Sets
+
+will be updated
+
+#### nettest
+
+#### tash
+
index 1cf7e7f..1c32be9 100644 (file)
@@ -7,7 +7,7 @@ Samsung IoT Development Kit for S5JT200 chipset.
 will be updated
 
 ## Environment Set-up
-### For OpenOCD
+### On Chip Debugger installation
 
 on Ubuntu 13.10 ~ 14.xx version
 ```bash
@@ -21,7 +21,7 @@ sudo apt-get update
 sudo apt-get install libc6:i386 libncurses5:i386 libstdc++6:i386 lib32z1
 ```
 
-### For FTDI
+### FTDI installation
 
 Install the package for usb
 ```bash
@@ -53,7 +53,7 @@ sudo ln -s /usr/local/lib/libftdi.so.1.19.0 libftdi.so
 sudo ln -s /usr/local/lib/libftdi.so.1.19.0 libftdi.so.1
 ```
 
-### For FT2232 interface driver for OpenOCD
+### FT2232 interface driver installation
 
 Get the package, [libftd2xxx1.0.4](https://github.com/psi46/HDItest/tree/master/FTDI-1.0.4/libftd2xx1.0.4)
 
@@ -79,8 +79,14 @@ sudo ln -s /usr/local/lib/libftd2xx.so.1.0.4 libftd2xx.so
 
 ## Configuration Sets
 
-There are three configuration sets for sidk_s5jt200, including 'tc', 'kernel_sample', and 'hello_with_tash'.
-'tc' is a configuration set for runnig unit test cases, 'kernel_sample' for running kernel functions, and 'hello_with_tash' for running a hello example.
-You can modify the configuration by using the menuconfig tool on the 'os' folder, but all configuration combinations are not fully tested yet.
-The IPv4 network stack based on LWIP is included, but Wi-Fi related codes such as wpa_supplicant are not included.
-Wi-Fi will be added in 2017.
+There are three configuration sets for sidk_s5jt200, including 'hello_with_tash', 'kernel_sample', and 'tc'.
+
+#### hello_with_tash
+ for running a hello example with shell enabled
+
+#### kernel_sample
+ for running kernel functions
+
+#### tc
+ for runnig unit test cases
+