Skip to content

Commit 10dd70c

Browse files
committed
deploy: 276e42c
1 parent 3cd9b35 commit 10dd70c

File tree

131 files changed

+109
-139
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+109
-139
lines changed
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

_gen_md/projects/test_marble_family/i2c/README_md.html

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -124,45 +124,6 @@
124124
<span id="readme"></span><h1>i2c README<a class="headerlink" href="#i2c-readme" title="Permalink to this heading"></a></h1>
125125
<section id="marble-platform-support-for-i2cbridge-programming">
126126
<h2>Marble Platform Support for I2CBridge Programming<a class="headerlink" href="#marble-platform-support-for-i2cbridge-programming" title="Permalink to this heading"></a></h2>
127-
<section id="one-shot-i2c-transactions">
128-
<h3>One-shot I2C transactions<a class="headerlink" href="#one-shot-i2c-transactions" title="Permalink to this heading"></a></h3>
129-
<p>The script <code class="docutils literal notranslate"><span class="pre">oneshot.py</span></code> is included here to allow composing and running single-transaction
130-
<code class="docutils literal notranslate"><span class="pre">i2cbridge</span></code> programs to a live target with a (hopefully) user-friendly interface. Without
131-
worrying about the I2C tree on the Marble board or chip addresses, you can simply read from
132-
or write to any register in any chip just referring to the chip by name (refdes on the
133-
schematic).</p>
134-
<p>Example: turn on LD13 via the GPIO expander U39 by writing to register 3
135-
<strong>WARNING</strong>: The user LEDs are on the same port as <code class="docutils literal notranslate"><span class="pre">/CLKMUX_RST</span></code> which means we can shut down the board on accident
136-
if we aren’t very careful to ensure we always keep bit 7 asserted when writing to this register!</p>
137-
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">PYTHONPATH</span><span class="o">=</span>../../../peripheral_drivers/i2cbridge:<span class="nv">$PYTHONPATH</span><span class="w"> </span>python3<span class="w"> </span>oneshot.py<span class="w"> </span>leep://<span class="nv">$IP</span>:<span class="nv">$PORT</span><span class="w"> </span>U39.3<span class="o">=</span>0x80
138-
</pre></div>
139-
</div>
140-
<p>Example: turn off LD13</p>
141-
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">PYTHONPATH</span><span class="o">=</span>../../../peripheral_drivers/i2cbridge:<span class="nv">$PYTHONPATH</span><span class="w"> </span>python3<span class="w"> </span>oneshot.py<span class="w"> </span>leep://<span class="nv">$IP</span>:<span class="nv">$PORT</span><span class="w"> </span>U39.3<span class="o">=</span>0x88
142-
</pre></div>
143-
</div>
144-
<p>Example: read the inputs to port 0 on the GPIO expander U39 by reading from register 0</p>
145-
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">PYTHONPATH</span><span class="o">=</span>../../../peripheral_drivers/i2cbridge:<span class="nv">$PYTHONPATH</span><span class="w"> </span>python3<span class="w"> </span>oneshot.py<span class="w"> </span>leep://192.168.19.40:803<span class="w"> </span>U39.0
146-
</pre></div>
147-
</div>
148-
<p><em>(The following demos assume you have exported ``PYTHONPATH`` for brevity)</em></p>
149-
<p>We can also read more than 1 byte (very much dependent on the specifics of the IC’s I2C implementation).
150-
Example: read shunt voltage (addr 1, 16 bits) from INA219 U57</p>
151-
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>oneshot.py<span class="w"> </span>leep://<span class="nv">$IP</span>:<span class="nv">$PORT</span><span class="w"> </span>U57.1:2
152-
<span class="c1"># Note the &#39;:&#39; instead of a &#39;=&#39; (the latter indicates a write!)</span>
153-
</pre></div>
154-
</div>
155-
<p>Note that you can perform many transactions in one “one shot” program, including adding pauses between
156-
transactions, as in this demo disabling and re-enabling QSFP1 channel 0:</p>
157-
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>oneshot.py<span class="w"> </span>leep://<span class="nv">$IP</span>:<span class="nv">$PORT</span><span class="w"> </span>J17.86<span class="o">=</span><span class="m">1</span><span class="w"> </span>J17.86<span class="o">=</span><span class="m">0</span>
158-
</pre></div>
159-
</div>
160-
<p>And breaking the “one shot” model, you can tell the program to continue looping after the script exits.
161-
This demo makes LD13 continually blink.</p>
162-
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>oneshot.py<span class="w"> </span>leep://<span class="nv">$IP</span>:<span class="nv">$PORT</span><span class="w"> </span>U39.3<span class="o">=</span>0x80<span class="w"> </span><span class="nv">pause</span><span class="o">=</span><span class="m">500</span><span class="w"> </span>U39.3<span class="o">=</span>0x88<span class="w"> </span><span class="nv">pause</span><span class="o">=</span><span class="m">500</span><span class="w"> </span>-l
163-
</pre></div>
164-
</div>
165-
</section>
166127
<section id="usage">
167128
<h3>Usage:<a class="headerlink" href="#usage" title="Permalink to this heading"></a></h3>
168129
<p>These tools assume usage of the i2cbridge modules in <code class="docutils literal notranslate"><span class="pre">bedrock/peripheral_drivers/i2cbridge</span></code>.
@@ -226,7 +187,7 @@ <h4>Test 2: Decode the program without platform awareness<a class="headerlink" h
226187
<h4>Test 3: Test assembler violations<a class="headerlink" href="#test-3-test-assembler-violations" title="Permalink to this heading"></a></h4>
227188
<p>This last test is not truly platform-specific but shows various violations of the I2C assembler rules
228189
using the Marble platform-aware interface. None of the rules violated are specific to the platform.</p>
229-
<p><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">violations</span></code></p>
190+
<p><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test</span></code></p>
230191
<p>See <code class="docutils literal notranslate"><span class="pre">demo_i2c_baddy.py</span></code> for examples of what to avoid.</p>
231192
</section>
232193
</section>

