aboutsummaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorEtienne Carriere <etienne.carriere@linaro.org>2018-04-05 14:57:06 +0200
committerjenswi-linaro-adm <jenswi-linaro-adm@users.noreply.github.com>2018-04-05 17:11:44 +0200
commitecb1e1546bbd38cb78dd5bca5ce539fbb1889238 (patch)
tree97d03436f8407f79b4335a727c8298ddf68e4d2d /documentation
parentd84eb122fea4a58b7a9c34d23770174e09651e36 (diff)
doc: update documentation against out dated information
OP-TEE currently targets ARM Cortex-A with TZ, not all ARM TZ HW. This change updates documentation on this fact. This change references the GPD TEE Internal Core API v1.1 instead of the older GPD TEE Internal API v1.0. This also fixes an missing uppercase Internal *C*ore API v1.1 reference. Remove reference to the deprecated optee_linuxdriver git repository and review presentation of the several OP-TEE components in relate git repositories. These updates lead to few other changes, especially adding references to other available documentation where accurate. Signed-off-by: Etienne Carriere <etienne.carriere@linaro.org> Acked-by: Jerome Forissier <jerome.forissier@linaro.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/extensions/crypto_concat_kdf.md4
-rw-r--r--documentation/extensions/crypto_hkdf.md4
-rw-r--r--documentation/extensions/crypto_pbkdf2.md4
-rw-r--r--documentation/extensions/extensions.md5
-rw-r--r--documentation/globalplatform_api.md15
5 files changed, 16 insertions, 16 deletions
diff --git a/documentation/extensions/crypto_concat_kdf.md b/documentation/extensions/crypto_concat_kdf.md
index 3e1092c7..cbdfff16 100644
--- a/documentation/extensions/crypto_concat_kdf.md
+++ b/documentation/extensions/crypto_concat_kdf.md
@@ -26,8 +26,8 @@ is desired.
## API extension
-To support the Concat KDF, the *GlobalPlatform TEE Internal API Specification
-v1.0* was extended with new algorithm descriptors, new object types, and new
+To support the Concat KDF, the *GlobalPlatform TEE Internal Core API Specification
+v1.1* was extended with new algorithm descriptors, new object types, and new
object attributes as described below.
### p.95 Add new object type to TEE_PopulateTransientObject
diff --git a/documentation/extensions/crypto_hkdf.md b/documentation/extensions/crypto_hkdf.md
index 16a27da8..b60a980e 100644
--- a/documentation/extensions/crypto_hkdf.md
+++ b/documentation/extensions/crypto_hkdf.md
@@ -2,8 +2,8 @@
OP-TEE implements the *HMAC-based Extract-and-Expand Key Derivation Function
(HKDF)* specified in [RFC 5869](http://tools.ietf.org/html/rfc5869). This
-file documents the extensions to the *GlobalPlatform TEE Internal API
-Specification v1.0* that were implemented to support this algorithm. Trusted
+file documents the extensions to the *GlobalPlatform TEE Internal Core API
+Specification v1.1* that were implemented to support this algorithm. Trusted
Applications should include `<tee_api_defines_extensions.h>` to import the
definitions.
diff --git a/documentation/extensions/crypto_pbkdf2.md b/documentation/extensions/crypto_pbkdf2.md
index 7e22dddc..5ce3c4ad 100644
--- a/documentation/extensions/crypto_pbkdf2.md
+++ b/documentation/extensions/crypto_pbkdf2.md
@@ -12,8 +12,8 @@ in `conf.mk`:
## API extension
-To support PBKDF2, the *GlobalPlatform TEE Internal API Specification
-v1.0* was extended with a new algorithm descriptor, new object types, and new
+To support PBKDF2, the *GlobalPlatform TEE Internal Core API Specification
+v1.1* was extended with a new algorithm descriptor, new object types, and new
object attributes as described below.
### p.95 Add new object type to TEE_PopulateTransientObject
diff --git a/documentation/extensions/extensions.md b/documentation/extensions/extensions.md
index b4b64448..01d6f836 100644
--- a/documentation/extensions/extensions.md
+++ b/documentation/extensions/extensions.md
@@ -1,6 +1,7 @@
-# General Extensions to the GlobalPlatform TEE Internal API
+# General Extensions to the GlobalPlatform TEE Internal Core API
-This document describes the OP-TEE extensions introduced with respect to the GlobalPlatform TEE API Specifications v1.0.
+This document describes the OP-TEE extensions introduced with respect to the
+GlobalPlatform TEE Internal Core API Specifications v1.1.
Specific extensions documentation are part of:
* Cryptographic Extensions
diff --git a/documentation/globalplatform_api.md b/documentation/globalplatform_api.md
index f8ed8d73..2bce2ec7 100644
--- a/documentation/globalplatform_api.md
+++ b/documentation/globalplatform_api.md
@@ -13,8 +13,7 @@ identify, develop and publish specifications which facilitate the secure and
interoperable deployment and management of multiple embedded applications on
secure chip technology. OP-TEE has support for GlobalPlatform [TEE Client API
Specification v1.0](http://www.globalplatform.org/specificationsdevice.asp) and
-[TEE Internal API Specification
-v1.0](http://www.globalplatform.org/specificationsdevice.asp).
+[TEE Internal Core API Specification v1.1](http://www.globalplatform.org/specificationsdevice.asp).
# 2. TEE Client API
The TEE Client API describes and defines how a client running in a rich
@@ -45,8 +44,7 @@ are used in the communication between the client and the TEE.
#### TEE Functions
``` c
TEEC_Result TEEC_InitializeContext(
- const char*
- name,
+ const char* name,
TEEC_Context* context)
void TEEC_FinalizeContext(
@@ -97,10 +95,11 @@ in the secure world. The TEE Internal API consists of four major parts:
4. **Arithmetical API**
### Examples / usage
-Calling the Internal API is done in the same way as described above using Client API.
+Calling the Internal Core API is done in the same way as described above using Client API.
The best place to find information how this should be done is in the
-[TEE Internal API Specification
-v1.0](http://www.globalplatform.org/specificationsdevice.asp) which contains a
+[TEE Internal Core API Specification
+v1.1](http://www.globalplatform.org/specificationsdevice.asp) which contains a
lot of examples of how to call the various APIs.
-
+One can also have a look at the OP-TEE examples git repository
+[optee_examples](https://github.com/linaro-swg/optee_examples) documentation.