u-boot/doc/usage/cmd/optee.rst
Tom Rini 11da3403e9 doc: usage: Add general rule for $?
For nearly all commands in U-Boot the '?' variable is handled the same
way with 0 meaning success, 1 meaning any failure.  Explain this in the
general rules section of the cmdline documentation (with a link to a
counter example) and then remove the redundant wording from most
commands. We retain a section about the return value in a number of
places where we are doing something such as always returning a specific
value or we have useful additional information to go along with the
normal return codes.

Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2025-10-26 09:03:35 -06:00

66 lines
1.4 KiB
ReStructuredText

.. 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.