2 Definitions for what a port must provide.
3 All ports are referenced in SDCCmain.c.
10 #include "SDCCpeeph.h"
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
23 /* Macro to test the target we are compiling for.
24 Can only be used after SDCCmain has defined the port
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)
37 #define MAX_BUILTIN_ARGS 16
38 /* definition of builtin functions */
39 typedef struct builtins
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 */
47 /* Processor specific names */
50 /** Unique id for this target */
52 /** Target name used for -m */
55 /** Target name string, used for --help */
56 const char *target_name;
58 /** Specific processor for the given target family. specified by -p */
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.
77 /* assembler related information */
80 /** Command to run and arguments (eg as-z80) */
82 /** Alternate macro based form. */
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 */
90 /* assembler file extension */
92 /** If non-null will be used to execute the assembler. */
93 void (*do_assemble) (set *);
97 /* linker related info */
100 /** Command to run (eg link-z80) */
102 /** Alternate macro based form. */
104 /** If non-null will be used to execute the link. */
105 void (*do_link) (void);
106 /** Extension for object files (.rel, .obj, ...) */
108 /** 1 if port needs the .lnk file, 0 otherwise */
109 const int needLinkerScript;
115 /** Default peephole rules */
117 int (*getSize)(lineNode *line);
118 bitVect * (*getRegsRead)(lineNode *line);
119 bitVect * (*getRegsWritten)(lineNode *line);
123 /** Basic type sizes */
139 /** memory regions related stuff */
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 */
164 void (*genExtraAreaDeclaration)(FILE *, bool);
165 void (*genExtraAreaLinkOptions)(FILE *);
169 /* stack related information */
172 /** -1 for grows down (z80), +1 for grows up (mcs51) */
174 /** Extra overhead when calling between banks */
176 /** Extra overhead when the function is an ISR */
178 /** Standard overhead for a function call */
180 /** Re-enterant space */
182 /** 'banked' call overhead.
183 Mild overlap with bank_overhead */
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 */
200 void (*emitDebuggerSymbol) (char *);
203 int (*regNum) (struct regs *);
220 int sizeofMatchJump[3];
221 int sizeofRangeCompare[3];
227 /** Prefix to add to a C function (eg "_") */
228 const char *fun_prefix;
230 /** Called once the processor target has been selected.
231 First chance to initalise and set any port specific variables.
232 'port' is set before calling this. May be NULL.
235 /** Parses one option + its arguments */
236 bool (*parseOption) (int *pargc, char **argv, int *i);
237 /** Optional list of automatically parsed options. Should be
238 implemented to at least show the help text correctly. */
240 /** Initialise port spectific paths */
241 void (*initPaths)(void);
242 /** Called after all the options have been parsed. */
243 void (*finaliseOptions) (void);
244 /** Called after the port has been selected but before any
245 options are parsed. */
246 void (*setDefaultOptions) (void);
247 /** Does the dirty work. */
248 void (*assignRegisters) (struct eBBlock **, int);
250 /** Returns the register name of a symbol.
251 Used so that 'regs' can be an incomplete type. */
252 const char *(*getRegName) (struct regs * reg);
254 /* list of keywords that are used by this
255 target (used by lexer) */
258 /* Write any port specific assembler output. */
259 void (*genAssemblerPreamble) (FILE * of);
260 /* invoked at end assembler file */
261 void (*genAssemblerEnd) (FILE * of);
263 /* Write the port specific IVT. If genIVT is NULL or if
264 * it returns zero, default (8051) IVT generation code
267 int (*genIVT) (FILE * of, symbol ** intTable, int intCount);
269 void (*genXINIT) (FILE * of);
271 /* Write port specific startup code */
272 void (*genInitStartup) (FILE * of);
274 /* parameter passing in register related functions */
275 void (*reset_regparms) (void); /* reset the register count */
276 int (*reg_parm) (struct sym_link *); /* will return 1 if can be passed in register */
278 /** Process the pragma string 'sz'. Returns 0 if recognised and
279 processed, 1 otherwise. May be NULL.
281 int (*process_pragma) (const char *sz);
283 /** Mangles a support function name to reflect the calling model.
285 char *(*getMangledFunctionName) (char *szOrginial);
287 /** Returns true if the port can multiply the two types nativly
288 without using support functions.
290 bool (*hasNativeMulFor) (iCode *ic, sym_link *left, sym_link *right);
292 /** Returns true if the port has implemented certain bit
293 manipulation iCodes (RRC, RLC, SWAP, GETHBIT)
295 bool (*hasExtBitOp) (int op, int size);
297 /** Returns the relative expense of accessing a particular output
298 storage class. Larger values indicate higher expense.
300 int (*oclsExpense) (struct memmap *oclass);
302 /** If TRUE, then tprintf and !dw will be used for some initalisers
304 bool use_dw_for_init;
306 /** TRUE for targets with little endian byte ordering, FALSE for
307 targets with big endian byte ordering.
311 /* condition transformations */
312 bool lt_nge; /* transform (a < b) to !(a >= b) */
313 bool gt_nle; /* transform (a > b) to !(a <= b) */
314 bool le_ngt; /* transform (a <= b) to !(a > b) */
315 bool ge_nlt; /* transform (a >= b) to !(a < b) */
316 bool ne_neq; /* transform a != b --> ! (a == b) */
317 bool eq_nne; /* transform a == b --> ! (a != b) */
319 bool arrayInitializerSuppported;
320 bool (*cseOk) (iCode *ic, iCode *pdic);
321 builtins *builtintable; /* table of builtin functions */
322 int unqualified_pointer; /* unqualified pointers type is */
323 int reset_labelKey ; /* reset Label no 1 at the start of a function */
324 int globals_allowed ; /* global & static locals not allowed ? 0 ONLY TININative*/
325 #define PORT_MAGIC 0xAC32
326 /** Used at runtime to detect if this structure has been completly filled in. */
333 #if !OPT_DISABLE_MCS51
334 extern PORT mcs51_port;
336 #if !OPT_DISABLE_GBZ80
337 extern PORT gbz80_port;
340 extern PORT z80_port;
343 extern PORT avr_port;
345 #if !OPT_DISABLE_DS390
346 extern PORT ds390_port;
349 extern PORT pic_port;
351 #if !OPT_DISABLE_PIC16
352 extern PORT pic16_port;
354 #if !OPT_DISABLE_TININative
355 extern PORT tininative_port;
357 #if !OPT_DISABLE_XA51
358 extern PORT xa51_port;
360 #if !OPT_DISABLE_DS400
361 extern PORT ds400_port;
363 #if !OPT_DISABLE_HC08
364 extern PORT hc08_port;
367 #endif /* PORT_INCLUDE*/