Skip to content

Commit d02bc50

Browse files
tswaehnkartben
tswaehn
and
kartben
committed
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 <s.ginka@sensry.de> Co-authored-by: Benjamin Cabé <kartben@gmail.com>
1 parent 6384f28 commit d02bc50

File tree

1 file changed

+73
-101
lines changed

1 file changed

+73
-101
lines changed

‎boards/sensry/ganymed_bob/doc/index.rst

Lines changed: 73 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
.. _ganymed_bob:
1+
.. zephyr:board:: ganymed_bob
22
3-
Ganymed Break-Out-Board (BOB)
4-
#############################
3+
.. _ganymed_bob:
54

65
Overview
76
********
@@ -14,9 +13,10 @@ Overview
1413
The Ganymed board hardware provides support for the Ganymed sy1xx series IoT multicore
1514
RISC-V SoC with optional sensor level.
1615

17-
The SoC has the following core features:
16+
Hardware
17+
********
1818

19-
* 32-Bit RSIC-V 1+8-core processor, up to 500MHz
19+
* 32-Bit RISC-V 1+8-core processor, up to 500MHz
2020

2121
* 1x Data Acquisition Unit
2222
* 8x Data Processing Unit
@@ -28,117 +28,89 @@ The SoC has the following core features:
2828
* 512 KB Global MRAM
2929
* 512 KB Secure MRAM
3030
* CLOCK
31-
* RAM
32-
* :abbr:`32x GPIO (General Purpose Input Output)`
33-
* :abbr:`4x TWIM (I2C-compatible two-wire interface with MicroDMA)`
34-
* 4x I2S
35-
* :abbr:`7x SPI (Serial Peripheral Interface with MicroDMA)`
36-
* :abbr:`3x UART (Universal receiver-transmitter with MicroDMA)`
37-
* :abbr:`1x TSN (Time sensitive networking ethernet MAC with MicroDMA)`
38-
* 1x CAN-FD
39-
* 3x ADC
31+
* Peripherals
32+
33+
* :abbr:`32x GPIO (General Purpose Input Output)`
34+
* :abbr:`4x TWIM (I2C-compatible two-wire interface with MicroDMA)`
35+
* 4x I2S
36+
* :abbr:`7x SPI (Serial Peripheral Interface with MicroDMA)`
37+
* :abbr:`3x UART (Universal receiver-transmitter with MicroDMA)`
38+
* :abbr:`1x TSN (Time sensitive networking ethernet MAC with MicroDMA)`
39+
* 1x CAN-FD
40+
* 3x ADC
41+
* Power section for on-board power generation and power measurement (selectable)
42+
43+
* USB type-C
44+
* external 5V power source
45+
* 40-pin JTAG connector (compatible to Olimex ARM-JTAG-OCD-H)
46+
* USB over FTDI (connected to UART0)
47+
* Header for all I/Os and configuration
4048

41-
.. figure:: img/ganymed_bob_sy120_gbm.webp
42-
:align: center
43-
:alt: Ganymed Break-Out-Board (BOB) equipped with SY120 GBM
49+
* Assembly options for the SoC
4450

45-
Ganymed Break-Out-Board (BOB) equipped with SY120 GBM (Credit: Sensry)
51+
* SY120-GBM - Generic Base Module without top level sensors
52+
* SY120-GEN1 - Generic Module type 1 with top level sensors (see below)
4653

47-
.. figure:: img/ganymed_bob_sy120_gen1.webp
48-
:align: center
49-
:alt: Ganymed Break-Out-Board (BOB) equipped with SY120 GEN1
54+
The ``ganymed-bob/sy120-gen1`` comes with additional on-board sensors.
5055

51-
Ganymed Break-Out-Board (BOB) equipped with SY120 GEN1 (Credit: Sensry)
56+
Supported Features
57+
==================
5258

53-
Hardware
54-
********
59+
.. zephyr:board-supported-hw::
5560
56-
The Ganymed BOB has:
61+
For more detailed description please refer to `Ganymed BreakOut Board Documentation`_
5762

58-
* Assembly options for the SoC include
5963

60-
* SY120-GBM - Generic Base Module without top level sensors
61-
* SY120-GEN1 - Generic Module type 1 with top level sensors (Bosch BME680 - SPI1 , Bosch BMA456 - SPI0, Bosch BMG250 - SPI2, STMicro MIS2DH - I2C0)
64+
Programming and Testing
65+
***********************
6266

