1 /*****************************************************************************\
3 *****************************************************************************
4 * Copyright (C) 2002-2005 The Regents of the University of California.
5 * Produced at the Lawrence Livermore National Laboratory.
6 * Written by Dave Peterson <dsp@llnl.gov> <dave_peterson@pobox.com>
7 * and Stefan Reinauer <stepan@openbios.org>.
11 * This file is part of nvramtool, a utility for reading/writing coreboot
12 * parameters and displaying information from the coreboot table.
13 * For details, see http://coreboot.org/nvramtool.
15 * Please also read the file DISCLAIMER which is included in this software
18 * This program is free software; you can redistribute it and/or modify it
19 * under the terms of the GNU General Public License (as published by the
20 * Free Software Foundation) version 2, dated June 1991.
22 * This program is distributed in the hope that it will be useful, but
23 * WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY OF
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the terms and
25 * conditions of the GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License along
28 * with this program; if not, write to the Free Software Foundation, Inc.,
29 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
30 \*****************************************************************************/
35 #include "coreboot_tables.h"
36 #include "ip_checksum.h"
39 #include "cmos_lowlevel.h"
42 typedef void (*lbtable_print_fn_t) (const struct lb_record * rec);
44 /* This structure represents an item in the coreboot table that may be
45 * displayed using the -l option.
50 const char *description;
51 const char *nofound_msg;
52 lbtable_print_fn_t print_fn;
56 unsigned long start; /* address of first byte of memory range */
57 unsigned long end; /* address of last byte of memory range */
60 static const struct lb_header *lbtable_scan(unsigned long start,
62 int *bad_header_count,
63 int *bad_table_count);
64 static void process_cmos_table(void);
65 static void get_cmos_checksum_info(void);
66 static void try_convert_checksum_layout(cmos_checksum_layout_t * layout);
67 static void try_add_cmos_table_enum(cmos_enum_t * cmos_enum);
68 static void try_add_cmos_table_entry(cmos_entry_t * cmos_entry);
69 static const struct lb_record *find_lbrec(uint32_t tag);
70 static const char *lbrec_tag_to_str(uint32_t tag);
71 static const struct cmos_entries *first_cmos_table_entry(void);
72 static const struct cmos_entries *next_cmos_table_entry(const struct
74 static const struct cmos_enums *first_cmos_table_enum(void);
75 static const struct cmos_enums *next_cmos_table_enum
76 (const struct cmos_enums *last);
77 static const struct lb_record *first_cmos_rec(uint32_t tag);
78 static const struct lb_record *next_cmos_rec(const struct lb_record *last,
80 static void memory_print_fn(const struct lb_record *rec);
81 static void mainboard_print_fn(const struct lb_record *rec);
82 static void cmos_opt_table_print_fn(const struct lb_record *rec);
83 static void print_option_record(const struct cmos_entries *cmos_entry);
84 static void print_enum_record(const struct cmos_enums *cmos_enum);
85 static void print_defaults_record(const struct cmos_defaults *cmos_defaults);
86 static void print_unknown_record(const struct lb_record *cmos_item);
87 static void option_checksum_print_fn(const struct lb_record *rec);
88 static void string_print_fn(const struct lb_record *rec);
89 static void uint64_to_hex_string(char str[], uint64_t n);
91 static const char memory_desc[] =
92 " This shows information about system memory.\n";
94 static const char mainboard_desc[] =
95 " This shows information about your mainboard.\n";
97 static const char version_desc[] =
98 " This shows coreboot version information.\n";
100 static const char extra_version_desc[] =
101 " This shows extra coreboot version information.\n";
103 static const char build_desc[] = " This shows coreboot build information.\n";
105 static const char compile_time_desc[] =
106 " This shows when coreboot was compiled.\n";
108 static const char compile_by_desc[] = " This shows who compiled coreboot.\n";
110 static const char compile_host_desc[] =
111 " This shows the name of the machine that compiled coreboot.\n";
113 static const char compile_domain_desc[] =
114 " This shows the domain name of the machine that compiled coreboot.\n";
116 static const char compiler_desc[] =
117 " This shows the name of the compiler used to build coreboot.\n";
119 static const char linker_desc[] =
120 " This shows the name of the linker used to build coreboot.\n";
122 static const char assembler_desc[] =
123 " This shows the name of the assembler used to build coreboot.\n";
125 static const char cmos_opt_table_desc[] =
126 " This does a low-level dump of the CMOS option table. The table "
128 " information about the layout of the values that coreboot stores in\n"
129 " nonvolatile RAM.\n";
131 static const char option_checksum_desc[] =
132 " This shows the location of the CMOS checksum and the area over which it "
133 "is\n" " calculated.\n";
135 static const char generic_nofound_msg[] =
136 "%s: Item %s not found in coreboot table.\n";
138 static const char nofound_msg_cmos_opt_table[] =
139 "%s: Item %s not found in coreboot table. Apparently, the "
140 "coreboot installed on this system was built without specifying "
141 "CONFIG_HAVE_OPTION_TABLE.\n";
143 static const char nofound_msg_option_checksum[] =
144 "%s: Item %s not found in coreboot table. Apparently, you are "
145 "using coreboot v1.\n";
149 /* This is the number of items from the coreboot table that may be displayed
150 * using the -l option.
152 #define NUM_LBTABLE_CHOICES 14
154 /* These represent the various items from the coreboot table that may be
155 * displayed using the -l option.
157 static const lbtable_choice_t lbtable_choices[NUM_LBTABLE_CHOICES] =
158 { {LB_TAG_MEMORY, "memory",
159 memory_desc, generic_nofound_msg,
161 {LB_TAG_MAINBOARD, "mainboard",
162 mainboard_desc, generic_nofound_msg,
164 {LB_TAG_VERSION, "version",
165 version_desc, generic_nofound_msg,
167 {LB_TAG_EXTRA_VERSION, "extra_version",
168 extra_version_desc, generic_nofound_msg,
170 {LB_TAG_BUILD, "build",
171 build_desc, generic_nofound_msg,
173 {LB_TAG_COMPILE_TIME, "compile_time",
174 compile_time_desc, generic_nofound_msg,
176 {LB_TAG_COMPILE_BY, "compile_by",
177 compile_by_desc, generic_nofound_msg,
179 {LB_TAG_COMPILE_HOST, "compile_host",
180 compile_host_desc, generic_nofound_msg,
182 {LB_TAG_COMPILE_DOMAIN, "compile_domain",
183 compile_domain_desc, generic_nofound_msg,
185 {LB_TAG_COMPILER, "compiler",
186 compiler_desc, generic_nofound_msg,
188 {LB_TAG_LINKER, "linker",
189 linker_desc, generic_nofound_msg,
191 {LB_TAG_ASSEMBLER, "assembler",
192 assembler_desc, generic_nofound_msg,
194 {LB_TAG_CMOS_OPTION_TABLE, "cmos_opt_table",
195 cmos_opt_table_desc, nofound_msg_cmos_opt_table,
196 cmos_opt_table_print_fn},
197 {LB_TAG_OPTION_CHECKSUM, "option_checksum",
198 option_checksum_desc, nofound_msg_option_checksum,
199 option_checksum_print_fn}
202 /* The coreboot table resides in low physical memory, which we access using
203 * /dev/mem. These are ranges of physical memory that should be scanned for a
207 #define NUM_MEM_RANGES 2
209 static const mem_range_t mem_ranges[NUM_MEM_RANGES] =
210 { {0x00000000, 0x00000fff},
211 {0x000f0000, 0x000fffff}
214 /* This is the number of bytes of physical memory to map, starting at physical
215 * address 0. This value must be large enough to contain all memory ranges
216 * specified in mem_ranges above plus the maximum possible size of the
217 * coreboot table (since the start of the table could potentially occur at
218 * the end of the last memory range).
220 static const size_t BYTES_TO_MAP = (1024 * 1024);
222 /* Pointer to low physical memory that we access by calling mmap() on
225 static const void *low_phys_mem;
226 static unsigned long low_phys_base = 0;
228 /* Pointer to coreboot table. */
229 static const struct lb_header *lbtable = NULL;
231 /* The CMOS option table is located within the coreboot table. It tells us
232 * where the CMOS parameters are located in the nonvolatile RAM.
234 static const struct cmos_option_table *cmos_table = NULL;
236 static const hexdump_format_t format =
237 { 12, 4, " ", " | ", " ", " | ", '.' };
239 /****************************************************************************
242 * Convert a virtual address to a physical address. 'vaddr' is a virtual
243 * address in the address space of the current process. It points to
244 * somewhere in the chunk of memory that we mapped by calling mmap() on
245 * /dev/mem. This macro converts 'vaddr' to a physical address.
246 ****************************************************************************/
247 #define vtophys(vaddr) (((unsigned long) vaddr) - \
248 ((unsigned long) low_phys_mem) + low_phys_base)
250 /****************************************************************************
253 * Convert a physical address to a virtual address. 'paddr' is a physical
254 * address. This macro converts 'paddr' to a virtual address in the address
255 * space of the current process. The virtual to physical mapping was set up
256 * by calling mmap() on /dev/mem.
257 ****************************************************************************/
258 #define phystov(paddr) (((unsigned long) low_phys_mem) + \
259 ((unsigned long) paddr) - low_phys_base)
261 /****************************************************************************
264 * Find the coreboot table and set global variable lbtable to point to it.
265 ****************************************************************************/
266 void get_lbtable(void)
268 int i, bad_header_count, bad_table_count, bad_headers, bad_tables;
273 /* The coreboot table is located in low physical memory, which may be
274 * conveniently accessed by calling mmap() on /dev/mem.
277 if ((fd = open("/dev/mem", O_RDONLY, 0)) < 0) {
278 fprintf(stderr, "%s: Can not open /dev/mem for reading: %s\n",
279 prog_name, strerror(errno));
284 mmap(NULL, BYTES_TO_MAP, PROT_READ, MAP_SHARED, fd, 0))
286 fprintf(stderr, "%s: Failed to mmap /dev/mem: %s\n", prog_name,
291 bad_header_count = 0;
294 for (i = 0; i < NUM_MEM_RANGES; i++) {
295 lbtable = lbtable_scan(phystov(mem_ranges[i].start),
296 phystov(mem_ranges[i].end),
297 &bad_headers, &bad_tables);
300 return; /* success: we found it! */
302 bad_header_count += bad_headers;
303 bad_table_count += bad_tables;
307 "%s: coreboot table not found. coreboot does not appear to\n"
308 " be installed on this system. Scanning for the table "
310 " following results:\n\n"
311 " %d valid signatures were found with bad header "
313 " %d valid headers were found with bad table "
314 "checksums.\n", prog_name, bad_header_count, bad_table_count);
318 /****************************************************************************
319 * get_layout_from_cmos_table
321 * Find the CMOS table which is stored within the coreboot table and set the
322 * global variable cmos_table to point to it.
323 ****************************************************************************/
324 void get_layout_from_cmos_table(void)
328 cmos_table = (const struct cmos_option_table *)
329 find_lbrec(LB_TAG_CMOS_OPTION_TABLE);
331 if ((cmos_table) == NULL) {
333 "%s: CMOS option table not found in coreboot table. "
334 "Apparently, the coreboot installed on this system was "
335 "built without specifying CONFIG_HAVE_OPTION_TABLE.\n",
340 process_cmos_table();
341 get_cmos_checksum_info();
344 /****************************************************************************
347 * Do a low-level dump of the coreboot table.
348 ****************************************************************************/
349 void dump_lbtable(void)
351 const char *p, *data;
352 uint32_t bytes_processed;
353 const struct lb_record *lbrec;
355 p = ((const char *)lbtable) + lbtable->header_bytes;
356 printf("Coreboot table at physical address 0x%lx:\n"
357 " signature: 0x%x (ASCII: %c%c%c%c)\n"
358 " header_bytes: 0x%x (decimal: %d)\n"
359 " header_checksum: 0x%x (decimal: %d)\n"
360 " table_bytes: 0x%x (decimal: %d)\n"
361 " table_checksum: 0x%x (decimal: %d)\n"
362 " table_entries: 0x%x (decimal: %d)\n\n",
363 vtophys(lbtable), lbtable->signature32,
364 lbtable->signature[0], lbtable->signature[1],
365 lbtable->signature[2], lbtable->signature[3],
366 lbtable->header_bytes, lbtable->header_bytes,
367 lbtable->header_checksum, lbtable->header_checksum,
368 lbtable->table_bytes, lbtable->table_bytes,
369 lbtable->table_checksum, lbtable->table_checksum,
370 lbtable->table_entries, lbtable->table_entries);
372 if ((lbtable->table_bytes == 0) != (lbtable->table_entries == 0)) {
374 ("Inconsistent values for table_bytes and table_entries!!!\n"
375 "They should be either both 0 or both nonzero.\n");
379 if (lbtable->table_bytes == 0) {
380 printf("The coreboot table is empty!!!\n");
384 for (bytes_processed = 0;;) {
385 lbrec = (const struct lb_record *)&p[bytes_processed];
386 printf(" %s record at physical address 0x%lx:\n"
387 " tag: 0x%x (decimal: %d)\n"
388 " size: 0x%x (decimal: %d)\n"
390 lbrec_tag_to_str(lbrec->tag), vtophys(lbrec), lbrec->tag,
391 lbrec->tag, lbrec->size, lbrec->size);
393 data = ((const char *)lbrec) + sizeof(*lbrec);
394 hexdump(data, lbrec->size - sizeof(*lbrec), vtophys(data),
397 bytes_processed += lbrec->size;
399 if (bytes_processed >= lbtable->table_bytes)
406 /****************************************************************************
407 * list_lbtable_choices
409 * List names and informational blurbs for items from the coreboot table
410 * that may be displayed using the -l option.
411 ****************************************************************************/
412 void list_lbtable_choices(void)
418 lbtable_choices[i].name, lbtable_choices[i].description);
420 if (++i >= NUM_LBTABLE_CHOICES)
427 /****************************************************************************
430 * Show the coreboot table item specified by 'item'.
431 ****************************************************************************/
432 void list_lbtable_item(const char item[])
435 const struct lb_record *rec;
437 for (i = 0; i < NUM_LBTABLE_CHOICES; i++) {
438 if (strcmp(item, lbtable_choices[i].name) == 0)
442 if (i == NUM_LBTABLE_CHOICES) {
443 fprintf(stderr, "%s: Invalid coreboot table item %s.\n",
448 if ((rec = find_lbrec(lbtable_choices[i].tag)) == NULL) {
449 fprintf(stderr, lbtable_choices[i].nofound_msg, prog_name,
450 lbtable_choices[i].name);
454 lbtable_choices[i].print_fn(rec);
457 /****************************************************************************
460 * Scan the chunk of memory specified by 'start' and 'end' for a coreboot
461 * table. The first 4 bytes of the table are marked by the signature
462 * { 'L', 'B', 'I', 'O' }. 'start' and 'end' indicate the addresses of the
463 * first and last bytes of the chunk of memory to be scanned. For instance,
464 * values of 0x10000000 and 0x1000ffff for 'start' and 'end' specify a 64k
465 * chunk of memory starting at address 0x10000000. 'start' and 'end' are
466 * virtual addresses in the address space of the current process. They
467 * represent a chunk of memory obtained by calling mmap() on /dev/mem.
469 * If a coreboot table is found, return a pointer to it. Otherwise return
470 * NULL. On return, *bad_header_count and *bad_table_count are set as
474 * Indicates the number of times in which a valid signature was found
475 * but the header checksum was invalid.
478 * Indicates the number of times in which a header with a valid
479 * checksum was found but the table checksum was invalid.
480 ****************************************************************************/
481 static const struct lb_header *lbtable_scan(unsigned long start,
483 int *bad_header_count,
484 int *bad_table_count)
486 static const char signature[4] = { 'L', 'B', 'I', 'O' };
487 const struct lb_header *table;
488 const struct lb_forward *forward;
492 assert(end >= start);
493 memcpy(&sig, signature, sizeof(sig));
495 *bad_header_count = 0;
496 *bad_table_count = 0;
498 /* Look for signature. Table is aligned on 16-byte boundary. Therefore
499 * only check every fourth 32-bit memory word. As the loop is coded below,
500 * this function will behave in a reasonable manner for ALL possible values
501 * for 'start' and 'end': even weird boundary cases like 0x00000000 and
502 * 0xffffffff on a 32-bit architecture.
504 for (p = (const uint32_t *)start;
505 (((unsigned long)p) <= end) &&
506 ((end - (unsigned long)p) >= (sizeof(uint32_t) - 1)); p += 4) {
510 /* We found a valid signature. */
511 table = (const struct lb_header *)p;
513 /* validate header checksum */
514 if (compute_ip_checksum((void *)table, sizeof(*table))) {
515 (*bad_header_count)++;
519 /* validate table checksum */
520 if (table->table_checksum !=
521 compute_ip_checksum(((char *)table) + sizeof(*table),
522 table->table_bytes)) {
523 (*bad_table_count)++;
527 /* checksums are ok: we found it! */
528 /* But it may just be a forwarding table, so look if there's a forwarder */
530 forward = (struct lb_forward *)find_lbrec(LB_TAG_FORWARD);
534 uint64_t new_phys = forward->forward;
536 new_phys &= ~(getpagesize() - 1);
538 munmap((void *)low_phys_mem, BYTES_TO_MAP);
540 mmap(NULL, BYTES_TO_MAP, PROT_READ, MAP_SHARED, fd,
541 (off_t) new_phys)) == MAP_FAILED) {
543 "%s: Failed to mmap /dev/mem: %s\n",
544 prog_name, strerror(errno));
547 low_phys_base = new_phys;
549 lbtable_scan(phystov(low_phys_base),
550 phystov(low_phys_base + BYTES_TO_MAP),
551 bad_header_count, bad_table_count);
559 /****************************************************************************
562 * Extract layout information from the CMOS option table and store it in our
563 * internal repository.
564 ****************************************************************************/
565 static void process_cmos_table(void)
567 const struct cmos_enums *p;
568 const struct cmos_entries *q;
569 cmos_enum_t cmos_enum;
570 cmos_entry_t cmos_entry;
572 /* First add the enums. */
573 for (p = first_cmos_table_enum(); p != NULL;
574 p = next_cmos_table_enum(p)) {
575 cmos_enum.config_id = p->config_id;
576 cmos_enum.value = p->value;
577 strncpy(cmos_enum.text, (char *)p->text, CMOS_MAX_TEXT_LENGTH);
578 cmos_enum.text[CMOS_MAX_TEXT_LENGTH] = '\0';
579 try_add_cmos_table_enum(&cmos_enum);
582 /* Now add the entries. We must add the entries after the enums because
583 * the entries are sanity checked against the enums as they are added.
585 for (q = first_cmos_table_entry(); q != NULL;
586 q = next_cmos_table_entry(q)) {
587 cmos_entry.bit = q->bit;
588 cmos_entry.length = q->length;
592 cmos_entry.config = CMOS_ENTRY_ENUM;
596 cmos_entry.config = CMOS_ENTRY_HEX;
600 cmos_entry.config = CMOS_ENTRY_RESERVED;
604 cmos_entry.config = CMOS_ENTRY_STRING;
609 "%s: Entry in CMOS option table has unknown config "
610 "value.\n", prog_name);
614 cmos_entry.config_id = q->config_id;
615 strncpy(cmos_entry.name, (char *)q->name, CMOS_MAX_NAME_LENGTH);
616 cmos_entry.name[CMOS_MAX_NAME_LENGTH] = '\0';
617 try_add_cmos_table_entry(&cmos_entry);
621 /****************************************************************************
622 * get_cmos_checksum_info
624 * Get layout information for CMOS checksum.
625 ****************************************************************************/
626 static void get_cmos_checksum_info(void)
628 const cmos_entry_t *e;
629 struct cmos_checksum *checksum;
630 cmos_checksum_layout_t layout;
631 unsigned index, index2;
633 checksum = (struct cmos_checksum *)find_lbrec(LB_TAG_OPTION_CHECKSUM);
635 if (checksum == NULL) {
636 checksum = (struct cmos_checksum *)next_cmos_rec((const struct lb_record *)first_cmos_table_enum(), LB_TAG_OPTION_CHECKSUM);
639 if (checksum != NULL) { /* We are lucky. The coreboot table hints us to the checksum.
640 * We might have to check the type field here though.
642 layout.summed_area_start = checksum->range_start;
643 layout.summed_area_end = checksum->range_end;
644 layout.checksum_at = checksum->location;
645 try_convert_checksum_layout(&layout);
646 cmos_checksum_start = layout.summed_area_start;
647 cmos_checksum_end = layout.summed_area_end;
648 cmos_checksum_index = layout.checksum_at;
652 if ((e = find_cmos_entry(checksum_param_name)) == NULL)
655 /* If we get here, we are unlucky. The CMOS option table contains the
656 * location of the CMOS checksum. However, there is no information
657 * regarding which bytes of the CMOS area the checksum is computed over.
658 * Thus we have to hope our presets will be fine.
663 "%s: Error: CMOS checksum is not byte-aligned.\n",
669 index2 = index + 1; /* The CMOS checksum occupies 16 bits. */
671 if (verify_cmos_byte_index(index) || verify_cmos_byte_index(index2)) {
673 "%s: Error: CMOS checksum location out of range.\n",
678 if (((index >= cmos_checksum_start) && (index <= cmos_checksum_end)) ||
679 (((index2) >= cmos_checksum_start)
680 && ((index2) <= cmos_checksum_end))) {
682 "%s: Error: CMOS checksum overlaps checksummed area.\n",
687 cmos_checksum_index = index;
690 /****************************************************************************
691 * try_convert_checksum_layout
693 * Perform sanity checking on CMOS checksum layout information and attempt to
694 * convert information from bit positions to byte positions. Return OK on
695 * success or an error code on failure.
696 ****************************************************************************/
697 static void try_convert_checksum_layout(cmos_checksum_layout_t * layout)
699 switch (checksum_layout_to_bytes(layout)) {
703 case LAYOUT_SUMMED_AREA_START_NOT_ALIGNED:
705 "%s: CMOS checksummed area start is not byte-aligned.\n",
709 case LAYOUT_SUMMED_AREA_END_NOT_ALIGNED:
711 "%s: CMOS checksummed area end is not byte-aligned.\n",
715 case LAYOUT_CHECKSUM_LOCATION_NOT_ALIGNED:
717 "%s: CMOS checksum location is not byte-aligned.\n",
721 case LAYOUT_INVALID_SUMMED_AREA:
723 "%s: CMOS checksummed area end must be greater than "
724 "CMOS checksummed area start.\n", prog_name);
727 case LAYOUT_CHECKSUM_OVERLAPS_SUMMED_AREA:
729 "%s: CMOS checksum overlaps checksummed area.\n",
733 case LAYOUT_SUMMED_AREA_OUT_OF_RANGE:
735 "%s: CMOS checksummed area out of range.\n", prog_name);
738 case LAYOUT_CHECKSUM_LOCATION_OUT_OF_RANGE:
740 "%s: CMOS checksum location out of range.\n",
751 /****************************************************************************
752 * try_add_cmos_table_enum
754 * Attempt to add a CMOS enum to our internal repository. Exit with an error
755 * message on failure.
756 ****************************************************************************/
757 static void try_add_cmos_table_enum(cmos_enum_t * cmos_enum)
759 switch (add_cmos_enum(cmos_enum)) {
763 case LAYOUT_DUPLICATE_ENUM:
764 fprintf(stderr, "%s: Duplicate enum %s found in CMOS option "
765 "table.\n", prog_name, cmos_enum->text);
775 /****************************************************************************
776 * try_add_cmos_table_entry
778 * Attempt to add a CMOS entry to our internal repository. Exit with an
779 * error message on failure.
780 ****************************************************************************/
781 static void try_add_cmos_table_entry(cmos_entry_t * cmos_entry)
783 const cmos_entry_t *conflict;
785 switch (add_cmos_entry(cmos_entry, &conflict)) {
789 case CMOS_AREA_OUT_OF_RANGE:
791 "%s: Bad CMOS option layout in CMOS option table entry "
792 "%s.\n", prog_name, cmos_entry->name);
795 case CMOS_AREA_TOO_WIDE:
797 "%s: Area too wide for CMOS option table entry %s.\n",
798 prog_name, cmos_entry->name);
801 case LAYOUT_ENTRY_OVERLAP:
803 "%s: CMOS option table entries %s and %s have overlapping "
804 "layouts.\n", prog_name, cmos_entry->name,
808 case LAYOUT_ENTRY_BAD_LENGTH:
809 /* Silently ignore entries with zero length. Although this should
810 * never happen in practice, we should handle the case in a
811 * reasonable manner just to be safe.
822 /****************************************************************************
825 * Find the record in the coreboot table that matches 'tag'. Return pointer
826 * to record on success or NULL if record not found.
827 ****************************************************************************/
828 static const struct lb_record *find_lbrec(uint32_t tag)
831 uint32_t bytes_processed;
832 const struct lb_record *lbrec;
834 p = ((const char *)lbtable) + lbtable->header_bytes;
836 for (bytes_processed = 0;
837 bytes_processed < lbtable->table_bytes;
838 bytes_processed += lbrec->size) {
839 lbrec = (const struct lb_record *)&p[bytes_processed];
841 if (lbrec->tag == tag)
848 /****************************************************************************
851 * Return a pointer to the string representation of the given coreboot table
853 ****************************************************************************/
854 static const char *lbrec_tag_to_str(uint32_t tag)
866 case LB_TAG_MAINBOARD:
872 case LB_TAG_EXTRA_VERSION:
873 return "EXTRA_VERSION";
878 case LB_TAG_COMPILE_TIME:
879 return "COMPILE_TIME";
881 case LB_TAG_COMPILE_BY:
884 case LB_TAG_COMPILE_HOST:
885 return "COMPILE_HOST";
887 case LB_TAG_COMPILE_DOMAIN:
888 return "COMPILE_DOMAIN";
890 case LB_TAG_COMPILER:
896 case LB_TAG_ASSEMBLER:
908 case LB_TAG_CMOS_OPTION_TABLE:
909 return "CMOS_OPTION_TABLE";
911 case LB_TAG_OPTION_CHECKSUM:
912 return "OPTION_CHECKSUM";
921 /****************************************************************************
922 * first_cmos_table_entry
924 * Return a pointer to the first entry in the CMOS table that represents a
925 * CMOS parameter. Return NULL if CMOS table is empty.
926 ****************************************************************************/
927 static const struct cmos_entries *first_cmos_table_entry(void)
929 return (const struct cmos_entries *)first_cmos_rec(LB_TAG_OPTION);
932 /****************************************************************************
933 * next_cmos_table_entry
935 * Return a pointer to the next entry after 'last' in the CMOS table that
936 * represents a CMOS parameter. Return NULL if there are no more parameters.
937 ****************************************************************************/
938 static const struct cmos_entries *next_cmos_table_entry(const struct
941 return (const struct cmos_entries *)
942 next_cmos_rec((const struct lb_record *)last, LB_TAG_OPTION);
945 /****************************************************************************
946 * first_cmos_table_enum
948 * Return a pointer to the first entry in the CMOS table that represents a
949 * possible CMOS parameter value. Return NULL if the table does not contain
951 ****************************************************************************/
952 static const struct cmos_enums *first_cmos_table_enum(void)
954 return (const struct cmos_enums *)first_cmos_rec(LB_TAG_OPTION_ENUM);
957 /****************************************************************************
958 * next_cmos_table_enum
960 * Return a pointer to the next entry after 'last' in the CMOS table that
961 * represents a possible CMOS parameter value. Return NULL if there are no
962 * more parameter values.
963 ****************************************************************************/
964 static const struct cmos_enums *next_cmos_table_enum
965 (const struct cmos_enums *last) {
966 return (const struct cmos_enums *)
967 next_cmos_rec((const struct lb_record *)last, LB_TAG_OPTION_ENUM);
970 /****************************************************************************
973 * Return a pointer to the first entry in the CMOS table whose type matches
974 * 'tag'. Return NULL if CMOS table contains no such entry.
976 * Possible values for 'tag' are as follows:
978 * LB_TAG_OPTION: The entry represents a CMOS parameter.
979 * LB_TAG_OPTION_ENUM: The entry represents a possible value for a CMOS
980 * parameter of type 'enum'.
982 * The CMOS table tells us where in the nonvolatile RAM to look for CMOS
983 * parameter values and specifies their types as 'enum', 'hex', or
985 ****************************************************************************/
986 static const struct lb_record *first_cmos_rec(uint32_t tag)
989 uint32_t bytes_processed, bytes_for_entries;
990 const struct lb_record *lbrec;
992 p = ((const char *)cmos_table) + cmos_table->header_length;
993 bytes_for_entries = cmos_table->size - cmos_table->header_length;
995 for (bytes_processed = 0;
996 bytes_processed < bytes_for_entries;
997 bytes_processed += lbrec->size) {
998 lbrec = (const struct lb_record *)&p[bytes_processed];
1000 if (lbrec->tag == tag)
1007 /****************************************************************************
1010 * Return a pointer to the next entry after 'last' in the CMOS table whose
1011 * type matches 'tag'. Return NULL if the table contains no more entries of
1013 ****************************************************************************/
1014 static const struct lb_record *next_cmos_rec(const struct lb_record *last,
1018 uint32_t bytes_processed, bytes_for_entries, last_offset;
1019 const struct lb_record *lbrec;
1021 p = ((const char *)cmos_table) + cmos_table->header_length;
1022 bytes_for_entries = cmos_table->size - cmos_table->header_length;
1023 last_offset = ((const char *)last) - p;
1025 for (bytes_processed = last_offset + last->size;
1026 bytes_processed < bytes_for_entries;
1027 bytes_processed += lbrec->size) {
1028 lbrec = (const struct lb_record *)&p[bytes_processed];
1030 if (lbrec->tag == tag)
1037 /****************************************************************************
1040 * Display function for 'memory' item of coreboot table.
1041 ****************************************************************************/
1042 static void memory_print_fn(const struct lb_record *rec)
1044 char start_str[19], end_str[19], size_str[19];
1045 const struct lb_memory *p;
1046 const char *mem_type;
1047 const struct lb_memory_range *ranges;
1048 uint64_t size, start, end;
1051 p = (const struct lb_memory *)rec;
1052 entries = (p->size - sizeof(*p)) / sizeof(p->map[0]);
1056 printf("No memory ranges were found.\n");
1061 switch (ranges[i].type) {
1063 mem_type = "AVAILABLE";
1066 case LB_MEM_RESERVED:
1067 mem_type = "RESERVED";
1071 mem_type = "CONFIG_TABLE";
1075 mem_type = "UNKNOWN";
1079 size = unpack_lb64(ranges[i].size);
1080 start = unpack_lb64(ranges[i].start);
1081 end = start + size - 1;
1082 uint64_to_hex_string(start_str, start);
1083 uint64_to_hex_string(end_str, end);
1084 uint64_to_hex_string(size_str, size);
1085 printf("%s memory:\n"
1086 " from physical addresses %s to %s\n"
1087 " size is %s bytes (%lld in decimal)\n",
1088 mem_type, start_str, end_str, size_str,
1089 (unsigned long long)size);
1098 /****************************************************************************
1099 * mainboard_print_fn
1101 * Display function for 'mainboard' item of coreboot table.
1102 ****************************************************************************/
1103 static void mainboard_print_fn(const struct lb_record *rec)
1105 const struct lb_mainboard *p;
1107 p = (const struct lb_mainboard *)rec;
1108 printf("Vendor: %s\n"
1109 "Part number: %s\n",
1110 &p->strings[p->vendor_idx], &p->strings[p->part_number_idx]);
1113 /****************************************************************************
1114 * cmos_opt_table_print_fn
1116 * Display function for 'cmos_opt_table' item of coreboot table.
1117 ****************************************************************************/
1118 static void cmos_opt_table_print_fn(const struct lb_record *rec)
1120 const struct cmos_option_table *p;
1121 const struct lb_record *cmos_item;
1122 uint32_t bytes_processed, bytes_for_entries;
1125 p = (const struct cmos_option_table *)rec;
1126 q = ((const char *)p) + p->header_length;
1127 bytes_for_entries = p->size - p->header_length;
1129 printf("CMOS option table at physical address 0x%lx:\n"
1130 " tag: 0x%x (decimal: %d)\n"
1131 " size: 0x%x (decimal: %d)\n"
1132 " header_length: 0x%x (decimal: %d)\n\n",
1133 vtophys(p), p->tag, p->tag, p->size, p->size, p->header_length,
1136 if (p->header_length > p->size) {
1138 ("Header length for CMOS option table is greater than the size "
1139 "of the entire table including header!!!\n");
1143 if (bytes_for_entries == 0) {
1144 printf("The CMOS option table is empty!!!\n");
1148 for (bytes_processed = 0;;) {
1149 cmos_item = (const struct lb_record *)&q[bytes_processed];
1151 switch (cmos_item->tag) {
1153 print_option_record((const struct cmos_entries *)
1157 case LB_TAG_OPTION_ENUM:
1158 print_enum_record((const struct cmos_enums *)cmos_item);
1161 case LB_TAG_OPTION_DEFAULTS:
1162 print_defaults_record((const struct cmos_defaults *)
1167 print_unknown_record(cmos_item);
1171 bytes_processed += cmos_item->size;
1173 if (bytes_processed >= bytes_for_entries)
1180 /****************************************************************************
1181 * print_option_record
1183 * Display "option" record from CMOS option table.
1184 ****************************************************************************/
1185 static void print_option_record(const struct cmos_entries *cmos_entry)
1187 static const size_t S_BUFSIZE = 80;
1190 switch (cmos_entry->config) {
1200 strcpy(s, "RESERVED");
1204 snprintf(s, S_BUFSIZE, "UNKNOWN: value is 0x%x (decimal: %d)",
1205 cmos_entry->config, cmos_entry->config);
1209 printf(" OPTION record at physical address 0x%lx:\n"
1210 " tag: 0x%x (decimal: %d)\n"
1211 " size: 0x%x (decimal: %d)\n"
1212 " bit: 0x%x (decimal: %d)\n"
1213 " length: 0x%x (decimal: %d)\n"
1215 " config_id: 0x%x (decimal: %d)\n"
1217 vtophys(cmos_entry), cmos_entry->tag, cmos_entry->tag,
1218 cmos_entry->size, cmos_entry->size, cmos_entry->bit,
1219 cmos_entry->bit, cmos_entry->length, cmos_entry->length, s,
1220 cmos_entry->config_id, cmos_entry->config_id, cmos_entry->name);
1223 /****************************************************************************
1226 * Display "enum" record from CMOS option table.
1227 ****************************************************************************/
1228 static void print_enum_record(const struct cmos_enums *cmos_enum)
1230 printf(" ENUM record at physical address 0x%lx:\n"
1231 " tag: 0x%x (decimal: %d)\n"
1232 " size: 0x%x (decimal: %d)\n"
1233 " config_id: 0x%x (decimal: %d)\n"
1234 " value: 0x%x (decimal: %d)\n"
1236 vtophys(cmos_enum), cmos_enum->tag, cmos_enum->tag,
1237 cmos_enum->size, cmos_enum->size, cmos_enum->config_id,
1238 cmos_enum->config_id, cmos_enum->value, cmos_enum->value,
1242 /****************************************************************************
1243 * print_defaults_record
1245 * Display "defaults" record from CMOS option table.
1246 ****************************************************************************/
1247 static void print_defaults_record(const struct cmos_defaults *cmos_defaults)
1249 printf(" DEFAULTS record at physical address 0x%lx:\n"
1250 " tag: 0x%x (decimal: %d)\n"
1251 " size: 0x%x (decimal: %d)\n"
1252 " name_length: 0x%x (decimal: %d)\n"
1255 vtophys(cmos_defaults), cmos_defaults->tag, cmos_defaults->tag,
1256 cmos_defaults->size, cmos_defaults->size,
1257 cmos_defaults->name_length, cmos_defaults->name_length,
1258 cmos_defaults->name);
1259 hexdump(cmos_defaults->default_set, CMOS_IMAGE_BUFFER_SIZE,
1260 vtophys(cmos_defaults->default_set), stdout, &format);
1263 /****************************************************************************
1264 * print_unknown_record
1266 * Display record of unknown type from CMOS option table.
1267 ****************************************************************************/
1268 static void print_unknown_record(const struct lb_record *cmos_item)
1272 printf(" UNKNOWN record at physical address 0x%lx:\n"
1273 " tag: 0x%x (decimal: %d)\n"
1274 " size: 0x%x (decimal: %d)\n"
1276 vtophys(cmos_item), cmos_item->tag, cmos_item->tag,
1277 cmos_item->size, cmos_item->size);
1278 data = ((const char *)cmos_item) + sizeof(*cmos_item);
1279 hexdump(data, cmos_item->size - sizeof(*cmos_item), vtophys(data),
1283 /****************************************************************************
1284 * option_checksum_print_fn
1286 * Display function for 'option_checksum' item of coreboot table.
1287 ****************************************************************************/
1288 static void option_checksum_print_fn(const struct lb_record *rec)
1290 struct cmos_checksum *p;
1292 p = (struct cmos_checksum *)rec;
1293 printf("CMOS checksum from bit %d to bit %d\n"
1294 "at position %d is type %s.\n",
1295 p->range_start, p->range_end, p->location,
1296 (p->type == CHECKSUM_PCBIOS) ? "PC BIOS" : "NONE");
1299 /****************************************************************************
1302 * Display function for a generic item of coreboot table that simply
1303 * consists of a string.
1304 ****************************************************************************/
1305 static void string_print_fn(const struct lb_record *rec)
1307 const struct lb_string *p;
1309 p = (const struct lb_string *)rec;
1310 printf("%s\n", p->string);
1313 /****************************************************************************
1314 * uint64_to_hex_string
1316 * Convert the 64-bit integer 'n' to its hexadecimal string representation,
1317 * storing the result in 's'. 's' must point to a buffer at least 19 bytes
1318 * long. The result is displayed with as many leading zeros as needed to
1319 * make a 16-digit hex number including a 0x prefix (example: the number 1
1320 * will be displayed as "0x0000000000000001").
1321 ****************************************************************************/
1322 static void uint64_to_hex_string(char str[], uint64_t n)
1329 /* Print the result right-justified with leading spaces in a
1330 * 16-character field. */
1331 chars_printed = sprintf(&str[2], "%016llx", (unsigned long long)n);
1332 assert(chars_printed == 16);