Re: [PATCH 7/8] tiva c board documentation

[Peter Maydell <peter.maydell@linaro.org>]

On Wed, 17 May 2023 at 09:13, Mohamed ElSayed <m.elsayed4420@gmail.com> wrote:
>
> Signed-off-by: Mohamed ElSayed <m.elsayed4420@gmail.com>
> ---
>  docs/system/arm/tivac.rst | 47 +++++++++++++++++++++++++++++++++++++++
>  1 file changed, 47 insertions(+)
>  create mode 100644 docs/system/arm/tivac.rst

This is missing the line to add this new file to the
docs:

--- a/docs/system/target-arm.rst
+++ b/docs/system/target-arm.rst
@@ -105,6 +105,7 @@ undocumented; you can get a complete list by running
    arm/sx1
    arm/stellaris
    arm/stm32
+   arm/tivac
    arm/virt
    arm/xlnx-versal-virt

Without this Sphinx will complain, which should cause a build
failure. Check that you're really building the docs
(passing --enable-docs to configure will make it fail if
you don't have the necessary tools installed to build docs).

> diff --git a/docs/system/arm/tivac.rst b/docs/system/arm/tivac.rst
> new file mode 100644
> index 0000000000..8e78726c01
> --- /dev/null
> +++ b/docs/system/arm/tivac.rst
> @@ -0,0 +1,47 @@
> +Texas Instruments EK-TM4C123GXL Evaluation Board, ``Tiva C``
> +========================================================================================

Underlines below titles should be the same length as the title-text,
not over-length.

> +
> +The `Tiva C`_ board is an evaluation platform for ARM Cortex-M4-based microcontrollers.

See remarks on board naming from patch 1.

> +Its based on the `TM4C123GH6PM`_ microcontroller by Texas Instruments.

"It is"

> +
> +.. _Tiva C: https://www.ti.com/tool/EK-TM4C123GXL
> +.. _TM4C123GH6PM: https://www.ti.com/product/TM4C123GH6PM
> +
> +Supported modules
> +-----------------
> +
> + * ARM Cortex-M4
> + * General Purpose Input/Output (GPIO)
> + * General Purpose Timers (GPTM)
> + * Serial Ports (USART)
> + * System Control (SYSCTL)
> + * Watchdog Timers (WDT)
> +
> +Missing modules
> +---------------
> +
> + * Dynamic Memory Access (uDMA)
> + * Analog to Digital Converter (ADC)
> + * Synchronous Serial Interface (SSI)
> + * Inter-Integrated Circuit Interface (I2C)
> + * Controller Area Network (CAN)
> + * USB Controller
> + * Analog Comparators
> + * Pulse Width Modulator (PWM)
> + * Quadrature Encoder Interface (QEI)
> +
> +Boot options
> +------------
> +
> +The Tiva C machines could be started using the ``-kernel`` option to load a binary file.

"can be started"

> +
> +.. code-block:: bash
> +
> +  $ qemu-system-arm -M tivac -kernel binary.elf -s -S

Are there any standard/well-known guest binaries that run on the board
that we could point to? (If not, that's fine.)

> +
> +The ``-s -S`` switches are for debugging, in another terminal window you can do:
> +
> +.. code-block:: bash
> +
> +   $ arm-none-eabi-gdb binary.elf
> +   (gdb) target remote :1234

The -s and -S stuff is standard, so you don't need to mention
it here.

thanks
-- PMM