blob: aac8a9604f9f8995d64b168b82178ab95f7d6981 [file] [log] [blame]
James Morrissey9d72b4e2014-02-10 17:04:32 +00001/*
2 * Copyright (c) 2014, ARM Limited and Contributors. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * Redistributions of source code must retain the above copyright notice, this
8 * list of conditions and the following disclaimer.
9 *
10 * Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * Neither the name of ARM nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without specific
16 * prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#include <assert.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010032#include <debug.h>
Dan Handley714a0d22014-04-09 13:13:04 +010033#include <io_driver.h>
Dan Handley714a0d22014-04-09 13:13:04 +010034#include <io_fip.h>
35#include <io_memmap.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010036#include <io_storage.h>
37#include <io_semihosting.h>
38#include <platform.h>
39#include <semihosting.h> /* For FOPEN_MODE_... */
40#include <string.h>
James Morrissey9d72b4e2014-02-10 17:04:32 +000041
James Morrissey9d72b4e2014-02-10 17:04:32 +000042/* IO devices */
Dan Handleye2712bc2014-04-10 15:37:22 +010043static io_plat_data_t io_data;
Dan Handleya4cb68e2014-04-23 13:47:06 +010044static const io_dev_connector_t *sh_dev_con;
45static uintptr_t sh_dev_spec;
46static uintptr_t sh_init_params;
47static uintptr_t sh_dev_handle;
48static const io_dev_connector_t *fip_dev_con;
49static uintptr_t fip_dev_spec;
50static uintptr_t fip_dev_handle;
51static const io_dev_connector_t *memmap_dev_con;
52static uintptr_t memmap_dev_spec;
53static uintptr_t memmap_init_params;
54static uintptr_t memmap_dev_handle;
Harry Liebel561cd332014-02-14 14:42:48 +000055
Dan Handleya4cb68e2014-04-23 13:47:06 +010056static const io_block_spec_t fip_block_spec = {
Harry Liebel561cd332014-02-14 14:42:48 +000057 .offset = FLASH0_BASE,
58 .length = FLASH0_SIZE
59};
60
Dan Handleya4cb68e2014-04-23 13:47:06 +010061static const io_file_spec_t bl2_file_spec = {
James Morrissey9d72b4e2014-02-10 17:04:32 +000062 .path = BL2_IMAGE_NAME,
Sandrine Bailleuxa9de1bb2014-03-20 15:51:02 +000063 .mode = FOPEN_MODE_RB
James Morrissey9d72b4e2014-02-10 17:04:32 +000064};
65
Dan Handleya4cb68e2014-04-23 13:47:06 +010066static const io_file_spec_t bl31_file_spec = {
James Morrissey9d72b4e2014-02-10 17:04:32 +000067 .path = BL31_IMAGE_NAME,
Sandrine Bailleuxa9de1bb2014-03-20 15:51:02 +000068 .mode = FOPEN_MODE_RB
James Morrissey9d72b4e2014-02-10 17:04:32 +000069};
70
Dan Handleya4cb68e2014-04-23 13:47:06 +010071static const io_file_spec_t bl32_file_spec = {
Achin Gupta375f5382014-02-18 18:12:48 +000072 .path = BL32_IMAGE_NAME,
Sandrine Bailleuxa9de1bb2014-03-20 15:51:02 +000073 .mode = FOPEN_MODE_RB
Achin Gupta375f5382014-02-18 18:12:48 +000074};
75
Dan Handleya4cb68e2014-04-23 13:47:06 +010076static const io_file_spec_t bl33_file_spec = {
Harry Liebel561cd332014-02-14 14:42:48 +000077 .path = BL33_IMAGE_NAME,
Sandrine Bailleuxa9de1bb2014-03-20 15:51:02 +000078 .mode = FOPEN_MODE_RB
Harry Liebel561cd332014-02-14 14:42:48 +000079};
80
Dan Handleya4cb68e2014-04-23 13:47:06 +010081static int open_fip(const uintptr_t spec);
82static int open_memmap(const uintptr_t spec);
Ryan Harkin1bf80fc2014-02-18 17:40:24 +000083
84struct plat_io_policy {
85 char *image_name;
Dan Handleya4cb68e2014-04-23 13:47:06 +010086 uintptr_t *dev_handle;
87 uintptr_t image_spec;
88 int (*check)(const uintptr_t spec);
Ryan Harkin1bf80fc2014-02-18 17:40:24 +000089};
90
Dan Handleya4cb68e2014-04-23 13:47:06 +010091static const struct plat_io_policy policies[] = {
92 {
93 FIP_IMAGE_NAME,
94 &memmap_dev_handle,
95 (uintptr_t)&fip_block_spec,
96 open_memmap
97 }, {
98 BL2_IMAGE_NAME,
99 &fip_dev_handle,
100 (uintptr_t)&bl2_file_spec,
101 open_fip
102 }, {
103 BL31_IMAGE_NAME,
104 &fip_dev_handle,
105 (uintptr_t)&bl31_file_spec,
106 open_fip
107 }, {
108 BL32_IMAGE_NAME,
109 &fip_dev_handle,
110 (uintptr_t)&bl32_file_spec,
111 open_fip
112 }, {
113 BL33_IMAGE_NAME,
114 &fip_dev_handle,
115 (uintptr_t)&bl33_file_spec,
116 open_fip
117 }, {
118 0, 0, 0
119 }
Harry Liebel561cd332014-02-14 14:42:48 +0000120};
121
122
Dan Handleya4cb68e2014-04-23 13:47:06 +0100123static int open_fip(const uintptr_t spec)
Harry Liebel561cd332014-02-14 14:42:48 +0000124{
125 int result = IO_FAIL;
126
127 /* See if a Firmware Image Package is available */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100128 result = io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_NAME);
Harry Liebel561cd332014-02-14 14:42:48 +0000129 if (result == IO_SUCCESS) {
130 INFO("Using FIP\n");
131 /*TODO: Check image defined in spec is present in FIP. */
132 }
133 return result;
134}
135
136
Dan Handleya4cb68e2014-04-23 13:47:06 +0100137static int open_memmap(const uintptr_t spec)
Harry Liebel561cd332014-02-14 14:42:48 +0000138{
139 int result = IO_FAIL;
Dan Handleya4cb68e2014-04-23 13:47:06 +0100140 uintptr_t local_image_handle;
Harry Liebel561cd332014-02-14 14:42:48 +0000141
142 result = io_dev_init(memmap_dev_handle, memmap_init_params);
143 if (result == IO_SUCCESS) {
144 result = io_open(memmap_dev_handle, spec, &local_image_handle);
145 if (result == IO_SUCCESS) {
146 /* INFO("Using Memmap IO\n"); */
147 io_close(local_image_handle);
148 }
149 }
150 return result;
151}
152
153
Dan Handleya4cb68e2014-04-23 13:47:06 +0100154static int open_semihosting(const uintptr_t spec)
Harry Liebel561cd332014-02-14 14:42:48 +0000155{
156 int result = IO_FAIL;
Dan Handleya4cb68e2014-04-23 13:47:06 +0100157 uintptr_t local_image_handle;
Harry Liebel561cd332014-02-14 14:42:48 +0000158
159 /* See if the file exists on semi-hosting.*/
160 result = io_dev_init(sh_dev_handle, sh_init_params);
161 if (result == IO_SUCCESS) {
162 result = io_open(sh_dev_handle, spec, &local_image_handle);
163 if (result == IO_SUCCESS) {
164 INFO("Using Semi-hosting IO\n");
165 io_close(local_image_handle);
166 }
167 }
168 return result;
169}
170
Harry Liebel561cd332014-02-14 14:42:48 +0000171void io_setup (void)
172{
173 int io_result = IO_FAIL;
174
James Morrissey9d72b4e2014-02-10 17:04:32 +0000175 /* Initialise the IO layer */
176 io_init(&io_data);
177
Harry Liebel561cd332014-02-14 14:42:48 +0000178 /* Register the IO devices on this platform */
179 io_result = register_io_dev_sh(&sh_dev_con);
James Morrissey9d72b4e2014-02-10 17:04:32 +0000180 assert(io_result == IO_SUCCESS);
181
Harry Liebel561cd332014-02-14 14:42:48 +0000182 io_result = register_io_dev_fip(&fip_dev_con);
183 assert(io_result == IO_SUCCESS);
184
185 io_result = register_io_dev_memmap(&memmap_dev_con);
186 assert(io_result == IO_SUCCESS);
187
188 /* Open connections to devices and cache the handles */
James Morrissey9d72b4e2014-02-10 17:04:32 +0000189 io_result = io_dev_open(sh_dev_con, sh_dev_spec, &sh_dev_handle);
190 assert(io_result == IO_SUCCESS);
191
Harry Liebel561cd332014-02-14 14:42:48 +0000192 io_result = io_dev_open(fip_dev_con, fip_dev_spec, &fip_dev_handle);
193 assert(io_result == IO_SUCCESS);
194
195 io_result = io_dev_open(memmap_dev_con, memmap_dev_spec,
196 &memmap_dev_handle);
197 assert(io_result == IO_SUCCESS);
198
James Morrissey9d72b4e2014-02-10 17:04:32 +0000199 /* Ignore improbable errors in release builds */
200 (void)io_result;
201}
202
203
204/* Return an IO device handle and specification which can be used to access
Harry Liebel561cd332014-02-14 14:42:48 +0000205 * an image. Use this to enforce platform load policy */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100206int plat_get_image_source(const char *image_name, uintptr_t *dev_handle,
207 uintptr_t *image_spec)
James Morrissey9d72b4e2014-02-10 17:04:32 +0000208{
209 int result = IO_FAIL;
Dan Handleya4cb68e2014-04-23 13:47:06 +0100210 const struct plat_io_policy *policy;
James Morrissey9d72b4e2014-02-10 17:04:32 +0000211
Ryan Harkin1bf80fc2014-02-18 17:40:24 +0000212 if ((image_name != NULL) && (dev_handle != NULL) &&
213 (image_spec != NULL)) {
214 policy = policies;
215 while (policy->image_name != NULL) {
216 if (strcmp(policy->image_name, image_name) == 0) {
217 result = policy->check(policy->image_spec);
218 if (result == IO_SUCCESS) {
Dan Handleya4cb68e2014-04-23 13:47:06 +0100219 *image_spec = policy->image_spec;
Ryan Harkin1bf80fc2014-02-18 17:40:24 +0000220 *dev_handle = *(policy->dev_handle);
221 break;
222 } else {
223 result = open_semihosting(
224 policy->image_spec);
225 if (result == IO_SUCCESS) {
226 *dev_handle = sh_dev_handle;
Dan Handleya4cb68e2014-04-23 13:47:06 +0100227 *image_spec =
Ryan Harkin1bf80fc2014-02-18 17:40:24 +0000228 policy->image_spec;
229 }
230 }
231 }
232 policy++;
Harry Liebel561cd332014-02-14 14:42:48 +0000233 }
Ryan Harkin1bf80fc2014-02-18 17:40:24 +0000234 } else {
235 result = IO_FAIL;
Harry Liebel561cd332014-02-14 14:42:48 +0000236 }
James Morrissey9d72b4e2014-02-10 17:04:32 +0000237 return result;
238}