1*91f16700Schasinglulu /* 2*91f16700Schasinglulu * Copyright (c) 2022-2023, ARM Limited and Contributors. All rights reserved. 3*91f16700Schasinglulu * 4*91f16700Schasinglulu * SPDX-License-Identifier: BSD-3-Clause 5*91f16700Schasinglulu */ 6*91f16700Schasinglulu 7*91f16700Schasinglulu #ifndef MTK_SIP_SVC_H 8*91f16700Schasinglulu #define MTK_SIP_SVC_H 9*91f16700Schasinglulu 10*91f16700Schasinglulu #include <stdint.h> 11*91f16700Schasinglulu #include <lib/smccc.h> 12*91f16700Schasinglulu #include <mtk_sip_def.h> 13*91f16700Schasinglulu 14*91f16700Schasinglulu /* SMC function IDs for SiP Service queries */ 15*91f16700Schasinglulu #define SIP_SVC_CALL_COUNT U(0x8200ff00) 16*91f16700Schasinglulu #define SIP_SVC_UID U(0x8200ff01) 17*91f16700Schasinglulu /* 0x8200ff02 is reserved */ 18*91f16700Schasinglulu #define SIP_SVC_VERSION U(0x8200ff03) 19*91f16700Schasinglulu 20*91f16700Schasinglulu /* MediaTek SiP Service Calls version numbers */ 21*91f16700Schasinglulu #define MTK_SIP_SVC_VERSION_MAJOR U(0x0) 22*91f16700Schasinglulu #define MTK_SIP_SVC_VERSION_MINOR U(0x1) 23*91f16700Schasinglulu 24*91f16700Schasinglulu /* Number of MediaTek SiP Calls implemented */ 25*91f16700Schasinglulu #define MTK_COMMON_SIP_NUM_CALLS U(4) 26*91f16700Schasinglulu 27*91f16700Schasinglulu /* MediaTek SiP Service Calls function IDs */ 28*91f16700Schasinglulu #define MTK_SIP_SET_AUTHORIZED_SECURE_REG U(0x82000001) 29*91f16700Schasinglulu 30*91f16700Schasinglulu #define SMC_ID_EXPAND_AS_ENUM(_smc_id, _smc_num) \ 31*91f16700Schasinglulu _smc_id##_AARCH32 = ((SMC_TYPE_FAST << FUNCID_TYPE_SHIFT) | \ 32*91f16700Schasinglulu ((0) << FUNCID_CC_SHIFT) | \ 33*91f16700Schasinglulu (OEN_SIP_START << FUNCID_OEN_SHIFT) | \ 34*91f16700Schasinglulu ((_smc_num) << FUNCID_NUM_SHIFT)), \ 35*91f16700Schasinglulu _smc_id##_AARCH64 = ((SMC_TYPE_FAST << FUNCID_TYPE_SHIFT) | \ 36*91f16700Schasinglulu ((1) << FUNCID_CC_SHIFT) | \ 37*91f16700Schasinglulu (OEN_SIP_START << FUNCID_OEN_SHIFT) | \ 38*91f16700Schasinglulu ((_smc_num) << FUNCID_NUM_SHIFT)), 39*91f16700Schasinglulu 40*91f16700Schasinglulu #define SMC_ID_EXPAND_AS_EXTERN_SMC_INDEX(_smc_id, _smc_num) \ 41*91f16700Schasinglulu extern short _smc_id##_descriptor_index; 42*91f16700Schasinglulu 43*91f16700Schasinglulu /* Bind SMC handler with SMC ID */ 44*91f16700Schasinglulu #define DECLARE_SMC_HANDLER(_smc_id, _smc_handler) \ 45*91f16700Schasinglulu const struct smc_descriptor _smc_id##_descriptor \ 46*91f16700Schasinglulu __used \ 47*91f16700Schasinglulu __aligned(sizeof(void *)) \ 48*91f16700Schasinglulu __section(".mtk_smc_descriptor_pool") = { \ 49*91f16700Schasinglulu .smc_handler = _smc_handler, \ 50*91f16700Schasinglulu .smc_name = #_smc_id, \ 51*91f16700Schasinglulu .smc_id_aarch32 = _smc_id##_AARCH32, \ 52*91f16700Schasinglulu .smc_id_aarch64 = _smc_id##_AARCH64, \ 53*91f16700Schasinglulu .smc_descriptor_index = &_smc_id##_descriptor_index \ 54*91f16700Schasinglulu } 55*91f16700Schasinglulu 56*91f16700Schasinglulu MTK_SIP_SMC_FROM_BL33_TABLE(SMC_ID_EXPAND_AS_EXTERN_SMC_INDEX); 57*91f16700Schasinglulu MTK_SIP_SMC_FROM_NS_EL1_TABLE(SMC_ID_EXPAND_AS_EXTERN_SMC_INDEX); 58*91f16700Schasinglulu MTK_SIP_SMC_FROM_S_EL1_TABLE(SMC_ID_EXPAND_AS_EXTERN_SMC_INDEX); 59*91f16700Schasinglulu 60*91f16700Schasinglulu /* Expand SiP SMC ID table as enum */ 61*91f16700Schasinglulu enum { 62*91f16700Schasinglulu MTK_SIP_SMC_FROM_BL33_TABLE(SMC_ID_EXPAND_AS_ENUM) 63*91f16700Schasinglulu MTK_SIP_SMC_FROM_NS_EL1_TABLE(SMC_ID_EXPAND_AS_ENUM) 64*91f16700Schasinglulu MTK_SIP_SMC_FROM_S_EL1_TABLE(SMC_ID_EXPAND_AS_ENUM) 65*91f16700Schasinglulu MTK_SIP_SMC_MAX_NUMBER 66*91f16700Schasinglulu }; 67*91f16700Schasinglulu 68*91f16700Schasinglulu /* MediaTek SiP Calls error code */ 69*91f16700Schasinglulu enum { 70*91f16700Schasinglulu MTK_SIP_E_SUCCESS = 0, 71*91f16700Schasinglulu MTK_SIP_E_INVALID_PARAM = -1, 72*91f16700Schasinglulu MTK_SIP_E_NOT_SUPPORTED = -2, 73*91f16700Schasinglulu MTK_SIP_E_INVALID_RANGE = -3, 74*91f16700Schasinglulu MTK_SIP_E_PERMISSION_DENY = -4, 75*91f16700Schasinglulu MTK_SIP_E_LOCK_FAIL = -5, 76*91f16700Schasinglulu }; 77*91f16700Schasinglulu 78*91f16700Schasinglulu struct smccc_res { 79*91f16700Schasinglulu uint64_t a1; 80*91f16700Schasinglulu uint64_t a2; 81*91f16700Schasinglulu uint64_t a3; 82*91f16700Schasinglulu }; 83*91f16700Schasinglulu 84*91f16700Schasinglulu typedef uintptr_t (*smc_handler_t)(u_register_t, 85*91f16700Schasinglulu u_register_t, 86*91f16700Schasinglulu u_register_t, 87*91f16700Schasinglulu u_register_t, 88*91f16700Schasinglulu void *, 89*91f16700Schasinglulu struct smccc_res *); 90*91f16700Schasinglulu 91*91f16700Schasinglulu struct smc_descriptor { 92*91f16700Schasinglulu smc_handler_t smc_handler; 93*91f16700Schasinglulu const uint32_t smc_id_aarch32; 94*91f16700Schasinglulu const uint32_t smc_id_aarch64; 95*91f16700Schasinglulu const char *smc_name; 96*91f16700Schasinglulu short *const smc_descriptor_index; 97*91f16700Schasinglulu }; 98*91f16700Schasinglulu 99*91f16700Schasinglulu /* 100*91f16700Schasinglulu * This function should be implemented in MediaTek SOC directory. It fulfills 101*91f16700Schasinglulu * MTK_SIP_SET_AUTHORIZED_SECURE_REG SiP call by checking the sreg with the 102*91f16700Schasinglulu * predefined secure register list, if a match was found, set val to sreg. 103*91f16700Schasinglulu * 104*91f16700Schasinglulu * Return MTK_SIP_E_SUCCESS on success, and MTK_SIP_E_INVALID_PARAM on failure. 105*91f16700Schasinglulu */ 106*91f16700Schasinglulu uint64_t mt_sip_set_authorized_sreg(uint32_t sreg, uint32_t val); 107*91f16700Schasinglulu 108*91f16700Schasinglulu #endif /* MTK_SIP_SVC_H */ 109