root/dev/microcode/aic7xxx/aicasm_symbol.c

DEFINITIONS

1. symbol_create
2. symbol_delete
3. symtable_open
4. symtable_close
5. symtable_get
6. symlist_search
7. symlist_add
8. symlist_free
9. symlist_merge
10. aic_print_file_prologue
11. aic_print_include
12. aic_print_reg_dump_types
13. aic_print_reg_dump_start
14. aic_print_reg_dump_end
15. aic_print_reg_dump_entry
16. symtable_dump

    1 /* $OpenBSD: aicasm_symbol.c,v 1.9 2003/12/24 23:27:55 krw Exp $ */
    2 /*      $NetBSD: aicasm_symbol.c,v 1.4 2003/07/14 15:42:40 lukem Exp $  */
    4 /*
    5  * Aic7xxx SCSI host adapter firmware asssembler symbol table implementation
    6  *
    7  * Copyright (c) 1997 Justin T. Gibbs.
    8  * Copyright (c) 2002 Adaptec Inc.
    9  * All rights reserved.
   10  *
   11  * Redistribution and use in source and binary forms, with or without
   12  * modification, are permitted provided that the following conditions
   13  * are met:
   14  * 1. Redistributions of source code must retain the above copyright
   15  *    notice, this list of conditions, and the following disclaimer,
   16  *    without modification.
   17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
   18  *    substantially similar to the "NO WARRANTY" disclaimer below
   19  *    ("Disclaimer") and any redistribution must be conditioned upon
   20  *    including a substantially similar Disclaimer requirement for further
   21  *    binary redistribution.
   22  * 3. Neither the names of the above-listed copyright holders nor the names
   23  *    of any contributors may be used to endorse or promote products derived
   24  *    from this software without specific prior written permission.
   25  *
   26  * Alternatively, this software may be distributed under the terms of the
   27  * GNU General Public License ("GPL") version 2 as published by the Free
   28  * Software Foundation.
   29  *
   30  * NO WARRANTY
   31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
   34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
   39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
   40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   41  * POSSIBILITY OF SUCH DAMAGES.
   42  *
   43  * $FreeBSD: src/sys/dev/aic7xxx/aicasm/aicasm_symbol.c,v 1.23 2003/01/20 18:01:37 gibbs Exp $
   44  */
   46 #include <sys/cdefs.h>
   47 /* __RCSID("$NetBSD: aicasm_symbol.c,v 1.4 2003/07/14 15:42:40 lukem Exp $"); */
   49 #include <sys/types.h>
   51 #ifdef __linux__
   52 #include "aicdb.h"
   53 #else
   54 #include <db.h>
   55 #endif
   56 #include <fcntl.h>
   57 #include <inttypes.h>
   58 #include <regex.h>
   59 #include <stdio.h>
   60 #include <stdlib.h>
   61 #include <string.h>
   62 #include <sysexits.h>
   64 #include "aicasm_symbol.h"
   65 #include "aicasm.h"
   67 static DB *symtable;
symbol_t *
symbol_create(char *name)
   71 {
symbol_t *new_symbol;
new_symbol = (symbol_t *)malloc(sizeof(symbol_t));
   75         if (new_symbol == NULL) {
perror("Unable to create new symbol");
exit(EX_SOFTWARE);
   78         }
memset(new_symbol, 0, sizeof(*new_symbol));
new_symbol->name = strdup(name);
   81         if (new_symbol->name == NULL)
stop("Unable to strdup symbol name", EX_SOFTWARE);
new_symbol->type = UNINITIALIZED;
   84         return (new_symbol);
   85 }
   87 void
symbol_delete(symbol_t *symbol)
   89 {
   90         if (symtable != NULL) {
DBT      key;
key.data = symbol->name;
key.size = strlen(symbol->name);
symtable->del(symtable, &key, /*flags*/0);
   96         }
   97         switch(symbol->type) {
   98         case SCBLOC:
   99         case SRAMLOC:
  100         case REGISTER:
  101                 if (symbol->info.rinfo != NULL)
free(symbol->info.rinfo);
  103                 break;
  104         case ALIAS:
  105                 if (symbol->info.ainfo != NULL)
free(symbol->info.ainfo);
  107                 break;
  108         case MASK:
  109         case FIELD:
  110         case ENUM:
  111         case ENUM_ENTRY:
  112                 if (symbol->info.finfo != NULL) {
symlist_free(&symbol->info.finfo->symrefs);
free(symbol->info.finfo);
  115                 }
  116                 break;
  117         case DOWNLOAD_CONST:
  118         case CONST:
  119                 if (symbol->info.cinfo != NULL)
free(symbol->info.cinfo);
  121                 break;
  122         case LABEL:
  123                 if (symbol->info.linfo != NULL)
free(symbol->info.linfo);
  125                 break;
  126         case UNINITIALIZED:
  127         default:
  128                 break;
  129         }
free(symbol->name);
free(symbol);
  132 }
  134 void
