2 * This file is part of the coreboot project.
4 * Copyright (C) 2003 Eric Biederman (ebiederm@xmission.com)
5 * Copyright (C) 2007-2010 coresystems GmbH
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 2 of the License.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA
28 #define UTIL_BUILD_OPTION_TABLE
29 #include "../../src/include/pc80/mc146818rtc.h"
30 #include "../../src/include/boot/coreboot_tables.h"
32 #define CMOS_IMAGE_BUFFER_SIZE 256
33 #define INPUT_LINE_MAX 256
34 #define MAX_VALUE_BYTE_LENGTH 64
36 #define TMPFILE_LEN 25600
37 #define TMPFILE_TEMPLATE "/build_opt_tbl_XXXXXX"
39 static unsigned char cmos_table[4096];
41 /* This array is used to isolate bits that are to be changed in a byte */
42 static unsigned char clip[9]={0,1,3,7,0x0f,0x1f,0x3f,0x7f,0xff};
46 char *mkstemp(char* name)
52 return open(name,O_CREAT | O_RDWR);
54 #define UNLINK_IF_NECESSARY(x) unlink(x)
56 #define UNLINK_IF_NECESSARY(x)
60 * This routine loops through the entried and tests if any of the fields
62 * If there is an overlap, the routine exits, otherwise it returns.
64 * @param entry_start memory pointer to the start of the entries.
65 * @param entry_end memory pointer to the byte past the entries.
67 static void test_for_entry_overlaps(void *entry_start, void *entry_end)
75 struct cmos_entries *ce;
76 unsigned char test[CMOS_IMAGE_BUFFER_SIZE];
79 /* calculate the size of the cmos buffer in bits */
80 buffer_bit_size=(CMOS_IMAGE_BUFFER_SIZE*8);
81 /* clear the temporary test buffer */
82 for(ptr=0; ptr < CMOS_IMAGE_BUFFER_SIZE; ptr++)
85 /* loop through each entry in the table testing for errors */
86 for(cptr = entry_start; cptr < (char *)entry_end; cptr += ce->size) {
87 ce=(struct cmos_entries *)cptr;
88 /* test if entry goes past the end of the buffer */
89 if((int)(ce->bit+ce->length) > buffer_bit_size) {
90 printf("Error - Entry %s start bit + length must be less than %d\n",
91 ce->name,buffer_bit_size);
96 byte_length=ce->length/8;
97 if(byte_length) { /* entry is 8 bits long or more */
98 if(offset) { /* if 8 bits or more long, it must be byte aligned */
99 printf("Error - Entry %s length over 8 must be byte aligned\n",
103 /* test if entries 8 or more in length are even bytes */
105 printf("Error - Entry %s length over 8 must be a multiple of 8\n",
109 /* test if any of the bits have been previously used */
110 for(;byte_length;byte_length--,byte++) {
112 printf("Error - Entry %s uses same bits previously used\n",
116 test[byte]=clip[8]; /* set the bits defined in test */
119 /* test if bits overlap byte boundaries */
120 if((int)ce->length > (8-offset)) {
121 printf("Error - Entry %s length overlaps a byte boundry\n",
125 /* test for bits previously used */
126 set=(clip[ce->length]<<offset);
128 printf("Error - Entry %s uses same bits previously used\n",
132 test[byte]|=set; /* set the bits defined in test */
138 /* This routine displays the usage options */
139 static void display_usage(char *name)
141 printf("Usage: %s [--config filename]\n", name);
142 printf(" [--option filename]\n");
143 printf(" [--header filename]\n\n");
144 printf("--config = Build the definitions table from the given file.\n");
145 printf("--binary = Output a binary file with the definitions.\n");
146 printf("--option = Output a C source file with the definitions.\n");
147 printf("--header = Output a C header file with the definitions.\n");
151 static void skip_spaces(char *line, char **ptr)
153 if (!isspace(**ptr)) {
154 printf("Error missing whitespace in line\n%s\n", line);
157 while(isspace(**ptr)) {
163 static unsigned long get_number(char *line, char **ptr, int base)
167 value = strtoul(*ptr, &ptr2, base);
169 printf("Error missing digits at: \n%s\n in line:\n%s\n",
177 static int is_ident_digit(int c)
181 case '0': case '1': case '2': case '3':
182 case '4': case '5': case '6': case '7':
193 static int is_ident_nondigit(int c)
197 case 'A': case 'B': case 'C': case 'D':
198 case 'E': case 'F': case 'G': case 'H':
199 case 'I': case 'J': case 'K': case 'L':
200 case 'M': case 'N': case 'O': case 'P':
201 case 'Q': case 'R': case 'S': case 'T':
202 case 'U': case 'V': case 'W': case 'X':
204 case 'a': case 'b': case 'c': case 'd':
205 case 'e': case 'f': case 'g': case 'h':
206 case 'i': case 'j': case 'k': case 'l':
207 case 'm': case 'n': case 'o': case 'p':
208 case 'q': case 'r': case 's': case 't':
209 case 'u': case 'v': case 'w': case 'x':
221 static int is_ident(char *str)
227 if (is_ident_nondigit(ch)) {
231 } while(ch && (is_ident_nondigit(ch) || (is_ident_digit(ch))));
232 result = (ch == '\0');
238 * This routine builds the cmos definition table from the cmos layout file
240 * The input comes from the configuration file which contains two parts
241 * entries and enumerations. Each section is started with the key words
242 * entries and enumerations. Records then follow in their respective
245 * The output of this program is the cmos definitions table. It is stored
246 * in the cmos_table array. If this module is called, and the global
247 * table_file has been implimented by the user, the table is also written
248 * to the specified file.
250 * This program exits with a return code of 1 on error. It returns 0 on
251 * successful completion
253 int main(int argc, char **argv)
262 char tempfilename[TMPFILE_LEN];
263 struct cmos_option_table *ct;
264 struct cmos_entries *ce;
265 struct cmos_enums *c_enums, *c_enums_start;
266 struct cmos_checksum *cs, *new_cs;
267 char line[INPUT_LINE_MAX];
274 void *entry_start, *entry_end;
281 for(i=1;i<argc;i++) {
282 if(argv[i][0]!='-') {
283 display_usage(argv[0]);
286 case '-': /* data is requested from a file */
288 case 'c': /* use a configuration file */
289 if(strcmp(&argv[i][2],"config")) {
290 display_usage(argv[0]);
294 case 'b': /* Emit a binary file */
295 if(strcmp(&argv[i][2],"binary")) {
296 display_usage(argv[0]);
300 case 'o': /* use a cmos definitions table file */
301 if(strcmp(&argv[i][2],"option")) {
302 display_usage(argv[0]);
306 case 'h': /* Output a header file */
307 if (strcmp(&argv[i][2], "header") != 0) {
308 display_usage(argv[0]);
313 display_usage(argv[0]);
319 display_usage(argv[0]);
325 /* Has the user specified a configuration file */
326 if(config) { /* if yes, open it */
327 if((fp=fopen(config,"r"))==NULL){
328 fprintf(stderr, "Error - Can not open config file %s\n",config);
329 exit(1); /* exit if it can not be opened */
332 else { /* no configuration file specified, so try the default */
333 if((fp=fopen("cmos.layout","r"))==NULL){
334 fprintf(stderr, "Error - Can not open cmos.layout\n");
335 exit(1); /* end of no configuration file is found */
338 /* type cast a pointer, so we can us the structure */
339 ct=(struct cmos_option_table*)cmos_table;
340 /* start the table with the type signature */
341 ct->tag = LB_TAG_CMOS_OPTION_TABLE;
342 /* put in the header length */
343 ct->header_length=sizeof(*ct);
345 /* Get the entry records */
346 ce=(struct cmos_entries*)(cmos_table+(ct->header_length));
348 for(;;){ /* this section loops through the entry records */
349 if(fgets(line,INPUT_LINE_MAX,fp)==NULL)
350 break; /* end if no more input */
351 // FIXME mode should be a single enum.
352 if(!entry_mode) { /* skip input until the entries key word */
353 if (strstr(line,"entries") != 0) {
359 } else { /* Test if we are done with entries and starting enumerations */
360 if (strstr(line,"enumerations") != 0){
366 if (strstr(line, "checksums") != 0) {
374 /* skip commented and blank lines */
375 val = line[strspn(line," ")];
376 /* takes care of *nix, Mac and Windows line ending formats */
377 if (val=='#' || val=='\n' || val=='\r') continue;
378 /* scan in the input data */
379 sscanf(line,"%d %d %c %d %s",
380 &ce->bit,&ce->length,&uc,&ce->config_id,&ce->name[0]);
382 /* check bit and length ranges */
383 if(ce->bit>(CMOS_IMAGE_BUFFER_SIZE*8)) {
384 fprintf(stderr, "Error - bit is to big in line \n%s\n",line);
387 if((ce->length>(MAX_VALUE_BYTE_LENGTH*8))&&(uc!='r')) {
388 fprintf(stderr, "Error - Length is to long in line \n%s\n",line);
391 if (!is_ident((char *)ce->name)) {
393 "Error - Name %s is an invalid identifier in line\n %s\n",
397 /* put in the record type */
398 ce->tag=LB_TAG_OPTION;
399 /* calculate and save the record length */
400 len=strlen((char *)ce->name)+1;
401 /* make the record int aligned */
404 ce->size=sizeof(struct cmos_entries)-32+len;
406 cptr += ce->size; /* increment to the next table position */
407 ce = (struct cmos_entries*) cptr;
410 /* put the length of the entries into the header section */
411 entries_length = (cptr - (char *)&cmos_table) - ct->header_length;
413 /* compute the start of the enumerations section */
414 entry_start = ((char*)&cmos_table) + ct->header_length;
415 entry_end = ((char *)entry_start) + entries_length;
416 c_enums_start = c_enums = (struct cmos_enums*)entry_end;
417 /* test for overlaps in the entry records */
418 test_for_entry_overlaps(entry_start, entry_end);
420 for(;enum_mode;){ /* loop to build the enumerations section */
422 if(fgets(line,INPUT_LINE_MAX,fp)==NULL)
423 break; /* go till end of input */
425 if (strstr(line, "checksums") != 0) {
431 /* skip commented and blank lines */
432 if(line[0]=='#') continue;
433 if(line[strspn(line," ")]=='\n') continue;
435 /* scan in the data */
436 for(ptr=0;(line[ptr]==' ')||(line[ptr]=='\t');ptr++);
437 c_enums->config_id=strtol(&line[ptr],(char**)NULL,10);
438 for(;(line[ptr]!=' ')&&(line[ptr]!='\t');ptr++);
439 for(;(line[ptr]==' ')||(line[ptr]=='\t');ptr++);
440 c_enums->value=strtol(&line[ptr],(char**)NULL,10);
441 for(;(line[ptr]!=' ')&&(line[ptr]!='\t');ptr++);
442 for(;(line[ptr]==' ')||(line[ptr]=='\t');ptr++);
443 for(cnt=0;(line[ptr]!='\n')&&(cnt<31);ptr++,cnt++)
444 c_enums->text[cnt]=line[ptr];
445 c_enums->text[cnt]=0;
447 /* make the record int aligned */
451 /* store the record length */
452 c_enums->size=((char *)&c_enums->text[cnt]) - (char *)c_enums;
453 /* store the record type */
454 c_enums->tag=LB_TAG_OPTION_ENUM;
455 /* increment to the next record */
456 c_enums=(struct cmos_enums*)&c_enums->text[cnt];
458 /* save the enumerations length */
459 enum_length= (char *)c_enums - (char *)c_enums_start;
460 ct->size=ct->header_length+enum_length+entries_length;
462 /* Get the checksum records */
463 new_cs = (struct cmos_checksum *)(cmos_table+(ct->size));
464 for(;checksum_mode;) { /* This section finds the checksums */
466 if(fgets(line, INPUT_LINE_MAX,fp)==NULL)
467 break; /* end if no more input */
469 /* skip commented and blank lines */
470 if (line[0]=='#') continue;
471 if (line[strspn(line, " ")]=='\n') continue;
472 if (memcmp(line, "checksum", 8) != 0) continue;
474 /* We actually found a new cmos checksum entry */
477 /* get the information */
479 skip_spaces(line, &ptr);
480 cs->range_start = get_number(line, &ptr, 10);
482 skip_spaces(line, &ptr);
483 cs->range_end = get_number(line, &ptr, 10);
485 skip_spaces(line, &ptr);
486 cs->location = get_number(line, &ptr, 10);
488 /* Make certain there are spaces until the end of the line */
489 skip_spaces(line, &ptr);
491 if ((cs->range_start%8) != 0) {
492 fprintf(stderr, "Error - range start is not byte aligned in line\n%s\n", line);
495 if (cs->range_start >= (CMOS_IMAGE_BUFFER_SIZE*8)) {
496 fprintf(stderr, "Error - range start is to big in line\n%s\n", line);
499 if ((cs->range_end%8) != 7) {
500 fprintf(stderr, "Error - range end is not byte aligned in line\n%s\n", line);
503 if ((cs->range_end) >= (CMOS_IMAGE_BUFFER_SIZE*8)) {
504 fprintf(stderr, "Error - range end is to long in line\n%s\n", line);
507 if ((cs->location%8) != 0) {
508 fprintf(stderr, "Error - location is not byte aligned in line\n%s\n", line);
511 if ((cs->location >= (CMOS_IMAGE_BUFFER_SIZE*8)) ||
512 ((cs->location + 16) > (CMOS_IMAGE_BUFFER_SIZE*8)))
514 fprintf(stderr, "Error - location is to big in line\n%s\n", line);
518 cs->tag = LB_TAG_OPTION_CHECKSUM;
519 cs->size = sizeof(*cs);
520 cs->type = CHECKSUM_PCBIOS;
524 new_cs = (struct cmos_checksum *)cptr;
526 ct->size += (cptr - (char *)(cmos_table + ct->size));
529 /* See if we want to output a C source file */
532 snprintf(tempfilename, TMPFILE_LEN, "%s%s", dirname(strdup(option)), TMPFILE_TEMPLATE);
533 tempfile = mkstemp(tempfilename);
535 perror("Error - Could not create temporary file");
539 if((fp=fdopen(tempfile,"w"))==NULL){
540 perror("Error - Could not open temporary file");
541 unlink(tempfilename);
545 /* write the header */
546 if(fwrite("unsigned char option_table[] = {",1,32,fp) != 32) {
547 perror("Error - Could not write image file");
549 unlink(tempfilename);
552 /* write the array values */
553 for(i=0; i<(int)(ct->size-1); i++) {
554 if(!(i%10) && !err) err=(fwrite("\n\t",1,2,fp) != 2);
555 sprintf(buf,"0x%02x,",cmos_table[i]);
556 if(!err) err=(fwrite(buf,1,5,fp) != 5);
559 sprintf(buf,"0x%02x\n",cmos_table[i]);
560 if(!err) err=(fwrite(buf,1,4,fp) != 4);
561 if(fwrite("};\n",1,3,fp) != 3) {
562 perror("Error - Could not write image file");
564 unlink(tempfilename);
569 UNLINK_IF_NECESSARY(option);
570 if (rename(tempfilename, option)) {
571 fprintf(stderr, "Error - Could not write %s: ", option);
573 unlink(tempfilename);
578 /* See if we also want to output a binary file */
581 snprintf(tempfilename, TMPFILE_LEN, "%s%s", dirname(strdup(binary)), TMPFILE_TEMPLATE);
582 tempfile = mkstemp(tempfilename);
584 perror("Error - Could not create temporary file");
588 if((fp=fdopen(tempfile,"wb"))==NULL){
589 perror("Error - Could not open temporary file");
590 unlink(tempfilename);
594 /* write the array values */
595 if(fwrite(cmos_table, (int)(ct->size-1), 1, fp) != 1) {
596 perror("Error - Could not write image file");
598 unlink(tempfilename);
603 UNLINK_IF_NECESSARY(binary);
604 if (rename(tempfilename, binary)) {
605 fprintf(stderr, "Error - Could not write %s: ", binary);
607 unlink(tempfilename);
612 /* See if we also want to output a C header file */
614 struct cmos_option_table *hdr;
615 struct lb_record *ptr, *end;
617 snprintf(tempfilename, TMPFILE_LEN, "%s%s", dirname(strdup(header)), TMPFILE_TEMPLATE);
618 tempfile = mkstemp(tempfilename);
620 perror("Error - Could not create temporary file");
624 fp = fdopen(tempfile, "w");
626 perror("Error - Could not open temporary file");
627 unlink(tempfilename);
631 /* Get the cmos table header */
632 hdr = (struct cmos_option_table *)cmos_table;
633 /* Walk through the entry records */
634 ptr = (struct lb_record *)(cmos_table + hdr->header_length);
635 end = (struct lb_record *)(cmos_table + hdr->size);
636 fprintf(fp, "/* This file is autogenerated.\n"
637 " * See mainboard's cmos.layout file.\n */\n\n"
638 "#ifndef __OPTION_TABLE_H\n#define __OPTION_TABLE_H\n\n");
640 for(;ptr < end; ptr = (struct lb_record *)(((char *)ptr) + ptr->size)) {
641 if (ptr->tag != LB_TAG_OPTION) {
644 ce = (struct cmos_entries *)ptr;
646 if (!is_ident((char *)ce->name)) {
647 fprintf(stderr, "Invalid identifier: %s\n",
650 unlink(tempfilename);
653 fprintf(fp, "#define CMOS_VSTART_%s %d\n",
655 fprintf(fp, "#define CMOS_VLEN_%s %d\n",
656 ce->name, ce->length);
660 fprintf(fp, "\n#define LB_CKS_RANGE_START %d\n", cs->range_start / 8);
661 fprintf(fp, "#define LB_CKS_RANGE_END %d\n", cs->range_end / 8);
662 fprintf(fp, "#define LB_CKS_LOC %d\n", cs->location / 8);
664 fprintf(stderr, "Error - No checksums defined.\n");
666 unlink(tempfilename);
669 fprintf(fp, "\n#endif // __OPTION_TABLE_H\n");
672 UNLINK_IF_NECESSARY(header);
673 if (rename(tempfilename, header)) {
674 fprintf(stderr, "Error - Could not write %s: ", header);
676 unlink(tempfilename);