1 /*-------------------------------------------------------------------------
3 main.c - pic16 specific general functions.
5 Written by - Scott Dattalo scott@dattalo.com
6 Ported to PIC16 by - Martin Dubuc m.debuc@rogers.com
8 Note that mlh prepended _pic16_ on the static functions. Makes
9 it easier to set a breakpoint using the debugger.
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
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.
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 -------------------------------------------------------------------------*/
37 static char _defaultRules[] =
42 /* list of key words used by pic16 */
43 static char *_pic16_keywords[] =
73 pic16_sectioninfo_t pic16_sectioninfo;
76 extern char *pic16_processor_base_name(void);
78 void pic16_pCodeInitRegisters(void);
80 void pic16_assignRegisters (eBBlock ** ebbs, int count);
82 static int regParmFlg = 0; /* determine if we can register a parameter */
84 pic16_options_t pic16_options;
86 extern set *includeDirsSet;
87 extern set *dataDirsSet;
88 extern set *libFilesSet;
90 /* Also defined in gen.h, but the #include is commented out */
91 /* for an unknowned reason. - EEP */
92 void pic16_emitDebuggerSymbol (char *);
94 extern regs* newReg(short type, short pc_type, int rIdx, char *name, int size, int alias, operand *refop);
95 extern void pic16_emitConfigRegs(FILE *of);
96 extern void pic16_emitIDRegs(FILE *of);
103 asm_addTree (&asm_asxxxx_mapping);
104 pic16_pCodeInitRegisters();
107 /* set pic16 port options to defaults */
108 pic16_options.no_banksel = 0;
109 pic16_options.opt_banksel = 0;
110 pic16_options.omit_configw = 0;
111 pic16_options.omit_ivt = 0;
112 pic16_options.leave_reset = 0;
113 pic16_options.stack_model = 0; /* 0 for 'small', 1 for 'large' */
114 pic16_options.ivt_loc = 0x000000; /* default location of interrupt vectors */
115 pic16_options.nodefaultlibs = 0; /* link default libraries */
116 pic16_options.dumpcalltree = 0;
120 _pic16_reset_regparm ()
126 _pic16_regparm (sym_link * l)
128 /* for this processor it is simple
129 * can pass only the first parameter in a register */
131 if(regParmFlg)return 0;
141 int initsfpnt=0; /* set to 1 if source provides a pragma for stack
142 * so glue() later emits code to initialize stack/frame pointers */
145 set *sectNames=NULL; /* list of section listed in pragma directives */
146 set *sectSyms=NULL; /* list of symbols set in a specific section */
150 _process_pragma(const char *sz)
152 static const char *WHITE = " \t\n";
154 char *ptr = strtok((char *)sz, WHITE);
156 /* #pragma maxram [maxram] */
157 if (startsWith (ptr, "maxram")) {
158 char *maxRAM = strtok((char *)NULL, WHITE);
160 if (maxRAM != (char *)NULL) {
164 maxRAMVal = constVal(maxRAM);
165 maxRAMaddress = (int)floatFromVal(maxRAMVal);
166 pic16_setMaxRAM(maxRAMaddress);
170 /* #pragma stack [stack-position] [stack-len] */
171 if(startsWith(ptr, "stack")) {
172 char *stackPosS = strtok((char *)NULL, WHITE);
173 char *stackLenS = strtok((char *)NULL, WHITE);
179 stackPosVal = constVal( stackPosS );
180 stackPos = (unsigned int)floatFromVal( stackPosVal );
184 stackLenVal = constVal( stackLenS );
185 stackLen = (unsigned int)floatFromVal( stackLenVal );
190 fprintf(stderr, "%s:%d setting stack to default size 0x%x\n", __FILE__, __LINE__, stackLen);
193 // fprintf(stderr, "Initializing stack pointer at 0x%x len 0x%x\n", stackPos, stackLen);
195 reg=newReg(REG_SFR, PO_SFR_REGISTER, stackPos, "_stack", stackLen-1, 0, NULL);
196 addSet(&pic16_fix_udata, reg);
198 reg = newReg(REG_SFR, PO_SFR_REGISTER, stackPos + stackLen-1, "_stack_end", 1, 0, NULL);
199 addSet(&pic16_fix_udata, reg);
201 sym = newSymbol("stack", 0);
202 sprintf(sym->rname, "_%s", sym->name);
203 addSet(&publics, sym);
205 sym = newSymbol("stack_end", 0);
206 sprintf(sym->rname, "_%s", sym->name);
207 addSet(&publics, sym);
209 initsfpnt = 1; // force glue() to initialize stack/frame pointers */
214 /* #pragma code [symbol] [location] */
215 if(startsWith(ptr, "code")) {
216 char *symname = strtok((char *)NULL, WHITE);
217 char *location = strtok((char *)NULL, WHITE);
221 absS = Safe_calloc(1, sizeof(absSym));
222 absS->name = Safe_strdup( symname );
223 addr = constVal( location );
224 absS->address = (unsigned int)floatFromVal( addr );
226 addSet(&absSymSet, absS);
227 fprintf(stderr, "%s:%d symbol %s will be placed in location 0x%06x in code memory\n",
228 __FILE__, __LINE__, symname, absS->address);
233 /* #pragma udata [section-name] [symbol] */
234 if(startsWith(ptr, "udata")) {
235 char *sectname = strtok((char *)NULL, WHITE);
236 char *symname = strtok((char *)NULL, WHITE);
243 ssym = Safe_calloc(1, sizeof(sectSyms));
244 ssym->name = Safe_calloc(1, strlen(symname)+2);
245 sprintf(ssym->name, "_%s", symname);
248 addSet(§Syms, ssym);
251 for(snam=setFirstItem(sectNames);snam;snam=setNextItem(sectNames)) {
252 if(!strcmp(sectname, snam->name)){ found=1; break; }
256 snam = Safe_calloc(1, sizeof(sectNames));
257 snam->name = Safe_strdup( sectname );
258 snam->regsSet = NULL;
260 addSet(§Names, snam);
263 ssym->section = snam;
265 // fprintf(stderr, "%s:%d placing symbol %s at section %s (%p)\n", __FILE__, __LINE__,
266 // ssym->name, snam->name, snam);
268 symname = strtok((char *)NULL, WHITE);
277 #define REP_UDATA "--preplace-udata-with="
279 #define STACK_MODEL "--pstack-model="
280 #define OPT_BANKSEL "--obanksel="
282 #define ALT_ASM "--asm="
283 #define ALT_LINK "--link="
285 #define IVT_LOC "--ivt-loc"
286 #define NO_DEFLIBS "--nodefaultlibs"
287 #define MPLAB_COMPAT "--mplab-comp"
289 #define NL_OPT "--nl="
294 int pic16_mplab_comp=0;
295 extern int pic16_debug_verbose;
296 extern int pic16_ralloc_debug;
297 extern int pic16_pcode_verbose;
300 int pic16_enable_peeps=0;
301 int pic16_nl=0; /* 0 for LF, 1 for CRLF */
303 OPTION pic16_optionsTable[]= {
304 { 0, NO_DEFLIBS, &pic16_options.nodefaultlibs, "do not link default libraries when linking"},
305 { 0, "--pno-banksel", &pic16_options.no_banksel, "do not generate BANKSEL assembler directives"},
306 { 0, OPT_BANKSEL, NULL, "set banksel optimization level (default=0 no)"},
307 { 0, "--pomit-config-words", &pic16_options.omit_configw, "omit the generation of configuration words"},
308 { 0, "--pomit-ivt", &pic16_options.omit_ivt, "omit the generation of the Interrupt Vector Table"},
309 { 0, "--pleave-reset-vector",&pic16_options.leave_reset, "when omitting IVT leave RESET vector"},
310 { 0, STACK_MODEL, NULL, "use stack model 'small' (default) or 'large'"},
312 { 0, "--debug-xtra", &pic16_debug_verbose, "show more debug info in assembly output"},
313 { 0, "--debug-ralloc", &pic16_ralloc_debug, "dump register allocator debug file *.d"},
314 { 0, "--pcode-verbose", &pic16_pcode_verbose, "dump pcode related info"},
316 { 0, REP_UDATA, NULL, "Place udata variables at another section: udata_acs, udata_ovr, udata_shr"},
318 { 0, ALT_ASM, NULL, "Use alternative assembler"},
319 { 0, ALT_LINK, NULL, "Use alternative linker"},
321 { 0, "--denable-peeps", &pic16_enable_peeps, "explicit enable of peepholes"},
322 { 0, IVT_LOC, NULL, "<nnnn> interrupt vector table location"},
323 { 0, "--calltree", &pic16_options.dumpcalltree, "dump call tree in .calltree file"},
324 { 0, MPLAB_COMPAT, &pic16_mplab_comp, "enable compatibility mode for MPLAB utilities (MPASM/MPLINK)"},
325 { 0, "--fstack", &pic16_fstack, "enable stack optimizations"},
326 { 0, NL_OPT, NULL, "new line, \"lf\" or \"crlf\""},
327 { 0, NULL, NULL, NULL}
331 #define ISOPT(str) !strncmp(argv[ *i ], str, strlen(str) )
333 extern char *getStringArg(const char *, char **, int *, int);
334 extern int getIntArg(const char *, char **, int *, int);
337 _pic16_parseOptions (int *pargc, char **argv, int *i)
342 /* TODO: allow port-specific command line options to specify
343 * segment names here.
345 /* check for arguments that have associated an integer variable */
346 while(pic16_optionsTable[j].pparameter) {
347 if(ISOPT( pic16_optionsTable[j].longOpt )) {
348 (*pic16_optionsTable[j].pparameter)++;
355 if(ISOPT(STACK_MODEL)) {
356 stkmodel = getStringArg(STACK_MODEL, argv, i, *pargc);
357 if(!STRCASECMP(stkmodel, "small"))pic16_options.stack_model = 0;
358 else if(!STRCASECMP(stkmodel, "large"))pic16_options.stack_model = 1;
360 fprintf(stderr, "Unknown stack model: %s", stkmodel);
366 if(ISOPT(OPT_BANKSEL)) {
367 pic16_options.opt_banksel = getIntArg(OPT_BANKSEL, argv, i, *pargc);
371 if(ISOPT(REP_UDATA)) {
372 pic16_sectioninfo.at_udata = Safe_strdup(getStringArg(REP_UDATA, argv, i, *pargc));
377 alt_asm = Safe_strdup(getStringArg(ALT_ASM, argv, i, *pargc));
381 if(ISOPT(ALT_LINK)) {
382 alt_link = Safe_strdup(getStringArg(ALT_LINK, argv, i, *pargc));
387 pic16_options.ivt_loc = getIntArg(IVT_LOC, argv, i, *pargc);
394 tmp = Safe_strdup( getStringArg(NL_OPT, argv, i, *pargc) );
395 if(!STRCASECMP(tmp, "lf"))pic16_nl = 0;
396 else if(!STRCASECMP(tmp, "crlf"))pic16_nl = 1;
398 fprintf(stderr, "invalid termination character id\n");
407 static void _pic16_initPaths(void)
409 char pic16incDir[512];
410 char pic16libDir[512];
411 set *pic16incDirsSet;
412 set *pic16libDirsSet;
415 setMainValue("mcu", pic16->name[2] );
416 addSet(&preArgvSet, Safe_strdup("-D{mcu}"));
418 sprintf(pic16incDir, "%s%cpic16", INCLUDE_DIR_SUFFIX, DIR_SEPARATOR_CHAR);
419 sprintf(pic16libDir, "%s%cpic16", LIB_DIR_SUFFIX, DIR_SEPARATOR_CHAR);
421 if(!options.nostdinc) {
422 /* setup pic16 include directory */
423 pic16incDirsSet = appendStrSet(dataDirsSet, NULL, pic16incDir);
424 mergeSets(&includeDirsSet, pic16incDirsSet);
427 if(!options.nostdlib) {
428 /* setup pic16 library directory */
429 pic16libDirsSet = appendStrSet(dataDirsSet, NULL, pic16libDir);
430 mergeSets(&libDirsSet, pic16libDirsSet);
433 if(!pic16_options.nodefaultlibs) {
434 /* now add the library for the device */
435 sprintf(devlib, "%s.lib", pic16->name[2]);
436 addSet(&libFilesSet, Safe_strdup(devlib));
440 extern set *linkOptionsSet;
441 char *msprintf(hTab *pvals, const char *pformat, ...);
442 int my_system(const char *cmd);
444 /* custom function to link objects */
445 static void _pic16_linkEdit(void)
447 hTab *linkValues=NULL;
455 * link command format:
456 * {linker} {incdirs} {lflags} -o {outfile} {spec_ofiles} {ofiles} {libs}
460 sprintf(lfrm, "{linker} {incdirs} {lflags} -o {outfile} {spec_ofiles} {ofiles} {libs}");
462 shash_add(&linkValues, "linker", "gplink");
464 mergeSets(&tSet, libDirsSet);
465 mergeSets(&tSet, libPathsSet);
467 shash_add(&linkValues, "incdirs", joinStrSet( appendStrSet(tSet, "-I\"", "\"")));
468 shash_add(&linkValues, "lflags", joinStrSet(linkOptionsSet));
470 shash_add(&linkValues, "outfile", dstFileName);
472 if(fullSrcFileName) {
473 sprintf(temp, "%s.o", dstFileName);
474 // shash_add(&linkValues, "srcofile", temp);
475 addSetHead(&relFilesSet, temp);
478 // shash_add(&linkValues, "spec_ofiles", "crt0i.o");
479 shash_add(&linkValues, "ofiles", joinStrSet(relFilesSet));
480 shash_add(&linkValues, "libs", joinStrSet(libFilesSet));
482 lcmd = msprintf(linkValues, lfrm);
484 ret = my_system( lcmd );
493 /* forward declarations */
494 extern const char *pic16_linkCmd[];
495 extern const char *pic16_asmCmd[];
498 _pic16_finaliseOptions (void)
500 port->mem.default_local_map = data;
501 port->mem.default_globl_map = data;
503 /* peepholes are disabled for the time being */
506 /* explicit enable peepholes for testing */
507 if(pic16_enable_peeps)
510 options.all_callee_saves = 1; // always callee saves
511 // options.float_rent = 1;
512 // options.intlong_rent = 1;
515 if(alt_asm && strlen(alt_asm))
516 pic16_asmCmd[0] = alt_asm;
518 if(alt_link && strlen(alt_link))
519 pic16_linkCmd[0] = alt_link;
523 /* all the rest is commented ifdef'd out */
525 /* Hack-o-matic: if we are using the flat24 model,
526 * adjust pointer sizes.
528 if (options.model == MODEL_FLAT24)
531 fprintf (stderr, "*** WARNING: you should use the '-mds390' option "
532 "for DS80C390 support. This code generator is "
533 "badly out of date and probably broken.\n");
535 port->s.fptr_size = 3;
536 port->s.gptr_size = 4;
537 port->stack.isr_overhead++; /* Will save dpx on ISR entry. */
539 port->stack.call_overhead++; /* This acounts for the extra byte
540 * of return addres on the stack.
541 * but is ugly. There must be a
545 fReturn = fReturn390;
549 if (options.model == MODEL_LARGE)
551 port->mem.default_local_map = xdata;
552 port->mem.default_globl_map = xdata;
556 port->mem.default_local_map = data;
557 port->mem.default_globl_map = data;
560 if (options.stack10bit)
562 if (options.model != MODEL_FLAT24)
565 "*** warning: 10 bit stack mode is only supported in flat24 model.\n");
566 fprintf (stderr, "\t10 bit stack mode disabled.\n");
567 options.stack10bit = 0;
571 /* Fixup the memory map for the stack; it is now in
572 * far space and requires a FPOINTER to access it.
575 istack->ptrType = FPOINTER;
582 _pic16_setDefaultOptions (void)
584 /* initialize to defaults section locations, names and addresses */
585 pic16_sectioninfo.at_udata = "udata";
587 /* set pic16 port options to defaults */
588 pic16_options.no_banksel = 0;
589 pic16_options.opt_banksel = 0;
590 pic16_options.omit_configw = 0;
591 pic16_options.omit_ivt = 0;
592 pic16_options.leave_reset = 0;
593 pic16_options.stack_model = 0; /* 0 for 'small', 1 for 'large' */
594 pic16_options.ivt_loc = 0x000000;
595 pic16_options.nodefaultlibs = 0;
596 pic16_options.dumpcalltree = 0;
600 _pic16_getRegName (struct regs *reg)
609 static char *_pic16_mangleFunctionName(char *sz)
611 // fprintf(stderr, "mangled function name: %s\n", sz);
619 _pic16_genAssemblerPreamble (FILE * of)
621 char *name = pic16_processor_base_name();
625 fprintf(stderr,"WARNING: No Pic has been selected, defaulting to %s\n",name);
628 fprintf (of, "\tlist\tp=%s\n",&name[1]);
630 if(!pic16_options.omit_configw) {
631 pic16_emitConfigRegs(of);
633 pic16_emitIDRegs(of);
636 fprintf (of, "\tradix dec\n");
639 /* Generate interrupt vector table. */
641 _pic16_genIVT (FILE * of, symbol ** interrupts, int maxInterrupts)
644 /* PIC18F family has only two interrupts, the high and the low
645 * priority interrupts, which reside at 0x0008 and 0x0018 respectively - VR */
647 if((!pic16_options.omit_ivt) || (pic16_options.omit_ivt && pic16_options.leave_reset)) {
648 fprintf(of, "; RESET vector\n");
649 fprintf(of, "\tgoto\t__sdcc_gsinit_startup\n");
652 if(!pic16_options.omit_ivt) {
653 fprintf(of, "\tres 4\n");
656 fprintf(of, "; High priority interrupt vector 0x0008\n");
658 fprintf(of, "\tgoto\t%s\n", interrupts[1]->rname);
659 fprintf(of, "\tres\t12\n");
661 fprintf(of, "\tretfie\n");
662 fprintf(of, "\tres\t14\n");
665 fprintf(of, "; Low priority interrupt vector 0x0018\n");
667 fprintf(of, "\tgoto\t%s\n", interrupts[2]->rname);
669 fprintf(of, "\tretfie\n");
676 /* return True if the port can handle the type,
677 * False to convert it to function call */
678 static bool _hasNativeMulFor (iCode *ic, sym_link *left, sym_link *right)
680 // fprintf(stderr,"checking for native mult for %c (size: %d)\n", ic->op, getSize(OP_SYMBOL(IC_RESULT(ic))->type));
683 /* multiplication is fixed */
684 /* support mul for char/int/long */
685 if((getSize(OP_SYMBOL(IC_LEFT(ic))->type ) <= 4)
686 && (ic->op == '*'))return TRUE;
690 /* support div for char/int/long */
691 if((getSize(OP_SYMBOL(IC_LEFT(ic))->type ) <= 0)
692 && (ic->op == '/'))return TRUE;
700 /* Do CSE estimation */
701 static bool cseCostEstimation (iCode *ic, iCode *pdic)
703 // operand *result = IC_RESULT(ic);
704 // sym_link *result_type = operandType(result);
707 /* VR -- this is an adhoc. Put here after conversation
708 * with Erik Epetrich */
712 || ic->op == EQ_OP) {
714 fprintf(stderr, "%d %s\n", __LINE__, __FUNCTION__);
719 /* if it is a pointer then return ok for now */
720 if (IC_RESULT(ic) && IS_PTR(result_type)) return 1;
722 /* if bitwise | add & subtract then no since mcs51 is pretty good at it
723 so we will cse only if they are local (i.e. both ic & pdic belong to
724 the same basic block */
725 if (IS_BITWISE_OP(ic) || ic->op == '+' || ic->op == '-') {
726 /* then if they are the same Basic block then ok */
727 if (ic->eBBlockNum == pdic->eBBlockNum) return 1;
732 /* for others it is cheaper to do the cse */
738 /* Indicate which extended bit operations this port supports */
740 hasExtBitOp (int op, int size)
744 /* || op == GETHBIT */ /* GETHBIT doesn't look complete for PIC */
751 /* Indicate the expense of an access to an output storage class */
753 oclsExpense (struct memmap *oclass)
755 /* The IN_FARSPACE test is compatible with historical behaviour, */
756 /* but I don't think it is applicable to PIC. If so, please feel */
757 /* free to remove this test -- EEP */
758 if (IN_FARSPACE(oclass))
764 /** $1 is the input object file (PIC16 specific) // >>always the basename<<.
765 $2 is always the output file.
766 $3 -L path and -l libraries
767 $l is the list of extra options that should be there somewhere...
768 MUST be terminated with a NULL.
770 const char *pic16_linkCmd[] =
772 "gplink", "$l", "-o \"$2\"", "\"$1\"","$3", NULL
777 /** $1 is always the basename.
778 $2 is always the output file.
779 $3 varies (nothing currently)
780 $l is the list of extra options that should be there somewhere...
781 MUST be terminated with a NULL.
783 const char *pic16_asmCmd[] =
785 "gpasm", "$l", "$3", "-c", "\"$1.asm\"", "-o \"$2\"", NULL
794 "MCU PIC16", /* Target name */
795 "p18f452", /* Processor */
798 TRUE, /* Emit glue around main */
799 MODEL_SMALL | MODEL_LARGE | MODEL_FLAT24,
803 pic16_asmCmd, /* assembler command and arguments */
804 NULL, /* alternate macro based form */
805 "-g", /* arguments for debug mode */
806 NULL, /* arguments for normal mode */
807 0, /* print externs as global */
808 ".asm", /* assembler file extension */
809 NULL /* no do_assemble function */
812 NULL, // pic16_linkCmd, /* linker command and arguments */
813 NULL, /* alternate macro based form */
814 _pic16_linkEdit, //NULL, /* no do_link function */
815 ".o", /* extension for object files */
816 0 /* no need for linker file */
828 3, /* fptr, far pointers (see Microchip) */
835 "XSEG (XDATA)", // xstack
836 "STACK (DATA)", // istack
837 "CSEG (CODE)", // code
838 "DSEG (DATA)", // data
839 "ISEG (DATA)", // idata
840 "XSEG (XDATA)", // xdata
842 "RSEG (DATA)", // reg
843 "GSINIT (CODE)", // static
844 "OSEG (OVR,DATA)", // overlay
845 "GSFINAL (CODE)", // post static
846 "HOME (CODE)", // home
849 NULL, // default location for auto vars
850 NULL, // default location for global vars
851 1 // code is read only 1=yes
854 NULL, /* genExtraAreaDeclaration */
855 NULL /* genExatrAreaLinkOptions */
858 /* stack related information */
859 -1, /* -1 stack grows downwards, +1 upwards */
860 1, /* extra overhead when calling between banks */
861 4, /* extra overhead when the function is an ISR */
862 1, /* extra overhead for a function call */
863 1, /* re-entrant space */
864 0 /* 'banked' call overhead, mild overlap with bank_overhead */
866 /* pic16 has an 8 bit mul */
871 pic16_emitDebuggerSymbol
878 _pic16_finaliseOptions,
879 _pic16_setDefaultOptions,
880 pic16_assignRegisters,
883 _pic16_genAssemblerPreamble,
884 NULL, /* no genAssemblerEnd */
886 NULL, // _pic16_genXINIT
887 NULL, /* genInitStartup */
888 _pic16_reset_regparm,
890 _process_pragma, /* process a pragma */
891 _pic16_mangleFunctionName, /* mangles function name */
893 hasExtBitOp, /* hasExtBitOp */
894 oclsExpense, /* oclsExpense */
896 TRUE, /* little endian */
899 1, /* transform <= to ! > */
900 1, /* transform >= to ! < */
901 1, /* transform != to !(a == b) */
903 FALSE, /* No array initializer support. */
904 0, //cseCostEstimation, /* !!!no CSE cost estimation yet */
905 NULL, /* no builtin functions */
906 GPOINTER, /* treat unqualified pointers as "generic" pointers */
907 1, /* reset labelKey to 1 */
908 1, /* globals & local static allowed */