1/*
2 * Nios2 kernel loader
3 *
4 * Copyright (c) 2016 Marek Vasut <marek.vasut@gmail.com>
5 *
6 * Based on microblaze kernel loader
7 *
8 * Copyright (c) 2012 Peter Crosthwaite <peter.crosthwaite@petalogix.com>
9 * Copyright (c) 2012 PetaLogix
10 * Copyright (c) 2009 Edgar E. Iglesias.
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a copy
13 * of this software and associated documentation files (the "Software"), to deal
14 * in the Software without restriction, including without limitation the rights
15 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16 * copies of the Software, and to permit persons to whom the Software is
17 * furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
28 * THE SOFTWARE.
29 */
30
31#include "qemu/osdep.h"
32#include "qemu/units.h"
33#include "qemu-common.h"
34#include "cpu.h"
35#include "qemu/option.h"
36#include "qemu/config-file.h"
37#include "qemu/error-report.h"
38#include "sysemu/device_tree.h"
39#include "sysemu/reset.h"
40#include "sysemu/sysemu.h"
41#include "hw/loader.h"
42#include "elf.h"
43
44#include "boot.h"
45
46#define NIOS2_MAGIC 0x534f494e
47
48static struct nios2_boot_info {
49 void (*machine_cpu_reset)(Nios2CPU *);
50 uint32_t bootstrap_pc;
51 uint32_t cmdline;
52 uint32_t initrd_start;
53 uint32_t initrd_end;
54 uint32_t fdt;
55} boot_info;
56
57static void main_cpu_reset(void *opaque)
58{
59 Nios2CPU *cpu = opaque;
60 CPUState *cs = CPU(cpu);
61 CPUNios2State *env = &cpu->env;
62
63 cpu_reset(CPU(cpu));
64
65 env->regs[R_ARG0] = NIOS2_MAGIC;
66 env->regs[R_ARG1] = boot_info.initrd_start;
67 env->regs[R_ARG2] = boot_info.fdt;
68 env->regs[R_ARG3] = boot_info.cmdline;
69
70 cpu_set_pc(cs, boot_info.bootstrap_pc);
71 if (boot_info.machine_cpu_reset) {
72 boot_info.machine_cpu_reset(cpu);
73 }
74}
75
76static uint64_t translate_kernel_address(void *opaque, uint64_t addr)
77{
78 return addr - 0xc0000000LL;
79}
80
81static int nios2_load_dtb(struct nios2_boot_info bi, const uint32_t ramsize,
82 const char *kernel_cmdline, const char *dtb_filename)
83{
84 int fdt_size;
85 void *fdt = NULL;
86 int r;
87
88 if (dtb_filename) {
89 fdt = load_device_tree(dtb_filename, &fdt_size);
90 }
91 if (!fdt) {
92 return 0;
93 }
94
95 if (kernel_cmdline) {
96 r = qemu_fdt_setprop_string(fdt, "/chosen", "bootargs",
97 kernel_cmdline);
98 if (r < 0) {
99 fprintf(stderr, "couldn't set /chosen/bootargs\n");
100 }
101 }
102
103 if (bi.initrd_start) {
104 qemu_fdt_setprop_cell(fdt, "/chosen", "linux,initrd-start",
105 translate_kernel_address(NULL, bi.initrd_start));
106
107 qemu_fdt_setprop_cell(fdt, "/chosen", "linux,initrd-end",
108 translate_kernel_address(NULL, bi.initrd_end));
109 }
110
111 cpu_physical_memory_write(bi.fdt, fdt, fdt_size);
112 return fdt_size;
113}
114
115void nios2_load_kernel(Nios2CPU *cpu, hwaddr ddr_base,
116 uint32_t ramsize,
117 const char *initrd_filename,
118 const char *dtb_filename,
119 void (*machine_cpu_reset)(Nios2CPU *))
120{
121 QemuOpts *machine_opts;
122 const char *kernel_filename;
123 const char *kernel_cmdline;
124 const char *dtb_arg;
125 char *filename = NULL;
126
127 machine_opts = qemu_get_machine_opts();
128 kernel_filename = qemu_opt_get(machine_opts, "kernel");
129 kernel_cmdline = qemu_opt_get(machine_opts, "append");
130 dtb_arg = qemu_opt_get(machine_opts, "dtb");
131 /* default to pcbios dtb as passed by machine_init */
132 if (!dtb_arg) {
133 filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, dtb_filename);
134 }
135
136 boot_info.machine_cpu_reset = machine_cpu_reset;
137 qemu_register_reset(main_cpu_reset, cpu);
138
139 if (kernel_filename) {
140 int kernel_size, fdt_size;
141 uint64_t entry, low, high;
142 int big_endian = 0;
143
144#ifdef TARGET_WORDS_BIGENDIAN
145 big_endian = 1;
146#endif
147
148 /* Boots a kernel elf binary. */
149 kernel_size = load_elf(kernel_filename, NULL, NULL, NULL,
150 &entry, &low, &high,
151 big_endian, EM_ALTERA_NIOS2, 0, 0);
152 if ((uint32_t)entry == 0xc0000000) {
153 /*
154 * The Nios II processor reference guide documents that the
155 * kernel is placed at virtual memory address 0xc0000000,
156 * and we've got something that points there. Reload it
157 * and adjust the entry to get the address in physical RAM.
158 */
159 kernel_size = load_elf(kernel_filename, NULL,
160 translate_kernel_address, NULL,
161 &entry, NULL, NULL,
162 big_endian, EM_ALTERA_NIOS2, 0, 0);
163 boot_info.bootstrap_pc = ddr_base + 0xc0000000 +
164 (entry & 0x07ffffff);
165 } else {
166 /* Use the entry point in the ELF image. */
167 boot_info.bootstrap_pc = (uint32_t)entry;
168 }
169
170 /* If it wasn't an ELF image, try an u-boot image. */
171 if (kernel_size < 0) {
172 hwaddr uentry, loadaddr = LOAD_UIMAGE_LOADADDR_INVALID;
173
174 kernel_size = load_uimage(kernel_filename, &uentry, &loadaddr, 0,
175 NULL, NULL);
176 boot_info.bootstrap_pc = uentry;
177 high = loadaddr + kernel_size;
178 }
179
180 /* Not an ELF image nor an u-boot image, try a RAW image. */
181 if (kernel_size < 0) {
182 kernel_size = load_image_targphys(kernel_filename, ddr_base,
183 ram_size);
184 boot_info.bootstrap_pc = ddr_base;
185 high = ddr_base + kernel_size;
186 }
187
188 high = ROUND_UP(high, 1 * MiB);
189
190 /* If initrd is available, it goes after the kernel, aligned to 1M. */
191 if (initrd_filename) {
192 int initrd_size;
193 uint32_t initrd_offset;
194
195 boot_info.initrd_start = high;
196 initrd_offset = boot_info.initrd_start - ddr_base;
197
198 initrd_size = load_ramdisk(initrd_filename,
199 boot_info.initrd_start,
200 ram_size - initrd_offset);
201 if (initrd_size < 0) {
202 initrd_size = load_image_targphys(initrd_filename,
203 boot_info.initrd_start,
204 ram_size - initrd_offset);
205 }
206 if (initrd_size < 0) {
207 error_report("could not load initrd '%s'",
208 initrd_filename);
209 exit(EXIT_FAILURE);
210 }
211 high += initrd_size;
212 }
213 high = ROUND_UP(high, 4);
214 boot_info.initrd_end = high;
215
216 /* Device tree must be placed right after initrd (if available) */
217 boot_info.fdt = high;
218 fdt_size = nios2_load_dtb(boot_info, ram_size, kernel_cmdline,
219 /* Preference a -dtb argument */
220 dtb_arg ? dtb_arg : filename);
221 high += fdt_size;
222
223 /* Kernel command is at the end, 4k aligned. */
224 boot_info.cmdline = ROUND_UP(high, 4 * KiB);
225 if (kernel_cmdline && strlen(kernel_cmdline)) {
226 pstrcpy_targphys("cmdline", boot_info.cmdline, 256, kernel_cmdline);
227 }
228 }
229 g_free(filename);
230}
231