[processor-sdk/pdk.git] / packages / ti / drv / sciclient / soc / sysfw / binaries / system-firmware-public-documentation / _sources / 2_tisci_msgs / security / dkek_management.rst.txt
1 =============================
2 Derived KEK TISCI Description
3 =============================
5 .. _sec_dkek_tisci_desc:
8 This chapter provides information on |sysfw| API for Derived Key Encryption
9 Key(DKEK) management. The available API are listed below.
11 +------------------+-----------------------------------------------------------------------+
12 | TISCI Message ID | Message Name |
13 +==================+=======================================================================+
14 | 0x9003 | :ref:`TISCI_MSG_SA2UL_SET_DKEK <sec-api-sa2ul-set-dkek>` |
15 +------------------+-----------------------------------------------------------------------+
16 | 0x9004 | :ref:`TISCI_MSG_SA2UL_RELEASE_DKEK <sec-api-sa2ul-release-dkek>` |
17 +------------------+-----------------------------------------------------------------------+
18 | 0x9029 | :ref:`TISCI_MSG_SA2UL_GET_DKEK <sec-api-sa2ul-get-dkek>` |
19 +------------------+-----------------------------------------------------------------------+
21 This document must be read along side
23 #. :doc:`../../6_topic_user_guides/dkek_management` and
24 #. :doc:`../../3_boardcfg/BOARDCFG_SEC`, specifically :ref:`pub_boardcfg_dkek_config`
26 API Description
27 ===============
29 .. _sec-api-sa2ul-set-dkek:
31 TISCI_MSG_SA2UL_SET_DKEK - Set DKEK
32 -----------------------------------
34 **Usage**:
36 +------------------------+--------+
37 | **Message Type** | Normal |
38 +------------------------+--------+
39 | **Secure Queue Only?** | Yes |
40 +------------------------+--------+
42 TISCI Message ID
43 ----------------
45 .. sysfwapimacro:: TISCI_MSG_SA2UL_SET_DKEK
47 .. sysfwapistruct:: tisci_msg_sa2ul_set_dkek_req
49 .. sysfwapistruct:: tisci_msg_sa2ul_set_dkek_resp
51 .. sysfwapimacro:: KDF_LABEL_AND_CONTEXT_LEN_MAX
54 See :ref:`pub_tisci_dkek_notes` below.
56 .. _sec-api-sa2ul-release-dkek:
58 TISCI_MSG_SA2UL_RELEASE_DKEK - Release DKEK
59 -------------------------------------------
61 **Usage**:
63 +------------------------+--------+
64 | **Message Type** | Normal |
65 +------------------------+--------+
66 | **Secure Queue Only?** | Yes |
67 +------------------------+--------+
69 TISCI Message ID
70 ----------------
72 .. sysfwapimacro:: TISCI_MSG_SA2UL_RELEASE_DKEK
74 .. sysfwapistruct:: tisci_msg_sa2ul_release_dkek_req
76 .. sysfwapistruct:: tisci_msg_sa2ul_release_dkek_resp
78 See :ref:`pub_tisci_dkek_notes` below.
80 .. _sec-api-sa2ul-get-dkek:
82 TISCI_MSG_SA2UL_GET_DKEK - Get DKEK
83 -----------------------------------
85 **Usage**:
87 +------------------------+--------+
88 | **Message Type** | Normal |
89 +------------------------+--------+
90 | **Secure Queue Only?** | Yes |
91 +------------------------+--------+
93 TISCI Message ID
94 ----------------
96 .. sysfwapimacro:: TISCI_MSG_SA2UL_GET_DKEK
98 .. sysfwapimacro:: SA2UL_DKEK_KEY_LEN
100 .. sysfwapistruct:: tisci_msg_sa2ul_get_dkek_req
102 .. sysfwapistruct:: tisci_msg_sa2ul_get_dkek_resp
105 See :ref:`pub_tisci_dkek_notes` below.
107 .. _pub_tisci_dkek_notes:
109 API Notes
110 ---------
112 - The total length of the Label and Context fields below is limited by the size
113 of the TISCI messages(see :ref:`pub_secure_msg_header`) to 41 bytes.
115 - |sysfw| only support ``sa2ul_instance`` value of 0 in the API below.