diff options
| author | Tom Rini <[email protected]> | 2025-01-08 14:19:22 -0600 |
|---|---|---|
| committer | Tom Rini <[email protected]> | 2025-01-08 14:19:22 -0600 |
| commit | 3bfd12008bef1a8353e7ceaca2cb06cf388527ed (patch) | |
| tree | ac25e8db2f18bcba9f48518249fc020a05cb576c /doc/usage/cmd | |
| parent | 6d41f0a39d6423c8e57e92ebbe9f8c0333a63f72 (diff) | |
| parent | d6da3dbaef57fc1d319b6b552efa009e2489d7d9 (diff) | |
Merge branch 'next'
Diffstat (limited to 'doc/usage/cmd')
| -rw-r--r-- | doc/usage/cmd/optee.rst | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/doc/usage/cmd/optee.rst b/doc/usage/cmd/optee.rst new file mode 100644 index 00000000000..46c569a105f --- /dev/null +++ b/doc/usage/cmd/optee.rst @@ -0,0 +1,70 @@ +.. SPDX-License-Identifier: GPL-2.0 + +.. index:: + single: optee (command) + +optee command +============= + +Synopsis +-------- + +:: + + optee hello + optee hello <value> + +Description +----------- + +This is an OP-TEE sanity test which invokes the "Hello World" +Trusted Application (TA). The TA does two things: +- It prints debug and information messages to the secure console (if logging is enabled) +- It increments the integer value passed as a parameter and returns it + + +value + Integer value that the TA is expected to increment and return. + The default value is 0. + +To enable the OP-TEE Hello World example please refer +https://optee.readthedocs.io/en/latest/building/gits/optee_examples/optee_examples.html + +Examples +-------- + +:: + + ==> optee hello + D/TA: TA_CreateEntryPoint:39 has been called + I/TA: Hello World! + Value before: 0x0 + Calling TA + D/TA: inc_value:105 has been called + I/TA: Got value: 0 from NW + I/TA: Increase value to: 1 + Value after: 0x1 + I/TA: Goodbye! + D/TA: TA_DestroyEntryPoint:50 has been called + + ==> optee hello 74 + D/TA: TA_CreateEntryPoint:39 has been called + I/TA: Hello World! + Value before: 0x74 + Calling TA + D/TA: inc_value:105 has been called + I/TA: Got value: 116 from NW + I/TA: Increase value to: 117 + Value after: 0x75 + I/TA: Goodbye! + D/TA: TA_DestroyEntryPoint:50 has been called + +Configuration +------------- + +The optee command is enabled by CONFIG_OPTEE=y and CONFIG_CMD_OPTEE=y. + +Return value +------------ + +The return value $? is 0 (true) if the command succeeds, 1 (false) otherwise. |
