git.gag.com Git - fw/sdcc/blob - src/port.h

   1 /** @file port.h
   2     Definitions for what a port must provide.
   3     All ports are referenced in SDCCmain.c.
   4 */
   5 #ifndef PORT_INCLUDE
   6 #define PORT_INCLUDE
   7
   8 /* Processor specific names */
   9 typedef struct {
  10     /** Target name used for -m */
  11     const char *target;
  12
  13     /** Target name string, used for --help */
  14     const char *target_name;
  15
  16     struct {
  17         /** TRUE if all types of glue functions should be inseted into
  18             the file that also defines main.
  19             We dont want this in cases like the z80 where the startup
  20             code is provided by a seperate module.
  21         */
  22         bool glue_up_main;
  23     } general;
  24
  25     /* assembler related information */
  26     struct {
  27         /** Command to run and arguments (eg as-z80) */
  28         const char **cmd;
  29         /** Arguments for debug mode.  PENDING: ignored */
  30         const char *debug_opts;
  31         /** Arguments for normal assembly mode.  PENDING: ignored */
  32         const char *plain_opts;
  33     } assembler;
  34
  35     /* linker related info */
  36     struct {
  37         /** Command to run (eg link-z80) */
  38         const char **cmd;
  39     } linker;
  40
  41     struct {
  42         /** Default peephole rules */
  43         char *default_rules;
  44     } peep;
  45
  46     /** Basic type sizes */
  47     struct {
  48         int char_size;
  49         int short_size;
  50         int int_size;
  51         int long_size;
  52         int ptr_size;
  53         int fptr_size;
  54         int gptr_size;
  55         int bit_size;
  56         int float_size;
  57         int max_base_size;
  58     } s;
  59
  60     /** Names for all the memory regions */
  61     struct {
  62         const char *xstack_name;
  63         const char *istack_name;
  64         const char *code_name;
  65         const char *data_name;
  66         const char *idata_name;
  67         const char *xdata_name;
  68         const char *bit_name;
  69         const char *reg_name;
  70         const char *static_name;
  71         const char *overlay_name;
  72     } mem;
  73
  74     /* stack related information */
  75     struct {
  76         /** -1 for grows down (z80), +1 for grows up (mcs51) */
  77         int direction;
  78         /** Extra overhead when calling between banks */
  79         int bank_overhead;
  80         /** Extra overhead when the function is an ISR */
  81         int isr_overhead;
  82         /** Standard overhead for a function call */
  83         int call_overhead;
  84         /** Re-enterant space */
  85         int reent_overhead;
  86
  87     } stack;
  88     struct {
  89         /** One more than the smallest
  90             mul/div operation the processor can do nativley
  91             Eg if the processor has an 8 bit mul, nativebelow is 2 */
  92         int native_below;
  93     } muldiv;
  94
  95     /** Called once the processor target has been selected.
  96         First chance to initalise and set any port specific varibles.
  97         'port' is set before calling this.  May be NULL.
  98     */
  99     void (*init)(void);
 100     /** Parses one option + its arguments */
 101     bool (*parseOption)(int *pargc, char **argv, int *i);
 102     /** Called after all the options have been parsed. */
 103     void (*finaliseOptions)(void);
 104     /** Called after the port has been selected but before any
 105         options are parsed. */
 106     void (*setDefaultOptions)(void);
 107     /** Does the dirty work. */
 108     void (*assignRegisters)(eBBlock **, int);
 109
 110     /** Returns the register name of a symbol.
 111         Used so that 'regs' can be an incomplete type. */
 112     const char *(*getRegName)(struct regs *reg);
 113
 114     /* list of keywords that are used by this
 115        target (used by lexer) */
 116     char **keywords;
 117
 118     /* Write any port specific assembler output. */
 119     void (*genAssemblerPreamble)(FILE *of);
 120
 121     /* Write the port specific IVT. If genIVT is NULL or if
 122      * it returns zero, default (8051) IVT generation code
 123      * will be used.
 124      */
 125     int (*genIVT)(FILE *of, symbol **intTable, int intCount);
 126 } PORT;
 127
 128 extern PORT *port;
 129
 130 #endif