symtable_open()
  136 {
symtable = dbopen(/*filename*/NULL,
O_CREAT | O_NONBLOCK | O_RDWR, /*mode*/0, DB_HASH,
  139                           /*openinfo*/NULL);
  141         if (symtable == NULL) {
perror("Symbol table creation failed");
exit(EX_SOFTWARE);
  144                 /* NOTREACHED */
  145         }
  146 }
  148 void
symtable_close()
  150 {
  151         if (symtable != NULL) {
DBT      key;
DBT      data;
  155                 while (symtable->seq(symtable, &key, &data, R_FIRST) == 0) {
symbol_t *stored_ptr;
memcpy(&stored_ptr, data.data, sizeof(stored_ptr));
symbol_delete(stored_ptr);
  160                 }
symtable->close(symtable);
  162         }
  163 }
  165 /*
  166  * The semantics of get is to return an uninitialized symbol entry
  167  * if a lookup fails.
  168  */
symbol_t *
symtable_get(char *name)
  171 {
symbol_t *stored_ptr;
DBT       key;
DBT       data;
  175         int       retval;
key.data = (void *)name;
key.size = strlen(name);
  180         if ((retval = symtable->get(symtable, &key, &data, /*flags*/0)) != 0) {
  181                 if (retval == -1) {
perror("Symbol table get operation failed");
exit(EX_SOFTWARE);
  184                         /* NOTREACHED */
  185                 } else if (retval == 1) {
  186                         /* Symbol wasn't found, so create a new one */
symbol_t *new_symbol;
new_symbol = symbol_create(name);
data.data = &new_symbol;
data.size = sizeof(new_symbol);
  192                         if (symtable->put(symtable, &key, &data,
  193                                           /*flags*/0) !=0) {
perror("Symtable put failed");
exit(EX_SOFTWARE);
  196                         }
  197                         return (new_symbol);
  198                 } else {
perror("Unexpected return value from db get routine");
exit(EX_SOFTWARE);
  201                         /* NOTREACHED */
  202                 }
  203         }
memcpy(&stored_ptr, data.data, sizeof(stored_ptr));
  205         return (stored_ptr);
  206 }
symbol_node_t *
symlist_search(symlist_t *symlist, char *symname)
  210 {
symbol_node_t *curnode;
curnode = SLIST_FIRST(symlist);
  214         while(curnode != NULL) {
  215                 if (strcmp(symname, curnode->symbol->name) == 0)
  216                         break;
curnode = SLIST_NEXT(curnode, links);
  218         }
  219         return (curnode);
  220 }
  222 void
symlist_add(symlist_t *symlist, symbol_t *symbol, int how)
  224 {
symbol_node_t *newnode;
newnode = (symbol_node_t *)malloc(sizeof(symbol_node_t));
  228         if (newnode == NULL) {
stop("symlist_add: Unable to malloc symbol_node", EX_SOFTWARE);
  230                 /* NOTREACHED */
  231         }
newnode->symbol = symbol;
  233         if (how == SYMLIST_SORT) {
symbol_node_t *curnode;
  235                 int field;
field = FALSE;
  238                 switch(symbol->type) {
  239                 case REGISTER:
  240                 case SCBLOC:
  241                 case SRAMLOC:
  242                         break;
  243                 case FIELD:
  244                 case MASK:
  245                 case ENUM:
  246                 case ENUM_ENTRY:
field = TRUE;
  248                         break;
  249                 default:
stop("symlist_add: Invalid symbol type for sorting",
EX_SOFTWARE);
  252                         /* NOTREACHED */
  253                 }
curnode = SLIST_FIRST(symlist);
  256                 if (curnode == NULL
  257                  || (field
  258                   && (curnode->symbol->type > newnode->symbol->type
  259                    || (curnode->symbol->type == newnode->symbol->type
  260                     && (curnode->symbol->info.finfo->value >
newnode->symbol->info.finfo->value))))
  262                  || (!field && (curnode->symbol->info.rinfo->address >
newnode->symbol->info.rinfo->address))) {
SLIST_INSERT_HEAD(symlist, newnode, links);
  265                         return;
  266                 }
  268                 while (1) {
  269                         if (SLIST_NEXT(curnode, links) == NULL) {
SLIST_INSERT_AFTER(curnode, newnode,
links);
  272                                 break;
  273                         } else {
symbol_t *cursymbol;
cursymbol = SLIST_NEXT(curnode, links)->symbol;
  277                                 if ((field
  278                                   && (cursymbol->type > symbol->type
  279                                    || (cursymbol->type == symbol->type
  280                                     && (cursymbol->info.finfo->value >
symbol->info.finfo->value))))
  282                                  || (!field
  283                                    && (cursymbol->info.rinfo->address >
symbol->info.rinfo->address))) {
SLIST_INSERT_AFTER(curnode, newnode,
links);
  287                                         break;
  288                                 }
  289                         }
curnode = SLIST_NEXT(curnode, links);
  291                 }
  292         } else {
SLIST_INSERT_HEAD(symlist, newnode, links);
  294         }
  295 }
  297 void
