blob: 937b8c7e8c12e0bde4b3bb991e22e9b5acc60500 [file] [log] [blame]
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +01001/*
Antonio Nino Diaze3887a92019-01-30 20:29:50 +00002 * Copyright (c) 2015-2019, ARM Limited and Contributors. All rights reserved.
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +01003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +01005 */
6
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +00007#ifndef BL1_H
8#define BL1_H
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +01009
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000010#include <common/bl_common.h>
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +010011
12/*
13 * Defines for BL1 SMC function ids.
14 */
15#define BL1_SMC_CALL_COUNT 0x0
16#define BL1_SMC_UID 0x1
17/* SMC #0x2 reserved */
18#define BL1_SMC_VERSION 0x3
19
20/*
21 * Corresponds to the function ID of the SMC that
22 * the BL1 exception handler service to execute BL31.
23 */
24#define BL1_SMC_RUN_IMAGE 0x4
25
26/*
27 * BL1 SMC version
28 */
29#define BL1_SMC_MAJOR_VER 0x0
30#define BL1_SMC_MINOR_VER 0x1
31
32/*
33 * Defines for FWU SMC function ids.
34 */
35
36#define FWU_SMC_IMAGE_COPY 0x10
37#define FWU_SMC_IMAGE_AUTH 0x11
38#define FWU_SMC_IMAGE_EXECUTE 0x12
39#define FWU_SMC_IMAGE_RESUME 0x13
40#define FWU_SMC_SEC_IMAGE_DONE 0x14
41#define FWU_SMC_UPDATE_DONE 0x15
Antonio Nino Diaz0e8e7202017-05-12 16:51:59 +010042#define FWU_SMC_IMAGE_RESET 0x16
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +010043
44/*
45 * Number of FWU calls (above) implemented
46 */
Antonio Nino Diaz0e8e7202017-05-12 16:51:59 +010047#define FWU_NUM_SMC_CALLS 7
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +010048
49#if TRUSTED_BOARD_BOOT
50# define BL1_NUM_SMC_CALLS (FWU_NUM_SMC_CALLS + 4)
51#else
52# define BL1_NUM_SMC_CALLS 4
53#endif
54
55/*
56 * The macros below are used to identify FWU
57 * calls from the SMC function ID
58 */
59#define FWU_SMC_FID_START FWU_SMC_IMAGE_COPY
Antonio Nino Diaz0e8e7202017-05-12 16:51:59 +010060#define FWU_SMC_FID_END FWU_SMC_IMAGE_RESET
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +010061#define is_fwu_fid(_fid) \
62 ((_fid >= FWU_SMC_FID_START) && (_fid <= FWU_SMC_FID_END))
63
64#ifndef __ASSEMBLY__
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000065
66#include <lib/cassert.h>
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +010067
Roberto Vargas05712702018-02-12 12:36:17 +000068struct entry_point_info;
69
70register_t bl1_smc_wrapper(uint32_t smc_fid,
71 void *cookie,
72 void *handle,
73 unsigned int flags);
74
75register_t bl1_smc_handler(unsigned int smc_fid,
76 register_t x1,
77 register_t x2,
78 register_t x3,
79 register_t x4,
80 void *cookie,
81 void *handle,
82 unsigned int flags);
83
84void bl1_print_next_bl_ep_info(const struct entry_point_info *bl_ep_info);
85
Antonio Nino Diaze3887a92019-01-30 20:29:50 +000086void bl1_setup(void);
Roberto Vargas05712702018-02-12 12:36:17 +000087void bl1_main(void);
Roberto Vargas2ca18d92018-02-12 12:36:17 +000088void bl1_plat_prepare_exit(entry_point_info_t *ep_info);
Roberto Vargas05712702018-02-12 12:36:17 +000089
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +010090/*
91 * Check if the total number of FWU SMC calls are as expected.
92 */
93CASSERT(FWU_NUM_SMC_CALLS == \
94 (FWU_SMC_FID_END - FWU_SMC_FID_START + 1),\
95 assert_FWU_NUM_SMC_CALLS_mismatch);
96
Soby Mathew6e16a332018-01-10 12:51:34 +000097/* Utility functions */
98void bl1_calc_bl2_mem_layout(const meminfo_t *bl1_mem_layout,
99 meminfo_t *bl2_mem_layout);
100
Yatharth Kochar71c9a5e2015-10-10 19:06:53 +0100101#endif /* __ASSEMBLY__ */
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +0000102#endif /* BL1_H */