Add README file
Dennis Huang [Wed, 23 Apr 2014 21:41:43 +0000 (14:41 -0700)]
Change-Id: Ia9dde92f9f53d8380b79dfa29b9a3b29c5e3b171
Reviewed-on: http://git-master/r/400529
Reviewed-by: Dennis Huang <denhuang@nvidia.com>
Tested-by: Dennis Huang <denhuang@nvidia.com>

README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..048e2dd
--- /dev/null
+++ b/README
@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2013-2014, NVIDIA CORPORATION. All rights reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files
+ * (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+- Directory structure
+  1. tlk: tlk core
+  2. lib: required libraries
+  3. tlk_driver: Linux driver between NS/S worlds
+  4. daemon: a proxy agent in NS world for TLK
+  5. tasks: containing secure task (TA)
+  6. tools: toolchain to build tlk
+
+- To make tlk image, including 1 and 2,
+  cd tlk
+  TARGET=<platform> make -e
+  # <platform> could be either "t124" or "t132"
+
+- The result binary will be "build-<platform>/tos.img"
+
+- Item 3 and 4 will be relased in source as example only.  They will not be part of the final image.
+
+- Item 6 will not be included in the release.  Audiences of this package need to get the toolchain and populate this directory.
+  Required toolchain are
+  tools/aarch64-linux-android-4.8: for 64-bit TLK
+  tools/arm-eabi-4.7: for 32-bit TLK
+  
+  Tools could be obtained from 
+  https://android.googlesource.com/platform/prebuilts/gcc/linux-x86/aarch64/aarch64-linux-android-4.8
+  https://android.googlesource.com/platform/prebuilts/gcc/linux-x86/arm/arm-eabi-4.7
+
+