xref: /rk3399_ARM-atf/plat/arm/common/arm_io_storage.c (revision 0a0a7a9ac82cb79af91f098cedc69cc67bca3978)
1 /*
2  * Copyright (c) 2015-2020, ARM Limited. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #include <assert.h>
8 
9 #include <common/debug.h>
10 #include <drivers/io/io_driver.h>
11 #include <drivers/io/io_fip.h>
12 #include <drivers/io/io_memmap.h>
13 #include <drivers/io/io_storage.h>
14 #include <lib/utils.h>
15 
16 #include <plat/arm/common/arm_fconf_getter.h>
17 #include <plat/arm/common/arm_fconf_io_storage.h>
18 #include <plat/arm/common/plat_arm.h>
19 #include <plat/common/platform.h>
20 #include <platform_def.h>
21 
22 /* IO devices */
23 static const io_dev_connector_t *fip_dev_con;
24 uintptr_t fip_dev_handle;
25 static const io_dev_connector_t *memmap_dev_con;
26 uintptr_t memmap_dev_handle;
27 
28 /* Weak definitions may be overridden in specific ARM standard platform */
29 #pragma weak plat_arm_io_setup
30 #pragma weak plat_arm_get_alt_image_source
31 
32 int open_fip(const uintptr_t spec)
33 {
34 	int result;
35 	uintptr_t local_image_handle;
36 
37 	/* See if a Firmware Image Package is available */
38 	result = io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_ID);
39 	if (result == 0) {
40 		result = io_open(fip_dev_handle, spec, &local_image_handle);
41 		if (result == 0) {
42 			VERBOSE("Using FIP\n");
43 			io_close(local_image_handle);
44 		}
45 	}
46 	return result;
47 }
48 
49 int open_memmap(const uintptr_t spec)
50 {
51 	int result;
52 	uintptr_t local_image_handle;
53 
54 	result = io_dev_init(memmap_dev_handle, (uintptr_t)NULL);
55 	if (result == 0) {
56 		result = io_open(memmap_dev_handle, spec, &local_image_handle);
57 		if (result == 0) {
58 			VERBOSE("Using Memmap\n");
59 			io_close(local_image_handle);
60 		}
61 	}
62 	return result;
63 }
64 
65 int arm_io_setup(void)
66 {
67 	int io_result;
68 
69 	io_result = register_io_dev_fip(&fip_dev_con);
70 	if (io_result < 0) {
71 		return io_result;
72 	}
73 
74 	io_result = register_io_dev_memmap(&memmap_dev_con);
75 	if (io_result < 0) {
76 		return io_result;
77 	}
78 
79 	/* Open connections to devices and cache the handles */
80 	io_result = io_dev_open(fip_dev_con, (uintptr_t)NULL,
81 				&fip_dev_handle);
82 	if (io_result < 0) {
83 		return io_result;
84 	}
85 
86 	io_result = io_dev_open(memmap_dev_con, (uintptr_t)NULL,
87 				&memmap_dev_handle);
88 
89 	return io_result;
90 }
91 
92 void plat_arm_io_setup(void)
93 {
94 	int err;
95 
96 	err = arm_io_setup();
97 	if (err < 0) {
98 		panic();
99 	}
100 }
101 
102 int plat_arm_get_alt_image_source(
103 	unsigned int image_id __unused,
104 	uintptr_t *dev_handle __unused,
105 	uintptr_t *image_spec __unused)
106 {
107 	/* By default do not try an alternative */
108 	return -ENOENT;
109 }
110 
111 /* Return an IO device handle and specification which can be used to access
112  * an image. Use this to enforce platform load policy */
113 int plat_get_image_source(unsigned int image_id, uintptr_t *dev_handle,
114 			  uintptr_t *image_spec)
115 {
116 	int result;
117 	const struct plat_io_policy *policy;
118 
119 	assert(image_id < MAX_NUMBER_IDS);
120 
121 	policy = FCONF_GET_PROPERTY(arm, io_policies, image_id);
122 	result = policy->check(policy->image_spec);
123 	if (result == 0) {
124 		*image_spec = policy->image_spec;
125 		*dev_handle = *(policy->dev_handle);
126 	} else {
127 		VERBOSE("Trying alternative IO\n");
128 		result = plat_arm_get_alt_image_source(image_id, dev_handle,
129 						       image_spec);
130 	}
131 
132 	return result;
133 }
134 
135 /*
136  * See if a Firmware Image Package is available,
137  * by checking if TOC is valid or not.
138  */
139 bool arm_io_is_toc_valid(void)
140 {
141 	return (io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_ID) == 0);
142 }
143