Skip to content

Commit

Permalink
deploy: 5e5e3de
Browse files Browse the repository at this point in the history
  • Loading branch information
@cseci
cseci committed Jul 18, 2024
1 parent f692612 commit bd3789c
Show file tree
Hide file tree
Showing 6 changed files with 141 additions and 68 deletions.
63 changes: 35 additions & 28 deletions library/axi_pwm_gen/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -969,64 +969,73 @@ <h3>Start at sync<a class="headerlink" href="#start-at-sync" title="Permalink to
</section>
<section id="timing-diagrams-and-examples">
<h2>Timing Diagrams and examples<a class="headerlink" href="#timing-diagrams-and-examples" title="Permalink to this heading">#</a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The diagrams below, that refer to <code class="docutils literal notranslate"><span class="pre">load_config</span></code> functionality, are
highlighting the transition from a set of pwm core config values (period,
pulse, offset) to new pwm set of config values.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The relationship between the offset and channel counters is not 100% accurate.
It is meant to highlight the functionality, by helping the reader track the
pwm waveforms. If you are interested in the exact timing you will have to
simulate the IP.</p>
</div>
<p>The timing diagram below, shows the <code class="docutils literal notranslate"><span class="pre">load_config</span></code> functionality with
force sync and force start disabled.</p>
force align and start at sync disabled.</p>

<div style="overflow-x:auto">
<script type="WaveDrom">
{ "signal" : [
{ "name": "clk", "wave": "P.............................."},
{ "name": "pwm_1 period", "wave": "9.............9................","data":["8","10"]},
{ "name": "pwm_1 pulse", "wave": "9.............9................","data":["3","5"]},
{ "name": "pwm_1 offset", "wave": "9.............9................","data":["1","0"]},
{ "name": "pwm_2 period", "wave": "6.............6................","data":["8","10"]},
{ "name": "pwm_2 pulse", "wave": "6.............6................","data":["3","5"]},
{ "name": "pwm_2 offset", "wave": "6.............6................","data":["5","4"]},
{ "name": "load_config", "wave": "0............10................",phase: 0,},
{ "name": "offset counter", "wave": "7777777777777777777777777777777","data":["55","56","57","58","59","60","61","62","63","64","65","66","67","68","0","1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16"]},
{ "name": "counter 0", "wave": "45555555544444=6666666666333333","data":["8","1","2","3","4","5","6","7","8","1","2","3","4","5","1","1","2","3","4","5","6","7","8","9","10","1","2","3","4","5","6"]},
{ "name": "pwm 0", "wave": "lh..l....h...l.h....l....h....l"},
{ "name": "counter 1", "wave": "44444555555554=...6666666666333","data":["4","5","6","7","8","1","2","3","4","5","6","7","8","1","1","1","2","3","4","5","6","7","8","9","10","1","2","3","4","5"]},
{ "name": "pwm 1", "wave": "l....h..l....hl...h....l....h.."},
],
foot: {text: ['tspan', 'load_config force_sync and start at sync e.g.'],
}}
{ "name": "clk", "wave": "P................................"},
{ "name": "pwm_1 period", "wave": "9...........9....................","data":["8","10"]},
{ "name": "pwm_1 pulse", "wave": "9...........9....................","data":["3","5"]},
{ "name": "pwm_1 offset", "wave": "9...........9....................","data":["1","1"]},
{ "name": "pwm_2 period", "wave": "6...........6....................","data":["8","10"]},
{ "name": "pwm_2 pulse", "wave": "6...........6....................","data":["3","5"]},
{ "name": "pwm_2 offset", "wave": "6...........6....................","data":["5","4"]},
{ "name": "load_config", "wave": "0..........10....................",phase: 0,},
{ "name": "offset counter", "wave": "777777777777=.....777777777777777","data":["55","56","57","58","59","60","61","62","63","64","65","66","0","1","2","3","4","5","6","7","8","9","10","11","12","13","14","15"]},
{ "name": "counter 0", "wave": "45555555544444444=666666666633333","data":["8","1","2","3","4","5","6","7","8","1","2","3","4","5","6","7","8","1","1","2","3","4","5","6","7","8","9","10","1","2","3","4","5"]},
{ "name": "pwm 0", "wave": "lh..l....h...l..............h...."},
{ "name": "counter 1", "wave": "4444455555555=.......666666666633","data":["4","5","6","7","8","1","2","3","4","5","6","7","8","1","1","2","3","4","5","6","7","8","9","10","1","2"]},
{ "name": "pwm 1", "wave": "l....h..l......................h."},
]}
</script>
</div>
<p>The timing diagram below, shows the <code class="docutils literal notranslate"><span class="pre">load_config</span></code> functionality with
force sync disabled and force start enabled.</p>
force align disabled and start at sync enabled.</p>

