2 * Simulator of microcontrollers (sim.src/uccl.h)
4 * Copyright (C) 1999,99 Drotos Daniel, Talker Bt.
6 * To contact author send email to drdani@mazsola.iit.uni-miskolc.hu
10 /* This file is part of microcontroller simulator: ucsim.
12 UCSIM is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2 of the License, or
15 (at your option) any later version.
17 UCSIM 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 UCSIM; see the file COPYING. If not, write to the Free
24 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
28 #ifndef SIM_UCCL_HEADER
29 #define SIM_UCCL_HEADER
41 /* Counter to count clock ticks */
44 #define TICK_INISR 0x02
45 #define TICK_IDLE 0x03
47 class cl_ticker: public cl_base
51 int options; // see TICK_XXX above
55 cl_ticker(int adir, int in_isr, char *aname);
58 virtual int tick(int nr);
59 virtual double get_rtime(double xtal);
60 virtual void dump(int nr, double xtal, class cl_console *con);
64 /* Abstract microcontroller */
66 class cl_uc: public cl_base
69 int type; // CPU family
70 int technology; // CMOS, HMOS
71 int state; // GO, IDLE, PD
72 class cl_list *options;
74 t_addr PC; // Program Counter
75 class cl_ticker *ticks; // Nr of XTAL clocks
76 class cl_ticker *isr_ticks; // Time in ISRs
77 class cl_ticker *idle_ticks; // Time in idle mode
78 class cl_list *counters; // User definable timers (tickers)
79 double xtal; // Clock speed
81 int brk_counter; // Number of breakpoints
82 class brk_coll *fbrk; // Collection of FETCH break-points
83 class brk_coll *ebrk; // Collection of EVENT breakpoints
88 class cl_list *it_sources; // Sources of interrupts
89 class cl_list *it_levels; // Follow interrupt services
90 class cl_list *st_ops; // Track stack operations
96 cl_uc(class cl_sim *asim);
98 virtual int init(void);
99 virtual char *id_string(void);
100 virtual void reset(void);
103 virtual class cl_mem *mk_mem(enum mem_class type, char *class_name);
104 virtual t_addr get_mem_size(enum mem_class type);
105 virtual int get_mem_width(enum mem_class type);
106 virtual void mk_hw_elements(void);
108 // manipulating memories
109 virtual ulong read_mem(enum mem_class type, t_addr addr);
110 virtual ulong get_mem(enum mem_class type, t_addr addr);
111 virtual void write_mem(enum mem_class type, t_addr addr, t_mem val);
112 virtual void set_mem(enum mem_class type, t_addr addr, t_mem val);
113 virtual class cl_mem *mem(enum mem_class type);
114 virtual class cl_mem *mem(char *class_name);
115 //virtual TYPE_UBYTE *MEM(enum mem_class type);
118 virtual long read_hex_file(const char *name);
120 // instructions, code analyzer
121 virtual void analyze(t_addr addr) {}
122 virtual bool inst_at(t_addr addr);
123 virtual void set_inst_at(t_addr addr);
124 virtual void del_inst_at(t_addr addr);
125 virtual bool there_is_inst(void);
127 // manipulating hw elements
128 virtual void register_hw_read(enum mem_class, t_addr addr, class cl_hw *hw);
129 virtual void register_hw_write(enum mem_class, t_addr addr, class cl_hw *hw);
130 virtual class cl_hw *get_hw(enum hw_cath cath, int *idx);
131 virtual class cl_hw *get_hw(char *id_string, int *idx);
132 virtual class cl_hw *get_hw(enum hw_cath cath, int hwid, int *idx);
133 virtual class cl_hw *get_hw(char *id_string, int hwid, int *idx);
136 virtual int tick(int cycles);
137 virtual class cl_ticker *get_counter(int nr);
138 virtual class cl_ticker *get_counter(char *name);
139 virtual void add_counter(class cl_ticker *ticker, int nr);
140 virtual void add_counter(class cl_ticker *ticker, char *name);
141 virtual void del_counter(int nr);
142 virtual void del_counter(char *name);
143 virtual double get_rtime(void);
144 virtual int clock_per_cycle(void);
147 virtual t_mem fetch(void);
148 virtual bool fetch(t_mem *code);
149 virtual int do_inst(int step);
150 virtual void pre_inst(void);
151 virtual int exec_inst(void);
152 virtual void post_inst(void);
154 virtual int it_priority(uchar ie_mask) {return(0);}
157 virtual void st_push(class cl_stack_op *op);
158 virtual void st_call(class cl_stack_op *op);
159 virtual int st_pop(class cl_stack_op *op);
160 virtual int st_ret(class cl_stack_op *op);
163 virtual class cl_fetch_brk *fbrk_at(t_addr addr);
164 virtual class cl_ev_brk *ebrk_at(t_addr addr, char *id);
165 //virtual void rm_fbrk(long addr);
166 virtual class cl_brk *brk_by_nr(int nr);
167 virtual class cl_brk *brk_by_nr(class brk_coll *bpcoll, int nr);
168 virtual void rm_ebrk(t_addr addr, char *id);
169 virtual void rm_brk(int nr);
170 virtual void put_breaks(void);
171 virtual void remove_all_breaks(void);
172 virtual int make_new_brknr(void);
173 virtual class cl_ev_brk *mk_ebrk(enum brk_perm perm, class cl_mem *mem,
174 char op, t_addr addr, int hit);
176 // disassembling and symbol recognition
177 virtual char *disass(t_addr addr, char *sep);
178 virtual struct dis_entry *dis_tbl(void);
179 virtual struct name_entry *sfr_tbl(void);
180 virtual struct name_entry *bit_tbl(void);
181 virtual void print_disass(t_addr addr, class cl_console *con);
182 virtual void print_regs(class cl_console *con);
183 virtual int inst_length(t_mem code);
184 virtual int longest_inst(void);
185 virtual bool get_name(t_addr addr, struct name_entry tab[], char *buf);
186 virtual bool extract_bit_address(t_addr bit_address,
189 t_mem *bit_mask) {return(DD_FALSE);}
190 virtual char *symbolic_bit_name(t_addr bit_address,
195 /* Following fields and virtual methods defined in uc51 I don't have
196 energy to redesign them:-( */
198 uchar port_pins[4]; // Port pins
200 virtual void proc_write(uchar *addr) {}
201 virtual void set_p_flag(void) {}
202 virtual uchar *get_bit(uchar bitaddr) { return(0); }
203 virtual void eram2xram(void) {} // Dirty hack for 51R
204 virtual void xram2eram(void) {}