2 * Copyright (C) 2014 Freescale Semiconductor
4 * SPDX-License-Identifier: GPL-2.0+
10 #include <asm/system.h>
12 #include <fsl-mc/fsl_mc.h>
13 #include <fsl_debug_server.h>
15 DECLARE_GLOBAL_DATA_PTR;
16 static int debug_server_ver_info_maj, debug_server_ver_info_min;
19 * Copying Debug Server firmware to DDR
21 static int debug_server_copy_image(const char *title, u64 image_addr,
22 u32 image_size, u64 debug_server_ram_addr)
24 debug("%s copied to address %p\n", title,
25 (void *)debug_server_ram_addr);
26 memcpy((void *)debug_server_ram_addr, (void *)image_addr, image_size);
32 * Debug Server FIT image parser checks if the image is in FIT
33 * format, verifies integrity of the image and calculates
34 * raw image address and size values.
36 * Returns 0 if success and -1 if any of the above mentioned
39 int debug_server_parse_firmware_fit_image(const void **raw_image_addr,
40 size_t *raw_image_size)
47 const char *uname = "firmware";
49 char *debug_server_ver_info;
50 char *debug_server_ver_info_major, *debug_server_ver_info_minor;
52 /* Check if the image is in NOR flash */
53 #ifdef CONFIG_SYS_DEBUG_SERVER_FW_IN_NOR
54 fit_hdr = (void *)CONFIG_SYS_DEBUG_SERVER_FW_ADDR;
56 #error "CONFIG_SYS_DEBUG_SERVER_FW_IN_NOR not defined"
59 /* Check if Image is in FIT format */
60 format = genimg_get_format(fit_hdr);
61 if (format != IMAGE_FORMAT_FIT) {
62 printf("Debug Server FW: Not a FIT image\n");
66 if (!fit_check_format(fit_hdr)) {
67 printf("Debug Server FW: Bad FIT image format\n");
71 node_offset = fit_image_get_node(fit_hdr, uname);
72 if (node_offset < 0) {
73 printf("Debug Server FW:Can not find %s subimage\n", uname);
77 /* Verify Debug Server firmware image */
78 if (!fit_image_verify(fit_hdr, node_offset)) {
79 printf("Debug Server FW: Bad Debug Server firmware hash");
83 if (fit_get_desc(fit_hdr, node_offset, &desc) < 0) {
84 printf("Debug Server FW: Failed to get FW description");
88 debug_server_ver_info = strstr(desc, "Version");
89 debug_server_ver_info_major = strtok(debug_server_ver_info, ".");
90 debug_server_ver_info_minor = strtok(NULL, ".");
92 debug_server_ver_info_maj =
93 simple_strtoul(debug_server_ver_info_major, NULL, 10);
94 debug_server_ver_info_min =
95 simple_strtoul(debug_server_ver_info_minor, NULL, 10);
97 /* Debug server version checking */
98 if ((debug_server_ver_info_maj < DEBUG_SERVER_VER_MAJOR) ||
99 (debug_server_ver_info_min < DEBUG_SERVER_VER_MINOR)) {
100 printf("Debug server FW mismatches the min version required\n");
101 printf("Expected:%d.%d, Got %d.%d\n",
102 DEBUG_SERVER_VER_MAJOR, DEBUG_SERVER_VER_MINOR,
103 debug_server_ver_info_maj,
104 debug_server_ver_info_min);
108 /* Get address and size of raw image */
109 fit_image_get_data(fit_hdr, node_offset, &data, &size);
111 *raw_image_addr = data;
112 *raw_image_size = size;
121 * Return the actual size of the Debug Server private DRAM block.
123 * NOTE: For now this function always returns the minimum required size,
124 * However, in the future, the actual size may be obtained from an environment
127 unsigned long debug_server_get_dram_block_size(void)
129 return CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE;
132 int debug_server_init(void)
134 struct ccsr_gur __iomem *gur = (void *)(CONFIG_SYS_FSL_GUTS_ADDR);
135 int error, timeout = CONFIG_SYS_DEBUG_SERVER_TIMEOUT;
136 int debug_server_boot_status;
137 u64 debug_server_ram_addr, debug_server_ram_size;
138 const void *raw_image_addr;
139 size_t raw_image_size = 0;
141 debug("debug_server_init called\n");
143 * The Debug Server private DRAM block was already carved at the end of
144 * DRAM by board_init_f() using CONFIG_SYS_MEM_TOP_HIDE:
146 debug_server_ram_size = debug_server_get_dram_block_size();
147 if (gd->bd->bi_dram[1].start)
148 debug_server_ram_addr =
149 gd->bd->bi_dram[1].start + gd->bd->bi_dram[1].size;
151 debug_server_ram_addr =
152 gd->bd->bi_dram[0].start + gd->bd->bi_dram[0].size;
154 #ifdef CONFIG_FSL_MC_ENET
155 debug_server_ram_addr += mc_get_dram_block_size();
158 error = debug_server_parse_firmware_fit_image(&raw_image_addr,
163 debug("debug server (ram addr = 0x%llx, ram size = 0x%llx)\n",
164 debug_server_ram_addr, debug_server_ram_size);
166 * Load the Debug Server FW at the beginning of the Debug Server
167 * private DRAM block:
169 debug_server_copy_image("Debug Server Firmware",
170 (u64)raw_image_addr, raw_image_size,
171 debug_server_ram_addr);
174 flush_dcache_range((unsigned long)debug_server_ram_addr,
175 (unsigned long)debug_server_ram_addr +
176 (unsigned long)debug_server_ram_size);
179 * Tell SP that the Debug Server FW is about to be launched. Before that
180 * populate the following:
181 * 1. Write the size allocated to SP Memory region into Bits {31:16} of
183 * 2. Write the start address of the SP memory regions into
184 * SCRATCHRW5 (Bits {15:0}, contain most significant bits, Bits
185 * {47:32} of the SP Memory Region physical start address
186 * (SoC address)) and SCRATCHRW6 (Bits {31:0}).
187 * 3. To know the Debug Server FW boot status, set bit 0 of SCRATCHRW11
188 * to 1. The Debug Server sets this to 0 to indicate a
190 * 4. Wakeup SP by writing 0x1F to VSG GIC reg VIGR2.
194 out_le32(&gur->scratchrw[5 - 1],
195 (u32)((u64)debug_server_ram_addr >> 32) | (0x000D << 16));
196 out_le32(&gur->scratchrw[6 - 1],
197 ((u32)debug_server_ram_addr) & 0xFFFFFFFF);
199 out_le32(&gur->scratchrw[11 - 1], DEBUG_SERVER_INIT_STATUS);
200 /* Allow the changes to reflect in GUR block */
204 * Program VGIC to raise an interrupt to SP
206 out_le32(CONFIG_SYS_FSL_SP_VSG_GIC_VIGR2, 0x1F);
207 /* Allow the changes to reflect in VIGR2 */
211 debug("Polling for Debug server to launch ...\n");
214 debug_server_boot_status = in_le32(&gur->scratchrw[11 - 1]);
215 if (!(debug_server_boot_status & DEBUG_SERVER_INIT_STATUS_MASK))
218 udelay(1); /* throttle polling */
224 printf("Debug Server FW timed out (boot status: 0x%x)\n",
225 debug_server_boot_status);
230 if (debug_server_boot_status & DEBUG_SERVER_INIT_STATUS_MASK) {
231 printf("Debug server FW error'ed out (boot status: 0x%x)\n",
232 debug_server_boot_status);
237 printf("Debug server booted\n");
238 printf("Detected firmware %d.%d, (boot status: 0x0%x)\n",
239 debug_server_ver_info_maj, debug_server_ver_info_min,
240 debug_server_boot_status);
244 debug_server_boot_status = -error;
246 debug_server_boot_status = 0;
248 return debug_server_boot_status;