blob: 5582ff1a2540f433a980465fb732d66f3948fa7c [file] [log] [blame]
Ye Li0db17f42021-08-07 16:00:41 +08001/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * Copyright 2021 NXP
4 */
5
6#ifndef __S400_API_H__
7#define __S400_API_H__
8
9#define AHAB_VERSION 0x6
10#define AHAB_CMD_TAG 0x17
11#define AHAB_RESP_TAG 0xe1
12
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)
27#define ELE_ENABLE_PATCH_REQ (0xC3)
28#define ELE_RELEASE_RDC_REQ (0xC4)
29#define ELE_GET_FW_STATUS_REQ (0xC5)
30#define ELE_ENABLE_OTFAD_REQ (0xC6)
31#define ELE_RESET_REQ (0xC7)
32#define ELE_UPDATE_OTP_CLKDIV_REQ (0xD0)
33#define ELE_POWER_DOWN_REQ (0xD1)
34#define ELE_ENABLE_APC_REQ (0xD2)
35#define ELE_ENABLE_RTC_REQ (0xD3)
36#define ELE_DEEP_POWER_DOWN_REQ (0xD4)
37#define ELE_STOP_RST_TIMER_REQ (0xD5)
38#define ELE_WRITE_FUSE_REQ (0xD6)
39#define ELE_RELEASE_CAAM_REQ (0xD7)
40#define ELE_RESET_A35_CTX_REQ (0xD8)
41#define ELE_MOVE_TO_UNSECURED_REQ (0xD9)
42#define ELE_GET_INFO_REQ (0xDA)
43#define ELE_ATTEST_REQ (0xDB)
44#define ELE_RELEASE_PATCH_REQ (0xDC)
45#define ELE_OTP_SEQ_SWITH_REQ (0xDD)
46
47/* ELE failure indications */
48#define ELE_ROM_PING_FAILURE_IND (0x0A)
49#define ELE_FW_PING_FAILURE_IND (0x1A)
50#define ELE_BAD_SIGNATURE_FAILURE_IND (0xF0)
51#define ELE_BAD_HASH_FAILURE_IND (0xF1)
52#define ELE_INVALID_LIFECYCLE_IND (0xF2)
53#define ELE_PERMISSION_DENIED_FAILURE_IND (0xF3)
54#define ELE_INVALID_MESSAGE_FAILURE_IND (0xF4)
55#define ELE_BAD_VALUE_FAILURE_IND (0xF5)
56#define ELE_BAD_FUSE_ID_FAILURE_IND (0xF6)
57#define ELE_BAD_CONTAINER_FAILURE_IND (0xF7)
58#define ELE_BAD_VERSION_FAILURE_IND (0xF8)
59#define ELE_INVALID_KEY_FAILURE_IND (0xF9)
60#define ELE_BAD_KEY_HASH_FAILURE_IND (0xFA)
61#define ELE_NO_VALID_CONTAINER_FAILURE_IND (0xFB)
62#define ELE_BAD_CERTIFICATE_FAILURE_IND (0xFC)
63#define ELE_BAD_UID_FAILURE_IND (0xFD)
64#define ELE_BAD_MONOTONIC_COUNTER_FAILURE_IND (0xFE)
65#define ELE_MUST_SIGNED_FAILURE_IND (0xE0)
66#define ELE_NO_AUTHENTICATION_FAILURE_IND (0xEE)
67#define ELE_BAD_SRK_SET_FAILURE_IND (0xEF)
68#define ELE_UNALIGNED_PAYLOAD_FAILURE_IND (0xA6)
69#define ELE_WRONG_SIZE_FAILURE_IND (0xA7)
70#define ELE_ENCRYPTION_FAILURE_IND (0xA8)
71#define ELE_DECRYPTION_FAILURE_IND (0xA9)
72#define ELE_OTP_PROGFAIL_FAILURE_IND (0xAA)
73#define ELE_OTP_LOCKED_FAILURE_IND (0xAB)
74#define ELE_OTP_INVALID_IDX_FAILURE_IND (0xAD)
75#define ELE_TIME_OUT_FAILURE_IND (0xB0)
76#define ELE_BAD_PAYLOAD_FAILURE_IND (0xB1)
77#define ELE_WRONG_ADDRESS_FAILURE_IND (0xB4)
78#define ELE_DMA_FAILURE_IND (0xB5)
79#define ELE_DISABLED_FEATURE_FAILURE_IND (0xB6)
80#define ELE_MUST_ATTEST_FAILURE_IND (0xB7)
81#define ELE_RNG_NOT_STARTED_FAILURE_IND (0xB8)
82#define ELE_CRC_ERROR_IND (0xB9)
83#define ELE_AUTH_SKIPPED_OR_FAILED_FAILURE_IND (0xBB)
84#define ELE_INCONSISTENT_PAR_FAILURE_IND (0xBC)
85#define ELE_RNG_INST_FAILURE_FAILURE_IND (0xBD)
86#define ELE_LOCKED_REG_FAILURE_IND (0xBE)
87#define ELE_BAD_ID_FAILURE_IND (0xBF)
88#define ELE_INVALID_OPERATION_FAILURE_IND (0xC0)
89#define ELE_NON_SECURE_STATE_FAILURE_IND (0xC1)
90#define ELE_MSG_TRUNCATED_IND (0xC2)
91#define ELE_BAD_IMAGE_NUM_FAILURE_IND (0xC3)
92#define ELE_BAD_IMAGE_ADDR_FAILURE_IND (0xC4)
93#define ELE_BAD_IMAGE_PARAM_FAILURE_IND (0xC5)
94#define ELE_BAD_IMAGE_TYPE_FAILURE_IND (0xC6)
95#define ELE_CORRUPTED_SRK_FAILURE_IND (0xD0)
96#define ELE_OUT_OF_MEMORY_IND (0xD1)
97#define ELE_CSTM_FAILURE_IND (0xCF)
98#define ELE_OLD_VERSION_FAILURE_IND (0xCE)
99#define ELE_WRONG_BOOT_MODE_FAILURE_IND (0xCD)
100#define ELE_APC_ALREADY_ENABLED_FAILURE_IND (0xCB)
101#define ELE_RTC_ALREADY_ENABLED_FAILURE_IND (0xCC)
102#define ELE_ABORT_IND (0xFF)
103
104/* ELE IPC identifier */
105#define ELE_IPC_MU_RTD (0x1)
106#define ELE_IPC_MU_APD (0x2)
107
108/* ELE Status*/
109#define ELE_SUCCESS_IND (0xD6)
110#define ELE_FAILURE_IND (0x29)
111
Ye Li0a917da2022-04-06 14:30:20 +0800112#define S400_MAX_MSG 255U
Ye Li0db17f42021-08-07 16:00:41 +0800113
Ye Lic843d5e2022-07-26 16:40:57 +0800114struct sentinel_msg {
Ye Li0db17f42021-08-07 16:00:41 +0800115 u8 version;
116 u8 size;
117 u8 command;
118 u8 tag;
119 u32 data[(S400_MAX_MSG - 1U)];
120};
121
Peng Fancffe2b92022-07-26 16:40:52 +0800122struct sentinel_get_info_data {
123 u32 hdr;
124 u32 soc;
125 u32 lc;
126 u32 uid[4];
127 u32 sha256_rom_patch[8];
128 u32 sha_fw[8];
Ye Lic30260e2023-01-31 16:42:26 +0800129 u32 oem_srkh[16];
130 u32 state;
Peng Fancffe2b92022-07-26 16:40:52 +0800131};
132
Ye Lid4b3ba32022-07-26 16:40:51 +0800133int ahab_release_rdc(u8 core_id, u8 xrdc, u32 *response);
Ye Lia61f2672021-08-07 16:00:52 +0800134int ahab_auth_oem_ctnr(ulong ctnr_addr, u32 *response);
135int ahab_release_container(u32 *response);
136int ahab_verify_image(u32 img_id, u32 *response);
137int ahab_forward_lifecycle(u16 life_cycle, u32 *response);
Ye Lif80a41b2021-08-07 16:00:54 +0800138int ahab_write_fuse(u16 fuse_id, u32 fuse_val, bool lock, u32 *response);
139int ahab_read_common_fuse(u16 fuse_id, u32 *fuse_words, u32 fuse_num, u32 *response);
Clement Faure26386ae2022-04-06 14:30:19 +0800140int ahab_release_caam(u32 core_did, u32 *response);
Gaurav Jain580cc7b2022-05-11 14:07:55 +0530141int ahab_get_fw_version(u32 *fw_version, u32 *sha1, u32 *response);
Ye Li0a917da2022-04-06 14:30:20 +0800142int ahab_dump_buffer(u32 *buffer, u32 buffer_length);
Peng Fancffe2b92022-07-26 16:40:52 +0800143int ahab_get_info(struct sentinel_get_info_data *info, u32 *response);
144int ahab_get_fw_status(u32 *status, u32 *response);
Peng Fanf6ff1402022-07-26 16:40:53 +0800145int ahab_release_m33_trout(void);
Ye Li395bfd42023-01-30 18:39:50 +0800146int ahab_get_events(u32 *events, u32 *events_cnt, u32 *response);
Ye Lia61f2672021-08-07 16:00:52 +0800147
Ye Li0db17f42021-08-07 16:00:41 +0800148#endif