Initial Commit

Author: emilmont

.gitignore

@@ -1,5 +1,13 @@
 *.py[cod]
 
+# Private settings
+private_settings.py
+
+# Eclipse Project Files
+.cproject
+.project
+.pydevproject
+
 # C extensions
 *.so
 
@@ -34,3 +42,4 @@ nosetests.xml
 .mr.developer.cfg
 .project
 .pydevproject
+*.bak

README.md

@@ -1,4 +1,157 @@
 pyOCD
 =====
+pyOCD is an Open Source python library or programming and debugging 
+ARM Cortex-M microcontrollers using CMSIS-DAP.
 
-Open source python library for programming and debugging ARM Cortex-M microcontrollers using CMSIS-DAP
+You can use the following interfaces:
+
+1. From a python interpretor:
+  * halt, step, resume execution
+  * read/write memory
+  * read/write block memory
+  * read-write core register
+  * set/remove hardware breakpoints
+  * flash new binary
+  * reset
+2. From a GDB client, you have all the features provided by gdb:
+  * load a .elf file
+  * read/write memory
+  * read/write core register
+  * set/remove hardware breakpoints
+  * high level stepping
+  * ...
+
+Dependencies
+------------
+pyOCD relies on external libraries:
+
+* Windows: [pyWinUSB](https://github.com/rene-aguirre/pywinusb):
+
+```
+$ cd /path-to-pywinusb/
+$ python setup.py install
+```
+
+* Linux: [pyUSB](https://github.com/walac/pyusb):
+
+```
+$ sudo apt-get install python libusb-1.0-0-dev
+$ cd /path-to-pyusb/
+$ sudo python setup.py install
+```
+
+* Mac:
+    So far Mac OS X is not supported
+    
+    
+Installation
+------------
+```
+$ cd /path-to-pyOCD/
+$ python setup.py install
+```
+    
+Examples
+--------
+### Tests
+A series of tests are on the test directory:
+* basic_test.py: simple test that checks:
+  * read/write core registers
+  * read/write memory
+  * stop/resume/step the execution
+  * reset the target
+  * flash a binary
+* gdb_test.py: launch a gdbserver
+
+### Hello World example
+```python
+from pyOCD.board import MbedBoard
+
+import logging
+logging.basicConfig(level=logging.INFO)
+
+board = MbedBoard.chooseBoard()
+
+target = board.target
+flash = board.flash
+target.resume()
+target.halt()
+
+print "pc: 0x%X" % target.readCoreRegister("pc")
+    pc: 0xA64
+
+target.step()
+print "pc: 0x%X" % target.readCoreRegister("pc")
+    pc: 0xA30
+
+target.step()
+print "pc: 0x%X" % target.readCoreRegister("pc")
+   pc: 0xA32
+
+flash.flashBinary("binaries/l1_lpc1768.bin")
+print "pc: 0x%X" % target.readCoreRegister("pc")
+   pc: 0x10000000
+
+target.reset()
+target.halt()
+print "pc: 0x%X" % target.readCoreRegister("pc")
+   pc: 0xAAC
+
+board.uninit()
+```
+
+###GDB server example
+Python:
+```python
+from pyOCD.gdbserver import GDBServer
+from pyOCD.board import MbedBoard
+
+import logging
+logging.basicConfig(level=logging.INFO)
+
+board = MbedBoard.chooseBoard()
+
+# start gdbserver
+gdb = GDBServer(board, 3333)
+```
+gdb server:
+```
+arm-none-eabi-gdb basic.elf
+
+<gdb> target remote localhost:3333
+<gdb> load
+<gdb> continue
+
+```
+
+Architecture
+------------
+
+### Interface
+An interface does the link between the target and the computer.
+This module contains basic functionalities to write and read data to and from
+an interface. You can inherit from ```Interface``` and overwrite ```read()```, ```write()```,...
+
+Then declare your interface in ```INTERFACE``` (in ```pyOCD.interface.__init__.py```)
+
+### Target
+A target defines basic functionalities such as ```step```, ```resume```, ```halt```, ```readMemory```,...
+You can inherit from Target to implement your own methods.
+
+Then declare your target in TARGET (in ```pyOCD.target.__init__.py```)
+
+### Transport
+Defines the transport used to communicate. In particular, you can find CMSIS-DAP. 
+Implements methods such as ```memWriteAP```, ```memReadAP```, ```writeDP```, ```readDP```, ...
+
+You can inherit from ```Transport``` and implement your own methods.
+Then declare your transport in ```TRANSPORT``` (in ```pyOCD.transport.__init__.py```)
+
+### Flash
+Contains flash algorithm in order to flash a new binary into the target.
+
+### gdbserver
+Start a GDB server. The server listens on a specific port. You can then
+connect a GDB client to it and debug/program the target
+
+Then you can debug a board which is composed by an interface, a target, a transport and a flash

__init__.py

@@ -0,0 +1,16 @@
+"""
+ mbed CMSIS-DAP debugger
+ Copyright (c) 2006-2013 ARM Limited
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+"""

binaries/l1_kl25z.bin

@@ -0,0 +1,16 @@
+"""
+ mbed CMSIS-DAP debugger
+ Copyright (c) 2006-2013 ARM Limited
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+"""

binaries/l1_lpc11u24.bin

@@ -0,0 +1,18 @@
+"""
+ mbed CMSIS-DAP debugger
+ Copyright (c) 2006-2013 ARM Limited
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+"""
+
+from mbed_board import MbedBoard

binaries/l1_lpc1768.bin

@@ -0,0 +1,60 @@
+"""
+ mbed CMSIS-DAP debugger
+ Copyright (c) 2006-2013 ARM Limited
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+"""
+
+from pyOCD.target import TARGET
+from pyOCD.transport import TRANSPORT
+from pyOCD.interface import INTERFACE
+from pyOCD.flash import FLASH
+
+import logging
+
+class Board():
+    """
+    This class associates a target, a flash, a transport and an interface
+    to create a board
+    """
+    def __init__(self, target, flash, interface, transport = "cmsis_dap"):
+        if isinstance(interface, str) == False:
+            self.interface = interface
+        else:
+            self.interface = INTERFACE[interface].chooseInterface(INTERFACE[interface])
+        self.transport = TRANSPORT[transport](self.interface)
+        self.target = TARGET[target](self.transport)
+        self.flash = FLASH[flash](self.target)
+        return
+    
+    def init(self):
+        """
+        Initialize the board: interface, transport and target
+        """
+        logging.debug("init board %s", self)
+        self.interface.init()
+        self.transport.init()
+        self.target.init()
+        
+    def uninit(self):
+        """
+        Uninitialize the board: inetrface, transport and target.
+        This function resets the target
+        """
+        logging.debug("uninit board %s", self)
+        self.target.resume()
+        self.transport.uninit()
+        self.interface.close()
+    
+    def getInfo(self):
+        return self.interface.getInfo()