Skip to content

Commit 1b5b3ca

Browse files
committed
Deploy full documentation and product brief [skip ci]
1 parent 7b3c876 commit 1b5b3ca

36 files changed

+264
-622
lines changed

docs/1_0_0_terms.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,13 +178,13 @@
178178
<li class="toctree-l1"><a class="reference internal" href="2_2_0_started.html">AVR: Compile and Upload Code</a></li>
179179
<li class="toctree-l1"><a class="reference internal" href="2_3_0_ide.html">AVR: Arduino IDE Bootloader</a></li>
180180
<li class="toctree-l1"><a class="reference internal" href="3_0_0_arm.html">ARM Cortex-M</a></li>
181-
<li class="toctree-l1"><a class="reference internal" href="3_1_0_arm_firmware.html">ARM Firmware</a></li>
181+
<li class="toctree-l1"><a class="reference internal" href="3_1_0_openocd.html">Using OpenOCD</a></li>
182+
182183
<li class="toctree-l1"><a class="reference internal" href="4_0_0_rp2040.html">RP2040: An Introduction</a></li>
184+
183185
<li class="toctree-l1"><a class="reference internal" href="4_1_0_rp_firmware.html">RP2040 Firmware</a></li>
184186
<li class="toctree-l1"><a class="reference internal" href="5_0_0_stm32.html">STM32: Getting Started</a></li>
185187
<li class="toctree-l1"><a class="reference internal" href="5_1_0_stm32_firmware.html">STM32 Firmware</a></li>
186-
<li class="toctree-l1"><a class="reference internal" href="6_0_0_open_ocd.html">Using OpenOCD</a></li>
187-
188188
<li class="toctree-l1"><a class="reference internal" href="7_0_0_cpld.html">CPLD/FPGA</a></li>
189189
<li class="toctree-l1"><a class="reference internal" href="7_1_0_cpld_firmware.html">CPLD Firmware</a></li>
190190
<li class="toctree-l1"><a class="reference internal" href="report.html">How to Generate an Error Report</a></li>

docs/1_1_0_sdk.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,13 +179,13 @@
179179
<li class="toctree-l1"><a class="reference internal" href="2_2_0_started.html">AVR: Compile and Upload Code</a></li>
180180
<li class="toctree-l1"><a class="reference internal" href="2_3_0_ide.html">AVR: Arduino IDE Bootloader</a></li>
181181
<li class="toctree-l1"><a class="reference internal" href="3_0_0_arm.html">ARM Cortex-M</a></li>
182-
<li class="toctree-l1"><a class="reference internal" href="3_1_0_arm_firmware.html">ARM Firmware</a></li>
182+
<li class="toctree-l1"><a class="reference internal" href="3_1_0_openocd.html">Using OpenOCD</a></li>
183+
183184
<li class="toctree-l1"><a class="reference internal" href="4_0_0_rp2040.html">RP2040: An Introduction</a></li>
185+
184186
<li class="toctree-l1"><a class="reference internal" href="4_1_0_rp_firmware.html">RP2040 Firmware</a></li>
185187
<li class="toctree-l1"><a class="reference internal" href="5_0_0_stm32.html">STM32: Getting Started</a></li>
186188
<li class="toctree-l1"><a class="reference internal" href="5_1_0_stm32_firmware.html">STM32 Firmware</a></li>
187-
<li class="toctree-l1"><a class="reference internal" href="6_0_0_open_ocd.html">Using OpenOCD</a></li>
188-
189189
<li class="toctree-l1"><a class="reference internal" href="7_0_0_cpld.html">CPLD/FPGA</a></li>
190190
<li class="toctree-l1"><a class="reference internal" href="7_1_0_cpld_firmware.html">CPLD Firmware</a></li>
191191
<li class="toctree-l1"><a class="reference internal" href="report.html">How to Generate an Error Report</a></li>