<div style="overflow-x:auto">
<script type="WaveDrom">
{ "signal" : [
{ "name": "clk", "wave": "P.............................."},
{ "name": "pwm_1 period", "wave": "9...........9..................","data":["8","10"]},
{ "name": "pwm_1 pulse", "wave": "9...........9..................","data":["3","5"]},
{ "name": "pwm_1 offset", "wave": "9...........9..................","data":["1","0"]},
{ "name": "pwm_1 offset", "wave": "9...........9..................","data":["1","1"]},
{ "name": "pwm_2 period", "wave": "6...........6..................","data":["8","10"]},
{ "name": "pwm_2 pulse", "wave": "6...........6..................","data":["3","5"]},
{ "name": "pwm_2 offset", "wave": "6...........6..................","data":["5","4"]},
{ "name": "load_config", "wave": "0..........10..................",phase: 0,},
{ "name": "offset counter", "wave": "7777777777777777777777777777777","data":["55","56","57","58","59","60","61","62","63","64","65","66","67","68","0","1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16"]},
{ "name": "offset counter", "wave": "777777777777=.....7777777777777","data":["55","56","57","58","59","60","61","62","63","64","65","66","0","1","2","3","4","5","6","7","8","9","10","11","12","13"]},
{ "name": "counter 0", "wave": "45555555544444444=6666666666333","data":["8","1","2","3","4","5","6","7","8","1","2","3","4","5","6","7","8","1","1","2","3","4","5","6","7","8","9","10","1","2","3"]},
{ "name": "pwm 0", "wave": "lh..l....h...l....h....l....h.."},
{ "name": "counter 1", "wave": "4444455555555=.......6666666666","data":["4","5","6","7","8","1","2","3","4","5","6","7","8","1","1","2","3","4","5","6","7","8","9","10"]},
{ "name": "pwm 1", "wave": "l....h..l............h....l...."},
],
foot: {text: ['tspan', 'load_config with start at sync(default)'],
}}
]}
</script>
</div>
<p>The timing diagram below, shows the <code class="docutils literal notranslate"><span class="pre">load_config</span></code> functionality with
force sync and force start enabled.</p>
force align and start at sync enabled.</p>

