4 Copyright 2008-2012 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/>.
30 #include "sim_interrupts.h"
31 #include "sim_cycle_timers.h"
33 typedef uint32_t avr_flashaddr_t;
36 typedef uint8_t (*avr_io_read_t)(
40 typedef void (*avr_io_write_t)(
48 S_C = 0,S_Z,S_N,S_V,S_S,S_H,S_T,S_I,
50 // 16 bits register pairs
51 R_XL = 0x1a, R_XH,R_YL,R_YH,R_ZL,R_ZH,
53 R_SPL = 32+0x3d, R_SPH,
57 // maximum number of IO registers, on normal AVRs
58 MAX_IOs = 256, // Bigger AVRs need more than 256-32 (mega1280)
61 #define AVR_DATA_TO_IO(v) ((v) - 32)
62 #define AVR_IO_TO_DATA(v) ((v) + 32)
68 cpu_Limbo = 0, // before initialization is finished
69 cpu_Stopped, // all is stopped, timers included
71 cpu_Running, // we're free running
73 cpu_Sleeping, // we're now sleeping until an interrupt
75 cpu_Step, // run ONE instruction, then...
76 cpu_StepDone, // tell gdb it's all OK, and give it registers
77 cpu_Done, // avr software stopped gracefully
78 cpu_Crashed, // avr software crashed (watchdog fired)
81 // this is only ever used if CONFIG_SIMAVR_TRACE is defined
82 struct avr_trace_data_t {
83 struct avr_symbol_t ** codeline;
86 * this keeps track of "jumps" ie, call,jmp,ret,reti and so on
87 * allows dumping of a meaningful data even if the stack is
90 #define OLD_PC_SIZE 32
94 } old[OLD_PC_SIZE]; // catches reset..
98 #define STACK_FRAME_SIZE 32
99 // this records the call/ret pairs, to try to catch
100 // code that munches the stack -under- their own frame
104 } stack_frame[STACK_FRAME_SIZE];
105 int stack_frame_index;
109 // keeps track of which registers gets touched by instructions
110 // reset before each new instructions. Allows meaningful traces
111 uint32_t touched[256 / 32]; // debug
115 * Main AVR instance. Some of these fields are set by the AVR "Core" definition files
116 * the rest is runtime data (as little as possible)
118 typedef struct avr_t {
119 const char * mmcu; // name of the AVR
120 // these are filled by sim_core_declare from constants in /usr/lib/avr/include/avr/io*.h
125 uint8_t signature[3];
127 avr_io_addr_t rampz; // optional, only for ELPM/SPM on >64Kb cores
128 avr_io_addr_t eind; // optional, only for EIJMP/EICALL on >64Kb cores
130 // filled by the ELF data, this allow tracking of invalid jumps
133 int state; // stopped, running, sleeping
134 uint32_t frequency; // frequency we are running at
135 // mostly used by the ADC for now
136 uint32_t vcc,avcc,aref; // (optional) voltages in millivolts
138 // cycles gets incremented when sleeping and when running; it corresponds
139 // not only to "cycles that runs" but also "cycles that might have run"
141 avr_cycle_count_t cycle; // current cycle
143 // called at init time
144 void (*init)(struct avr_t * avr);
145 // called at init time (for special purposes like using a memory mapped file as flash see: simduino)
146 void (*special_init)(struct avr_t * avr);
147 // called at termination time ( to clean special initalizations)
148 void (*special_deinit)(struct avr_t * avr);
149 // called at reset time
150 void (*reset)(struct avr_t * avr);
153 * Default AVR core run function.
154 * Two modes are available, a "raw" run that goes as fast as
155 * it can, and a "gdb" mode that also watchouts for gdb events
156 * and is a little bit slower.
158 void (*run)(struct avr_t * avr);
161 * Sleep default behaviour.
162 * In "raw" mode, it calls usleep, in gdb mode, it waits
163 * for howLong for gdb command on it's sockets.
165 void (*sleep)(struct avr_t * avr, avr_cycle_count_t howLong);
168 * Every IRQs will be stored in this pool. It is not
169 * mandatory (yet) but will allow listing IRQs and their connections
171 avr_irq_pool_t irq_pool;
173 // Mirror of the SREG register, to facilitate the access to bits
174 // in the opcode decoder.
175 // This array is re-synthetized back/forth when SREG changes
177 uint8_t i_shadow; // used to detect edges on I flag
181 * Note that the PC is representing /bytes/ while the AVR value is
182 * assumed to be "words". This is in line with what GDB does...
183 * this is why you will see >>1 and <<1 in the decoder to handle jumps.
184 * It CAN be a little confusing, so concentrate, young grasshopper.
189 * callback when specific IO registers are read/written.
190 * There is one drawback here, there is in way of knowing what is the
191 * "beginning of useful sram" on a core, so there is no way to deduce
192 * what is the maximum IO register for a core, and thus, we can't
193 * allocate this table dynamically.
194 * If you wanted to emulate the BIG AVRs, and XMegas, this would need
198 struct avr_irq_t * irq; // optional, used only if asked for with avr_iomem_getirq()
210 * This block allows sharing of the IO write/read on addresses between
211 * multiple callbacks. In 99% of case it's not needed, however on the tiny*
212 * (tiny85 at last) some registers have bits that are used by different
214 * If this case is detected, a special "dispatch" callback is installed that
215 * will handle this particular case, without impacting the performance of the
216 * other, normal cases...
218 int io_shared_io_count;
227 // flash memory (initialized to 0xff, and code loaded into it)
229 // this is the general purpose registers, IO registers, and SRAM
232 // queue of io modules
233 struct avr_io_t *io_port;
235 // cycle timers tracking & delivery
236 avr_cycle_timer_pool_t cycle_timers;
237 // interrupt vectors and delivery fifo
238 avr_int_table_t interrupts;
240 // DEBUG ONLY -- value ignored if CONFIG_SIMAVR_TRACE = 0
242 log : 2; // log level, default to 1
244 // Only used if CONFIG_SIMAVR_TRACE is defined
245 struct avr_trace_data_t *trace_data;
247 // VALUE CHANGE DUMP file (waveforms)
248 // this is the VCD file that gets allocated if the
249 // firmware that is loaded explicitly asks for a trace
250 // to be generated, and allocates it's own symbols
251 // using AVR_MMCU_TAG_VCD_TRACE (see avr_mcu_section.h)
252 struct avr_vcd_t * vcd;
254 // gdb hooking structure. Only present when gdb server is active
255 struct avr_gdb_t * gdb;
257 // if non-zero, the gdb server will be started when the core
258 // crashed even if not activated at startup
259 // if zero, the simulator will just exit() in case of a crash
264 // this is a static constructor for each of the AVR devices
265 typedef struct avr_kind_t {
266 const char * names[4]; // name aliases
270 // a symbol loaded from the .elf file
271 typedef struct avr_symbol_t {
276 // locate the maker for mcu "name" and allocates a new avr instance
278 avr_make_mcu_by_name(
280 // initializes a new AVR instance. Will call the IO registers init(), and then reset()
284 // Used by the cores, allocated a mutable avr_t from the const global
290 // resets the AVR, and the IO modules
294 // run one cycle of the AVR, sleep if necessary
298 // finish any pending operations
303 // set an IO register to receive commands from the AVR firmware
304 // it's optional, and uses the ELF tags
306 avr_set_command_register(
310 // specify the "console register" -- output sent to this register
311 // is printed on the simulator console, without using a UART
313 avr_set_console_register(
317 // load code in the "flash"
323 avr_flashaddr_t address);
326 * these are accessors for avr->data but allows watchpoints to be set for gdb
327 * IO modules use that to set values to registers, and the AVR core decoder uses
328 * that to register "public" read by instructions.
331 avr_core_watch_write(
340 // called when the core has detected a crash somehow.
341 // this might activate gdb server
349 * These are callbacks for the two 'main' bahaviour in simavr
351 void avr_callback_sleep_gdb(avr_t * avr, avr_cycle_count_t howLong);
352 void avr_callback_run_gdb(avr_t * avr);
353 void avr_callback_sleep_raw(avr_t * avr, avr_cycle_count_t howLong);
354 void avr_callback_run_raw(avr_t * avr);
361 #include "sim_regbit.h"
363 #endif /*__SIM_AVR_H__*/