blob: d3f671e2c4c450e827383104e7cb67ddd7fb81d8 [file] [log] [blame]
Dan Handley9df48042015-03-19 18:58:55 +00001/*
Vikram Kanigiri72084192016-02-08 16:29:30 +00002 * Copyright (c) 2014-2016, ARM Limited and Contributors. All rights reserved.
Dan Handley9df48042015-03-19 18:58:55 +00003 *
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 <arch_helpers.h>
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000032#include <assert.h>
Dan Handley9df48042015-03-19 18:58:55 +000033#include <css_def.h>
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000034#include <debug.h>
Dan Handley9df48042015-03-19 18:58:55 +000035#include <platform.h>
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000036#include <stdint.h>
Dan Handley9df48042015-03-19 18:58:55 +000037#include "css_mhu.h"
38#include "css_scp_bootloader.h"
39#include "css_scpi.h"
40
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000041/* ID of the MHU slot used for the BOM protocol */
42#define BOM_MHU_SLOT_ID 0
Dan Handley9df48042015-03-19 18:58:55 +000043
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000044/* Boot commands sent from AP -> SCP */
45#define BOOT_CMD_INFO 0x00
46#define BOOT_CMD_DATA 0x01
Dan Handley9df48042015-03-19 18:58:55 +000047
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000048/* BOM command header */
Dan Handley9df48042015-03-19 18:58:55 +000049typedef struct {
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000050 uint32_t id : 8;
51 uint32_t reserved : 24;
52} bom_cmd_t;
Dan Handley9df48042015-03-19 18:58:55 +000053
54typedef struct {
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000055 uint32_t image_size;
56 uint32_t checksum;
57} cmd_info_payload_t;
Dan Handley9df48042015-03-19 18:58:55 +000058
59/*
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000060 * Unlike the SCPI protocol, the boot protocol uses the same memory region
Dan Handley9df48042015-03-19 18:58:55 +000061 * for both AP -> SCP and SCP -> AP transfers; define the address of this...
62 */
Vikram Kanigiri72084192016-02-08 16:29:30 +000063#define BOM_SHARED_MEM PLAT_CSS_SCP_COM_SHARED_MEM_BASE
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000064#define BOM_CMD_HEADER ((bom_cmd_t *) BOM_SHARED_MEM)
65#define BOM_CMD_PAYLOAD ((void *) (BOM_SHARED_MEM + sizeof(bom_cmd_t)))
Dan Handley9df48042015-03-19 18:58:55 +000066
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000067typedef struct {
68 /* Offset from the base address of the Trusted RAM */
69 uint32_t offset;
70 uint32_t block_size;
71} cmd_data_payload_t;
Dan Handley9df48042015-03-19 18:58:55 +000072
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000073static void scp_boot_message_start(void)
74{
75 mhu_secure_message_start(BOM_MHU_SLOT_ID);
Dan Handley9df48042015-03-19 18:58:55 +000076}
77
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000078static void scp_boot_message_send(size_t payload_size)
Dan Handley9df48042015-03-19 18:58:55 +000079{
Juan Castillo2e86cb12016-01-13 15:01:09 +000080 /* Ensure that any write to the BOM payload area is seen by SCP before
81 * we write to the MHU register. If these 2 writes were reordered by
82 * the CPU then SCP would read stale payload data */
83 dmbst();
Dan Handley9df48042015-03-19 18:58:55 +000084
85 /* Send command to SCP */
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000086 mhu_secure_message_send(BOM_MHU_SLOT_ID);
Dan Handley9df48042015-03-19 18:58:55 +000087}
88
89static uint32_t scp_boot_message_wait(size_t size)
90{
Sandrine Bailleux04b66d82015-03-18 14:52:53 +000091 uint32_t mhu_status;
92
93 mhu_status = mhu_secure_message_wait();
94
95 /* Expect an SCP Boot Protocol message, reject any other protocol */
96 if (mhu_status != (1 << BOM_MHU_SLOT_ID)) {
97 ERROR("MHU: Unexpected protocol (MHU status: 0x%x)\n",
98 mhu_status);
99 panic();
100 }
Dan Handley9df48042015-03-19 18:58:55 +0000101
Juan Castillo2e86cb12016-01-13 15:01:09 +0000102 /* Ensure that any read to the BOM payload area is done after reading
103 * the MHU register. If these 2 reads were reordered then the CPU would
104 * read invalid payload data */
105 dmbld();
Dan Handley9df48042015-03-19 18:58:55 +0000106
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000107 return *(uint32_t *) BOM_SHARED_MEM;
Dan Handley9df48042015-03-19 18:58:55 +0000108}
109
110static void scp_boot_message_end(void)
111{
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000112 mhu_secure_message_end(BOM_MHU_SLOT_ID);
Dan Handley9df48042015-03-19 18:58:55 +0000113}
114
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000115int scp_bootloader_transfer(void *image, unsigned int image_size)
Dan Handley9df48042015-03-19 18:58:55 +0000116{
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000117 uint32_t response;
118 uint32_t checksum;
119 cmd_info_payload_t *cmd_info_payload;
120 cmd_data_payload_t *cmd_data_payload;
Dan Handley9df48042015-03-19 18:58:55 +0000121
Juan Castilloa72b6472015-12-10 15:49:17 +0000122 assert((uintptr_t) image == SCP_BL2_BASE);
Dan Handley9df48042015-03-19 18:58:55 +0000123
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000124 if ((image_size == 0) || (image_size % 4 != 0)) {
Juan Castilloa72b6472015-12-10 15:49:17 +0000125 ERROR("Invalid size for the SCP_BL2 image. Must be a multiple of "
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000126 "4 bytes and not zero (current size = 0x%x)\n",
127 image_size);
128 return -1;
129 }
Dan Handley9df48042015-03-19 18:58:55 +0000130
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000131 /* Extract the checksum from the image */
132 checksum = *(uint32_t *) image;
133 image = (char *) image + sizeof(checksum);
134 image_size -= sizeof(checksum);
Dan Handley9df48042015-03-19 18:58:55 +0000135
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000136 mhu_secure_init();
Dan Handley9df48042015-03-19 18:58:55 +0000137
Juan Castilloa72b6472015-12-10 15:49:17 +0000138 VERBOSE("Send info about the SCP_BL2 image to be transferred to SCP\n");
Dan Handley9df48042015-03-19 18:58:55 +0000139
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000140 /*
141 * Send information about the SCP firmware image about to be transferred
142 * to SCP
143 */
144 scp_boot_message_start();
145
146 BOM_CMD_HEADER->id = BOOT_CMD_INFO;
147 cmd_info_payload = BOM_CMD_PAYLOAD;
148 cmd_info_payload->image_size = image_size;
149 cmd_info_payload->checksum = checksum;
150
151 scp_boot_message_send(sizeof(*cmd_info_payload));
Sandrine Bailleux7da652d2015-04-13 11:47:48 +0100152#if CSS_DETECT_PRE_1_7_0_SCP
153 {
154 const uint32_t deprecated_scp_nack_cmd = 0x404;
155 uint32_t mhu_status;
156
157 VERBOSE("Detecting SCP version incompatibility\n");
158
159 mhu_status = mhu_secure_message_wait();
160 if (mhu_status == deprecated_scp_nack_cmd) {
161 ERROR("Detected an incompatible version of the SCP firmware.\n");
162 ERROR("Only versions from v1.7.0 onwards are supported.\n");
163 ERROR("Please update the SCP firmware.\n");
164 return -1;
165 }
166
167 VERBOSE("SCP version looks OK\n");
168 }
169#endif /* CSS_DETECT_PRE_1_7_0_SCP */
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000170 response = scp_boot_message_wait(sizeof(response));
171 scp_boot_message_end();
Dan Handley9df48042015-03-19 18:58:55 +0000172
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000173 if (response != 0) {
174 ERROR("SCP BOOT_CMD_INFO returned error %u\n", response);
175 return -1;
176 }
177
Juan Castilloa72b6472015-12-10 15:49:17 +0000178 VERBOSE("Transferring SCP_BL2 image to SCP\n");
Dan Handley9df48042015-03-19 18:58:55 +0000179
Juan Castilloa72b6472015-12-10 15:49:17 +0000180 /* Transfer SCP_BL2 image to SCP */
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000181 scp_boot_message_start();
Dan Handley9df48042015-03-19 18:58:55 +0000182
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000183 BOM_CMD_HEADER->id = BOOT_CMD_DATA;
184 cmd_data_payload = BOM_CMD_PAYLOAD;
Sandrine Bailleux47ea1bc2015-06-09 11:53:33 +0100185 cmd_data_payload->offset = (uintptr_t) image - ARM_TRUSTED_SRAM_BASE;
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000186 cmd_data_payload->block_size = image_size;
Dan Handley9df48042015-03-19 18:58:55 +0000187
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000188 scp_boot_message_send(sizeof(*cmd_data_payload));
189 response = scp_boot_message_wait(sizeof(response));
190 scp_boot_message_end();
Dan Handley9df48042015-03-19 18:58:55 +0000191
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000192 if (response != 0) {
193 ERROR("SCP BOOT_CMD_DATA returned error %u\n", response);
194 return -1;
Dan Handley9df48042015-03-19 18:58:55 +0000195 }
196
Sandrine Bailleux04b66d82015-03-18 14:52:53 +0000197 VERBOSE("Waiting for SCP to signal it is ready to go on\n");
198
Dan Handley9df48042015-03-19 18:58:55 +0000199 /* Wait for SCP to signal it's ready */
200 return scpi_wait_ready();
201}