MATLAB Control of CW-Lite - Revision history

Fheubach: Removed irrelevant sentence

2018-03-09T16:25:13Z

Removed irrelevant sentence

Fheubach: link was showing a 1 not a word, fixed it

2018-03-01T18:48:56Z

link was showing a 1 not a word, fixed it

Fheubach: Updated the wiki for the changed MATLAB api

2018-03-01T18:45:07Z

Updated the wiki for the changed MATLAB api

Show changes

Fheubach: Removed note

2018-03-01T16:38:06Z

Removed note

Fheubach: Adding a V4 version of interfacing chipwhisperer with matlab

2018-03-01T16:35:47Z

Adding a V4 version of interfacing chipwhisperer with matlab

Fheubach: Added warning box

2018-03-01T16:12:51Z

Added warning box

Coflynn at 01:50, 29 November 2016

2016-11-29T01:50:14Z

Coflynn: /* Running Examples */

2016-11-29T01:45:37Z

‎Running Examples

Coflynn: /* MATLAB Setup */

2016-11-29T01:44:18Z

‎MATLAB Setup

Coflynn at 01:43, 29 November 2016

2016-11-29T01:43:59Z

@@ Line 47: / Line 47: @@
 To run the examples, you will need to ensure you set the MATLAB working directory to the location of the .m script files.
-Since the new CW 4,0 API exposes the internals of chipwhisperer the easiest way to get access to the chipwhisperer module in MATLAB is to use this API. MATLAB seems to not find certain modules even if they are on the python path so just use pythons build in importlib, which MATLAB can find, letting python find the module for MATLAB. Run this command in MATLAB.
+Since the new CW 4,0 API exposes the internals of chipwhisperer the easiest way to get access to the chipwhisperer module in MATLAB is to use this API. Run this command in MATLAB.
 <syntaxhighlight lang=matlab>
   >> [cw, scope, target] = cwconnect()
@@ Line 233: / Line 233: @@
 </syntaxhighlight>
-If this FAILS, you may need to simply unplug/replug the ChipWhisperer-Lite. You may have not closed the connection from the previous test.
+If this FAILS, you may need to simply unplug/replug the ChipWhisperer-Lite. You may not have closed the connection from the previous test.
 == Interfacing with AES ==

