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 #include "SDCCicode.h"
   9 #include "SDCCargs.h"
  10
  11 #define TARGET_ID_MCS51    1
  12 #define TARGET_ID_GBZ80    2
  13 #define TARGET_ID_Z80      3
  14 #define TARGET_ID_AVR      4
  15 #define TARGET_ID_DS390    5
  16 #define TARGET_ID_PIC      6
  17 #define TARGET_ID_PIC16    7
  18 #define TARGET_ID_XA51     9
  19 #define TARGET_ID_DS400    10
  20
  21 /* Macro to test the target we are compiling for.
  22    Can only be used after SDCCmain has defined the port
  23 */
  24 #define TARGET_IS_MCS51 (port->id==TARGET_ID_MCS51)
  25 #define TARGET_IS_GBZ80 (port->id==TARGET_ID_GBZ80)
  26 #define TARGET_IS_Z80 (port->id==TARGET_ID_Z80)
  27 #define TARGET_IS_AVR (port->id==TARGET_ID_AVR)
  28 #define TARGET_IS_DS390 (port->id==TARGET_ID_DS390)
  29 #define TARGET_IS_DS400 (port->id==TARGET_ID_DS400)
  30 #define TARGET_IS_PIC   (port->id==TARGET_ID_PIC)
  31 #define TARGET_IS_PIC16 (port->id==TARGET_ID_PIC16)
  32 #define TARGET_IS_XA51 (port->id==TARGET_ID_XA51)
  33
  34 #define MAX_BUILTIN_ARGS        16
  35 /* definition of builtin functions */
  36 typedef struct builtins
  37 {
  38     char *name ;                /* name of builtin function */
  39     char *rtype;                /* return type as string : see typefromStr */
  40     int  nParms;                /* number of parms : max 8 */
  41     char *parm_types[MAX_BUILTIN_ARGS]; /* each parm type as string : see typeFromStr */
  42 } builtins ;
  43
  44 /* Processor specific names */
  45 typedef struct
  46   {
  47 /** Unique id for this target */
  48     const int id;
  49 /** Target name used for -m */
  50     const char *target;
  51
  52 /** Target name string, used for --help */
  53     const char *target_name;
  54
  55 /** Specific processor for the given target family. specified by -p */
  56     char *processor;
  57
  58     struct
  59       {
  60         /** TRUE if all types of glue functions should be inserted into
  61             the file that also defines main.
  62             We dont want this in cases like the z80 where the startup
  63             code is provided by a seperate module.
  64         */
  65         bool glue_up_main;
  66         /* OR of MODEL_* */
  67         int supported_models;
  68         int default_model;
  69       }
  70     general;
  71
  72     /* assembler related information */
  73     struct
  74       {
  75         /** Command to run and arguments (eg as-z80) */
  76         const char **cmd;
  77         /** Alternate macro based form. */
  78         const char *mcmd;
  79         /** Arguments for debug mode. */
  80         const char *debug_opts;
  81         /** Arguments for normal assembly mode. */
  82         const char *plain_opts;
  83         /* print externs as global */
  84         int externGlobal;
  85         /* assembler file extension */
  86         const char *file_ext;
  87         /** If non-null will be used to execute the assembler. */
  88         void (*do_assemble) (set *);
  89       }
  90     assembler;
  91
  92     /* linker related info */
  93     struct
  94       {
  95         /** Command to run (eg link-z80) */
  96         const char **cmd;
  97         /** Alternate macro based form. */
  98         const char *mcmd;
  99         /** If non-null will be used to execute the link. */
 100         void (*do_link) (void);
 101         /** Extension for object files (.rel, .obj, ...) */
 102         const char *rel_ext;
 103       }
 104     linker;
 105
 106     struct
 107       {
 108 /** Default peephole rules */
 109         char *default_rules;
 110       }
 111     peep;
 112
 113 /** Basic type sizes */
 114     struct
 115       {
 116         int char_size;
 117         int short_size;
 118         int int_size;
 119         int long_size;
 120         int ptr_size;
 121         int fptr_size;
 122         int gptr_size;
 123         int bit_size;
 124         int float_size;
 125         int max_base_size;
 126       }
 127     s;
 128
 129 /** memory regions related stuff */
 130     struct
 131       {
 132         const char *xstack_name;
 133         const char *istack_name;
 134         const char *code_name;
 135         const char *data_name;
 136         const char *idata_name;
 137         const char *xdata_name;
 138         const char *bit_name;
 139         const char *reg_name;
 140         const char *static_name;
 141         const char *overlay_name;
 142         const char *post_static_name;
 143         const char *home_name;
 144         const char *xidata_name; // initialized xdata
 145         const char *xinit_name; // a code copy of xidata
 146         struct memmap *default_local_map; // default location for auto vars
 147         struct memmap *default_globl_map; // default location for globl vars
 148         int code_ro;            /* code space read-only 1=yes */
 149       }
 150     mem;
 151
 152     /* stack related information */
 153     struct
 154       {
 155 /** -1 for grows down (z80), +1 for grows up (mcs51) */
 156         int direction;
 157 /** Extra overhead when calling between banks */
 158         int bank_overhead;
 159 /** Extra overhead when the function is an ISR */
 160         int isr_overhead;
 161 /** Standard overhead for a function call */
 162         int call_overhead;
 163 /** Re-enterant space */
 164         int reent_overhead;
 165         /** 'banked' call overhead.
 166             Mild overlap with bank_overhead */
 167         int banked_overhead;
 168       }
 169     stack;
 170
 171     struct
 172       {
 173         /** One more than the smallest
 174             mul/div operation the processor can do nativley
 175             Eg if the processor has an 8 bit mul, nativebelow is 2 */
 176         unsigned muldiv;
 177         unsigned shift;
 178       }
 179     support;
 180
 181 /** Prefix to add to a C function (eg "_") */
 182     const char *fun_prefix;
 183
 184     /** Called once the processor target has been selected.
 185         First chance to initalise and set any port specific variables.
 186         'port' is set before calling this.  May be NULL.
 187     */
 188     void (*init) (void);
 189 /** Parses one option + its arguments */
 190       bool (*parseOption) (int *pargc, char **argv, int *i);
 191 /** Optional list of automatically parsed options.  Should be
 192     implemented to at least show the help text correctly. */
 193     OPTION *poptions;
 194 /** Called after all the options have been parsed. */
 195     void (*finaliseOptions) (void);
 196     /** Called after the port has been selected but before any
 197         options are parsed. */
 198     void (*setDefaultOptions) (void);
 199 /** Does the dirty work. */
 200     void (*assignRegisters) (struct eBBlock **, int);
 201
 202     /** Returns the register name of a symbol.
 203         Used so that 'regs' can be an incomplete type. */
 204     const char *(*getRegName) (struct regs * reg);
 205
 206     /* list of keywords that are used by this
 207        target (used by lexer) */
 208     char **keywords;
 209
 210     /* Write any port specific assembler output. */
 211     void (*genAssemblerPreamble) (FILE * of);
 212       /* invoked at end assembler file */
 213     void (*genAssemblerEnd) (FILE * of);
 214
 215     /* Write the port specific IVT. If genIVT is NULL or if
 216      * it returns zero, default (8051) IVT generation code
 217      * will be used.
 218      */
 219     int (*genIVT) (FILE * of, symbol ** intTable, int intCount);
 220
 221     void (*genXINIT) (FILE * of);
 222
 223     /* parameter passing in register related functions */
 224     void (*reset_regparms) ();  /* reset the register count */
 225     int (*reg_parm) (struct sym_link *);        /* will return 1 if can be passed in register */
 226
 227     /** Process the pragma string 'sz'.  Returns 0 if recognised and
 228         processed, 1 otherwise.  May be NULL.
 229     */
 230     int (*process_pragma) (const char *sz);
 231
 232     /** Mangles a support function name to reflect the calling model.
 233      */
 234     char *(*getMangledFunctionName) (char *szOrginial);
 235
 236     /** Returns true if the port can multiply the two types nativly
 237         without using support functions.
 238     */
 239     bool (*hasNativeMulFor) (iCode *ic, sym_link *left, sym_link *right);
 240
 241     /** If TRUE, then tprintf and !dw will be used for some initalisers
 242      */
 243     bool use_dw_for_init;
 244
 245     /* condition transformations */
 246     bool lt_nge;                /* transform (a < b)  to !(a >= b)  */
 247     bool gt_nle;                /* transform (a > b)  to !(a <= b)  */
 248     bool le_ngt;                /* transform (a <= b) to !(a > b)   */
 249     bool ge_nlt;                /* transform (a >= b) to !(a < b)   */
 250     bool ne_neq;                /* transform a != b --> ! (a == b)  */
 251     bool eq_nne;                /* transform a == b --> ! (a != b)  */
 252
 253     bool arrayInitializerSuppported;
 254     bool (*cseOk) (iCode *ic, iCode *pdic);
 255     builtins *builtintable;     /* table of builtin functions */
 256     int unqualified_pointer;    /* unqualified pointers type is  */
 257     int reset_labelKey  ;       /* reset Label no 1 at the start of a function */
 258     int globals_allowed ;       /* global & static locals not allowed ?  0 ONLY TININative*/
 259 #define PORT_MAGIC 0xAC32
 260 /** Used at runtime to detect if this structure has been completly filled in. */
 261     int magic;
 262   }
 263 PORT;
 264
 265 extern PORT *port;
 266
 267 #if !OPT_DISABLE_MCS51
 268 extern PORT mcs51_port;
 269 #endif
 270 #if !OPT_DISABLE_GBZ80
 271 extern PORT gbz80_port;
 272 #endif
 273 #if !OPT_DISABLE_Z80
 274 extern PORT z80_port;
 275 #endif
 276 #if !OPT_DISABLE_AVR
 277 extern PORT avr_port;
 278 #endif
 279 #if !OPT_DISABLE_DS390
 280 extern PORT ds390_port;
 281 #endif
 282 #if !OPT_DISABLE_PIC
 283 extern PORT pic_port;
 284 #endif
 285 #if !OPT_DISABLE_PIC16
 286 extern PORT pic16_port;
 287 #endif
 288 #if !OPT_DISABLE_TININative
 289 extern PORT tininative_port;
 290 #endif
 291 #if !OPT_DISABLE_XA51
 292 extern PORT xa51_port;
 293 #endif
 294 #if !OPT_DISABLE_DS400
 295 extern PORT ds400_port;
 296 #endif
 297
 298 #define DEFAULT_PORT    pic16_port
 299
 300 #endif /* PORT_INCLUDE*/