[docs] update doc

This commit is contained in:
jzlv 2021-07-16 16:43:39 +08:00
parent ee237e8197
commit a703cb54ff
74 changed files with 74 additions and 128 deletions

View file

@ -296,7 +296,7 @@
<span class="normal">6</span>
<span class="normal">7</span>
<span class="normal">8</span>
<span class="normal">9</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span> <span class="n">uart_register</span><span class="p">(</span><span class="n">board_get_debug_uart_index</span><span class="p">(),</span> <span class="s">&quot;debug_log&quot;</span><span class="p">,</span> <span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
<span class="normal">9</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span> <span class="n">uart_register</span><span class="p">(</span><span class="n">board_get_debug_uart_index</span><span class="p">(),</span> <span class="s">&quot;debug_log&quot;</span><span class="p">);</span>
<span class="k">struct</span> <span class="nc">device</span> <span class="o">*</span><span class="n">uart</span> <span class="o">=</span> <span class="n">device_find</span><span class="p">(</span><span class="s">&quot;debug_log&quot;</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="n">uart</span><span class="p">)</span>

View file

@ -264,7 +264,7 @@
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">dma_register</span><span class="p">(</span><span class="n">DMA0_CH0_INDEX</span><span class="p">,</span> <span class="s">&quot;DMA&quot;</span><span class="p">,</span> <span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
<span class="normal">10</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">dma_register</span><span class="p">(</span><span class="n">DMA0_CH0_INDEX</span><span class="p">,</span> <span class="s">&quot;DMA&quot;</span><span class="p">);</span>
<span class="k">struct</span> <span class="nc">device</span> <span class="o">*</span><span class="n">dma</span> <span class="o">=</span> <span class="n">device_find</span><span class="p">(</span><span class="s">&quot;DMA&quot;</span><span class="p">);</span>

View file

@ -236,7 +236,7 @@
</pre></div>
</td></tr></table></div>
<ul class="simple">
<li><p>配置 <code class="docutils literal notranslate"><span class="pre">I2C</span></code> 设备复用引脚,见 <code class="docutils literal notranslate"><span class="pre">bsp/board/bl706_iot/peripheral_config.h</span></code></p></li>
<li><p>配置 <code class="docutils literal notranslate"><span class="pre">I2C</span></code> 设备复用引脚,见 <code class="docutils literal notranslate"><span class="pre">bsp/board/bl706_iot/pinmux_config.h</span></code></p></li>
</ul>
<div class="highlight-C notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
@ -273,7 +273,7 @@
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span>
<span class="normal">8</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">i2c_register</span><span class="p">(</span><span class="n">I2C0_INDEX</span><span class="p">,</span> <span class="s">&quot;i2c&quot;</span><span class="p">,</span> <span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
<span class="normal">8</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">i2c_register</span><span class="p">(</span><span class="n">I2C0_INDEX</span><span class="p">,</span> <span class="s">&quot;i2c&quot;</span><span class="p">);</span>
<span class="k">struct</span> <span class="nc">device</span> <span class="o">*</span><span class="n">i2c0</span> <span class="o">=</span> <span class="n">device_find</span><span class="p">(</span><span class="s">&quot;i2c&quot;</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="n">i2c0</span><span class="p">)</span>

View file

@ -282,7 +282,7 @@
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM_CH2_INDEX</span><span class="p">,</span> <span class="s">&quot;led_breath&quot;</span><span class="p">,</span> <span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
<span class="normal">11</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM_CH2_INDEX</span><span class="p">,</span> <span class="s">&quot;led_breath&quot;</span><span class="p">);</span>
<span class="k">struct</span> <span class="nc">device</span> <span class="o">*</span><span class="n">led_breath</span> <span class="o">=</span> <span class="n">device_find</span><span class="p">(</span><span class="s">&quot;led_breath&quot;</span><span class="p">);</span>

View file

@ -445,10 +445,10 @@
<span class="normal">36</span>
<span class="normal">37</span>
<span class="normal">38</span>
<span class="normal">39</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM_CH0_INDEX</span><span class="p">,</span> <span class="s">&quot;motor_ch0&quot;</span><span class="p">,</span> <span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
<span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM_CH1_INDEX</span><span class="p">,</span> <span class="s">&quot;motor_ch1&quot;</span><span class="p">,</span> <span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
<span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM_CH2_INDEX</span><span class="p">,</span> <span class="s">&quot;motor_ch2&quot;</span><span class="p">,</span> <span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
<span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM_CH3_INDEX</span><span class="p">,</span> <span class="s">&quot;motor_ch3&quot;</span><span class="p">,</span> <span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
<span class="normal">39</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM_CH0_INDEX</span><span class="p">,</span> <span class="s">&quot;motor_ch0&quot;</span><span class="p">);</span>
<span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM_CH1_INDEX</span><span class="p">,</span> <span class="s">&quot;motor_ch1&quot;</span><span class="p">);</span>
<span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM_CH2_INDEX</span><span class="p">,</span> <span class="s">&quot;motor_ch2&quot;</span><span class="p">);</span>
<span class="n">pwm_register</span><span class="p">(</span><span class="n">PWM_CH3_INDEX</span><span class="p">,</span> <span class="s">&quot;motor_ch3&quot;</span><span class="p">);</span>
<span class="n">motor_ch0</span> <span class="o">=</span> <span class="n">device_find</span><span class="p">(</span><span class="s">&quot;motor_ch0&quot;</span><span class="p">);</span>
<span class="n">motor_ch1</span> <span class="o">=</span> <span class="n">device_find</span><span class="p">(</span><span class="s">&quot;motor_ch1&quot;</span><span class="p">);</span>

View file

@ -314,7 +314,7 @@
<span class="n">device_close</span><span class="p">(</span><span class="n">spi0</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">else</span><span class="p">{</span>
<span class="n">spi_register</span><span class="p">(</span><span class="n">SPI0_INDEX</span><span class="p">,</span><span class="s">&quot;spi0&quot;</span><span class="p">,</span><span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
<span class="n">spi_register</span><span class="p">(</span><span class="n">SPI0_INDEX</span><span class="p">,</span><span class="s">&quot;spi0&quot;</span><span class="p">);</span>
<span class="n">spi0</span> <span class="o">=</span> <span class="n">device_find</span><span class="p">(</span><span class="s">&quot;spi0&quot;</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">if</span><span class="p">(</span><span class="n">spi0</span><span class="p">)</span>

View file

@ -287,7 +287,7 @@
<span class="normal">6</span>
<span class="normal">7</span>
<span class="normal">8</span>
<span class="normal">9</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span> <span class="n">uart_register</span><span class="p">(</span><span class="n">board_get_debug_uart_index</span><span class="p">(),</span> <span class="s">&quot;debug_log&quot;</span><span class="p">,</span> <span class="n">DEVICE_OFLAG_RDWR</span><span class="p">);</span>
<span class="normal">9</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span> <span class="n">uart_register</span><span class="p">(</span><span class="n">board_get_debug_uart_index</span><span class="p">(),</span> <span class="s">&quot;debug_log&quot;</span><span class="p">);</span>
<span class="k">struct</span> <span class="nc">device</span> <span class="o">*</span><span class="n">uart</span> <span class="o">=</span> <span class="n">device_find</span><span class="p">(</span><span class="s">&quot;debug_log&quot;</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="n">uart</span><span class="p">)</span>