board: sensry: ganymed_bob_sy120 - doc update

In this commit we updated the document page for the sensry
ganymed_bob_sy120 boards.

Signed-off-by: Sven Ginka <[email protected]>
Co-authored-by: Benjamin Cabé <[email protected]>

Author: tswaehn

boards/sensry/ganymed_bob/doc/index.rst

@@ -1,7 +1,6 @@
-.. _ganymed_bob:
+.. zephyr:board:: ganymed_bob
 
-Ganymed Break-Out-Board (BOB)
-#############################
+.. _ganymed_bob:
 
 Overview
 ********
@@ -14,9 +13,10 @@ Overview
 The Ganymed board hardware provides support for the Ganymed sy1xx series IoT multicore
 RISC-V SoC with optional sensor level.
 
-The SoC has the following core features:
+Hardware
+********
 
-* 32-Bit RSIC-V 1+8-core processor, up to 500MHz
+* 32-Bit RISC-V 1+8-core processor, up to 500MHz
 
   * 1x Data Acquisition Unit
   * 8x Data Processing Unit
@@ -28,117 +28,89 @@ The SoC has the following core features:
 * 512 KB Global MRAM
 * 512 KB Secure MRAM
 * CLOCK
-* RAM
-* :abbr:`32x GPIO (General Purpose Input Output)`
-* :abbr:`4x TWIM (I2C-compatible two-wire interface with MicroDMA)`
-* 4x I2S
-* :abbr:`7x SPI (Serial Peripheral Interface with MicroDMA)`
-* :abbr:`3x UART (Universal receiver-transmitter with MicroDMA)`
-* :abbr:`1x TSN (Time sensitive networking ethernet MAC with MicroDMA)`
-* 1x CAN-FD
-* 3x ADC
+* Peripherals
+
+    * :abbr:`32x GPIO (General Purpose Input Output)`
+    * :abbr:`4x TWIM (I2C-compatible two-wire interface with MicroDMA)`
+    * 4x I2S
+    * :abbr:`7x SPI (Serial Peripheral Interface with MicroDMA)`
+    * :abbr:`3x UART (Universal receiver-transmitter with MicroDMA)`
+    * :abbr:`1x TSN (Time sensitive networking ethernet MAC with MicroDMA)`
+    * 1x CAN-FD
+    * 3x ADC
+* Power section for on-board power generation and power measurement (selectable)
+
+    * USB type-C
+    * external 5V power source
+* 40-pin JTAG connector (compatible to Olimex ARM-JTAG-OCD-H)
+* USB over FTDI (connected to UART0)
+* Header for all I/Os and configuration
 
-.. figure:: img/ganymed_bob_sy120_gbm.webp
-     :align: center
-     :alt: Ganymed Break-Out-Board (BOB) equipped with SY120 GBM
+* Assembly options for the SoC
 
-     Ganymed Break-Out-Board (BOB) equipped with SY120 GBM (Credit: Sensry)
+  * SY120-GBM - Generic Base Module without top level sensors
+  * SY120-GEN1 - Generic Module type 1 with top level sensors (see below)
 
-.. figure:: img/ganymed_bob_sy120_gen1.webp
-     :align: center
-     :alt: Ganymed Break-Out-Board (BOB) equipped with SY120 GEN1
+The ``ganymed-bob/sy120-gen1`` comes with additional on-board sensors.
 
-     Ganymed Break-Out-Board (BOB) equipped with SY120 GEN1 (Credit: Sensry)
+Supported Features
+==================
 
-Hardware
-********
+.. zephyr:board-supported-hw::
 
-The Ganymed BOB has:
+For more detailed description please refer to `Ganymed BreakOut Board Documentation`_
 
-* Assembly options for the SoC include
 
-  * SY120-GBM - Generic Base Module without top level sensors
-  * SY120-GEN1 - Generic Module type 1 with top level sensors (Bosch BME680 - SPI1 , Bosch BMA456 - SPI0, Bosch BMG250 - SPI2, STMicro MIS2DH - I2C0)
+Programming and Testing
+***********************
 
