forked from NetBSD/src
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathevboards.c
1964 lines (1760 loc) · 50.8 KB
/
evboards.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* $NetBSD: evboards.c,v 1.8 2022/11/01 19:51:46 andvar Exp $ */
/*-
* Copyright (c) 2019 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Jason R. Thorpe.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#if HAVE_NBTOOL_CONFIG_H
#include "nbtool_config.h"
#endif
#include <sys/cdefs.h>
#if !defined(__lint)
__RCSID("$NetBSD: evboards.c,v 1.8 2022/11/01 19:51:46 andvar Exp $");
#endif /* !__lint */
#include <sys/types.h>
#include <sys/param.h> /* for roundup() */
#include <sys/stat.h>
#include <assert.h>
#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <fts.h>
#include <inttypes.h>
#include <limits.h>
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#ifdef SUPPORT_FDT
#include "libfdt.h"
#endif
#if !HAVE_NBTOOL_CONFIG_H
#include <sys/utsname.h>
#ifdef SUPPORT_OPENFIRMWARE
#include <sys/ioctl.h>
#include <dev/ofw/openfirmio.h>
#endif
#endif /* ! HAVE_NBTOOL_CONFIG_H */
#include "installboot.h"
#include "evboards.h"
/*
* The board database is implemented as a property list. The base
* system provides a set of known boards, keyed by their "compatible"
* device tree property.
*
* The database provided by the base system is meant to help guide
* the user as to which u-boot package needs to be installed on the
* system in order to write the boot loader to the boot media. The
* base board plist is specific to the $MACHINE (e.g. "evbarm"), and
* is installed along with the build tools, e.g.:
*
* (native location)
* /usr/sbin/installboot
* /usr/share/installboot/evbarm/boards.plist
* /usr/share/installboot/evbmips/boards.plist
*
* (example cross host tool location)
* /usr/local/xnbsd/bin/nbinstallboot
* /usr/local/xnbsd/share/installboot/evbarm/boards.plist
* /usr/local/xnbsd/share/installboot/evbmips/boards.plist
*
* The schema of the base board plist is as follows:
*
* <plist>
* <dict>
* <!--
* -- Key: string matching a "compatible" DT property.
* -- Value: dictionary representing a board object.
* -- (required)
* -->
* <key>example,example-board</key>
* <dict>
* <!--
* -- Key: "description".
* -- Value: string containing the board description.
* -- (required)
* -->
* <key>description</key>
* <string>Example Co. Example Board</string>
*
* <!--
* -- Key: "u-boot-pkg".
* -- Value: string representing the board-specific
* -- portion of the u-boot package name.
* -- In this example, the package's full name
* -- is "u-boot-exampleboard". This is used
* -- to recommend to the user which u-boot
* -- package to install. If not present, then
* -- no package recommendation will be made.
* -- (optional)
* -->
* <key>u-boot-pkg</key>
* <string>exampleboard</string>
* </dict>
* </dict>
* </plist>
*
* Individual u-boot packages install their own overlay property list
* files that installboot(8) then scans for. These overlay files are
* named "installboot.plist", and are installed alongside the u-boot
* binaries by the individual u-boot packages, for example:
*
* /usr/pkg/share/u-boot/exampleboard/installboot.plist
* /usr/pkg/share/u-boot/exampleboard/u-boot-with-spl.bin
*
* installboot(8) scans a set of directories looking for "installboot.plist"
* overlay files one directory deep. For example:
*
* /usr/pkg/share/u-boot/
* exampleboard/installboot.plist
* superarmdeluxe/installboot.plist
* dummy/
*
* In this example, "/usr/pkg/share/u-boot" is scanned, it would identify
* "exampleboard" and "superarmdeluxe" as directories containing overlays
* and load them.
*
* The default path scanned for u-boot packages is:
*
* /usr/pkg/share/u-boot
*
* This can be overridden with either the INSTALLBOOT_UBOOT_PATHS
* environment variable or the command line option -u, which contains
* a colon-separated list of directories, e.g.:
*
* /usr/pkg/share/u-boot:/home/jmcneill/hackityhack/u-boot
*
* The scan only consults the top-level children of the specified directory.
*
* Each overlay includes complete board objects that entirely replace
* the system-provided board objects in memory. Some of the keys in
* overlay board objects are computed at run-time and should not appear
* in the plists loaded from the file system.
*
* The schema of the overlay board plists are as follows:
*
* <plist>
* <dict>
* <!--
* -- Key: string matching a "compatible" DT property.
* -- Value: dictionary representing a board object.
* -- (required)
* -->
* <key>example,example-board</key>
* <dict>
* <!--
* -- Key: "description".
* -- Value: string containing the board description.
* -- (required)
* -->
* <key>description</key>
* <string>Example Co. Example Board</string>
*
* <!--
* -- Key: "u-boot-install".
* -- (and variants; see discussion below)
* -- "u-boot-install-emmc", etc.).
* -- Value: Array of u-boot installation step objects,
* -- as described below.
* -- (required)
* --
* -- At least one of these objects is required. If the
* -- board uses a single set of steps for all boot media
* -- types, then it should provide just "u-boot-install".
* -- Otherwise, it would provide one or more objects
* -- with names reflecting the media type, e.g.:
* --
* -- "u-boot-install-sdmmc" (for SD cards)
* -- "u-boot-install-emmc" (for eMMC modules)
* -- "u-boot-install-usb" (for USB block storage)
* -- "u-boot-install-spi" (for SPI NOR flash)
* --
* -- These installation steps will be selectable using
* -- the "media=..." option to installboot(8).
* -->
* <key>u-boot-install</key>
* <array>
* <!-- see installation object discussion below. -->
* </array>
*
* <!--
* -- Key: "runtime-u-boot-path"
* -- Value: A string representing the path to the u-boot
* -- binary files needed to install the boot loader.
* -- This value is computed at run-time and is the
* -- same directory in which the installboot.plist
* -- file for that u-boot package is located.
* -- This key/value pair should never be included
* -- in an installboot.plist file, and including it
* -- will cause the overlay to be rejected.
* -- (computed at run-time)
* -->
* <key>runtime-u-boot-path</key>
* <string>/usr/pkg/share/u-boot/exampleboard</string>
* </dict>
* </dict>
* </plist>
*
* The installation objects provide a description of the steps needed
* to install u-boot on the boot media. Each installation object it
* itself an array of step object.
*
* A basic installation object has a single step that instructs
* installboot(8) to write a file to a specific offset onto the
* boot media.
*
* <key>u-boot-install</key>
* <!-- installation object -->
* <array>
* <!-- step object -->
* <dict>
* <!--
* -- Key: "file-name".
* -- Value: a string naming the file to be
* -- written to the media.
* -- (required)
* -->
* <key>file-name</key>
* <string>u-boot-with-spl.bin</string>
*
* <!--
* -- Key: "image-offset".
* -- Value: an integer specifying the offset
* -- into the output image or device
* -- where to write the file. Defaults
* -- to 0 if not specified.
* -- (optional)
* -->
* <key>image-offset</key>
* <integer>8192</integer>
* </dict>
* </array>
*
* Some installations require multiple steps with special handling.
*
* <key>u-boot-install</key>
* <array>
* <--
* -- Step 1: Write the initial portion of the boot
* -- loader onto the media. The loader has a "hole"
* -- to leave room for the MBR partition table. Take
* -- care not to scribble over the table.
* -->
* <dict>
* <key>file-name</key>
* <string>u-boot-img.bin</string>
*
* <!--
* -- Key: "file-size".
* -- Value: an integer specifying the amount of
* -- data from the file to be written to the
* -- output. Defaults to "to end of file" if
* -- not specified.
* -- (optional)
* -->
* <!-- Stop short of the MBR partition table. -->
* <key>file-size</key>
* <integer>442</integer>
*
* <!--
* -- Key: "preserve".
* -- Value: a boolean indicating that any partial
* -- output block should preserve any pre-
* -- existing contents of that block for
* -- the portion of the of the block not
* -- overwritten by the input file.
* -- (read-modify-write)
* -- (optional)
* -->
* <!-- Preserve the MBR partition table. -->
* <key>preserve</key>
* <true/>
* </dict>
* <--
* -- Step 2: Write the rest of the loader after the
* -- MBR partition table.
* -->
* <dict>
* <key>file-name</key>
* <string>u-boot-img.bin</string>
*
* <!--
* -- Key: "file-offset".
* -- Value: an integer specifying the offset into
* -- the input file from where to start
* -- copying to the output.
* -- (optional)
* -->
* <key>file-offset</key>
* <integer>512</integer>
*
* <!-- ...just after the MBR partition table. -->
* <key>image-offset</key>
* <integer>512</integer>
* </dict>
* </array>
*
* There are some additional directives for installing on raw flash devices:
*
* <key>u-boot-install-spi</key>
* <array>
* <!-- This board's SPI NOR flash is 16Mbit (2MB) in size,
* -- arranged as 32 512Kbit (64KB) blocks.
* <dict>
* <key>file-name</key>
* <string>u-boot-with-spl.bin</string>
*
* <!-- Key: "input-block-size".
* -- Value: an integer specifying how much file
* -- data to read per input block before
* -- padding. Must be used in conjunction
* -- with "input-pad-size".
* -- (optional)
* -->
* <key>input-block-size</key>
* <integer>2048</integer>
*
* <!-- Key: "input-pad-size".
* -- Value: an integer specifying the amount of
* -- zero padding inserted per input block.
* -- Must be used in conjunction with
* -- "input-block-size".
* -- (optional)
* -->
* <key>input-pad-size</key>
* <integer>2048</integer>
*
* <!-- Key: "output-size".
* -- Value: an integer specifying the total
* -- size to be written to the output
* -- device. This is used when writing
* -- a bootloader to a raw flash memory
* -- device such as a SPI NOR flash.
* -- The boot loader MUST fit within
* -- this size and the output will be
* -- padded to this size with zeros.
* --
* -- If the "output-block-size" key (below)
* -- is also specified, then this value
* -- must be a multiple of the output block
* -- size.
* -- (optional)
* -->
* <key>output-size</key>
* <integer>2097152</integer>
*
* <-- Key: "output-block-size"
* -- Value: an integer specifying the size of
* -- the blocks used to write to the
* -- output device. If the output device
* -- simulates a disk block storage device,
* -- then this value must be a multiple of
* -- the reported sector size.
* -- (optional)
* -->
* <key>output-block-size</key>
* <integer>65536</integer>
* </dict>
* </array>
*
* For boards that require a media specification to be provided, it
* may be the case that two media types have identical steps. It
* could be confusing for users to see a list of media types that does
* not include the media type on which they are installing, so there
* is an alias capability:
*
* <key>u-boot-install-spi</key>
* <array>
* .
* .
* .
* </array>
* <key>u-boot-install-sdmmc</key>
* <array>
* .
* .
* .
* </array>
* <-- Steps for eMMC are identical to SDMMC on this board. -->
* <key>u-boot-install-emmc</key>
* <string>u-boot-install-sdmmc</string>
*/
/*
* make_path --
* Build a path into the given buffer with the specified
* format. Returns NULL if the path won't fit.
*/
static __printflike(3,4) const char *
make_path(char *buf, size_t bufsize, const char *fmt, ...)
{
va_list ap;
int ret;
va_start(ap, fmt);
ret = vsnprintf(buf, bufsize, fmt, ap);
va_end(ap);
if (ret < 0 || (size_t)ret >= bufsize)
return NULL;
return buf;
}
#ifndef EVBOARDS_PLIST_BASE
#define EVBOARDS_PLIST_BASE "/usr"
#endif
static const char evb_db_base_location[] =
EVBOARDS_PLIST_BASE "/share/installboot";
/*
* evb_db_base_path --
* Returns the path to the base board db file.
*/
static const char *
evb_db_base_path(ib_params *params, char *buf, size_t bufsize)
{
return make_path(buf, bufsize, "%s/%s/boards.plist",
evb_db_base_location, params->machine->name);
}
/*
* evb_uboot_pkg_paths --
* Returns an array of u-boot package paths to scan for
* installboot.plist files.
*
* Number of array elements, not including the NULL terminator,
* is returned in *countp.
*
* The working buffer is returned in *bufp so that the caller
* can free it.
*/
static char **
evb_uboot_pkg_paths(ib_params *params, int *countp, void **bufp)
{
char **ret_array = NULL;
char *buf = NULL;
const char *pathspec;
int i, count;
char *cp, *startcp;
pathspec = params->uboot_paths;
assert(pathspec != NULL);
if (strlen(pathspec) == 0)
goto out;
/* Count the path elements. */
for (cp = __UNCONST(pathspec), count = 0;;) {
count++;
cp = strchr(cp, ':');
if (cp == NULL)
break;
cp++;
}
buf = malloc((sizeof(char *) * (count + 1)) +
strlen(pathspec) + 1);
if (buf == NULL)
goto out;
/*
* Because we want to follow the usual "paths are listed in priority
* order" semantics, we reverse the order of the paths when we put
* them into the array we feed to fts. This is because we always
* overwrite existing entries as we find them, thus the last board
* object found one a given key is the one that will be used.
*/
ret_array = (char **)buf;
startcp = buf + (sizeof(char *) * (count + 1));
/* this is a safe strcpy(); don't replace it. */
strcpy(startcp, pathspec);
cp = strrchr(startcp, ':');
if (cp == NULL)
cp = startcp;
for (i = 0;;) {
if (*cp == ':') {
ret_array[i++] = cp+1;
*cp-- = '\0';
} else
ret_array[i++] = cp;
if (cp == startcp)
break;
cp = strrchr(cp, ':');
if (cp == NULL)
cp = startcp;
}
assert(i == count);
ret_array[i] = NULL;
out:
if (ret_array == NULL) {
if (buf != NULL)
free(buf);
} else {
if (countp != NULL)
*countp = count;
if (bufp != NULL)
*bufp = buf;
}
return ret_array;
}
static const char step_file_name_key[] = "file-name";
static const char step_file_offset_key[] = "file-offset";
static const char step_file_size_key[] = "file-size";
static const char step_image_offset_key[] = "image-offset";
static const char step_input_block_size_key[] = "input-block-size";
static const char step_input_pad_size_key[] = "input-pad-size";
static const char step_output_size_key[] = "output-size";
static const char step_output_block_size_key[] = "output-block-size";
static const char step_preserve_key[] = "preserve";
static bool
validate_ubstep_object(evb_ubstep obj)
{
/*
* evb_ubstep is a dictionary with the following keys:
*
* "file-name" (string) (required)
* "file-offset" (number) (optional)
* "file-size" (number) (optional)
* "image-offset" (number) (optional)
* "input-block-size" (number) (optional)
* "input-pad-size" (number) (optional)
* "output-size" (number) (optional)
* "output-block-size" (number) (optional)
* "preserve" (bool) (optional)
*/
if (prop_object_type(obj) != PROP_TYPE_DICTIONARY)
return false;
prop_object_t v;
v = prop_dictionary_get(obj, step_file_name_key);
if (v == NULL ||
prop_object_type(v) != PROP_TYPE_STRING)
return false;
v = prop_dictionary_get(obj, step_file_offset_key);
if (v != NULL &&
prop_object_type(v) != PROP_TYPE_NUMBER)
return false;
v = prop_dictionary_get(obj, step_file_size_key);
if (v != NULL &&
prop_object_type(v) != PROP_TYPE_NUMBER)
return false;
v = prop_dictionary_get(obj, step_image_offset_key);
if (v != NULL &&
prop_object_type(v) != PROP_TYPE_NUMBER)
return false;
bool have_input_block_size = false;
bool have_input_pad_size = false;
v = prop_dictionary_get(obj, step_input_block_size_key);
if (v != NULL) {
have_input_block_size = true;
if (prop_object_type(v) != PROP_TYPE_NUMBER)
return false;
}
v = prop_dictionary_get(obj, step_input_pad_size_key);
if (v != NULL) {
have_input_pad_size = true;
if (prop_object_type(v) != PROP_TYPE_NUMBER)
return false;
}
/* Must have both or neither of input-{block,pad}-size. */
if (have_input_block_size ^ have_input_pad_size)
return false;
v = prop_dictionary_get(obj, step_output_size_key);
if (v != NULL &&
prop_object_type(v) != PROP_TYPE_NUMBER)
return false;
v = prop_dictionary_get(obj, step_output_block_size_key);
if (v != NULL &&
prop_object_type(v) != PROP_TYPE_NUMBER)
return false;
v = prop_dictionary_get(obj, step_preserve_key);
if (v != NULL &&
prop_object_type(v) != PROP_TYPE_BOOL)
return false;
return true;
}
static bool
validate_ubinstall_object(evb_board board, evb_ubinstall obj)
{
/*
* evb_ubinstall is either:
* -- an array with one or more evb_ubstep objects.
* -- a string representing an alias of another evb_ubinstall
* object
*
* (evb_ubsteps is just a convenience type for iterating
* over the steps.)
*/
if (prop_object_type(obj) == PROP_TYPE_STRING) {
evb_ubinstall tobj = prop_dictionary_get(board,
prop_string_value((prop_string_t)obj));
/*
* The target evb_ubinstall object must exist
* and must itself be a proper evb_ubinstall,
* not another alias.
*/
if (tobj == NULL ||
prop_object_type(tobj) != PROP_TYPE_ARRAY) {
return false;
}
return true;
}
if (prop_object_type(obj) != PROP_TYPE_ARRAY)
return false;
if (prop_array_count(obj) < 1)
return false;
prop_object_t v;
prop_object_iterator_t iter = prop_array_iterator(obj);
while ((v = prop_object_iterator_next(iter)) != NULL) {
if (!validate_ubstep_object(v))
break;
}
prop_object_iterator_release(iter);
return v == NULL;
}
static const char board_description_key[] = "description";
static const char board_u_boot_pkg_key[] = "u-boot-pkg";
static const char board_u_boot_path_key[] = "runtime-u-boot-path";
static const char board_u_boot_install_key[] = "u-boot-install";
static bool
validate_board_object(evb_board obj, bool is_overlay)
{
/*
* evb_board is a dictionary with the following keys:
*
* "description" (string) (required)
* "u-boot-pkg" (string) (optional, base only)
* "runtime-u-boot-path" (string) (required, overlay only)
*
* With special consideration for these keys:
*
* Either this key and no other "u-boot-install*" keys:
* "u-boot-install" (string) (required, overlay only)
*
* Or one or more keys of the following pattern:
* "u-boot-install-*" (string) (required, overlay only)
*/
bool has_default_install = false;
bool has_media_install = false;
if (prop_object_type(obj) != PROP_TYPE_DICTIONARY)
return false;
prop_object_t v;
v = prop_dictionary_get(obj, board_description_key);
if (v == NULL ||
prop_object_type(v) != PROP_TYPE_STRING)
return false;
v = prop_dictionary_get(obj, board_u_boot_pkg_key);
if (v != NULL &&
(is_overlay || prop_object_type(v) != PROP_TYPE_STRING))
return false;
/*
* "runtime-u-boot-path" is added to an overlay after we've
* validated the board object, so simply make sure it's not
* present.
*/
v = prop_dictionary_get(obj, board_u_boot_path_key);
if (v != NULL)
return false;
prop_object_iterator_t iter = prop_dictionary_iterator(obj);
prop_dictionary_keysym_t key;
while ((key = prop_object_iterator_next(iter)) != NULL) {
const char *cp = prop_dictionary_keysym_value(key);
if (strcmp(cp, board_u_boot_install_key) == 0) {
has_default_install = true;
} else if (strncmp(cp, board_u_boot_install_key,
sizeof(board_u_boot_install_key) - 1) == 0 &&
cp[sizeof(board_u_boot_install_key) - 1] == '-') {
has_media_install = true;
} else {
continue;
}
v = prop_dictionary_get_keysym(obj, key);
assert(v != NULL);
if (!is_overlay || !validate_ubinstall_object(obj, v))
break;
}
prop_object_iterator_release(iter);
if (key != NULL)
return false;
/*
* Overlays must have only a default install key OR one or more
* media install keys.
*/
if (is_overlay)
return has_default_install ^ has_media_install;
/*
* Base board objects must have neither.
*/
return (has_default_install | has_media_install) == false;
}
/*
* evb_db_load_overlay --
* Load boards from an overlay file into the db.
*/
static void
evb_db_load_overlay(ib_params *params, const char *path,
const char *runtime_uboot_path)
{
prop_dictionary_t overlay;
struct stat sb;
if (params->flags & IB_VERBOSE)
printf("Loading '%s'.\n", path);
if (stat(path, &sb) < 0) {
warn("'%s'", path);
return;
} else {
overlay = prop_dictionary_internalize_from_file(path);
if (overlay == NULL) {
warnx("unable to parse overlay '%s'", path);
return;
}
}
/*
* Validate all of the board objects and add them to the board
* db, replacing any existing entries as we go.
*/
prop_object_iterator_t iter = prop_dictionary_iterator(overlay);
prop_dictionary_keysym_t key;
prop_dictionary_t board;
while ((key = prop_object_iterator_next(iter)) != NULL) {
board = prop_dictionary_get_keysym(overlay, key);
assert(board != NULL);
if (!validate_board_object(board, true)) {
warnx("invalid board object in '%s': '%s'", path,
prop_dictionary_keysym_value(key));
continue;
}
/* Add "runtime-u-boot-path". */
prop_string_t string =
prop_string_create_copy(runtime_uboot_path);
assert(string != NULL);
prop_dictionary_set(board, board_u_boot_path_key, string);
prop_object_release(string);
/* Insert into board db. */
prop_dictionary_set_keysym(params->mach_data, key, board);
}
prop_object_iterator_release(iter);
prop_object_release(overlay);
}
/*
* evb_db_load_overlays --
* Load the overlays from the search path.
*/
static void
evb_db_load_overlays(ib_params *params)
{
char overlay_pathbuf[PATH_MAX+1];
const char *overlay_path;
char **paths;
void *pathsbuf = NULL;
FTS *fts;
FTSENT *chp, *p;
struct stat sb;
paths = evb_uboot_pkg_paths(params, NULL, &pathsbuf);
if (paths == NULL) {
warnx("No u-boot search path?");
return;
}
fts = fts_open(paths, FTS_COMFOLLOW | FTS_LOGICAL | FTS_NOCHDIR, NULL);
if (fts == NULL ||
(chp = fts_children(fts, 0)) == NULL) {
warn("Unable to search u-boot path");
if (fts != NULL)
fts_close(fts);
return;
}
chp = fts_children(fts, 0);
while ((p = fts_read(fts)) != NULL) {
if (p->fts_info != FTS_D)
continue;
overlay_path = make_path(overlay_pathbuf,
sizeof(overlay_pathbuf), "%s/installboot.plist",
p->fts_path);
if (overlay_path == NULL)
continue;
if (stat(overlay_path, &sb) < 0)
continue;
evb_db_load_overlay(params, overlay_path, p->fts_path);
}
fts_close(fts);
/*
* If the user specified a stage1 loader, then consult it last
* for a possible u-boot package location.
*/
if (params->stage1 != NULL) {
overlay_path = make_path(overlay_pathbuf,
sizeof(overlay_pathbuf), "%s/installboot.plist",
params->stage1);
if (overlay_path != NULL) {
if (stat(overlay_path, &sb) == 0) {
evb_db_load_overlay(params, overlay_path,
params->stage1);
}
}
}
}
/*
* evb_db_load_base --
* Load the base board db.
*/
static bool
evb_db_load_base(ib_params *params)
{
char buf[PATH_MAX+1];
const char *path;
prop_dictionary_t board_db;
struct stat sb;
path = evb_db_base_path(params, buf, sizeof(buf));
if (path == NULL)
return false;
if (params->flags & IB_VERBOSE)
printf("Loading '%s'.\n", path);
if (stat(path, &sb) < 0) {
if (errno != ENOENT) {
warn("'%s'", path);
return false;
}
board_db = prop_dictionary_create();
assert(board_db != NULL);
} else {
board_db = prop_dictionary_internalize_from_file(path);
if (board_db == NULL) {
warnx("unable to parse board db '%s'", path);
return false;
}
}
if (prop_dictionary_count(board_db) == 0) {
/*
* Oh well, maybe we'll load some overlays.
*/
goto done;
}
/*
* Validate all of the board objects and remove any bad ones.
*/
prop_array_t all_board_keys = prop_dictionary_all_keys(board_db);
prop_object_iterator_t iter = prop_array_iterator(all_board_keys);
prop_dictionary_keysym_t key;
prop_dictionary_t board;
while ((key = prop_object_iterator_next(iter)) != NULL) {
board = prop_dictionary_get_keysym(board_db, key);
assert(board != NULL);
if (!validate_board_object(board, false)) {
warnx("invalid board object in '%s': '%s'", path,
prop_dictionary_keysym_value(key));
prop_dictionary_remove_keysym(board_db, key);
}
}
prop_object_iterator_release(iter);
prop_object_release(all_board_keys);
done:
params->mach_data = board_db;
return true;
}
/*
* evb_db_load --
* Load the board database.
*/
bool
evb_db_load(ib_params *params)
{
if (!evb_db_load_base(params))
return false;
evb_db_load_overlays(params);
return true;
}
#if !HAVE_NBTOOL_CONFIG_H
/*
* Native board name guessing methods.
*/
#ifdef SUPPORT_OPENFIRMWARE
static int
ofw_fd(void)
{
static const char openfirm_path[] = "/dev/openfirm";
return open(openfirm_path, O_RDONLY);
}
static int
OF_finddevice(const char *name)
{
struct ofiocdesc ofio = {
.of_name = __UNCONST(name),
.of_namelen = strlen(name),
};
int fd = ofw_fd();
if (fd == -1)
return -1;
if (ioctl(fd, OFIOCFINDDEVICE, &ofio) < 0) {
if (errno != ENOENT)
warn("OFIOCFINDDEVICE('%s')", name);
ofio.of_nodeid = -1;
}
(void) close(fd);
return ofio.of_nodeid;
}
static int
OF_getprop(int phandle, const char *prop, void *buf, size_t buflen)
{
struct ofiocdesc ofio = {