docs/1_1_2_docker.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,13 +179,13 @@
179179
<li class="toctree-l1"><a class="reference internal" href="2_2_0_started.html">AVR: Compile and Upload Code</a></li>
180180
<li class="toctree-l1"><a class="reference internal" href="2_3_0_ide.html">AVR: Arduino IDE Bootloader</a></li>
181181
<li class="toctree-l1"><a class="reference internal" href="3_0_0_arm.html">ARM Cortex-M</a></li>
182-
<li class="toctree-l1"><a class="reference internal" href="3_1_0_arm_firmware.html">ARM Firmware</a></li>
182+
<li class="toctree-l1"><a class="reference internal" href="3_1_0_openocd.html">Using OpenOCD</a></li>
183+
183184
<li class="toctree-l1"><a class="reference internal" href="4_0_0_rp2040.html">RP2040: An Introduction</a></li>
185+
184186
<li class="toctree-l1"><a class="reference internal" href="4_1_0_rp_firmware.html">RP2040 Firmware</a></li>
185187
<li class="toctree-l1"><a class="reference internal" href="5_0_0_stm32.html">STM32: Getting Started</a></li>
186188
<li class="toctree-l1"><a class="reference internal" href="5_1_0_stm32_firmware.html">STM32 Firmware</a></li>
187-
<li class="toctree-l1"><a class="reference internal" href="6_0_0_open_ocd.html">Using OpenOCD</a></li>
188-
189189
<li class="toctree-l1"><a class="reference internal" href="7_0_0_cpld.html">CPLD/FPGA</a></li>
190190
<li class="toctree-l1"><a class="reference internal" href="7_1_0_cpld_firmware.html">CPLD Firmware</a></li>
191191
<li class="toctree-l1"><a class="reference internal" href="report.html">How to Generate an Error Report</a></li>

docs/1_2_0_about.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,13 +178,13 @@
178178
<li class="toctree-l1"><a class="reference internal" href="2_2_0_started.html">AVR: Compile and Upload Code</a></li>
179179
<li class="toctree-l1"><a class="reference internal" href="2_3_0_ide.html">AVR: Arduino IDE Bootloader</a></li>
180180
<li class="toctree-l1"><a class="reference internal" href="3_0_0_arm.html">ARM Cortex-M</a></li>
181-
<li class="toctree-l1"><a class="reference internal" href="3_1_0_arm_firmware.html">ARM Firmware</a></li>
181+
<li class="toctree-l1"><a class="reference internal" href="3_1_0_openocd.html">Using OpenOCD</a></li>
182+
182183
<li class="toctree-l1"><a class="reference internal" href="4_0_0_rp2040.html">RP2040: An Introduction</a></li>
184+
183185
<li class="toctree-l1"><a class="reference internal" href="4_1_0_rp_firmware.html">RP2040 Firmware</a></li>
184186
<li class="toctree-l1"><a class="reference internal" href="5_0_0_stm32.html">STM32: Getting Started</a></li>
185187
<li class="toctree-l1"><a class="reference internal" href="5_1_0_stm32_firmware.html">STM32 Firmware</a></li>
186-
<li class="toctree-l1"><a class="reference internal" href="6_0_0_open_ocd.html">Using OpenOCD</a></li>
187-
188188
<li class="toctree-l1"><a class="reference internal" href="7_0_0_cpld.html">CPLD/FPGA</a></li>
189189
<li class="toctree-l1"><a class="reference internal" href="7_1_0_cpld_firmware.html">CPLD Firmware</a></li>
190190
<li class="toctree-l1"><a class="reference internal" href="report.html">How to Generate an Error Report</a></li>

