€•¼D      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ/translations/zh_CN/tee/amd-tee”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/zh_TW/tee/amd-tee”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/it_IT/tee/amd-tee”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/ja_JP/tee/amd-tee”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/ko_KR/tee/amd-tee”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ/translations/sp_SP/tee/amd-tee”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…””}”hh£sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1h¡hhhžhhŸŒ9/var/lib/git/docbuild/linux/Documentation/tee/amd-tee.rst”h KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ-AMD-TEE (AMD's Trusted Execution Environment)”h]”hŒ/AMD-TEE (AMDâ€™s Trusted Execution Environment)”…””}”(hh»hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hh¶hžhhŸh³h KubhŒ	paragraph”“”)”}”(hŒThe AMD-TEE driver handles the communication with AMD's TEE environment. The
TEE environment is provided by AMD Secure Processor.”h]”hŒƒThe AMD-TEE driver handles the communication with AMDâ€™s TEE environment. The
TEE environment is provided by AMD Secure Processor.”…””}”(hhËhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhÊ)”}”(hX4  The AMD Secure Processor (formerly called Platform Security Processor or PSP)
is a dedicated processor that features ARM TrustZone technology, along with a
software-based Trusted Execution Environment (TEE) designed to enable
third-party Trusted Applications. This feature is currently enabled only for
APUs.”h]”hX4  The AMD Secure Processor (formerly called Platform Security Processor or PSP)
is a dedicated processor that features ARM TrustZone technology, along with a
software-based Trusted Execution Environment (TEE) designed to enable
third-party Trusted Applications. This feature is currently enabled only for
APUs.”…””}”(hhÙhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K
hh¶hžhubhÊ)”}”(hŒ>The following picture shows a high level overview of AMD-TEE::”h]”hŒ=The following picture shows a high level overview of AMD-TEE:”…””}”(hhçhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h Khh¶hžhubhŒliteral_block”“”)”}”(hX:                                              |
   x86                                      |
                                            |
User space            (Kernel space)        |    AMD Secure Processor (PSP)
~~~~~~~~~~            ~~~~~~~~~~~~~~        |    ~~~~~~~~~~~~~~~~~~~~~~~~~~
                                            |
+--------+                                  |       +-------------+
| Client |                                  |       | Trusted     |
+--------+                                  |       | Application |
    /\                                      |       +-------------+
    ||                                      |             /\
    ||                                      |             ||
    ||                                      |             \/
    ||                                      |         +----------+
    ||                                      |         |   TEE    |
    ||                                      |         | Internal |
    \/                                      |         |   API    |
+---------+           +-----------+---------+         +----------+
| TEE     |           | TEE       | AMD-TEE |         | AMD-TEE  |
| Client  |           | subsystem | driver  |         | Trusted  |
| API     |           |           |         |         |   OS     |
+---------+-----------+----+------+---------+---------+----------+
|   Generic TEE API        |      | ASP     |      Mailbox       |
|   IOCTL (TEE_IOC_*)      |      | driver  | Register Protocol  |
+--------------------------+      +---------+--------------------+”h]”hX:                                              |
   x86                                      |
                                            |
User space            (Kernel space)        |    AMD Secure Processor (PSP)
~~~~~~~~~~            ~~~~~~~~~~~~~~        |    ~~~~~~~~~~~~~~~~~~~~~~~~~~
                                            |
+--------+                                  |       +-------------+
| Client |                                  |       | Trusted     |
+--------+                                  |       | Application |
    /\                                      |       +-------------+
    ||                                      |             /\
    ||                                      |             ||
    ||                                      |             \/
    ||                                      |         +----------+
    ||                                      |         |   TEE    |
    ||                                      |         | Internal |
    \/                                      |         |   API    |
