added args to simulavr to define serial device

configure.ac

@@ -6,7 +6,7 @@
 # common initialisation of autotools
 ####
 AC_INIT([SimulAVR], [1.1dev], [simulavr-devel@nongnu.org])
-AM_INIT_AUTOMAKE([1.10 -Wall -Werror foreign])
+AM_INIT_AUTOMAKE([1.10 -Wall foreign])
 AC_PREREQ([2.61])
 AC_CONFIG_MACRO_DIR([m4])
 AM_MAINTAINER_MODE
@@ -215,6 +215,7 @@ AC_CONFIG_FILES([
   examples/atmega48/Makefile examples/atmega128_timer/Makefile
   examples/atmel_key/Makefile examples/feedback/Makefile examples/simple_ex1/Makefile
   examples/spi/Makefile examples/stdiodemo/Makefile examples/python/Makefile
+  examples/simple_serial/Makefile
 ])
 
 ## Certain files should only be generated if Tcl is available and enabled

doc/mdate-sh

@@ -45,7 +45,7 @@ Report bugs to <bug-automake@gnu.org>.
 EOF
     exit $?
     ;;
-  -v | --v*)
+  -V | --v*)
     echo "mdate-sh $scriptversion"
     exit $?
     ;;

doc/simulavr.texi

@@ -179,9 +179,9 @@ no matter if it is ever reached or not.
 run with user interface for external pin handling at port 7777. This
 does not open any graphics but activates the interface to communicate
 with the environment simulation.
-@item -v --version
+@item -V --version
 show the software version of simulavr
-@item -V --verbose
+@item -v --verbose
 output some hints to console
 @item -W --writetopipe <offset>,<file>
 add a special pipe register to device at IO-Offset and opens <file> for writing

doc/usage.rst

@@ -8,10 +8,10 @@ Invoke simulavr::
 Common options
 --------------
 
-``-v, --version``
+``-V, --version``
   show the software version of simulavr
 
-``-V, --verbose``
+``-v, --verbose``
   output some hints to console
 
 ``-h, --help``

examples/Makefile.am

@@ -5,7 +5,7 @@
 
 examplesdir = $(docdir)/examples
 
-SUBDIRS = simple_ex1
+SUBDIRS = simple_ex1 simple_serial
 if USE_TCL
 SUBDIRS += anacomp atmega48 spi stdiodemo feedback atmega128_timer atmel_key
 endif

examples/simple_serial/.gitignore

@@ -0,0 +1,3 @@
+*.elf
+*.hex
+

examples/simple_serial/Makefile.am

@@ -0,0 +1,43 @@
+#
+#  $Id$
+#
+
+examplesdir = $(docdir)/examples/simple_serial
+
+EXAMPLE = simple_serial
+
+AVR_GCC = @AVR_GCC@
+AVR_CPU = atmega644
+AVR_FREQUENCY = 20000000
+AVR_CFLAGS = -g -O2 -mmcu=$(AVR_CPU) -DF_CPU=$(AVR_FREQUENCY)
+AVR_CFLAGS += -Wl,--section-start=.siminfo=0x900000
+AVR_OBJS = main.o serial.o
+SIMULAVR_ARGS = -d $(AVR_CPU) -f $(EXAMPLE).elf
+
+EXTRA_DIST = main.c serial.c serial.h
+
+examples_DATA = $(EXAMPLE).hex $(EXAMPLE).elf $(EXTRA_DIST) README
+
+CLEANFILES = $(EXAMPLE).hex $(EXAMPLE).elf $(AVR_OBJS)
+
+
+do: $(EXAMPLE).elf
+	../../src/simulavr $(SIMULAVR_ARGS)
+
+program: $(EXAMPLE).hex
+	avrdude -c stk500v2 -b 115200 -p $(AVR_CPU) -P $(SERIAL_AVR) \
+	-U flash:w:$<
+
+
+$(EXAMPLE).hex: $(EXAMPLE).elf
+	avr-objcopy -j .text -j .data -O ihex -R .eeprom -R .fuse -R .lock $< $@
+
+$(EXAMPLE).elf: $(AVR_OBJS)
+	$(AVR_GCC) $(AVR_CFLAGS) -o $@ $^
+
+main.o: $(srcdir)/main.c
+	$(AVR_GCC) $(AVR_CFLAGS) -c -o $@ $<
+
+serial.o: $(srcdir)/serial.c  $(srcdir)/serial.h
+	$(AVR_GCC) $(AVR_CFLAGS) -c -o $@ $<
+

