summaryrefslogtreecommitdiff
path: root/lib/trusty/ql-tipc/README.md
diff options
context:
space:
mode:
authorHaoran.Wang <elven.wang@nxp.com>2017-08-28 15:21:44 +0800
committerYe Li <ye.li@nxp.com>2018-06-13 03:06:36 -0700
commit0ccdd527a794c2b450658980361a7857ce7495c9 (patch)
treeb04765783a5d5789bae9af434901268d6bc8d427 /lib/trusty/ql-tipc/README.md
parent2c840c82b3558267650b98735790ac7151644ae1 (diff)
MLK-18591-4 android: iot: Import ql-tipc lib for Trusty OS
The lib provided ql-tipc communication channel with Trusty OS. Also the AVB, Keymaster and SecureStorage service tipc client implement in this lib. Change-Id: I0ab1ec9ee1b6f272b960c2e944008283c2c9249a Signed-off-by: Haoran.Wang <elven.wang@nxp.com> (cherry picked from commit 8fb370dd80fbb293b58115d2e7fc4970813773c7)
Diffstat (limited to 'lib/trusty/ql-tipc/README.md')
-rw-r--r--lib/trusty/ql-tipc/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/lib/trusty/ql-tipc/README.md b/lib/trusty/ql-tipc/README.md
new file mode 100644
index 0000000000..76e3781756
--- /dev/null
+++ b/lib/trusty/ql-tipc/README.md
@@ -0,0 +1,30 @@
+# Queueless Trusty IPC
+
+ql-tipc is a portable client library that implements Trusty queueless IPC.
+It is intended to enable Trusty IPC in bootloader environments.
+
+## Code organization
+
+### IPC components
+
+- libtipc - Functions to be called by library user
+- ipc - IPC library
+- ipc_dev - Helper functions for sending requests to the secure OS
+- rpmb_proxy - Handles RPMB requests from secure storage service
+- avb - Sends requests to the Android Verified Boot service
+
+### Misc
+
+- examples/ - Implementations of bootloader-specific code.
+- arch/$ARCH/ - Architecture dependent implementation of Trusty device
+ (see trusty_dev.h). Implements SMCs on ARM for example.
+
+## Portability Notes
+
+The suggested approach to porting ql-tipc is to copy all header and C files
+into the bootloader and integrate as needed. RPMB storage operations and
+functions defined in trusty/sysdeps.h require system dependent implementations.
+
+If the TIPC_ENABLE_DEBUG preprocessor symbol is set, the code will include
+debug information and run-time checks. Production builds should not use this.
+