From 9c97bdd37313288fb83e47551a9bee8ef746430f Mon Sep 17 00:00:00 2001 From: Takuya Sasaki Date: Sat, 24 May 2025 11:21:41 +0900 Subject: [PATCH] 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 --- boards/sc/scobc_a1/doc/index.rst | 32 +++++++++----------------------- 1 file changed, 9 insertions(+), 23 deletions(-) diff --git a/boards/sc/scobc_a1/doc/index.rst b/boards/sc/scobc_a1/doc/index.rst index 264e27801ea..310e524de3f 100644 --- a/boards/sc/scobc_a1/doc/index.rst +++ b/boards/sc/scobc_a1/doc/index.rst @@ -1,9 +1,9 @@ -.. zephyr:board:: scobc_module1 +.. zephyr:board:: scobc_a1 Overview ******** -`Space Cubics`_ OBC module 1 is a single board computer for spacecraft, +`Space Cubics`_ OBC Module A1 (SC-OBC Module A1) is a single board computer for spacecraft, especially for 3U CubeSats. The board is based on Xilinx Artix-7 FPGA and implements ARM Cortex M3 as the main CPU. @@ -21,21 +21,7 @@ Hardware Supported Features ================== -The Space Cubics OBC module 1 provides the following hardware features: - -+-----------+------------+------------------------------------+ -| Interface | Controller | Driver/Component | -+===========+============+====================================+ -| NVIC | on-chip | nested vector interrupt controller | -+-----------+------------+------------------------------------+ -| SYSTICK | on-chip | systick | -+-----------+------------+------------------------------------+ -| UART | on-chip | serial port-polling; | -| | | serial port-interrupt | -+-----------+------------+------------------------------------+ - -The default configuration for the board can be found in the defconfig file: -:file:`boards/arm/scobc_module1/scobc_module1_defconfig`. +.. zephyr:board-supported-hw:: Other hardware features are not currently supported by the port. @@ -71,15 +57,15 @@ for the default design: .. zephyr-app-commands:: :zephyr-app: samples/hello_world - :board: scobc_module1 + :board: scobc_a1 :goals: flash After flashing, you should see message similar to the following in the terminal: .. code-block:: console - *** Booting Zephyr OS build zephyr-v2.7.99 *** - Hello World! scobc_module1 + *** Booting Zephyr OS build v4.1.0-4619-gd571a59b0a43 *** + Hello World! scobc_a1/designstart_fpga_cortex_m3 Note, however, that the application was not persisted in flash memory by the above steps. It was merely written to internal RAM in the FPGA. @@ -91,7 +77,7 @@ Here is an example for the :zephyr:code-sample:`hello_world` application. .. zephyr-app-commands:: :zephyr-app: samples/hello_world - :board: scobc_module1 + :board: scobc_a1 :goals: debug Step through the application in your debugger, and you should see a message @@ -99,8 +85,8 @@ similar to the following in the terminal: .. code-block:: console - *** Booting Zephyr OS build zephyr-v2.7.99 *** - Hello World! scobc_module1 + *** Booting Zephyr OS build v4.1.0-4619-gd571a59b0a43 *** + Hello World! scobc_a1/designstart_fpga_cortex_m3 References **********