* src/SDCCutil.c: fixed a bug in (get_pragma_token)
[fw/sdcc] / src / pic16 / main.c
1 /*-------------------------------------------------------------------------
2
3   main.c - pic16 specific general functions.
4
5    Written by - Scott Dattalo scott@dattalo.com
6    Ported to PIC16 by - Martin Dubuc m.debuc@rogers.com
7     
8    Note that mlh prepended _pic16_ on the static functions.  Makes
9    it easier to set a breakpoint using the debugger.
10
11
12    This program is free software; you can redistribute it and/or modify it
13    under the terms of the GNU General Public License as published by the
14    Free Software Foundation; either version 2, or (at your option) any
15    later version.
16    
17    This program is distributed in the hope that it will be useful,
18    but WITHOUT ANY WARRANTY; without even the implied warranty of
19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20    GNU General Public License for more details.
21    
22    You should have received a copy of the GNU General Public License
23    along with this program; if not, write to the Free Software
24    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 -------------------------------------------------------------------------*/
26
27 #include "common.h"
28 #include "main.h"
29 #include "ralloc.h"
30 #include "device.h"
31 #include "SDCCutil.h"
32 #include "glue.h"
33 #include "pcode.h"
34
35
36 static char _defaultRules[] =
37 {
38 #include "peeph.rul"
39 };
40
41 /* list of key words used by pic16 */
42 static char *_pic16_keywords[] =
43 {
44   "at",
45   "code",
46   "critical",
47   "register",
48   "data",
49   "far",
50   "interrupt",
51   "near",
52   "pdata",
53   "reentrant",
54   "sfr",
55   "sfr16",
56   "using",
57   "_data",
58   "_code",
59   "_generic",
60   "_near",
61   "_pdata",
62   "_naked",
63   "shadowregs",
64   "wparam",
65   "prodlp",
66   "prodhp",
67   "fsr0lp",
68   "fixed16x16",
69   
70 //  "bit",
71 //  "idata",
72 //  "sbit",
73 //  "xdata",
74 //  "_xdata",
75 //  "_idata",
76   NULL
77 };
78
79
80 pic16_sectioninfo_t pic16_sectioninfo;
81
82 int xinst=0;
83
84
85 extern char *pic16_processor_base_name(void);
86
87 void  pic16_pCodeInitRegisters(void);
88
89 void pic16_assignRegisters (ebbIndex *);
90
91 static int regParmFlg = 0;      /* determine if we can register a parameter */
92
93 pic16_options_t pic16_options;
94
95 extern set *includeDirsSet;
96 extern set *dataDirsSet;
97 extern set *libFilesSet;
98
99 /* Also defined in gen.h, but the #include is commented out */
100 /* for an unknowned reason. - EEP */
101 void pic16_emitDebuggerSymbol (char *);
102  
103 extern void pic16_emitConfigRegs(FILE *of);
104 extern void pic16_emitIDRegs(FILE *of);
105
106
107
108 static void
109 _pic16_init (void)
110 {
111   asm_addTree (&asm_asxxxx_mapping);
112   pic16_pCodeInitRegisters();
113   maxInterrupts = 2;
114 }
115
116 static void
117 _pic16_reset_regparm (void)
118 {
119   regParmFlg = 0;
120 }
121
122 static int
123 _pic16_regparm (sym_link * l, bool reentrant)
124 {
125   /* force all parameters via SEND/RECEIVE */
126   if(0 /*pic16_options.ip_stack*/) {
127     /* for this processor it is simple
128      * can pass only the first parameter in a register */
129     if(regParmFlg)return 0;
130       regParmFlg++;
131       return 1; //regParmFlg;
132   } else {
133     /* otherwise pass all arguments in registers via SEND/RECEIVE */
134     regParmFlg++;// = 1;
135     return regParmFlg;
136   }
137 }
138
139
140 int initsfpnt=0;                /* set to 1 if source provides a pragma for stack
141                                  * so glue() later emits code to initialize stack/frame pointers */
142 set *absSymSet;
143
144 set *sectNames=NULL;                    /* list of section listed in pragma directives */
145 set *sectSyms=NULL;                     /* list of symbols set in a specific section */
146 set *wparamList=NULL;
147
148 #if 0
149 /* This is an experimental code for #pragma inline
150    and is temporarily disabled for 2.5.0 release */
151 set *asmInlineMap=NULL;
152 #endif  /* 0 */
153
154 struct {
155   unsigned ignore: 1;
156   unsigned want_libc: 1;
157   unsigned want_libm: 1;
158   unsigned want_libio: 1;
159   unsigned want_libdebug: 1;
160 } libflags = { 0, 0, 0, 0, 0 };
161   
162
163 enum {
164   P_MAXRAM = 1,
165   P_STACK,
166   P_CODE,
167   P_UDATA,
168   P_LIBRARY
169 };
170
171 static int
172 do_pragma(int id, const char *name, const char *cp)
173 {
174   struct pragma_token_s token;
175   int err = 0;
176   int processed = 1;
177
178   init_pragma_token(&token);
179
180   switch (id)
181     {
182     /* #pragma maxram [maxram] */
183     case P_MAXRAM:
184       {
185         int max_ram;
186
187         cp = get_pragma_token(cp, &token);
188         if (TOKEN_INT == token.type)
189           max_ram = token.val.int_val;
190         else
191           {
192             err = 1;
193             break;
194           }
195
196         cp = get_pragma_token(cp, &token);
197         if (TOKEN_EOL != token.type)
198           {
199             err = 1;
200             break;
201           }
202
203         pic16_setMaxRAM(max_ram);
204       }
205       break;
206
207     /* #pragma stack [stack-position] [stack-len] */
208     case  P_STACK:
209       {
210         unsigned int stackPos, stackLen;
211         regs *reg;
212         symbol *sym;
213
214         cp = get_pragma_token(cp, &token);
215         if (TOKEN_INT != token.type)
216           {
217             err = 1;
218             break;
219           }
220         stackPos = token.val.int_val;
221
222         cp = get_pragma_token(cp, &token);
223         if (TOKEN_INT != token.type)
224           {
225             err = 1;
226             break;
227           }
228         stackLen = token.val.int_val;
229
230         cp = get_pragma_token(cp, &token);
231         if (TOKEN_EOL != token.type)
232           {
233             err = 1;
234             break;
235           }
236
237         if (stackLen < 1) {
238           stackLen = 64;
239           fprintf(stderr, "%s:%d: warning: setting stack to default size %d (0x%04x)\n",
240                   filename, lineno, stackLen, stackLen);
241         }
242
243         /* check sanity of stack */
244         if ((stackPos >> 8) != ((stackPos + stackLen - 1) >> 8)) {
245           fprintf (stderr, "%s:%u: warning: stack [0x%03X,0x%03X] crosses memory bank boundaries (not fully tested)\n",
246                   filename, lineno, stackPos, stackPos + stackLen - 1);
247         }
248
249         if (pic16) {
250           if (stackPos < pic16->acsSplitOfs) {
251             fprintf (stderr, "%s:%u: warning: stack [0x%03X, 0x%03X] intersects with the access bank [0x000,0x%03x] -- this is highly discouraged!\n",
252                   filename, lineno, stackPos, stackPos + stackLen - 1, pic16->acsSplitOfs);
253           }
254
255           if (stackPos+stackLen > 0xF00 + pic16->acsSplitOfs) {
256             fprintf (stderr, "%s:%u: warning: stack [0x%03X,0x%03X] intersects with special function registers [0x%03X,0xFFF]-- this is highly discouraged!\n",
257                    filename, lineno, stackPos, stackPos + stackLen - 1, 0xF00 + pic16->acsSplitOfs);
258           }
259
260           if (stackPos+stackLen > pic16->RAMsize) {
261             fprintf (stderr, "%s:%u: error: stack [0x%03X,0x%03X] is placed outside available memory [0x000,0x%03X]!\n",
262                   filename, lineno, stackPos, stackPos + stackLen - 1, pic16->RAMsize-1);
263             err = 1;
264             break;
265           }
266         }
267
268         reg = newReg(REG_SFR, PO_SFR_REGISTER, stackPos, "_stack", stackLen-1, 0, NULL);
269         addSet(&pic16_fix_udata, reg);
270
271         reg = newReg(REG_SFR, PO_SFR_REGISTER, stackPos + stackLen-1, "_stack_end", 1, 0, NULL);
272         addSet(&pic16_fix_udata, reg);
273
274         sym = newSymbol("stack", 0);
275         sprintf(sym->rname, "_%s", sym->name);
276         addSet(&publics, sym);
277
278         sym = newSymbol("stack_end", 0);
279         sprintf(sym->rname, "_%s", sym->name);
280         addSet(&publics, sym);
281     
282         initsfpnt = 1;    // force glue() to initialize stack/frame pointers */
283       }
284       break;
285
286     /* #pragma code [symbol] [location] */
287     case P_CODE:
288       {
289         absSym *absS;
290
291         cp = get_pragma_token(cp, &token);
292         if (TOKEN_STR != token.type)
293           goto code_err;
294
295         absS = Safe_calloc(1, sizeof(absSym));
296         sprintf(absS->name, "_%s", get_pragma_string(&token));
297
298         cp = get_pragma_token(cp, &token);
299         if (TOKEN_INT != token.type)
300           {
301           code_err:
302             //fprintf (stderr, "%s:%d: #pragma code [symbol] [location] -- symbol or location missing\n", filename, lineno);
303             err = 1;
304             break;
305           }
306         absS->address = token.val.int_val;
307
308         cp = get_pragma_token(cp, &token);
309         if (TOKEN_EOL != token.type)
310           {
311             err = 1;
312             break;
313           }
314
315         if ((absS->address % 2) != 0) {
316           absS->address--;
317           fprintf(stderr, "%s:%d: warning: code memory locations should be word aligned, will locate to 0x%06x instead\n",
318                   filename, lineno, absS->address);
319         }
320
321         addSet(&absSymSet, absS);
322 //      fprintf(stderr, "%s:%d symbol %s will be placed in location 0x%06x in code memory\n",
323 //        __FILE__, __LINE__, symname, absS->address);
324       }
325       break;
326
327     /* #pragma udata [section-name] [symbol] */
328     case P_UDATA:
329       {
330         char *sectname;
331         const char *symname;
332         symbol *nsym;
333         sectSym *ssym;
334         sectName *snam;
335         int found = 0;
336
337         cp = get_pragma_token(cp, &token);
338         if (TOKEN_EOL == token.type)
339           goto udata_err;
340
341         sectname = Safe_strdup(get_pragma_string(&token));
342
343         cp = get_pragma_token(cp, &token);
344         if (TOKEN_EOL == token.type)
345           {
346           udata_err:
347             //fprintf (stderr, "%s:%d: #pragma udata [section-name] [symbol] -- section-name or symbol missing!\n", filename, lineno);
348             err = 1;
349             break;
350           }
351         symname = get_pragma_string(&token);
352
353         cp = get_pragma_token(cp, &token);
354         if (TOKEN_EOL != token.type)
355           {
356             err = 1;
357             break;
358           }
359
360         while (symname) {
361           ssym = Safe_calloc(1, sizeof(sectSym));
362           ssym->name = Safe_calloc(1, strlen(symname) + 2);
363           sprintf(ssym->name, "%s%s", port->fun_prefix, symname);
364           ssym->reg = NULL;
365
366           addSet(&sectSyms, ssym);
367
368           nsym = newSymbol((char *)symname, 0);
369           strcpy(nsym->rname, ssym->name);
370
371 #if 0
372           checkAddSym(&publics, nsym);
373 #endif
374
375           found = 0;
376           for (snam = setFirstItem(sectNames);snam;snam=setNextItem(sectNames)) {
377             if (!strcmp(sectname, snam->name)){ found=1; break; }
378           }
379
380           if(!found) {
381             snam = Safe_calloc(1, sizeof(sectName));
382             snam->name = Safe_strdup(sectname);
383             snam->regsSet = NULL;
384
385             addSet(&sectNames, snam);
386           }
387
388           ssym->section = snam;
389
390 #if 0
391           fprintf(stderr, "%s:%d placing symbol %s at section %s (%p)\n", __FILE__, __LINE__,
392              ssym->name, snam->name, snam);
393 #endif
394
395           cp = get_pragma_token(cp, &token);
396           symname = (TOKEN_EOL != token.type) ? get_pragma_string(&token) : NULL;
397         }
398
399         Safe_free(sectname);
400       }
401       break;
402
403     /* #pragma library library_module */
404     case P_LIBRARY:
405       {
406         const char *lmodule;
407
408         cp = get_pragma_token(cp, &token);
409         if (TOKEN_EOL != token.type)
410           {
411             lmodule = get_pragma_string(&token);
412
413             /* lmodule can be:
414              * c        link the C library
415              * math     link the math library
416              * io       link the IO library
417              * debug    link the debug libary
418              * anything else, will link as-is */
419      
420             if(!strcmp(lmodule, "c"))
421               libflags.want_libc = 1;
422             else if(!strcmp(lmodule, "math"))
423               libflags.want_libm = 1;
424             else if(!strcmp(lmodule, "io"))
425               libflags.want_libio = 1;
426             else if(!strcmp(lmodule, "debug"))
427               libflags.want_libdebug = 1;
428             else if(!strcmp(lmodule, "ignore"))
429               libflags.ignore = 1;
430             else
431               {
432                 if(!libflags.ignore)
433                   {
434                     fprintf(stderr, "link library %s\n", lmodule);
435                     addSetHead(&libFilesSet, (char *)lmodule);
436                   }
437               }
438           }
439         else
440           {
441             err = 1;
442             break;
443           }
444
445         cp = get_pragma_token(cp, &token);
446         if (TOKEN_EOL != token.type)
447           {
448             err = 1;
449             break;
450           }
451       }
452       break;
453
454 #if 0
455   /* This is an experimental code for #pragma inline
456      and is temporarily disabled for 2.5.0 release */
457     case P_INLINE:
458       {
459         char *tmp = strtok((char *)NULL, WHITECOMMA);
460
461         while(tmp) {
462           addSet(&asmInlineMap, Safe_strdup( tmp ));
463           tmp = strtok((char *)NULL, WHITECOMMA);
464         }
465
466         {
467           char *s;
468           
469           for(s = setFirstItem(asmInlineMap); s ; s = setNextItem(asmInlineMap)) {
470             debugf("inline asm: `%s'\n", s);
471           }
472         }
473       }
474       break;
475 #endif  /* 0 */
476
477     default:
478       processed = 0;
479       break;
480   }
481
482   get_pragma_token(cp, &token);
483
484   if (1 == err)
485     werror(W_BAD_PRAGMA_ARGUMENTS, name);
486
487   free_pragma_token(&token);
488   return processed;
489 }
490
491 static struct pragma_s pragma_tbl[] = {
492   { "maxram",  P_MAXRAM,  0, do_pragma },
493   { "stack",   P_STACK,   0, do_pragma },
494   { "code",    P_CODE,    0, do_pragma },
495   { "udata",   P_UDATA,   0, do_pragma },
496   { "library", P_LIBRARY, 0, do_pragma },
497 /*{ "inline",  P_INLINE,  0, do_pragma }, */
498   { NULL,      0,         0, NULL },
499   };
500
501 static int
502 _process_pragma(const char *s)
503 {
504   return process_pragma_tbl(pragma_tbl, s);
505 }
506
507 #define REP_UDATA       "--preplace-udata-with="
508
509 #define STACK_MODEL     "--pstack-model="
510 #define OPT_BANKSEL     "--obanksel="
511
512 #define ALT_ASM         "--asm="
513 #define ALT_LINK        "--link="
514
515 #define IVT_LOC         "--ivt-loc="
516 #define NO_DEFLIBS      "--nodefaultlibs"
517 #define MPLAB_COMPAT    "--mplab-comp"
518
519 #define NL_OPT          "--nl="
520 #define USE_CRT         "--use-crt="
521
522 #define OFMSG_LRSUPPORT "--flr-support"
523
524 #define OPTIMIZE_GOTO   "--optimize-goto"
525 #define OPTIMIZE_CMP    "--optimize-cmp"
526 #define OPTIMIZE_DF     "--optimize-df"
527
528 char *alt_asm=NULL;
529 char *alt_link=NULL;
530
531 int pic16_mplab_comp=0;
532 extern int pic16_debug_verbose;
533 extern int pic16_ralloc_debug;
534 extern int pic16_pcode_verbose;
535
536 int pic16_fstack=0;
537 int pic16_enable_peeps=0;
538 int pic16_nl=0;                 /* 0 for LF, 1 for CRLF */
539
540 OPTION pic16_optionsTable[]= {
541         { 0,    NO_DEFLIBS,             &pic16_options.nodefaultlibs,   "do not link default libraries when linking"},
542         { 0,    "--pno-banksel",        &pic16_options.no_banksel,      "do not generate BANKSEL assembler directives"},
543         { 0,    OPT_BANKSEL,            NULL,                           "set banksel optimization level (default=0 no)"},
544 //      { 0,    "--pomit-config-words", &pic16_options.omit_configw,    "omit the generation of configuration words"},
545 //      { 0,    "--pomit-ivt",          &pic16_options.omit_ivt,        "omit the generation of the Interrupt Vector Table"},
546 //      { 0,    "--pleave-reset-vector",&pic16_options.leave_reset,     "when omitting IVT leave RESET vector"},
547         { 0,    STACK_MODEL,            NULL,                           "use stack model 'small' (default) or 'large'"},
548
549         { 0,    "--debug-xtra",         &pic16_debug_verbose,   "show more debug info in assembly output"},
550         { 0,    "--debug-ralloc",       &pic16_ralloc_debug,    "dump register allocator debug file *.d"},
551         { 0,    "--pcode-verbose",      &pic16_pcode_verbose,   "dump pcode related info"},
552                 
553         { 0,    REP_UDATA,      NULL,   "Place udata variables at another section: udata_acs, udata_ovr, udata_shr"},
554
555         { 0,    ALT_ASM,        NULL,   "Use alternative assembler"},
556         { 0,    ALT_LINK,       NULL,   "Use alternative linker"},
557
558         { 0,    "--denable-peeps",      &pic16_enable_peeps,    "explicit enable of peepholes"},
559         { 0,    IVT_LOC,        NULL,   "<nnnn> interrupt vector table location"},
560         { 0,    "--calltree",           &pic16_options.dumpcalltree,    "dump call tree in .calltree file"},
561         { 0,    MPLAB_COMPAT,           &pic16_mplab_comp,      "enable compatibility mode for MPLAB utilities (MPASM/MPLINK)"},
562         { 0,    "--fstack",             &pic16_fstack,          "enable stack optimizations"},
563         { 0,    NL_OPT,         NULL,                           "new line, \"lf\" or \"crlf\""},
564         { 0,    USE_CRT,        NULL,   "use <crt-o> run-time initialization module"},
565         { 0,    "--no-crt",     &pic16_options.no_crt,  "do not link any default run-time initialization module"},
566         { 0,    "--gstack",     &pic16_options.gstack,  "trace stack pointer push/pop to overflow"},
567         { 0,    OPTIMIZE_GOTO,  NULL,                   "try to use (conditional) BRA instead of GOTO"},
568         { 0,    OPTIMIZE_CMP,   NULL,                   "try to optimize some compares"},
569         { 0,    OPTIMIZE_DF,    NULL,                   "thoroughly analyze data flow (memory and time intensive!)"},
570         { 0,    "--num-func-alloc-regs", &pic16_options.CATregs, "dump number of temporary registers allocated for each function"},
571 #if XINST
572         { 'y',  "--extended",   &xinst, "enable Extended Instruction Set/Literal Offset Addressing mode"},
573 #endif
574         { 0,    NULL,           NULL,   NULL}
575         };
576
577
578 #define ISOPT(str)      !strncmp(argv[ *i ], str, strlen(str) )
579
580 extern char *getStringArg(const char *,  char **, int *, int);
581 extern int getIntArg(const char *, char **, int *, int);
582
583 static bool
584 _pic16_parseOptions (int *pargc, char **argv, int *i)
585 {
586   int j=0;
587   char *stkmodel;
588   
589   /* TODO: allow port-specific command line options to specify
590    * segment names here.
591    */
592   
593     /* check for arguments that have associated an integer variable */
594     while(pic16_optionsTable[j].pparameter) {
595       if(ISOPT( pic16_optionsTable[j].longOpt )) {
596         (*pic16_optionsTable[j].pparameter)++;
597         return TRUE;
598       }
599       j++;
600     }
601
602     if(ISOPT(STACK_MODEL)) {
603       stkmodel = getStringArg(STACK_MODEL, argv, i, *pargc);
604       if(!STRCASECMP(stkmodel, "small"))pic16_options.stack_model = 0;
605       else if(!STRCASECMP(stkmodel, "large"))pic16_options.stack_model = 1;
606       else {
607         fprintf(stderr, "Unknown stack model: %s", stkmodel);
608         exit(EXIT_FAILURE);
609       }
610       return TRUE;
611     }
612
613     if(ISOPT(OPT_BANKSEL)) {
614       pic16_options.opt_banksel = getIntArg(OPT_BANKSEL, argv, i, *pargc);
615       return TRUE;
616     }
617
618     if(ISOPT(REP_UDATA)) {
619       pic16_sectioninfo.at_udata = Safe_strdup(getStringArg(REP_UDATA, argv, i, *pargc));
620       return TRUE;
621     }
622         
623     if(ISOPT(ALT_ASM)) {
624       alt_asm = Safe_strdup(getStringArg(ALT_ASM, argv, i, *pargc));
625       return TRUE;
626     }
627         
628     if(ISOPT(ALT_LINK)) {
629       alt_link = Safe_strdup(getStringArg(ALT_LINK, argv, i, *pargc));
630       return TRUE;
631     }
632
633     if(ISOPT(IVT_LOC)) {
634       pic16_options.ivt_loc = getIntArg(IVT_LOC, argv, i, *pargc);
635       fprintf(stderr, "%s:%d setting interrupt vector addresses 0x%x\n", __FILE__, __LINE__, pic16_options.ivt_loc);
636       return TRUE;
637     }
638         
639     if(ISOPT(NL_OPT)) {
640       char *tmp;
641             
642         tmp = Safe_strdup( getStringArg(NL_OPT, argv, i, *pargc) );
643         if(!STRCASECMP(tmp, "lf"))pic16_nl = 0;
644         else if(!STRCASECMP(tmp, "crlf"))pic16_nl = 1;
645         else {
646           fprintf(stderr, "invalid termination character id\n");
647           exit(EXIT_FAILURE);
648         }
649         return TRUE;
650     }
651
652     if(ISOPT(USE_CRT)) {
653       pic16_options.no_crt = 0;
654       pic16_options.crt_name = Safe_strdup( getStringArg(USE_CRT, argv, i, *pargc) );
655
656       return TRUE;
657     }
658
659 #if 0
660     if(ISOPT(OFMSG_LRSUPPORT)) {
661       pic16_options.opt_flags |= OF_LR_SUPPORT;
662       return TRUE;
663     }
664 #endif
665
666     if (ISOPT(OPTIMIZE_GOTO)) {
667       pic16_options.opt_flags |= OF_OPTIMIZE_GOTO;
668       return TRUE;
669     }
670
671     if(ISOPT(OPTIMIZE_CMP)) {
672       pic16_options.opt_flags |= OF_OPTIMIZE_CMP;
673       return TRUE;
674     }
675
676     if (ISOPT(OPTIMIZE_DF)) {
677       pic16_options.opt_flags |= OF_OPTIMIZE_DF;
678       return TRUE;
679     }
680     
681
682   return FALSE;
683 }
684
685 extern set *userIncDirsSet;
686
687 static void _pic16_initPaths(void)
688 {
689   char pic16incDir[512];
690   char pic16libDir[512];
691   set *pic16incDirsSet=NULL;
692   set *pic16libDirsSet=NULL;
693   char devlib[512];
694
695     setMainValue("mcu", pic16->name[2] );
696     addSet(&preArgvSet, Safe_strdup("-D{mcu}"));
697
698     setMainValue("mcu1", pic16->name[1] );
699     addSet(&preArgvSet, Safe_strdup("-D__{mcu1}"));
700
701     sprintf(pic16incDir, "%s%cpic16", INCLUDE_DIR_SUFFIX, DIR_SEPARATOR_CHAR);
702     sprintf(pic16libDir, "%s%cpic16", LIB_DIR_SUFFIX, DIR_SEPARATOR_CHAR);
703
704
705     if(!options.nostdinc) {
706       /* setup pic16 include directory */
707       pic16incDirsSet = appendStrSet(dataDirsSet, NULL, pic16incDir);
708       includeDirsSet = pic16incDirsSet;
709 //      mergeSets(&includeDirsSet, pic16incDirsSet);
710     }
711     /* pic16 port should not search to the SDCC standard include directories,
712      * so add here the deleted include dirs that user has issued in command line */
713     mergeSets(&pic16incDirsSet, userIncDirsSet);
714
715     if(!options.nostdlib) {
716       /* setup pic16 library directory */
717       pic16libDirsSet = appendStrSet(dataDirsSet, NULL, pic16libDir);
718       libDirsSet = pic16libDirsSet;
719 //      mergeSets(&libDirsSet, pic16libDirsSet);
720     }
721
722     if(!pic16_options.nodefaultlibs) {
723       /* now add the library for the device */
724       sprintf(devlib, "%s.lib", pic16->name[2]);
725       addSet(&libFilesSet, Safe_strdup(devlib));
726
727       /* add the internal SDCC library */
728       addSet(&libFilesSet, Safe_strdup( "libsdcc.lib" ));
729     }
730 }
731
732 extern set *linkOptionsSet;
733 char *msprintf(hTab *pvals, const char *pformat, ...);
734 int my_system(const char *cmd);
735
736 /* forward declarations */   
737 extern const char *pic16_linkCmd[];
738 extern const char *pic16_asmCmd[];
739 extern set *asmOptionsSet;
740   
741 /* custom function to link objects */
742 static void _pic16_linkEdit(void)
743 {
744   hTab *linkValues=NULL;
745   char lfrm[1024];
746   char *lcmd;
747   char temp[1024];
748   set *tSet=NULL;
749   int ret;
750   
751         /*
752          * link command format:
753          * {linker} {incdirs} {lflags} -o {outfile} {spec_ofiles} {ofiles} {libs}
754          *
755          */
756         sprintf(lfrm, "{linker} {incdirs} {lflags} -w -r -o {outfile} {user_ofile} {ofiles} {spec_ofiles} {libs}");
757
758         shash_add(&linkValues, "linker", pic16_linkCmd[0]);
759
760         mergeSets(&tSet, libDirsSet);
761         mergeSets(&tSet, libPathsSet);
762         
763         shash_add(&linkValues, "incdirs", joinStrSet( appendStrSet(tSet, "-I\"", "\"")));
764         shash_add(&linkValues, "lflags", joinStrSet(linkOptionsSet));
765   
766         shash_add(&linkValues, "outfile", fullDstFileName ? fullDstFileName : dstFileName);
767
768         if(fullSrcFileName) {
769                 sprintf(temp, "%s.o", fullDstFileName ? fullDstFileName : dstFileName);
770 //              addSetHead(&relFilesSet, Safe_strdup(temp));
771                 shash_add(&linkValues, "user_ofile", temp);
772         }
773
774         if(!pic16_options.no_crt)
775           shash_add(&linkValues, "spec_ofiles", pic16_options.crt_name);
776
777         shash_add(&linkValues, "ofiles", joinStrSet(relFilesSet));
778
779         if(!libflags.ignore) {
780           if(libflags.want_libc)
781             addSet(&libFilesSet, Safe_strdup("libc18f.lib"));
782         
783           if(libflags.want_libm)
784             addSet(&libFilesSet, Safe_strdup("libm18f.lib"));
785         
786           if(libflags.want_libio) {
787             sprintf(temp, "libio%s.lib", pic16->name[1]);       /* build libio18f452.lib name */
788             addSet(&libFilesSet, Safe_strdup(temp));
789           }
790         
791           if(libflags.want_libdebug)
792             addSet(&libFilesSet, Safe_strdup("libdebug.lib"));
793         }
794
795         shash_add(&linkValues, "libs", joinStrSet(libFilesSet));
796         
797         lcmd = msprintf(linkValues, lfrm);
798          
799         ret = my_system( lcmd );
800          
801         Safe_free( lcmd );
802          
803         if(ret)
804                 exit(1);
805 }
806
807
808 static void
809 _pic16_finaliseOptions (void)
810 {
811     port->mem.default_local_map = data;
812     port->mem.default_globl_map = data;
813
814     /* peepholes are disabled for the time being */
815     options.nopeep = 1;
816
817     /* explicit enable peepholes for testing */
818     if(pic16_enable_peeps)
819       options.nopeep = 0;
820
821     options.all_callee_saves = 1;               // always callee saves
822
823 #if 0
824     options.float_rent = 1;
825     options.intlong_rent = 1;
826 #endif
827         
828
829     if(alt_asm && strlen(alt_asm))
830       pic16_asmCmd[0] = alt_asm;
831         
832     if(alt_link && strlen(alt_link))
833       pic16_linkCmd[0] = alt_link;
834         
835     if(!pic16_options.no_crt) {
836       pic16_options.omit_ivt = 1;
837       pic16_options.leave_reset = 0;
838     }
839     
840     if(options.model == MODEL_SMALL)
841       addSet(&asmOptionsSet, Safe_strdup("-DSDCC_MODEL_SMALL"));
842     else
843     if(options.model == MODEL_LARGE)
844       addSet(&asmOptionsSet, Safe_strdup("-DSDCC_MODEL_LARGE"));
845     
846     {
847       char buf[128];
848
849         sprintf(buf, "-D%s -D__%s", pic16->name[2], pic16->name[1]);
850         *(strrchr(buf, 'f')) = 'F';
851         addSet(&asmOptionsSet, Safe_strdup( buf ));
852     }
853     
854     if(STACK_MODEL_LARGE) {
855       addSet(&preArgvSet, Safe_strdup("-DSTACK_MODEL_LARGE"));
856       addSet(&asmOptionsSet, Safe_strdup("-DSTACK_MODEL_LARGE"));
857     } else {
858       addSet(&preArgvSet, Safe_strdup("-DSTACK_MODEL_SMALL"));
859       addSet(&asmOptionsSet, Safe_strdup("-DSTACK_MODEL_SMALL"));
860     }
861 }
862
863
864 #if 0
865   if (options.model == MODEL_LARGE)
866     {
867       port->mem.default_local_map = xdata;
868       port->mem.default_globl_map = xdata;
869     }
870   else
871     {
872       port->mem.default_local_map = data;
873       port->mem.default_globl_map = data;
874     }
875
876   if (options.stack10bit)
877     {
878       if (options.model != MODEL_FLAT24)
879         {
880           fprintf (stderr,
881                    "*** warning: 10 bit stack mode is only supported in flat24 model.\n");
882           fprintf (stderr, "\t10 bit stack mode disabled.\n");
883           options.stack10bit = 0;
884         }
885       else
886         {
887           /* Fixup the memory map for the stack; it is now in
888            * far space and requires a FPOINTER to access it.
889            */
890           istack->fmap = 1;
891           istack->ptrType = FPOINTER;
892         }
893     }
894 #endif
895
896
897 static void
898 _pic16_setDefaultOptions (void)
899 {
900   options.stackAuto = 0;                /* implicit declaration */
901   /* port is not capable yet to allocate separate registers 
902    * dedicated for passing certain parameters */
903   
904   /* initialize to defaults section locations, names and addresses */
905   pic16_sectioninfo.at_udata    = "udata";
906
907   /* set pic16 port options to defaults */
908   pic16_options.no_banksel = 0;
909   pic16_options.opt_banksel = 0;
910   pic16_options.omit_configw = 0;
911   pic16_options.omit_ivt = 0;
912   pic16_options.leave_reset = 0;
913   pic16_options.stack_model = 0;                        /* 0 for 'small', 1 for 'large' */
914   pic16_options.ivt_loc = 0x000000;
915   pic16_options.nodefaultlibs = 0;
916   pic16_options.dumpcalltree = 0;
917   pic16_options.crt_name = "crt0i.o";           /* the default crt to link */
918   pic16_options.no_crt = 0;                     /* use crt by default */
919   pic16_options.ip_stack = 1;           /* set to 1 to enable ipop/ipush for stack */
920   pic16_options.gstack = 0;
921   pic16_options.debgen = 0;
922   pic16_options.CATregs = 0;
923 }
924
925 static const char *
926 _pic16_getRegName (struct regs *reg)
927 {
928   if (reg)
929     return reg->name;
930   return "err";
931 }
932
933
934 #if 1
935 static  char *_pic16_mangleFunctionName(char *sz)
936 {
937 //      fprintf(stderr, "mangled function name: %s\n", sz);
938
939   return sz;
940 }
941 #endif
942
943
944 static void
945 _pic16_genAssemblerPreamble (FILE * of)
946 {
947   char *name = pic16_processor_base_name();
948
949         if(!name) {
950                 name = "p18f452";
951                 fprintf(stderr,"WARNING: No Pic has been selected, defaulting to %s\n",name);
952         }
953
954         fprintf (of, "\tlist\tp=%s\n",&name[1]);
955         if (pic16_mplab_comp) {
956           // provide ACCESS macro used during SFR accesses
957           fprintf (of, "\tinclude <p%s.inc>\n", &name[1]);
958         }
959
960         if(!pic16_options.omit_configw) {
961                 pic16_emitConfigRegs(of);
962                 fprintf(of, "\n");
963                 pic16_emitIDRegs(of);
964         }
965         
966   fprintf (of, "\tradix dec\n");
967 }
968
969 /* Generate interrupt vector table. */
970 static int
971 _pic16_genIVT (FILE * of, symbol ** interrupts, int maxInterrupts)
972 {
973 #if 1
974         /* PIC18F family has only two interrupts, the high and the low
975          * priority interrupts, which reside at 0x0008 and 0x0018 respectively - VR */
976
977         if((!pic16_options.omit_ivt) || (pic16_options.omit_ivt && pic16_options.leave_reset)) {
978                 fprintf(of, "; RESET vector\n");
979                 fprintf(of, "\tgoto\t__sdcc_gsinit_startup\n");
980         }
981         
982         if(!pic16_options.omit_ivt) {
983                 fprintf(of, "\tres 4\n");
984
985
986                 fprintf(of, "; High priority interrupt vector 0x0008\n");
987                 if(interrupts[1]) {
988                         fprintf(of, "\tgoto\t%s\n", interrupts[1]->rname);
989                         fprintf(of, "\tres\t12\n"); 
990                 } else {
991                         fprintf(of, "\tretfie\n");
992                         fprintf(of, "\tres\t14\n");
993                 }
994
995                 fprintf(of, "; Low priority interrupt vector 0x0018\n");
996                 if(interrupts[2]) {
997                         fprintf(of, "\tgoto\t%s\n", interrupts[2]->rname);
998                 } else {
999                         fprintf(of, "\tretfie\n");
1000                 }
1001         }
1002 #endif
1003   return TRUE;
1004 }
1005
1006 /* return True if the port can handle the type,
1007  * False to convert it to function call */
1008 static bool _hasNativeMulFor (iCode *ic, sym_link *left, sym_link *right)
1009 {
1010   //fprintf(stderr,"checking for native mult for %c (size: %d)\n", ic->op, getSize(OP_SYMBOL(IC_RESULT(ic))->type));
1011   int symL, symR, symRes, sizeL = 0, sizeR = 0, sizeRes = 0;
1012
1013   /* left/right are symbols? */
1014   symL = IS_SYMOP(IC_LEFT(ic));
1015   symR = IS_SYMOP(IC_RIGHT(ic));
1016   symRes = IS_SYMOP(IC_RESULT(ic));
1017
1018   /* --> then determine their sizes */
1019   sizeL = symL ? getSize(OP_SYM_TYPE(IC_LEFT(ic))) : 4;
1020   sizeR = symR ? getSize(OP_SYM_TYPE(IC_RIGHT(ic))) : 4;
1021   sizeRes = symRes ? getSize(OP_SYM_TYPE(IC_RESULT(ic))) : 4;
1022
1023   /* Checks to enable native multiplication.
1024    * PICs do not offer native division at all...
1025    *
1026    * Ideas:
1027    * (  i) if result is just one byte, use native MUL
1028    *       (regardless of the operands)
1029    * ( ii) if left and right are unsigned 8-bit operands,
1030    *       use native MUL
1031    * (iii) if left or right is a literal in the range of [-128..256)
1032    *       and the other is an unsigned byte, use native MUL
1033    */
1034   if (ic->op == '*')
1035   {
1036     /* use native mult for `*: <?> x <?> --> {u8_t, s8_t}' */
1037     if (sizeRes == 1) { return TRUE; }
1038
1039     /* use native mult for `u8_t x u8_t --> { u16_t, s16_t }' */
1040     if (sizeL == 1 && symL /*&& SPEC_USIGN(OP_SYM_TYPE(IC_LEFT(ic)))*/) {
1041       sizeL = 1;
1042     } else {
1043       //printf( "%s: left too large (%u) / signed (%u)\n", __FUNCTION__, sizeL, symL && !SPEC_USIGN(OP_SYM_TYPE(IC_LEFT(ic))));
1044       sizeL = 4;
1045     }
1046     if (sizeR == 1 && symR /*&& SPEC_USIGN(OP_SYM_TYPE(IC_RIGHT(ic)))*/) {
1047       sizeR = 1;
1048     } else {
1049       //printf( "%s: right too large (%u) / signed (%u)\n", __FUNCTION__, sizeR, symR && !SPEC_USIGN(OP_SYM_TYPE(IC_RIGHT(ic))));
1050       sizeR = 4;
1051     }
1052
1053     /* also allow literals [-128..256) for left/right operands */
1054     if (IS_VALOP(IC_LEFT(ic)))
1055     {
1056       long l = (long)floatFromVal( OP_VALUE( IC_LEFT(ic) ) );
1057       sizeL = 4;
1058       //printf( "%s: val(left) = %ld\n", __FUNCTION__, l );
1059       if (l >= -128 && l < 256)
1060       {
1061         sizeL = 1;
1062       } else {
1063         //printf( "%s: left value %ld outside [-128..256)\n", __FUNCTION__, l );
1064       }
1065     }
1066     if (IS_VALOP( IC_RIGHT(ic) ))
1067     {
1068       long l = (long)floatFromVal( OP_VALUE( IC_RIGHT(ic) ) );
1069       sizeR = 4;
1070       //printf( "%s: val(right) = %ld\n", __FUNCTION__, l );
1071       if (l >= -128 && l < 256)
1072       {
1073         sizeR = 1;
1074       } else {
1075         //printf( "%s: right value %ld outside [-128..256)\n", __FUNCTION__, l );
1076       }
1077     }
1078
1079     /* use native mult iff left and right are (unsigned) 8-bit operands */
1080     if (sizeL == 1 && sizeR == 1) { return TRUE; }
1081   }
1082
1083   if (ic->op == '/' || ic->op == '%')
1084   {
1085     /* We must catch /: {u8_t,s8_t} x {u8_t,s8_t} --> {u8_t,s8_t},
1086      * because SDCC will call 'divuchar' even for u8_t / s8_t.
1087      * Example: 128 / -2 becomes 128 / 254 = 0 != -64... */
1088     if (sizeL == 1 && sizeR == 1) return TRUE;
1089
1090     /* What about literals? */
1091     if (IS_VALOP( IC_LEFT(ic) ))
1092     {
1093       long l = (long)floatFromVal( OP_VALUE( IC_LEFT(ic) ) );
1094       sizeL = 4;
1095       //printf( "%s: val(left) = %ld\n", __FUNCTION__, l );
1096       if (l >= -128 && l < 256)
1097       {
1098         sizeL = 1;
1099       } else {
1100         //printf( "%s: left value %ld outside [-128..256)\n", __FUNCTION__, l );
1101       }
1102     }
1103     if (IS_VALOP( IC_RIGHT(ic) ))
1104     {
1105       long l = (long)floatFromVal( OP_VALUE( IC_RIGHT(ic) ) );
1106       sizeR = 4;
1107       //printf( "%s: val(right) = %ld\n", __FUNCTION__, l );
1108       if (l >= -128 && l < 256)
1109       {
1110         sizeR = 1;
1111       } else {
1112         //printf( "%s: right value %ld outside [-128..256)\n", __FUNCTION__, l );
1113       }
1114     }
1115     if (sizeL == 1 && sizeR == 1) { return TRUE; }
1116   }
1117
1118   return FALSE;
1119 }
1120
1121
1122 #if 0
1123 /* Do CSE estimation */
1124 static bool cseCostEstimation (iCode *ic, iCode *pdic)
1125 {
1126 //    operand *result = IC_RESULT(ic);
1127 //    sym_link *result_type = operandType(result);
1128
1129
1130         /* VR -- this is an adhoc. Put here after conversation
1131          * with Erik Epetrich */
1132
1133         if(ic->op == '<'
1134                 || ic->op == '>'
1135                 || ic->op == EQ_OP) {
1136
1137                 fprintf(stderr, "%d %s\n", __LINE__, __FUNCTION__);
1138           return 0;
1139         }
1140
1141 #if 0
1142     /* if it is a pointer then return ok for now */
1143     if (IC_RESULT(ic) && IS_PTR(result_type)) return 1;
1144
1145     /* if bitwise | add & subtract then no since mcs51 is pretty good at it
1146        so we will cse only if they are local (i.e. both ic & pdic belong to
1147        the same basic block */
1148     if (IS_BITWISE_OP(ic) || ic->op == '+' || ic->op == '-') {
1149         /* then if they are the same Basic block then ok */
1150         if (ic->eBBlockNum == pdic->eBBlockNum) return 1;
1151         else return 0;
1152     }
1153 #endif
1154
1155     /* for others it is cheaper to do the cse */
1156     return 1;
1157 }
1158 #endif
1159
1160
1161 /* Indicate which extended bit operations this port supports */
1162 static bool
1163 hasExtBitOp (int op, int size)
1164 {
1165   if (op == RRC
1166       || op == RLC
1167       /* || op == GETHBIT */ /* GETHBIT doesn't look complete for PIC */
1168      )
1169     return TRUE;
1170   else
1171     return FALSE;
1172 }
1173
1174 /* Indicate the expense of an access to an output storage class */
1175 static int
1176 oclsExpense (struct memmap *oclass)
1177 {
1178   /* The IN_FARSPACE test is compatible with historical behaviour, */
1179   /* but I don't think it is applicable to PIC. If so, please feel */
1180   /* free to remove this test -- EEP */
1181   if (IN_FARSPACE(oclass))
1182     return 1;
1183     
1184   return 0;
1185 }
1186
1187 /** $1 is the input object file (PIC16 specific)        // >>always the basename<<.
1188     $2 is always the output file.
1189     $3 -L path and -l libraries
1190     $l is the list of extra options that should be there somewhere...
1191     MUST be terminated with a NULL.
1192 */
1193 const char *pic16_linkCmd[] =
1194 {
1195   "gplink", "$l", "-w", "-r", "-o \"$2\"", "\"$1\"","$3", NULL
1196 };
1197
1198
1199
1200 /** $1 is always the basename.
1201     $2 is always the output file.
1202     $3 varies (nothing currently)
1203     $l is the list of extra options that should be there somewhere...
1204     MUST be terminated with a NULL.
1205 */
1206 const char *pic16_asmCmd[] =
1207 {
1208   "gpasm", "$l", "$3", "-c", "\"$1.asm\"", "-o \"$2\"", NULL
1209
1210 };
1211
1212 /* Globals */
1213 PORT pic16_port =
1214 {
1215   TARGET_ID_PIC16,
1216   "pic16",
1217   "MCU PIC16",                  /* Target name */
1218   "p18f452",                    /* Processor */
1219   {
1220     pic16glue,
1221     TRUE,                       /* Emit glue around main */
1222     MODEL_SMALL | MODEL_LARGE | MODEL_FLAT24,
1223     MODEL_SMALL
1224   },
1225   {
1226     pic16_asmCmd,               /* assembler command and arguments */
1227     NULL,                       /* alternate macro based form */
1228     "-g",                       /* arguments for debug mode */
1229     NULL,                       /* arguments for normal mode */
1230     0,                          /* print externs as global */
1231     ".asm",                     /* assembler file extension */
1232     NULL                        /* no do_assemble function */
1233   },
1234   {
1235     NULL,                       //    pic16_linkCmd,            /* linker command and arguments */
1236     NULL,                       /* alternate macro based form */
1237     _pic16_linkEdit,            //NULL,                 /* no do_link function */
1238     ".o",                       /* extension for object files */
1239     0                           /* no need for linker file */
1240   },
1241   {
1242     _defaultRules
1243   },
1244   {
1245         /* Sizes */
1246     1,          /* char */
1247     2,          /* short */
1248     2,          /* int */
1249     4,          /* long */
1250     2,          /* ptr */
1251     3,          /* fptr, far pointers (see Microchip) */
1252     3,          /* gptr */
1253     1,          /* bit */
1254     4,          /* float */
1255     4           /* max */
1256   },
1257
1258     /* generic pointer tags */
1259   {
1260     0x00,       /* far */
1261     0x80,       /* near */
1262     0x00,       /* xstack */
1263     0x00        /* code */
1264   },
1265   
1266   {
1267     "XSEG    (XDATA)",          // xstack
1268     "STACK   (DATA)",           // istack
1269     "CSEG    (CODE)",           // code
1270     "DSEG    (DATA)",           // data
1271     "ISEG    (DATA)",           // idata
1272     "PSEG    (DATA)",           // pdata
1273     "XSEG    (XDATA)",          // xdata
1274     "BSEG    (BIT)",            // bit
1275     "RSEG    (DATA)",           // reg
1276     "GSINIT  (CODE)",           // static
1277     "OSEG    (OVR,DATA)",       // overlay
1278     "GSFINAL (CODE)",           // post static
1279     "HOME    (CODE)",   // home
1280     NULL,                       // xidata
1281     NULL,                       // xinit
1282     "CONST   (CODE)",           // const_name - const data (code or not)
1283     "CABS    (ABS,CODE)",       // cabs_name - const absolute data (code or not)
1284     NULL,                       // default location for auto vars
1285     NULL,                       // default location for global vars
1286     1                           // code is read only 1=yes
1287   },
1288   {
1289     NULL,               /* genExtraAreaDeclaration */
1290     NULL                /* genExatrAreaLinkOptions */
1291   },
1292   {
1293         /* stack related information */
1294     -1,                 /* -1 stack grows downwards, +1 upwards */
1295     1,                  /* extra overhead when calling between banks */
1296     4,                  /* extra overhead when the function is an ISR */
1297     1,                  /* extra overhead for a function call */
1298     1,                  /* re-entrant space */
1299     0                   /* 'banked' call overhead, mild overlap with bank_overhead */
1300   },
1301     /* pic16 has an 8 bit mul */
1302   {
1303      0, -1
1304   },
1305   {
1306     pic16_emitDebuggerSymbol
1307   },
1308   {
1309     255/3,      /* maxCount */
1310     3,          /* sizeofElement */
1311     /* The rest of these costs are bogus. They approximate */
1312     /* the behavior of src/SDCCicode.c 1.207 and earlier.  */
1313     {4,4,4},    /* sizeofMatchJump[] */
1314     {0,0,0},    /* sizeofRangeCompare[] */
1315     0,          /* sizeofSubtract */
1316     3,          /* sizeofDispatch */
1317   },
1318   "_",
1319   _pic16_init,
1320   _pic16_parseOptions,
1321   pic16_optionsTable,
1322   _pic16_initPaths,
1323   _pic16_finaliseOptions,
1324   _pic16_setDefaultOptions,
1325   pic16_assignRegisters,
1326   _pic16_getRegName,
1327   _pic16_keywords,
1328   _pic16_genAssemblerPreamble,
1329   NULL,                         /* no genAssemblerEnd */
1330   _pic16_genIVT,
1331   NULL, // _pic16_genXINIT
1332   NULL,                         /* genInitStartup */
1333   _pic16_reset_regparm,
1334   _pic16_regparm,
1335   _process_pragma,                              /* process a pragma */
1336   _pic16_mangleFunctionName,                            /* mangles function name */
1337   _hasNativeMulFor,
1338   hasExtBitOp,                  /* hasExtBitOp */
1339   oclsExpense,                  /* oclsExpense */
1340   FALSE,                        
1341   TRUE,                         /* little endian */
1342   0,                            /* leave lt */
1343   0,                            /* leave gt */
1344   1,                            /* transform <= to ! > */
1345   1,                            /* transform >= to ! < */
1346   1,                            /* transform != to !(a == b) */
1347   0,                            /* leave == */
1348   FALSE,                        /* No array initializer support. */
1349   0,    //cseCostEstimation,            /* !!!no CSE cost estimation yet */
1350   NULL,                         /* no builtin functions */
1351   GPOINTER,                     /* treat unqualified pointers as "generic" pointers */
1352   1,                            /* reset labelKey to 1 */
1353   1,                            /* globals & local static allowed */
1354   PORT_MAGIC
1355 };