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 */
49 /* Processor specific names */
52 /** Unique id for this target */
54 /** Target name used for -m */
57 /** Target name string, used for --help */
58 const char *target_name;
60 /** Specific processor for the given target family. specified by -p */
65 /** Pointer to glue function */
66 void (*do_glue)(void);
67 /** TRUE if all types of glue functions should be inserted into
68 the file that also defines main.
69 We dont want this in cases like the z80 where the startup
70 code is provided by a seperate module.
79 /* assembler related information */
82 /** Command to run and arguments (eg as-z80) */
84 /** Alternate macro based form. */
86 /** Arguments for debug mode. */
87 const char *debug_opts;
88 /** Arguments for normal assembly mode. */
89 const char *plain_opts;
90 /* print externs as global */
92 /* assembler file extension */
94 /** If non-null will be used to execute the assembler. */
95 void (*do_assemble) (set *);
99 /* linker related info */
102 /** Command to run (eg link-z80) */
104 /** Alternate macro based form. */
106 /** If non-null will be used to execute the link. */
107 void (*do_link) (void);
108 /** Extension for object files (.rel, .obj, ...) */
110 /** 1 if port needs the .lnk file, 0 otherwise */
111 const int needLinkerScript;
117 /** Default peephole rules */
119 int (*getSize)(lineNode *line);
120 bitVect * (*getRegsRead)(lineNode *line);
121 bitVect * (*getRegsWritten)(lineNode *line);
125 /** Basic type sizes */
141 /** memory regions related stuff */
144 const char *xstack_name;
145 const char *istack_name;
146 const char *code_name;
147 const char *data_name;
148 const char *idata_name;
149 const char *pdata_name;
150 const char *xdata_name;
151 const char *bit_name;
152 const char *reg_name;
153 const char *static_name;
154 const char *overlay_name;
155 const char *post_static_name;
156 const char *home_name;
157 const char *xidata_name; // initialized xdata
158 const char *xinit_name; // a code copy of xidata
159 struct memmap *default_local_map; // default location for auto vars
160 struct memmap *default_globl_map; // default location for globl vars
161 int code_ro; /* code space read-only 1=yes */
167 void (*genExtraAreaDeclaration)(FILE *, bool);
168 void (*genExtraAreaLinkOptions)(FILE *);
172 /* stack related information */
175 /** -1 for grows down (z80), +1 for grows up (mcs51) */
177 /** Extra overhead when calling between banks */
179 /** Extra overhead when the function is an ISR */
181 /** Standard overhead for a function call */
183 /** Re-enterant space */
185 /** 'banked' call overhead.
186 Mild overlap with bank_overhead */
193 /** One more than the smallest
194 mul/div operation the processor can do nativley
195 Eg if the processor has an 8 bit mul, nativebelow is 2 */
203 void (*emitDebuggerSymbol) (char *);
206 int (*regNum) (struct regs *);
223 int sizeofMatchJump[3];
224 int sizeofRangeCompare[3];
230 /** Prefix to add to a C function (eg "_") */
231 const char *fun_prefix;
233 /** Called once the processor target has been selected.
234 First chance to initalise and set any port specific variables.
235 'port' is set before calling this. May be NULL.
238 /** Parses one option + its arguments */
239 bool (*parseOption) (int *pargc, char **argv, int *i);
240 /** Optional list of automatically parsed options. Should be
241 implemented to at least show the help text correctly. */
243 /** Initialise port spectific paths */
244 void (*initPaths)(void);
245 /** Called after all the options have been parsed. */
246 void (*finaliseOptions) (void);
247 /** Called after the port has been selected but before any
248 options are parsed. */
249 void (*setDefaultOptions) (void);
250 /** Does the dirty work. */
251 void (*assignRegisters) (struct ebbIndex *);
253 /** Returns the register name of a symbol.
254 Used so that 'regs' can be an incomplete type. */
255 const char *(*getRegName) (struct regs * reg);
257 /* list of keywords that are used by this
258 target (used by lexer) */
261 /* Write any port specific assembler output. */
262 void (*genAssemblerPreamble) (FILE * of);
263 /* invoked at end assembler file */
264 void (*genAssemblerEnd) (FILE * of);
266 /* Write the port specific IVT. If genIVT is NULL or if
267 * it returns zero, default (8051) IVT generation code
270 int (*genIVT) (FILE * of, symbol ** intTable, int intCount);
272 void (*genXINIT) (FILE * of);
274 /* Write port specific startup code */
275 void (*genInitStartup) (FILE * of);
277 /* parameter passing in register related functions */
278 void (*reset_regparms) (void); /* reset the register count */
279 int (*reg_parm) (struct sym_link *); /* will return 1 if can be passed in register */
281 /** Process the pragma string 'sz'. Returns 0 if recognised and
282 processed, 1 otherwise. May be NULL.
284 int (*process_pragma) (const char *sz);
286 /** Mangles a support function name to reflect the calling model.
288 char *(*getMangledFunctionName) (char *szOrginial);
290 /** Returns true if the port can multiply the two types nativly
291 without using support functions.
293 bool (*hasNativeMulFor) (iCode *ic, sym_link *left, sym_link *right);
295 /** Returns true if the port has implemented certain bit
296 manipulation iCodes (RRC, RLC, SWAP, GETHBIT)
298 bool (*hasExtBitOp) (int op, int size);
300 /** Returns the relative expense of accessing a particular output
301 storage class. Larger values indicate higher expense.
303 int (*oclsExpense) (struct memmap *oclass);
305 /** If TRUE, then tprintf and !dw will be used for some initalisers
307 bool use_dw_for_init;
309 /** TRUE for targets with little endian byte ordering, FALSE for
310 targets with big endian byte ordering.
314 /* condition transformations */
315 bool lt_nge; /* transform (a < b) to !(a >= b) */
316 bool gt_nle; /* transform (a > b) to !(a <= b) */
317 bool le_ngt; /* transform (a <= b) to !(a > b) */
318 bool ge_nlt; /* transform (a >= b) to !(a < b) */
319 bool ne_neq; /* transform a != b --> ! (a == b) */
320 bool eq_nne; /* transform a == b --> ! (a != b) */
322 bool arrayInitializerSuppported;
323 bool (*cseOk) (iCode *ic, iCode *pdic);
324 builtins *builtintable; /* table of builtin functions */
325 int unqualified_pointer; /* unqualified pointers type is */
326 int reset_labelKey ; /* reset Label no 1 at the start of a function */
327 int globals_allowed ; /* global & static locals not allowed ? 0 ONLY TININative*/
328 #define PORT_MAGIC 0xAC32
329 /** Used at runtime to detect if this structure has been completly filled in. */
336 #if !OPT_DISABLE_MCS51
337 extern PORT mcs51_port;
339 #if !OPT_DISABLE_GBZ80
340 extern PORT gbz80_port;
343 extern PORT z80_port;
346 extern PORT avr_port;
348 #if !OPT_DISABLE_DS390
349 extern PORT ds390_port;
352 extern PORT pic_port;
354 #if !OPT_DISABLE_PIC16
355 extern PORT pic16_port;
357 #if !OPT_DISABLE_TININative
358 extern PORT tininative_port;
360 #if !OPT_DISABLE_XA51
361 extern PORT xa51_port;
363 #if !OPT_DISABLE_DS400
364 extern PORT ds400_port;
366 #if !OPT_DISABLE_HC08
367 extern PORT hc08_port;
370 #endif /* PORT_INCLUDE*/