xref: /optee_os/core/drivers/dra7_rng.c (revision 3d3b05918ec9052ba13de82fbcaba204766eb636)
1 // SPDX-License-Identifier: BSD-2-Clause
2 /*
3  * Copyright (c) 2016, Linaro Limited
4  */
5 
6 #include <initcall.h>
7 #include <io.h>
8 #include <keep.h>
9 #include <kernel/interrupt.h>
10 #include <kernel/misc.h>
11 #include <kernel/spinlock.h>
12 #include <mm/core_memprot.h>
13 #include <mm/core_mmu.h>
14 #include <platform_config.h>
15 #include <rng_support.h>
16 
17 #define	RNG_OUTPUT_L            0x0000
18 #define	RNG_OUTPUT_H            0x0004
19 #define	RNG_STATUS              0x0008
20 #  define RNG_READY             BIT(0)
21 #  define SHUTDOWN_OFLO         BIT(1)
22 #define	RNG_INTMASK             0x000C
23 #define	RNG_INTACK              0x0010
24 #define	RNG_CONTROL             0x0014
25 #  define ENABLE_TRNG           BIT(10)
26 #define	RNG_CONFIG              0x0018
27 #define	RNG_ALARMCNT            0x001C
28 #define	RNG_FROENABLE           0x0020
29 #define	RNG_FRODETUNE           0x0024
30 #define	RNG_ALARMMASK           0x0028
31 #define	RNG_ALARMSTOP           0x002C
32 #define	RNG_LFSR_L              0x0030
33 #define	RNG_LFSR_M              0x0034
34 #define	RNG_LFSR_H              0x0038
35 #define	RNG_COUNT               0x003C
36 #define	RNG_OPTIONS             0x0078
37 #define	RNG_EIP_REV             0x007C
38 #define	RNG_MMR_STATUS_EN       0x1FD8
39 #define	RNG_REV                 0x1FE0
40 #define	RNG_SYS_CONFIG_REG      0x1FE4
41 #  define RNG_AUTOIDLE          BIT(0)
42 #define	RNG_MMR_STATUS_SET      0x1FEC
43 #define	RNG_SOFT_RESET_REG      0x1FF0
44 #  define RNG_SOFT_RESET        BIT(0)
45 #define	RNG_IRQ_EOI_REG         0x1FF4
46 #define	RNG_IRQSTATUS           0x1FF8
47 
48 #define RNG_CONTROL_STARTUP_CYCLES_SHIFT        16
49 #define RNG_CONTROL_STARTUP_CYCLES_MASK         GENMASK_32(31, 16)
50 
51 #define RNG_CONFIG_MAX_REFIL_CYCLES_SHIFT       16
52 #define RNG_CONFIG_MAX_REFIL_CYCLES_MASK        GENMASK_32(31, 16)
53 #define RNG_CONFIG_MIN_REFIL_CYCLES_SHIFT       0
54 #define RNG_CONFIG_MIN_REFIL_CYCLES_MASK        GENMASK_32(7, 0)
55 
56 #define RNG_ALARMCNT_ALARM_TH_SHIFT             0
57 #define RNG_ALARMCNT_ALARM_TH_MASK              GENMASK_32(7, 0)
58 #define RNG_ALARMCNT_SHUTDOWN_TH_SHIFT          16
59 #define RNG_ALARMCNT_SHUTDOWN_TH_MASK           GENMASK_32(20, 16)
60 
61 #define RNG_CONTROL_STARTUP_CYCLES              0xff
62 #define RNG_CONFIG_MIN_REFIL_CYCLES             0x21
63 #define RNG_CONFIG_MAX_REFIL_CYCLES             0x22
64 #define RNG_ALARM_THRESHOLD                     0xff
65 #define RNG_SHUTDOWN_THRESHOLD                  0x4
66 
67 #define RNG_FRO_MASK    GENMASK_32(23, 0)
68 
69 #define RNG_REG_SIZE    0x2000
70 
71 register_phys_mem_pgdir(MEM_AREA_IO_SEC, RNG_BASE, RNG_REG_SIZE);
72 
73 static unsigned int rng_lock = SPINLOCK_UNLOCK;
74 
75 uint8_t hw_get_random_byte(void)
76 {
77 	static int pos;
78 	static union {
79 		uint32_t val[2];
80 		uint8_t byte[8];
81 	} random;
82 	vaddr_t rng = (vaddr_t)phys_to_virt(RNG_BASE, MEM_AREA_IO_SEC);
83 	uint8_t ret;
84 
85 	uint32_t exceptions = thread_mask_exceptions(THREAD_EXCP_ALL);
86 	cpu_spin_lock(&rng_lock);
87 
88 	if (!pos) {
89 		/* Is the result ready (available)? */
90 		while (!(io_read32(rng + RNG_STATUS) & RNG_READY)) {
91 			/* Is the shutdown threshold reached? */
92 			if (io_read32(rng + RNG_STATUS) & SHUTDOWN_OFLO) {
93 				uint32_t alarm = io_read32(rng + RNG_ALARMSTOP);
94 				uint32_t tune = io_read32(rng + RNG_FRODETUNE);
95 
96 				/* Clear the alarm events */
97 				io_write32(rng + RNG_ALARMMASK, 0x0);
98 				io_write32(rng + RNG_ALARMSTOP, 0x0);
99 				/* De-tune offending FROs */
100 				io_write32(rng + RNG_FRODETUNE, tune ^ alarm);
101 				/* Re-enable the shut down FROs */
102 				io_write32(rng + RNG_FROENABLE, RNG_FRO_MASK);
103 				/* Clear the shutdown overflow event */
104 				io_write32(rng + RNG_INTACK, SHUTDOWN_OFLO);
105 
106 				DMSG("Fixed FRO shutdown\n");
107 			}
108 		}
109 		/* Read random value */
110 		random.val[0] = io_read32(rng + RNG_OUTPUT_L);
111 		random.val[1] = io_read32(rng + RNG_OUTPUT_H);
112 		/* Acknowledge read complete */
113 		io_write32(rng + RNG_INTACK, RNG_READY);
114 	}
115 
116 	ret = random.byte[pos];
117 
118 	pos = (pos + 1) % 8;
119 
120 	cpu_spin_unlock(&rng_lock);
121 	thread_set_exceptions(exceptions);
122 
123 	return ret;
124 }
125 
126 static TEE_Result dra7_rng_init(void)
127 {
128 	vaddr_t rng = (vaddr_t)phys_to_virt(RNG_BASE, MEM_AREA_IO_SEC);
129 	uint32_t val;
130 
131 	/* Execute a software reset */
132 	io_write32(rng + RNG_SOFT_RESET_REG, RNG_SOFT_RESET);
133 
134 	/* Wait for the software reset completion by polling */
135 	while (io_read32(rng + RNG_SOFT_RESET_REG) & RNG_SOFT_RESET)
136 		;
137 
138 	/* Switch to low-power operating mode */
139 	io_write32(rng + RNG_SYS_CONFIG_REG, RNG_AUTOIDLE);
140 
141 	/*
142 	 * Select the number of clock input cycles to the
143 	 * FROs between two samples
144 	 */
145 	val = 0;
146 
147 	/* Ensure initial latency */
148 	val |= RNG_CONFIG_MIN_REFIL_CYCLES <<
149 			RNG_CONFIG_MIN_REFIL_CYCLES_SHIFT;
150 	val |= RNG_CONFIG_MAX_REFIL_CYCLES <<
151 			RNG_CONFIG_MAX_REFIL_CYCLES_SHIFT;
152 	io_write32(rng + RNG_CONFIG, val);
153 
154 	/* Configure the desired FROs */
155 	io_write32(rng + RNG_FRODETUNE, 0x0);
156 
157 	/* Enable all FROs */
158 	io_write32(rng + RNG_FROENABLE, 0xffffff);
159 
160 	/*
161 	 * Select the maximum number of samples after
162 	 * which if a repeating pattern is still detected, an
163 	 * alarm event is generated
164 	 */
165 	val = RNG_ALARM_THRESHOLD << RNG_ALARMCNT_ALARM_TH_SHIFT;
166 
167 	/*
168 	 * Set the shutdown threshold to the number of FROs
169 	 * allowed to be shut downed
170 	 */
171 	val |= RNG_SHUTDOWN_THRESHOLD << RNG_ALARMCNT_SHUTDOWN_TH_SHIFT;
172 	io_write32(rng + RNG_ALARMCNT, val);
173 
174 	/* Enable the RNG module */
175 	val = RNG_CONTROL_STARTUP_CYCLES << RNG_CONTROL_STARTUP_CYCLES_SHIFT;
176 	val |= ENABLE_TRNG;
177 	io_write32(rng + RNG_CONTROL, val);
178 
179 	IMSG("DRA7x TRNG initialized");
180 
181 	return TEE_SUCCESS;
182 }
183 driver_init(dra7_rng_init);
184