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/>.
28 typedef uint8_t (*avr_io_read_t)(struct avr_t * avr, uint8_t addr, void * param);
29 typedef void (*avr_io_write_t)(struct avr_t * avr, uint8_t addr, uint8_t v, void * param);
33 S_C = 0,S_Z,S_N,S_V,S_S,S_H,S_T,S_I,
35 // 16 bits register pairs
36 R_XL = 0x1a, R_XH,R_YL,R_YH,R_ZL,R_ZH,
38 R_SPL = 32+0x3d, R_SPH,
42 // maximum number of IO regisrer, on normal AVRs
43 MAX_IOs = 256 - 32, // minus 32 GP registers
46 #define AVR_DATA_TO_IO(v) ((v) - 32)
47 #define AVR_IO_TO_DATA(v) ((v) + 32)
50 * Core states. This will need populating with debug states for gdb
53 cpu_Limbo = 0, // before initialization is finished
63 * Main AVR instance. Some of these fields are set by the AVR "Core" definition files
64 * the rest is runtime data (as little as possible)
66 typedef struct avr_t {
67 const char * mmcu; // name of the AVR
68 // these are filled by sim_core_declare from constants in /usr/lib/avr/include/avr/io*.h
76 // filled by the ELF data, this allow tracking of invalid jumps
79 int state; // stopped, running, sleeping
80 uint32_t frequency; // frequency we are running at
81 uint64_t cycle; // current cycle
83 // called at init time
84 void (*init)(struct avr_t * avr);
85 // called at reset time
86 void (*reset)(struct avr_t * avr);
88 // Mirror of the SREG register, to facilitate the access to bits
89 // in the opcode decoder.
90 // This array is re-synthetized back/forth when SREG changes
95 * Note that the PC is reoresenting /bytes/ while the AVR value is
96 * assumed to be "words". This is in line with what GDB does...
97 * this is why you will see >>1 ane <<1 in the decoder to handle jumps
102 * callback when specific IO registers are read/written
113 // flash memory (initialized to 0xff, and code loaded into it)
115 // this is the general purpose registers, IO registers, and SRAM
118 // queue of io modules
119 struct avr_io_t *io_port;
121 // interrupt vectors, and their enable/clear registers
122 struct avr_int_vector_t * vector[64];
123 uint8_t pending_wait; // number of cycles to wait for pending
124 uint32_t pending[2]; // pending interrupts
128 struct avr_symbol_t ** codeline;
131 * this keeps track of "jumps" ie, call,jmp,ret,reti and so on
132 * allows dumping of a meaningful data even if the stack is
135 #define OLD_PC_SIZE 32
139 } old[OLD_PC_SIZE]; // catches reset..
143 #define STACK_FRAME_SIZE 32
144 // this records the call/ret pairs, to try to catch
145 // code that munches the stack -under- their own frame
149 } stack_frame[STACK_FRAME_SIZE];
150 int stack_frame_index;
154 // keeps track of wich registers gets touched by instructions
155 // reset before each new instructions. Allows meaningful traces
156 uint32_t touched[256 / 32]; // debug
158 // gdb hooking structure. Only present when gdb server is active
159 struct avr_gdb_t * gdb;
160 // if non-zero, the gdb server will be started when the core
161 // crashed even if not activated at startup
162 // if zero, the simulator will just exit() in case of a crash
167 // this is a static constructor for each of the AVR devices
168 typedef struct avr_kind_t {
169 const char * names[4]; // name aliases
173 // a symbol loaded from the .elf file
174 typedef struct avr_symbol_t {
179 // locate the maker for mcu "name" and allocates a new avr instance
180 avr_t * avr_make_mcu_by_name(const char *name);
181 // initializes a new AVR instance. Will call the IO registers init(), and then reset()
182 int avr_init(avr_t * avr);
183 // resets the AVR, and the IO modules
184 void avr_reset(avr_t * avr);
185 // run one cycle of the AVR, sleep if necessary
186 int avr_run(avr_t * avr);
188 // load code in the "flash"
189 void avr_loadcode(avr_t * avr, uint8_t * code, uint32_t size, uint32_t address);
193 * these are accessors for avr->data but allows watchpoints to be set for gdb
194 * IO modules use that to set values to registers, and the AVR core decoder uses
195 * that to register "public" read by instructions.
197 void avr_core_watch_write(avr_t *avr, uint16_t addr, uint8_t v);
198 uint8_t avr_core_watch_read(avr_t *avr, uint16_t addr);
200 // called when the core has detected a crash somehow.
201 // this might activate gdb server
202 void avr_sadly_crashed(avr_t *avr, uint8_t signal);
205 #include "sim_regbit.h"
206 #include "sim_interrupts.h"
209 #endif /*__SIM_AVR_H__*/