[v1] docs: Add RX target.

[PATCH] docs: Add RX target.

Posted by Yoshinori Sato 5 years, 8 months ago

Add rx-virt target specificaion document.

Signed-off-by: Yoshinori Sato <ysato@users.sourceforge.jp>
---
 docs/system/target-rx.rst | 35 +++++++++++++++++++++++++++++++++++
 docs/system/targets.rst   |  1 +
 2 files changed, 36 insertions(+)
 create mode 100644 docs/system/target-rx.rst

diff --git a/docs/system/target-rx.rst b/docs/system/target-rx.rst
new file mode 100644
index 0000000000..8540fd5218
--- /dev/null
+++ b/docs/system/target-rx.rst
@@ -0,0 +1,35 @@
+.. _RX-System-emulator:
+
+RX System emulator
+--------------------
+
+Use the executable ``qemu-system-rx`` to simulate a Virtual RX target.
+This target emulated following devices.
+
+-  R5F562N8 MCU
+
+   -  On-chip memory (ROM 512KB, RAM 96KB)
+   -  Interrupt Control Unit (ICUa)
+   -  8Bit Timer x 1CH (TMR0,1)
+   -  Compare Match Timer x 2CH (CMT0,1)
+   -  Serial Communication Interface x 1CH (SCI0)
+
+-  External memory 16MByte
+
+Example of ``qemu-system-rx`` usage for RX is shown below:
+
+Download ``<u-boot_image_file>`` from
+https://osdn.net/users/ysato/pf/qemu/dl/u-boot.bin.gz
+
+Start emulation of rx-virt::
+  qemu-system-rx -bios <u-boot_image_file>
+
+Download ``kernel_image_file`` from
+https://osdn.net/users/ysato/pf/qemu/dl/zImage
+
+Download ``device_tree_blob`` from
+https://osdn.net/users/ysato/pf/qemu/dl/rx-virt.dtb
+
+Start emulation of rx-virt::
+  qemu-system-rx -kernel <kernel_image_file> -dtb <device_tree_blob> \
+      -append "earlycon"
diff --git a/docs/system/targets.rst b/docs/system/targets.rst
index eba3111247..946f513daa 100644
--- a/docs/system/targets.rst
+++ b/docs/system/targets.rst
@@ -17,3 +17,4 @@ Contents:
    target-arm
    target-m68k
    target-xtensa
+   target-rx
-- 
2.20.1

Re: [PATCH] docs: Add RX target.

Posted by Eric Blake 5 years, 8 months ago

On 3/8/20 8:06 AM, Yoshinori Sato wrote:
> Add rx-virt target specificaion document.

specification

> 
> Signed-off-by: Yoshinori Sato <ysato@users.sourceforge.jp>
> ---
>   docs/system/target-rx.rst | 35 +++++++++++++++++++++++++++++++++++
>   docs/system/targets.rst   |  1 +
>   2 files changed, 36 insertions(+)
>   create mode 100644 docs/system/target-rx.rst
> 
> diff --git a/docs/system/target-rx.rst b/docs/system/target-rx.rst
> new file mode 100644
> index 0000000000..8540fd5218
> --- /dev/null
> +++ b/docs/system/target-rx.rst
> @@ -0,0 +1,35 @@
> +.. _RX-System-emulator:
> +
> +RX System emulator
> +--------------------
> +
> +Use the executable ``qemu-system-rx`` to simulate a Virtual RX target.
> +This target emulated following devices.

s/emulated/emulates the/


> +++ b/docs/system/targets.rst
> @@ -17,3 +17,4 @@ Contents:
>      target-arm
>      target-m68k
>      target-xtensa
> +   target-rx

Is it worth keeping this list alphabetically sorted?

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org

Re: [PATCH] docs: Add RX target.

Posted by Yoshinori Sato 5 years, 8 months ago