examples/simple_serial/README

@@ -0,0 +1,48 @@
+#
+#  $Id$
+#
+#
+# Copyright (C) 2013 Markus Hitter <mah@jump-ing.de>
+
+
+This example illustrates how one can communicate with the simulated AVR
+using its USART. The other end of the communications line is stdin/stdout,
+so you can simply interact with the simulated AVR by typing into the
+terminal you used to start it with.
+
+The firmware provided can be uploaded to real hardware as-is and should do
+just the same when accessed through a serial terminal. This is an important
+point, because in main.c you can see how few tweaks to the original code
+are required to allow interacting with a simulated run. All of these tweaks
+don't alter the binary actually executed at all.
+
+Building and running the example:
+
+ - Have SimulAVR built, default configuration options are fine.
+
+ - Go to examples/simple_serial (here).
+
+ - Build the example:
+
+      make
+
+ - Run the example:
+
+      make do
+
+ - Upload the example to and run it on real hardware (this isn't exactly
+   flexible, yet, it might require some tweaks to the Makefile to match
+   /your/ hardware):
+
+      export SERIAL_AVR=/dev/<your device here>
+      make program
+      gtkterm -p $SERIAL_AVR -s 19200
+
+Interaction:
+
+Well, extremely simple. It's a code example, after all. Type characters and
+the characters will be sent back with some extra text. That's all, I hope
+this fuels your imagination.
+
+
+

examples/simple_serial/main.c

@@ -0,0 +1,78 @@
+ /*
+ ****************************************************************************
+ *
+ * simple_serial - A demo for the SimulAVR simulator.
+ * Copyright (C) 2013 Markus Hitter <mah@jump-ing.de>
+ * 
+ * This program 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 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ ****************************************************************************
+ *
+ *  $Id$
+ *
+ * Super trivial example exercising the UART serial communications line.
+ *
+ * It's purpose is to show how SimulAVR can redirect serial communications
+ * in a way useful for running in a simulator, while requiring NO code
+ * modifications which would change it's behaviour compared to running
+ * on real hardware or disallowing to run the very same compiled binary
+ * on that hardware. The compiled binary should work in the simulator just
+ * as fine as on hardware.
+ */
+
+#include "serial.h"
+
+#include <avr/interrupt.h>
+
+/*
+ * Here we tell SimulAVR for which device and which frequency we build this
+ * code. The nice thing is, these macros add a section to the ELF file, so
+ * they can be read by SimulAVR, but they're also ignored when converted to
+ * an ihex file for hardware upload. Accordingly, the executed binary for
+ * SimulAVR and real hardware is the same, no need to recompile for one or
+ * another. The more important result of this is, behaviour is also exactly
+ * the same, no extra cycles for serving simulator matters.
+ *
+ * One small caveat: To stop the linker from stripping this section, avr-gcc
+ * needs an extra parameter when linking the binary (see Makefile.am):
+ *
+ *   -Wl,--section-start=.siminfo=0x900000
+ *
+ * For details on these macros, see the comments in simulavr_info.h.
+ */
+#include "../../src/simulavr_info.h"
+SIMINFO_DEVICE("atmega644");
+SIMINFO_CPUFREQUENCY(F_CPU);
+SIMINFO_SERIAL_IN("D0", "-", 19200);
+SIMINFO_SERIAL_OUT("D1", "-", 19200);
+
+
+// This is all we need:
+int main (void) {
+
+  serial_init();
+  sei();
+
+  serial_writestr_P(PSTR("Hello, world!\n\nNow, please type:\n"));
+
+  for (;;) {
+    if (serial_rxchars() != 0) {
+      uint8_t c = serial_popchar();
+      serial_writestr_P(PSTR("received: <"));
+      serial_writechar(c);
+      serial_writestr_P(PSTR(">\n"));
+    }
+  }
+}