2 * Copyright 2016 NXP Semiconductor, Inc.
4 * SPDX-License-Identifier: GPL-2.0+
9 #include <linux/kernel.h>
11 #include <asm/system.h>
12 #include <asm/types.h>
13 #include <asm/macro.h>
14 #include <asm/armv8/sec_firmware.h>
16 DECLARE_GLOBAL_DATA_PTR;
17 extern void c_runtime_cpu_setup(void);
19 #define SEC_FIRMWARE_LOADED 0x1
20 #define SEC_FIRMWARE_RUNNING 0x2
21 #define SEC_FIRMWARE_ADDR_MASK (~0x3)
23 * Secure firmware load addr
24 * Flags used: 0x1 secure firmware has been loaded to secure memory
25 * 0x2 secure firmware is running
27 phys_addr_t sec_firmware_addr;
29 #ifndef SEC_FIRMWARE_FIT_IMAGE
30 #define SEC_FIRMWARE_FIT_IMAGE "firmware"
32 #ifndef SEC_FIRMEWARE_FIT_CNF_NAME
33 #define SEC_FIRMEWARE_FIT_CNF_NAME "config@1"
35 #ifndef SEC_FIRMWARE_TARGET_EL
36 #define SEC_FIRMWARE_TARGET_EL 2
39 static int sec_firmware_get_data(const void *sec_firmware_img,
40 const void **data, size_t *size)
42 int conf_node_off, fw_node_off;
43 char *conf_node_name = NULL;
47 conf_node_name = SEC_FIRMEWARE_FIT_CNF_NAME;
49 conf_node_off = fit_conf_get_node(sec_firmware_img, conf_node_name);
50 if (conf_node_off < 0) {
51 printf("SEC Firmware: %s: no such config\n", conf_node_name);
55 fw_node_off = fit_conf_get_prop_node(sec_firmware_img, conf_node_off,
56 SEC_FIRMWARE_FIT_IMAGE);
57 if (fw_node_off < 0) {
58 printf("SEC Firmware: No '%s' in config\n",
59 SEC_FIRMWARE_FIT_IMAGE);
63 /* Verify secure firmware image */
64 if (!(fit_image_verify(sec_firmware_img, fw_node_off))) {
65 printf("SEC Firmware: Bad firmware image (bad CRC)\n");
69 if (fit_image_get_data(sec_firmware_img, fw_node_off, data, size)) {
70 printf("SEC Firmware: Can't get %s subimage data/size",
71 SEC_FIRMWARE_FIT_IMAGE);
75 ret = fit_get_desc(sec_firmware_img, fw_node_off, &desc);
77 printf("SEC Firmware: Can't get description\n");
85 * SEC Firmware FIT image parser checks if the image is in FIT
86 * format, verifies integrity of the image and calculates raw
87 * image address and size values.
89 * Returns 0 on success and a negative errno on error task fail.
91 static int sec_firmware_parse_image(const void *sec_firmware_img,
92 const void **raw_image_addr,
93 size_t *raw_image_size)
97 ret = sec_firmware_get_data(sec_firmware_img, raw_image_addr,
102 debug("SEC Firmware: raw_image_addr = 0x%p, raw_image_size = 0x%lx\n",
103 *raw_image_addr, *raw_image_size);
109 * SEC Firmware FIT image parser to check if any loadable is
110 * present. If present, verify integrity of the loadable and
111 * copy loadable to address provided in (loadable_h, loadable_l).
113 * Returns 0 on success and a negative errno on error task fail.
115 static int sec_firmware_check_copy_loadable(const void *sec_firmware_img,
116 u32 *loadable_l, u32 *loadable_h)
118 phys_addr_t sec_firmware_loadable_addr = 0;
119 int conf_node_off, ld_node_off;
120 char *conf_node_name = NULL;
125 conf_node_name = SEC_FIRMEWARE_FIT_CNF_NAME;
127 conf_node_off = fit_conf_get_node(sec_firmware_img, conf_node_name);
128 if (conf_node_off < 0) {
129 printf("SEC Firmware: %s: no such config\n", conf_node_name);
133 ld_node_off = fit_conf_get_prop_node(sec_firmware_img, conf_node_off,
135 if (ld_node_off >= 0) {
136 printf("SEC Firmware: '%s' present in config\n",
139 /* Verify secure firmware image */
140 if (!(fit_image_verify(sec_firmware_img, ld_node_off))) {
141 printf("SEC Loadable: Bad loadable image (bad CRC)\n");
145 if (fit_image_get_data(sec_firmware_img, ld_node_off,
147 printf("SEC Loadable: Can't get subimage data/size");
151 /* Get load address, treated as load offset to secure memory */
152 if (fit_image_get_load(sec_firmware_img, ld_node_off, &load)) {
153 printf("SEC Loadable: Can't get subimage load");
157 /* Compute load address for loadable in secure memory */
158 sec_firmware_loadable_addr = (sec_firmware_addr -
159 gd->arch.tlb_size) + load;
161 /* Copy loadable to secure memory and flush dcache */
162 debug("%s copied to address 0x%p\n",
163 FIT_LOADABLE_PROP, (void *)sec_firmware_loadable_addr);
164 memcpy((void *)sec_firmware_loadable_addr, data, size);
165 flush_dcache_range(sec_firmware_loadable_addr,
166 sec_firmware_loadable_addr + size);
169 /* Populate address ptrs for loadable image with loadbale addr */
170 out_le32(loadable_l, (sec_firmware_loadable_addr & WORD_MASK));
171 out_le32(loadable_h, (sec_firmware_loadable_addr >> WORD_SHIFT));
176 static int sec_firmware_copy_image(const char *title,
177 u64 image_addr, u32 image_size, u64 sec_firmware)
179 debug("%s copied to address 0x%p\n", title, (void *)sec_firmware);
180 memcpy((void *)sec_firmware, (void *)image_addr, image_size);
181 flush_dcache_range(sec_firmware, sec_firmware + image_size);
187 * This function will parse the SEC Firmware image, and then load it
188 * to secure memory. Also load any loadable if present along with SEC
191 static int sec_firmware_load_image(const void *sec_firmware_img,
192 u32 *loadable_l, u32 *loadable_h)
194 const void *raw_image_addr;
195 size_t raw_image_size = 0;
199 * The Excetpion Level must be EL3 to load and initialize
202 if (current_el() != 3) {
207 #ifdef CONFIG_SYS_MEM_RESERVE_SECURE
209 * The SEC Firmware must be stored in secure memory.
210 * Append SEC Firmware to secure mmu table.
212 if (!(gd->arch.secure_ram & MEM_RESERVE_SECURE_MAINTAINED)) {
217 sec_firmware_addr = (gd->arch.secure_ram & MEM_RESERVE_SECURE_ADDR_MASK) +
220 #error "The CONFIG_SYS_MEM_RESERVE_SECURE must be defined when enabled SEC Firmware support"
223 /* Align SEC Firmware base address to 4K */
224 sec_firmware_addr = (sec_firmware_addr + 0xfff) & ~0xfff;
225 debug("SEC Firmware: Load address: 0x%llx\n",
226 sec_firmware_addr & SEC_FIRMWARE_ADDR_MASK);
228 ret = sec_firmware_parse_image(sec_firmware_img, &raw_image_addr,
234 * Check if the end addr of SEC Firmware has been extend the secure
238 /* Copy the secure firmware to secure memory */
239 ret = sec_firmware_copy_image("SEC Firmware", (u64)raw_image_addr,
240 raw_image_size, sec_firmware_addr &
241 SEC_FIRMWARE_ADDR_MASK);
246 * Check if any loadable are present along with firmware image, if
249 ret = sec_firmware_check_copy_loadable(sec_firmware_img, loadable_l,
254 sec_firmware_addr |= SEC_FIRMWARE_LOADED;
255 debug("SEC Firmware: Entry point: 0x%llx\n",
256 sec_firmware_addr & SEC_FIRMWARE_ADDR_MASK);
261 printf("SEC Firmware: error (%d)\n", ret);
262 sec_firmware_addr = 0;
267 static int sec_firmware_entry(u32 *eret_hold_l, u32 *eret_hold_h)
269 const void *entry = (void *)(sec_firmware_addr &
270 SEC_FIRMWARE_ADDR_MASK);
272 return _sec_firmware_entry(entry, eret_hold_l, eret_hold_h);
275 /* Check the secure firmware FIT image */
276 __weak bool sec_firmware_is_valid(const void *sec_firmware_img)
278 if (fdt_check_header(sec_firmware_img)) {
279 printf("SEC Firmware: Bad firmware image (not a FIT image)\n");
283 if (!fit_check_format(sec_firmware_img)) {
284 printf("SEC Firmware: Bad firmware image (bad FIT header)\n");
291 #ifdef CONFIG_SEC_FIRMWARE_ARMV8_PSCI
293 * The PSCI_VERSION function is added from PSCI v0.2. When the PSCI
294 * v0.1 received this function, the NOT_SUPPORTED (0xffff_ffff) error
295 * number will be returned according to SMC Calling Conventions. But
296 * when getting the NOT_SUPPORTED error number, we cannot ensure if
297 * the PSCI version is v0.1 or other error occurred. So, PSCI v0.1
298 * won't be supported by this framework.
299 * And if the secure firmware isn't running, return NOT_SUPPORTED.
301 * The return value on success is PSCI version in format
302 * major[31:16]:minor[15:0].
304 unsigned int sec_firmware_support_psci_version(void)
306 if (current_el() == SEC_FIRMWARE_TARGET_EL)
307 return _sec_firmware_support_psci_version();
309 return PSCI_INVALID_VER;
314 * Check with sec_firmware if it supports random number generation
317 * The return value will be true if it is supported
319 bool sec_firmware_support_hwrng(void)
322 if (sec_firmware_addr & SEC_FIRMWARE_RUNNING) {
323 if (!sec_firmware_get_random(rand, 8))
331 * sec_firmware_get_random - Get a random number from SEC Firmware
332 * @rand: random number buffer to be filled
333 * @bytes: Number of bytes of random number to be supported
334 * @eret: -1 in case of error, 0 for success
336 int sec_firmware_get_random(uint8_t *rand, int bytes)
338 unsigned long long num;
342 if (!bytes || bytes > 8) {
343 printf("Max Random bytes genration supported is 8\n");
346 #define SIP_RNG_64 0xC200FF11
347 regs.regs[0] = SIP_RNG_64;
353 regs.regs[1] = param1;
361 memcpy(rand, &num, bytes);
367 * sec_firmware_init - Initialize the SEC Firmware
368 * @sec_firmware_img: the SEC Firmware image address
369 * @eret_hold_l: the address to hold exception return address low
370 * @eret_hold_h: the address to hold exception return address high
371 * @loadable_l: the address to hold loadable address low
372 * @loadable_h: the address to hold loadable address high
374 int sec_firmware_init(const void *sec_firmware_img,
382 if (!sec_firmware_is_valid(sec_firmware_img))
385 ret = sec_firmware_load_image(sec_firmware_img, loadable_l,
388 printf("SEC Firmware: Failed to load image\n");
390 } else if (sec_firmware_addr & SEC_FIRMWARE_LOADED) {
391 ret = sec_firmware_entry(eret_hold_l, eret_hold_h);
393 printf("SEC Firmware: Failed to initialize\n");
398 debug("SEC Firmware: Return from SEC Firmware: current_el = %d\n",
402 * The PE will be turned into target EL when returned from
405 if (current_el() != SEC_FIRMWARE_TARGET_EL)
408 sec_firmware_addr |= SEC_FIRMWARE_RUNNING;
410 /* Set exception table and enable caches if it isn't EL3 */
411 if (current_el() != 3) {
412 c_runtime_cpu_setup();
420 * fdt_fix_kaslr - Add kalsr-seed node in Device tree
422 * @eret: 0 in case of error, 1 for success
424 int fdt_fixup_kaslr(void *fdt)
430 #if defined(CONFIG_ARMV8_SEC_FIRMWARE_SUPPORT)
431 /* Check if random seed generation is supported */
432 if (sec_firmware_support_hwrng() == false)
435 ret = sec_firmware_get_random(rand, 8);
437 printf("WARNING: No random number to set kaslr-seed\n");
441 err = fdt_check_header(fdt);
443 printf("fdt_chosen: %s\n", fdt_strerror(err));
447 /* find or create "/chosen" node. */
448 nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
452 err = fdt_setprop(fdt, nodeoffset, "kaslr-seed", rand,
455 printf("WARNING: can't set kaslr-seed %s.\n",