xref: /rk3399_ARM-atf/include/drivers/auth/auth_mod.h (revision 37d56d3829f86ee5808b5f4a5a6b4dbdbb1bab67)
1 /*
2  * Copyright (c) 2015-2020, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef AUTH_MOD_H
8 #define AUTH_MOD_H
9 
10 #if TRUSTED_BOARD_BOOT
11 
12 #include <common/tbbr/cot_def.h>
13 #include <common/tbbr/tbbr_img_def.h>
14 #include <drivers/auth/auth_common.h>
15 #include <drivers/auth/img_parser_mod.h>
16 
17 #include <lib/utils_def.h>
18 
19 /*
20  * Image flags
21  */
22 #define IMG_FLAG_AUTHENTICATED		(1 << 0)
23 
24 
25 /*
26  * Authentication image descriptor
27  */
28 typedef struct auth_img_desc_s {
29 	unsigned int img_id;
30 	img_type_t img_type;
31 	const struct auth_img_desc_s *parent;
32 	const auth_method_desc_t *const img_auth_methods;
33 	const auth_param_desc_t *const authenticated_data;
34 } auth_img_desc_t;
35 
36 /* Public functions */
37 void auth_mod_init(void);
38 int auth_mod_get_parent_id(unsigned int img_id, unsigned int *parent_id);
39 int auth_mod_verify_img(unsigned int img_id,
40 			void *img_ptr,
41 			unsigned int img_len);
42 
43 /* Macro to register a CoT defined as an array of auth_img_desc_t pointers */
44 #define REGISTER_COT(_cot) \
45 	const auth_img_desc_t *const *const cot_desc_ptr = (_cot); \
46 	const size_t cot_desc_size = ARRAY_SIZE(_cot);		   \
47 	unsigned int auth_img_flags[MAX_NUMBER_IDS]
48 
49 extern const auth_img_desc_t *const *const cot_desc_ptr;
50 extern const size_t cot_desc_size;
51 extern unsigned int auth_img_flags[MAX_NUMBER_IDS];
52 
53 #endif /* TRUSTED_BOARD_BOOT */
54 
55 #endif /* AUTH_MOD_H */
56