chore: edit Docs restructure name and complement documentation pyocd

Cesarbautista10 · Cesarbautista10 · commit 36d08b9400a3 · 2025-07-11T10:20:31.000-06:00
diff --git a/software/sphinx/src/source/1_2_0_about.rst b/software/sphinx/src/source/1_2_0_about.rst
@@ -1,7 +1,7 @@
 General Information
 ===================
 
-The **CH552  Multi-Protocol Programmer** is a compact and versatile development tool designed for high-precision embedded system applications. It supports a broad range of protocols and device architectures, including **AVR**, **ARM (CMSIS-DAP)**, and **CPLD (MAX II)**. Its USB connectivity enables direct interfacing with standard development environments, enabling:
+The **Multi-Protocol Programmer** is a compact and versatile development tool designed for high-precision embedded system applications. It supports a broad range of protocols and device architectures, including **AVR**, **ARM (CMSIS-DAP)**, and **CPLD (MAX II)**. Its USB connectivity enables direct interfacing with standard development environments, enabling:
 
 - In-system programming (ISP)
 - Step-through debugging
diff --git a/software/sphinx/src/source/2_1_0_avr_firmware.rst b/software/sphinx/src/source/2_1_0_avr_firmware.rst
@@ -29,7 +29,7 @@ Firmware Update Procedure
     Ensure that **Docker Desktop** is running before executing the build commands, as they rely on Docker containers for compilation.
 
 
-To commence the utilization of the **CH552 USB Multi-Protocol Programmer** in PICO ASP mode, execute the following procedures:
+To commence the utilization of the **Multi-Protocol Programmer** in PICO ASP mode, execute the following procedures:
 
 1. Navigate to the SDK Root Directory
 
diff --git a/software/sphinx/src/source/2_2_0_started.rst b/software/sphinx/src/source/2_2_0_started.rst
@@ -133,7 +133,7 @@ Upload Command
 Explanation:
 
 * ``-p m328p`` specifies the target device (ATmega328P).
-* ``-c usbasp`` sets the programmer to the CH552 USB Multi-Protocol Programmer.
+* ``-c usbasp`` sets the programmer to the Multi-Protocol Programmer.
 * ``-U flash:w:blink.hex`` uploads the hex file to flash memory.
 
 Replace ``m328p`` with the appropriate identifier for your specific AVR device (e.g., ``t88`` for ATtiny88). A full list of supported devices is available in the `AVRDUDE user manual <http://www.nongnu.org/avrdude/user-manual/avrdude.html#Device-Options>`_.
diff --git a/software/sphinx/src/source/2_3_0_ide.rst b/software/sphinx/src/source/2_3_0_ide.rst
@@ -9,13 +9,13 @@ This guide explains how to flash the Arduino-compatible bootloader onto an **ATM
 Required Materials
 ------------------
 
-1. **UNIT Multi-Protocol Programmer**
+1. **Multi-Protocol Programmer**
 
 .. raw:: html
 
     <div style="text-align: center;">
       <img src="./_static/programmer.png" alt="Multi-Protocol Programmer" style="width: 50%;">
-      <p>UNIT Multi-Protocol Programmer</p>
+      <p>Multi-Protocol Programmer</p>
     </div>
 
 2. **ATMEGA328P Microcontroller**
diff --git a/software/sphinx/src/source/3_1_0_openocd.rst b/software/sphinx/src/source/3_1_0_openocd.rst
@@ -51,6 +51,168 @@ Each microcontroller requires a specific configuration file. This file is a scri
 PyOCD
 =====
 
+PyOCD is a command-line tool for interacting with ARM Cortex-M microcontrollers. It supports flashing, erasing, debugging, and low-level memory access using CMSIS-DAP, DAPLink, ST-Link, and other probes.
+
+Basic Syntax
+------------
+
+.. code-block:: bash
+
+    pyocd <command> [OPTIONS]
+
+You can specify the target using ``-t <target>`` or through a configuration file using ``--config <file.yaml>``.
+
+Configuration File
+------------------
+
+Use a YAML configuration file to define global options:
+
+.. code-block:: yaml
+
+    # Misc/pyocd.yaml
+    target_override: py32f003x6
+    frequency: 1000000
+    log_level: info
+
+To load this config:
+
+.. code-block:: bash
+
+    pyocd erase --config ./Misc/pyocd.yaml
+
+Commands
+--------
+
+erase
+^^^^^
+
+Erase flash memory of the target device.
+
+.. code-block:: bash
+
+    pyocd erase -t py32f003x6 [OPTIONS]
+
+Options:
+
+- ``--chip``: Erase the entire flash memory.
+- ``--sector <ADDR>``: Erase a single sector by address.
+- ``--config <file.yaml>``: Load configuration from YAML file.
+
+Example:
+
 .. code-block:: bash
 
     pyocd erase -t py32f003x6 --chip --config ./Misc/pyocd.yaml
