git.gag.com Git - fw/sdcc/blob - sim/ucsim/sim.src/uccl.h

   1 /*
   2  * Simulator of microcontrollers (sim.src/uccl.h)
   3  *
   4  * Copyright (C) 1999,99 Drotos Daniel, Talker Bt.
   5  *
   6  * To contact author send email to drdani@mazsola.iit.uni-miskolc.hu
   7  *
   8  */
   9
  10 /* This file is part of microcontroller simulator: ucsim.
  11
  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.
  16
  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.
  21
  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
  25 02111-1307, USA. */
  26 /*@1@*/
  27
  28 #ifndef SIM_UCCL_HEADER
  29 #define SIM_UCCL_HEADER
  30
  31 // prj
  32 #include "stypes.h"
  33 #include "pobjcl.h"
  34
  35 // sim
  36 #include "hwcl.h"
  37 #include "memcl.h"
  38 #include "brkcl.h"
  39
  40
  41 /* Counter to count clock ticks */
  42
  43 #define TICK_RUN        0x01
  44 #define TICK_INISR      0x02
  45 #define TICK_IDLE       0x03
  46
  47 class cl_ticker: public cl_base
  48 {
  49 public:
  50   unsigned long ticks;
  51   int options; // see TICK_XXX above
  52   int dir;
  53   char *name;
  54
  55   cl_ticker(int adir, int in_isr, char *aname);
  56   ~cl_ticker(void);
  57
  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);
  61 };
  62
  63
  64 /* Abstract microcontroller */
  65
  66 class cl_uc: public cl_base
  67 {
  68 public:
  69   int type;                     // CPU family
  70   int technology;               // CMOS, HMOS
  71   int state;                    // GO, IDLE, PD
  72   class cl_list *options;
  73
  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
  80
  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
  84   class cl_sim *sim;
  85   class cl_list *mems;
  86   class cl_hws *hws;
  87
  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
  91
  92   t_addr sp_max;
  93   t_addr sp_avg;
  94
  95 public:
  96   cl_uc(class cl_sim *asim);
  97   ~cl_uc(void);
  98   virtual int init(void);
  99   virtual char *id_string(void);
 100   virtual void reset(void);
 101
 102   // making objects
 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);
 107   virtual void build_cmdset(class cl_cmdset *cmdset);
 108
 109   // manipulating memories
 110   virtual ulong read_mem(enum mem_class type, t_addr addr);
 111   virtual ulong get_mem(enum mem_class type, t_addr addr);
 112   virtual void write_mem(enum mem_class type, t_addr addr, t_mem val);
 113   virtual void set_mem(enum mem_class type, t_addr addr, t_mem val);
 114   virtual class cl_mem *mem(enum mem_class type);
 115   virtual class cl_mem *mem(char *class_name);
 116   //virtual TYPE_UBYTE *MEM(enum mem_class type);
 117
 118   // file handling
 119   virtual long read_hex_file(const char *name);
 120
 121   // instructions, code analyzer
 122   virtual void analyze(t_addr addr) {}
 123   virtual bool inst_at(t_addr addr);
 124   virtual void set_inst_at(t_addr addr);
 125   virtual void del_inst_at(t_addr addr);
 126   virtual bool there_is_inst(void);
 127
 128   // manipulating hw elements
 129   virtual void register_hw_read(enum mem_class, t_addr addr, class cl_hw *hw);
 130   virtual void register_hw_write(enum mem_class, t_addr addr, class cl_hw *hw);
 131   virtual class cl_hw *get_hw(enum hw_cath cath, int *idx);
 132   virtual class cl_hw *get_hw(char *id_string, int *idx);
 133   virtual class cl_hw *get_hw(enum hw_cath cath, int hwid, int *idx);
 134   virtual class cl_hw *get_hw(char *id_string, int hwid, int *idx);
 135
 136   // "virtual" timers
 137   virtual int tick(int cycles);
 138   virtual class cl_ticker *get_counter(int nr);
 139   virtual class cl_ticker *get_counter(char *name);
 140   virtual void add_counter(class cl_ticker *ticker, int nr);
 141   virtual void add_counter(class cl_ticker *ticker, char *name);
 142   virtual void del_counter(int nr);
 143   virtual void del_counter(char *name);
 144   virtual double get_rtime(void);
 145   virtual int clock_per_cycle(void);
 146
 147   // execution
 148   virtual t_mem fetch(void);
 149   virtual bool fetch(t_mem *code);
 150   virtual int do_inst(int step);
 151   virtual void pre_inst(void);
 152   virtual int exec_inst(void);
 153   virtual void post_inst(void);
 154
 155   virtual int it_priority(uchar ie_mask) {return(0);}
 156
 157   // stack tracking
 158   virtual void st_push(class cl_stack_op *op);
 159   virtual void st_call(class cl_stack_op *op);
 160   virtual int st_pop(class cl_stack_op *op);
 161   virtual int st_ret(class cl_stack_op *op);
 162
 163   // breakpoints
 164   virtual class cl_fetch_brk *fbrk_at(t_addr addr);
 165   virtual class cl_ev_brk *ebrk_at(t_addr addr, char *id);
 166   //virtual void rm_fbrk(long addr);
 167   virtual class cl_brk *brk_by_nr(int nr);
 168   virtual class cl_brk *brk_by_nr(class brk_coll *bpcoll, int nr);
 169   virtual void rm_ebrk(t_addr addr, char *id);
 170   virtual void rm_brk(int nr);
 171   virtual void put_breaks(void);
 172   virtual void remove_all_breaks(void);
 173   virtual int make_new_brknr(void);
 174   virtual class cl_ev_brk *mk_ebrk(enum brk_perm perm, class cl_mem *mem,
 175                                    char op, t_addr addr, int hit);
 176
 177   // disassembling and symbol recognition
 178   virtual char *disass(t_addr addr, char *sep);
 179   virtual struct dis_entry *dis_tbl(void);
 180   virtual struct name_entry *sfr_tbl(void);
 181   virtual struct name_entry *bit_tbl(void);
 182   virtual void print_disass(t_addr addr, class cl_console *con);
 183   virtual void print_regs(class cl_console *con);
 184   virtual int inst_length(t_mem code);
 185   virtual int longest_inst(void);
 186   virtual bool get_name(t_addr addr, struct name_entry tab[], char *buf);
 187   virtual bool extract_bit_address(t_addr bit_address,
 188                                    class cl_mem **mem,
 189                                    t_addr *mem_addr,
 190                                    t_mem *bit_mask) {return(DD_FALSE);}
 191   virtual char *symbolic_bit_name(t_addr bit_address,
 192                                   class cl_mem *mem,
 193                                   t_addr mem_addr,
 194                                   t_mem bit_mask);
 195
 196   /* Following fields and virtual methods defined in uc51 I don't have
 197      energy to redesign them:-( */
 198 public:
 199   uchar port_pins[4];   // Port pins
 200 public:
 201   virtual void proc_write(uchar *addr) {}
 202   virtual void set_p_flag(void) {}
 203   virtual uchar *get_bit(uchar bitaddr) { return(0); }
 204   virtual void eram2xram(void) {} // Dirty hack for 51R
 205   virtual void xram2eram(void) {}
 206 };
 207
 208
 209 #endif
 210
 211 /* End of uccl.h */