71124bbbed82ac2680fba80905da87dff31d7aa7
[fw/sdcc] / src / pic16 / ralloc.h
1 /*-------------------------------------------------------------------------
2
3   ralloc.h - header file register allocation
4
5         Written By -  Sandeep Dutta . sandeep.dutta@usa.net (1998)
6         PIC port   - T. Scott Dattalo scott@dattalo.com (2000)
7         PIC16 port   - Martin Dubuc m.dubuc@rogers.com (2002)
8
9    This program is free software; you can redistribute it and/or modify it
10    under the terms of the GNU General Public License as published by the
11    Free Software Foundation; either version 2, or (at your option) any
12    later version.
13    
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18    
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22    
23    In other words, you are welcome to use, share and improve this program.
24    You are forbidden to forbid anyone else to use, share and improve
25    what you give them.   Help stamp out software-hoarding!  
26 -------------------------------------------------------------------------*/
27 #include "SDCCicode.h"
28 #include "SDCCBBlock.h"
29 #ifndef SDCCRALLOC_H
30 #define SDCCRALLOC_H 1
31
32 #include "pcoderegs.h"
33
34 extern unsigned int stackPos;
35 extern unsigned int stackLen;
36
37 enum
38   {
39     R2_IDX = 0, R3_IDX, R4_IDX,
40     R5_IDX, R6_IDX, R7_IDX,
41     R0_IDX, R1_IDX, X8_IDX,
42     X9_IDX, X10_IDX, X11_IDX,
43     X12_IDX, CND_IDX
44   };
45
46 enum {
47  REG_PTR=1,
48  REG_GPR,
49  REG_CND,
50  REG_SFR,
51  REG_STK,
52  REG_TMP
53 };
54 //#define REG_PTR 0x01
55 //#define REG_GPR 0x02
56 //#define REG_CND 0x04
57 //#define REG_SFR 0x08
58 //#define REG_STK 0x10  /* Use a register as a psuedo stack */
59 //#define REG_TMP 0x20  
60
61 /* definition for the registers */
62 typedef struct regs
63   {
64     short type;                 /* can have value 
65                                  * REG_GPR, REG_PTR or REG_CND 
66                                  * This like the "meta-type" */
67     short pc_type;              /* pcode type */
68     short rIdx;                 /* index into register table */
69     //    short otype;        
70     char *name;                 /* name */
71
72     unsigned isFree:1;          /* is currently unassigned  */
73     unsigned wasUsed:1;         /* becomes true if register has been used */
74     unsigned isFixed:1;         /* True if address can't change */
75 //    unsigned isMapped:1;        /* The Register's address has been mapped to physical RAM */
76     unsigned isBitField:1;      /* True if reg is type bit OR is holder for several bits */
77     unsigned isEmitted:1;       /* True if the reg has been written to a .asm file */
78     unsigned accessBank:1;      /* True if the reg is explicit placed in access bank */
79     unsigned isLocal:1;         /* True if the reg is allocated in function's local frame */
80     unsigned address;           /* reg's address if isFixed | isMapped is true */
81     unsigned size;              /* 0 for byte, 1 for int, 4 for long */
82     unsigned alias;             /* Alias mask if register appears in multiple banks */
83     struct regs *reg_alias;     /* If more than one register share the same address 
84                                  * then they'll point to each other. (primarily for bits)*/
85     operand *regop;             /* reference to the operand used to create the register */
86     pCodeRegLives reglives; /* live range mapping */
87   }
88 regs;
89 extern regs regspic16[];
90 extern int pic16_nRegs;
91 extern int pic16_Gstack_base_addr;
92
93 /*
94   As registers are created, they're added to a set (based on the
95   register type). Here are the sets of registers that are supported
96   in the PIC port:
97 */
98 extern set *pic16_dynAllocRegs;
99 extern set *pic16_dynStackRegs;
100 extern set *pic16_dynProcessorRegs;
101 extern set *pic16_dynDirectRegs;
102 extern set *pic16_dynDirectBitRegs;
103 extern set *pic16_dynInternalRegs;
104
105 extern set *pic16_builtin_functions;
106
107 extern set *pic16_rel_udata;
108 extern set *pic16_fix_udata;
109 extern set *pic16_equ_data;
110 extern set *pic16_int_regs;
111
112 regs *pic16_regWithIdx (int);
113 regs *pic16_typeRegWithIdx(int, int, int);
114 regs *pic16_dirregWithName (char *name );
115 regs *pic16_allocregWithName(char *name);
116 regs *pic16_regWithName(char *name);
117 void  pic16_freeAllRegs ();
118 void  pic16_deallocateAllRegs ();
119 regs *pic16_findFreeReg(short type);
120 regs *pic16_allocWithIdx (int idx);
121
122 regs *pic16_allocDirReg (operand *op );
123 regs *pic16_allocRegByName (char *name, int size, operand *op);
124
125 regs* newReg(short type, short pc_type, int rIdx, char *name, int size, int alias, operand *refop);
126
127 /* Define register address that are constant across PIC16 family */
128 #define IDX_TMR0    0xfd6
129 #define IDX_PCL     0xff9
130 #define IDX_STATUS  0xfd8
131 #define IDX_PCLATH  0xffa
132 #define IDX_PCLATU  0xffb /* patch 14 */
133 #define IDX_INTCON  0xff2
134 #define IDX_WREG    0xfe8
135 #define IDX_BSR     0xfe0
136
137 #define IDX_TOSL    0xffd /* patch 14 */
138 #define IDX_TOSH    0xffe /* patch 14 */
139 #define IDX_TOSU    0xfff /* patch 14 */
140
141 #define IDX_TBLPTRL 0xff6 /* patch 15 */
142 #define IDX_TBLPTRH 0xff7 /* patch 15 */
143 #define IDX_TBLPTRU 0xff8 /* patch 15 */
144 #define IDX_TABLAT  0xff5 /* patch 15 */
145
146 #define IDX_FSR0    0xfe9
147 #define IDX_FSR0L   0xfe9
148 #define IDX_FSR0H   0xfea
149
150 #define IDX_FSR1    0xfe1
151 #define IDX_FSR1L   0xfe1
152 #define IDX_FSR1H   0xfe2
153
154 #define IDX_FSR2    0xfd9
155 #define IDX_FSR2L   0xfd9
156 #define IDX_FSR2H   0xfda
157
158 #define IDX_INDF0       0xfef
159 #define IDX_POSTINC0    0xfee
160 #define IDX_POSTDEC0    0xfed
161 #define IDX_PREINC0     0xfec
162 #define IDX_PLUSW0      0xfeb
163
164 #define IDX_INDF1       0xfe7
165 #define IDX_POSTINC1    0xfe6
166 #define IDX_POSTDEC1    0xfe5
167 #define IDX_PREINC1     0xfe4
168 #define IDX_PLUSW1      0xfe3
169
170 #define IDX_INDF2       0xfdf
171 #define IDX_POSTINC2    0xfde
172 #define IDX_POSTDEC2    0xfdd
173 #define IDX_PREINC2     0xfdc
174 #define IDX_PLUSW2      0xfdb
175
176 #define IDX_PRODL       0xff3
177 #define IDX_PRODH       0xff4
178
179 /* EEPROM registers */
180 #define IDX_EECON1      0xfa6
181 #define IDX_EECON2      0xfa7
182 #define IDX_EEDATA      0xfa8
183 #define IDX_EEADR       0xfa9
184
185 #define IDX_KZ      0x7fff   /* Known zero - actually just a general purpose reg. */
186 #define IDX_WSAVE   0x7ffe
187 #define IDX_SSAVE   0x7ffd
188
189 #endif