2020-03-10 00:07 に Eric Blake さんは書きました:
> On 3/8/20 8:06 AM, Yoshinori Sato wrote:
>> Add rx-virt target specificaion document.
> 
> specification
> 
>> 
>> Signed-off-by: Yoshinori Sato <ysato@users.sourceforge.jp>
>> ---
>>   docs/system/target-rx.rst | 35 +++++++++++++++++++++++++++++++++++
>>   docs/system/targets.rst   |  1 +
>>   2 files changed, 36 insertions(+)
>>   create mode 100644 docs/system/target-rx.rst
>> 
>> diff --git a/docs/system/target-rx.rst b/docs/system/target-rx.rst
>> new file mode 100644
>> index 0000000000..8540fd5218
>> --- /dev/null
>> +++ b/docs/system/target-rx.rst
>> @@ -0,0 +1,35 @@
>> +.. _RX-System-emulator:
>> +
>> +RX System emulator
>> +--------------------
>> +
>> +Use the executable ``qemu-system-rx`` to simulate a Virtual RX 
>> target.
>> +This target emulated following devices.
> 
> s/emulated/emulates the/
> 

OK. I'll fix it.

> 
>> +++ b/docs/system/targets.rst
>> @@ -17,3 +17,4 @@ Contents:
>>      target-arm
>>      target-m68k
>>      target-xtensa
>> +   target-rx
> 
> Is it worth keeping this list alphabetically sorted?

It was not in alphabetical order, it was added at the last. Is it better 
to arrange in alphabetical order?

---
Yoshinori Sato

Re: [PATCH] docs: Add RX target.

Posted by Eric Blake 5 years, 8 months ago

On 3/9/20 11:28 PM, Yoshinori Sato wrote:

>>> +++ b/docs/system/targets.rst
>>> @@ -17,3 +17,4 @@ Contents:
>>>      target-arm
>>>      target-m68k
>>>      target-xtensa
>>> +   target-rx
>>
>> Is it worth keeping this list alphabetically sorted?
> 
> It was not in alphabetical order, it was added at the last. Is it better 
> to arrange in alphabetical order?

The 3 lines of context was alphabetical, but looking at the whole file, 
the overall list is not. So sticking yours last is fine after all.

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org

Re: [PATCH] docs: Add RX target.

Posted by Peter Maydell 5 years, 8 months ago

On Tue, 10 Mar 2020 at 11:30, Eric Blake <eblake@redhat.com> wrote:
>
> On 3/9/20 11:28 PM, Yoshinori Sato wrote:
>
> >>> +++ b/docs/system/targets.rst
> >>> @@ -17,3 +17,4 @@ Contents:
> >>>      target-arm
> >>>      target-m68k
> >>>      target-xtensa
> >>> +   target-rx
> >>
> >> Is it worth keeping this list alphabetically sorted?
> >
> > It was not in alphabetical order, it was added at the last. Is it better
> > to arrange in alphabetical order?
>
> The 3 lines of context was alphabetical, but looking at the whole file,
> the overall list is not. So sticking yours last is fine after all.

In an ideal world the correct order would probably be
"alphabetical order of the headline titles in the referenced
files", so that the displayed ToC is alphabetized.

thanks
-- PMM

Re: [PATCH] docs: Add RX target.

Posted by Yoshinori Sato 5 years, 8 months ago

On Tue, 10 Mar 2020 20:54:16 +0900,
Peter Maydell wrote:
> 
> On Tue, 10 Mar 2020 at 11:30, Eric Blake <eblake@redhat.com> wrote:
> >
> > On 3/9/20 11:28 PM, Yoshinori Sato wrote:
> >
> > >>> +++ b/docs/system/targets.rst
> > >>> @@ -17,3 +17,4 @@ Contents:
> > >>>      target-arm
> > >>>      target-m68k
> > >>>      target-xtensa
> > >>> +   target-rx
> > >>
> > >> Is it worth keeping this list alphabetically sorted?
> > >
> > > It was not in alphabetical order, it was added at the last. Is it better
> > > to arrange in alphabetical order?
> >
> > The 3 lines of context was alphabetical, but looking at the whole file,
> > the overall list is not. So sticking yours last is fine after all.
> 
> In an ideal world the correct order would probably be
> "alphabetical order of the headline titles in the referenced
> files", so that the displayed ToC is alphabetized.

OK.
Change to alphabetical order.

> thanks
> -- PMM

-- 
Yosinori Sato