diff mbox series

[for-5.1,1/4] docs/system: Briefly document canon-a1100 board

Message ID 20200713175746.5936-2-peter.maydell@linaro.org
State Superseded
Headers show
Series Document virt and a few other Arm boards | expand

Commit Message

Peter Maydell July 13, 2020, 5:57 p.m. UTC
Add skeletal documentation of the canon-a1100 board.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

---
 docs/system/arm/digic.rst  | 11 +++++++++++
 docs/system/target-arm.rst |  1 +
 MAINTAINERS                |  1 +
 3 files changed, 13 insertions(+)
 create mode 100644 docs/system/arm/digic.rst

-- 
2.20.1

Comments

Philippe Mathieu-Daudé July 14, 2020, 12:51 p.m. UTC | #1
On 7/13/20 7:57 PM, Peter Maydell wrote:
> Add skeletal documentation of the canon-a1100 board.

> 

> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

> ---

>  docs/system/arm/digic.rst  | 11 +++++++++++

>  docs/system/target-arm.rst |  1 +

>  MAINTAINERS                |  1 +

>  3 files changed, 13 insertions(+)

>  create mode 100644 docs/system/arm/digic.rst

> 

> diff --git a/docs/system/arm/digic.rst b/docs/system/arm/digic.rst

> new file mode 100644

> index 00000000000..2b3520ff5e1

> --- /dev/null

> +++ b/docs/system/arm/digic.rst

> @@ -0,0 +1,11 @@

> +Canon A1100 (``canon-a1100``)

> +=============================

> +

> +This machine is a model of the Canon PowerShot A1100 camera, which

> +uses the DIGIC SoC. This model is based on reverse engineering efforts

> +by the contributors to the `CHDK <http://chdk.wikia.com/>`_ and

> +`Magic Lantern <http://www.magiclantern.fm/>`_ projects.

> +

> +The emulation is incomplete. In particular it can't be used

> +to run the original camera firmware, but it can successfully run

> +an experimental version of the `barebox bootloader <http://www.barebox.org/>`_.

> diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst

> index 1bd477a2936..8fa51a22817 100644

> --- a/docs/system/target-arm.rst

> +++ b/docs/system/target-arm.rst

> @@ -82,6 +82,7 @@ undocumented; you can get a complete list by running

>     arm/versatile

>     arm/vexpress

>     arm/aspeed

> +   arm/digic

>     arm/musicpal

>     arm/nseries

>     arm/orangepi

> diff --git a/MAINTAINERS b/MAINTAINERS

> index fe8139f3675..0f578040b99 100644

> --- a/MAINTAINERS

> +++ b/MAINTAINERS

> @@ -634,6 +634,7 @@ F: include/hw/arm/digic.h

>  F: hw/*/digic*

>  F: include/hw/*/digic*

>  F: tests/acceptance/machine_arm_canona1100.py

> +F: docs/system/arm/digic.rst

>  

>  Goldfish RTC

>  M: Anup Patel <anup.patel@wdc.com>

> 


Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Alex Bennée July 14, 2020, 1:14 p.m. UTC | #2
Peter Maydell <peter.maydell@linaro.org> writes:

> Add skeletal documentation of the canon-a1100 board.

>

> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>


Reviewed-by: Alex Bennée <alex.bennee@linaro.org>


-- 
Alex Bennée
diff mbox series

Patch

diff --git a/docs/system/arm/digic.rst b/docs/system/arm/digic.rst
new file mode 100644
index 00000000000..2b3520ff5e1
--- /dev/null
+++ b/docs/system/arm/digic.rst
@@ -0,0 +1,11 @@ 
+Canon A1100 (``canon-a1100``)
+=============================
+
+This machine is a model of the Canon PowerShot A1100 camera, which
+uses the DIGIC SoC. This model is based on reverse engineering efforts
+by the contributors to the `CHDK <http://chdk.wikia.com/>`_ and
+`Magic Lantern <http://www.magiclantern.fm/>`_ projects.
+
+The emulation is incomplete. In particular it can't be used
+to run the original camera firmware, but it can successfully run
+an experimental version of the `barebox bootloader <http://www.barebox.org/>`_.
diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst
index 1bd477a2936..8fa51a22817 100644
--- a/docs/system/target-arm.rst
+++ b/docs/system/target-arm.rst
@@ -82,6 +82,7 @@  undocumented; you can get a complete list by running
    arm/versatile
    arm/vexpress
    arm/aspeed
+   arm/digic
    arm/musicpal
    arm/nseries
    arm/orangepi
diff --git a/MAINTAINERS b/MAINTAINERS
index fe8139f3675..0f578040b99 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -634,6 +634,7 @@  F: include/hw/arm/digic.h
 F: hw/*/digic*
 F: include/hw/*/digic*
 F: tests/acceptance/machine_arm_canona1100.py
+F: docs/system/arm/digic.rst
 
 Goldfish RTC
 M: Anup Patel <anup.patel@wdc.com>