Niek Linnenbank <address@hidden> writes:
> The Xunlong Orange Pi PC machine is a functional ARM machine
> based on the Allwinner H3 System-on-Chip. It supports mainline
> Linux, U-Boot, NetBSD and is covered by acceptance tests.
>
> This commit adds a documentation text file with a description
> of the machine and instructions for the user.
This is great, thanks for taking the time to include documentation.
Sure, I'm happy to contribute it. I tried to include most relevant information
in there for developers and potential users of the machine. If something is missing
just let me know and I'll make an update for it.
>
> Signed-off-by: Niek Linnenbank <address@hidden>
> ---
> docs/orangepi.rst | 226
> ++++++++++++++++++++++++++++++++++++++++++++++
I suspect there is a better place to put this is than the top level. I
wonder if it should be docs/specs?
Yeah I'm fine to move it to a different subdirectory if needed. Right now its placed in docs,
as it seems that documents for machines are also placed there, for example docs/microvm.rst
> MAINTAINERS | 1 +
> 2 files changed, 227 insertions(+)
> create mode 100644 docs/orangepi.rst
>
> diff --git a/docs/orangepi.rst b/docs/orangepi.rst
> new file mode 100644
> index 0000000000..a9b46f553c
> --- /dev/null
> +++ b/docs/orangepi.rst
> @@ -0,0 +1,226 @@
> +=========================
> +Orange Pi PC Machine Type
> +=========================
> +
> +The Xunlong Orange Pi PC is an Allwinner H3 System on Chip
> +based embedded computer with mainline support in both U-Boot
> +and Linux. The board comes with a Quad Core Cortex A7 @ 1.3GHz,
> +1GiB RAM, 100Mbit ethernet, USB, SD/MMC, USB, HDMI and
> +various other I/O.
When Peter's document PR goes in later this week there will also be a:
docs/system/target-arm.rst
which would benefit from a section for the Orange Pi in it.
Nice, I'll have a look at it when it gets merged and add a section for Orange Pi.
I'll try to include that in the next version of this series.
> +
> +Supported devices
> +-----------------
> +
> +The Orange Pi PC machine supports the following devices:
> +
> + * SMP (Quad Core Cortex A7)
> + * Generic Interrupt Controller configuration
> + * SRAM mappings
> + * SDRAM controller
> + * Real Time Clock
> + * Timer device (re-used from Allwinner A10)
> + * UART
> + * SD/MMC storage controller
> + * EMAC ethernet
Do we ever exercise the ethernet in the acceptance tests? I see we have
some that boots a full OS but boot console only seems to touch the
serial console.
Good point. Currently in the acceptance tests U-Boot and Linux detect
the ethernet device, but there are no explicit checks for that in the acceptance tests
nor any actual packet transmission.
I'll try to extend the current tests in the next version of this series to include some
basic checks for the ethernet device, perhaps with DHCP or a ping.
I'm open to suggestions for the preferred way to do this.