@@ Line 7: / Line 7: @@
 This system relies on the Mathworks Python interface, which is built in as of R2014B. See [https://www.mathworks.com/help/matlab/examples/call-python-from-matlab.html MathWorks Reference Page] for more details.
-The code is currently held in a separate repository at [https://github.com/newaetech/cw-apiexample1/tree/master/matlab]. You'll have to clone that repository (or use the download link inside of GITHub) to copy the files into your own local working directory.
+The code is currently held in a separate [https://github.com/newaetech/cw-apiexample1/tree/master/matlab repository]. You'll have to clone that repository (or use the download link inside of GITHub) to copy the files into your own local working directory.
 == Python/ChipWhisperer Setup ==

@@ Line 105: / Line 105: @@
 == Usage Notes ==
-Most of the capture parameters are set inside of the 'cwapi.py' Python file. For example sample rate is fixed at 4x the clock frequency, and the clock frequency is fixed at 7.37 MHz. However the sample offset from trigger & length of capture can be set on the call to 'cwconnect'. By default the CW-Lite starts recording at 1250 samples after the trigger (1250 / 4 = 312.5 target device clock cyles), and records for 3000 samples (3000 / 4 = 750 target device clock cycles). These are suitable for the example AES in C, but you may need to reduce the offset if running AES in assembly for example.
+By default the CW-Lite starts recording at 1250 samples after the trigger (1250 / 4 = 312.5 target device clock cyles), and records for 3000 samples (3000 / 4 = 750 target device clock cycles). These are suitable for the example AES in C, but you may need to reduce the offset if running AES in assembly for example.
 The ChipWhisperer-Lite has a maximum capture length of about 24000 samples. The maximum offset is 4294967294.

@@ Line 45: / Line 45: @@
 == Running Examples ==
+Since the new CW 4,0 API exposes the internals of chipwhisperer the easiest way to get access to the chipwhisperer module in MATLAB is to use this API. MATLAB seems to not find certain modules even if they are on the python path so just use pythons build in importlib, which MATLAB can find, letting python find the module for MATLAB. Running this command in MATLAB
-To run the examples, you will need to ensure you set the MATLAB working directory to the location of the .m script files. The following shows my example setup:
+<syntaxhighlight lang=matlab>
+  >> cw = py.importlib.import_module('chipwhisperer')
-[[File:api_matlab_path.png]]
+</syntaxhighlight>
+should give you access to the 4.0 API.
-The matlab files internally will reference a .py file in that same directory. You should be able to simply connect to the ChipWhisperer-Lite with the following:
-−
-  >> cw = cwconnect()
 If this works it should print the information about the 'cw' object:
+<syntaxhighlight>
   cw =
-   plot(trace)
+   Python module with properties:
-[[File:matlab_plot.png|400px]]
+             TargetTemplate: [1×1 py.type]
-You can run a number of measure_AES() calls with the same cw object without running cwconnect() again. Note if you want to reconnect, you will first need to run cw.disconnect() to close the USB connection.
+    <module 'chipwhisperer' from 'c:\chipwhisperer\software\chipwhisperer\__init__.pyc'>
-If you receive 'device in use' error messages, this is likely the problem. You can also simply unplug/replug the USB connection to force-close any existing connections.
+If this FAILS, you may need to simply unplug/replug the ChipWhisperer-Lite. You may have not closed the connection from the previous test. Note you can actually interact directly with the 'cw' as in Python, just as you would after running <code> import chipwhisperer as cw </code> in Python. So you can initialize a scope and a target like so:
 == Usage Notes ==

← Older revision		Revision as of 16:12, 1 March 2018
Line 1:		Line 1:
		+	{{Warningbox\|For the older V3.x tools, see [[V3:MATLAB Control of CW-Lite]]}}
		+
	The following is designed to demonstrate how to control the CW-Lite directly from MATLAB.		The following is designed to demonstrate how to control the CW-Lite directly from MATLAB.

← Older revision		Revision as of 01:50, 29 November 2016
Line 103:		Line 103:

	If you receive 'device in use' error messages, this is likely the problem. You can also simply unplug/replug the USB connection to force-close any existing connections.		If you receive 'device in use' error messages, this is likely the problem. You can also simply unplug/replug the USB connection to force-close any existing connections.
		+
		+	== Usage Notes ==
		+
		+	Most of the capture parameters are set inside of the 'cwapi.py' Python file. For example sample rate is fixed at 4x the clock frequency, and the clock frequency is fixed at 7.37 MHz. However the sample offset from trigger & length of capture can be set on the call to 'cwconnect'. By default the CW-Lite starts recording at 1250 samples after the trigger (1250 / 4 = 312.5 target device clock cyles), and records for 3000 samples (3000 / 4 = 750 target device clock cycles). These are suitable for the example AES in C, but you may need to reduce the offset if running AES in assembly for example.
		+
		+	The ChipWhisperer-Lite has a maximum capture length of about 24000 samples. The maximum offset is 4294967294.

@@ Line 55: / Line 55: @@
   cw =
-−
    Python CWCoreAPI with properties:
-−
                   sigNewProject: [1x1 py.chipwhisperer.common.utils.util.Signal]
                       valid_aux: [1x1 py.collections.OrderedDict]
@@ Line 80: / Line 80: @@
                 sigCampaignDone: [1x1 py.chipwhisperer.common.utils.util.Signal]
      valid_preprocessingModules: [1x1 py.collections.OrderedDict]
-−
      <chipwhisperer.common.api.CWCoreAPI.CWCoreAPI object at 0x000000013312FD30>
@@ Line 99: / Line 99: @@
 [[File:matlab_plot.png|400px]]

@@ Line 29: / Line 29: @@
    >> pyversion
-−
           version: ''
        executable: ''

← Older revision		Revision as of 01:43, 29 November 2016
Line 41:		Line 41:

	Where you will need to adjust the path for your local version/install. You can confirm with pyversion this worked. You shouldn't need to do any more setup now, it should remember this Python environment.		Where you will need to adjust the path for your local version/install. You can confirm with pyversion this worked. You shouldn't need to do any more setup now, it should remember this Python environment.
		+
		+	== Running Examples ==
		+
		+	To run the examples, you will need to ensure you set the MATLAB working directory to the location of the .m script files. The following shows my example setup:
		+
		+	[[File:api_matlab_path.png]]
		+
		+	The matlab files internally will reference a .py file in that same directory. You should be able to simply connect to the ChipWhisperer-Lite with the following:
		+
		+	>> cw = cwconnect()
		+
		+	If this works it should print the information about the 'cw' object:
		+
		+	cw =
		+
		+	Python CWCoreAPI with properties:
		+
		+	sigNewProject: [1x1 py.chipwhisperer.common.utils.util.Signal]
		+	valid_aux: [1x1 py.collections.OrderedDict]
		+	auxParam: [1x1 py.chipwhisperer.common.utils.parameter.Parameter]
		+	sigConnectStatus: [1x1 py.chipwhisperer.common.utils.util.Signal]
		+	sigNewTextResponse: [1x1 py.chipwhisperer.common.utils.util.Signal]
		+	valid_attacks: [1x1 py.collections.OrderedDict]
		+	sigTraceDone: [1x1 py.chipwhisperer.common.utils.util.Signal]
		+	traceParam: [1x1 py.chipwhisperer.common.utils.parameter.Parameter]
		+	executingScripts: [1x1 py.chipwhisperer.common.utils.util.Observable]
		+	scopeParam: [1x1 py.chipwhisperer.common.utils.parameter.Parameter]
		+	sigCampaignStart: [1x1 py.chipwhisperer.common.utils.util.Signal]
		+	sigNewInputData: [1x1 py.chipwhisperer.common.utils.util.Signal]
		+	params: [1x1 py.chipwhisperer.common.utils.parameter.Parameter]
		+	settings: [1x1 py.chipwhisperer.common.api.settings.Settings]
		+	valid_acqPatterns: [1x1 py.collections.OrderedDict]
		+	valid_scopes: [1x1 py.collections.OrderedDict]
		+	targetParam: [1x1 py.chipwhisperer.common.utils.parameter.Parameter]
		+	valid_traces: [1x1 py.collections.OrderedDict]
		+	valid_targets: [1x1 py.collections.OrderedDict]
		+	sigAttackChanged: [1x1 py.chipwhisperer.common.utils.util.Signal]
		+	sigCampaignDone: [1x1 py.chipwhisperer.common.utils.util.Signal]
		+	valid_preprocessingModules: [1x1 py.collections.OrderedDict]
		+
		+	<chipwhisperer.common.api.CWCoreAPI.CWCoreAPI object at 0x000000013312FD30>
		+
		+
		+	If this FAILS, you may need to simply unplug/replug the ChipWhisperer-Lite. You may have not closed the connection from the previous test. Note you can actually interact directly with the 'cw' object as in Python. For example we can get information about the current scope module:
		+
		+	>> cw.getScope()
		+
		+	But you probably just want to run an AES test. To do this, simply perform the following:
		+
		+	[cipher, trace] = measure_AES(cw, [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15],[0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15]);
		+
		+	The measure_AES() function passes both the plaintext and key. In this example they are both set to the same array value. It returns the ciphertext resulting & the power trace.
		+
		+	You can plot this power trace with:
		+
		+	plot(trace)
		+
		+	[[File:matlab_plot.png\|400px]]