Re: [PATCH rc1 14/24] target/avr: Add section about AVR into QEMU documentation

[Philippe Mathieu-Daudé]

On Thu, Jan 23, 2020 at 5:57 AM Thomas Huth <address@hidden> wrote:
> On 23/01/2020 01.02, Richard Henderson wrote:
> > From: Michael Rolnik <address@hidden>
> >
> > Signed-off-by: Michael Rolnik <address@hidden>
> > Message-Id: <address@hidden>
> > Signed-off-by: Richard Henderson <address@hidden>
> > ---
> >  qemu-doc.texi | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 51 insertions(+)
> >
> > diff --git a/qemu-doc.texi b/qemu-doc.texi
> > index 39f950471f..515aacfae9 100644
> > --- a/qemu-doc.texi
> > +++ b/qemu-doc.texi
> > @@ -1741,6 +1741,7 @@ differences are mentioned in the following sections.
> >  * Microblaze System emulator::
> >  * SH4 System emulator::
> >  * Xtensa System emulator::
> > +* AVR System emulator::
> >  @end menu
> >
> >  @node PowerPC System emulator
> > @@ -2514,6 +2515,56 @@ so should only be used with trusted guest OS.
> >
> >  @c man end
> >
> > +@node AVR System emulator
> > +@section AVR System emulator
> > +@cindex system emulation (AVR)
> > +
> > +Use the executable @file{qemu-system-avr} to emulates a AVR 8 bit based 
> > machine having one for the following cores: avr1, avr2, avr25, avr3, avr31, 
> > avr35, avr4, avr5, avr51, avr6, avrtiny, xmega2, xmega3, xmega4, xmega5, 
> > xmega6 and xmega7.
> > +
> > +As for now it does not support any real MCUs. However, it does support a 
> > "sample" board for educational and testing purposes. This "sample" board 
> > hosts USART & 16 bit timer devices and it's enought to run FreeRTOS based 
> > applicaton (like this 
> > @url{https://github.com/seharris/qemu-avr-tests/blob/master/free-rtos/Demo/AVR_ATMega2560_GCC/demo.elf,,demo})
>
> The "sample" board has been replaced by the boards that Philippe added,
> hasn't it? In that case, the above sentence should be adjusted accordingly.
>
> > +Following are examples of possible usages, assuming program.elf is 
> > compiled for AVR cpu
> > +@itemize
> > +
> > +@item Continious non interrupted execution
>
> s/Continious/Continuous/
>
> > +@example
> > +qemu-system-avr -kernel program.elf
> > +@end example
> > +
> > +@item Continious non interrupted execution with serial output into telnet 
> > window
>
> s/Continious/Continuous/
>
> > +@example
> > +qemu-system-avr -kernel program.elf -serial tcp::5678,server,nowait 
> > -nographic
> > +@end example
> > +and then in another shell
> > +@example
> > +telent localhost 5678
>
> s/telent/telnet/
>
> > +@end example
> > +
> > +@item Continious non interrupted execution with serial output into stdout
>
> s/Continious/Continuous/
>
> > +@example
> > +qemu-system-avr -kernel program.elf -serial stdio
> > +@end example
>
> ... and I'm not sure whether we really need multiple examples for
> "-serial" here ... one should be enough, "-serial" is described
> somewhere else in the documentation already.

-kernel isn't supported anyway...

> > +@item Debugging wit GDB debugger
> > +@example
> > +qemu-system-avr -kernel program.elf -s -S
> > +@end example
> > +and then in another shell
> > +@example
> > +avr-gdb program.elf
> > +@end example
> > +and then within GDB shell
> > +@example
> > +target remote :1234
> > +@end example
> > +
> > +@item Print out executed instructions
> > +@example
> > +qemu-system-avr -kernel program.elf -d in_asm
> > +@end example
> > +
> > +@end itemize
> > +
> >  @node QEMU User space emulator
> >  @chapter QEMU User space emulator
>
>  Thomas
>
>