33c0fa87277046a7918f3409e92cf014d4f212bf
[fw/sdcc] / src / pic16 / gen.h
1 /*-------------------------------------------------------------------------
2   gen.h - header file for code generation for PIC16
3
4              Written By -  Sandeep Dutta . sandeep.dutta@usa.net (1998)
5              PIC port   - T. Scott Dattalo scott@dattalo.com (2000)
6              PIC16 port   - Martin Dubuc m.dubuc@rogers.com (2000)
7
8    This program is free software; you can redistribute it and/or modify it
9    under the terms of the GNU General Public License as published by the
10    Free Software Foundation; either version 2, or (at your option) any
11    later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21    
22    In other words, you are welcome to use, share and improve this program.
23    You are forbidden to forbid anyone else to use, share and improve
24    what you give them.   Help stamp out software-hoarding!  
25 -------------------------------------------------------------------------*/
26
27 #ifndef SDCCGENPIC16_H
28 #define SDCCGENPIC16_H
29
30 struct pCodeOp;
31
32 enum
33   {
34     AOP_LIT = 1,
35     AOP_REG,
36     AOP_DIR,
37     AOP_DPTR,
38     AOP_DPTR2,
39     AOP_R0,
40     AOP_R1,
41     AOP_STK,
42     AOP_IMMD,
43     AOP_STR,
44     AOP_CRY,
45     AOP_ACC,
46     AOP_FSR0,
47     AOP_FSR1,
48     AOP_FSR2,
49     AOP_PCODE
50   };
51
52 /* type asmop : a homogenised type for 
53    all the different spaces an operand can be
54    in */
55 typedef struct asmop
56   {
57
58     short type;                 /* can have values
59                                    AOP_LIT    -  operand is a literal value
60                                    AOP_REG    -  is in registers
61                                    AOP_DIR    -  direct just a name
62                                    AOP_DPTR   -  dptr contains address of operand
63                                    AOP_DPTR2  -  dptr2 contains address of operand (DS80C390 only).
64                                    AOP_R0/R1  -  r0/r1 contains address of operand               
65                                    AOP_STK    -  should be pushed on stack this
66                                    can happen only for the result
67                                    AOP_IMMD   -  immediate value for eg. remateriazable 
68                                    AOP_CRY    -  carry contains the value of this
69                                    AOP_STR    -  array of strings
70                                    AOP_ACC    -  result is in the acc:b pair
71                                  */
72     short coff;                 /* current offset */
73     short size;                 /* total size */
74     unsigned code:1;            /* is in Code space */
75     unsigned paged:1;           /* in paged memory  */
76     unsigned freed:1;           /* already freed    */
77     union
78       {
79         value *aop_lit;         /* if literal */
80         regs *aop_reg[4];       /* array of registers */
81         char *aop_dir;          /* if direct  */
82         regs *aop_ptr;          /* either -> to r0 or r1 */
83         char *aop_immd;         /* if immediate others are implied */
84         int aop_stk;            /* stack offset when AOP_STK */
85         char *aop_str[4];       /* just a string array containing the location */
86 /*      regs *aop_alloc_reg;     * points to a dynamically allocated register */
87         pCodeOp *pcop;
88       }
89     aopu;
90   }
91 asmop;
92
93 void genpic16Code (iCode *);
94
95 //extern char *fReturnpic16[];
96 //extern char *fReturn390[];
97 extern unsigned pic16_fReturnSizePic;
98 //extern char **fReturn;
99
100
101 #define AOP(op) op->aop
102 #define AOP_TYPE(op) AOP(op)->type
103 #define AOP_SIZE(op) AOP(op)->size
104 #define IS_AOP_PREG(x) (AOP(x) && (AOP_TYPE(x) == AOP_R1 || \
105                        AOP_TYPE(x) == AOP_R0))
106
107 #define AOP_NEEDSACC(x) (AOP(x) && (AOP_TYPE(x) == AOP_CRY ||  \
108                         AOP_TYPE(x) == AOP_DPTR || AOP_TYPE(x) == AOP_DPTR2 || \
109                          AOP(x)->paged)) 
110
111 #define AOP_INPREG(x) (x && (x->type == AOP_REG &&                        \
112                       (x->aopu.aop_reg[0] == pic16_regWithIdx(R0_IDX) || \
113                       x->aopu.aop_reg[0] == pic16_regWithIdx(R1_IDX) )))
114
115 #define RESULTONSTACK(x) \
116                          (IC_RESULT(x) && IC_RESULT(x)->aop && \
117                          IC_RESULT(x)->aop->type == AOP_STK )
118
119 #define MOVA(x) if (strcmp(x,"a") && strcmp(x,"acc")) pic16_emitcode(";XXX mov","a,%s  %s,%d",x,__FILE__,__LINE__);
120 #define CLRC    pic16_emitcode(";XXX clr","c %s,%d",__FILE__,__LINE__);
121
122
123 #define BIT_NUMBER(x) (x & 7)
124 #define BIT_REGISTER(x) (x>>3)
125
126
127 #define LSB     0
128 #define MSB16   1
129 #define MSB24   2
130 #define MSB32   3
131
132
133 #define FUNCTION_LABEL_INC  40
134
135 /*-----------------------------------------------------------------*/
136 /* Macros for emitting skip instructions                           */
137 /*-----------------------------------------------------------------*/
138
139 #define emitSKPC    pic16_emitpcode(POC_BTFSS,pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_C_BIT))
140 #define emitSKPNC   pic16_emitpcode(POC_BTFSC,pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_C_BIT))
141 #define emitSKPZ    pic16_emitpcode(POC_BTFSS,pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_Z_BIT))
142 #define emitSKPNZ   pic16_emitpcode(POC_BTFSC,pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_Z_BIT))
143 #define emitSKPDC   pic16_emitpcode(POC_BTFSS,pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_DC_BIT))
144 #define emitSKPNDC  pic16_emitpcode(POC_BTFSC,pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_DC_BIT))
145 #define emitCLRZ    pic16_emitpcode(POC_BCF,  pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_Z_BIT))
146 #define emitCLRC    pic16_emitpcode(POC_BCF,  pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_C_BIT))
147 #define emitCLRDC   pic16_emitpcode(POC_BCF,  pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_DC_BIT))
148 #define emitSETZ    pic16_emitpcode(POC_BSF,  pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_Z_BIT))
149 #define emitSETC    pic16_emitpcode(POC_BSF,  pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_C_BIT))
150 #define emitSETDC   pic16_emitpcode(POC_BSF,  pic16_popCopyGPR2Bit(PCOP(&pic16_pc_status),PIC_DC_BIT))
151
152 int pic16_getDataSize(operand *op);
153 void pic16_emitpcode(PIC_OPCODE poc, pCodeOp *pcop);
154 void pic16_emitpLabel(int key);
155 void pic16_emitcode (char *inst,char *fmt, ...);
156 void DEBUGpic16_emitcode (char *inst,char *fmt, ...);
157 void pic16_emitDebuggerSymbol (char *);
158 bool pic16_sameRegs (asmop *aop1, asmop *aop2 );
159 char *pic16_aopGet (asmop *aop, int offset, bool bit16, bool dname);
160 void DEBUGpic16_pic16_AopType(int line_no, operand *left, operand *right, operand *result);
161
162
163 bool pic16_genPlusIncr (iCode *ic);
164 void pic16_outBitAcc(operand *result);
165 void pic16_genPlusBits (iCode *ic);
166 void pic16_genPlus (iCode *ic);
167 bool pic16_genMinusDec (iCode *ic);
168 void pic16_addSign(operand *result, int offset, int sign);
169 void pic16_genMinusBits (iCode *ic);
170 void pic16_genMinus (iCode *ic);
171
172
173 pCodeOp *pic16_popGetLabel(unsigned int key);
174 pCodeOp *pic16_popCopyReg(pCodeOpReg *pc);
175 pCodeOp *pic16_popCopyGPR2Bit(pCodeOp *pc, int bitval);
176 pCodeOp *pic16_popGetLit(unsigned int lit);
177 pCodeOp *pic16_popGetLit2(unsigned int lit, pCodeOp *arg2);
178 pCodeOp *popGetWithString(char *str);
179 pCodeOp *pic16_popGet (asmop *aop, int offset);//, bool bit16, bool dname);
180 pCodeOp *pic16_popGetTempReg(void);
181 void pic16_popReleaseTempReg(pCodeOp *pcop);
182
183 pCodeOp *pic16_popCombine2(pCodeOpReg *src, pCodeOpReg *dst, int noalloc);
184
185 void pic16_aopPut (asmop *aop, char *s, int offset);
186 void pic16_outAcc(operand *result);
187 void pic16_aopOp (operand *op, iCode *ic, bool result);
188 void pic16_outBitC(operand *result);
189 void pic16_toBoolean(operand *oper);
190 void pic16_freeAsmop (operand *op, asmop *aaop, iCode *ic, bool pop);
191 const char *pic16_pCodeOpType(  pCodeOp *pcop);
192
193
194 void dumpiCode(iCode *lic);
195
196 #endif