Merge with git://www.denx.de/git/u-boot.git
[platform/kernel/u-boot.git] / common / ft_build.c
1 /*
2  * OF flat tree builder
3  * Written by: Pantelis Antoniou <pantelis.antoniou@gmail.com>
4  * Updated by: Matthew McClintock <msm@freescale.com>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License as
8  * published by the Free Software Foundation; either version 2 of
9  * the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
19  * MA 02111-1307 USA
20  */
21
22 #include <common.h>
23 #include <malloc.h>
24 #include <environment.h>
25
26 #ifdef CONFIG_OF_FLAT_TREE
27
28 #include <asm/errno.h>
29 #include <stddef.h>
30
31 #include <ft_build.h>
32 #include <linux/ctype.h>
33
34 #undef DEBUG
35
36 /* align addr on a size boundary - adjust address up if needed -- Cort */
37 #define _ALIGN(addr,size)       (((addr)+(size)-1)&(~((size)-1)))
38 #ifndef CONFIG_OF_BOOT_CPU
39 #define CONFIG_OF_BOOT_CPU 0
40 #endif
41 #define SIZE_OF_RSVMAP_ENTRY (2*sizeof(u64))
42
43 static void ft_put_word(struct ft_cxt *cxt, u32 v)
44 {
45         memmove(cxt->p + sizeof(u32), cxt->p, cxt->p_end - cxt->p);
46
47         *(u32 *) cxt->p = cpu_to_be32(v);
48         cxt->p += sizeof(u32);
49         cxt->p_end += sizeof(u32);
50 }
51
52 static inline void ft_put_bin(struct ft_cxt *cxt, const void *data, int sz)
53 {
54         int aligned_size = ((u8 *)_ALIGN((unsigned long)cxt->p + sz,
55                                         sizeof(u32))) - cxt->p;
56
57         memmove(cxt->p + aligned_size, cxt->p, cxt->p_end - cxt->p);
58
59         /* make sure the last bytes are zeroed */
60         memset(cxt->p + aligned_size - (aligned_size % sizeof(u32)), 0,
61                         (aligned_size % sizeof(u32)));
62
63         memcpy(cxt->p, data, sz);
64
65         cxt->p += aligned_size;
66         cxt->p_end += aligned_size;
67 }
68
69 void ft_begin_node(struct ft_cxt *cxt, const char *name)
70 {
71         ft_put_word(cxt, OF_DT_BEGIN_NODE);
72         ft_put_bin(cxt, name, strlen(name) + 1);
73 }
74
75 void ft_end_node(struct ft_cxt *cxt)
76 {
77         ft_put_word(cxt, OF_DT_END_NODE);
78 }
79
80 void ft_nop(struct ft_cxt *cxt)
81 {
82         ft_put_word(cxt, OF_DT_NOP);
83 }
84
85 static int lookup_string(struct ft_cxt *cxt, const char *name)
86 {
87         u8 *p;
88
89         p = cxt->p;
90         while (p < cxt->p_end) {
91                 if (strcmp((char *)p, name) == 0)
92                         return p - cxt->p;
93                 p += strlen((char *)p) + 1;
94         }
95
96         return -1;
97 }
98
99 void ft_prop(struct ft_cxt *cxt, const char *name, const void *data, int sz)
100 {
101         int off = 0;
102
103         off = lookup_string(cxt, name);
104         if (off == -1) {
105                 memcpy(cxt->p_end, name, strlen(name) + 1);
106                 off = cxt->p_end - cxt->p;
107                 cxt->p_end += strlen(name) + 1;
108         }
109
110         /* now put offset from beginning of *STRUCTURE* */
111         /* will be fixed up at the end */
112         ft_put_word(cxt, OF_DT_PROP);
113         ft_put_word(cxt, sz);
114         ft_put_word(cxt, off);
115         ft_put_bin(cxt, data, sz);
116 }
117
118 void ft_prop_str(struct ft_cxt *cxt, const char *name, const char *str)
119 {
120         ft_prop(cxt, name, str, strlen(str) + 1);
121 }
122
123 void ft_prop_int(struct ft_cxt *cxt, const char *name, int val)
124 {
125         u32 v = cpu_to_be32((u32) val);
126
127         ft_prop(cxt, name, &v, sizeof(u32));
128 }
129
130 /* pick up and start working on a tree in place */
131 void ft_init_cxt(struct ft_cxt *cxt, void *blob)
132 {
133         struct boot_param_header *bph = blob;
134
135         memset(cxt, 0, sizeof(*cxt));
136
137         cxt->bph = bph;
138         bph->boot_cpuid_phys = CONFIG_OF_BOOT_CPU;
139
140         /* find beginning and end of reserve map table (zeros in last entry) */
141         cxt->p_rsvmap = (u8 *)bph + bph->off_mem_rsvmap;
142         while ( ((uint64_t *)cxt->p_rsvmap)[0] != 0 &&
143                      ((uint64_t *)cxt->p_rsvmap)[1] != 0 ) {
144         cxt->p_rsvmap += SIZE_OF_RSVMAP_ENTRY;
145         }
146
147         cxt->p_start = (u8 *)bph + bph->off_dt_struct;
148         cxt->p_end = (u8 *)bph + bph->totalsize;
149         cxt->p = (u8 *)bph + bph->off_dt_strings;
150 }
151
152 /* add a reserver physical area to the rsvmap */
153 void ft_add_rsvmap(struct ft_cxt *cxt, u64 physstart, u64 physend)
154 {
155         memmove(cxt->p_rsvmap + SIZE_OF_RSVMAP_ENTRY, cxt->p_rsvmap,
156                                  cxt->p_end - cxt->p_rsvmap);
157
158         ((u64 *)cxt->p_rsvmap)[0] = cpu_to_be64(physstart);
159         ((u64 *)cxt->p_rsvmap)[1] = cpu_to_be64(physend);
160         ((u64 *)cxt->p_rsvmap)[2] = 0;
161         ((u64 *)cxt->p_rsvmap)[3] = 0;
162
163         cxt->p_rsvmap += SIZE_OF_RSVMAP_ENTRY;
164         cxt->p_start += SIZE_OF_RSVMAP_ENTRY;
165         cxt->p += SIZE_OF_RSVMAP_ENTRY;
166         cxt->p_end += SIZE_OF_RSVMAP_ENTRY;
167 }
168
169 void ft_end_tree(struct ft_cxt *cxt)
170 {
171         ft_put_word(cxt, OF_DT_END);
172 }
173
174 /* update the boot param header with correct values */
175 void ft_finalize_tree(struct ft_cxt *cxt) {
176         struct boot_param_header *bph = cxt->bph;
177
178         bph->totalsize = cxt->p_end - (u8 *)bph;
179         bph->off_dt_struct = cxt->p_start - (u8 *)bph;
180         bph->off_dt_strings = cxt->p - (u8 *)bph;
181         bph->dt_strings_size = cxt->p_end - cxt->p;
182 }
183
184 static int is_printable_string(const void *data, int len)
185 {
186         const char *s = data;
187         const char *ss;
188
189         /* zero length is not */
190         if (len == 0)
191                 return 0;
192
193         /* must terminate with zero */
194         if (s[len - 1] != '\0')
195                 return 0;
196
197         ss = s;
198         while (*s && isprint(*s))
199                 s++;
200
201         /* not zero, or not done yet */
202         if (*s != '\0' || (s + 1 - ss) < len)
203                 return 0;
204
205         return 1;
206 }
207
208 static void print_data(const void *data, int len)
209 {
210         int i;
211         const u8 *s;
212
213         /* no data, don't print */
214         if (len == 0)
215                 return;
216
217         if (is_printable_string(data, len)) {
218                 puts(" = \"");
219                 puts(data);
220                 puts("\"");
221                 return;
222         }
223
224         switch (len) {
225         case 1:         /* byte */
226                 printf(" = <%02x>", (*(u8 *) data) & 0xff);
227                 break;
228         case 2:         /* half-word */
229                 printf(" = <%04x>", be16_to_cpu(*(u16 *) data) & 0xffff);
230                 break;
231         case 4:         /* word */
232                 printf(" = <%x>", be32_to_cpu(*(u32 *) data) & 0xffffffffU);
233                 break;
234         case 8:         /* double-word */
235                 printf(" = <%qx>", be64_to_cpu(*(uint64_t *) data));
236                 break;
237         default:                /* anything else... hexdump */
238                 printf(" = [");
239                 for (i = 0, s = data; i < len; i++)
240                         printf("%02x%s", s[i], i < len - 1 ? " " : "");
241                 printf("]");
242
243                 break;
244         }
245 }
246
247 void ft_dump_blob(const void *bphp)
248 {
249         const struct boot_param_header *bph = bphp;
250         const uint64_t *p_rsvmap = (const uint64_t *)
251                 ((const char *)bph + be32_to_cpu(bph->off_mem_rsvmap));
252         const u32 *p_struct = (const u32 *)
253                 ((const char *)bph + be32_to_cpu(bph->off_dt_struct));
254         const u32 *p_strings = (const u32 *)
255                 ((const char *)bph + be32_to_cpu(bph->off_dt_strings));
256         u32 tag;
257         const u32 *p;
258         const char *s, *t;
259         int depth, sz, shift;
260         int i;
261         uint64_t addr, size;
262
263         if (be32_to_cpu(bph->magic) != OF_DT_HEADER) {
264                 /* not valid tree */
265                 return;
266         }
267
268         depth = 0;
269         shift = 4;
270
271         for (i = 0;; i++) {
272                 addr = be64_to_cpu(p_rsvmap[i * 2]);
273                 size = be64_to_cpu(p_rsvmap[i * 2 + 1]);
274                 if (addr == 0 && size == 0)
275                         break;
276
277                 printf("/memreserve/ %qx %qx;\n", addr, size);
278         }
279
280         p = p_struct;
281         while ((tag = be32_to_cpu(*p++)) != OF_DT_END) {
282
283                 /* printf("tag: 0x%08x (%d)\n", tag, p - p_struct); */
284
285                 if (tag == OF_DT_BEGIN_NODE) {
286                         s = (const char *)p;
287                         p = (u32 *) _ALIGN((unsigned long)p + strlen(s) + 1, 4);
288
289                         printf("%*s%s {\n", depth * shift, "", s);
290
291                         depth++;
292                         continue;
293                 }
294
295                 if (tag == OF_DT_END_NODE) {
296                         depth--;
297
298                         printf("%*s};\n", depth * shift, "");
299                         continue;
300                 }
301
302                 if (tag == OF_DT_NOP) {
303                         printf("%*s[NOP]\n", depth * shift, "");
304                         continue;
305                 }
306
307                 if (tag != OF_DT_PROP) {
308                         fprintf(stderr, "%*s ** Unknown tag 0x%08x at 0x%x\n",
309                                 depth * shift, "", tag, --p);
310                         break;
311                 }
312                 sz = be32_to_cpu(*p++);
313                 s = (const char *)p_strings + be32_to_cpu(*p++);
314                 t = (const char *)p;
315                 p = (const u32 *)_ALIGN((unsigned long)p + sz, 4);
316                 printf("%*s%s", depth * shift, "", s);
317                 print_data(t, sz);
318                 printf(";\n");
319         }
320 }
321
322 void ft_backtrack_node(struct ft_cxt *cxt)
323 {
324         int i = 4;
325
326         while (be32_to_cpu(*(u32 *) (cxt->p - i)) != OF_DT_END_NODE)
327                 i += 4;
328
329         memmove (cxt->p - i, cxt->p, cxt->p_end - cxt->p);
330
331         cxt->p_end -= i;
332         cxt->p -= i;
333 }
334
335 void *ft_get_prop(void *bphp, const char *propname, int *szp)
336 {
337         struct boot_param_header *bph = bphp;
338         uint32_t *p_struct =
339             (uint32_t *) ((char *)bph + be32_to_cpu(bph->off_dt_struct));
340         uint32_t *p_strings =
341             (uint32_t *) ((char *)bph + be32_to_cpu(bph->off_dt_strings));
342         uint32_t version = be32_to_cpu(bph->version);
343         uint32_t tag;
344         uint32_t *p;
345         char *s, *t;
346         char *ss;
347         int sz;
348         static char path[256], prop[256];
349
350         path[0] = '\0';
351
352         p = p_struct;
353         while ((tag = be32_to_cpu(*p++)) != OF_DT_END) {
354
355                 if (tag == OF_DT_BEGIN_NODE) {
356                         s = (char *)p;
357                         p = (uint32_t *) _ALIGN((unsigned long)p + strlen(s) +
358                                                 1, 4);
359                         strcat(path, s);
360                         strcat(path, "/");
361                         continue;
362                 }
363
364                 if (tag == OF_DT_END_NODE) {
365                         path[strlen(path) - 1] = '\0';
366                         ss = strrchr(path, '/');
367                         if (ss != NULL)
368                                 ss[1] = '\0';
369                         continue;
370                 }
371
372                 if (tag == OF_DT_NOP)
373                         continue;
374
375                 if (tag != OF_DT_PROP)
376                         break;
377
378                 sz = be32_to_cpu(*p++);
379                 s = (char *)p_strings + be32_to_cpu(*p++);
380                 if (version < 0x10 && sz >= 8)
381                         p = (uint32_t *) _ALIGN((unsigned long)p, 8);
382                 t = (char *)p;
383                 p = (uint32_t *) _ALIGN((unsigned long)p + sz, 4);
384
385                 strcpy(prop, path);
386                 strcat(prop, s);
387
388                 if (strcmp(prop, propname) == 0) {
389                         *szp = sz;
390                         return t;
391                 }
392         }
393
394         return NULL;
395 }
396
397 /********************************************************************/
398
399 /* Function that returns a character from the environment */
400 extern uchar(*env_get_char) (int);
401
402 #define BDM(x)  {       .name = #x, .offset = offsetof(bd_t, bi_ ##x ) }
403
404 #ifdef CONFIG_OF_HAS_BD_T
405 static const struct {
406         const char *name;
407         int offset;
408 } bd_map[] = {
409         BDM(memstart),
410         BDM(memsize),
411         BDM(flashstart),
412         BDM(flashsize),
413         BDM(flashoffset),
414         BDM(sramstart),
415         BDM(sramsize),
416 #if defined(CONFIG_5xx) || defined(CONFIG_8xx) || defined(CONFIG_8260) \
417         || defined(CONFIG_E500)
418         BDM(immr_base),
419 #endif
420 #if defined(CONFIG_MPC5xxx)
421         BDM(mbar_base),
422 #endif
423 #if defined(CONFIG_MPC83XX)
424         BDM(immrbar),
425 #endif
426 #if defined(CONFIG_MPC8220)
427         BDM(mbar_base),
428         BDM(inpfreq),
429         BDM(pcifreq),
430         BDM(pevfreq),
431         BDM(flbfreq),
432         BDM(vcofreq),
433 #endif
434         BDM(bootflags),
435         BDM(ip_addr),
436         BDM(intfreq),
437         BDM(busfreq),
438 #ifdef CONFIG_CPM2
439         BDM(cpmfreq),
440         BDM(brgfreq),
441         BDM(sccfreq),
442         BDM(vco),
443 #endif
444 #if defined(CONFIG_MPC5xxx)
445         BDM(ipbfreq),
446         BDM(pcifreq),
447 #endif
448         BDM(baudrate),
449 };
450 #endif
451
452 void ft_setup(void *blob, bd_t * bd, ulong initrd_start, ulong initrd_end)
453 {
454         u32 *p;
455         int len;
456         struct ft_cxt cxt;
457         ulong clock;
458 #if defined(CONFIG_OF_HAS_UBOOT_ENV)
459         int k, nxt;
460 #endif
461 #if defined(CONFIG_OF_HAS_BD_T)
462         u8 *end;
463 #endif
464 #if defined(CONFIG_OF_HAS_UBOOT_ENV) || defined(CONFIG_OF_HAS_BD_T)
465         int i;
466         static char tmpenv[256];
467 #endif
468
469         /* disable OF tree; booting old kernel */
470         if (getenv("disable_of") != NULL) {
471                 memcpy(blob, bd, sizeof(*bd));
472                 return;
473         }
474
475 #ifdef DEBUG
476         printf ("recieved oftree\n");
477         ft_dump_blob(blob);
478 #endif
479
480         ft_init_cxt(&cxt, blob);
481
482         if (initrd_start && initrd_end)
483                 ft_add_rsvmap(&cxt, initrd_start, initrd_end - initrd_start + 1);
484
485         /* back into root */
486         ft_backtrack_node(&cxt);
487
488 #ifdef CONFIG_OF_HAS_UBOOT_ENV
489         ft_begin_node(&cxt, "u-boot-env");
490
491         for (i = 0; env_get_char(i) != '\0'; i = nxt + 1) {
492                 char *s, *lval, *rval;
493
494                 for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) ;
495                 s = tmpenv;
496                 for (k = i; k < nxt && s < &tmpenv[sizeof(tmpenv) - 1]; ++k)
497                         *s++ = env_get_char(k);
498                 *s++ = '\0';
499                 lval = tmpenv;
500                 s = strchr(tmpenv, '=');
501                 if (s != NULL) {
502                         *s++ = '\0';
503                         rval = s;
504                 } else
505                         continue;
506                 ft_prop_str(&cxt, lval, rval);
507         }
508
509         ft_end_node(&cxt);
510 #endif
511
512         ft_begin_node(&cxt, "chosen");
513         ft_prop_str(&cxt, "name", "chosen");
514
515         ft_prop_str(&cxt, "bootargs", getenv("bootargs"));
516         ft_prop_int(&cxt, "linux,platform", 0x600);     /* what is this? */
517         if (initrd_start && initrd_end) {
518                 ft_prop_int(&cxt, "linux,initrd-start", initrd_start);
519                 ft_prop_int(&cxt, "linux,initrd-end", initrd_end);
520         }
521 #ifdef OF_STDOUT_PATH
522         ft_prop_str(&cxt, "linux,stdout-path", OF_STDOUT_PATH);
523 #endif
524
525         ft_end_node(&cxt);
526
527         ft_end_node(&cxt);      /* end root */
528
529         ft_end_tree(&cxt);
530         ft_finalize_tree(&cxt);
531
532 #ifdef CONFIG_OF_HAS_BD_T
533         /* paste the bd_t at the end of the flat tree */
534         end = (char *)blob +
535             be32_to_cpu(((struct boot_param_header *)blob)->totalsize);
536         memcpy(end, bd, sizeof(*bd));
537 #endif
538
539 #ifdef CONFIG_PPC
540
541 #ifdef CONFIG_OF_HAS_BD_T
542         for (i = 0; i < sizeof(bd_map)/sizeof(bd_map[0]); i++) {
543                 uint32_t v;
544
545                 sprintf(tmpenv, "/bd_t/%s", bd_map[i].name);
546                 v = *(uint32_t *)((char *)bd + bd_map[i].offset);
547
548                 p = ft_get_prop(blob, tmpenv, &len);
549                 if (p != NULL)
550                         *p = cpu_to_be32(v);
551         }
552
553         p = ft_get_prop(blob, "/bd_t/enetaddr", &len);
554         if (p != NULL)
555                 memcpy(p, bd->bi_enetaddr, 6);
556
557         p = ft_get_prop(blob, "/bd_t/ethspeed", &len);
558         if (p != NULL)
559                 *p = cpu_to_be32((uint32_t) bd->bi_ethspeed);
560 #endif
561
562         clock = bd->bi_intfreq;
563         p = ft_get_prop(blob, "/cpus/" OF_CPU "/clock-frequency", &len);
564         if (p != NULL)
565                 *p = cpu_to_be32(clock);
566
567 #ifdef OF_TBCLK
568         clock = OF_TBCLK;
569         p = ft_get_prop(blob, "/cpus/" OF_CPU "/timebase-frequency", &len);
570         if (p != NULL)
571                 *p = cpu_to_be32(clock);
572 #endif
573 #endif                          /* __powerpc__ */
574
575 #ifdef CONFIG_OF_BOARD_SETUP
576         ft_board_setup(blob, bd);
577 #endif
578
579         /* in case the size changed in the platform code */
580         ft_finalize_tree(&cxt);
581
582 #ifdef DEBUG
583         printf("final OF-tree\n");
584         ft_dump_blob(blob);
585 #endif
586 }
587 #endif