docs/2_0_0_started.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,13 +178,13 @@
178178
<li class="toctree-l1"><a class="reference internal" href="2_2_0_started.html">AVR: Compile and Upload Code</a></li>
179179
<li class="toctree-l1"><a class="reference internal" href="2_3_0_ide.html">AVR: Arduino IDE Bootloader</a></li>
180180
<li class="toctree-l1"><a class="reference internal" href="3_0_0_arm.html">ARM Cortex-M</a></li>
181-
<li class="toctree-l1"><a class="reference internal" href="3_1_0_arm_firmware.html">ARM Firmware</a></li>
181+
<li class="toctree-l1"><a class="reference internal" href="3_1_0_openocd.html">Using OpenOCD</a></li>
182+
182183
<li class="toctree-l1"><a class="reference internal" href="4_0_0_rp2040.html">RP2040: An Introduction</a></li>
184+
183185
<li class="toctree-l1"><a class="reference internal" href="4_1_0_rp_firmware.html">RP2040 Firmware</a></li>
184186
<li class="toctree-l1"><a class="reference internal" href="5_0_0_stm32.html">STM32: Getting Started</a></li>
185187
<li class="toctree-l1"><a class="reference internal" href="5_1_0_stm32_firmware.html">STM32 Firmware</a></li>
186-
<li class="toctree-l1"><a class="reference internal" href="6_0_0_open_ocd.html">Using OpenOCD</a></li>
187-
188188
<li class="toctree-l1"><a class="reference internal" href="7_0_0_cpld.html">CPLD/FPGA</a></li>
189189
<li class="toctree-l1"><a class="reference internal" href="7_1_0_cpld_firmware.html">CPLD Firmware</a></li>
190190
<li class="toctree-l1"><a class="reference internal" href="report.html">How to Generate an Error Report</a></li>

docs/2_1_0_avr_firmware.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -178,13 +178,13 @@
178178
<li class="toctree-l1"><a class="reference internal" href="2_2_0_started.html">AVR: Compile and Upload Code</a></li>
179179
<li class="toctree-l1"><a class="reference internal" href="2_3_0_ide.html">AVR: Arduino IDE Bootloader</a></li>
180180
<li class="toctree-l1"><a class="reference internal" href="3_0_0_arm.html">ARM Cortex-M</a></li>
181-
<li class="toctree-l1"><a class="reference internal" href="3_1_0_arm_firmware.html">ARM Firmware</a></li>
181+
<li class="toctree-l1"><a class="reference internal" href="3_1_0_openocd.html">Using OpenOCD</a></li>
182+
182183
<li class="toctree-l1"><a class="reference internal" href="4_0_0_rp2040.html">RP2040: An Introduction</a></li>
184+
183185
<li class="toctree-l1"><a class="reference internal" href="4_1_0_rp_firmware.html">RP2040 Firmware</a></li>
184186
<li class="toctree-l1"><a class="reference internal" href="5_0_0_stm32.html">STM32: Getting Started</a></li>
185187
<li class="toctree-l1"><a class="reference internal" href="5_1_0_stm32_firmware.html">STM32 Firmware</a></li>
186-
<li class="toctree-l1"><a class="reference internal" href="6_0_0_open_ocd.html">Using OpenOCD</a></li>
187-
188188
<li class="toctree-l1"><a class="reference internal" href="7_0_0_cpld.html">CPLD/FPGA</a></li>
189189
<li class="toctree-l1"><a class="reference internal" href="7_1_0_cpld_firmware.html">CPLD Firmware</a></li>
190190
<li class="toctree-l1"><a class="reference internal" href="report.html">How to Generate an Error Report</a></li>
@@ -438,7 +438,7 @@ <h2>Firmware Update Procedure<a class="headerlink" href="#firmware-update-proced
438438
<p>The following procedure assumes that the <cite>unit_ch55x_docker_sdk</cite> repository is already cloned on your system.
439439
Ensure that <strong>Docker Desktop</strong> is running before executing the build commands, as they rely on Docker containers for compilation.</p>
440440
</div>
441-
<p>To commence the utilization of the <strong>CH552 USB Multi-Protocol Programmer</strong> in PICO AVR mode, execute the following procedures:</p>
441+
<p>To commence the utilization of the <strong>CH552 USB Multi-Protocol Programmer</strong> in PICO ASP mode, execute the following procedures:</p>
442442
<ol class="arabic simple">
443443
<li><p>Navigate to the SDK Root Directory</p></li>
444444
</ol>

