Skip to content

Commit 9c97bdd

Browse files
sasatakufabiobaltieri
authored andcommitted
doc: scobc_a1: Rename board name
Rename the board name to `scobc-a1`, and update the board's full name to `SC-OBC Module A1`. And update the output of the `Hello World` sample to match the latest Zephyr version. Then, The supported feature section was replaced with a hw-directive block. Signed-off-by: Takuya Sasaki <[email protected]>
1 parent 479ea7a commit 9c97bdd

File tree

1 file changed

+9
-23
lines changed

1 file changed

+9
-23
lines changed

boards/sc/scobc_a1/doc/index.rst

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. zephyr:board:: scobc_module1
1+
.. zephyr:board:: scobc_a1
22
33
Overview
44
********
55

6-
`Space Cubics`_ OBC module 1 is a single board computer for spacecraft,
6+
`Space Cubics`_ OBC Module A1 (SC-OBC Module A1) is a single board computer for spacecraft,
77
especially for 3U CubeSats. The board is based on Xilinx Artix-7 FPGA and
88
implements ARM Cortex M3 as the main CPU.
99

@@ -21,21 +21,7 @@ Hardware
2121
Supported Features
2222
==================
2323

24-
The Space Cubics OBC module 1 provides the following hardware features:
25-
26-
+-----------+------------+------------------------------------+
27-
| Interface | Controller | Driver/Component |
28-
+===========+============+====================================+
29-
| NVIC | on-chip | nested vector interrupt controller |
30-
+-----------+------------+------------------------------------+
31-
| SYSTICK | on-chip | systick |
32-
+-----------+------------+------------------------------------+
33-
| UART | on-chip | serial port-polling; |
34-
| | | serial port-interrupt |
35-
+-----------+------------+------------------------------------+
36-
37-
The default configuration for the board can be found in the defconfig file:
38-
:file:`boards/arm/scobc_module1/scobc_module1_defconfig`.
24+
.. zephyr:board-supported-hw::
3925
4026
Other hardware features are not currently supported by the port.
4127

@@ -71,15 +57,15 @@ for the default design:
7157

7258
.. zephyr-app-commands::
7359
:zephyr-app: samples/hello_world
74-
:board: scobc_module1
60+
:board: scobc_a1
7561
:goals: flash
7662

7763
After flashing, you should see message similar to the following in the terminal:
7864

7965
.. code-block:: console
8066
81-
*** Booting Zephyr OS build zephyr-v2.7.99 ***
82-
Hello World! scobc_module1
67+
*** Booting Zephyr OS build v4.1.0-4619-gd571a59b0a43 ***
68+
Hello World! scobc_a1/designstart_fpga_cortex_m3
8369
8470
Note, however, that the application was not persisted in flash memory by the
8571
above steps. It was merely written to internal RAM in the FPGA.
@@ -91,16 +77,16 @@ Here is an example for the :zephyr:code-sample:`hello_world` application.
9177

9278
.. zephyr-app-commands::
9379
:zephyr-app: samples/hello_world
94-
:board: scobc_module1
80+
:board: scobc_a1
9581
:goals: debug
9682

9783
Step through the application in your debugger, and you should see a message
9884
similar to the following in the terminal:
9985

10086
.. code-block:: console
10187
102-
*** Booting Zephyr OS build zephyr-v2.7.99 ***
103-
Hello World! scobc_module1
88+
*** Booting Zephyr OS build v4.1.0-4619-gd571a59b0a43 ***
89+
Hello World! scobc_a1/designstart_fpga_cortex_m3
10490
10591
References
10692
**********

0 commit comments

Comments
 (0)