blob: 19d12696a1eef1e2602da9bc9ef6dabfdbdb62d3 [file] [log] [blame]
Ye Li0db17f42021-08-07 16:00:41 +08001/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * Copyright 2021 NXP
4 */
5
Peng Fand5c31832023-06-15 18:09:05 +08006#ifndef __ELE_API_H__
7#define __ELE_API_H__
Ye Li0db17f42021-08-07 16:00:41 +08008
Peng Fand5c31832023-06-15 18:09:05 +08009#define ELE_VERSION 0x6
10#define ELE_CMD_TAG 0x17
11#define ELE_RESP_TAG 0xe1
Ye Li0db17f42021-08-07 16:00:41 +080012
Ye Lic9e34362023-01-30 18:39:51 +080013/* ELE commands */
14#define ELE_PING_REQ (0x01)
15#define ELE_FW_AUTH_REQ (0x02)
16#define ELE_RESTART_RST_TIMER_REQ (0x04)
17#define ELE_DUMP_DEBUG_BUFFER_REQ (0x21)
18#define ELE_OEM_CNTN_AUTH_REQ (0x87)
19#define ELE_VERIFY_IMAGE_REQ (0x88)
20#define ELE_RELEASE_CONTAINER_REQ (0x89)
21#define ELE_WRITE_SECURE_FUSE_REQ (0x91)
22#define ELE_FWD_LIFECYCLE_UP_REQ (0x95)
23#define ELE_READ_FUSE_REQ (0x97)
24#define ELE_GET_FW_VERSION_REQ (0x9D)
25#define ELE_RET_LIFECYCLE_UP_REQ (0xA0)
26#define ELE_GET_EVENTS_REQ (0xA2)
Mathieu Othacehe8df8e592024-03-21 08:19:53 +010027#define ELE_COMMIT_REQ (0xA8)
Peng Fand5c31832023-06-15 18:09:05 +080028#define ELE_START_RNG (0xA3)
Mathieu Othacehec6143392024-08-26 12:07:07 +020029#define ELE_CMD_DERIVE_KEY (0xA9)
Peng Fand5c31832023-06-15 18:09:05 +080030#define ELE_GENERATE_DEK_BLOB (0xAF)
Ye Lic9e34362023-01-30 18:39:51 +080031#define ELE_ENABLE_PATCH_REQ (0xC3)
32#define ELE_RELEASE_RDC_REQ (0xC4)
33#define ELE_GET_FW_STATUS_REQ (0xC5)
34#define ELE_ENABLE_OTFAD_REQ (0xC6)
35#define ELE_RESET_REQ (0xC7)
36#define ELE_UPDATE_OTP_CLKDIV_REQ (0xD0)
37#define ELE_POWER_DOWN_REQ (0xD1)
38#define ELE_ENABLE_APC_REQ (0xD2)
39#define ELE_ENABLE_RTC_REQ (0xD3)
40#define ELE_DEEP_POWER_DOWN_REQ (0xD4)
41#define ELE_STOP_RST_TIMER_REQ (0xD5)
42#define ELE_WRITE_FUSE_REQ (0xD6)
43#define ELE_RELEASE_CAAM_REQ (0xD7)
44#define ELE_RESET_A35_CTX_REQ (0xD8)
45#define ELE_MOVE_TO_UNSECURED_REQ (0xD9)
46#define ELE_GET_INFO_REQ (0xDA)
47#define ELE_ATTEST_REQ (0xDB)
48#define ELE_RELEASE_PATCH_REQ (0xDC)
49#define ELE_OTP_SEQ_SWITH_REQ (0xDD)
Ye Lia45bec82024-10-06 08:30:03 +080050#define ELE_WRITE_SHADOW_REQ (0xF2)
51#define ELE_READ_SHADOW_REQ (0xF3)
Ye Lic9e34362023-01-30 18:39:51 +080052
53/* ELE failure indications */
54#define ELE_ROM_PING_FAILURE_IND (0x0A)
55#define ELE_FW_PING_FAILURE_IND (0x1A)
56#define ELE_BAD_SIGNATURE_FAILURE_IND (0xF0)
57#define ELE_BAD_HASH_FAILURE_IND (0xF1)
58#define ELE_INVALID_LIFECYCLE_IND (0xF2)
59#define ELE_PERMISSION_DENIED_FAILURE_IND (0xF3)
60#define ELE_INVALID_MESSAGE_FAILURE_IND (0xF4)
61#define ELE_BAD_VALUE_FAILURE_IND (0xF5)
62#define ELE_BAD_FUSE_ID_FAILURE_IND (0xF6)
63#define ELE_BAD_CONTAINER_FAILURE_IND (0xF7)
64#define ELE_BAD_VERSION_FAILURE_IND (0xF8)
65#define ELE_INVALID_KEY_FAILURE_IND (0xF9)
66#define ELE_BAD_KEY_HASH_FAILURE_IND (0xFA)
67#define ELE_NO_VALID_CONTAINER_FAILURE_IND (0xFB)
68#define ELE_BAD_CERTIFICATE_FAILURE_IND (0xFC)
69#define ELE_BAD_UID_FAILURE_IND (0xFD)
70#define ELE_BAD_MONOTONIC_COUNTER_FAILURE_IND (0xFE)
71#define ELE_MUST_SIGNED_FAILURE_IND (0xE0)
72#define ELE_NO_AUTHENTICATION_FAILURE_IND (0xEE)
73#define ELE_BAD_SRK_SET_FAILURE_IND (0xEF)
74#define ELE_UNALIGNED_PAYLOAD_FAILURE_IND (0xA6)
75#define ELE_WRONG_SIZE_FAILURE_IND (0xA7)
76#define ELE_ENCRYPTION_FAILURE_IND (0xA8)
77#define ELE_DECRYPTION_FAILURE_IND (0xA9)
78#define ELE_OTP_PROGFAIL_FAILURE_IND (0xAA)
79#define ELE_OTP_LOCKED_FAILURE_IND (0xAB)
80#define ELE_OTP_INVALID_IDX_FAILURE_IND (0xAD)
81#define ELE_TIME_OUT_FAILURE_IND (0xB0)
82#define ELE_BAD_PAYLOAD_FAILURE_IND (0xB1)
83#define ELE_WRONG_ADDRESS_FAILURE_IND (0xB4)
84#define ELE_DMA_FAILURE_IND (0xB5)
85#define ELE_DISABLED_FEATURE_FAILURE_IND (0xB6)
86#define ELE_MUST_ATTEST_FAILURE_IND (0xB7)
87#define ELE_RNG_NOT_STARTED_FAILURE_IND (0xB8)
88#define ELE_CRC_ERROR_IND (0xB9)
89#define ELE_AUTH_SKIPPED_OR_FAILED_FAILURE_IND (0xBB)
90#define ELE_INCONSISTENT_PAR_FAILURE_IND (0xBC)
91#define ELE_RNG_INST_FAILURE_FAILURE_IND (0xBD)
92#define ELE_LOCKED_REG_FAILURE_IND (0xBE)
93#define ELE_BAD_ID_FAILURE_IND (0xBF)
94#define ELE_INVALID_OPERATION_FAILURE_IND (0xC0)
95#define ELE_NON_SECURE_STATE_FAILURE_IND (0xC1)
96#define ELE_MSG_TRUNCATED_IND (0xC2)
97#define ELE_BAD_IMAGE_NUM_FAILURE_IND (0xC3)
98#define ELE_BAD_IMAGE_ADDR_FAILURE_IND (0xC4)
99#define ELE_BAD_IMAGE_PARAM_FAILURE_IND (0xC5)
100#define ELE_BAD_IMAGE_TYPE_FAILURE_IND (0xC6)
101#define ELE_CORRUPTED_SRK_FAILURE_IND (0xD0)
102#define ELE_OUT_OF_MEMORY_IND (0xD1)
103#define ELE_CSTM_FAILURE_IND (0xCF)
104#define ELE_OLD_VERSION_FAILURE_IND (0xCE)
105#define ELE_WRONG_BOOT_MODE_FAILURE_IND (0xCD)
106#define ELE_APC_ALREADY_ENABLED_FAILURE_IND (0xCB)
107#define ELE_RTC_ALREADY_ENABLED_FAILURE_IND (0xCC)
108#define ELE_ABORT_IND (0xFF)
109
110/* ELE IPC identifier */
111#define ELE_IPC_MU_RTD (0x1)
112#define ELE_IPC_MU_APD (0x2)
113
114/* ELE Status*/
115#define ELE_SUCCESS_IND (0xD6)
116#define ELE_FAILURE_IND (0x29)
117
Peng Fand5c31832023-06-15 18:09:05 +0800118#define ELE_MAX_MSG 255U
Ye Li0db17f42021-08-07 16:00:41 +0800119
Peng Fand5c31832023-06-15 18:09:05 +0800120struct ele_msg {
Ye Li0db17f42021-08-07 16:00:41 +0800121 u8 version;
122 u8 size;
123 u8 command;
124 u8 tag;
Peng Fand5c31832023-06-15 18:09:05 +0800125 u32 data[(ELE_MAX_MSG - 1U)];
Ye Li0db17f42021-08-07 16:00:41 +0800126};
127
Peng Fand5c31832023-06-15 18:09:05 +0800128struct ele_get_info_data {
Peng Fancffe2b92022-07-26 16:40:52 +0800129 u32 hdr;
130 u32 soc;
131 u32 lc;
132 u32 uid[4];
133 u32 sha256_rom_patch[8];
134 u32 sha_fw[8];
Ye Lic30260e2023-01-31 16:42:26 +0800135 u32 oem_srkh[16];
136 u32 state;
Peng Fancffe2b92022-07-26 16:40:52 +0800137};
138
Peng Fand5c31832023-06-15 18:09:05 +0800139int ele_release_rdc(u8 core_id, u8 xrdc, u32 *response);
140int ele_auth_oem_ctnr(ulong ctnr_addr, u32 *response);
141int ele_release_container(u32 *response);
142int ele_verify_image(u32 img_id, u32 *response);
143int ele_forward_lifecycle(u16 life_cycle, u32 *response);
144int ele_write_fuse(u16 fuse_id, u32 fuse_val, bool lock, u32 *response);
145int ele_read_common_fuse(u16 fuse_id, u32 *fuse_words, u32 fuse_num, u32 *response);
146int ele_release_caam(u32 core_did, u32 *response);
147int ele_get_fw_version(u32 *fw_version, u32 *sha1, u32 *response);
148int ele_get_events(u32 *events, u32 *events_cnt, u32 *response);
Mathieu Othacehec6143392024-08-26 12:07:07 +0200149int ele_derive_huk(u8 *key, size_t key_size, u8 *ctx, size_t seed_size);
Mathieu Othacehe8df8e592024-03-21 08:19:53 +0100150int ele_commit(u16 fuse_id, u32 *response, u32 *info_type);
Peng Fan16426c82023-06-15 18:09:09 +0800151int ele_generate_dek_blob(u32 key_id, u32 src_paddr, u32 dst_paddr, u32 max_output_size);
Peng Fand5c31832023-06-15 18:09:05 +0800152int ele_dump_buffer(u32 *buffer, u32 buffer_length);
153int ele_get_info(struct ele_get_info_data *info, u32 *response);
154int ele_get_fw_status(u32 *status, u32 *response);
155int ele_release_m33_trout(void);
Peng Fanc88036d2023-06-15 18:09:08 +0800156int ele_write_secure_fuse(ulong signed_msg_blk, u32 *response);
157int ele_return_lifecycle_update(ulong signed_msg_blk, u32 *response);
Peng Fanaa70b852023-06-15 18:09:14 +0800158int ele_start_rng(void);
Ye Lia45bec82024-10-06 08:30:03 +0800159int ele_write_shadow_fuse(u32 fuse_id, u32 fuse_val, u32 *response);
160int ele_read_shadow_fuse(u32 fuse_id, u32 *fuse_val, u32 *response);
Ye Li0db17f42021-08-07 16:00:41 +0800161#endif