symlist_free(symlist_t *symlist)
  299 {
symbol_node_t *node1, *node2;
node1 = SLIST_FIRST(symlist);
  303         while (node1 != NULL) {
node2 = SLIST_NEXT(node1, links);
free(node1);
node1 = node2;
  307         }
SLIST_INIT(symlist);
  309 }
  311 void
symlist_merge(symlist_t *symlist_dest, symlist_t *symlist_src1,
symlist_t *symlist_src2)
  314 {
symbol_node_t *node;
  317         *symlist_dest = *symlist_src1;
  318         while((node = SLIST_FIRST(symlist_src2)) != NULL) {
SLIST_REMOVE_HEAD(symlist_src2, links);
SLIST_INSERT_HEAD(symlist_dest, node, links);
  321         }
  323         /* These are now empty */
SLIST_INIT(symlist_src1);
SLIST_INIT(symlist_src2);
  326 }
  328 void
aic_print_file_prologue(FILE *ofile)
  330 {
  332         if (ofile == NULL)
  333                 return;
fprintf(ofile,
  336 "/*\n"
  337 " * DO NOT EDIT - This file is automatically generated\n"
  338 " *              from the following source files:\n"
  339 " *\n"
  340 "%s */\n",
versions);
  342 }
  344 void
aic_print_include(FILE *dfile, char *include_file)
  346 {
  348         if (dfile == NULL)
  349                 return;
fprintf(dfile, "\n#include \"%s\"\n\n", include_file);
  351 }
  353 void
aic_print_reg_dump_types(FILE *ofile)
  355 {
  356         if (ofile == NULL)
  357                 return;
fprintf(ofile,
  360 "typedef int (%sreg_print_t)(u_int, u_int *, u_int);\n"
  361 "typedef struct %sreg_parse_entry {\n"
  362 "       char    *name;\n"
  363 "       uint8_t  value;\n"
  364 "       uint8_t  mask;\n"
  365 "} %sreg_parse_entry_t;\n"
  366 "\n",
prefix, prefix, prefix);
  368 }
  370 static void
aic_print_reg_dump_start(FILE *dfile, symbol_node_t *regnode)
  372 {
  373         if (dfile == NULL)
  374                 return;
fprintf(dfile,
  377 "static %sreg_parse_entry_t %s_parse_table[] = {\n",
prefix,
regnode->symbol->name);
  380 }
  382 static void