63-
* power section for on-board power generation and power measurement (selectable)
64-
* 40-pin JTAG connector (compatible to Olimex ARM-JTAG-OCD-H)
65-
* USB over FTDI (connected to UART0)
66-
* Header for I/Os and additional configuration
67+
Building
68+
========
6769

68-
Supported Features
69-
==================
70-
71-
The ``ganymed-bob/sy120-gbm`` board supports the following hardware features:
72-
73-
+-----------+------------+----------------------+
74-
| Interface | Controller | Driver/Component |
75-
+===========+============+======================+
76-
| SAADC | on-chip | adc |
77-
+-----------+------------+----------------------+
78-
| CLOCK | on-chip | clock_control |
79-
+-----------+------------+----------------------+
80-
| MRAM | on-chip | flash |
81-
+-----------+------------+----------------------+
82-
| GPIO | on-chip | gpio |
83-
+-----------+------------+----------------------+
84-
| TWIM | on-chip | i2c |
85-
+-----------+------------+----------------------+
86-
| PWM | on-chip | pwm |
87-
+-----------+------------+----------------------+
88-
| GRTC | on-chip | counter |
89-
+-----------+------------+----------------------+
90-
| RTT | Segger | console |
91-
+-----------+------------+----------------------+
92-
| SPI(M/S) | on-chip | spi |
93-
+-----------+------------+----------------------+
94-
| SPU | on-chip | system protection |
95-
+-----------+------------+----------------------+
96-
| UART | on-chip | serial |
97-
+-----------+------------+----------------------+
98-
| TSN | on-chip | ethernet MAC |
99-
+-----------+------------+----------------------+
100-
| CAN | on-chip | CAN |
101-
+-----------+------------+----------------------+
102-
103-
Other hardware features have not been enabled yet for this board.
104-
105-
The ``ganymed-bob/sy120-gen1`` board includes all hardware features of the ``ganymed-bob/sy120-gbm`` board and comes additionally
106-
with these features:
107-
108-
+-----------+------------+----------------------+
109-
| Interface | Controller | Driver/Component |
110-
+===========+============+======================+
111-
| BME680 | on-chip | environment sensor |
112-
+-----------+------------+----------------------+
113-
| BMA456 | on-chip | acceleration sensor |
114-
+-----------+------------+----------------------+
115-
| BMG250 | on-chip | gyrosope sensor |
116-
+-----------+------------+----------------------+
117-
| MIS2DH | on-chip | vibration sensor |
118-
+-----------+------------+----------------------+
119-
120-
Other hardware features have not been enabled yet for this board.
121-
122-
Power
123-
*****
124-
125-
* USB type-C
126-
* external 5V power source
127-
128-
Programming and Debugging
129-
*************************
130-
131-
Applications for the ``ganymed-bob/sy120-gbm`` board can be
132-
built, flashed, and debugged in the usual way. See
70+
Applications for the ``ganymed_bob/sy120_gbm`` board can be
71+
built and flashed in the usual way. See
13372
:ref:`build_an_application` and :ref:`application_run` for more details on
13473
building and running.
13574

136-
Testing the Ganymed BreakOut Board
137-
**********************************
75+
Building the :zephyr:code-sample:`hello_world` sample:
76+
77+
.. zephyr-app-commands::
78+
:tool: west
79+
:zephyr-app: samples/hello_world
80+
:board: ganymed_bob/sy120_gbm
81+
:goals: build
82+
:compact:
83+
84+
85+
Flashing
86+
========
87+
88+
Test the Ganymed with a :zephyr:code-sample:`hello_world` sample.
89+
90+
Flash the zephyr image:
13891

139-
Test the Ganymed with a :zephyr:code-sample:`blinky` sample.
92+
.. zephyr-app-commands::
93+
:tool: west
94+
:zephyr-app: samples/hello_world
95+
:goals: flash
96+
:west-args: --serial /dev/ttyUSB0
97+
:compact:
98+
99+
100+
Testing
101+
=======
102+
103+
Then attach a serial console, ex. minicom / picocom / putty; Reset the target.
140104
The sample output should be:
141105

142106
.. code-block:: console
143107
144-
Hello World! ganymed-bob/sy120-gbm
108+
Hello World! ganymed_bob/sy120_gbm
109+
110+
111+
References
112+
**********
113+
114+
.. target-notes::
115+
116+
.. _`Ganymed BreakOut Board Documentation`: https://docs.sensry.net/datasheets/sy120-bob/

0 commit comments

Comments
 (0)