+
+flash
+^^^^^
+
+Flash a binary, hex, or ELF file to the target.
+
+.. code-block:: bash
+
+    pyocd flash <file> -t py32f003x6 [OPTIONS]
+
+Options:
+
+- ``--base-address <addr>``: Override the base address (for .bin files).
+- ``--verify``: Verify flash contents after writing.
+- ``--erase=chip|sector|auto``: Select erase mode.
+- ``--format bin|hex|elf``: Force file format.
+- ``--config <file.yaml>``: Load YAML config.
+
+Example:
+
+.. code-block:: bash
+
+    pyocd flash firmware.hex -t py32f003x6 --erase=chip --verify
+
+gdbserver
+^^^^^^^^^
+
+Start a GDB server for remote debugging.
+
+.. code-block:: bash
+
+    pyocd gdbserver -t py32f003x6 [OPTIONS]
+
+Options:
+
+- ``--port <number>``: GDB server port.
+- ``--telnet-port <number>``: Telnet monitor port.
+- ``--persist``: Keep the server alive after GDB disconnects.
+- ``--config <file.yaml>``: Load YAML config.
+
+reset
+^^^^^
+
+Reset the target microcontroller.
+
+.. code-block:: bash
+
+    pyocd reset -t py32f003x6 [OPTIONS]
+
+Options:
+
+- ``--halt``: Halt the CPU after reset.
+- ``--config <file.yaml>``: Load YAML config.
+
+list
+^^^^
+
+List connected debug probes and supported targets.
+
+.. code-block:: bash
+
+    pyocd list
+
+read / write
+^^^^^^^^^^^^
+
+Read and write memory directly.
+
+.. code-block:: bash
+
+    pyocd read32 0x08000000 4
+    pyocd write32 0x20000000 0x12345678
+
+CMSIS-Pack Targets
+------------------
+
+To add custom target support (e.g., ``py32f003x6``), use:
+
+.. code-block:: bash
+
+    pyocd pack install py32f003x6
+
+Or add a local `.pdsc` file:
+
+.. code-block:: bash
+
+    pyocd pack add ./path/to/PY32F003.pdsc
+
+Example Workflow
+----------------
+
+.. code-block:: bash
+
+    pyocd list
+    pyocd erase -t py32f003x6 --chip
+    pyocd flash build/main.hex -t py32f003x6 --verify
+    pyocd gdbserver -t py32f003x6
+    pyocd reset -t py32f003x6 --halt
+
+References
+----------
+
+- `https://pyocd.io/ <https://pyocd.io/>`_
+- `https://github.com/pyocd/pyocd <https://github.com/pyocd/pyocd>`_
+
+Command Help
+------------
+
+.. code-block:: bash
+
+    pyocd --help
+    pyocd flash --help
+    pyocd erase --help
diff --git a/software/sphinx/src/source/4_0_0_rp2040.rst b/software/sphinx/src/source/4_0_0_rp2040.rst
@@ -13,10 +13,10 @@ The RP2040 is an efficient and cost-effective microcontroller developed by Raspb
 
 This guide provides a comprehensive introduction to working with RP2040 microcontrollers. It covers setting up the development environment, installing the required software, and writing code for RP2040-based projects.
 
-CH552 Multi-Protocol Programmer for RP2040
+Multi-Protocol Programmer for RP2040
 -----------------------------------------
 
-The CH552 Multi-Protocol Programmer is a versatile tool for programming and debugging RP2040 microcontrollers. It enables straightforward and reliable programming using the SWD (Serial Wire Debug) interface.
+The Multi-Protocol Programmer is a versatile tool for programming and debugging RP2040 microcontrollers. It enables straightforward and reliable programming using the SWD (Serial Wire Debug) interface.
 
 .. raw:: html
 
@@ -26,10 +26,10 @@ The CH552 Multi-Protocol Programmer is a versatile tool for programming and debu
    </div>
 
 
