/usr/include/simavr/sim_avr.h is in libsimavr-dev 1.5+dfsg1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 | /*
sim_avr.h
Copyright 2008-2012 Michel Pollet <buserror@gmail.com>
This file is part of simavr.
simavr is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
simavr is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with simavr. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __SIM_AVR_H__
#define __SIM_AVR_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "sim_irq.h"
#include "sim_interrupts.h"
#include "sim_cmds.h"
#include "sim_cycle_timers.h"
typedef uint32_t avr_flashaddr_t;
struct avr_t;
typedef uint8_t (*avr_io_read_t)(
struct avr_t * avr,
avr_io_addr_t addr,
void * param);
typedef void (*avr_io_write_t)(
struct avr_t * avr,
avr_io_addr_t addr,
uint8_t v,
void * param);
enum {
// SREG bit indexes
S_C = 0,S_Z,S_N,S_V,S_S,S_H,S_T,S_I,
// 16 bits register pairs
R_XL = 0x1a, R_XH,R_YL,R_YH,R_ZL,R_ZH,
// stack pointer
R_SPL = 32+0x3d, R_SPH,
// real SREG
R_SREG = 32+0x3f,
// maximum number of IO registers, on normal AVRs
MAX_IOs = 280, // Bigger AVRs need more than 256-32 (mega1280)
};
#define AVR_DATA_TO_IO(v) ((v) - 32)
#define AVR_IO_TO_DATA(v) ((v) + 32)
/**
* Logging macros and associated log levels.
* The current log level is kept in avr->log.
*/
enum {
LOG_OUTPUT = 0,
LOG_ERROR,
LOG_WARNING,
LOG_TRACE,
};
#ifndef AVR_LOG
#define AVR_LOG(avr, level, ...) \
do { \
avr_global_logger(avr, level, __VA_ARGS__); \
} while(0)
#endif
#define AVR_TRACE(avr, ... ) \
AVR_LOG(avr, LOG_TRACE, __VA_ARGS__)
/*
* Core states.
*/
enum {
cpu_Limbo = 0, // before initialization is finished
cpu_Stopped, // all is stopped, timers included
cpu_Running, // we're free running
cpu_Sleeping, // we're now sleeping until an interrupt
cpu_Step, // run ONE instruction, then...
cpu_StepDone, // tell gdb it's all OK, and give it registers
cpu_Done, // avr software stopped gracefully
cpu_Crashed, // avr software crashed (watchdog fired)
};
// this is only ever used if CONFIG_SIMAVR_TRACE is defined
struct avr_trace_data_t {
struct avr_symbol_t ** codeline;
/* DEBUG ONLY
* this keeps track of "jumps" ie, call,jmp,ret,reti and so on
* allows dumping of a meaningful data even if the stack is
* munched and so on
*/
#define OLD_PC_SIZE 32
struct {
uint32_t pc;
uint16_t sp;
} old[OLD_PC_SIZE]; // catches reset..
int old_pci;
#if AVR_STACK_WATCH
#define STACK_FRAME_SIZE 32
// this records the call/ret pairs, to try to catch
// code that munches the stack -under- their own frame
struct {
uint32_t pc;
uint16_t sp;
} stack_frame[STACK_FRAME_SIZE];
int stack_frame_index;
#endif
// DEBUG ONLY
// keeps track of which registers gets touched by instructions
// reset before each new instructions. Allows meaningful traces
uint32_t touched[256 / 32]; // debug
};
typedef void (*avr_run_t)(
struct avr_t * avr);
#define AVR_FUSE_LOW 0
#define AVR_FUSE_HIGH 1
#define AVR_FUSE_EXT 2
/*
* Main AVR instance. Some of these fields are set by the AVR "Core" definition files
* the rest is runtime data (as little as possible)
*/
typedef struct avr_t {
const char * mmcu; // name of the AVR
// these are filled by sim_core_declare from constants in /usr/lib/avr/include/avr/io*.h
uint16_t ramend;
uint32_t flashend;
uint32_t e2end;
uint8_t vector_size;
uint8_t signature[3];
uint8_t fuse[6];
uint8_t lockbits;
avr_io_addr_t rampz; // optional, only for ELPM/SPM on >64Kb cores
avr_io_addr_t eind; // optional, only for EIJMP/EICALL on >64Kb cores
uint8_t address_size; // 2, or 3 for cores >128KB in flash
// filled by the ELF data, this allow tracking of invalid jumps
uint32_t codeend;
int state; // stopped, running, sleeping
uint32_t frequency; // frequency we are running at
// mostly used by the ADC for now
uint32_t vcc,avcc,aref; // (optional) voltages in millivolts
// cycles gets incremented when sleeping and when running; it corresponds
// not only to "cycles that runs" but also "cycles that might have run"
// like, sleeping.
avr_cycle_count_t cycle; // current cycle
// these next two allow the core to freely run between cycle timers and also allows
// for a maximum run cycle limit... run_cycle_count is set during cycle timer processing.
avr_cycle_count_t run_cycle_count; // cycles to run before next timer
avr_cycle_count_t run_cycle_limit; // maximum run cycle interval limit
/**
* Sleep requests are accumulated in sleep_usec until the minimum sleep value
* is reached, at which point sleep_usec is cleared and the sleep request
* is passed on to the operating system.
*/
uint32_t sleep_usec;
// called at init time
void (*init)(struct avr_t * avr);
// called at reset time
void (*reset)(struct avr_t * avr);
struct {
// called at init time (for special purposes like using a
// memory mapped file as flash see: simduino)
void (*init)(struct avr_t * avr, void * data);
// called at termination time ( to clean special initializations)
void (*deinit)(struct avr_t * avr, void * data);
// value passed to init() and deinit()
void *data;
} custom;
/*!
* Default AVR core run function.
* Two modes are available, a "raw" run that goes as fast as
* it can, and a "gdb" mode that also watchouts for gdb events
* and is a little bit slower.
*/
avr_run_t run;
/*!
* Sleep default behaviour.
* In "raw" mode, it calls usleep, in gdb mode, it waits
* for howLong for gdb command on it's sockets.
*/
void (*sleep)(struct avr_t * avr, avr_cycle_count_t howLong);
/*!
* Every IRQs will be stored in this pool. It is not
* mandatory (yet) but will allow listing IRQs and their connections
*/
avr_irq_pool_t irq_pool;
// Mirror of the SREG register, to facilitate the access to bits
// in the opcode decoder.
// This array is re-synthesized back/forth when SREG changes
uint8_t sreg[8];
/* Interrupt state:
00: idle (no wait, no pending interrupts) or disabled
<0: wait till zero
>0: interrupt pending */
int8_t interrupt_state; // interrupt state
/*
* ** current PC **
* Note that the PC is representing /bytes/ while the AVR value is
* assumed to be "words". This is in line with what GDB does...
* this is why you will see >>1 and <<1 in the decoder to handle jumps.
* It CAN be a little confusing, so concentrate, young grasshopper.
*/
avr_flashaddr_t pc;
/*
* Reset PC, this is the value used to jump to at reset time, this
* allow support for bootloaders
*/
avr_flashaddr_t reset_pc;
/*
* callback when specific IO registers are read/written.
* There is one drawback here, there is in way of knowing what is the
* "beginning of useful sram" on a core, so there is no way to deduce
* what is the maximum IO register for a core, and thus, we can't
* allocate this table dynamically.
* If you wanted to emulate the BIG AVRs, and XMegas, this would need
* work.
*/
struct {
struct avr_irq_t * irq; // optional, used only if asked for with avr_iomem_getirq()
struct {
void * param;
avr_io_read_t c;
} r;
struct {
void * param;
avr_io_write_t c;
} w;
} io[MAX_IOs];
/*
* This block allows sharing of the IO write/read on addresses between
* multiple callbacks. In 99% of case it's not needed, however on the tiny*
* (tiny85 at last) some registers have bits that are used by different
* IO modules.
* If this case is detected, a special "dispatch" callback is installed that
* will handle this particular case, without impacting the performance of the
* other, normal cases...
*/
int io_shared_io_count;
struct {
int used;
struct {
void * param;
void * c;
} io[4];
} io_shared_io[4];
// flash memory (initialized to 0xff, and code loaded into it)
uint8_t * flash;
// this is the general purpose registers, IO registers, and SRAM
uint8_t * data;
// queue of io modules
struct avr_io_t * io_port;
// Builtin and user-defined commands
avr_cmd_table_t commands;
// cycle timers tracking & delivery
avr_cycle_timer_pool_t cycle_timers;
// interrupt vectors and delivery fifo
avr_int_table_t interrupts;
// DEBUG ONLY -- value ignored if CONFIG_SIMAVR_TRACE = 0
uint8_t trace : 1,
log : 2; // log level, default to 1
// Only used if CONFIG_SIMAVR_TRACE is defined
struct avr_trace_data_t *trace_data;
// VALUE CHANGE DUMP file (waveforms)
// this is the VCD file that gets allocated if the
// firmware that is loaded explicitly asks for a trace
// to be generated, and allocates it's own symbols
// using AVR_MMCU_TAG_VCD_TRACE (see avr_mcu_section.h)
struct avr_vcd_t * vcd;
// gdb hooking structure. Only present when gdb server is active
struct avr_gdb_t * gdb;
// if non-zero, the gdb server will be started when the core
// crashed even if not activated at startup
// if zero, the simulator will just exit() in case of a crash
int gdb_port;
// buffer for console debugging output from register
struct {
char * buf;
uint32_t size;
uint32_t len;
} io_console_buffer;
} avr_t;
// this is a static constructor for each of the AVR devices
typedef struct avr_kind_t {
const char * names[4]; // name aliases
avr_t * (*make)(void);
} avr_kind_t;
// a symbol loaded from the .elf file
typedef struct avr_symbol_t {
uint32_t addr;
const char symbol[0];
} avr_symbol_t;
// locate the maker for mcu "name" and allocates a new avr instance
avr_t *
avr_make_mcu_by_name(
const char *name);
// initializes a new AVR instance. Will call the IO registers init(), and then reset()
int
avr_init(
avr_t * avr);
// Used by the cores, allocated a mutable avr_t from the const global
avr_t *
avr_core_allocate(
const avr_t * core,
uint32_t coreLen);
// resets the AVR, and the IO modules
void
avr_reset(
avr_t * avr);
// run one cycle of the AVR, sleep if necessary
int
avr_run(
avr_t * avr);
// finish any pending operations
void
avr_terminate(
avr_t * avr);
// set an IO register to receive commands from the AVR firmware
// it's optional, and uses the ELF tags
void
avr_set_command_register(
avr_t * avr,
avr_io_addr_t addr);
// specify the "console register" -- output sent to this register
// is printed on the simulator console, without using a UART
void
avr_set_console_register(
avr_t * avr,
avr_io_addr_t addr);
// load code in the "flash"
void
avr_loadcode(
avr_t * avr,
uint8_t * code,
uint32_t size,
avr_flashaddr_t address);
/*
* These are accessors for avr->data but allows watchpoints to be set for gdb
* IO modules use that to set values to registers, and the AVR core decoder uses
* that to register "public" read by instructions.
*/
void
avr_core_watch_write(
avr_t *avr,
uint16_t addr,
uint8_t v);
uint8_t
avr_core_watch_read(
avr_t *avr,
uint16_t addr);
// called when the core has detected a crash somehow.
// this might activate gdb server
void
avr_sadly_crashed(
avr_t *avr,
uint8_t signal);
/*
* Logs a message using the current logger
*/
void
avr_global_logger(
struct avr_t* avr,
const int level,
const char * format,
... );
#ifndef AVR_CORE
#include <stdarg.h>
/*
* Type for custom logging functions
*/
typedef void (*avr_logger_p)(struct avr_t* avr, const int level, const char * format, va_list ap);
/* Sets a global logging function in place of the default */
void
avr_global_logger_set(
avr_logger_p logger);
/* Gets the current global logger function */
avr_logger_p
avr_global_logger_get(void);
#endif
/*
* These are callbacks for the two 'main' behaviour in simavr
*/
void avr_callback_sleep_gdb(avr_t * avr, avr_cycle_count_t howLong);
void avr_callback_run_gdb(avr_t * avr);
void avr_callback_sleep_raw(avr_t * avr, avr_cycle_count_t howLong);
void avr_callback_run_raw(avr_t * avr);
/**
* Accumulates sleep requests (and returns a sleep time of 0) until
* a minimum count of requested sleep microseconds are reached
* (low amounts cannot be handled accurately).
* This function is an utility function for the sleep callbacks
*/
uint32_t
avr_pending_sleep_usec(
avr_t * avr,
avr_cycle_count_t howLong);
#ifdef __cplusplus
};
#endif
#include "sim_io.h"
#include "sim_regbit.h"
#ifdef __GNUC__
# ifndef likely
# define likely(x) __builtin_expect(!!(x), 1)
# endif
# ifndef unlikely
# define unlikely(x) __builtin_expect(!!(x), 0)
# endif
#else /* ! __GNUC__ */
# ifndef likely
# define likely(x) x
# endif
# ifndef unlikely
# define unlikely(x) x
# endif
#endif /* __GNUC__ */
#endif /*__SIM_AVR_H__*/
|