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