+---------+           +-----------+---------+         +----------+
| TEE     |           | TEE       | AMD-TEE |         | AMD-TEE  |
| Client  |           | subsystem | driver  |         | Trusted  |
| API     |           |           |         |         |   OS     |
+---------+-----------+----+------+---------+---------+----------+
|   Generic TEE API        |      | ASP     |      Mailbox       |
|   IOCTL (TEE_IOC_*)      |      | driver  | Register Protocol  |
+--------------------------+      +---------+--------------------+”…””}”hh÷sbah}”(h]”h ]”h"]”h$]”h&]”h±h²uh1hõhŸh³h Khh¶hžhubhÊ)”}”(hX}  At the lowest level (in x86), the AMD Secure Processor (ASP) driver uses the
CPU to PSP mailbox register to submit commands to the PSP. The format of the
command buffer is opaque to the ASP driver. It's role is to submit commands to
the secure processor and return results to AMD-TEE driver. The interface
between AMD-TEE driver and AMD Secure Processor driver can be found in [1].”h]”hX  At the lowest level (in x86), the AMD Secure Processor (ASP) driver uses the
CPU to PSP mailbox register to submit commands to the PSP. The format of the
command buffer is opaque to the ASP driver. Itâ€™s role is to submit commands to
the secure processor and return results to AMD-TEE driver. The interface
between AMD-TEE driver and AMD Secure Processor driver can be found in [1].”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K,hh¶hžhubhÊ)”}”(hŒ›The AMD-TEE driver packages the command buffer payload for processing in TEE.
The command buffer format for the different TEE commands can be found in [2].”h]”hŒ›The AMD-TEE driver packages the command buffer payload for processing in TEE.
The command buffer format for the different TEE commands can be found in [2].”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K2hh¶hžhubhÊ)”}”(hŒ5The TEE commands supported by AMD-TEE Trusted OS are:”h]”hŒ5The TEE commands supported by AMD-TEE Trusted OS are:”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K5hh¶hžhubhŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒyTEE_CMD_ID_LOAD_TA          - loads a Trusted Application (TA) binary into
                              TEE environment.”h]”hŒdefinition_list”“”)”}”(hhh]”hŒdefinition_list_item”“”)”}”(hŒ[TEE_CMD_ID_LOAD_TA          - loads a Trusted Application (TA) binary into
TEE environment.”h]”(hŒterm”“”)”}”(hŒJTEE_CMD_ID_LOAD_TA          - loads a Trusted Application (TA) binary into”h]”hŒJTEE_CMD_ID_LOAD_TA          - loads a Trusted Application (TA) binary into”…””}”(hjG  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jE  hŸh³h K7hjA  ubhŒ
definition”“”)”}”(hhh]”hÊ)”}”(hŒTEE environment.”h]”hŒTEE environment.”…””}”(hjZ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K8hjW  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jU  hjA  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j?  hŸh³h K7hj<  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hj6  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj1  hžhhŸNh Nubj5  )”}”(hŒETEE_CMD_ID_UNLOAD_TA        - unloads TA binary from TEE environment.”h]”hÊ)”}”(hj‚  h]”hŒETEE_CMD_ID_UNLOAD_TA        - unloads TA binary from TEE environment.”…””}”(hj„  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K9hj€  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj1  hžhhŸh³h Nubj5  )”}”(hŒ?TEE_CMD_ID_OPEN_SESSION     - opens a session with a loaded TA.”h]”hÊ)”}”(hj™  h]”hŒ?TEE_CMD_ID_OPEN_SESSION     - opens a session with a loaded TA.”…””}”(hj›  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K:hj—  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj1  hžhhŸh³h Nubj5  )”}”(hŒ;TEE_CMD_ID_CLOSE_SESSION    - closes session with loaded TA”h]”hÊ)”}”(hj°  h]”hŒ;TEE_CMD_ID_CLOSE_SESSION    - closes session with loaded TA”…””}”(hj²  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K;hj®  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj1  hžhhŸh³h Nubj5  )”}”(hŒ>TEE_CMD_ID_INVOKE_CMD       - invokes a command with loaded TA”h]”hÊ)”}”(hjÇ  h]”hŒ>TEE_CMD_ID_INVOKE_CMD       - invokes a command with loaded TA”…””}”(hjÉ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K<hjÅ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj1  hžhhŸh³h Nubj5  )”}”(hŒ0TEE_CMD_ID_MAP_SHARED_MEM   - maps shared memory”h]”hÊ)”}”(hjÞ  h]”hŒ0TEE_CMD_ID_MAP_SHARED_MEM   - maps shared memory”…””}”(hjà  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K=hjÜ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj1  hžhhŸh³h Nubj5  )”}”(hŒ3TEE_CMD_ID_UNMAP_SHARED_MEM - unmaps shared memory
”h]”hÊ)”}”(hŒ2TEE_CMD_ID_UNMAP_SHARED_MEM - unmaps shared memory”h]”hŒ2TEE_CMD_ID_UNMAP_SHARED_MEM - unmaps shared memory”…””}”(hj÷  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K>hjó  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj1  hžhhŸh³h Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ*”uh1j/  hŸh³h K7hh¶hžhubhÊ)”}”(hŒCAMD-TEE Trusted OS is the firmware running on AMD Secure Processor.”h]”hŒCAMD-TEE Trusted OS is the firmware running on AMD Secure Processor.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h K@hh¶hžhubhÊ)”}”(hŒnThe AMD-TEE driver registers itself with TEE subsystem and implements the
following driver function callbacks:”h]”hŒnThe AMD-TEE driver registers itself with TEE subsystem and implements the
following driver function callbacks:”…””}”(hj!  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KBhh¶hžhubj0  )”}”(hhh]”(j5  )”}”(hŒBget_version - returns the driver implementation id and capability.”h]”hÊ)”}”(hj4  h]”hŒBget_version - returns the driver implementation id and capability.”…””}”(hj6  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KEhj2  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj/  hžhhŸh³h Nubj5  )”}”(hŒ1open - sets up the driver context data structure.”h]”hÊ)”}”(hjK  h]”hŒ1open - sets up the driver context data structure.”…””}”(hjM  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KFhjI  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj/  hžhhŸh³h Nubj5  )”}”(hŒ$release - frees up driver resources.”h]”hÊ)”}”(hjb  h]”hŒ$release - frees up driver resources.”…””}”(hjd  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KGhj`  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj/  hžhhŸh³h Nubj5  )”}”(hŒDopen_session - loads the TA binary and opens session with loaded TA.”h]”hÊ)”}”(hjy  h]”hŒDopen_session - loads the TA binary and opens session with loaded TA.”…””}”(hj{  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KHhjw  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj/  hžhhŸh³h Nubj5  )”}”(hŒ>close_session -  closes session with loaded TA and unloads it.”h]”hÊ)”}”(hj  h]”hŒ>close_session -  closes session with loaded TA and unloads it.”…””}”(hj’  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KIhjŽ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj/  hžhhŸh³h Nubj5  )”}”(hŒ0invoke_func - invokes a command with loaded TA.
”h]”hÊ)”}”(hŒ/invoke_func - invokes a command with loaded TA.”h]”hŒ/invoke_func - invokes a command with loaded TA.”…””}”(hj©  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KJhj¥  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj/  hžhhŸh³h Nubeh}”(h]”h ]”h"]”h$]”h&]”j  j  uh1j/  hŸh³h KEhh¶hžhubhÊ)”}”(hŒ7cancel_req driver callback is not supported by AMD-TEE.”h]”hŒ7cancel_req driver callback is not supported by AMD-TEE.”…””}”(hjÃ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KLhh¶hžhubhÊ)”}”(hŒÙThe GlobalPlatform TEE Client API [3] can be used by the user space (client) to
talk to AMD's TEE. AMD's TEE provides a secure environment for loading, opening
a session, invoking commands and closing session with TA.”h]”hŒÝThe GlobalPlatform TEE Client API [3] can be used by the user space (client) to
talk to AMDâ€™s TEE. AMDâ€™s TEE provides a secure environment for loading, opening
a session, invoking commands and closing session with TA.”…””}”(hjÑ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KNhh¶hžhubhµ)”}”(hhh]”(hº)”}”(hŒ
References”h]”hŒ
References”…””}”(hjâ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¹hjß  hžhhŸh³h KSubhÊ)”}”(hŒ[1] include/linux/psp-tee.h”h]”hŒ[1] include/linux/psp-tee.h”…””}”(hjð  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KUhjß  hžhubhÊ)”}”(hŒ"[2] drivers/tee/amdtee/amdtee_if.h”h]”hŒ"[2] drivers/tee/amdtee/amdtee_if.h”…””}”(hjþ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KWhjß  hžhubj;  )”}”(hhh]”j@  )”}”(hŒ{[3] http://www.globalplatform.org/specificationsdevice.asp look for
"TEE Client API Specification v1.0" and click download.”h]”(jF  )”}”(hŒC[3] http://www.globalplatform.org/specificationsdevice.asp look for”h]”(hŒ[3] ”…””}”(hj  hžhhŸNh NubhŒ	reference”“”)”}”(hŒ6http://www.globalplatform.org/specificationsdevice.asp”h]”hŒ6http://www.globalplatform.org/specificationsdevice.asp”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”j  uh1j  hj  ubhŒ	 look for”…””}”(hj  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1jE  hŸh³h KYhj  ubjV  )”}”(hhh]”hÊ)”}”(hŒ7"TEE Client API Specification v1.0" and click download.”h]”hŒ;â€œTEE Client API Specification v1.0â€ and click download.”…””}”(hj9  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÉhŸh³h KZhj6  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jU  hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j?  hŸh³h KYhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j:  hjß  hžhhŸh³h Nubeh}”(h]”Œ
references”ah ]”h"]”Œ
references”ah$]”h&]”uh1h´hh¶hžhhŸh³h KSubeh}”(h]”Œ+amd-tee-amd-s-trusted-execution-environment”ah ]”h"]”Œ-amd-tee (amd's trusted execution environment)”ah$]”h&]”uh1h´hhhžhhŸh³h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h³uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¹NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jŒ  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h³Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jf  jc  j^  j[  uŒ	nametypes”}”(jf  ‰j^  ‰uh}”(jc  h¶j[  jß  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.