* src/SDCCcse.c (algebraicOpts): fixed loss of volatility
[fw/sdcc] / src / hc08 / main.c
1 /** @file main.c
2     hc08 specific general functions.
3
4     Note that mlh prepended _hc08_ on the static functions.  Makes
5     it easier to set a breakpoint using the debugger.
6 */
7 #include "common.h"
8 #include "main.h"
9 #include "ralloc.h"
10 #include "gen.h"
11 #include "../SDCCutil.h"
12
13 void copyFile(FILE *dest, FILE *src);
14 extern char * iComments2;
15 extern DEBUGFILE dwarf2DebugFile;
16 extern int dwarf2FinalizeFile(FILE *);
17
18 static char _defaultRules[] =
19 {
20 #include "peeph.rul"
21 };
22
23 /* list of key words used by msc51 */
24 static char *_hc08_keywords[] =
25 {
26   "at",
27   //"bit",
28   "code",
29   "critical",
30   "data",
31   "far",
32   //"idata",
33   "interrupt",
34   "near",
35   //"pdata",
36   "reentrant",
37   //"sfr",
38   //"sbit",
39   //"using",
40   "xdata",
41   "_data",
42   "_code",
43   "_generic",
44   "_near",
45   "_xdata",
46   //"_pdata",
47   //"_idata",
48   "_naked",
49   "_overlay",
50   NULL
51 };
52
53
54 void hc08_assignRegisters (ebbIndex *);
55
56 static int regParmFlg = 0;      /* determine if we can register a parameter */
57
58 static void
59 _hc08_init (void)
60 {
61   asm_addTree (&asm_asxxxx_mapping);
62 }
63
64 static void
65 _hc08_reset_regparm (void)
66 {
67   regParmFlg = 0;
68 }
69
70 static int
71 _hc08_regparm (sym_link * l)
72 {
73   int size = getSize(l);
74     
75   /* If they fit completely, the first two bytes of parameters can go */
76   /* into A and X, otherwise, they go on the stack. Examples:         */
77   /*   foo(char p1)                    A <- p1                        */
78   /*   foo(char p1, char p2)           A <- p1, X <- p2               */
79   /*   foo(char p1, char p2, char p3)  A <- p1, X <- p2, stack <- p3  */
80   /*   foo(int p1)                     XA <- p1                       */
81   /*   foo(long p1)                    stack <- p1                    */
82   /*   foo(char p1, int p2)            A <- p1, stack <- p2           */
83   /*   foo(int p1, char p2)            XA <- p1, stack <- p2          */
84
85   if (regParmFlg>=2)
86     return 0;
87
88   if ((regParmFlg+size)>2) 
89     {
90       regParmFlg = 2;
91       return 0;
92     }
93
94   regParmFlg += size;
95   return 1+regParmFlg-size;
96 }
97
98 static bool
99 _hc08_parseOptions (int *pargc, char **argv, int *i)
100 {
101   if (!strcmp (argv[*i], "--out-fmt-elf"))
102     {
103       options.out_fmt = 2;
104       debugFile = &dwarf2DebugFile;
105       return TRUE;
106     }
107     
108   return FALSE;
109 }
110
111 static OPTION _hc08_options[] = 
112   {
113     {  0,   "--out-fmt-elf", NULL, "Output executable in ELF format" },
114     {  0, NULL }
115   };
116
117 static void
118 _hc08_finaliseOptions (void)
119 {
120   if (options.noXinitOpt) {
121     port->genXINIT=0;
122   }
123
124   if (options.model == MODEL_LARGE) {
125       port->mem.default_local_map = xdata;
126       port->mem.default_globl_map = xdata;
127     }
128   else
129     {
130       port->mem.default_local_map = data;
131       port->mem.default_globl_map = data;
132     }
133
134   istack->ptrType = FPOINTER;
135 }
136
137 static void
138 _hc08_setDefaultOptions (void)
139 {
140   options.code_loc = 0x8000;
141   options.data_loc = 0x80;
142   options.xdata_loc = 0;        /* 0 means immediately following data */
143   options.stack_loc = 0x7fff;
144   options.out_fmt = 1;          /* use motorola S19 output */
145
146   options.ommitFramePtr = 1;    /* no frame pointer (we use SP */
147                                 /* offsets instead)            */
148   
149 }
150
151 static const char *
152 _hc08_getRegName (struct regs *reg)
153 {
154   if (reg)
155     return reg->name;
156   return "err";
157 }
158
159 static void
160 _hc08_genAssemblerPreamble (FILE * of)
161 {
162   int i;
163   int needOrg = 1;
164   symbol *mainExists=newSymbol("main", 0);
165   mainExists->block=0;
166
167   fprintf (of, "\t.area %s\n",port->mem.code_name);
168   fprintf (of, "\t.area GSINIT0 (CODE)\n");
169   fprintf (of, "\t.area %s\n",port->mem.static_name);
170   fprintf (of, "\t.area %s\n",port->mem.post_static_name);
171   fprintf (of, "\t.area %s\n",port->mem.xinit_name);
172   fprintf (of, "\t.area %s\n",port->mem.const_name);
173   fprintf (of, "\t.area %s\n",port->mem.data_name);
174   fprintf (of, "\t.area %s\n",port->mem.overlay_name);
175   fprintf (of, "\t.area %s\n",port->mem.bit_name);
176   fprintf (of, "\t.area %s\n",port->mem.xdata_name);
177   fprintf (of, "\t.area %s\n",port->mem.xidata_name);
178
179   if ((mainExists=findSymWithLevel(SymbolTab, mainExists)))
180     {
181       // generate interrupt vector table
182       fprintf (of, "\t.area\tCODEIVT (ABS)\n");
183       
184       for (i=maxInterrupts;i>0;i--)
185         {
186           if (interrupts[i])
187             {
188               if (needOrg)
189                 {
190                   fprintf (of, "\t.org\t0x%04x\n", (0xfffe - (i * 2)));
191                   needOrg = 0;
192                 }
193               fprintf (of, "\t.dw\t%s\n", interrupts[i]->rname);
194             }
195           else
196             needOrg = 1;
197         }
198       if (needOrg)
199         fprintf (of, "\t.org\t0xfffe\n");
200       fprintf (of, "\t.dw\t%s", "__sdcc_gs_init_startup\n\n");
201         
202       fprintf (of, "\t.area GSINIT0\n");
203       fprintf (of, "__sdcc_gs_init_startup:\n");
204       if (options.stack_loc)
205         {
206           fprintf (of, "\tldhx\t#0x%04x\n", options.stack_loc+1);
207           fprintf (of, "\ttxs\n");
208         }
209       else
210         fprintf (of, "\trsp\n");
211       fprintf (of, "\tjsr\t__sdcc_external_startup\n");
212       fprintf (of, "\tbeq\t__sdcc_init_data\n");
213       fprintf (of, "\tjmp\t__sdcc_program_startup\n");
214       fprintf (of, "__sdcc_init_data:\n");
215
216       fprintf (of, "; _hc08_genXINIT() start\n");
217       fprintf (of, "        ldhx #0\n");
218       fprintf (of, "00001$:\n");
219       fprintf (of, "        cphx #l_XINIT\n");
220       fprintf (of, "        beq  00002$\n");
221       fprintf (of, "        lda  s_XINIT,x\n");
222       fprintf (of, "        sta  s_XISEG,x\n");
223       fprintf (of, "        aix  #1\n");
224       fprintf (of, "        bra  00001$\n");
225       fprintf (of, "00002$:\n");
226       fprintf (of, "; _hc08_genXINIT() end\n");
227
228       fprintf (of, "\t.area GSFINAL\n");
229       fprintf (of, "\tjmp\t__sdcc_program_startup\n\n");
230
231       fprintf (of, "\t.area CSEG\n");
232       fprintf (of, "__sdcc_program_startup:\n");
233       fprintf (of, "\tjsr\t_main\n");
234       fprintf (of, "\tbra\t.\n");
235       
236     }
237 }
238
239 static void
240 _hc08_genAssemblerEnd (FILE * of)
241 {
242   if (options.out_fmt == 2 && options.debug)
243     {
244       dwarf2FinalizeFile (of);
245     }
246 }
247
248 static void
249 _hc08_genExtraAreas (FILE * asmFile, bool mainExists)
250 {
251     fprintf (asmFile, "%s", iComments2);
252     fprintf (asmFile, "; extended address mode data\n");
253     fprintf (asmFile, "%s", iComments2);
254     copyFile (asmFile, xdata->oFile);
255 }
256
257
258 /* Generate interrupt vector table. */
259 static int
260 _hc08_genIVT (FILE * of, symbol ** interrupts, int maxInterrupts)
261 {
262   int i;
263   
264   fprintf (of, "\t.area\tCODEIVT (ABS)\n");
265   fprintf (of, "\t.org\t0x%04x\n",
266     (0xfffe - (maxInterrupts * 2)));
267   
268   for (i=maxInterrupts;i>0;i--)
269     {
270       if (interrupts[i])
271         fprintf (of, "\t.dw\t%s\n", interrupts[i]->rname);
272       else
273         fprintf (of, "\t.dw\t0xffff\n");
274     }
275   fprintf (of, "\t.dw\t%s", "__sdcc_gs_init_startup\n");
276         
277   return TRUE;
278 }
279
280 /* Generate code to copy XINIT to XISEG */
281 static void _hc08_genXINIT (FILE * of) {
282   fprintf (of, ";       _hc08_genXINIT() start\n");
283   fprintf (of, ";       _hc08_genXINIT() end\n");
284 }
285
286
287 /* Do CSE estimation */
288 static bool cseCostEstimation (iCode *ic, iCode *pdic)
289 {
290     operand *result = IC_RESULT(ic);
291     sym_link *result_type = operandType(result);
292
293     return 0; /* disable CSE */
294     
295     /* if it is a pointer then return ok for now */
296     if (IC_RESULT(ic) && IS_PTR(result_type)) return 1;
297     
298     if (ic->op == ADDRESS_OF)
299       return 0;
300     
301     /* if bitwise | add & subtract then no since hc08 is pretty good at it 
302        so we will cse only if they are local (i.e. both ic & pdic belong to
303        the same basic block */
304     if (IS_BITWISE_OP(ic) || ic->op == '+' || ic->op == '-') {
305         /* then if they are the same Basic block then ok */
306         if (ic->eBBlockNum == pdic->eBBlockNum) return 1;
307         else return 0;
308     }
309         
310     /* for others it is cheaper to do the cse */
311     return 1;
312 }
313
314
315 /* Indicate which extended bit operations this port supports */
316 static bool
317 hasExtBitOp (int op, int size)
318 {
319   if (op == RRC
320       || op == RLC
321       || op == GETHBIT
322       || (op == SWAP && size <= 2)
323      )
324     return TRUE;
325   else
326     return FALSE;
327 }
328
329 /* Indicate the expense of an access to an output storage class */
330 static int
331 oclsExpense (struct memmap *oclass)
332 {
333   /* The hc08's addressing modes allow access to all storage classes */
334   /* inexpensively (<=0) */
335   
336   if (IN_DIRSPACE (oclass))     /* direct addressing mode is fastest */
337     return -2;
338   if (IN_FARSPACE (oclass))     /* extended addressing mode is almost at fast */
339     return -1;
340   if (oclass == istack) /* stack is the slowest, but still faster than */
341     return 0;           /* trying to copy to a temp location elsewhere */
342   
343   return 0; /* anything we missed */
344 }
345
346
347 /*----------------------------------------------------------------------*/
348 /* hc08_dwarfRegNum - return the DWARF register number for a register.  */
349 /*   These are defined for the HC08 in "Motorola 8- and 16-bit Embedded */
350 /*   Application Binary Interface (M8/16EABI)"                          */
351 /*----------------------------------------------------------------------*/
352 static int
353 hc08_dwarfRegNum (regs * reg)
354 {
355   switch (reg->rIdx)
356     {
357     case A_IDX: return 0;
358     case H_IDX: return 1;
359     case X_IDX: return 2;
360     case CND_IDX: return 17;
361     case SP_IDX: return 15;
362     }
363   return -1;
364 }
365
366
367
368 /** $1 is always the basename.
369     $2 is always the output file.
370     $3 varies
371     $l is the list of extra options that should be there somewhere...
372     MUST be terminated with a NULL.
373 */
374 static const char *_linkCmd[] =
375 {
376   "link-hc08", "-nf", "\"$1\"", NULL
377 };
378
379 /* $3 is replaced by assembler.debug_opts resp. port->assembler.plain_opts */
380 static const char *_asmCmd[] =
381 {
382   "as-hc08", "$l", "$3", "\"$1.asm\"", NULL
383 };
384
385 /* Globals */
386 PORT hc08_port =
387 {
388   TARGET_ID_HC08,
389   "hc08",
390   "HC08",                       /* Target name */
391   NULL,                         /* Processor name */
392   {
393     glue,
394     FALSE,                      /* Emit glue around main */
395     MODEL_SMALL | MODEL_LARGE,
396     MODEL_LARGE
397   },
398   {
399     _asmCmd,
400     NULL,
401     "-plosgffc",                /* Options with debug */
402     "-plosgff",                 /* Options without debug */
403     0,
404     ".asm",
405     NULL                        /* no do_assemble function */
406   },
407   {
408     _linkCmd,
409     NULL,
410     NULL,
411     ".rel",
412     1
413   },
414   {
415     _defaultRules
416   },
417   {
418         /* Sizes: char, short, int, long, ptr, fptr, gptr, bit, float, max */
419     1, 2, 2, 4, 2, 2, 2, 1, 4, 4
420   },
421   {
422     "XSEG",
423     "STACK",
424     "CSEG (CODE)",
425     "DSEG",
426     NULL, /* "ISEG" */
427     NULL, /* "PSEG" */
428     "XSEG",
429     "BSEG",
430     "RSEG",
431     "GSINIT (CODE)",
432     "OSEG    (OVR)",
433     "GSFINAL (CODE)",
434     "HOME (CODE)",
435     "XISEG", // initialized xdata
436     "XINIT", // a code copy of xiseg
437     "CONST   (CODE)", // const_name - const data (code or not)
438     NULL,
439     NULL,
440     1
441   },
442   { _hc08_genExtraAreas,
443     NULL },
444   {
445     -1,         /* direction (-1 = stack grows down) */
446     0,          /* bank_overhead (switch between register banks) */
447     4,          /* isr_overhead */
448     2,          /* call_overhead */
449     0,          /* reent_overhead */
450     0           /* banked_overhead (switch between code banks) */
451   },
452     /* hc08 has an 8 bit mul */
453   {
454     1, -1
455   },
456   {
457     hc08_emitDebuggerSymbol,
458     {
459       hc08_dwarfRegNum,
460       NULL,
461       NULL,
462       4,                                /* addressSize */
463       14,                       /* regNumRet */
464       15,                       /* regNumSP */
465       -1,                       /* regNumBP */
466       1,                        /* offsetSP */
467     },
468   },
469   {
470     256,        /* maxCount */
471     2,          /* sizeofElement */
472     {8,16,32},  /* sizeofMatchJump[] */
473     {8,16,32},  /* sizeofRangeCompare[] */
474     5,          /* sizeofSubtract */
475     10,         /* sizeofDispatch */
476   },
477   "_",
478   _hc08_init,
479   _hc08_parseOptions,
480   _hc08_options,
481   NULL,
482   _hc08_finaliseOptions,
483   _hc08_setDefaultOptions,
484   hc08_assignRegisters,
485   _hc08_getRegName,
486   _hc08_keywords,
487   _hc08_genAssemblerPreamble,
488   _hc08_genAssemblerEnd,        /* no genAssemblerEnd */
489   _hc08_genIVT,
490   _hc08_genXINIT,
491   NULL,                         /* genInitStartup */
492   _hc08_reset_regparm,
493   _hc08_regparm,
494   NULL,                         /* process_pragma */
495   NULL,                         /* getMangledFunctionName */
496   NULL,                         /* hasNativeMulFor */
497   hasExtBitOp,                  /* hasExtBitOp */
498   oclsExpense,                  /* oclsExpense */
499   TRUE,                         /* use_dw_for_init */
500   FALSE,                        /* little endian */
501   0,                            /* leave lt */
502   0,                            /* leave gt */
503   1,                            /* transform <= to ! > */
504   1,                            /* transform >= to ! < */
505   1,                            /* transform != to !(a == b) */
506   0,                            /* leave == */
507   FALSE,                        /* No array initializer support. */
508   cseCostEstimation,
509   NULL,                         /* no builtin functions */
510   GPOINTER,                     /* treat unqualified pointers as "generic" pointers */
511   1,                            /* reset labelKey to 1 */
512   1,                            /* globals & local static allowed */
513   PORT_MAGIC
514 };