aic_print_reg_dump_end(FILE *ofile, FILE *dfile,
symbol_node_t *regnode, u_int num_entries)
  385 {
  386         char *lower_name;
  387         char *letter;
lower_name = strdup(regnode->symbol->name);
  390         if (lower_name == NULL)
stop("Unable to strdup symbol name", EX_SOFTWARE);
  393         for (letter = lower_name; *letter != '\0'; letter++)
  394                 *letter = tolower(*letter);
  396         if (dfile != NULL) {
  397                 if (num_entries != 0)
fprintf(dfile,
  399 "\n"
  400 "};\n"
  401 "\n");
fprintf(dfile,
  404 "int\n"
  405 "%s%s_print(u_int regvalue, u_int *cur_col, u_int wrap)\n"
  406 "{\n"
  407 "       return (%sprint_register(%s%s, %d, \"%s\",\n"
  408 "           0x%02x, regvalue, cur_col, wrap));\n"
  409 "}\n"
  410 "\n",
prefix,
lower_name,
prefix,
num_entries != 0 ? regnode->symbol->name : "NULL",
num_entries != 0 ? "_parse_table" : "",
num_entries,
regnode->symbol->name,
regnode->symbol->info.rinfo->address);
  419         }
fprintf(ofile,
  422 "#if AIC_DEBUG_REGISTERS\n"
  423 "%sreg_print_t %s%s_print;\n"
  424 "#else\n"
  425 "#define %s%s_print(regvalue, cur_col, wrap) \\\n"
  426 "    %sprint_register(NULL, 0, \"%s\", 0x%02x, regvalue, cur_col, wrap)\n"
  427 "#endif\n"
  428 "\n",
prefix,
prefix,
lower_name,
prefix,
lower_name,
prefix,
regnode->symbol->name,
regnode->symbol->info.rinfo->address);
  437 }
  439 static void
aic_print_reg_dump_entry(FILE *dfile, symbol_node_t *curnode)
  441 {
  442         int num_tabs;
  444         if (dfile == NULL)
  445                 return;
fprintf(dfile,
  448 "       { \"%s\",",
curnode->symbol->name);
num_tabs = 3 - (strlen(curnode->symbol->name) + 5) / 8;
  453         while (num_tabs-- > 0)
fputc('\t', dfile);
fprintf(dfile, "0x%02x, 0x%02x }",
curnode->symbol->info.finfo->value,
curnode->symbol->info.finfo->mask);
  458 }
  460 void
