2 * Simulator of microcontrollers (sim.src/memcl.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_MEMCL_HEADER
29 #define SIM_MEMCL_HEADER
41 class cl_event_handler;
45 #define CELL_NORMAL 0x00 /* Nothing special */
46 #define CELL_HW_READ 0x01 /* Hw handles read */
47 #define CELL_HW_WRITE 0x02 /* Hw catches write */
48 #define CELL_INST 0x04 /* Marked as instruction */
49 #define CELL_FETCH_BRK 0x08 /* Fetch breakpoint */
50 #define CELL_READ_BRK 0x10 /* Read event breakpoint */
51 #define CELL_WRITE_BRK 0x20 /* Write event breakpoint */
53 #define CELL_GENERAL (CELL_NORMAL|CELL_INST|CELL_FETCH_BRK)
56 class cl_cell: public cl_base
59 cl_cell(void): cl_base() {}
61 virtual TYPE_UBYTE get_type(void)= 0;
62 virtual void set_type(TYPE_UBYTE what)= 0;
63 virtual t_mem get_mask(void)= 0;
65 virtual t_mem read(void)=0 ;
66 virtual t_mem read(enum hw_cath /*skip*/)=0;
67 virtual t_mem get(void)=0;
68 virtual t_mem write(t_mem val)=0;
69 virtual t_mem set(t_mem val)=0;
70 virtual t_mem add(long what)=0;
71 virtual t_mem wadd(long what)=0;
73 virtual void set_bit1(t_mem bits)=0;
74 virtual void set_bit0(t_mem bits)=0;
76 virtual class cl_cell *add_hw(class cl_hw */*hw*/, int */*ith*/)=0;
77 virtual class cl_hw *get_hw(int ith)=0;
78 virtual class cl_event_handler *get_event_handler(void)=0;
81 class cl_normal_cell: public cl_cell
85 TYPE_UBYTE type; // See CELL_XXXX
91 cl_normal_cell(uchar awidth);
92 //virtual void destroy(void) {}
94 virtual TYPE_UBYTE get_type(void) { return(type); }
95 virtual void set_type(TYPE_UBYTE what) { type= what; }
96 virtual t_mem get_mask(void) { return(mask); }
98 virtual t_mem read(void) { return(data); }
99 virtual t_mem read(enum hw_cath /*skip*/) { return(data); }
100 virtual t_mem get(void) { return(data); }
101 virtual t_mem write(t_mem val) { data= val & mask; return(data); }
102 virtual t_mem set(t_mem val) { return(data= val & mask); }
103 virtual t_mem add(long what);
104 virtual t_mem wadd(long what);
106 virtual void set_bit1(t_mem bits);
107 virtual void set_bit0(t_mem bits);
109 virtual class cl_cell *add_hw(class cl_hw */*hw*/, int */*ith*/)
111 virtual class cl_hw *get_hw(int ith) { return(0); }
112 //virtual class cl_brk *get_brk(void) { return(0); }
113 virtual class cl_event_handler *get_event_handler(void) { return(0); }
117 /* Memory location handled specially by a hw element */
119 /*class cl_memloc: public cl_base
126 cl_memloc(t_addr addr);
127 virtual ~cl_memloc(void);
129 virtual ulong read(class cl_mem *mem);
130 virtual void write(class cl_mem *mem, t_addr addr, t_mem *val);
133 /*class cl_memloc_coll: public cl_sorted_list
136 cl_memloc_coll(void);
138 virtual void *key_of(void *item);
139 virtual int compare(void *key1, void *key2);
141 class cl_memloc *get_loc(t_addr address);
146 class cl_mem: public cl_guiobj
151 char *addr_format, *data_format;
154 int width; // in bits
159 //class cl_memloc_coll *read_locs, *write_locs;
161 t_addr dump_finished;
164 cl_mem(enum mem_class atype, char *aclass_name, t_addr asize, int awidth,
166 virtual ~cl_mem(void);
167 virtual int init(void);
168 virtual char *id_string(void);
169 virtual int get_cell_flag(t_addr /*addr*/) { return(CELL_NORMAL); }
170 virtual bool get_cell_flag(t_addr /*addr*/, int /*flag*/)
171 { return(DD_FALSE); }
172 virtual void set_cell_flag(t_addr addr, bool set_to, int flag) {}
174 virtual t_mem read(t_addr addr);
175 virtual t_mem read(t_addr addr, enum hw_cath /*skip*/) {return(read(addr));}
176 virtual t_mem get(t_addr addr);
177 virtual t_mem write(t_addr addr, t_mem val);
178 virtual void set(t_addr addr, t_mem val);
179 virtual void set_bit1(t_addr addr, t_mem bits);
180 virtual void set_bit0(t_addr addr, t_mem bits);
181 virtual void write_bit1(t_addr addr, t_mem bits) { set_bit1(addr, bits); }
182 virtual void write_bit0(t_addr addr, t_mem bits) { set_bit0(addr, bits); }
183 virtual t_mem add(t_addr addr, long what);
184 virtual t_mem wadd(t_addr addr, long what) { return(add(addr, what)); }
185 virtual t_addr dump(t_addr start, t_addr stop, int bpl,
186 class cl_console *con);
187 virtual t_addr dump(class cl_console *con);
188 virtual bool search_next(bool case_sensitive,
189 t_mem *array, int len, t_addr *addr);
191 virtual class cl_cell *get_cell(t_addr addr) {return(0);}
192 virtual class cl_cell *register_hw(t_addr addr, class cl_hw *hw, int *ith,
195 virtual void set_brk(t_addr /*addr*/, class cl_brk */*brk*/) {}
196 virtual void del_brk(t_addr addr, class cl_brk *brk) {}
201 /*class cl_bitmap: public cl_base
207 cl_bitmap(t_addr asize);
208 virtual ~cl_bitmap(void);
209 virtual void set(t_addr pos);
210 virtual void clear(t_addr pos);
211 virtual bool get(t_addr pos);
212 virtual bool empty(void);
215 class cl_rom: public cl_mem
218 class cl_bitmap *bp_map;
219 class cl_bitmap *inst_map;
221 cl_rom(t_addr asize, int awidth, class cl_uc *auc);
222 virtual ~cl_rom(void);
226 * New type of memory simulation
229 class cl_registered_cell: public cl_normal_cell
232 //class cl_list *hws;
233 class cl_hw **hardwares;
236 cl_registered_cell(uchar awidth);
237 virtual ~cl_registered_cell(void);
238 //virtual void destroy(void);
240 virtual t_mem read(void);
241 virtual t_mem read(enum hw_cath skip);
242 virtual t_mem write(t_mem val);
244 virtual class cl_cell *add_hw(class cl_hw *hw, int *ith);
245 virtual class cl_hw *get_hw(int ith);
248 class cl_event_handler: public cl_base
251 class cl_list *read_bps, *write_bps;
254 cl_event_handler(class cl_uc *auc);
255 virtual ~cl_event_handler(void);
257 virtual void write(void);
258 virtual void read(void);
260 virtual int add_bp(class cl_brk *bp);
261 virtual int copy_from(class cl_event_handler *eh);
262 virtual bool del_bp(class cl_brk *bp);
265 class cl_event_cell: public cl_normal_cell
268 class cl_event_handler *eh;
270 cl_event_cell(uchar awidth, class cl_uc *auc);
271 virtual ~cl_event_cell(void);
273 virtual t_mem read(void);
274 virtual t_mem write(t_mem val);
275 //virtual void event(void);
277 //virtual class cl_brk *get_brk(void) { return(brk); }
278 virtual class cl_event_handler *get_event_handler(void) { return(eh); }
281 class cl_ev_reg_cell: public cl_registered_cell
284 class cl_event_handler *eh;
286 cl_ev_reg_cell(uchar awidth, class cl_uc *auc);
287 virtual ~cl_ev_reg_cell(void);
289 virtual t_mem read(void);
290 virtual t_mem write(t_mem val);
291 //virtual void event(void);
293 //virtual class cl_brk *get_brk(void) { return(brk); }
294 virtual class cl_event_handler *get_event_handler(void) { return(eh); }
297 class cl_mapped_cell: public cl_cell
300 class cl_cell *real_cell;
302 cl_mapped_cell(class cl_cell *realcell);
303 virtual ~cl_mapped_cell(void);
305 virtual t_mem read(void);
306 virtual t_mem read(enum hw_cath skip);
307 virtual t_mem get(void);
308 virtual t_mem write(t_mem val);
309 virtual t_mem set(t_mem val);
310 virtual t_mem add(long what);
311 virtual t_mem wadd(long what);
313 virtual void set_bit1(t_mem bits);
314 virtual void set_bit0(t_mem bits);
316 virtual class cl_cell *add_hw(class cl_hw *hw, int *ith);
317 virtual class cl_hw *get_hw(int ith);
318 virtual class cl_event_handler *get_event_handler(void);
321 class cl_m: public cl_mem
324 class cl_cell **array;
325 class cl_cell *dummy;
332 cl_m(enum mem_class atype, char *aclass_name, t_addr asize, int awidth,
334 cl_m(t_addr asize, int awidth);
336 virtual void err_inv_addr(t_addr addr);
337 virtual int get_cell_flag(t_addr addr);
338 virtual bool get_cell_flag(t_addr addr, int flag);
339 virtual void set_cell_flag(t_addr addr, bool set_to, int flag);
341 virtual t_mem read(t_addr addr);
342 virtual t_mem read(t_addr addr, enum hw_cath skip);
343 virtual t_mem get(t_addr addr);
344 virtual t_mem write(t_addr addr, t_mem val);
345 virtual void set(t_addr addr, t_mem val);
346 virtual class cl_cell *get_cell(t_addr addr);
348 virtual void set_bit1(t_addr addr, t_mem bits);
349 virtual void set_bit0(t_addr addr, t_mem bits);
350 virtual void write_bit1(t_addr addr, t_mem bits);
351 virtual void write_bit0(t_addr addr, t_mem bits);
352 virtual t_mem add(t_addr addr, long what);
353 virtual t_mem wadd(t_addr addr, long what);
355 virtual class cl_cell *register_hw(t_addr addr, class cl_hw *hw, int *ith,
357 virtual void set_brk(t_addr addr, class cl_brk *brk);
358 virtual void del_brk(t_addr addr, class cl_brk *brk);
365 * Errors in memory handling
368 class cl_err_inv_addr: public cl_error
374 cl_err_inv_addr(class cl_mem *amem, t_addr aaddr);
375 virtual void print(class cl_commander *c);