Setting up Software for B1 ARM - Revision history

Adewar at 19:37, 27 September 2018

2018-09-27T19:37:36Z

Adewar at 19:29, 27 September 2018

2018-09-27T19:29:18Z

Adewar: Created page with "It is assumed that you've already followed the guide in Installing_ChipWhisperer. Thus it is assumed you are able to communicate with the ChipWhisperer CW1173 hardware (or..."

2018-09-27T19:16:33Z

Created page with "It is assumed that you've already followed the guide in Installing_ChipWhisperer. Thus it is assumed you are able to communicate with the ChipWhisperer CW1173 hardware (or..."

New page

It is assumed that you've already followed the guide in [[Installing_ChipWhisperer]]. Thus it is assumed you are able to communicate with the ChipWhisperer CW1173 hardware (or whatever capture hardware you are using). Note in particular you must have configured the FPGA bitstream in the ChipWhisperer-Capture software, all part of the description in the [[Installing_ChipWhisperer]] guide.

Assuming this setup is complete, you can confirm you are able to communicate with the hardware by running the example capture of traces given in the [[CW1173_ChipWhisperer-Lite]] quick-start.

<h4> Programming the Example </h4>

Note with the CW1173 you need to configure a clock before programming of the device will succeed. Programming of the target device will be done as part of the CW-Capture software setup, discussed next.

<h4> Communicating from CW-Capture Software </h4>

Next, open the CW-Capture software. Then perform the following steps:

[[File:cwsetup_scriptselection.png|889x889px]]

# Switch to the ''Python Console'' tab.
# The script selection window (2) lists available example scripts. Scroll down to "connect_cwlite_simpleserial.py" and click on it.
# You will see the script contents appear in the "Script Preview" window (3). You can either hit the "Run" button or double-click the filename of the script to execute it. Do either of those now.

The window should change to indicate the connect succeeded:

[[File:cwsetup_scriptselection_cwliterun.png|889x889px]]

<ol start="4" style="list-style-type: decimal;">
<li>The console lists the exact script that is executed. Note you could have manually executed the script commands line-by-line in this console.</li>
<li>The "Scope" and "Target" buttons will show as connected.</li>
<li>The Status Bar will show a connection.</li>
</ol>

Note in previous software versions, this tutorial took you through manual setup. This can still be done (using the GUI), but instead now the API has been made more powerful, so the example configuration script will be used instead.

To do so, simply scroll down and select the "setup_cwlite_xmega_aes.py" file:

[[File:cwsetup_scriptselection_xmegaconfig_cwliterun.png]]

You'll notice the contents of the script contain the following setup:<syntaxhighlight lang="python" line="1">
scope.gain.gain = 45
scope.adc.samples = 3000
scope.adc.offset = 1250
scope.adc.basic_mode = "rising_edge"
scope.clock.clkgen_freq = 7370000
scope.clock.adc_src = "clkgen_x4"
scope.trigger.triggers = "tio4"
scope.io.tio1 = "serial_rx"
scope.io.tio2 = "serial_tx"
scope.io.hs2 = "clkgen"
</syntaxhighlight>This configuration block does the following (for lines 1 through 10):

Line 1: Sets the input ADC gain

Line 2: Sets the number of samples to record as 3000 samples long (this is normally used for the AES algorithm).

Line 3: Sets an offset of 1250 samples from the trigger to when we start recording samples.

Line 4: Sets the trigger as being a "rising edge" trigger.

Line 5: Sets the internal clock generator to 7.37MHz

Line 6: Sets the ADC as running at 4x that clock (so 29.48MHz)

Line 7: Sets the trigger pin as GPIO4 (we previously set the trigger condition as rising edge, so this pin will be the one a rising edge is expected on).

Line 8: Configures GPIO1 as the RX (Input). This is what the XMEGA target expects.

Line 9: Configures GPIO2 as the TX (Output). This is what the XMEGA target expects.

Line 10: Sets the "High-Speed 2" (HS2) pin as having the 7.37MHz clock output.

