458
edits
| As of August 2020 the site you are on (wiki.newae.com) is deprecated, and content is now at rtfm.newae.com. |
Changes
Changed header levels
==Adding New Modules==
In the new CW plugin architecture, all modules are scanned during the tool initialization, so new functionalities can be added by just dropping its file inside the respective folder:
These paths are checked both inside the tool's root directory (where the tool is installed), and in the Project Folder (default is ~/chipwhisperer_projects), allowing the usage of custom modules without the requirement of being system administer. The CW tools scan these directories looking for classes that inherits from the ''Plugin'' class (a marker interface actually) in each public module (that doesn't begin with "_").
'''IMPORTANT''': Accessing "Help->List Enabled/Disabled Plugins" in the tool's menu you'll find a list with all modules it tried to load. In case of any problem, you can check in the table the error message and its details.It should be easier to visuallise if you copy and paste the text cell cotent to a text editor (example: notepad).
These folders usually have a file called ''base.py'' or ''_base.py'' that contains the base class to all plugins in these directories. Ex.:
</pre>
==Adding Parameters==
Parameters are used to allow easy access and manipulation of all object's main attibutes and actions. All parameters can be accessed anywhere in the code throught the Parameter class. It means that if you want to set/get any parameter, you can do it easily adding the follow lines to your code:
@setupSetParam("Save Raw Results")
def setEnabled(self, enabled):
self._enabled = enabled</pre> === What to tweak? === ==== acq_patterns ====Has the modules that generate the keys. If you want to generate custom key or plaintext sequences, or read it from a file, this is the place to go. ==== auxiliary ====Usefull if you want to execute something before, during or after the capture. Exemple ([http://newae.com/forum/viewtopic.php?f=7&t=202#p1026 provided by GABRIEL_F]): import logging import time from chipwhisperer.capture.auxiliary._base import AuxiliaryTemplate from chipwhisperer.common.api.CWCoreAPI import CWCoreAPI from chipwhisperer.common.utils import util, timer class SerialBeforeArm(AuxiliaryTemplate): <nowiki>'''</nowiki> This auxillary module allows for serial data to be sent to the target during the capture process i.e., before and after arming the scope and after the trace has recorded. This enables the ability for the scope to trigger on serial communication that need to start after a reset but before the scope is armed and after. Compare to SimpleSerial send Go Command. TODO: Parser to chop up multiple commands sent in single string seperated by whitespace. Modify to iterate over returned lists. Uses non-blocking sleep methods poached from ResetCW1173Read. <br> Gabe 25-NOV-16 <nowiki>'''</nowiki> _name = "Send Serial During Capture"<br> def __init__(self): AuxiliaryTemplate.__init__(self) self.getParams().addChildren([ {'name':'Pre-Arm Message', 'type':'str', 'key':'prearmmssg', 'value':''},'' {'name':'Post-Arm Message', 'type':'str', 'key':'postarmmssg', 'value':''},'' {'name':'Post-Capture Message', 'type':'str', 'key':'postcapmssg', 'value':''},'' {'name':'Delay (Pre-Message)' , 'type':'int', 'key':'predelay', 'limits':(0, 10E3), 'value':0, 'suffix':' ms'}, {'name':'Delay (Post-Message)', 'type':'int', 'key':'postdelay', 'limits':(0, 10E3), 'value':0, 'suffix':' ms'}, {'name':'Test Reset', 'type':'action', 'action':self.testSend} ]) def traceArm(self): """Before arming the scope, send some serial messages and wait""" string = self.findParam('prearmmssg').getValue() self.sendSerial(string) def traceArmPost(self): """After arming the scope, send some serial message and wait""" string = self.findParam('postarmmssg').getValue() self.sendSerial(string) def traceDone(self): """After the trace is captured, send some serial messages and wait""" string = self.findParam('postcapmssg').getValue() self.sendSerial(string) def sendSerial(self, string): """Send a string!""" if string is None or len(string) == 0: return dly = self.findParam('predelay').getValue() if dly > 0: self.nonblockingSleep(dly / 1000.0) CWCoreAPI.getInstance().getTarget().ser.write(string) dly = self.findParam('postdelay').getValue() if dly > 0: self.nonblockingSleep(dly / 1000.0) def nonblockingSleep_done(self): self._sleeping = False def nonblockingSleep(self, stime): """Sleep for given number of seconds (~50mS resolution), but don't block GUI while we do it""" timer.Timer.singleShot(stime * 1000, self.nonblockingSleep_done) self._sleeping = True while(self._sleeping): time.sleep(0.01) util.updateUI() def testSend(self, _=None): self.sendSerial('Hello')