<div style="overflow-x:auto">
<script type="WaveDrom">
{ "signal" : [
{ "name": "clk", "wave": "P.............................."},
{ "name": "pwm_1 period", "wave": "9.............9................","data":["8","10"]},
{ "name": "pwm_1 pulse", "wave": "9.............9................","data":["3","5"]},
{ "name": "pwm_1 offset", "wave": "9.............9................","data":["1","0"]},
{ "name": "pwm_1 offset", "wave": "9.............9................","data":["1","1"]},
{ "name": "pwm_2 period", "wave": "6.............6................","data":["8","10"]},
{ "name": "pwm_2 pulse", "wave": "6.............6................","data":["3","5"]},
{ "name": "pwm_2 offset", "wave": "6.............6................","data":["5","4"]},
Expand All @@ -1036,9 +1045,7 @@ <h2>Timing Diagrams and examples<a class="headerlink" href="#timing-diagrams-and
{ "name": "pwm 0", "wave": "lh..l....h...l.h....l....h....l"},
{ "name": "counter 1", "wave": "44444555555554=...6666666666333","data":["4","5","6","7","8","1","2","3","4","5","6","7","8","1","1","1","2","3","4","5","6","7","8","9","10","1","2","3","4","5"]},
{ "name": "pwm 1", "wave": "l....h..l....hl...h....l....h.."},
],
foot: {text: ['tspan', 'load_config force_sync and start at sync e.g.'],
}}
]}
</script>
</div>
<p>The below timing diagrams, shows the <code class="docutils literal notranslate"><span class="pre">external_sync</span></code> functionality:</p>
Expand Down
6 changes: 3 additions & 3 deletions library/spi_engine/axi_spi_engine.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -892,7 +892,7 @@ <h2>Register Map<a class="headerlink" href="#register-map" title="Permalink to t
<td class="bold"><code class="docutils literal notranslate"><span class="pre">0x0</span></code></td>
<td class="bold" colspan="4"><code class="docutils literal notranslate"><span class="pre">VERSION</span></code></td>
<td class="description bold"><section>
<p>Version of the peripheral. Follows semantic versioning. Current version 1.02.01.</p>
<p>Version of the peripheral. Follows semantic versioning. Current version 1.03.00.</p>
</section>
</td>
</tr>
Expand All @@ -907,14 +907,14 @@ <h2>Register Map<a class="headerlink" href="#register-map" title="Permalink to t
<td><code class="docutils literal notranslate"><span class="pre">[15:8]</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">VERSION_MINOR</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">RO</span></code></td>
<td class="default"><code class="docutils literal notranslate"><span class="pre">0x02</span></code></td>
<td class="default"><code class="docutils literal notranslate"><span class="pre">0x03</span></code></td>
<td class="description"><p></p></td>
</tr>
<tr class="row-even"><td colspan="2"><p></p></td>
<td><code class="docutils literal notranslate"><span class="pre">[7:0]</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">VERSION_PATCH</span></code></td>
<td><code class="docutils literal notranslate"><span class="pre">RO</span></code></td>
<td class="default"><code class="docutils literal notranslate"><span class="pre">0x01</span></code></td>
<td class="default"><code class="docutils literal notranslate"><span class="pre">0x00</span></code></td>
<td class="description"><p></p></td>
</tr>
<tr class="row-odd"><td class="bold"><code class="docutils literal notranslate"><span class="pre">0x1</span></code></td>
Expand Down
13 changes: 9 additions & 4 deletions library/spi_engine/instruction-format.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -800,21 +800,26 @@ <h3>Sleep Instruction<a class="headerlink" href="#sleep-instruction" title="Perm
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>[7:3]</p></td>
<tr class="row-even"><td><p>[7:4]</p></td>
<td><p>reserved</p></td>
<td><p>Must always be 0.</p></td>
</tr>
<tr class="row-odd"><td><p>[2]</p></td>
<tr class="row-odd"><td><p>[3]</p></td>
<td><p>sdo_idle_state</p></td>
<td><p>Configures the output of the SDO pin when CS is inactive or during
read-only transfers.</p></td>
</tr>
<tr class="row-even"><td><p>[2]</p></td>
<td><p>three_wire</p></td>
<td><p>Configures the output of the three_wire pin.</p></td>
</tr>
<tr class="row-even"><td><p>[1]</p></td>
<tr class="row-odd"><td><p>[1]</p></td>
<td><p>CPOL</p></td>
<td><p>Configures the polarity of the SCLK signal. When 0, the idle state of
the SCLK signal is low. When 1, the idle state of the SCLK signal is
high.</p></td>
</tr>
<tr class="row-odd"><td><p>[0]</p></td>
<tr class="row-even"><td><p>[0]</p></td>
<td><p>CPHA</p></td>
<td><p>Configures the phase of the SCLK signal. When 0, data is sampled on the
leading edge and updated on the trailing edge. When 1, data is
Expand Down
Loading

0 comments on commit bd3789c

Please sign in to comment.