4 Copyright 2008, 2009 Michel Pollet <buserror@gmail.com>
6 This file is part of simavr.
8 simavr is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 simavr 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.
18 You should have received a copy of the GNU General Public License
19 along with simavr. If not, see <http://www.gnu.org/licenses/>.
27 typedef uint64_t avr_cycle_count_t;
28 typedef uint16_t avr_io_addr_t;
31 typedef uint8_t (*avr_io_read_t)(struct avr_t * avr, avr_io_addr_t addr, void * param);
32 typedef void (*avr_io_write_t)(struct avr_t * avr, avr_io_addr_t addr, uint8_t v, void * param);
33 typedef avr_cycle_count_t (*avr_cycle_timer_t)(struct avr_t * avr, avr_cycle_count_t when, void * param);
37 S_C = 0,S_Z,S_N,S_V,S_S,S_H,S_T,S_I,
39 // 16 bits register pairs
40 R_XL = 0x1a, R_XH,R_YL,R_YH,R_ZL,R_ZH,
42 R_SPL = 32+0x3d, R_SPH,
46 // maximum number of IO registers, on normal AVRs
47 MAX_IOs = 256 - 32, // minus 32 GP registers
50 #define AVR_DATA_TO_IO(v) ((v) - 32)
51 #define AVR_IO_TO_DATA(v) ((v) + 32)
57 cpu_Limbo = 0, // before initialization is finished
58 cpu_Stopped, // all is stopped, timers included
60 cpu_Running, // we're free running
62 cpu_Sleeping, // we're now sleeping until an interrupt
64 cpu_Step, // run ONE instruction, then...
65 cpu_StepDone, // tell gdb it's all OK, and give it registers
69 * Main AVR instance. Some of these fields are set by the AVR "Core" definition files
70 * the rest is runtime data (as little as possible)
72 typedef struct avr_t {
73 const char * mmcu; // name of the AVR
74 // these are filled by sim_core_declare from constants in /usr/lib/avr/include/avr/io*.h
82 // filled by the ELF data, this allow tracking of invalid jumps
85 int state; // stopped, running, sleeping
86 uint32_t frequency; // frequency we are running at
88 // cycles gets incremented when sleeping and when running; it corresponds
89 // not only to "cycles that runs" but also "cycles that might have run"
91 avr_cycle_count_t cycle; // current cycle
93 // called at init time
94 void (*init)(struct avr_t * avr);
95 // called at reset time
96 void (*reset)(struct avr_t * avr);
98 // Mirror of the SREG register, to facilitate the access to bits
99 // in the opcode decoder.
100 // This array is re-synthetized back/forth when SREG changes
105 * Note that the PC is representing /bytes/ while the AVR value is
106 * assumed to be "words". This is in line with what GDB does...
107 * this is why you will see >>1 and <<1 in the decoder to handle jumps.
108 * It CAN be a little confusing, so concentrate, young grasshopper.
113 * callback when specific IO registers are read/written.
114 * There is one drawback here, there is in way of knowing what is the
115 * "beginning of useful sram" on a core, so there is no way to deduce
116 * what is the maximum IO register for a core, and thus, we can't
117 * allocate this table dynamically.
118 * If you wanted to emulate the BIG AVRs, and XMegas, this would need
122 struct avr_irq_t * irq; // optional, used only if asked for with avr_iomem_getirq()
133 // flash memory (initialized to 0xff, and code loaded into it)
135 // this is the general purpose registers, IO registers, and SRAM
138 // queue of io modules
139 struct avr_io_t *io_port;
141 // cycle timers are callbacks that will be called when "when" cycle is reached
142 // the bitmap allows quick knowledge of whether there is anything to call
143 // these timers are one shots, then get cleared if the timer function returns zero,
144 // they get reset if the callback function returns a new cycle number
145 uint32_t cycle_timer_map;
147 avr_cycle_count_t when;
148 avr_cycle_timer_t timer;
152 // interrupt vectors, and their enable/clear registers
153 struct avr_int_vector_t * vector[64];
154 uint8_t pending_wait; // number of cycles to wait for pending
155 uint32_t pending[2]; // pending interrupts
157 // DEBUG ONLY -- value ignored if CONFIG_SIMAVR_TRACE = 0
160 #if CONFIG_SIMAVR_TRACE
161 struct avr_symbol_t ** codeline;
164 * this keeps track of "jumps" ie, call,jmp,ret,reti and so on
165 * allows dumping of a meaningful data even if the stack is
168 #define OLD_PC_SIZE 32
172 } old[OLD_PC_SIZE]; // catches reset..
176 #define STACK_FRAME_SIZE 32
177 // this records the call/ret pairs, to try to catch
178 // code that munches the stack -under- their own frame
182 } stack_frame[STACK_FRAME_SIZE];
183 int stack_frame_index;
187 // keeps track of which registers gets touched by instructions
188 // reset before each new instructions. Allows meaningful traces
189 uint32_t touched[256 / 32]; // debug
192 // VALUE CHANGE DUMP file (waveforms)
193 // this is the VCD file that gets allocated if the
194 // firmware that is loaded explicitly asks for a trace
195 // to be generated, and allocates it's own symbols
196 // using AVR_MMCU_TAG_VCD_TRACE (see avr_mcu_section.h)
197 struct avr_vcd_t * vcd;
199 // gdb hooking structure. Only present when gdb server is active
200 struct avr_gdb_t * gdb;
202 // if non-zero, the gdb server will be started when the core
203 // crashed even if not activated at startup
204 // if zero, the simulator will just exit() in case of a crash
209 // this is a static constructor for each of the AVR devices
210 typedef struct avr_kind_t {
211 const char * names[4]; // name aliases
215 // a symbol loaded from the .elf file
216 typedef struct avr_symbol_t {
221 // locate the maker for mcu "name" and allocates a new avr instance
222 avr_t * avr_make_mcu_by_name(const char *name);
223 // initializes a new AVR instance. Will call the IO registers init(), and then reset()
224 int avr_init(avr_t * avr);
225 // resets the AVR, and the IO modules
226 void avr_reset(avr_t * avr);
227 // run one cycle of the AVR, sleep if necessary
228 int avr_run(avr_t * avr);
229 // finish any pending operations
230 void avr_terminate(avr_t * avr);
232 // set an IO register to receive commands from the AVR firmware
233 // it's optional, and uses the ELF tags
234 void avr_set_command_register(avr_t * avr, avr_io_addr_t addr);
235 // load code in the "flash"
236 void avr_loadcode(avr_t * avr, uint8_t * code, uint32_t size, uint32_t address);
240 * these are accessors for avr->data but allows watchpoints to be set for gdb
241 * IO modules use that to set values to registers, and the AVR core decoder uses
242 * that to register "public" read by instructions.
244 void avr_core_watch_write(avr_t *avr, uint16_t addr, uint8_t v);
245 uint8_t avr_core_watch_read(avr_t *avr, uint16_t addr);
247 // called when the core has detected a crash somehow.
248 // this might activate gdb server
249 void avr_sadly_crashed(avr_t *avr, uint8_t signal);
252 #include "sim_regbit.h"
253 #include "sim_interrupts.h"
255 #include "sim_cycle_timers.h"
257 #endif /*__SIM_AVR_H__*/