symtable_dump(FILE *ofile, FILE *dfile)
  462 {
  463         /*
  464          * Sort the registers by address with a simple insertion sort.
  465          * Put bitmasks next to the first register that defines them.
  466          * Put constants at the end.
  467          */
symlist_t        registers;
symlist_t        masks;
symlist_t        constants;
symlist_t        download_constants;
symlist_t        aliases;
symlist_t        exported_labels;
symbol_node_t   *curnode;
symbol_node_t   *regnode;
DBT              key;
DBT              data;
  478         int              flag;
u_int            i;
  481         if (symtable == NULL)
  482                 return;
SLIST_INIT(&registers);
SLIST_INIT(&masks);
SLIST_INIT(&constants);
SLIST_INIT(&download_constants);
SLIST_INIT(&aliases);
SLIST_INIT(&exported_labels);
flag = R_FIRST;
  491         while (symtable->seq(symtable, &key, &data, flag) == 0) {
symbol_t *cursym;
memcpy(&cursym, data.data, sizeof(cursym));
  495                 switch(cursym->type) {
  496                 case REGISTER:
  497                 case SCBLOC:
  498                 case SRAMLOC:
symlist_add(&registers, cursym, SYMLIST_SORT);
  500                         break;
  501                 case MASK:
  502                 case FIELD:
  503                 case ENUM:
  504                 case ENUM_ENTRY:
symlist_add(&masks, cursym, SYMLIST_SORT);
  506                         break;
  507                 case CONST:
symlist_add(&constants, cursym,
SYMLIST_INSERT_HEAD);
  510                         break;
  511                 case DOWNLOAD_CONST:
symlist_add(&download_constants, cursym,
SYMLIST_INSERT_HEAD);
  514                         break;
  515                 case ALIAS:
symlist_add(&aliases, cursym,
SYMLIST_INSERT_HEAD);
  518                         break;
  519                 case LABEL:
  520                         if (cursym->info.linfo->exported == 0)
  521                                 break;
symlist_add(&exported_labels, cursym,
SYMLIST_INSERT_HEAD);
  524                         break;
  525                 default:
  526                         break;
  527                 }
flag = R_NEXT;
  529         }
  531         /* Register dianostic functions/declarations first. */
aic_print_file_prologue(ofile);
aic_print_reg_dump_types(ofile);
aic_print_file_prologue(dfile);
aic_print_include(dfile, stock_include_file);
SLIST_FOREACH(curnode, &registers, links) {
  538                 switch(curnode->symbol->type) {
  539                 case REGISTER:
  540                 case SCBLOC:
  541                 case SRAMLOC:
  542                 {
symlist_t       *fields;
symbol_node_t   *fieldnode;
  545                         int              num_entries;
num_entries = 0;
fields = &curnode->symbol->info.rinfo->fields;
SLIST_FOREACH(fieldnode, fields, links) {
  550                                 if (num_entries == 0)
aic_print_reg_dump_start(dfile,
curnode);
  553                                 else if (dfile != NULL)
fputs(",\n", dfile);
num_entries++;
aic_print_reg_dump_entry(dfile, fieldnode);
  557                         }
aic_print_reg_dump_end(ofile, dfile,
curnode, num_entries);
  560                 }
  561                 default:
  562                         break;
  563                 }
  564         }
  566         /* Fold in the masks and bits */
  567         while (SLIST_FIRST(&masks) != NULL) {
  568                 char *regname;
curnode = SLIST_FIRST(&masks);
SLIST_REMOVE_HEAD(&masks, links);
regnode = SLIST_FIRST(&curnode->symbol->info.finfo->symrefs);
regname = regnode->symbol->name;
regnode = symlist_search(&registers, regname);
SLIST_INSERT_AFTER(regnode, curnode, links);
  577         }
  579         /* Add the aliases */
  580         while (SLIST_FIRST(&aliases) != NULL) {
  581                 char *regname;
curnode = SLIST_FIRST(&aliases);
SLIST_REMOVE_HEAD(&aliases, links);
regname = curnode->symbol->info.ainfo->parent->name;
regnode = symlist_search(&registers, regname);
SLIST_INSERT_AFTER(regnode, curnode, links);
  589         }
  591         /* Output generated #defines. */
  592         while (SLIST_FIRST(&registers) != NULL) {
symbol_node_t *curnode;
u_int value;
  595                 char *tab_str;
  596                 char *tab_str2;
curnode = SLIST_FIRST(&registers);
SLIST_REMOVE_HEAD(&registers, links);
  600                 switch(curnode->symbol->type) {
  601                 case REGISTER:
  602                 case SCBLOC:
  603                 case SRAMLOC:
fprintf(ofile, "\n");
value = curnode->symbol->info.rinfo->address;
tab_str = "\t";
tab_str2 = "\t\t";
  608                         break;
  609                 case ALIAS:
  610                 {
symbol_t *parent;
parent = curnode->symbol->info.ainfo->parent;
value = parent->info.rinfo->address;
tab_str = "\t";
tab_str2 = "\t\t";
  617                         break;
  618                 }
  619                 case MASK:
  620                 case FIELD:
  621                 case ENUM:
  622                 case ENUM_ENTRY:
value = curnode->symbol->info.finfo->value;
tab_str = "\t\t";
tab_str2 = "\t";
  626                         break;
  627                 default:
value = 0; /* Quiet compiler */
tab_str = NULL;
tab_str2 = NULL;
stop("symtable_dump: Invalid symbol type "
  632                              "encountered", EX_SOFTWARE);
  633                         break;
  634                 }
fprintf(ofile, "#define%s%-16s%s0x%02x\n",
tab_str, curnode->symbol->name, tab_str2,
value);
free(curnode);
  639         }
fprintf(ofile, "\n\n");
  642         while (SLIST_FIRST(&constants) != NULL) {
symbol_node_t *curnode;
curnode = SLIST_FIRST(&constants);
SLIST_REMOVE_HEAD(&constants, links);
fprintf(ofile, "#define\t%-8s\t0x%02x\n",
curnode->symbol->name,
curnode->symbol->info.cinfo->value);
free(curnode);
  651         }
fprintf(ofile, "\n\n/* Downloaded Constant Definitions */\n");
  656         for (i = 0; SLIST_FIRST(&download_constants) != NULL; i++) {
symbol_node_t *curnode;
curnode = SLIST_FIRST(&download_constants);
SLIST_REMOVE_HEAD(&download_constants, links);
fprintf(ofile, "#define\t%-8s\t0x%02x\n",
curnode->symbol->name,
curnode->symbol->info.cinfo->value);
free(curnode);
  665         }
fprintf(ofile, "#define\tDOWNLOAD_CONST_COUNT\t0x%02x\n", i);
fprintf(ofile, "\n\n/* Exported Labels */\n");
  670         while (SLIST_FIRST(&exported_labels) != NULL) {
symbol_node_t *curnode;
curnode = SLIST_FIRST(&exported_labels);
SLIST_REMOVE_HEAD(&exported_labels, links);
fprintf(ofile, "#define\tLABEL_%-8s\t0x%02x\n",
curnode->symbol->name,
curnode->symbol->info.linfo->address);
free(curnode);
  679         }
  680 }