Deploy full documentation and product brief [skip ci]

Author: actions-user

docs/1_2_0_about.html

@@ -420,7 +420,7 @@ <h2> Contents </h2>
 
   <section id="general-information">
 <h1>General Information<a class="headerlink" href="#general-information" title="Link to this heading">#</a></h1>
-<p>The <strong>CH552  Multi-Protocol Programmer</strong> 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 <strong>AVR</strong>, <strong>ARM (CMSIS-DAP)</strong>, and <strong>CPLD (MAX II)</strong>. Its USB connectivity enables direct interfacing with standard development environments, enabling:</p>
+<p>The <strong>Multi-Protocol Programmer</strong> 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 <strong>AVR</strong>, <strong>ARM (CMSIS-DAP)</strong>, and <strong>CPLD (MAX II)</strong>. Its USB connectivity enables direct interfacing with standard development environments, enabling:</p>
 <ul class="simple">
 <li><p>In-system programming (ISP)</p></li>
 <li><p>Step-through debugging</p></li>

docs/2_1_0_avr_firmware.html

@@ -437,7 +437,7 @@ <h2>Firmware Update Procedure<a class="headerlink" href="#firmware-update-proced
 <p>The following procedure assumes that the <cite>unit_ch55x_docker_sdk</cite> repository is already cloned on your system.
 Ensure that <strong>Docker Desktop</strong> is running before executing the build commands, as they rely on Docker containers for compilation.</p>
 </div>
-<p>To commence the utilization of the <strong>CH552 USB Multi-Protocol Programmer</strong> in PICO ASP mode, execute the following procedures:</p>
+<p>To commence the utilization of the <strong>Multi-Protocol Programmer</strong> in PICO ASP mode, execute the following procedures:</p>
 <ol class="arabic simple">
 <li><p>Navigate to the SDK Root Directory</p></li>
 </ol>

docs/2_2_0_started.html

@@ -529,7 +529,7 @@ <h3>Upload Command<a class="headerlink" href="#upload-command" title="Link to th
 <p>Explanation:</p>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">-p</span> <span class="pre">m328p</span></code> specifies the target device (ATmega328P).</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">-c</span> <span class="pre">usbasp</span></code> sets the programmer to the CH552 USB Multi-Protocol Programmer.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-c</span> <span class="pre">usbasp</span></code> sets the programmer to the Multi-Protocol Programmer.</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">-U</span> <span class="pre">flash:w:blink.hex</span></code> uploads the hex file to flash memory.</p></li>
 </ul>
 <p>Replace <code class="docutils literal notranslate"><span class="pre">m328p</span></code> with the appropriate identifier for your specific AVR device (e.g., <code class="docutils literal notranslate"><span class="pre">t88</span></code> for ATtiny88). A full list of supported devices is available in the <a class="reference external" href="http://www.nongnu.org/avrdude/user-manual/avrdude.html#Device-Options">AVRDUDE user manual</a>.</p>

docs/2_3_0_ide.html

@@ -429,11 +429,11 @@ <h2>Installing the Bootloader on ATMEGA328P<a class="headerlink" href="#installi
 <section id="required-materials">
 <h2>Required Materials<a class="headerlink" href="#required-materials" title="Link to this heading">#</a></h2>
 <ol class="arabic simple">
-<li><p><strong>UNIT Multi-Protocol Programmer</strong></p></li>
+<li><p><strong>Multi-Protocol Programmer</strong></p></li>
 </ol>
 <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><ol class="arabic simple" start="2">
 <li><p><strong>ATMEGA328P Microcontroller</strong></p></li>
 </ol>

docs/3_1_0_openocd.html

@@ -406,7 +406,16 @@ <h2> Contents </h2>
 </li>
 </ul>
 </li>
-<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#pyocd">PyOCD</a></li>
+<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#pyocd">PyOCD</a><ul class="visible nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#basic-syntax">Basic Syntax</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#configuration-file">Configuration File</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#commands">Commands</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#cmsis-pack-targets">CMSIS-Pack Targets</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#example-workflow">Example Workflow</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#references">References</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#command-help">Command Help</a></li>
+</ul>
+</li>
 </ul>
 
             </nav>
@@ -485,9 +494,126 @@ <h3>Selecting Your Microcontroller Target<a class="headerlink" href="#selecting-
 </section>
 <section id="pyocd">
 <h1>PyOCD<a class="headerlink" href="#pyocd" title="Link to this heading">#</a></h1>
+<p>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.</p>
+<section id="basic-syntax">
+<h2>Basic Syntax<a class="headerlink" href="#basic-syntax" title="Link to this heading">#</a></h2>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>&lt;command&gt;<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
+</pre></div>
+</div>
+<p>You can specify the target using <code class="docutils literal notranslate"><span class="pre">-t</span> <span class="pre">&lt;target&gt;</span></code> or through a configuration file using <code class="docutils literal notranslate"><span class="pre">--config</span> <span class="pre">&lt;file.yaml&gt;</span></code>.</p>
+</section>
+<section id="configuration-file">
+<h2>Configuration File<a class="headerlink" href="#configuration-file" title="Link to this heading">#</a></h2>
+<p>Use a YAML configuration file to define global options:</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># Misc/pyocd.yaml</span>
+<span class="nt">target_override</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">py32f003x6</span>
+<span class="nt">frequency</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1000000</span>
+<span class="nt">log_level</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">info</span>
+</pre></div>
+</div>
+<p>To load this config:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>erase<span class="w"> </span>--config<span class="w"> </span>./Misc/pyocd.yaml
+</pre></div>
+</div>
+</section>
+<section id="commands">
+<h2>Commands<a class="headerlink" href="#commands" title="Link to this heading">#</a></h2>
+<p>Erase flash memory of the target device.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>erase<span class="w"> </span>-t<span class="w"> </span>py32f003x6<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
+</pre></div>
+</div>
+<p>Options:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">--chip</span></code>: Erase the entire flash memory.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--sector</span> <span class="pre">&lt;ADDR&gt;</span></code>: Erase a single sector by address.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--config</span> <span class="pre">&lt;file.yaml&gt;</span></code>: Load configuration from YAML file.</p></li>
+</ul>
+<p>Example:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>erase<span class="w"> </span>-t<span class="w"> </span>py32f003x6<span class="w"> </span>--chip<span class="w"> </span>--config<span class="w"> </span>./Misc/pyocd.yaml
 </pre></div>
 </div>
