3753737b7e9ca5a2dcc4f5aaedc4ccfecafeae34
[coreboot.git] / util / nvramtool / lbtable.c
1 /*****************************************************************************\
2  * lbtable.c
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>.
8  *  UCRL-CODE-2003-012
9  *  All rights reserved.
10  *
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.
14  *
15  *  Please also read the file DISCLAIMER which is included in this software
16  *  distribution.
17  *
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.
21  *
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.
26  *
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 \*****************************************************************************/
31
32 #include <string.h>
33 #include <sys/mman.h>
34 #include "common.h"
35 #include "coreboot_tables.h"
36 #include "ip_checksum.h"
37 #include "lbtable.h"
38 #include "layout.h"
39 #include "cmos_lowlevel.h"
40 #include "hexdump.h"
41
42 typedef void (*lbtable_print_fn_t) (const struct lb_record * rec);
43
44 /* This structure represents an item in the coreboot table that may be
45  * displayed using the -l option.
46  */
47 typedef struct {
48         uint32_t tag;
49         const char *name;
50         const char *description;
51         const char *nofound_msg;
52         lbtable_print_fn_t print_fn;
53 } lbtable_choice_t;
54
55 typedef struct {
56         unsigned long start;    /* address of first byte of memory range */
57         unsigned long end;      /* address of last byte of memory range */
58 } mem_range_t;
59
60 static const struct lb_header *lbtable_scan(unsigned long start,
61                                             unsigned long end,
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
73                                                         cmos_entries *last);
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,
79                                              uint32_t tag);
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);
90
91 static const char memory_desc[] =
92     "    This shows information about system memory.\n";
93
94 static const char mainboard_desc[] =
95     "    This shows information about your mainboard.\n";
96
97 static const char version_desc[] =
98     "    This shows coreboot version information.\n";
99
100 static const char extra_version_desc[] =
101     "    This shows extra coreboot version information.\n";
102
103 static const char build_desc[] = "    This shows coreboot build information.\n";
104
105 static const char compile_time_desc[] =
106     "    This shows when coreboot was compiled.\n";
107
108 static const char compile_by_desc[] = "    This shows who compiled coreboot.\n";
109
110 static const char compile_host_desc[] =
111     "    This shows the name of the machine that compiled coreboot.\n";
112
113 static const char compile_domain_desc[] =
114     "    This shows the domain name of the machine that compiled coreboot.\n";
115
116 static const char compiler_desc[] =
117     "    This shows the name of the compiler used to build coreboot.\n";
118
119 static const char linker_desc[] =
120     "    This shows the name of the linker used to build coreboot.\n";
121
122 static const char assembler_desc[] =
123     "    This shows the name of the assembler used to build coreboot.\n";
124
125 static const char cmos_opt_table_desc[] =
126     "    This does a low-level dump of the CMOS option table.  The table "
127     "contains\n"
128     "    information about the layout of the values that coreboot stores in\n"
129     "    nonvolatile RAM.\n";
130
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";
134
135 static const char generic_nofound_msg[] =
136     "%s: Item %s not found in coreboot table.\n";
137
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";
142
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";
146
147 int fd;
148
149 /* This is the number of items from the coreboot table that may be displayed
150  * using the -l option.
151  */
152 #define NUM_LBTABLE_CHOICES 14
153
154 /* These represent the various items from the coreboot table that may be
155  * displayed using the -l option.
156  */
157 static const lbtable_choice_t lbtable_choices[NUM_LBTABLE_CHOICES] =
158     { {LB_TAG_MEMORY, "memory",
159        memory_desc, generic_nofound_msg,
160        memory_print_fn},
161 {LB_TAG_MAINBOARD, "mainboard",
162  mainboard_desc, generic_nofound_msg,
163  mainboard_print_fn},
164 {LB_TAG_VERSION, "version",
165  version_desc, generic_nofound_msg,
166  string_print_fn},
167 {LB_TAG_EXTRA_VERSION, "extra_version",
168  extra_version_desc, generic_nofound_msg,
169  string_print_fn},
170 {LB_TAG_BUILD, "build",
171  build_desc, generic_nofound_msg,
172  string_print_fn},
173 {LB_TAG_COMPILE_TIME, "compile_time",
174  compile_time_desc, generic_nofound_msg,
175  string_print_fn},
176 {LB_TAG_COMPILE_BY, "compile_by",
177  compile_by_desc, generic_nofound_msg,
178  string_print_fn},
179 {LB_TAG_COMPILE_HOST, "compile_host",
180  compile_host_desc, generic_nofound_msg,
181  string_print_fn},
182 {LB_TAG_COMPILE_DOMAIN, "compile_domain",
183  compile_domain_desc, generic_nofound_msg,
184  string_print_fn},
185 {LB_TAG_COMPILER, "compiler",
186  compiler_desc, generic_nofound_msg,
187  string_print_fn},
188 {LB_TAG_LINKER, "linker",
189  linker_desc, generic_nofound_msg,
190  string_print_fn},
191 {LB_TAG_ASSEMBLER, "assembler",
192  assembler_desc, generic_nofound_msg,
193  string_print_fn},
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}
200 };
201
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
204  * coreboot table.
205  */
206
207 #define NUM_MEM_RANGES 2
208
209 static const mem_range_t mem_ranges[NUM_MEM_RANGES] =
210     { {0x00000000, 0x00000fff},
211 {0x000f0000, 0x000fffff}
212 };
213
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).
219  */
220 static const size_t BYTES_TO_MAP = (1024 * 1024);
221
222 /* Pointer to low physical memory that we access by calling mmap() on
223  * /dev/mem.
224  */
225 static const void *low_phys_mem;
226 static unsigned long low_phys_base = 0;
227
228 /* Pointer to coreboot table. */
229 static const struct lb_header *lbtable = NULL;
230
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.
233  */
234 static const struct cmos_option_table *cmos_table = NULL;
235
236 static const hexdump_format_t format =
237     { 12, 4, "            ", " | ", " ", " | ", '.' };
238
239 /****************************************************************************
240  * vtophys
241  *
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)
249
250 /****************************************************************************
251  * phystov
252  *
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)
260
261 /****************************************************************************
262  * get_lbtable
263  *
264  * Find the coreboot table and set global variable lbtable to point to it.
265  ****************************************************************************/
266 void get_lbtable(void)
267 {
268         int i, bad_header_count, bad_table_count, bad_headers, bad_tables;
269
270         if (lbtable != NULL)
271                 return;
272
273         /* The coreboot table is located in low physical memory, which may be
274          * conveniently accessed by calling mmap() on /dev/mem.
275          */
276
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));
280                 exit(1);
281         }
282
283         if ((low_phys_mem =
284              mmap(NULL, BYTES_TO_MAP, PROT_READ, MAP_SHARED, fd, 0))
285             == MAP_FAILED) {
286                 fprintf(stderr, "%s: Failed to mmap /dev/mem: %s\n", prog_name,
287                         strerror(errno));
288                 exit(1);
289         }
290
291         bad_header_count = 0;
292         bad_table_count = 0;
293
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);
298
299                 if (lbtable != NULL)
300                         return; /* success: we found it! */
301
302                 bad_header_count += bad_headers;
303                 bad_table_count += bad_tables;
304         }
305
306         fprintf(stderr,
307                 "%s: coreboot table not found.  coreboot does not appear to\n"
308                 "        be installed on this system.  Scanning for the table "
309                 "produced the\n"
310                 "        following results:\n\n"
311                 "            %d valid signatures were found with bad header "
312                 "checksums.\n"
313                 "            %d valid headers were found with bad table "
314                 "checksums.\n", prog_name, bad_header_count, bad_table_count);
315         exit(1);
316 }
317
318 /****************************************************************************
319  * get_layout_from_cmos_table
320  *
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)
325 {
326
327         get_lbtable();
328         cmos_table = (const struct cmos_option_table *)
329             find_lbrec(LB_TAG_CMOS_OPTION_TABLE);
330
331         if ((cmos_table) == NULL) {
332                 fprintf(stderr,
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",
336                         prog_name);
337                 exit(1);
338         }
339
340         process_cmos_table();
341         get_cmos_checksum_info();
342 }
343
344 /****************************************************************************
345  * dump_lbtable
346  *
347  * Do a low-level dump of the coreboot table.
348  ****************************************************************************/
349 void dump_lbtable(void)
350 {
351         const char *p, *data;
352         uint32_t bytes_processed;
353         const struct lb_record *lbrec;
354
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);
371
372         if ((lbtable->table_bytes == 0) != (lbtable->table_entries == 0)) {
373                 printf
374                     ("Inconsistent values for table_bytes and table_entries!!!\n"
375                      "They should be either both 0 or both nonzero.\n");
376                 return;
377         }
378
379         if (lbtable->table_bytes == 0) {
380                 printf("The coreboot table is empty!!!\n");
381                 return;
382         }
383
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"
389                        "        data:\n",
390                        lbrec_tag_to_str(lbrec->tag), vtophys(lbrec), lbrec->tag,
391                        lbrec->tag, lbrec->size, lbrec->size);
392
393                 data = ((const char *)lbrec) + sizeof(*lbrec);
394                 hexdump(data, lbrec->size - sizeof(*lbrec), vtophys(data),
395                         stdout, &format);
396
397                 bytes_processed += lbrec->size;
398
399                 if (bytes_processed >= lbtable->table_bytes)
400                         break;
401
402                 printf("\n");
403         }
404 }
405
406 /****************************************************************************
407  * list_lbtable_choices
408  *
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)
413 {
414         int i;
415
416         for (i = 0;;) {
417                 printf("%s:\n%s",
418                        lbtable_choices[i].name, lbtable_choices[i].description);
419
420                 if (++i >= NUM_LBTABLE_CHOICES)
421                         break;
422
423                 printf("\n");
424         }
425 }
426
427 /****************************************************************************
428  * list_lbtable_item
429  *
430  * Show the coreboot table item specified by 'item'.
431  ****************************************************************************/
432 void list_lbtable_item(const char item[])
433 {
434         int i;
435         const struct lb_record *rec;
436
437         for (i = 0; i < NUM_LBTABLE_CHOICES; i++) {
438                 if (strcmp(item, lbtable_choices[i].name) == 0)
439                         break;
440         }
441
442         if (i == NUM_LBTABLE_CHOICES) {
443                 fprintf(stderr, "%s: Invalid coreboot table item %s.\n",
444                         prog_name, item);
445                 exit(1);
446         }
447
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);
451                 exit(1);
452         }
453
454         lbtable_choices[i].print_fn(rec);
455 }
456
457 /****************************************************************************
458  * lbtable_scan
459  *
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.
468  *
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
471  * follows:
472  *
473  *     *bad_header_count:
474  *         Indicates the number of times in which a valid signature was found
475  *         but the header checksum was invalid.
476  *
477  *     *bad_table_count:
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,
482                                             unsigned long end,
483                                             int *bad_header_count,
484                                             int *bad_table_count)
485 {
486         static const char signature[4] = { 'L', 'B', 'I', 'O' };
487         const struct lb_header *table;
488         const struct lb_forward *forward;
489         const uint32_t *p;
490         uint32_t sig;
491
492         assert(end >= start);
493         memcpy(&sig, signature, sizeof(sig));
494         table = NULL;
495         *bad_header_count = 0;
496         *bad_table_count = 0;
497
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.
503          */
504         for (p = (const uint32_t *)start;
505              (((unsigned long)p) <= end) &&
506              ((end - (unsigned long)p) >= (sizeof(uint32_t) - 1)); p += 4) {
507                 if (*p != sig)
508                         continue;
509
510                 /* We found a valid signature. */
511                 table = (const struct lb_header *)p;
512
513                 /* validate header checksum */
514                 if (compute_ip_checksum((void *)table, sizeof(*table))) {
515                         (*bad_header_count)++;
516                         continue;
517                 }
518
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)++;
524                         continue;
525                 }
526
527                 /* checksums are ok: we found it! */
528                 /* But it may just be a forwarding table, so look if there's a forwarder */
529                 lbtable = table;
530                 forward = (struct lb_forward *)find_lbrec(LB_TAG_FORWARD);
531                 lbtable = NULL;
532
533                 if (forward) {
534                         uint64_t new_phys = forward->forward;
535
536                         new_phys &= ~(getpagesize() - 1);
537
538                         munmap((void *)low_phys_mem, BYTES_TO_MAP);
539                         if ((low_phys_mem =
540                              mmap(NULL, BYTES_TO_MAP, PROT_READ, MAP_SHARED, fd,
541                                   (off_t) new_phys)) == MAP_FAILED) {
542                                 fprintf(stderr,
543                                         "%s: Failed to mmap /dev/mem: %s\n",
544                                         prog_name, strerror(errno));
545                                 exit(1);
546                         }
547                         low_phys_base = new_phys;
548                         table =
549                             lbtable_scan(phystov(low_phys_base),
550                                          phystov(low_phys_base + BYTES_TO_MAP),
551                                          bad_header_count, bad_table_count);
552                 }
553                 return table;
554         }
555
556         return NULL;
557 }
558
559 /****************************************************************************
560  * process_cmos_table
561  *
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)
566 {
567         const struct cmos_enums *p;
568         const struct cmos_entries *q;
569         cmos_enum_t cmos_enum;
570         cmos_entry_t cmos_entry;
571
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);
580         }
581
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.
584          */
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;
589
590                 switch (q->config) {
591                 case 'e':
592                         cmos_entry.config = CMOS_ENTRY_ENUM;
593                         break;
594
595                 case 'h':
596                         cmos_entry.config = CMOS_ENTRY_HEX;
597                         break;
598
599                 case 'r':
600                         cmos_entry.config = CMOS_ENTRY_RESERVED;
601                         break;
602
603                 case 's':
604                         cmos_entry.config = CMOS_ENTRY_STRING;
605                         break;
606
607                 default:
608                         fprintf(stderr,
609                                 "%s: Entry in CMOS option table has unknown config "
610                                 "value.\n", prog_name);
611                         exit(1);
612                 }
613
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);
618         }
619 }
620
621 /****************************************************************************
622  * get_cmos_checksum_info
623  *
624  * Get layout information for CMOS checksum.
625  ****************************************************************************/
626 static void get_cmos_checksum_info(void)
627 {
628         const cmos_entry_t *e;
629         struct cmos_checksum *checksum;
630         cmos_checksum_layout_t layout;
631         unsigned index, index2;
632
633         checksum = (struct cmos_checksum *)find_lbrec(LB_TAG_OPTION_CHECKSUM);
634
635         if (checksum != NULL) { /* We are lucky.  The coreboot table hints us to the checksum.
636                                  * We might have to check the type field here though.
637                                  */
638                 layout.summed_area_start = checksum->range_start;
639                 layout.summed_area_end = checksum->range_end;
640                 layout.checksum_at = checksum->location;
641                 try_convert_checksum_layout(&layout);
642                 cmos_checksum_start = layout.summed_area_start;
643                 cmos_checksum_end = layout.summed_area_end;
644                 cmos_checksum_index = layout.checksum_at;
645                 return;
646         }
647
648         if ((e = find_cmos_entry(checksum_param_name)) == NULL)
649                 return;
650
651         /* If we get here, we are unlucky.  The CMOS option table contains the
652          * location of the CMOS checksum.  However, there is no information
653          * regarding which bytes of the CMOS area the checksum is computed over.
654          * Thus we have to hope our presets will be fine.
655          */
656
657         if (e->bit % 8) {
658                 fprintf(stderr,
659                         "%s: Error: CMOS checksum is not byte-aligned.\n",
660                         prog_name);
661                 exit(1);
662         }
663
664         index = e->bit / 8;
665         index2 = index + 1;     /* The CMOS checksum occupies 16 bits. */
666
667         if (verify_cmos_byte_index(index) || verify_cmos_byte_index(index2)) {
668                 fprintf(stderr,
669                         "%s: Error: CMOS checksum location out of range.\n",
670                         prog_name);
671                 exit(1);
672         }
673
674         if (((index >= cmos_checksum_start) && (index <= cmos_checksum_end)) ||
675             (((index2) >= cmos_checksum_start)
676              && ((index2) <= cmos_checksum_end))) {
677                 fprintf(stderr,
678                         "%s: Error: CMOS checksum overlaps checksummed area.\n",
679                         prog_name);
680                 exit(1);
681         }
682
683         cmos_checksum_index = index;
684 }
685
686 /****************************************************************************
687  * try_convert_checksum_layout
688  *
689  * Perform sanity checking on CMOS checksum layout information and attempt to
690  * convert information from bit positions to byte positions.  Return OK on
691  * success or an error code on failure.
692  ****************************************************************************/
693 static void try_convert_checksum_layout(cmos_checksum_layout_t * layout)
694 {
695         switch (checksum_layout_to_bytes(layout)) {
696         case OK:
697                 return;
698
699         case LAYOUT_SUMMED_AREA_START_NOT_ALIGNED:
700                 fprintf(stderr,
701                         "%s: CMOS checksummed area start is not byte-aligned.\n",
702                         prog_name);
703                 break;
704
705         case LAYOUT_SUMMED_AREA_END_NOT_ALIGNED:
706                 fprintf(stderr,
707                         "%s: CMOS checksummed area end is not byte-aligned.\n",
708                         prog_name);
709                 break;
710
711         case LAYOUT_CHECKSUM_LOCATION_NOT_ALIGNED:
712                 fprintf(stderr,
713                         "%s: CMOS checksum location is not byte-aligned.\n",
714                         prog_name);
715                 break;
716
717         case LAYOUT_INVALID_SUMMED_AREA:
718                 fprintf(stderr,
719                         "%s: CMOS checksummed area end must be greater than "
720                         "CMOS checksummed area start.\n", prog_name);
721                 break;
722
723         case LAYOUT_CHECKSUM_OVERLAPS_SUMMED_AREA:
724                 fprintf(stderr,
725                         "%s: CMOS checksum overlaps checksummed area.\n",
726                         prog_name);
727                 break;
728
729         case LAYOUT_SUMMED_AREA_OUT_OF_RANGE:
730                 fprintf(stderr,
731                         "%s: CMOS checksummed area out of range.\n", prog_name);
732                 break;
733
734         case LAYOUT_CHECKSUM_LOCATION_OUT_OF_RANGE:
735                 fprintf(stderr,
736                         "%s: CMOS checksum location out of range.\n",
737                         prog_name);
738                 break;
739
740         default:
741                 BUG();
742         }
743
744         exit(1);
745 }
746
747 /****************************************************************************
748  * try_add_cmos_table_enum
749  *
750  * Attempt to add a CMOS enum to our internal repository.  Exit with an error
751  * message on failure.
752  ****************************************************************************/
753 static void try_add_cmos_table_enum(cmos_enum_t * cmos_enum)
754 {
755         switch (add_cmos_enum(cmos_enum)) {
756         case OK:
757                 return;
758
759         case LAYOUT_DUPLICATE_ENUM:
760                 fprintf(stderr, "%s: Duplicate enum %s found in CMOS option "
761                         "table.\n", prog_name, cmos_enum->text);
762                 break;
763
764         default:
765                 BUG();
766         }
767
768         exit(1);
769 }
770
771 /****************************************************************************
772  * try_add_cmos_table_entry
773  *
774  * Attempt to add a CMOS entry to our internal repository.  Exit with an
775  * error message on failure.
776  ****************************************************************************/
777 static void try_add_cmos_table_entry(cmos_entry_t * cmos_entry)
778 {
779         const cmos_entry_t *conflict;
780
781         switch (add_cmos_entry(cmos_entry, &conflict)) {
782         case OK:
783                 return;
784
785         case CMOS_AREA_OUT_OF_RANGE:
786                 fprintf(stderr,
787                         "%s: Bad CMOS option layout in CMOS option table entry "
788                         "%s.\n", prog_name, cmos_entry->name);
789                 break;
790
791         case CMOS_AREA_TOO_WIDE:
792                 fprintf(stderr,
793                         "%s: Area too wide for CMOS option table entry %s.\n",
794                         prog_name, cmos_entry->name);
795                 break;
796
797         case LAYOUT_ENTRY_OVERLAP:
798                 fprintf(stderr,
799                         "%s: CMOS option table entries %s and %s have overlapping "
800                         "layouts.\n", prog_name, cmos_entry->name,
801                         conflict->name);
802                 break;
803
804         case LAYOUT_ENTRY_BAD_LENGTH:
805                 /* Silently ignore entries with zero length.  Although this should
806                  * never happen in practice, we should handle the case in a
807                  * reasonable manner just to be safe.
808                  */
809                 return;
810
811         default:
812                 BUG();
813         }
814
815         exit(1);
816 }
817
818 /****************************************************************************
819  * find_lbrec
820  *
821  * Find the record in the coreboot table that matches 'tag'.  Return pointer
822  * to record on success or NULL if record not found.
823  ****************************************************************************/
824 static const struct lb_record *find_lbrec(uint32_t tag)
825 {
826         const char *p;
827         uint32_t bytes_processed;
828         const struct lb_record *lbrec;
829
830         p = ((const char *)lbtable) + lbtable->header_bytes;
831
832         for (bytes_processed = 0;
833              bytes_processed < lbtable->table_bytes;
834              bytes_processed += lbrec->size) {
835                 lbrec = (const struct lb_record *)&p[bytes_processed];
836
837                 if (lbrec->tag == tag)
838                         return lbrec;
839         }
840
841         return NULL;
842 }
843
844 /****************************************************************************
845  * lbrec_tag_to_str
846  *
847  * Return a pointer to the string representation of the given coreboot table
848  * tag.
849  ****************************************************************************/
850 static const char *lbrec_tag_to_str(uint32_t tag)
851 {
852         switch (tag) {
853         case LB_TAG_UNUSED:
854                 return "UNUSED";
855
856         case LB_TAG_MEMORY:
857                 return "MEMORY";
858
859         case LB_TAG_HWRPB:
860                 return "HWRPB";
861
862         case LB_TAG_MAINBOARD:
863                 return "MAINBOARD";
864
865         case LB_TAG_VERSION:
866                 return "VERSION";
867
868         case LB_TAG_EXTRA_VERSION:
869                 return "EXTRA_VERSION";
870
871         case LB_TAG_BUILD:
872                 return "BUILD";
873
874         case LB_TAG_COMPILE_TIME:
875                 return "COMPILE_TIME";
876
877         case LB_TAG_COMPILE_BY:
878                 return "COMPILE_BY";
879
880         case LB_TAG_COMPILE_HOST:
881                 return "COMPILE_HOST";
882
883         case LB_TAG_COMPILE_DOMAIN:
884                 return "COMPILE_DOMAIN";
885
886         case LB_TAG_COMPILER:
887                 return "COMPILER";
888
889         case LB_TAG_LINKER:
890                 return "LINKER";
891
892         case LB_TAG_ASSEMBLER:
893                 return "ASSEMBLER";
894
895         case LB_TAG_SERIAL:
896                 return "SERIAL";
897
898         case LB_TAG_CONSOLE:
899                 return "CONSOLE";
900
901         case LB_TAG_FORWARD:
902                 return "FORWARD";
903
904         case LB_TAG_CMOS_OPTION_TABLE:
905                 return "CMOS_OPTION_TABLE";
906
907         case LB_TAG_OPTION_CHECKSUM:
908                 return "OPTION_CHECKSUM";
909
910         default:
911                 break;
912         }
913
914         return "UNKNOWN";
915 }
916
917 /****************************************************************************
918  * first_cmos_table_entry
919  *
920  * Return a pointer to the first entry in the CMOS table that represents a
921  * CMOS parameter.  Return NULL if CMOS table is empty.
922  ****************************************************************************/
923 static const struct cmos_entries *first_cmos_table_entry(void)
924 {
925         return (const struct cmos_entries *)first_cmos_rec(LB_TAG_OPTION);
926 }
927
928 /****************************************************************************
929  * next_cmos_table_entry
930  *
931  * Return a pointer to the next entry after 'last' in the CMOS table that
932  * represents a CMOS parameter.  Return NULL if there are no more parameters.
933  ****************************************************************************/
934 static const struct cmos_entries *next_cmos_table_entry(const struct
935                                                         cmos_entries *last)
936 {
937         return (const struct cmos_entries *)
938             next_cmos_rec((const struct lb_record *)last, LB_TAG_OPTION);
939 }
940
941 /****************************************************************************
942  * first_cmos_table_enum
943  *
944  * Return a pointer to the first entry in the CMOS table that represents a
945  * possible CMOS parameter value.  Return NULL if the table does not contain
946  * any such entries.
947  ****************************************************************************/
948 static const struct cmos_enums *first_cmos_table_enum(void)
949 {
950         return (const struct cmos_enums *)first_cmos_rec(LB_TAG_OPTION_ENUM);
951 }
952
953 /****************************************************************************
954  * next_cmos_table_enum
955  *
956  * Return a pointer to the next entry after 'last' in the CMOS table that
957  * represents a possible CMOS parameter value.  Return NULL if there are no
958  * more parameter values.
959  ****************************************************************************/
960 static const struct cmos_enums *next_cmos_table_enum
961     (const struct cmos_enums *last) {
962         return (const struct cmos_enums *)
963             next_cmos_rec((const struct lb_record *)last, LB_TAG_OPTION_ENUM);
964 }
965
966 /****************************************************************************
967  * first_cmos_rec
968  *
969  * Return a pointer to the first entry in the CMOS table whose type matches
970  * 'tag'.  Return NULL if CMOS table contains no such entry.
971  *
972  * Possible values for 'tag' are as follows:
973  *
974  *     LB_TAG_OPTION:      The entry represents a CMOS parameter.
975  *     LB_TAG_OPTION_ENUM: The entry represents a possible value for a CMOS
976  *                         parameter of type 'enum'.
977  *
978  * The CMOS table tells us where in the nonvolatile RAM to look for CMOS
979  * parameter values and specifies their types as 'enum', 'hex', or
980  * 'reserved'.
981  ****************************************************************************/
982 static const struct lb_record *first_cmos_rec(uint32_t tag)
983 {
984         const char *p;
985         uint32_t bytes_processed, bytes_for_entries;
986         const struct lb_record *lbrec;
987
988         p = ((const char *)cmos_table) + cmos_table->header_length;
989         bytes_for_entries = cmos_table->size - cmos_table->header_length;
990
991         for (bytes_processed = 0;
992              bytes_processed < bytes_for_entries;
993              bytes_processed += lbrec->size) {
994                 lbrec = (const struct lb_record *)&p[bytes_processed];
995
996                 if (lbrec->tag == tag)
997                         return lbrec;
998         }
999
1000         return NULL;
1001 }
1002
1003 /****************************************************************************
1004  * next_cmos_rec
1005  *
1006  * Return a pointer to the next entry after 'last' in the CMOS table whose
1007  * type matches 'tag'.  Return NULL if the table contains no more entries of
1008  * this type.
1009  ****************************************************************************/
1010 static const struct lb_record *next_cmos_rec(const struct lb_record *last,
1011                                              uint32_t tag)
1012 {
1013         const char *p;
1014         uint32_t bytes_processed, bytes_for_entries, last_offset;
1015         const struct lb_record *lbrec;
1016
1017         p = ((const char *)cmos_table) + cmos_table->header_length;
1018         bytes_for_entries = cmos_table->size - cmos_table->header_length;
1019         last_offset = ((const char *)last) - p;
1020
1021         for (bytes_processed = last_offset + last->size;
1022              bytes_processed < bytes_for_entries;
1023              bytes_processed += lbrec->size) {
1024                 lbrec = (const struct lb_record *)&p[bytes_processed];
1025
1026                 if (lbrec->tag == tag)
1027                         return lbrec;
1028         }
1029
1030         return NULL;
1031 }
1032
1033 /****************************************************************************
1034  * memory_print_fn
1035  *
1036  * Display function for 'memory' item of coreboot table.
1037  ****************************************************************************/
1038 static void memory_print_fn(const struct lb_record *rec)
1039 {
1040         char start_str[19], end_str[19], size_str[19];
1041         const struct lb_memory *p;
1042         const char *mem_type;
1043         const struct lb_memory_range *ranges;
1044         uint64_t size, start, end;
1045         int i, entries;
1046
1047         p = (const struct lb_memory *)rec;
1048         entries = (p->size - sizeof(*p)) / sizeof(p->map[0]);
1049         ranges = p->map;
1050
1051         if (entries == 0) {
1052                 printf("No memory ranges were found.\n");
1053                 return;
1054         }
1055
1056         for (i = 0;;) {
1057                 switch (ranges[i].type) {
1058                 case LB_MEM_RAM:
1059                         mem_type = "AVAILABLE";
1060                         break;
1061
1062                 case LB_MEM_RESERVED:
1063                         mem_type = "RESERVED";
1064                         break;
1065
1066                 case LB_MEM_TABLE:
1067                         mem_type = "CONFIG_TABLE";
1068                         break;
1069
1070                 default:
1071                         mem_type = "UNKNOWN";
1072                         break;
1073                 }
1074
1075                 size = unpack_lb64(ranges[i].size);
1076                 start = unpack_lb64(ranges[i].start);
1077                 end = start + size - 1;
1078                 uint64_to_hex_string(start_str, start);
1079                 uint64_to_hex_string(end_str, end);
1080                 uint64_to_hex_string(size_str, size);
1081                 printf("%s memory:\n"
1082                        "    from physical addresses %s to %s\n"
1083                        "    size is %s bytes (%lld in decimal)\n",
1084                        mem_type, start_str, end_str, size_str,
1085                        (unsigned long long)size);
1086
1087                 if (++i >= entries)
1088                         break;
1089
1090                 printf("\n");
1091         }
1092 }
1093
1094 /****************************************************************************
1095  * mainboard_print_fn
1096  *
1097  * Display function for 'mainboard' item of coreboot table.
1098  ****************************************************************************/
1099 static void mainboard_print_fn(const struct lb_record *rec)
1100 {
1101         const struct lb_mainboard *p;
1102
1103         p = (const struct lb_mainboard *)rec;
1104         printf("Vendor:      %s\n"
1105                "Part number: %s\n",
1106                &p->strings[p->vendor_idx], &p->strings[p->part_number_idx]);
1107 }
1108
1109 /****************************************************************************
1110  * cmos_opt_table_print_fn
1111  *
1112  * Display function for 'cmos_opt_table' item of coreboot table.
1113  ****************************************************************************/
1114 static void cmos_opt_table_print_fn(const struct lb_record *rec)
1115 {
1116         const struct cmos_option_table *p;
1117         const struct lb_record *cmos_item;
1118         uint32_t bytes_processed, bytes_for_entries;
1119         const char *q;
1120
1121         p = (const struct cmos_option_table *)rec;
1122         q = ((const char *)p) + p->header_length;
1123         bytes_for_entries = p->size - p->header_length;
1124
1125         printf("CMOS option table at physical address 0x%lx:\n"
1126                "    tag:           0x%x (decimal: %d)\n"
1127                "    size:          0x%x (decimal: %d)\n"
1128                "    header_length: 0x%x (decimal: %d)\n\n",
1129                vtophys(p), p->tag, p->tag, p->size, p->size, p->header_length,
1130                p->header_length);
1131
1132         if (p->header_length > p->size) {
1133                 printf
1134                     ("Header length for CMOS option table is greater than the size "
1135                      "of the entire table including header!!!\n");
1136                 return;
1137         }
1138
1139         if (bytes_for_entries == 0) {
1140                 printf("The CMOS option table is empty!!!\n");
1141                 return;
1142         }
1143
1144         for (bytes_processed = 0;;) {
1145                 cmos_item = (const struct lb_record *)&q[bytes_processed];
1146
1147                 switch (cmos_item->tag) {
1148                 case LB_TAG_OPTION:
1149                         print_option_record((const struct cmos_entries *)
1150                                             cmos_item);
1151                         break;
1152
1153                 case LB_TAG_OPTION_ENUM:
1154                         print_enum_record((const struct cmos_enums *)cmos_item);
1155                         break;
1156
1157                 case LB_TAG_OPTION_DEFAULTS:
1158                         print_defaults_record((const struct cmos_defaults *)
1159                                               cmos_item);
1160                         break;
1161
1162                 default:
1163                         print_unknown_record(cmos_item);
1164                         break;
1165                 }
1166
1167                 bytes_processed += cmos_item->size;
1168
1169                 if (bytes_processed >= bytes_for_entries)
1170                         break;
1171
1172                 printf("\n");
1173         }
1174 }
1175
1176 /****************************************************************************
1177  * print_option_record
1178  *
1179  * Display "option" record from CMOS option table.
1180  ****************************************************************************/
1181 static void print_option_record(const struct cmos_entries *cmos_entry)
1182 {
1183         static const size_t S_BUFSIZE = 80;
1184         char s[S_BUFSIZE];
1185
1186         switch (cmos_entry->config) {
1187         case 'e':
1188                 strcpy(s, "ENUM");
1189                 break;
1190
1191         case 'h':
1192                 strcpy(s, "HEX");
1193                 break;
1194
1195         case 'r':
1196                 strcpy(s, "RESERVED");
1197                 break;
1198
1199         default:
1200                 snprintf(s, S_BUFSIZE, "UNKNOWN: value is 0x%x (decimal: %d)",
1201                          cmos_entry->config, cmos_entry->config);
1202                 break;
1203         }
1204
1205         printf("    OPTION record at physical address 0x%lx:\n"
1206                "        tag:       0x%x (decimal: %d)\n"
1207                "        size:      0x%x (decimal: %d)\n"
1208                "        bit:       0x%x (decimal: %d)\n"
1209                "        length:    0x%x (decimal: %d)\n"
1210                "        config:    %s\n"
1211                "        config_id: 0x%x (decimal: %d)\n"
1212                "        name:      %s\n",
1213                vtophys(cmos_entry), cmos_entry->tag, cmos_entry->tag,
1214                cmos_entry->size, cmos_entry->size, cmos_entry->bit,
1215                cmos_entry->bit, cmos_entry->length, cmos_entry->length, s,
1216                cmos_entry->config_id, cmos_entry->config_id, cmos_entry->name);
1217 }
1218
1219 /****************************************************************************
1220  * print_enum_record
1221  *
1222  * Display "enum" record from CMOS option table.
1223  ****************************************************************************/
1224 static void print_enum_record(const struct cmos_enums *cmos_enum)
1225 {
1226         printf("    ENUM record at physical address 0x%lx:\n"
1227                "        tag:       0x%x (decimal: %d)\n"
1228                "        size:      0x%x (decimal: %d)\n"
1229                "        config_id: 0x%x (decimal: %d)\n"
1230                "        value:     0x%x (decimal: %d)\n"
1231                "        text:      %s\n",
1232                vtophys(cmos_enum), cmos_enum->tag, cmos_enum->tag,
1233                cmos_enum->size, cmos_enum->size, cmos_enum->config_id,
1234                cmos_enum->config_id, cmos_enum->value, cmos_enum->value,
1235                cmos_enum->text);
1236 }
1237
1238 /****************************************************************************
1239  * print_defaults_record
1240  *
1241  * Display "defaults" record from CMOS option table.
1242  ****************************************************************************/
1243 static void print_defaults_record(const struct cmos_defaults *cmos_defaults)
1244 {
1245         printf("    DEFAULTS record at physical address 0x%lx:\n"
1246                "        tag:         0x%x (decimal: %d)\n"
1247                "        size:        0x%x (decimal: %d)\n"
1248                "        name_length: 0x%x (decimal: %d)\n"
1249                "        name:        %s\n"
1250                "        default_set:\n",
1251                vtophys(cmos_defaults), cmos_defaults->tag, cmos_defaults->tag,
1252                cmos_defaults->size, cmos_defaults->size,
1253                cmos_defaults->name_length, cmos_defaults->name_length,
1254                cmos_defaults->name);
1255         hexdump(cmos_defaults->default_set, CMOS_IMAGE_BUFFER_SIZE,
1256                 vtophys(cmos_defaults->default_set), stdout, &format);
1257 }
1258
1259 /****************************************************************************
1260  * print_unknown_record
1261  *
1262  * Display record of unknown type from CMOS option table.
1263  ****************************************************************************/
1264 static void print_unknown_record(const struct lb_record *cmos_item)
1265 {
1266         const char *data;
1267
1268         printf("    UNKNOWN record at physical address 0x%lx:\n"
1269                "        tag:  0x%x (decimal: %d)\n"
1270                "        size: 0x%x (decimal: %d)\n"
1271                "        data:\n",
1272                vtophys(cmos_item), cmos_item->tag, cmos_item->tag,
1273                cmos_item->size, cmos_item->size);
1274         data = ((const char *)cmos_item) + sizeof(*cmos_item);
1275         hexdump(data, cmos_item->size - sizeof(*cmos_item), vtophys(data),
1276                 stdout, &format);
1277 }
1278
1279 /****************************************************************************
1280  * option_checksum_print_fn
1281  *
1282  * Display function for 'option_checksum' item of coreboot table.
1283  ****************************************************************************/
1284 static void option_checksum_print_fn(const struct lb_record *rec)
1285 {
1286         struct cmos_checksum *p;
1287
1288         p = (struct cmos_checksum *)rec;
1289         printf("CMOS checksum from bit %d to bit %d\n"
1290                "at position %d is type %s.\n",
1291                p->range_start, p->range_end, p->location,
1292                (p->type == CHECKSUM_PCBIOS) ? "PC BIOS" : "NONE");
1293 }
1294
1295 /****************************************************************************
1296  * string_print_fn
1297  *
1298  * Display function for a generic item of coreboot table that simply
1299  * consists of a string.
1300  ****************************************************************************/
1301 static void string_print_fn(const struct lb_record *rec)
1302 {
1303         const struct lb_string *p;
1304
1305         p = (const struct lb_string *)rec;
1306         printf("%s\n", p->string);
1307 }
1308
1309 /****************************************************************************
1310  * uint64_to_hex_string
1311  *
1312  * Convert the 64-bit integer 'n' to its hexadecimal string representation,
1313  * storing the result in 's'.  's' must point to a buffer at least 19 bytes
1314  * long.  The result is displayed with as many leading zeros as needed to
1315  * make a 16-digit hex number including a 0x prefix (example: the number 1
1316  * will be displayed as "0x0000000000000001").
1317  ****************************************************************************/
1318 static void uint64_to_hex_string(char str[], uint64_t n)
1319 {
1320         int chars_printed;
1321
1322         str[0] = '0';
1323         str[1] = 'x';
1324
1325         /* Print the result right-justified with leading spaces in a
1326          * 16-character field. */
1327         chars_printed = sprintf(&str[2], "%016llx", (unsigned long long)n);
1328         assert(chars_printed == 16);
1329 }