diff mbox series

[v32,22/22] qemu-doc.texi: Add RX section.

Message ID 20200224141923.82118-23-ysato@users.sourceforge.jp
State New
Headers show
Series Add RX archtecture support | expand

Commit Message

Yoshinori Sato Feb. 24, 2020, 2:19 p.m. UTC
Describe emulated target specification. And two examples.

Signed-off-by: Yoshinori Sato <ysato@users.sourceforge.jp>
---
 qemu-doc.texi | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

Comments

Philippe Mathieu-Daudé March 7, 2020, 5:38 p.m. UTC | #1
Hi,

On 2/24/20 3:19 PM, Yoshinori Sato wrote:
> Describe emulated target specification. And two examples.
> 
> Signed-off-by: Yoshinori Sato <ysato@users.sourceforge.jp>
> ---
>   qemu-doc.texi | 44 ++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 44 insertions(+)
> 
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index 33b9597b1d..d80a9c64f7 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -1719,6 +1719,7 @@ differences are mentioned in the following sections.
>   * Microblaze System emulator::
>   * SH4 System emulator::
>   * Xtensa System emulator::
> +* RX System emulator::
>   @end menu
>   
>   @node PowerPC System emulator
> @@ -2487,6 +2488,49 @@ so should only be used with trusted guest OS.
>   
>   @c man end
>   
> +@node RX System emulator
> +@section RX System emulator
> +@cindex system emulation (RX)
> +
> +Use the executable @file{qemu-system-rx} to simulate a Virtual RX target.
> +This target emulated following devices.
> +
> +@itemize @minus
> +@item
> +R5F562N8 MCU
> +@item
> +On-chip memory (ROM 512KB, RAM 96KB)
> +@item
> +Interrupt Control Unit (ICUa)
> +@item
> +8Bit Timer x 1CH (TMR0,1)
> +@item
> +Compare Match Timer x 2CH (CMT0,1)
> +@item
> +Serial Communication Interface x 1CH (SCI0)
> +@item
> +External memory 16MByte
> +@end itemize
> +
> +Example of @file{qemu-system-rx} usage for rx is shown below:
> +
> +Download @code{u-boot_image} from @url{https://osdn.net/users/ysato/pf/qemu/dl/u-boot.bin.gz}
> +
> +Start emulation of rx-virt:
> +@example
> +qemu-system-rx -bios @code{u-boot_image}
> +@end example
> +
> +Download @code{kernel_image} from @url{https://osdn.net/users/ysato/pf/qemu/dl/zImage}
> +
> +Download @code{device_tree_blob} from @url{https://osdn.net/users/ysato/pf/qemu/dl/rx-virt.dtb}
> +
> +Start emulation of rx-virt:
> +@example
> +qemu-system-rx -kernel @code{kernel_image} -dtb @code{device_tree_blob} \
> +  -append "earlycon"
> +@end example
> +
>   @node QEMU User space emulator
>   @chapter QEMU User space emulator
>   
> 

In commit 3a8273b1ab3 the this file has been removed (due to the 
conversion to the rST format).

Can you send a single patch (not the rest) with your documentation in 
rST format please?
Yoshinori Sato March 8, 2020, 3:49 a.m. UTC | #2
On Sun, 08 Mar 2020 02:38:08 +0900,
Philippe Mathieu-Daudé wrote:
> 
> Hi,
> 
> On 2/24/20 3:19 PM, Yoshinori Sato wrote:
> > Describe emulated target specification. And two examples.
> > 
> > Signed-off-by: Yoshinori Sato <ysato@users.sourceforge.jp>
> > ---
> >   qemu-doc.texi | 44 ++++++++++++++++++++++++++++++++++++++++++++
> >   1 file changed, 44 insertions(+)
> > 
> > diff --git a/qemu-doc.texi b/qemu-doc.texi
> > index 33b9597b1d..d80a9c64f7 100644
> > --- a/qemu-doc.texi
> > +++ b/qemu-doc.texi
> > @@ -1719,6 +1719,7 @@ differences are mentioned in the following sections.
> >   * Microblaze System emulator::
> >   * SH4 System emulator::
> >   * Xtensa System emulator::
> > +* RX System emulator::
> >   @end menu
> >     @node PowerPC System emulator
> > @@ -2487,6 +2488,49 @@ so should only be used with trusted guest OS.
> >     @c man end
> >   +@node RX System emulator
> > +@section RX System emulator
> > +@cindex system emulation (RX)
> > +
> > +Use the executable @file{qemu-system-rx} to simulate a Virtual RX target.
> > +This target emulated following devices.
> > +
> > +@itemize @minus
> > +@item
> > +R5F562N8 MCU
> > +@item
> > +On-chip memory (ROM 512KB, RAM 96KB)
> > +@item
> > +Interrupt Control Unit (ICUa)
> > +@item
> > +8Bit Timer x 1CH (TMR0,1)
> > +@item
> > +Compare Match Timer x 2CH (CMT0,1)
> > +@item
> > +Serial Communication Interface x 1CH (SCI0)
> > +@item
> > +External memory 16MByte
> > +@end itemize
> > +
> > +Example of @file{qemu-system-rx} usage for rx is shown below:
> > +
> > +Download @code{u-boot_image} from @url{https://osdn.net/users/ysato/pf/qemu/dl/u-boot.bin.gz}
> > +
> > +Start emulation of rx-virt:
> > +@example
> > +qemu-system-rx -bios @code{u-boot_image}
> > +@end example
> > +
> > +Download @code{kernel_image} from @url{https://osdn.net/users/ysato/pf/qemu/dl/zImage}
> > +
> > +Download @code{device_tree_blob} from @url{https://osdn.net/users/ysato/pf/qemu/dl/rx-virt.dtb}
> > +
> > +Start emulation of rx-virt:
> > +@example
> > +qemu-system-rx -kernel @code{kernel_image} -dtb @code{device_tree_blob} \
> > +  -append "earlycon"
> > +@end example
> > +
> >   @node QEMU User space emulator
> >   @chapter QEMU User space emulator
> >   
> 
> In commit 3a8273b1ab3 the this file has been removed (due to the
> conversion to the rST format).
> 
> Can you send a single patch (not the rest) with your documentation in
> rST format please?
> 

OK. I will snet later.

---
Yoshinori Sato
diff mbox series

Patch

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 33b9597b1d..d80a9c64f7 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -1719,6 +1719,7 @@  differences are mentioned in the following sections.
 * Microblaze System emulator::
 * SH4 System emulator::
 * Xtensa System emulator::
+* RX System emulator::
 @end menu
 
 @node PowerPC System emulator
@@ -2487,6 +2488,49 @@  so should only be used with trusted guest OS.
 
 @c man end
 
+@node RX System emulator
+@section RX System emulator
+@cindex system emulation (RX)
+
+Use the executable @file{qemu-system-rx} to simulate a Virtual RX target.
+This target emulated following devices.
+
+@itemize @minus
+@item
+R5F562N8 MCU
+@item
+On-chip memory (ROM 512KB, RAM 96KB)
+@item
+Interrupt Control Unit (ICUa)
+@item
+8Bit Timer x 1CH (TMR0,1)
+@item
+Compare Match Timer x 2CH (CMT0,1)
+@item
+Serial Communication Interface x 1CH (SCI0)
+@item
+External memory 16MByte
+@end itemize
+
+Example of @file{qemu-system-rx} usage for rx is shown below:
+
+Download @code{u-boot_image} from @url{https://osdn.net/users/ysato/pf/qemu/dl/u-boot.bin.gz}
+
+Start emulation of rx-virt:
+@example
+qemu-system-rx -bios @code{u-boot_image}
+@end example
+
+Download @code{kernel_image} from @url{https://osdn.net/users/ysato/pf/qemu/dl/zImage}
+
+Download @code{device_tree_blob} from @url{https://osdn.net/users/ysato/pf/qemu/dl/rx-virt.dtb}
+
+Start emulation of rx-virt:
+@example
+qemu-system-rx -kernel @code{kernel_image} -dtb @code{device_tree_blob} \
+  -append "earlycon"
+@end example
+
 @node QEMU User space emulator
 @chapter QEMU User space emulator