_gen_rst/phase_diff.html

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,13 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
223223
<td><p>14</p></td>
224224
<td></td>
225225
</tr>
226-
<tr class="row-odd"><td><p>delta</p></td>
226+
<tr class="row-odd"><td><p>adv</p></td>
227+
<td><p>?</p></td>
228+
<td><p>?</p></td>
229+
<td><p>3861</p></td>
230+
<td></td>
231+
</tr>
232+
<tr class="row-even"><td><p>delta</p></td>
227233
<td><p>?</p></td>
228234
<td><p>?</p></td>
229235
<td><p>16</p></td>
@@ -263,23 +269,19 @@ <h2>Ports<a class="headerlink" href="#ports" title="Permalink to this heading">
263269
<td><p>Input</p></td>
264270
<td><p>readout clock (data transfer, local bus)</p></td>
265271
</tr>
266-
<tr class="row-odd"><td><p>adv[dw-1:0]</p></td>
267-
<td><p>Input</p></td>
268-
<td><p>make adv a runtime variable</p></td>
269-
</tr>
270-
<tr class="row-even"><td><p>err</p></td>
272+
<tr class="row-odd"><td><p>err</p></td>
271273
<td><p>Output</p></td>
272274
<td></td>
273275
</tr>
274-
<tr class="row-odd"><td><p>phdiff_out[dw-2:0]</p></td>
276+
<tr class="row-even"><td><p>phdiff_out[dw-2:0]</p></td>
275277
<td><p>Output</p></td>
276278
<td></td>
277279
</tr>
278-
<tr class="row-even"><td><p>vfreq_out[dw-1:0]</p></td>
280+
<tr class="row-odd"><td><p>vfreq_out[dw-1:0]</p></td>
279281
<td><p>Output</p></td>
280282
<td></td>
281283
</tr>
282-
<tr class="row-odd"><td><p>err_ff</p></td>
284+
<tr class="row-even"><td><p>err_ff</p></td>
283285
<td><p>Output</p></td>
284286
<td></td>
285287
</tr>

_gen_rst/phaset.html

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,13 @@ <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
221221
<td><p>14</p></td>
222222
<td></td>
223223
</tr>
224-
<tr class="row-even"><td><p>delta</p></td>
224+
<tr class="row-even"><td><p>adv</p></td>
225+
<td><p>?</p></td>
226+
<td><p>?</p></td>
227+
<td><p>3861</p></td>
228+
<td></td>
229+
</tr>
230+
<tr class="row-odd"><td><p>delta</p></td>
225231
<td><p>?</p></td>
226232
<td><p>?</p></td>
227233
<td><p>16</p></td>
@@ -253,15 +259,11 @@ <h2>Ports<a class="headerlink" href="#ports" title="Permalink to this heading">
253259
<td><p>Input</p></td>
254260
<td></td>
255261
</tr>
256-
<tr class="row-odd"><td><p>adv[dw-1:0]</p></td>
257-
<td><p>Input</p></td>
258-
<td></td>
259-
</tr>
260-
<tr class="row-even"><td><p>phase[dw-1:0]</p></td>
262+
<tr class="row-odd"><td><p>phase[dw-1:0]</p></td>
261263
<td><p>Output</p></td>
262264
<td></td>
263265
</tr>
264-
<tr class="row-odd"><td><p>fault</p></td>
266+
<tr class="row-even"><td><p>fault</p></td>
265267
<td><p>Output</p></td>
266268
<td><p>single cycle</p></td>
267269
</tr>

0 commit comments

Comments
 (0)