docs/2_2_0_started.html

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -179,13 +179,13 @@
179179
<li class="toctree-l1 current active"><a class="current reference internal" href="#">AVR: Compile and Upload Code</a></li>
180180
<li class="toctree-l1"><a class="reference internal" href="2_3_0_ide.html">AVR: Arduino IDE Bootloader</a></li>
181181
<li class="toctree-l1"><a class="reference internal" href="3_0_0_arm.html">ARM Cortex-M</a></li>
182-
<li class="toctree-l1"><a class="reference internal" href="3_1_0_arm_firmware.html">ARM Firmware</a></li>
182+
<li class="toctree-l1"><a class="reference internal" href="3_1_0_openocd.html">Using OpenOCD</a></li>
183+
183184
<li class="toctree-l1"><a class="reference internal" href="4_0_0_rp2040.html">RP2040: An Introduction</a></li>
185+
184186
<li class="toctree-l1"><a class="reference internal" href="4_1_0_rp_firmware.html">RP2040 Firmware</a></li>
185187
<li class="toctree-l1"><a class="reference internal" href="5_0_0_stm32.html">STM32: Getting Started</a></li>
186188
<li class="toctree-l1"><a class="reference internal" href="5_1_0_stm32_firmware.html">STM32 Firmware</a></li>
187-
<li class="toctree-l1"><a class="reference internal" href="6_0_0_open_ocd.html">Using OpenOCD</a></li>
188-
189189
<li class="toctree-l1"><a class="reference internal" href="7_0_0_cpld.html">CPLD/FPGA</a></li>
190190
<li class="toctree-l1"><a class="reference internal" href="7_1_0_cpld_firmware.html">CPLD Firmware</a></li>
191191
<li class="toctree-l1"><a class="reference internal" href="report.html">How to Generate an Error Report</a></li>
@@ -408,7 +408,8 @@ <h2> Contents </h2>
408408
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#compilation-commands">Compilation Commands</a></li>
409409
</ul>
410410
</li>
411-
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#uploading-with-avrdude">Uploading with AVRDUDE</a><ul class="nav section-nav flex-column">
411+
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#uploading-with-avrdude">Uploading with AVRDUDE</a></li>
412+
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation-avrdude-linux">Installation AVRDUDE Linux</a><ul class="nav section-nav flex-column">
412413
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#upload-command">Upload Command</a></li>
413414
</ul>
414415
</li>
@@ -456,6 +457,24 @@ <h2>Example: Compiling a Blink Program<a class="headerlink" href="#example-compi
456457
<li><p><strong>ATtiny88</strong></p></li>
457458
<li><p><strong>ATmega328P</strong></p></li>
458459
</ul>
460+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="w"> </span>+-----------------+
461+
PC6<span class="w"> </span><span class="o">(</span>RST<span class="o">)</span><span class="p">|</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>ATmega328<span class="w"> </span><span class="m">28</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PC5<span class="w"> </span><span class="o">(</span>A5<span class="o">)</span>
462+
PD0<span class="w"> </span><span class="o">(</span>RX<span class="o">)</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="m">27</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PC4<span class="w"> </span><span class="o">(</span>A4<span class="o">)</span>
463+
PD1<span class="w"> </span><span class="o">(</span>TX<span class="o">)</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="m">3</span><span class="w"> </span><span class="m">26</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PC3<span class="w"> </span><span class="o">(</span>A3<span class="o">)</span>
464+
<span class="w"> </span>PD2<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="m">4</span><span class="w"> </span><span class="m">25</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PC2<span class="w"> </span><span class="o">(</span>A2<span class="o">)</span>
465+
PD3<span class="w"> </span><span class="o">(</span>PWM<span class="o">)</span><span class="p">|</span><span class="w"> </span><span class="m">5</span><span class="w"> </span><span class="m">24</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PC1<span class="w"> </span><span class="o">(</span>A1<span class="o">)</span>
466+
<span class="w"> </span>PD4<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="m">6</span><span class="w"> </span><span class="m">23</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PC0<span class="w"> </span><span class="o">(</span>A0<span class="o">)</span>
467+
<span class="w"> </span>VCC<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="m">7</span><span class="w"> </span><span class="m">22</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>GND
468+
<span class="w"> </span>GND<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="m">8</span><span class="w"> </span><span class="m">21</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>AREF
469+
<span class="w"> </span>PB6<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="m">9</span><span class="w"> </span><span class="m">20</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>AVCC
470+
<span class="w"> </span>PB7<span class="w"> </span><span class="p">|</span><span class="m">10</span><span class="w"> </span><span class="m">19</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PB5<span class="w"> </span><span class="o">(</span>D13<span class="o">)</span>
471+
PD5<span class="w"> </span><span class="o">(</span>D5<span class="o">)</span><span class="w"> </span><span class="p">|</span><span class="m">11</span><span class="w"> </span><span class="m">18</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PB4<span class="w"> </span><span class="o">(</span>D12<span class="o">)</span>
472+
PD6<span class="w"> </span><span class="o">(</span>D6<span class="o">)</span><span class="w"> </span><span class="p">|</span><span class="m">12</span><span class="w"> </span><span class="m">17</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PB3<span class="w"> </span><span class="o">(</span>D11/PWM<span class="o">)</span>
473+
PD7<span class="w"> </span><span class="o">(</span>D7<span class="o">)</span><span class="w"> </span><span class="p">|</span><span class="m">13</span><span class="w"> </span><span class="m">16</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PB2<span class="w"> </span><span class="o">(</span>D10/PWM<span class="o">)</span>
474+
PB0<span class="w"> </span><span class="o">(</span>D8<span class="o">)</span><span class="w"> </span><span class="p">|</span><span class="m">14</span><span class="w"> </span><span class="m">15</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>PB1<span class="w"> </span><span class="o">(</span>D9/PWM<span class="o">)</span>
475+
<span class="w"> </span>+-----------------+
476+
</pre></div>
477+
</div>
459478
<p>The program toggles an LED connected to <strong>pin PB0</strong> every second.</p>
460479
<section id="source-file">
461480
<h3>Source File<a class="headerlink" href="#source-file" title="Link to this heading">#</a></h3>
@@ -496,6 +515,13 @@ <h3>Compilation Commands<a class="headerlink" href="#compilation-commands" title
496515
<section id="uploading-with-avrdude">
497516
<h2>Uploading with AVRDUDE<a class="headerlink" href="#uploading-with-avrdude" title="Link to this heading">#</a></h2>
498517
<p>Once the <code class="docutils literal notranslate"><span class="pre">.hex</span></code> file is generated, you can upload it to the AVR microcontroller using <strong>AVRDUDE</strong>.</p>
518+
</section>
519+
<section id="installation-avrdude-linux">
520+
<h2>Installation AVRDUDE Linux<a class="headerlink" href="#installation-avrdude-linux" title="Link to this heading">#</a></h2>
521+
<p>You can install AVRDUDE on Linux using your package manager. For example, on Ubuntu:</p>
522+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>avrdude
523+
</pre></div>
524+
</div>
499525
<section id="upload-command">
500526
<h3>Upload Command<a class="headerlink" href="#upload-command" title="Link to this heading">#</a></h3>
501527
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="n">avrdude</span><span class="w"> </span><span class="o">-</span><span class="n">p</span><span class="w"> </span><span class="n">m328p</span><span class="w"> </span><span class="o">-</span><span class="n">c</span><span class="w"> </span><span class="n">usbasp</span><span class="w"> </span><span class="o">-</span><span class="n">U</span><span class="w"> </span><span class="n">flash</span><span class="o">:</span><span class="n">w</span><span class="o">:</span><span class="n">blink</span><span class="p">.</span><span class="n">hex</span>
@@ -568,7 +594,8 @@ <h3>Upload Command<a class="headerlink" href="#upload-command" title="Link to th
568594
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#compilation-commands">Compilation Commands</a></li>
569595
</ul>
570596
</li>
571-
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#uploading-with-avrdude">Uploading with AVRDUDE</a><ul class="nav section-nav flex-column">
597+
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#uploading-with-avrdude">Uploading with AVRDUDE</a></li>
598+
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation-avrdude-linux">Installation AVRDUDE Linux</a><ul class="nav section-nav flex-column">
572599
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#upload-command">Upload Command</a></li>
573600
</ul>
574601
</li>

0 commit comments

Comments
 (0)