+<p>Flash a binary, hex, or ELF file to the target.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>flash<span class="w"> </span>&lt;file&gt;<span class="w"> </span>-t<span class="w"> </span>py32f003x6<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
+</pre></div>
+</div>
+<p>Options:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">--base-address</span> <span class="pre">&lt;addr&gt;</span></code>: Override the base address (for .bin files).</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--verify</span></code>: Verify flash contents after writing.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--erase=chip|sector|auto</span></code>: Select erase mode.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--format</span> <span class="pre">bin|hex|elf</span></code>: Force file format.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--config</span> <span class="pre">&lt;file.yaml&gt;</span></code>: Load YAML config.</p></li>
+</ul>
+<p>Example:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>flash<span class="w"> </span>firmware.hex<span class="w"> </span>-t<span class="w"> </span>py32f003x6<span class="w"> </span>--erase<span class="o">=</span>chip<span class="w"> </span>--verify
+</pre></div>
+</div>
+<p>Start a GDB server for remote debugging.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>gdbserver<span class="w"> </span>-t<span class="w"> </span>py32f003x6<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
+</pre></div>
+</div>
+<p>Options:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">--port</span> <span class="pre">&lt;number&gt;</span></code>: GDB server port.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--telnet-port</span> <span class="pre">&lt;number&gt;</span></code>: Telnet monitor port.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--persist</span></code>: Keep the server alive after GDB disconnects.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--config</span> <span class="pre">&lt;file.yaml&gt;</span></code>: Load YAML config.</p></li>
+</ul>
+<p>Reset the target microcontroller.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>reset<span class="w"> </span>-t<span class="w"> </span>py32f003x6<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
+</pre></div>
+</div>
+<p>Options:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">--halt</span></code>: Halt the CPU after reset.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--config</span> <span class="pre">&lt;file.yaml&gt;</span></code>: Load YAML config.</p></li>
+</ul>
+<p>List connected debug probes and supported targets.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>list
+</pre></div>
+</div>
+<p>Read and write memory directly.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>read32<span class="w"> </span>0x08000000<span class="w"> </span><span class="m">4</span>
+pyocd<span class="w"> </span>write32<span class="w"> </span>0x20000000<span class="w"> </span>0x12345678
+</pre></div>
+</div>
+</section>
+<section id="cmsis-pack-targets">
+<h2>CMSIS-Pack Targets<a class="headerlink" href="#cmsis-pack-targets" title="Link to this heading">#</a></h2>
+<p>To add custom target support (e.g., <code class="docutils literal notranslate"><span class="pre">py32f003x6</span></code>), use:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>pack<span class="w"> </span>install<span class="w"> </span>py32f003x6
+</pre></div>
+</div>
+<p>Or add a local <cite>.pdsc</cite> file:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>pack<span class="w"> </span>add<span class="w"> </span>./path/to/PY32F003.pdsc
+</pre></div>
+</div>
+</section>
+<section id="example-workflow">
+<h2>Example Workflow<a class="headerlink" href="#example-workflow" title="Link to this heading">#</a></h2>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>list
+pyocd<span class="w"> </span>erase<span class="w"> </span>-t<span class="w"> </span>py32f003x6<span class="w"> </span>--chip
+pyocd<span class="w"> </span>flash<span class="w"> </span>build/main.hex<span class="w"> </span>-t<span class="w"> </span>py32f003x6<span class="w"> </span>--verify
+pyocd<span class="w"> </span>gdbserver<span class="w"> </span>-t<span class="w"> </span>py32f003x6
+pyocd<span class="w"> </span>reset<span class="w"> </span>-t<span class="w"> </span>py32f003x6<span class="w"> </span>--halt
+</pre></div>
+</div>
+</section>
+<section id="references">
+<h2>References<a class="headerlink" href="#references" title="Link to this heading">#</a></h2>
+<ul class="simple">
+<li><p><a class="reference external" href="https://pyocd.io/">https://pyocd.io/</a></p></li>
+<li><p><a class="github reference external" href="https://github.com/pyocd/pyocd">pyocd/pyocd</a></p></li>
+</ul>
+</section>
+<section id="command-help">
+<h2>Command Help<a class="headerlink" href="#command-help" title="Link to this heading">#</a></h2>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pyocd<span class="w"> </span>--help
+pyocd<span class="w"> </span>flash<span class="w"> </span>--help
+pyocd<span class="w"> </span>erase<span class="w"> </span>--help
+</pre></div>
+</div>
+</section>
 </section>
 
 
@@ -542,7 +668,16 @@ <h1>PyOCD<a class="headerlink" href="#pyocd" title="Link to this heading">#</a><
 </li>
 </ul>
 </li>
-<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#pyocd">PyOCD</a></li>
+<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#pyocd">PyOCD</a><ul class="visible nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#basic-syntax">Basic Syntax</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#configuration-file">Configuration File</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#commands">Commands</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#cmsis-pack-targets">CMSIS-Pack Targets</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#example-workflow">Example Workflow</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#references">References</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#command-help">Command Help</a></li>
+</ul>
+</li>
 </ul>
 
   </nav></div>