<ol start="14" style="list-style-type: decimal;">
<li><p>You can now program the XMEGA device! To do so, open the XMEGA Programmer from the ''Tools'' menu:</p>
<p>[[File:cw1173_xmegaproga.png|image]]</p></li>
<li><p>Hit the ''Check Signature'' button and confirm the device is detected. If not you may have issues with the clock setup.</p>
<p>[[File:cw1173_xmegaprogb.png|image]]</p></li>
<li><p>Using the ''Find'' button, navigate to the <code>simpleserial-base-cw303.hex</code> which you built earlier with the <code>make</code> command. You can then press the ''Erase/Program/Verify'' button, and confirm the file is programmed into the XMEGA device:</p>
<p>[[File:cw1173_xmegaprogc.png|image]]</p>
<p>Note the programmer dialog not only shows the successful programming status, but also shows when the <code>.hex</code> file was last modified. Always confirm this matches with when you last remember compiling the program -- if it is widely different this suggests you have selected the wrong file!</p>

<p>Finally we can check communications with the programmed file:</p></li></ol>

[[File:09_Cw1173_connectrun.png|image]]

<ol start="17" style="list-style-type: decimal;">
<li>Close the XMEGA programmer dialog.</li>
<li>Open the status monitor under <i>Tools > Encryption Status Monitor</i>.</li>
<li>Resize the monitor window. The monitor will show sent & received data to the target.</li>
<li>Hit the ''Run 1'' button ([[File:Capture One Button.PNG|image]]). You may have to hit it a few times, as the very first serial data is often lost. You should see data populate in the ''Text Out'' field of the monitor window. Note that each byte of the ''Text In'' is incremented in the ''Text Out'' field.</li></ol>

@@ Line 30: / Line 30: @@
 To do so, simply scroll down and select the "setup_cwlite_stm32f_aes.py" file:
-[[File:Stm32f aes.PNG|thumb]]
+[[File:Stm32f aes.PNG|thumb|left|1104x1104px]]
 You'll notice the contents of the script contain the following setup:<syntaxhighlight lang="python" line="1">
@@ Line 68: / Line 68: @@
 Line 12: Sets the serial communication speed with the target at 38400 baud. <p>You can now program the ARM device! To do so, open the STM32F Programmer from the ''Tools'' menu:</p>
-<p></p>
+[[File:Stm32f programmer.png|thumb|none|303x303px]]
 [[File:Stm32f programmer.png|thumb]]
 <ol start="14" style="list-style-type: decimal;">
-<li><p>Hit the ''Check Signature'' button and confirm the device is detected. If not you may have issues with the clock setup.</p>
+<li><p>Hit the ''Check Signature'' button and confirm the device is detected. If not you may have issues with the clock setup.</p>[[File:Stm32f programmer sig.png|none|thumb|357x357px]]<p></p></li>
-<p>[[File:cw1173_xmegaprogb.png|image]]</p></li>
+<li><p>Using the ''Find'' button, navigate to the <code>simpleserial-base-CWLITEARM.hex</code> which you built earlier with the <code>make</code> command. You can then press the ''Erase/Program/Verify'' button, and confirm the file is programmed into the XMEGA device:</p>[[File:Stm32f programmer succ.png|none|thumb|362x362px]]<p></p></li><li><p>If the software freezes and the verification fails after a long period of time, set the Read Block Size to 64 instead of 256.</p></li><li><p>Note the programmer dialog not only shows the successful programming status, but also shows when the <code>.hex</code> file was last modified. Always confirm this matches with when you last remember compiling the program -- if it is widely different this suggests you have selected the wrong file!</p>
-<li><p>Using the ''Find'' button, navigate to the <code>simpleserial-base-CWLITEARM.hex</code> which you built earlier with the <code>make</code> command. You can then press the ''Erase/Program/Verify'' button, and confirm the file is programmed into the XMEGA device:</p>
-<p>[[File:cw1173_xmegaprogc.png|image]]</p>
 <p></p></li><li><p>If the software freezes and the verification fails after a long period of time, set the Read Block Size to 64 instead of 256.</p></li><li><p>Note the programmer dialog not only shows the successful programming status, but also shows when the <code>.hex</code> file was last modified. Always confirm this matches with when you last remember compiling the program -- if it is widely different this suggests you have selected the wrong file!</p>
 <p>Finally we can check communications with the programmed file:</p></li></ol>

@@ Line 29: / Line 29: @@
 Note in previous software versions, this tutorial took you through manual setup. This can still be done (using the GUI), but instead now the API has been made more powerful, so the example configuration script will be used instead.
