xref: /arm-trusted-firmware/include/services/trng_svc.h (revision 91f16700b400a8c0651d24a598fc48ee2997a0d7)
1*91f16700Schasinglulu /*
2*91f16700Schasinglulu  * Copyright (c) 2021-2022, ARM Limited. All rights reserved.
3*91f16700Schasinglulu  *
4*91f16700Schasinglulu  * SPDX-License-Identifier: BSD-3-Clause
5*91f16700Schasinglulu  */
6*91f16700Schasinglulu 
7*91f16700Schasinglulu #ifndef TRNG_SVC_H
8*91f16700Schasinglulu #define TRNG_SVC_H
9*91f16700Schasinglulu 
10*91f16700Schasinglulu #include <stdbool.h>
11*91f16700Schasinglulu #include <stdint.h>
12*91f16700Schasinglulu 
13*91f16700Schasinglulu #include <lib/smccc.h>
14*91f16700Schasinglulu 
15*91f16700Schasinglulu /* SMC function IDs for TRNG queries */
16*91f16700Schasinglulu #define ARM_TRNG_VERSION	U(0x84000050)
17*91f16700Schasinglulu #define ARM_TRNG_FEATURES	U(0x84000051)
18*91f16700Schasinglulu #define ARM_TRNG_GET_UUID	U(0x84000052)
19*91f16700Schasinglulu #define ARM_TRNG_RND32		U(0x84000053)
20*91f16700Schasinglulu #define ARM_TRNG_RND64		U(0xC4000053)
21*91f16700Schasinglulu 
22*91f16700Schasinglulu /* TRNG version numbers */
23*91f16700Schasinglulu #define TRNG_VERSION_MAJOR	(0x1)
24*91f16700Schasinglulu #define TRNG_VERSION_MINOR	(0x0)
25*91f16700Schasinglulu 
26*91f16700Schasinglulu /* TRNG Error Numbers */
27*91f16700Schasinglulu #define TRNG_E_SUCCESS		(0)
28*91f16700Schasinglulu #define TRNG_E_NOT_SUPPORTED	(-1)
29*91f16700Schasinglulu #define TRNG_E_INVALID_PARAMS	(-2)
30*91f16700Schasinglulu #define TRNG_E_NO_ENTROPY	(-3)
31*91f16700Schasinglulu #define TRNG_E_NOT_IMPLEMENTED	(-4)
32*91f16700Schasinglulu 
33*91f16700Schasinglulu /* TRNG Entropy Bit Numbers */
34*91f16700Schasinglulu #define TRNG_RND32_ENTROPY_MAXBITS	(96U)
35*91f16700Schasinglulu #define TRNG_RND64_ENTROPY_MAXBITS	(192U)
36*91f16700Schasinglulu 
37*91f16700Schasinglulu /* Public API to perform the initial TRNG entropy setup */
38*91f16700Schasinglulu void trng_setup(void);
39*91f16700Schasinglulu 
40*91f16700Schasinglulu /* Public API to verify function id is part of TRNG */
41*91f16700Schasinglulu bool is_trng_fid(uint32_t smc_fid);
42*91f16700Schasinglulu 
43*91f16700Schasinglulu /* Handler to be called to handle TRNG smc calls */
44*91f16700Schasinglulu uintptr_t trng_smc_handler(
45*91f16700Schasinglulu 	uint32_t smc_fid,
46*91f16700Schasinglulu 	u_register_t x1,
47*91f16700Schasinglulu 	u_register_t x2,
48*91f16700Schasinglulu 	u_register_t x3,
49*91f16700Schasinglulu 	u_register_t x4,
50*91f16700Schasinglulu 	void *cookie,
51*91f16700Schasinglulu 	void *handle,
52*91f16700Schasinglulu 	u_register_t flags
53*91f16700Schasinglulu );
54*91f16700Schasinglulu 
55*91f16700Schasinglulu #endif /* TRNG_SVC_H */
56