xref: /rk3399_ARM-atf/plat/intel/soc/common/socfpga_sip_svc_v2.c (revision f3083e2e6c508d58f9bce1b2fce5eeb0903a4c6d)
1ad47f142SSieu Mun Tang /*
2*6fcd047bSJit Loon Lim  * Copyright (c) 2022-2023, Intel Corporation. All rights reserved.
3*6fcd047bSJit Loon Lim  * Copyright (c) 2024-2025, Altera Corporation. All rights reserved.
4ad47f142SSieu Mun Tang  *
5ad47f142SSieu Mun Tang  * SPDX-License-Identifier: BSD-3-Clause
6ad47f142SSieu Mun Tang  */
7ad47f142SSieu Mun Tang 
8ad47f142SSieu Mun Tang #include <assert.h>
9ad47f142SSieu Mun Tang #include <common/debug.h>
10ad47f142SSieu Mun Tang #include <common/runtime_svc.h>
11ad47f142SSieu Mun Tang #include <lib/mmio.h>
12ad47f142SSieu Mun Tang 
13*6fcd047bSJit Loon Lim #include "lib/utils/alignment_utils.h"
14c436707bSSieu Mun Tang #include "socfpga_mailbox.h"
15ad47f142SSieu Mun Tang #include "socfpga_sip_svc.h"
16ad47f142SSieu Mun Tang 
intel_v2_mbox_send_cmd(uint32_t req_header,uint32_t * data,uint32_t data_size)17c436707bSSieu Mun Tang static uint32_t intel_v2_mbox_send_cmd(uint32_t req_header,
18c436707bSSieu Mun Tang 				uint32_t *data, uint32_t data_size)
19c436707bSSieu Mun Tang {
20c436707bSSieu Mun Tang 	uint32_t value;
21c436707bSSieu Mun Tang 	uint32_t len;
22c436707bSSieu Mun Tang 
23c436707bSSieu Mun Tang 	if ((data == NULL) || (data_size == 0)) {
24c436707bSSieu Mun Tang 		return INTEL_SIP_SMC_STATUS_REJECTED;
25c436707bSSieu Mun Tang 	}
26c436707bSSieu Mun Tang 
27c436707bSSieu Mun Tang 	if (data_size > (MBOX_INC_HEADER_MAX_WORD_SIZE * MBOX_WORD_BYTE)) {
28c436707bSSieu Mun Tang 		return INTEL_SIP_SMC_STATUS_REJECTED;
29c436707bSSieu Mun Tang 	}
30c436707bSSieu Mun Tang 
31c436707bSSieu Mun Tang 	if (!is_size_4_bytes_aligned(data_size)) {
32c436707bSSieu Mun Tang 		return INTEL_SIP_SMC_STATUS_REJECTED;
33c436707bSSieu Mun Tang 	}
34c436707bSSieu Mun Tang 
35c436707bSSieu Mun Tang 	/* Make sure client id align in SMC SiP V2 header and mailbox header */
36c436707bSSieu Mun Tang 	value = (req_header >> INTEL_SIP_SMC_HEADER_CID_OFFSET) &
37c436707bSSieu Mun Tang 				INTEL_SIP_SMC_HEADER_CID_MASK;
38c436707bSSieu Mun Tang 
39c436707bSSieu Mun Tang 	if (value != MBOX_RESP_CLIENT_ID(data[0])) {
40c436707bSSieu Mun Tang 		return INTEL_SIP_SMC_STATUS_REJECTED;
41c436707bSSieu Mun Tang 	}
42c436707bSSieu Mun Tang 
43c436707bSSieu Mun Tang 	/* Make sure job id align in SMC SiP V2 header and mailbox header */
44c436707bSSieu Mun Tang 	value = (req_header >> INTEL_SIP_SMC_HEADER_JOB_ID_OFFSET) &
45c436707bSSieu Mun Tang 				INTEL_SIP_SMC_HEADER_JOB_ID_MASK;
46c436707bSSieu Mun Tang 
47c436707bSSieu Mun Tang 	if (value != MBOX_RESP_JOB_ID(data[0])) {
48c436707bSSieu Mun Tang 		return INTEL_SIP_SMC_STATUS_REJECTED;
49c436707bSSieu Mun Tang 	}
50c436707bSSieu Mun Tang 
51c436707bSSieu Mun Tang 	/*
52c436707bSSieu Mun Tang 	 * Make sure data length align in SMC SiP V2 header and
53c436707bSSieu Mun Tang 	 * mailbox header
54c436707bSSieu Mun Tang 	 */
55c436707bSSieu Mun Tang 	len = (data_size / MBOX_WORD_BYTE) - 1;
56c436707bSSieu Mun Tang 
57c436707bSSieu Mun Tang 	if (len != MBOX_RESP_LEN(data[0])) {
58c436707bSSieu Mun Tang 		return INTEL_SIP_SMC_STATUS_REJECTED;
59c436707bSSieu Mun Tang 	}
60c436707bSSieu Mun Tang 
61c436707bSSieu Mun Tang 	return mailbox_send_cmd_async_ext(data[0], &data[1], len);
62c436707bSSieu Mun Tang }
63c436707bSSieu Mun Tang 
intel_v2_mbox_poll_resp(uint64_t req_header,uint32_t * data,uint32_t * data_size,uint64_t * resp_header)64c436707bSSieu Mun Tang static uint32_t intel_v2_mbox_poll_resp(uint64_t req_header,
65c436707bSSieu Mun Tang 				uint32_t *data, uint32_t *data_size,
66c436707bSSieu Mun Tang 				uint64_t *resp_header)
67c436707bSSieu Mun Tang {
68c436707bSSieu Mun Tang 	int status = 0;
69c436707bSSieu Mun Tang 	uint32_t resp_len;
70c436707bSSieu Mun Tang 	uint32_t job_id = 0;
71c436707bSSieu Mun Tang 	uint32_t client_id = 0;
72c436707bSSieu Mun Tang 	uint32_t version;
73c436707bSSieu Mun Tang 
74c436707bSSieu Mun Tang 	if ((data == NULL) || (data_size == NULL) || (resp_header == NULL)) {
75c436707bSSieu Mun Tang 		return INTEL_SIP_SMC_STATUS_REJECTED;
76c436707bSSieu Mun Tang 	}
77c436707bSSieu Mun Tang 
78c436707bSSieu Mun Tang 	if (!is_size_4_bytes_aligned(*data_size)) {
79c436707bSSieu Mun Tang 		return INTEL_SIP_SMC_STATUS_REJECTED;
80c436707bSSieu Mun Tang 	}
81c436707bSSieu Mun Tang 
82c436707bSSieu Mun Tang 	resp_len = (*data_size / MBOX_WORD_BYTE) - 1;
83c436707bSSieu Mun Tang 	status = mailbox_read_response_async(&job_id, &data[0], &data[1],
84c436707bSSieu Mun Tang 				&resp_len, 1);
85c436707bSSieu Mun Tang 
86c436707bSSieu Mun Tang 	if (status == MBOX_BUSY) {
87c436707bSSieu Mun Tang 		status = INTEL_SIP_SMC_STATUS_BUSY;
88c436707bSSieu Mun Tang 	} else if (status == MBOX_NO_RESPONSE) {
89c436707bSSieu Mun Tang 		status = INTEL_SIP_SMC_STATUS_NO_RESPONSE;
90c436707bSSieu Mun Tang 	} else {
91c436707bSSieu Mun Tang 		*data_size = 0;
92c436707bSSieu Mun Tang 
93c436707bSSieu Mun Tang 		if (resp_len > 0) {
94c436707bSSieu Mun Tang 			/*
95c436707bSSieu Mun Tang 			 * Fill in the final response length,
96c436707bSSieu Mun Tang 			 * the length include both mailbox header and payload
97c436707bSSieu Mun Tang 			 */
98c436707bSSieu Mun Tang 			*data_size = (resp_len + 1) * MBOX_WORD_BYTE;
99c436707bSSieu Mun Tang 
100c436707bSSieu Mun Tang 			/* Extract the client id from mailbox header */
101c436707bSSieu Mun Tang 			client_id = MBOX_RESP_CLIENT_ID(data[0]);
102c436707bSSieu Mun Tang 		}
103c436707bSSieu Mun Tang 
104c436707bSSieu Mun Tang 		/*
105c436707bSSieu Mun Tang 		 * Extract SMC SiP V2 protocol version from
106c436707bSSieu Mun Tang 		 * SMC request header
107c436707bSSieu Mun Tang 		 */
108c436707bSSieu Mun Tang 		version = (req_header >> INTEL_SIP_SMC_HEADER_VERSION_OFFSET) &
109c436707bSSieu Mun Tang 				INTEL_SIP_SMC_HEADER_VERSION_MASK;
110c436707bSSieu Mun Tang 
111c436707bSSieu Mun Tang 		/* Fill in SMC SiP V2 protocol response header */
112c436707bSSieu Mun Tang 		*resp_header = 0;
113c436707bSSieu Mun Tang 		*resp_header |= (((uint64_t)job_id) &
114c436707bSSieu Mun Tang 				INTEL_SIP_SMC_HEADER_JOB_ID_MASK) <<
115c436707bSSieu Mun Tang 				INTEL_SIP_SMC_HEADER_JOB_ID_OFFSET;
116c436707bSSieu Mun Tang 		*resp_header |= (((uint64_t)client_id) &
117c436707bSSieu Mun Tang 				INTEL_SIP_SMC_HEADER_CID_MASK) <<
118c436707bSSieu Mun Tang 				INTEL_SIP_SMC_HEADER_CID_OFFSET;
119c436707bSSieu Mun Tang 		*resp_header |= (((uint64_t)version) &
120c436707bSSieu Mun Tang 				INTEL_SIP_SMC_HEADER_VERSION_MASK) <<
121c436707bSSieu Mun Tang 				INTEL_SIP_SMC_HEADER_VERSION_OFFSET;
122c436707bSSieu Mun Tang 	}
123c436707bSSieu Mun Tang 
124c436707bSSieu Mun Tang 	return status;
125c436707bSSieu Mun Tang }
126c436707bSSieu Mun Tang 
sip_smc_handler_v2(uint32_t smc_fid,u_register_t x1,u_register_t x2,u_register_t x3,u_register_t x4,void * cookie,void * handle,u_register_t flags)127ad47f142SSieu Mun Tang uintptr_t sip_smc_handler_v2(uint32_t smc_fid,
128ad47f142SSieu Mun Tang 				u_register_t x1,
129ad47f142SSieu Mun Tang 				u_register_t x2,
130ad47f142SSieu Mun Tang 				u_register_t x3,
131ad47f142SSieu Mun Tang 				u_register_t x4,
132ad47f142SSieu Mun Tang 				void *cookie,
133ad47f142SSieu Mun Tang 				void *handle,
134ad47f142SSieu Mun Tang 				u_register_t flags)
135ad47f142SSieu Mun Tang {
136ad47f142SSieu Mun Tang 	uint32_t retval = 0;
137c436707bSSieu Mun Tang 	uint64_t retval64 = 0;
138ad47f142SSieu Mun Tang 	int status = INTEL_SIP_SMC_STATUS_OK;
139ad47f142SSieu Mun Tang 
140ad47f142SSieu Mun Tang 	switch (smc_fid) {
141ad47f142SSieu Mun Tang 	case INTEL_SIP_SMC_V2_GET_SVC_VERSION:
142ad47f142SSieu Mun Tang 		SMC_RET4(handle, INTEL_SIP_SMC_STATUS_OK, x1,
143ad47f142SSieu Mun Tang 				SIP_SVC_VERSION_MAJOR,
144ad47f142SSieu Mun Tang 				SIP_SVC_VERSION_MINOR);
145ad47f142SSieu Mun Tang 
146ad47f142SSieu Mun Tang 	case INTEL_SIP_SMC_V2_REG_READ:
147ad47f142SSieu Mun Tang 		status = intel_secure_reg_read(x2, &retval);
148ad47f142SSieu Mun Tang 		SMC_RET4(handle, status, x1, retval, x2);
149ad47f142SSieu Mun Tang 
150ad47f142SSieu Mun Tang 	case INTEL_SIP_SMC_V2_REG_WRITE:
151ad47f142SSieu Mun Tang 		status = intel_secure_reg_write(x2, (uint32_t)x3, &retval);
152ad47f142SSieu Mun Tang 		SMC_RET4(handle, status, x1, retval, x2);
153ad47f142SSieu Mun Tang 
154ad47f142SSieu Mun Tang 	case INTEL_SIP_SMC_V2_REG_UPDATE:
155ad47f142SSieu Mun Tang 		status = intel_secure_reg_update(x2, (uint32_t)x3,
156ad47f142SSieu Mun Tang 				(uint32_t)x4, &retval);
157ad47f142SSieu Mun Tang 		SMC_RET4(handle, status, x1, retval, x2);
158ad47f142SSieu Mun Tang 
159ad47f142SSieu Mun Tang 	case INTEL_SIP_SMC_V2_HPS_SET_BRIDGES:
160ad47f142SSieu Mun Tang 		status = intel_hps_set_bridges(x2, x3);
161ad47f142SSieu Mun Tang 		SMC_RET2(handle, status, x1);
162ad47f142SSieu Mun Tang 
163e3c3a48cSMahesh Rao 	case INTEL_SIP_SMC_V2_RSU_UPDATE_ADDR:
164e3c3a48cSMahesh Rao 		status = intel_rsu_update(x2);
165e3c3a48cSMahesh Rao 		SMC_RET2(handle, status, x1);
166e3c3a48cSMahesh Rao 
167c436707bSSieu Mun Tang 	case INTEL_SIP_SMC_V2_MAILBOX_SEND_COMMAND:
168c436707bSSieu Mun Tang 		status = intel_v2_mbox_send_cmd(x1, (uint32_t *)x2, x3);
169c436707bSSieu Mun Tang 		SMC_RET2(handle, status, x1);
170c436707bSSieu Mun Tang 
171c436707bSSieu Mun Tang 	case INTEL_SIP_SMC_V2_MAILBOX_POLL_RESPONSE:
172c436707bSSieu Mun Tang 		status = intel_v2_mbox_poll_resp(x1, (uint32_t *)x2,
173c436707bSSieu Mun Tang 				(uint32_t *) &x3, &retval64);
174c436707bSSieu Mun Tang 		SMC_RET4(handle, status, retval64, x2, x3);
175c436707bSSieu Mun Tang 
176ad47f142SSieu Mun Tang 	default:
177ad47f142SSieu Mun Tang 		ERROR("%s: unhandled SMC V2 (0x%x)\n", __func__, smc_fid);
178ad47f142SSieu Mun Tang 		SMC_RET1(handle, SMC_UNK);
179ad47f142SSieu Mun Tang 	}
180ad47f142SSieu Mun Tang }
181