-Programming RP2040 with the CH552 Multi-Protocol Programmer
+Programming RP2040 with the Multi-Protocol Programmer
 -----------------------------------------------------------
 
-The CH552 Multi-Protocol Programmer supports programming of RP2040 microcontrollers via the SWD interface. This interface allows direct access to the target microcontroller's flash memory and supports debugging functionality. The programmer is compatible with RP2040f10x and RP2040f4xx series.
+The Multi-Protocol Programmer supports programming of RP2040 microcontrollers via the SWD interface. This interface allows direct access to the target microcontroller's flash memory and supports debugging functionality. The programmer is compatible with RP2040f10x and RP2040f4xx series.
 
 .. only:: html
 
@@ -48,12 +48,12 @@ The CH552 Multi-Protocol Programmer supports programming of RP2040 microcontroll
       Pinout diagram for RP2040
 
 
-DualMCU RP2040 Programming with CH552 Multi-Protocol Programmer
+DualMCU RP2040 Programming with Multi-Protocol Programmer
 ----------------------------------------------------------------
 
 The Multi-Protocol Programmer uses the SWD interface to program RP2040 microcontrollers. Follow these steps to program your RP2040 device:
 
-1. **Connect the CH552 Multi-Protocol Programmer** to your computer via USB.
+1. **Connect the Multi-Protocol Programmer** to your computer via USB.
 2. **Open Visual Studio Code** or another editor of your preference.
 3. **Install the required extensions** for RP2040 development, such as "C/C++" and "CMake Tools".
 4. **Create a new project** or open an existing one.
diff --git a/software/sphinx/src/source/4_1_0_rp_firmware.rst b/software/sphinx/src/source/4_1_0_rp_firmware.rst
@@ -9,7 +9,7 @@ Firmware update
     Always remember to keep Docker Desktop open in your computer; otherwise, the commands will not work properly.
 
 
-To start using your **CH552 USB Multi-Protocol Programmer** as a PICO DAP, follow these steps:
+To start using your **Multi-Protocol Programmer** as a PICO DAP, follow these steps:
 
 .. code-block:: bash
 
diff --git a/software/sphinx/src/source/5_1_0_stm32_firmware.rst b/software/sphinx/src/source/5_1_0_stm32_firmware.rst
@@ -9,7 +9,7 @@ Firmware update
     Always remember to keep Docker Desktop open in your computer; otherwise, the commands will not work properly.
 
 
-To start using your **CH552 USB Multi-Protocol Programmer** as a PICO DAP, follow these steps:
+To start using your **Multi-Protocol Programmer** as a PICO DAP, follow these steps:
 
 .. code-block:: bash
 
diff --git a/software/sphinx/src/source/7_1_0_cpld_firmware.rst b/software/sphinx/src/source/7_1_0_cpld_firmware.rst
@@ -17,7 +17,7 @@ Firmware update
     Always remember to keep Docker Desktop open in your computer; otherwise, the commands will not work properly.
 
 
-To start using your **CH552 USB Multi-Protocol Programmer** as a CPLD/FPGA programmer, follow these steps:
+To start using your **Multi-Protocol Programmer** as a CPLD/FPGA programmer, follow these steps:
 
 .. code-block:: bash
 
diff --git a/software/sphinx/src/source/index.rst b/software/sphinx/src/source/index.rst
@@ -12,7 +12,7 @@ Multi-Protocol Programmer
 
 **Multi-Protocol Programmer**
 
-The ** USB Multi-Protocol Programmer** is a compact and cost-effective device designed for embedded systems development, testing, and debugging. It supports multiple hardware architectures including **AVR**, **ARM Cortex-M (CMSIS-DAP)**, and **CPLD (MAX II)**, making it ideal for a wide range of applications such as firmware development, educational labs, and low-volume production environments.
+The **USB Multi-Protocol Programmer** is a compact and cost-effective device designed for embedded systems development, testing, and debugging. It supports multiple hardware architectures including **AVR**, **ARM Cortex-M (CMSIS-DAP)**, and **CPLD (MAX II)**, making it ideal for a wide range of applications such as firmware development, educational labs, and low-volume production environments.
 
 This programmer is built around the **CH552 microcontroller**, which is based on the enhanced **8051 architecture**. It offers native USB support and a range of digital interfaces (GPIO, SPI, I2C, UART), enabling seamless communication between the host system and the target hardware.
 
