xref: /rk3399_ARM-atf/include/drivers/arm/ethosn.h (revision 2a2e3e87706b56fd1b8e787d3a552cfc12725934)
176a21174SMikael Olsson /*
2fa37d308SJoshua Pimm  * Copyright (c) 2021-2023, Arm Limited. All rights reserved.
376a21174SMikael Olsson  *
476a21174SMikael Olsson  * SPDX-License-Identifier: BSD-3-Clause
576a21174SMikael Olsson  */
676a21174SMikael Olsson 
776a21174SMikael Olsson #ifndef ETHOSN_H
876a21174SMikael Olsson #define ETHOSN_H
976a21174SMikael Olsson 
1076a21174SMikael Olsson #include <lib/smccc.h>
1176a21174SMikael Olsson 
1276a21174SMikael Olsson /* Function numbers */
1376a21174SMikael Olsson #define ETHOSN_FNUM_VERSION		U(0x50)
1476a21174SMikael Olsson #define ETHOSN_FNUM_IS_SEC		U(0x51)
1576a21174SMikael Olsson #define ETHOSN_FNUM_HARD_RESET		U(0x52)
1676a21174SMikael Olsson #define ETHOSN_FNUM_SOFT_RESET		U(0x53)
17*2a2e3e87SMikael Olsson #define ETHOSN_FNUM_IS_SLEEPING		U(0x54)
18*2a2e3e87SMikael Olsson /* 0x55-0x5F reserved for future use */
1976a21174SMikael Olsson 
2076a21174SMikael Olsson /* SMC64 function IDs */
2176a21174SMikael Olsson #define ETHOSN_FID_64(func_num)		U(0xC2000000 | func_num)
2276a21174SMikael Olsson #define ETHOSN_FID_VERSION_64		ETHOSN_FID_64(ETHOSN_FNUM_VERSION)
2376a21174SMikael Olsson #define ETHOSN_FID_IS_SEC_64		ETHOSN_FID_64(ETHOSN_FNUM_IS_SEC)
2476a21174SMikael Olsson #define ETHOSN_FID_HARD_RESET_64	ETHOSN_FID_64(ETHOSN_FNUM_HARD_RESET)
2576a21174SMikael Olsson #define ETHOSN_FID_SOFT_RESET_64	ETHOSN_FID_64(ETHOSN_FNUM_SOFT_RESET)
2676a21174SMikael Olsson 
2776a21174SMikael Olsson /* SMC32 function IDs */
2876a21174SMikael Olsson #define ETHOSN_FID_32(func_num)		U(0x82000000 | func_num)
2976a21174SMikael Olsson #define ETHOSN_FID_VERSION_32		ETHOSN_FID_32(ETHOSN_FNUM_VERSION)
3076a21174SMikael Olsson #define ETHOSN_FID_IS_SEC_32		ETHOSN_FID_32(ETHOSN_FNUM_IS_SEC)
3176a21174SMikael Olsson #define ETHOSN_FID_HARD_RESET_32	ETHOSN_FID_32(ETHOSN_FNUM_HARD_RESET)
3276a21174SMikael Olsson #define ETHOSN_FID_SOFT_RESET_32	ETHOSN_FID_32(ETHOSN_FNUM_SOFT_RESET)
3376a21174SMikael Olsson 
3476a21174SMikael Olsson #define ETHOSN_NUM_SMC_CALLS	8
3576a21174SMikael Olsson 
3676a21174SMikael Olsson /* Macro to identify function calls */
3776a21174SMikael Olsson #define ETHOSN_FID_MASK		U(0xFFF0)
3876a21174SMikael Olsson #define ETHOSN_FID_VALUE	U(0x50)
3976a21174SMikael Olsson #define is_ethosn_fid(_fid) (((_fid) & ETHOSN_FID_MASK) == ETHOSN_FID_VALUE)
4076a21174SMikael Olsson 
4176a21174SMikael Olsson /* Service version  */
42b139f1cfSMikael Olsson #define ETHOSN_VERSION_MAJOR U(2)
43*2a2e3e87SMikael Olsson #define ETHOSN_VERSION_MINOR U(2)
4476a21174SMikael Olsson 
4576a21174SMikael Olsson /* Return codes for function calls */
4676a21174SMikael Olsson #define ETHOSN_SUCCESS			 0
4776a21174SMikael Olsson #define ETHOSN_NOT_SUPPORTED		-1
4876a21174SMikael Olsson /* -2 Reserved for NOT_REQUIRED */
49fa37d308SJoshua Pimm #define ETHOSN_INVALID_PARAMETER	-3
5076a21174SMikael Olsson #define ETHOSN_FAILURE			-4
511c65989eSLaurent Carlier #define ETHOSN_UNKNOWN_CORE_ADDRESS	-5
52b139f1cfSMikael Olsson #define ETHOSN_UNKNOWN_ALLOCATOR_IDX	-6
5376a21174SMikael Olsson 
54fa37d308SJoshua Pimm /*
55fa37d308SJoshua Pimm  * Argument types for soft and hard resets to indicate whether to reset
56fa37d308SJoshua Pimm  * and reconfigure the NPU or only halt it
57fa37d308SJoshua Pimm  */
58fa37d308SJoshua Pimm #define ETHOSN_RESET_TYPE_FULL		U(0)
59fa37d308SJoshua Pimm #define ETHOSN_RESET_TYPE_HALT		U(1)
60fa37d308SJoshua Pimm 
6176a21174SMikael Olsson uintptr_t ethosn_smc_handler(uint32_t smc_fid,
621c65989eSLaurent Carlier 			     u_register_t core_addr,
63b139f1cfSMikael Olsson 			     u_register_t asset_alloc_idx,
64fa37d308SJoshua Pimm 			     u_register_t reset_type,
6576a21174SMikael Olsson 			     u_register_t x4,
6676a21174SMikael Olsson 			     void *cookie,
6776a21174SMikael Olsson 			     void *handle,
6876a21174SMikael Olsson 			     u_register_t flags);
6976a21174SMikael Olsson 
7076a21174SMikael Olsson #endif  /* ETHOSN_H */
71