command: Remove the cmd_tbl_t typedef
[oweals/u-boot.git] / arch / powerpc / lib / bootm.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * (C) Copyright 2008 Semihalf
4  *
5  * (C) Copyright 2000-2006
6  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7  */
8
9
10 #include <common.h>
11 #include <bootstage.h>
12 #include <cpu_func.h>
13 #include <env.h>
14 #include <init.h>
15 #include <lmb.h>
16 #include <watchdog.h>
17 #include <command.h>
18 #include <image.h>
19 #include <malloc.h>
20 #include <u-boot/zlib.h>
21 #include <bzlib.h>
22 #include <asm/byteorder.h>
23 #include <asm/mp.h>
24 #include <bootm.h>
25 #include <vxworks.h>
26
27 #if defined(CONFIG_OF_LIBFDT)
28 #include <linux/libfdt.h>
29 #include <fdt_support.h>
30 #endif
31
32 #ifdef CONFIG_SYS_INIT_RAM_LOCK
33 #include <asm/cache.h>
34 #endif
35
36 DECLARE_GLOBAL_DATA_PTR;
37
38 static ulong get_sp (void);
39 extern void ft_fixup_num_cores(void *blob);
40 static void set_clocks_in_mhz (bd_t *kbd);
41
42 #ifndef CONFIG_SYS_LINUX_LOWMEM_MAX_SIZE
43 #define CONFIG_SYS_LINUX_LOWMEM_MAX_SIZE        (768*1024*1024)
44 #endif
45
46 static void boot_jump_linux(bootm_headers_t *images)
47 {
48         void    (*kernel)(bd_t *, ulong r4, ulong r5, ulong r6,
49                           ulong r7, ulong r8, ulong r9);
50 #ifdef CONFIG_OF_LIBFDT
51         char *of_flat_tree = images->ft_addr;
52 #endif
53
54         kernel = (void (*)(bd_t *, ulong, ulong, ulong,
55                            ulong, ulong, ulong))images->ep;
56         debug ("## Transferring control to Linux (at address %08lx) ...\n",
57                 (ulong)kernel);
58
59         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
60
61 #ifdef CONFIG_BOOTSTAGE_FDT
62         bootstage_fdt_add_report();
63 #endif
64 #ifdef CONFIG_BOOTSTAGE_REPORT
65         bootstage_report();
66 #endif
67
68 #if defined(CONFIG_SYS_INIT_RAM_LOCK) && !defined(CONFIG_E500)
69         unlock_ram_in_cache();
70 #endif
71
72 #if defined(CONFIG_OF_LIBFDT)
73         if (of_flat_tree) {     /* device tree; boot new style */
74                 /*
75                  * Linux Kernel Parameters (passing device tree):
76                  *   r3: pointer to the fdt
77                  *   r4: 0
78                  *   r5: 0
79                  *   r6: epapr magic
80                  *   r7: size of IMA in bytes
81                  *   r8: 0
82                  *   r9: 0
83                  */
84                 debug ("   Booting using OF flat tree...\n");
85                 WATCHDOG_RESET ();
86                 (*kernel) ((bd_t *)of_flat_tree, 0, 0, EPAPR_MAGIC,
87                            env_get_bootm_mapsize(), 0, 0);
88                 /* does not return */
89         } else
90 #endif
91         {
92                 /*
93                  * Linux Kernel Parameters (passing board info data):
94                  *   r3: ptr to board info data
95                  *   r4: initrd_start or 0 if no initrd
96                  *   r5: initrd_end - unused if r4 is 0
97                  *   r6: Start of command line string
98                  *   r7: End   of command line string
99                  *   r8: 0
100                  *   r9: 0
101                  */
102                 ulong cmd_start = images->cmdline_start;
103                 ulong cmd_end = images->cmdline_end;
104                 ulong initrd_start = images->initrd_start;
105                 ulong initrd_end = images->initrd_end;
106                 bd_t *kbd = images->kbd;
107
108                 debug ("   Booting using board info...\n");
109                 WATCHDOG_RESET ();
110                 (*kernel) (kbd, initrd_start, initrd_end,
111                            cmd_start, cmd_end, 0, 0);
112                 /* does not return */
113         }
114         return ;
115 }
116
117 void arch_lmb_reserve(struct lmb *lmb)
118 {
119         phys_size_t bootm_size;
120         ulong size, sp, bootmap_base;
121
122         bootmap_base = env_get_bootm_low();
123         bootm_size = env_get_bootm_size();
124
125 #ifdef DEBUG
126         if (((u64)bootmap_base + bootm_size) >
127             (CONFIG_SYS_SDRAM_BASE + (u64)gd->ram_size))
128                 puts("WARNING: bootm_low + bootm_size exceed total memory\n");
129         if ((bootmap_base + bootm_size) > get_effective_memsize())
130                 puts("WARNING: bootm_low + bootm_size exceed eff. memory\n");
131 #endif
132
133         size = min(bootm_size, get_effective_memsize());
134         size = min(size, (ulong)CONFIG_SYS_LINUX_LOWMEM_MAX_SIZE);
135
136         if (size < bootm_size) {
137                 ulong base = bootmap_base + size;
138                 printf("WARNING: adjusting available memory to %lx\n", size);
139                 lmb_reserve(lmb, base, bootm_size - size);
140         }
141
142         /*
143          * Booting a (Linux) kernel image
144          *
145          * Allocate space for command line and board info - the
146          * address should be as high as possible within the reach of
147          * the kernel (see CONFIG_SYS_BOOTMAPSZ settings), but in unused
148          * memory, which means far enough below the current stack
149          * pointer.
150          */
151         sp = get_sp();
152         debug ("## Current stack ends at 0x%08lx\n", sp);
153
154         /* adjust sp by 4K to be safe */
155         sp -= 4096;
156         lmb_reserve(lmb, sp, (CONFIG_SYS_SDRAM_BASE + get_effective_memsize() - sp));
157
158 #ifdef CONFIG_MP
159         cpu_mp_lmb_reserve(lmb);
160 #endif
161
162         return ;
163 }
164
165 static void boot_prep_linux(bootm_headers_t *images)
166 {
167 #ifdef CONFIG_MP
168         /*
169          * if we are MP make sure to flush the device tree so any changes are
170          * made visibile to all other cores.  In AMP boot scenarios the cores
171          * might not be HW cache coherent with each other.
172          */
173         flush_cache((unsigned long)images->ft_addr, images->ft_len);
174 #endif
175 }
176
177 static int boot_cmdline_linux(bootm_headers_t *images)
178 {
179         ulong of_size = images->ft_len;
180         struct lmb *lmb = &images->lmb;
181         ulong *cmd_start = &images->cmdline_start;
182         ulong *cmd_end = &images->cmdline_end;
183
184         int ret = 0;
185
186         if (!of_size) {
187                 /* allocate space and init command line */
188                 ret = boot_get_cmdline (lmb, cmd_start, cmd_end);
189                 if (ret) {
190                         puts("ERROR with allocation of cmdline\n");
191                         return ret;
192                 }
193         }
194
195         return ret;
196 }
197
198 static int boot_bd_t_linux(bootm_headers_t *images)
199 {
200         ulong of_size = images->ft_len;
201         struct lmb *lmb = &images->lmb;
202         bd_t **kbd = &images->kbd;
203
204         int ret = 0;
205
206         if (!of_size) {
207                 /* allocate space for kernel copy of board info */
208                 ret = boot_get_kbd (lmb, kbd);
209                 if (ret) {
210                         puts("ERROR with allocation of kernel bd\n");
211                         return ret;
212                 }
213                 set_clocks_in_mhz(*kbd);
214         }
215
216         return ret;
217 }
218
219 static int boot_body_linux(bootm_headers_t *images)
220 {
221         int ret;
222
223         /* allocate space for kernel copy of board info */
224         ret = boot_bd_t_linux(images);
225         if (ret)
226                 return ret;
227
228         ret = image_setup_linux(images);
229         if (ret)
230                 return ret;
231
232         return 0;
233 }
234
235 noinline int do_bootm_linux(int flag, int argc, char *const argv[],
236                             bootm_headers_t *images)
237 {
238         int     ret;
239
240         if (flag & BOOTM_STATE_OS_CMDLINE) {
241                 boot_cmdline_linux(images);
242                 return 0;
243         }
244
245         if (flag & BOOTM_STATE_OS_BD_T) {
246                 boot_bd_t_linux(images);
247                 return 0;
248         }
249
250         if (flag & BOOTM_STATE_OS_PREP) {
251                 boot_prep_linux(images);
252                 return 0;
253         }
254
255         boot_prep_linux(images);
256         ret = boot_body_linux(images);
257         if (ret)
258                 return ret;
259         boot_jump_linux(images);
260
261         return 0;
262 }
263
264 static ulong get_sp (void)
265 {
266         ulong sp;
267
268         asm( "mr %0,1": "=r"(sp) : );
269         return sp;
270 }
271
272 static void set_clocks_in_mhz (bd_t *kbd)
273 {
274         char    *s;
275
276         s = env_get("clocks_in_mhz");
277         if (s) {
278                 /* convert all clock information to MHz */
279                 kbd->bi_intfreq /= 1000000L;
280                 kbd->bi_busfreq /= 1000000L;
281 #if defined(CONFIG_CPM2)
282                 kbd->bi_cpmfreq /= 1000000L;
283                 kbd->bi_brgfreq /= 1000000L;
284                 kbd->bi_sccfreq /= 1000000L;
285                 kbd->bi_vco     /= 1000000L;
286 #endif
287         }
288 }
289
290 #if defined(CONFIG_BOOTM_VXWORKS)
291 void boot_prep_vxworks(bootm_headers_t *images)
292 {
293 #if defined(CONFIG_OF_LIBFDT)
294         int off;
295         u64 base, size;
296
297         if (!images->ft_addr)
298                 return;
299
300         base = (u64)gd->bd->bi_memstart;
301         size = (u64)gd->bd->bi_memsize;
302
303         off = fdt_path_offset(images->ft_addr, "/memory");
304         if (off < 0)
305                 fdt_fixup_memory(images->ft_addr, base, size);
306
307 #if defined(CONFIG_MP)
308 #if defined(CONFIG_MPC85xx)
309         ft_fixup_cpu(images->ft_addr, base + size);
310         ft_fixup_num_cores(images->ft_addr);
311 #elif defined(CONFIG_MPC86xx)
312         off = fdt_add_mem_rsv(images->ft_addr,
313                         determine_mp_bootpg(NULL), (u64)4096);
314         if (off < 0)
315                 printf("## WARNING %s: %s\n", __func__, fdt_strerror(off));
316         ft_fixup_num_cores(images->ft_addr);
317 #endif
318         flush_cache((unsigned long)images->ft_addr, images->ft_len);
319 #endif
320 #endif
321 }
322
323 void boot_jump_vxworks(bootm_headers_t *images)
324 {
325         /* PowerPC VxWorks boot interface conforms to the ePAPR standard
326          * general purpuse registers:
327          *
328          *      r3: Effective address of the device tree image
329          *      r4: 0
330          *      r5: 0
331          *      r6: ePAPR magic value
332          *      r7: shall be the size of the boot IMA in bytes
333          *      r8: 0
334          *      r9: 0
335          *      TCR: WRC = 0, no watchdog timer reset will occur
336          */
337         WATCHDOG_RESET();
338
339         ((void (*)(void *, ulong, ulong, ulong,
340                 ulong, ulong, ulong))images->ep)(images->ft_addr,
341                 0, 0, EPAPR_MAGIC, env_get_bootm_mapsize(), 0, 0);
342 }
343 #endif