-To do so, simply scroll down and select the "setup_cwlite_xmega_aes.py" file:
+To do so, simply scroll down and select the "setup_cwlite_stm32f_aes.py" file:
+[[File:Stm32f aes.PNG|thumb]]
-[[File:cwsetup_scriptselection_xmegaconfig_cwliterun.png]]
 You'll notice the contents of the script contain the following setup:<syntaxhighlight lang="python" line="1">
 scope.gain.gain = 45
-scope.adc.samples = 3000
+scope.adc.samples = 5000
-scope.adc.offset = 1250
+scope.adc.offset = 0
 scope.adc.basic_mode = "rising_edge"
 scope.clock.clkgen_freq = 7370000
@@ Line 44: / Line 43: @@
 scope.io.tio2 = "serial_tx"
 scope.io.hs2 = "clkgen"
-</syntaxhighlight>This configuration block does the following (for lines 1 through 10):
 Line 1: Sets the input ADC gain
-Line 2: Sets the number of samples to record as 3000 samples long (this is normally used for the AES algorithm).
+Line 2: Sets the number of samples to record as 5000 samples long (this is normally used for the AES algorithm).
-Line 3: Sets an offset of 1250 samples from the trigger to when we start recording samples.
+Line 3: Sets an offset of 0 samples from the trigger to when we start recording samples.
 Line 4: Sets the trigger as being a "rising edge" trigger.
@@ Line 60: / Line 61: @@
 Line 7: Sets the trigger pin as GPIO4 (we previously set the trigger condition as rising edge, so this pin will be the one a rising edge is expected on).
-Line 8: Configures GPIO1 as the RX (Input). This is what the XMEGA target expects.
+Line 8: Configures GPIO1 as the RX (Input). This is what the ARM target expects.
-Line 9: Configures GPIO2 as the TX (Output). This is what the XMEGA target expects.
+Line 9: Configures GPIO2 as the TX (Output). This is what the ARM target expects.
 Line 10: Sets the "High-Speed 2" (HS2) pin as having the 7.37MHz clock output.
 <ol start="14" style="list-style-type: decimal;">
 <li><p>Hit the ''Check Signature'' button and confirm the device is detected. If not you may have issues with the clock setup.</p>
 <p>[[File:cw1173_xmegaprogb.png|image]]</p></li>
-<li><p>Using the ''Find'' button, navigate to the <code>simpleserial-base-cw303.hex</code> which you built earlier with the <code>make</code> command. You can then press the ''Erase/Program/Verify'' button, and confirm the file is programmed into the XMEGA device:</p>
+<li><p>Using the ''Find'' button, navigate to the <code>simpleserial-base-CWLITEARM.hex</code> which you built earlier with the <code>make</code> command. You can then press the ''Erase/Program/Verify'' button, and confirm the file is programmed into the XMEGA device:</p>
 <p>[[File:cw1173_xmegaprogc.png|image]]</p>
-<p>Note the programmer dialog not only shows the successful programming status, but also shows when the <code>.hex</code> file was last modified. Always confirm this matches with when you last remember compiling the program -- if it is widely different this suggests you have selected the wrong file!</p>
+<p></p></li><li><p>If the software freezes and the verification fails after a long period of time, set the Read Block Size to 64 instead of 256.</p></li><li><p>Note the programmer dialog not only shows the successful programming status, but also shows when the <code>.hex</code> file was last modified. Always confirm this matches with when you last remember compiling the program -- if it is widely different this suggests you have selected the wrong file!</p>
 <p>Finally we can check communications with the programmed file:</p></li></ol>
@@ Line 80: / Line 82: @@
 <ol start="17" style="list-style-type: decimal;">
-<li>Close the XMEGA programmer dialog.</li>
+<li>Close the STM32F programmer dialog.</li>
 <li>Open the status monitor under <i>Tools > Encryption Status Monitor</i>.</li>
 <li>Resize the monitor window. The monitor will show sent &amp; received data to the target.</li>
 <li>Hit the ''Run 1'' button ([[File:Capture One Button.PNG|image]]). You may have to hit it a few times, as the very first serial data is often lost. You should see data populate in the ''Text Out'' field of the monitor window. Note that each byte of the ''Text In'' is incremented in the ''Text Out'' field.</li></ol>