git.rot13.org Git - simavr/blob - README.md

   1 simavr - a lean and mean Atmel AVR simulator for linux
   2 ======
   3
   4 _simavr_ is a new AVR simulator for linux, or any platform that uses avr-gcc. It uses
   5 avr-gcc's own register definition to simplify creating new targets for supported AVR
   6 devices. The core was made to be small and compact, and hackable so allow quick
   7 prototyping of an AVR project. The AVR core is now stable for use with parts
   8 with <= 128KB flash, and with preliminary support for the bigger parts. The
   9 simulator loads ELF files directly, and there is even a way to specify simulation
  10 parameters directly in the emulated code using an .elf section. You can also
  11 load multipart HEX files.
  12
  13 Supported IOs
  14 --------------
  15 * _eeprom_
  16 * _watchdog_
  17 * _IO ports_ (including pin interrupts)
  18 * _Timers_, 8 &16 (Normal, CTC and Fast PWM, the overflow interrupt too)
  19 * The _UART_, including tx & rx interrupts (there is a loopback/local echo test mode too)
  20 * _SPI_, master/slave including the interrupt
  21 * _i2c_ Master & Slave
  22 * External _Interrupts_, INT0 and so on.
  23 * _ADC_
  24 * Self-programming (ie bootloaders!)
  25
  26 Emulated Cores (very easy to add new ones!)
  27 --------------
  28 + AT90USB162 (with USB!)
  29 + ATMega1280
  30 + ATMega128
  31 + ATMega16M1
  32 + ATMega164/324/644
  33 + ATMega48/88/168/328
  34 + ATMega8
  35 + ATTiny25/45/85
  36 + ATTIny44/84
  37 + ATTiny2313
  38 + ATTiny13
  39
  40 Extras:
  41 -------
  42 * fully working _gdb_ support including some pretty cool “passive modes”.
  43 * There is also very easy support for “VCD” (Value Change Dump) that can be visualized
  44 graphically as “waveforms” with tools like _gtkwave_ (see below).
  45 * There are a few examples of real life firmwares running on simavr, including OpenGL rendering of the display…
  46 * There is support for _Arduino_, but no IDE integration
  47
  48 Documentation And Further Information
  49 -------------------------------------
  50
  51 * Manual / Developer Guide: https://github.com/buserror-uk/simavr/blob/master/doc/manual/manual.pdf?raw=true
  52 * Examples: https://github.com/buserror-uk/simavr/tree/master/examples
  53 * Mailing List: http://groups.google.com/group/simavr
  54 * IRC: _#simavr_ on Freenode
  55
  56 Contributing
  57 ------------
  58
  59 Patches are always welcome! Please submit your changes via Github pull requests.
  60
  61 VCD Support -- built in logic analyzer
  62 -----------
  63 _simavr_ can output most of its pins, firmware variables, interrupts and a few other
  64 things as signals to be dumped into a file that can be plotted using gtkwave for
  65 further, precise analysis.
  66 A firmware can contain instructions for _simavr_ to know what to trace, and the file is
  67 automatically generated.
  68 Example:
  69
  70         const struct avr_mmcu_vcd_trace_t _mytrace[]  _MMCU_ = {
  71                 { AVR_MCU_VCD_SYMBOL("UDR0"), .what = (void*)&UDR0, },
  72                 { AVR_MCU_VCD_SYMBOL("UDRE0"), .mask = (1 << UDRE0), .what = (void*)&UCSR0A, },
  73         };
  74
  75 Will tell _simavr_ to generate a trace everytime the UDR0 register changes and everytime
  76 the interrupt is raised (in UCSR0A). The *_MMCU_* tag tells gcc that it needs compiling,
  77 but it won't be linked in your program, so it takes literally zero bytes, this is a code
  78 section that is private to _simavr_, it's free!
  79 A program running with these instructions and writing to the serial port will generate
  80 a file that will display:
  81
  82         $ ./simavr/run_avr tests/atmega88_example.axf
  83         AVR_MMCU_TAG_VCD_TRACE 00c6:00 - UDR0
  84         AVR_MMCU_TAG_VCD_TRACE 00c0:20 - UDRE0
  85         Loaded 1780 .text
  86         Loaded 114 .data
  87         Loaded 4 .eeprom
  88         Starting atmega88 - flashend 1fff ramend 04ff e2end 01ff
  89         atmega88 init
  90         avr_eeprom_ioctl: AVR_IOCTL_EEPROM_SET Loaded 4 at offset 0
  91         Creating VCD trace file 'gtkwave_trace.vcd'
  92         Read from eeprom 0xdeadbeef -- should be 0xdeadbeef..
  93         Read from eeprom 0xcafef00d -- should be 0xcafef00d..
  94         simavr: sleeping with interrupts off, quitting gracefully
  95
  96 And when the file is loaded in gtkwave, you see:
  97 ![gtkwave](https://github.com/buserror-uk/simavr/raw/master/doc/img/gtkwave1.png)
  98
  99 You get a very precise timing breakdown of any change that you add to the trace, down
 100 to the AVR cycle.
 101
 102 Example:
 103 --------
 104 _simavr_ is really made to be the center for emulating your own AVR projects, not just
 105 a debugger, but also the emulating the peripherals you will use in your firmware, so
 106 you can test and develop offline, and now and then try it on the hardware.
 107
 108 You can also use _simavr_ to do test units on your shipping firmware to validate it
 109 before you ship a new version, to prevent regressions or mistakes.
 110
 111 _simavr_ has a few 'complete projects/ that demonstrate this, most of them were made
 112 using real hardware at some point, and the firmware binary is _exactly_ the one that
 113 ran on the hardware. The key here is to emulate the _parts_ or peripherals that
 114 are hooked to the AVR. Of course, you don't have to emulate the full hardware, you just
 115 need to generate the proper stimulus so that the AVR is fooled.
 116
 117 HD44780 LCD Board Demo
 118 ----------------------
 119
 120 ![lcd](https://github.com/buserror-uk/simavr/raw/master/doc/img/hd44780.png)
 121
 122 This example board hooks up an Atmega48 to an emulated HD44780 LCD and display a running
 123 counter in the 'lcd'. Everything is emulated, the firmware runs exactly like this
 124 on a real hardware.
 125
 126 ![lcd-gtkwave](https://github.com/buserror-uk/simavr/raw/master/doc/img/hd44780-wave.png)
 127
 128 And this is a gtkwave trace of what the firmware is doing. You can zoom in, measure, etc
 129 in gtkwave, select trades to see etc.
 130
 131 Quite a few other examples are available!