-* power section for on-board power generation and power measurement (selectable)
-* 40-pin JTAG connector (compatible to Olimex ARM-JTAG-OCD-H)
-* USB over FTDI (connected to UART0)
-* Header for I/Os and additional configuration
+Building
+========
 
-Supported Features
-==================
-
-The ``ganymed-bob/sy120-gbm`` board supports the following hardware features:
-
-+-----------+------------+----------------------+
-| Interface | Controller | Driver/Component     |
-+===========+============+======================+
-| SAADC     | on-chip    | adc                  |
-+-----------+------------+----------------------+
-| CLOCK     | on-chip    | clock_control        |
-+-----------+------------+----------------------+
-| MRAM      | on-chip    | flash                |
-+-----------+------------+----------------------+
-| GPIO      | on-chip    | gpio                 |
-+-----------+------------+----------------------+
-| TWIM      | on-chip    | i2c                  |
-+-----------+------------+----------------------+
-| PWM       | on-chip    | pwm                  |
-+-----------+------------+----------------------+
-| GRTC      | on-chip    | counter              |
-+-----------+------------+----------------------+
-| RTT       | Segger     | console              |
-+-----------+------------+----------------------+
-| SPI(M/S)  | on-chip    | spi                  |
-+-----------+------------+----------------------+
-| SPU       | on-chip    | system protection    |
-+-----------+------------+----------------------+
-| UART      | on-chip    | serial               |
-+-----------+------------+----------------------+
-| TSN       | on-chip    | ethernet MAC         |
-+-----------+------------+----------------------+
-| CAN       | on-chip    | CAN                  |
-+-----------+------------+----------------------+
-
-Other hardware features have not been enabled yet for this board.
-
-The ``ganymed-bob/sy120-gen1`` board includes all hardware features of the ``ganymed-bob/sy120-gbm`` board and comes additionally
-with these features:
-
-+-----------+------------+----------------------+
-| Interface | Controller | Driver/Component     |
-+===========+============+======================+
-| BME680    | on-chip    | environment sensor   |
-+-----------+------------+----------------------+
-| BMA456    | on-chip    | acceleration sensor  |
-+-----------+------------+----------------------+
-| BMG250    | on-chip    | gyrosope sensor      |
-+-----------+------------+----------------------+
-| MIS2DH    | on-chip    | vibration sensor     |
-+-----------+------------+----------------------+
-
-Other hardware features have not been enabled yet for this board.
-
-Power
-*****
-
-* USB type-C
-* external 5V power source
-
-Programming and Debugging
-*************************
-
-Applications for the ``ganymed-bob/sy120-gbm`` board can be
-built, flashed, and debugged in the usual way. See
+Applications for the ``ganymed_bob/sy120_gbm`` board can be
+built and flashed in the usual way. See
 :ref:`build_an_application` and :ref:`application_run` for more details on
 building and running.
 
-Testing the Ganymed BreakOut Board
-**********************************
+Building the :zephyr:code-sample:`hello_world` sample:
+
+.. zephyr-app-commands::
+   :tool: west
+   :zephyr-app: samples/hello_world
+   :board: ganymed_bob/sy120_gbm
+   :goals: build
+   :compact:
+
+
+Flashing
+========
+
+Test the Ganymed with a :zephyr:code-sample:`hello_world` sample.
+
+Flash the zephyr image:
 
-Test the Ganymed with a :zephyr:code-sample:`blinky` sample.
+.. zephyr-app-commands::
+   :tool: west
+   :zephyr-app: samples/hello_world
+   :goals: flash
+   :west-args: --serial /dev/ttyUSB0
+   :compact:
+
+
+Testing
+=======
+
+Then attach a serial console, ex. minicom / picocom / putty; Reset the target.
 The sample output should be:
 
 .. code-block:: console
 
-    Hello World! ganymed-bob/sy120-gbm
+    Hello World! ganymed_bob/sy120_gbm
+
+
+References
+**********
+
+.. target-notes::
+
+.. _`Ganymed BreakOut Board Documentation`: https://docs.sensry.net/datasheets/sy120-bob/