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;
280 for(i=1;i<argc;i++) {
281 if(argv[i][0]!='-') {
282 display_usage(argv[0]);
285 case '-': /* data is requested from a file */
287 case 'c': /* use a configuration file */
288 if(strcmp(&argv[i][2],"config")) {
289 display_usage(argv[0]);
293 case 'b': /* Emit a binary file */
294 if(strcmp(&argv[i][2],"binary")) {
295 display_usage(argv[0]);
299 case 'o': /* use a cmos definitions table file */
300 if(strcmp(&argv[i][2],"option")) {
301 display_usage(argv[0]);
305 case 'h': /* Output a header file */
306 if (strcmp(&argv[i][2], "header") != 0) {
307 display_usage(argv[0]);
312 display_usage(argv[0]);
318 display_usage(argv[0]);
324 /* Has the user specified a configuration file */
325 if(config) { /* if yes, open it */
326 if((fp=fopen(config,"r"))==NULL){
327 fprintf(stderr, "Error - Can not open config file %s\n",config);
328 exit(1); /* exit if it can not be opened */
331 else { /* no configuration file specified, so try the default */
332 if((fp=fopen("cmos.layout","r"))==NULL){
333 fprintf(stderr, "Error - Can not open cmos.layout\n");
334 exit(1); /* end of no configuration file is found */
337 /* type cast a pointer, so we can us the structure */
338 ct=(struct cmos_option_table*)cmos_table;
339 /* start the table with the type signature */
340 ct->tag = LB_TAG_CMOS_OPTION_TABLE;
341 /* put in the header length */
342 ct->header_length=sizeof(*ct);
344 /* Get the entry records */
345 ce=(struct cmos_entries*)(cmos_table+(ct->header_length));
347 for(;;){ /* this section loops through the entry records */
348 if(fgets(line,INPUT_LINE_MAX,fp)==NULL)
349 break; /* end if no more input */
350 // FIXME mode should be a single enum.
351 if(!entry_mode) { /* skip input until the entries key word */
352 if (strstr(line,"entries") != 0) {
358 } else { /* Test if we are done with entries and starting enumerations */
359 if (strstr(line,"enumerations") != 0){
365 if (strstr(line, "checksums") != 0) {
373 /* skip commented and blank lines */
374 if(line[0]=='#') continue;
375 if(line[strspn(line," ")]=='\n') continue;
376 /* scan in the input data */
377 sscanf(line,"%d %d %c %d %s",
378 &ce->bit,&ce->length,&uc,&ce->config_id,&ce->name[0]);
380 /* check bit and length ranges */
381 if(ce->bit>(CMOS_IMAGE_BUFFER_SIZE*8)) {
382 fprintf(stderr, "Error - bit is to big in line \n%s\n",line);
385 if((ce->length>(MAX_VALUE_BYTE_LENGTH*8))&&(uc!='r')) {
386 fprintf(stderr, "Error - Length is to long in line \n%s\n",line);
389 if (!is_ident((char *)ce->name)) {
391 "Error - Name %s is an invalid identifier in line\n %s\n",
395 /* put in the record type */
396 ce->tag=LB_TAG_OPTION;
397 /* calculate and save the record length */
398 len=strlen((char *)ce->name)+1;
399 /* make the record int aligned */
402 ce->size=sizeof(struct cmos_entries)-32+len;
404 cptr += ce->size; /* increment to the next table position */
405 ce = (struct cmos_entries*) cptr;
408 /* put the length of the entries into the header section */
409 entries_length = (cptr - (char *)&cmos_table) - ct->header_length;
411 /* compute the start of the enumerations section */
412 entry_start = ((char*)&cmos_table) + ct->header_length;
413 entry_end = ((char *)entry_start) + entries_length;
414 c_enums_start = c_enums = (struct cmos_enums*)entry_end;
415 /* test for overlaps in the entry records */
416 test_for_entry_overlaps(entry_start, entry_end);
418 for(;enum_mode;){ /* loop to build the enumerations section */
420 if(fgets(line,INPUT_LINE_MAX,fp)==NULL)
421 break; /* go till end of input */
423 if (strstr(line, "checksums") != 0) {
429 /* skip commented and blank lines */
430 if(line[0]=='#') continue;
431 if(line[strspn(line," ")]=='\n') continue;
433 /* scan in the data */
434 for(ptr=0;(line[ptr]==' ')||(line[ptr]=='\t');ptr++);
435 c_enums->config_id=strtol(&line[ptr],(char**)NULL,10);
436 for(;(line[ptr]!=' ')&&(line[ptr]!='\t');ptr++);
437 for(;(line[ptr]==' ')||(line[ptr]=='\t');ptr++);
438 c_enums->value=strtol(&line[ptr],(char**)NULL,10);
439 for(;(line[ptr]!=' ')&&(line[ptr]!='\t');ptr++);
440 for(;(line[ptr]==' ')||(line[ptr]=='\t');ptr++);
441 for(cnt=0;(line[ptr]!='\n')&&(cnt<31);ptr++,cnt++)
442 c_enums->text[cnt]=line[ptr];
443 c_enums->text[cnt]=0;
445 /* make the record int aligned */
449 /* store the record length */
450 c_enums->size=((char *)&c_enums->text[cnt]) - (char *)c_enums;
451 /* store the record type */
452 c_enums->tag=LB_TAG_OPTION_ENUM;
453 /* increment to the next record */
454 c_enums=(struct cmos_enums*)&c_enums->text[cnt];
456 /* save the enumerations length */
457 enum_length= (char *)c_enums - (char *)c_enums_start;
458 ct->size=ct->header_length+enum_length+entries_length;
460 /* Get the checksum records */
461 new_cs = (struct cmos_checksum *)(cmos_table+(ct->size));
462 for(;checksum_mode;) { /* This section finds the checksums */
464 if(fgets(line, INPUT_LINE_MAX,fp)==NULL)
465 break; /* end if no more input */
467 /* skip commented and blank lines */
468 if (line[0]=='#') continue;
469 if (line[strspn(line, " ")]=='\n') continue;
470 if (memcmp(line, "checksum", 8) != 0) continue;
472 /* We actually found a new cmos checksum entry */
475 /* get the information */
477 skip_spaces(line, &ptr);
478 cs->range_start = get_number(line, &ptr, 10);
480 skip_spaces(line, &ptr);
481 cs->range_end = get_number(line, &ptr, 10);
483 skip_spaces(line, &ptr);
484 cs->location = get_number(line, &ptr, 10);
486 /* Make certain there are spaces until the end of the line */
487 skip_spaces(line, &ptr);
489 if ((cs->range_start%8) != 0) {
490 fprintf(stderr, "Error - range start is not byte aligned in line\n%s\n", line);
493 if (cs->range_start >= (CMOS_IMAGE_BUFFER_SIZE*8)) {
494 fprintf(stderr, "Error - range start is to big in line\n%s\n", line);
497 if ((cs->range_end%8) != 7) {
498 fprintf(stderr, "Error - range end is not byte aligned in line\n%s\n", line);
501 if ((cs->range_end) >= (CMOS_IMAGE_BUFFER_SIZE*8)) {
502 fprintf(stderr, "Error - range end is to long in line\n%s\n", line);
505 if ((cs->location%8) != 0) {
506 fprintf(stderr, "Error - location is not byte aligned in line\n%s\n", line);
509 if ((cs->location >= (CMOS_IMAGE_BUFFER_SIZE*8)) ||
510 ((cs->location + 16) > (CMOS_IMAGE_BUFFER_SIZE*8)))
512 fprintf(stderr, "Error - location is to big in line\n%s\n", line);
516 cs->tag = LB_TAG_OPTION_CHECKSUM;
517 cs->size = sizeof(*cs);
518 cs->type = CHECKSUM_PCBIOS;
522 new_cs = (struct cmos_checksum *)cptr;
524 ct->size += (cptr - (char *)(cmos_table + ct->size));
527 /* See if we want to output a C source file */
530 snprintf(tempfilename, TMPFILE_LEN, "%s%s", dirname(strdup(option)), TMPFILE_TEMPLATE);
531 tempfile = mkstemp(tempfilename);
533 perror("Error - Could not create temporary file");
537 if((fp=fdopen(tempfile,"w"))==NULL){
538 perror("Error - Could not open temporary file");
539 unlink(tempfilename);
543 /* write the header */
544 if(fwrite("unsigned char option_table[] = {",1,32,fp) != 32) {
545 perror("Error - Could not write image file");
547 unlink(tempfilename);
550 /* write the array values */
551 for(i=0; i<(int)(ct->size-1); i++) {
552 if(!(i%10) && !err) err=(fwrite("\n\t",1,2,fp) != 2);
553 sprintf(buf,"0x%02x,",cmos_table[i]);
554 if(!err) err=(fwrite(buf,1,5,fp) != 5);
557 sprintf(buf,"0x%02x\n",cmos_table[i]);
558 if(!err) err=(fwrite(buf,1,4,fp) != 4);
559 if(fwrite("};\n",1,3,fp) != 3) {
560 perror("Error - Could not write image file");
562 unlink(tempfilename);
567 UNLINK_IF_NECESSARY(option);
568 if (rename(tempfilename, option)) {
569 fprintf(stderr, "Error - Could not write %s: ", option);
571 unlink(tempfilename);
576 /* See if we also want to output a binary file */
579 snprintf(tempfilename, TMPFILE_LEN, "%s%s", dirname(strdup(binary)), TMPFILE_TEMPLATE);
580 tempfile = mkstemp(tempfilename);
582 perror("Error - Could not create temporary file");
586 if((fp=fdopen(tempfile,"wb"))==NULL){
587 perror("Error - Could not open temporary file");
588 unlink(tempfilename);
592 /* write the array values */
593 if(fwrite(cmos_table, (int)(ct->size-1), 1, fp) != 1) {
594 perror("Error - Could not write image file");
596 unlink(tempfilename);
601 UNLINK_IF_NECESSARY(binary);
602 if (rename(tempfilename, binary)) {
603 fprintf(stderr, "Error - Could not write %s: ", binary);
605 unlink(tempfilename);
610 /* See if we also want to output a C header file */
612 struct cmos_option_table *hdr;
613 struct lb_record *ptr, *end;
615 snprintf(tempfilename, TMPFILE_LEN, "%s%s", dirname(strdup(header)), TMPFILE_TEMPLATE);
616 tempfile = mkstemp(tempfilename);
618 perror("Error - Could not create temporary file");
622 fp = fdopen(tempfile, "w");
624 perror("Error - Could not open temporary file");
625 unlink(tempfilename);
629 /* Get the cmos table header */
630 hdr = (struct cmos_option_table *)cmos_table;
631 /* Walk through the entry records */
632 ptr = (struct lb_record *)(cmos_table + hdr->header_length);
633 end = (struct lb_record *)(cmos_table + hdr->size);
634 fprintf(fp, "/* This file is autogenerated.\n"
635 " * See mainboard's cmos.layout file.\n */\n\n"
636 "#ifndef __OPTION_TABLE_H\n#define __OPTION_TABLE_H\n\n");
638 for(;ptr < end; ptr = (struct lb_record *)(((char *)ptr) + ptr->size)) {
639 if (ptr->tag != LB_TAG_OPTION) {
642 ce = (struct cmos_entries *)ptr;
644 if (!is_ident((char *)ce->name)) {
645 fprintf(stderr, "Invalid identifier: %s\n",
648 unlink(tempfilename);
651 fprintf(fp, "#define CMOS_VSTART_%s %d\n",
653 fprintf(fp, "#define CMOS_VLEN_%s %d\n",
654 ce->name, ce->length);
658 fprintf(fp, "\n#define LB_CKS_RANGE_START %d\n", cs->range_start / 8);
659 fprintf(fp, "#define LB_CKS_RANGE_END %d\n", cs->range_end / 8);
660 fprintf(fp, "#define LB_CKS_LOC %d\n", cs->location / 8);
662 fprintf(stderr, "Error - No checksums defined.\n");
664 unlink(tempfilename);
667 fprintf(fp, "\n#endif // __OPTION_TABLE_H\n");
670 UNLINK_IF_NECESSARY(header);
671 if (rename(tempfilename, header)) {
672 fprintf(stderr, "Error - Could not write %s: ", header);
674 unlink(tempfilename);