mirrors/unleashed-firmware
1
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-12 04:34:43 +04:00
Code Issues Activity

Debug: revert cortex debug to lxml and drop DWT (#2651)

Browse Source 
* Debug: revert cortex debug to lxml

* Debug: update PyCortexMDebug readme

* fbt: moved "debug" dir to "scripts" subfolder

* ufbt: added missing debug_other & debug_other_blackmagic targets; github: fixed script bundling

* lint: fixed formatting on debug scripts

* vscode: updated configuration for debug dir changes

---------

Co-authored-by: hedger <hedger@users.noreply.github.com>
Co-authored-by: hedger <hedger@nanode.su>
This commit is contained in:
あく
2023-05-09 08:31:44 +09:00
committed by GitHub
parent 241b4ef6e4
commit f57f0efc48
32 changed files with 113 additions and 898 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
scripts/debug/FreeRTOS/FreeRTOS.py Normal file
View File

@@ -0,0 +1,106 @@
# File: FreeRTOS.py
# Author: Carl Allendorph
# Date: 05NOV2014
#
# Description:
# This file contains some python code that utilizes the GDB API
# to inspect information about the FreeRTOS internal state. The
# idea is to provide the user with the ability to inspect information
# about the tasks, queues, mutexs, etc.
#
from os import path
import sys
directory, file = path.split(__file__)
directory = path.expanduser(directory)
directory = path.abspath(directory)
sys.path.append(directory)
import gdb
import pprint
from FreeRTOSgdb.Types import StdTypes
from FreeRTOSgdb.List import ListInspector
from FreeRTOSgdb.GDBCommands import ShowHandleName, ShowRegistry, ShowList
from FreeRTOSgdb.GDBCommands import ShowQueueInfo
class Scheduler:
def __init__(self):
self._blocked = ListInspector("xSuspendedTaskList")
self._delayed1 = ListInspector("xDelayedTaskList1")
self._delayed2 = ListInspector("xDelayedTaskList2")
self._readyLists = []
readyTasksListsStr = "pxReadyTasksLists"
readyListsSym, methodType = gdb.lookup_symbol(readyTasksListsStr)
if readyListsSym != None:
readyLists = readyListsSym.value()
minIndex, maxIndex = readyLists.type.range()
for i in range(minIndex, maxIndex + 1):
readyList = readyLists[i]
FRReadyList = ListInspector(readyList)
self._readyLists.append(FRReadyList)
else:
print("Failed to Find Symbol: %s" % readyTasksListsStr)
raise ValueError("Invalid Symbol!")
def ShowTaskList(self):
self.PrintTableHeader()
for i, rlist in enumerate(self._readyLists):
if i == 0:
items = rlist.GetElements("TCB_t", 0)
else:
items = rlist.GetElements("TCB_t", 1)
if len(items) > 0:
print("Ready List {%d}: Num Tasks: %d" % (i, len(items)))
for tcb, val in items:
self.PrintTaskFormatted(tcb)
items = self._blocked.GetElements("TCB_t")
print("Blocked List: Num Tasks: %d" % len(items))
for tcb, val in items:
self.PrintTaskFormatted(tcb)
items = self._delayed1.GetElements("TCB_t")
print("Delayed {1}: Num Tasks: %d" % len(items))
for tcb, val in items:
self.PrintTaskFormatted(tcb, val)
items = self._delayed2.GetElements("TCB_t")
print("Delayed {2}: Num Tasks: %d" % len(items))
for tcb, val in items:
self.PrintTaskFormatted(tcb, val)
def PrintTableHeader(self):
print("%16s %3s %4s" % ("Name", "PRI", "STCK"))
def PrintTaskFormatted(self, task, itemVal=None):
topStack = task["pxTopOfStack"]
stackBase = task["pxStack"]
highWater = topStack - stackBase
taskName = task["pcTaskName"].string()
taskPriority = task["uxPriority"]
if itemVal != None:
print("%16s %3s %4s %5s" % (taskName, taskPriority, highWater, itemVal))
else:
print("%16s %3s %4s" % (taskName, taskPriority, highWater))
class ShowTaskList(gdb.Command):
"""Generate a print out of the current tasks and their states."""
def __init__(self):
super(ShowTaskList, self).__init__("show Task-List", gdb.COMMAND_SUPPORT)
def invoke(self, arg, from_tty):
sched = Scheduler()
sched.ShowTaskList()
ShowRegistry()
ShowList()
ShowTaskList()
ShowHandleName()
ShowQueueInfo()

29
scripts/debug/FreeRTOS/FreeRTOSgdb/EventGroup.py Normal file
View File

@@ -0,0 +1,29 @@
# File: EventGroup.py
# Author: Carl Allendorph
# Date: 05NOV2014
#
# Description:
# This file contains the implementation of a Event Group Inspector
import gdb
from .List import ListInspector
from .Task import TaskInspector
class EventGroupInspector:
EvtGrpType = gdb.lookup_type("EventGroup_t")
def __init__(self, handle):
self._evtgrp = gdb.Value(handle).cast(EventGroupInspector.EvtGrpType)
def GetTasksWaiting(self):
taskListObj = self._evtgrp["xTasksWaitingForBits"]
taskList = ListInspector(taskListObj)
return taskList.GetElements(TaskInspector.TCBType)
def GetEventBits(self):
"""Get the Event Flag Bits
@return L{gdb.Value} of EventBits_t
"""
return self._evtgrp["uxEventBits"]

138
scripts/debug/FreeRTOS/FreeRTOSgdb/GDBCommands.py Normal file
View File

@@ -0,0 +1,138 @@
# File: GDBCommands.py
# Author: Carl Allendorph
# Date: 05NOV2014
#
# Description:
# This file contains the implementation of some custom
# GDB commands for Inspecting the FreeRTOS state
import gdb
from .List import ListInspector
from .Task import TaskInspector
from .HandleRegistry import HandleRegistry
from .QueueTools import *
class ShowQueueInfo(gdb.Command):
"""Generate a print out of info about a particular
set of queues.
"""
def __init__(self):
super(ShowQueueInfo, self).__init__("show Queue-Info", gdb.COMMAND_SUPPORT)
def invoke(self, arg, from_tty):
argv = gdb.string_to_argv(arg)
qTypes = []
if len(argv) > 0:
for a in argv:
try:
qType = QueueMode.Map[a]
qTypes.append(qType)
except KeyError:
print("Arg %s does not map to a Queue Type!" % a)
reg = HandleRegistry()
qToShow = []
if len(qTypes) > 0:
# We will only print info about queues
for qType in qTypes:
qObjs = reg.FilterBy(qType)
qToShow.extend(qObjs)
else:
qToShow = reg.FilterBy(None)
print("Num Queues: %d" % len(qToShow))
print("%20s %4s %16s %16s" % ("NAME", "CNT", "SEND", "RECEIVE"))
for q in qToShow:
self.PrintQueueInfo(q)
def PrintQueueInfo(self, q):
"""Print Info about the Queue"""
sendList = q.GetTasksWaitingToSend()
rxList = q.GetTasksWaitingToReceive()
# print("TxLen: %d, RxLen: %d" % (len(sendList), len(rxList)))
maxCount = max(len(sendList), len(rxList))
outputFmt = "%20s %4s %16s %16s"
if maxCount == 0:
print(outputFmt % (q.GetName(), q.GetQueueMessagesWaiting(), "", ""))
else:
for i in range(0, maxCount):
txName = ""
if i < len(sendList):
tcbRef, val = sendList[i]
tcb = TaskInspector(tcbRef)
txName = tcb.GetName()
rxName = ""
if i < len(rxList):
tcbRef, val = rxList[i]
tcb = TaskInspector(tcbRef)
rxName = tcb.GetName()
if i == 0:
print(
outputFmt
% (q.GetName(), q.GetQueueMessagesWaiting(), txName, rxName)
)
else:
print(outputFmt % ("", "", txName, rxName))
class ShowHandleName(gdb.Command):
"""Generate a print out of the handle by name"""
def __init__(self):
super(ShowHandleName, self).__init__("show Handle-Name", gdb.COMMAND_SUPPORT)
def invoke(self, arg, from_tty):
argv = gdb.string_to_argv(arg)
if len(argv) != 1:
print("Invalid Argument: Requires one handle arg")
handle = int(argv[0], 0)
reg = HandleRegistry()
name = reg.GetName(handle)
print("Handle 0x%08x: %s" % (handle, name))
class ShowRegistry(gdb.Command):
"""Generate a print out of the queue handle registry"""
def __init__(self):
super(ShowRegistry, self).__init__("show Handle-Registry", gdb.COMMAND_SUPPORT)
def invoke(self, arg, from_tty):
reg = HandleRegistry()
reg.PrintRegistry()
class ShowList(gdb.Command):
"""Generate a print out of the elements in a list
passed to this command. User must pass a symbol that
will be looked up.
"""
def __init__(self):
super(ShowList, self).__init__(
"show List-Handle", gdb.COMMAND_SUPPORT, gdb.COMPLETE_SYMBOL
)
def invoke(self, arg, from_tty):
argv = gdb.string_to_argv(arg)
CastTypeStr = None
if len(argv) > 0:
symbolArg = argv[0]
if len(argv) > 1:
CastTypeStr = argv[1]
listVal = ListInspector(symbolArg)
elems = listVal.GetElements(CastTypeStr)
for elem in elems:
print("Elem: %s" % str(elem))

83
scripts/debug/FreeRTOS/FreeRTOSgdb/HandleRegistry.py Normal file
View File

@@ -0,0 +1,83 @@
# File: HandleRegistry.py
# Author: Carl Allendorph
# Date: 06NOV2014
#
# Description:
# THis file contains the implementation of a class for accessing the
# handle registry. This contains a mapping of queue handles to
# strings for labeling purposes.
import gdb
from .Types import StdTypes
from .QueueTools import *
class HandleRegistry:
"""The FreeRTOS system can be configured with a table that
associates a name with a QueueHandle_t.
This class can be used to access this table and
label queue/mutex/semaphore/event groups
"""
def __init__(self, regSymbol="xQueueRegistry"):
symbol, methodObj = gdb.lookup_symbol(regSymbol)
self._registry = symbol.value()
self._minIndex = 0
self._maxIndex = 0
self._minIndex, self._maxIndex = self._registry.type.range()
def GetName(self, handle):
"""Find the string name associated with a queue
handle if it exists in the registry
"""
for i in range(self._minIndex, self._maxIndex):
elem = self._registry[i]
h = elem["xHandle"]
val = h.cast(StdTypes.uint32_t)
if handle == val:
print("Found Entry for: %x" % handle)
name = elem["pcQueueName"].string()
return name
def PrintRegistry(self):
for i in range(self._minIndex, self._maxIndex):
elem = self._registry[i]
h = elem["xHandle"]
if h != 0:
name = elem["pcQueueName"].string()
print("%d: %3s %16s" % (i, h, name))
def FilterBy(self, qMode):
"""Retrieve a List of Mutex Queue Handles"""
resp = []
for i in range(self._minIndex, self._maxIndex):
elem = self._registry[i]
h = elem["xHandle"]
if h != 0:
name = elem["pcQueueName"].string()
q = QueueInspector(h)
q.SetName(name)
if qMode != None:
qType = q.GetQueueType()
if qType != None:
if qType == qMode:
resp.append(q)
else:
print("qType == None")
else:
resp.append(q)
return resp
def GetMutexes(self):
"""Retrieve all the Mutex Objects in the Handle Registry"""
return self.FilterBy(QueueMode.MUTEX)
def GetSemaphores(self):
"""Retrieve all the Semaphore Objects in the Handle Registry"""
return self.FilterBy(QueueMode.BINARY)
def GetQueues(self):
"""Retrieve all the Queue Objects in the Handle Registry"""
return self.FilterBy(QueueMode.QUEUE)

100
scripts/debug/FreeRTOS/FreeRTOSgdb/List.py Normal file
View File

@@ -0,0 +1,100 @@
# File: List.py
# Author: Carl Allendorph
# Date: 05NOV2014
#
# Description:
# This file contains the class for inspecting
# a FreeRTOS List Object
#
import gdb
from .Types import StdTypes
class ListInspector:
"""FreeRTOS List Inspector Object"""
ListType = gdb.lookup_type("List_t")
def __init__(self, handle):
self._list = None
# print("List: Handle: %s" % handle)
self.Assign(handle)
def Assign(self, listObj):
try:
if listObj.type == ListInspector.ListType:
self._list = listObj
return
else:
raise TypeError("Invalid List Object Type!")
except Exception as exc:
# print(" Failed to assign from List object: %s" % str(exc))
pass
symbol, methodObj = gdb.lookup_symbol(listObj)
if symbol != None:
self._list = symbol.value()
else:
addrInt = int(listObj, 0)
listObjPtr = gdb.Value(addrInt).cast(ListInspector.ListType.pointer())
self._list = listObjPtr.dereference()
def GetElements(self, CastTypeStr=None, startElem=1):
"""Get the Elements of the list as an array of
gdb.Value type objects.
@param CastTypeStr string name of the type of object that
we will cast the void *pvOwner elements of the list to.
User can also pass a L{gdb.Type} object as the type
If None, we will simply cast to uint32_t and print these
as hex values.
@param startElem This is a flag to indicate whether
we will start getting elements starting at 0 or 1. Note
that this is to deal with some non-consistent behavior
of some of the TCB Task lists.
"""
if self._list != None:
CastType = None
if CastTypeStr != None:
if type(CastTypeStr) == str:
try:
CastType = gdb.lookup_type(CastTypeStr).pointer()
except:
print("Failed to find type: %s" % CastTypeStr)
elif type(CastTypeStr) == gdb.Type:
CastType = CastTypeStr.pointer()
resp = []
numElems = self._list["uxNumberOfItems"]
# print("List Elements: %d" % numElems)
index = self._list["pxIndex"]
if numElems > 0 and numElems < 200:
if startElem == 0:
curr = index
else:
curr = index["pxPrevious"]
for i in range(0, numElems):
owner = curr["pvOwner"]
ownerObj = None
if CastType != None:
castObjPtr = owner.cast(CastType)
castObj = castObjPtr.dereference()
ownerObj = castObj
else:
ownerUInt = owner.cast(StdTypes.uint32_t)
ownerObj = ownerUInt
itemVal = curr["xItemValue"]
resp.append((ownerObj, itemVal.cast(StdTypes.uint32_t)))
curr = curr["pxPrevious"]
return resp
else:
raise ValueError("Invalid List Object - Possibly Failed to Initialize!")

108
scripts/debug/FreeRTOS/FreeRTOSgdb/QueueTools.py Normal file
View File

@@ -0,0 +1,108 @@
# File: Queue.py
# Author: Carl Allendorph
# Date: 05NOV2014
#
# Description:
# This file contains the implementation of a Queue Inspector
# class.
#
import gdb
from .List import ListInspector
from .Task import TaskInspector
class QueueMode:
QUEUE = 0
MUTEX = 1
COUNTING = 2
BINARY = 3
RECURSIVE = 4
Map = None
@staticmethod
def IsValid(qType):
if (
qType == QueueMode.QUEUE
or qType == QueueMode.MUTEX
or qType == QueueMode.COUNTING
or qType == QueueMode.BINARY
or qType == QueueMode.RECURSIVE
):
return True
else:
return False
QueueMap = {
"mutex": QueueMode.MUTEX,
"queue": QueueMode.QUEUE,
"semaphore": QueueMode.BINARY,
"counting": QueueMode.COUNTING,
"recursive": QueueMode.RECURSIVE,
}
QueueMode.Map = QueueMap
class QueueInspector:
QueueType = gdb.lookup_type("Queue_t")
def __init__(self, handle):
# print("Queue: Handle: %s" % handle)
self.name = None
queueObjPtr = None
if type(handle) == gdb.Value:
queueObjPtr = handle.cast(QueueInspector.QueueType.pointer())
self._queue = queueObjPtr.dereference()
else:
queueObjPtr = gdb.Value(handle).cast(QueueInspector.QueueType.pointer())
self._queue = queueObjPtr.dereference()
def GetName(self):
return self.name
def SetName(self, name):
self.name = name
def GetTasksWaitingToSend(self):
"""Retrieve a list of gdb.Value objects of type
TCB that are the tasks that are currently waiting to
send data on this queue object.
"""
sendList = ListInspector(self._queue["xTasksWaitingToSend"])
return sendList.GetElements(TaskInspector.TCBType)
def GetTasksWaitingToReceive(self):
"""Retrieve a list of gdb.Value objects of Type
TCB that are the tasks that are currently waiting to
receive data on this queue object.
"""
rxList = ListInspector(self._queue["xTasksWaitingToReceive"])
return rxList.GetElements(TaskInspector.TCBType)
def GetQueueMessagesWaiting(self):
"""Return the number of messages waiting as a
L{gdb.Value} object
"""
return self._queue["uxMessagesWaiting"]
def GetQueueType(self):
"""Return the Type of the Queue as a enumerated number"""
try:
qType = self._queue["ucQueueType"]
if QueueMode.IsValid(int(qType)):
return qType
else:
raise ValueError(
"Invalid Queue Type In Queue Object! Are you sure this is a Queue Handle?"
)
except Exception as exc:
# If the TRACE functionality of the RTOS is not enabled,
# then the queue type will not be availabe in the queue
# handle - so we return None
print("Failed to get Type: %s" % str(exc))
return None

62
scripts/debug/FreeRTOS/FreeRTOSgdb/Task.py Normal file
View File

@@ -0,0 +1,62 @@
# File: Task.py
# Author: Carl Allendorph
# Date: 05NOV2014
#
# Description:
# This file contains the implementation of a class to use for
# inspecting the state of a FreeRTOS Task in GDB
#
import gdb
class TaskInspector:
TCBType = gdb.lookup_type("TCB_t")
def __init__(self, handle):
self._tcb = None
# print("Task: Pass Handle: %s" % str(handle))
try:
if handle.type == TaskInspector.TCBType:
self._tcb = handle
return
else:
print("Handle Type: %s" % str(handle.type))
except AttributeError as aexc:
print("Attribute Error: %s" % str(aexc))
pass
except Exception as exc:
print("Error Initializing Task Inspector: %s" % str(exc))
raise
try:
tcbPtr = gdb.Value(handle).cast(TaskInspector.TCBType.pointer())
self._tcb = tcbPtr.dereference()
return
except Exception as exc:
print("Failed to convert Handle Pointer: %s" % str(handle))
self._tcb = handle
def GetName(self):
if self._tcb != None:
return self._tcb["pcTaskName"].string()
else:
raise ValueError("Invalid TCB")
def GetPriority(self):
if self._tcb != None:
return self._tcb["uxPriority"]
else:
raise ValueError("Invalid TCB")
def GetStackMargin(self):
if self._tcb != None:
topStack = self._tcb["pxTopOfStack"]
stackBase = self._tcb["pxStack"]
highWater = topStack - stackBase
return highWater
else:
raise ValueError("Invalid TCB")

14
scripts/debug/FreeRTOS/FreeRTOSgdb/Types.py Normal file
View File

@@ -0,0 +1,14 @@
# File: Types.py
# Author: Carl Allendorph
# Date: 05NOV2014
#
# Description:
# This file contains the implementation of some
# standard types
import gdb
class StdTypes:
uint32_t = gdb.lookup_type("uint32_t")
uint16_t = gdb.lookup_type("uint16_t")

0
scripts/debug/FreeRTOS/FreeRTOSgdb/__init__.py Normal file
View File

340
scripts/debug/FreeRTOS/LICENSE Normal file
View File

@@ -0,0 +1,340 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
{description}
Copyright (C) {year} {fullname}
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
{signature of Ty Coon}, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

120
scripts/debug/FreeRTOS/README.md Normal file
View File

@@ -0,0 +1,120 @@
FreeRTOS-GDB
============
Python API Library for inspecting FreeRTOS Objects in GDB
Basically, the FreeRTOS internal state is kind of hard to inspect
when working with GDB. This project provides some scripts for GDB's
Python API that make accessing some of these internals a little easier
to inspect.
##Requirements:
1. You need to have the python API enabled in your version of GDB. This is a
compile time option when building GDB. You should be able to do something
like this:
```
gdb> python print "Hello World"
```
and get predictable results. If it throws an error - then you don't have
python compiled in your version of GDB.
2. Need to be using FreeRTOS 8.0+. This code could probably be used with FreeRTOS
version 7.0 or previous versions, but the current code doesn't support it.
3. You need to use the Handle Registry for Queue info to be any use.
Note that this only works for Queue based objects and not
for EventGroups
4. You need to put the FreeRTOS-GDB/src directory on your python path:
```
$> export PYTHONPATH=~/src/FreeRTOS-GDB/src/
```
How To Use:
```
$> gdb ./bin/program.elf
(gdb) c
Program runs on embedded device, sets up tasks, and queues
<Break>
(gdb) source ~/FreeRTOS-GDB/src/FreeRTOS.py
(gdb) show Task-List
Name PRI STCK
Ready List {0}: Num Tasks: 1
IDLE 0 107
Blocked List: Num Tasks: 11
EMAC Task 1 239
AFEC0 Task 1 295
LDSENS Task 1 195
AFEC1 Task 1 295
LineSample Task 1 281
DMAUART0 1 225
Log Task 1 273
BAT Task 1 169
Rx Task 1 421
Mng Task 2 551
Cell Task 1 275
Delayed {1}: Num Tasks: 5
Tmr Svc 3 355 62254
WLAN Task 1 205 13817
Init Task 1 445 10015
LED Task 1 179 7105
DMACOM1 1 265 7065
Delayed {2}: Num Tasks: 0
(gdb) show Queue-Info mutex
Num Queues: 6
NAME CNT SEND RECEIVE
LOG:LOCK 1 NONE NONE
STREAM:LOCK 1 NONE NONE
TWI:MUTEX 1 NONE NONE
CC3000:LOCK 1 NONE NONE
WLAN:LOCK 0 NONE NONE
SPI:LOCK 1 NONE NONE
(gdb) show Queue-Info queue
Num Queues: 14
NAME CNT SEND RECEIVE
TmrQ 0 Tmr Svc
LOG:MSGPOOL 12 NONE NONE
LOG:MSGQ 0 Log Task
TWI:QUEUE 0 NONE NONE
SPI:QUEUE 0 NONE NONE
DMAAFEC:POOL 1 NONE NONE
DMAAFEC:QUEUE 0 AFEC0 Task
DMAAFEC:POOL 1 NONE NONE
DMAAFEC:QUEUE 0 AFEC1 Task
COM:TXPOOL 3 NONE NONE
COM:TXQ 0 NONE NONE
COM:RXPOOL 5 NONE NONE
COM:RXQ 0 NONE NONE
FATFS:MUTEX 0 NONE NONE
```
@note - the NONE's above may just be empty strings.
This code adds the following custom GDB commands:
* show List-Handle (symbol|address) [CastType]
CastType is an optional argument that will cast all of the
handles in a list to a particular type.
* show Task-List
* show Handle-Registry
* show Handle-Name (symbole|address)
* show Queue-Info [filter]
filter can be "queue","mutex","semaphore", "counting", "recursive"
@TODO
=====
* With GDB's Python API - it doesn't seem to handle code is separate
files very well.
* Currently, the EventGroup objects don't have an inspector.
Work in progress - ideal solution would likely modify the struct
of the Event Group to provide a similar piece of info that the
Queue handle does so that we could use the same registry.

674
scripts/debug/PyCortexMDebug/LICENSE Normal file
View File

@@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
PyCortexMDebug
Copyright (C) 2013 Ben Nahill <bnahill@gmail.com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
PyCortexMDebug Copyright (C) 2013 Ben Nahill <bnahill@gmail.com>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

32
scripts/debug/PyCortexMDebug/PyCortexMDebug.py Normal file
View File

@@ -0,0 +1,32 @@
""" Simple script to load from GDB to import all components
===============================================================================
This file is part of PyCortexMDebug
PyCortexMDebug is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
PyCortexMDebug is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with PyCortexMDebug. If not, see <http://www.gnu.org/licenses/>.
"""
from os import path
import sys
directory, file = path.split(__file__)
directory = path.expanduser(directory)
directory = path.abspath(directory)
sys.path.append(directory)
from cmdebug.svd_gdb import LoadSVD
LoadSVD()

35
scripts/debug/PyCortexMDebug/README.md Normal file
View File

@@ -0,0 +1,35 @@
PyCortexMDebug
==============
## SVD
ARM defines an SVD (System View Description) file format in its CMSIS standard as a means for Cortex-M-based chip manufacturers to provide a common description of peripherals, registers, and register fields. You can download SVD files for different manufacturers [here](http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php).
The implementation consists of two components -- An lxml-based parser module (pysvd) and a GDB file (gdb_svd). I haven't yet worked out a perfect workflow for this, though it's quite easy to use when you already tend to have a GDB initialization file for starting up OpenOCD and the like. However your workflow works, just make sure to, in GDB:
source gdb_svd.py
svd_load [your_svd_file].svd
These files can be huge so it might take a second or two. Anyways, after that, you can do
svd
to list available peripherals with descriptions. Or you can do
svd [some_peripheral_name]
to see all of the registers (with their values) for a given peripheral. For more details, run
svd [some_peripheral_name] [some_register_name]
to see all of the field values with descriptions.
You can add format modifiers like:
* `svd/x` will display values in hex
* `svd/o` will display values in octal
* `svd/t` or `svd/b` will display values in binary
* `svd/a` will display values in hex and try to resolve symbols from the values
All field values are displayed at the correct lengths as provided by the SVD files.
Also, tab completion exists for nearly everything! When in doubt, run `svd help`.

0
scripts/debug/PyCortexMDebug/cmdebug/__init__.py Executable file
View File

448
scripts/debug/PyCortexMDebug/cmdebug/svd.py Executable file
View File

@@ -0,0 +1,448 @@
#!/usr/bin/env python
"""
This file is part of PyCortexMDebug
PyCortexMDebug is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
PyCortexMDebug is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with PyCortexMDebug. If not, see <http://www.gnu.org/licenses/>.
"""
import lxml.objectify as objectify
import sys
from collections import OrderedDict
import os
import pickle
import traceback
import re
import warnings
class SmartDict:
"""
Dictionary for search by case-insensitive lookup and/or prefix lookup
"""
def __init__(self):
self.od = OrderedDict()
self.casemap = {}
def __getitem__(self, key):
if key in self.od:
return self.od[key]
if key.lower() in self.casemap:
return self.od[self.casemap[key.lower()]]
return self.od[self.prefix_match(key)]
def is_ambiguous(self, key):
return (
key not in self.od
and key not in self.casemap
and len(list(self.prefix_match_iter(key))) > 1
)
def prefix_match_iter(self, key):
name, number = re.match(r"^(.*?)([0-9]*)$", key.lower()).groups()
for entry, od_key in self.casemap.items():
if entry.startswith(name) and entry.endswith(number):
yield od_key
def prefix_match(self, key):
for od_key in self.prefix_match_iter(key):
return od_key
return None
def __setitem__(self, key, value):
if key in self.od:
warnings.warn("Duplicate entry %s", key)
elif key.lower() in self.casemap:
warnings.warn(
"Entry %s differs from duplicate %s only in cAsE",
key,
self.casemap[key.lower()],
)
self.casemap[key.lower()] = key
self.od[key] = value
def __delitem__(self, key):
if (
self.casemap[key.lower()] == key
): # Check that we did not overwrite this entry
del self.casemap[key.lower()]
del self.od[key]
def __contains__(self, key):
return key in self.od or key.lower() in self.casemap or self.prefix_match(key)
def __iter__(self):
return iter(self.od)
def __len__(self):
return len(self.od)
def items(self):
return self.od.items()
def keys(self):
return self.od.keys()
def values(self):
return self.od.values()
def __str__(self):
return str(self.od)
class SVDNonFatalError(Exception):
"""Exception class for non-fatal errors
So far, these have related to quirks in some vendor SVD files which are reasonable to ignore
"""
def __init__(self, m):
self.m = m
self.exc_info = sys.exc_info()
def __str__(self):
s = "Non-fatal: {}".format(self.m)
s += "\n" + str("".join(traceback.format_exc())).strip()
return s
class SVDFile:
"""
A parsed SVD file
"""
def __init__(self, fname):
"""
Args:
fname: Filename for the SVD file
"""
f = objectify.parse(os.path.expanduser(fname))
root = f.getroot()
periph = root.peripherals.getchildren()
self.peripherals = SmartDict()
self.base_address = 0
# XML elements
for p in periph:
try:
if p.tag == "peripheral":
self.peripherals[str(p.name)] = SVDPeripheral(p, self)
else:
# This is some other tag
pass
except SVDNonFatalError as e:
print(e)
def add_register(parent, node):
"""
Add a register node to a peripheral
Args:
parent: Parent SVDPeripheral object
node: XML file node fot of the register
"""
if hasattr(node, "dim"):
dim = int(str(node.dim), 0)
# dimension is not used, number of split indexes should be same
incr = int(str(node.dimIncrement), 0)
default_dim_index = ",".join((str(i) for i in range(dim)))
dim_index = str(getattr(node, "dimIndex", default_dim_index))
indices = dim_index.split(",")
offset = 0
for i in indices:
name = str(node.name) % i
reg = SVDPeripheralRegister(node, parent)
reg.name = name
reg.offset += offset
parent.registers[name] = reg
offset += incr
else:
try:
reg = SVDPeripheralRegister(node, parent)
name = str(node.name)
if name not in parent.registers:
parent.registers[name] = reg
else:
if hasattr(node, "alternateGroup"):
print("Register %s has an alternate group", name)
except SVDNonFatalError as e:
print(e)
def add_cluster(parent, node):
"""
Add a register cluster to a peripheral
"""
if hasattr(node, "dim"):
dim = int(str(node.dim), 0)
# dimension is not used, number of split indices should be same
incr = int(str(node.dimIncrement), 0)
default_dim_index = ",".join((str(i) for i in range(dim)))
dim_index = str(getattr(node, "dimIndex", default_dim_index))
indices = dim_index.split(",")
offset = 0
for i in indices:
name = str(node.name) % i
cluster = SVDRegisterCluster(node, parent)
cluster.name = name
cluster.address_offset += offset
cluster.base_address += offset
parent.clusters[name] = cluster
offset += incr
else:
try:
parent.clusters[str(node.name)] = SVDRegisterCluster(node, parent)
except SVDNonFatalError as e:
print(e)
class SVDRegisterCluster:
"""
Register cluster
"""
def __init__(self, svd_elem, parent):
"""
Args:
svd_elem: XML element for the register cluster
parent: Parent SVDPeripheral object
"""
self.parent_base_address = parent.base_address
self.parent_name = parent.name
self.address_offset = int(str(svd_elem.addressOffset), 0)
self.base_address = self.address_offset + self.parent_base_address
# This doesn't inherit registers from anything
children = svd_elem.getchildren()
self.description = str(svd_elem.description)
self.name = str(svd_elem.name)
self.registers = SmartDict()
self.clusters = SmartDict()
for r in children:
if r.tag == "register":
add_register(self, r)
def refactor_parent(self, parent):
self.parent_base_address = parent.base_address
self.parent_name = parent.name
self.base_address = self.parent_base_address + self.address_offset
values = self.registers.values()
for r in values:
r.refactor_parent(self)
def __str__(self):
return str(self.name)
class SVDPeripheral:
"""
This is a peripheral as defined in the SVD file
"""
def __init__(self, svd_elem, parent):
"""
Args:
svd_elem: XML element for the peripheral
parent: Parent SVDFile object
"""
self.parent_base_address = parent.base_address
# Look for a base address, as it is required
if not hasattr(svd_elem, "baseAddress"):
raise SVDNonFatalError("Periph without base address")
self.base_address = int(str(svd_elem.baseAddress), 0)
if "derivedFrom" in svd_elem.attrib:
derived_from = svd_elem.attrib["derivedFrom"]
try:
self.name = str(svd_elem.name)
except AttributeError:
self.name = parent.peripherals[derived_from].name
try:
self.description = str(svd_elem.description)
except AttributeError:
self.description = parent.peripherals[derived_from].description
# pickle is faster than deepcopy by up to 50% on svd files with a
# lot of derivedFrom definitions
def copier(a):
return pickle.loads(pickle.dumps(a))
self.registers = copier(parent.peripherals[derived_from].registers)
self.clusters = copier(parent.peripherals[derived_from].clusters)
self.refactor_parent(parent)
else:
# This doesn't inherit registers from anything
self.description = str(svd_elem.description)
self.name = str(svd_elem.name)
self.registers = SmartDict()
self.clusters = SmartDict()
if hasattr(svd_elem, "registers"):
registers = [
r
for r in svd_elem.registers.getchildren()
if r.tag in ["cluster", "register"]
]
for r in registers:
if r.tag == "cluster":
add_cluster(self, r)
elif r.tag == "register":
add_register(self, r)
def refactor_parent(self, parent):
self.parent_base_address = parent.base_address
values = self.registers.values()
for r in values:
r.refactor_parent(self)
for c in self.clusters.values():
c.refactor_parent(self)
def __str__(self):
return str(self.name)
class SVDPeripheralRegister:
"""
A register within a peripheral
"""
def __init__(self, svd_elem, parent):
self.parent_base_address = parent.base_address
self.name = str(svd_elem.name)
self.description = str(svd_elem.description)
self.offset = int(str(svd_elem.addressOffset), 0)
if hasattr(svd_elem, "access"):
self.access = str(svd_elem.access)
else:
self.access = "read-write"
if hasattr(svd_elem, "size"):
self.size = int(str(svd_elem.size), 0)
else:
self.size = 0x20
self.fields = SmartDict()
if hasattr(svd_elem, "fields"):
# Filter fields to only consider those of tag "field"
fields = [f for f in svd_elem.fields.getchildren() if f.tag == "field"]
for f in fields:
self.fields[str(f.name)] = SVDPeripheralRegisterField(f, self)
def refactor_parent(self, parent):
self.parent_base_address = parent.base_address
def address(self):
return self.parent_base_address + self.offset
def readable(self):
return self.access in ["read-only", "read-write", "read-writeOnce"]
def writable(self):
return self.access in [
"write-only",
"read-write",
"writeOnce",
"read-writeOnce",
]
def __str__(self):
return str(self.name)
class SVDPeripheralRegisterField:
"""
Field within a register
"""
def __init__(self, svd_elem, parent):
self.name = str(svd_elem.name)
self.description = str(getattr(svd_elem, "description", ""))
# Try to extract a bit range (offset and width) from the available fields
if hasattr(svd_elem, "bitOffset") and hasattr(svd_elem, "bitWidth"):
self.offset = int(str(svd_elem.bitOffset))
self.width = int(str(svd_elem.bitWidth))
elif hasattr(svd_elem, "bitRange"):
bitrange = list(map(int, str(svd_elem.bitRange).strip()[1:-1].split(":")))
self.offset = bitrange[1]
self.width = 1 + bitrange[0] - bitrange[1]
else:
assert hasattr(svd_elem, "lsb") and hasattr(
svd_elem, "msb"
), "Range not found for field {} in register {}".format(self.name, parent)
lsb = int(str(svd_elem.lsb))
msb = int(str(svd_elem.msb))
self.offset = lsb
self.width = 1 + msb - lsb
self.access = str(getattr(svd_elem, "access", parent.access))
self.enum = {}
if hasattr(svd_elem, "enumeratedValues"):
values = [
v
for v in svd_elem.enumeratedValues.getchildren()
if v.tag == "enumeratedValue"
]
for v in values:
# Skip the "name" tag and any entries that don't have a value
if v.tag == "name" or not hasattr(v, "value"):
continue
# Some Kinetis parts have values with # instead of 0x...
value = str(v.value).replace("#", "0x")
description = str(v.description) if hasattr(v, "description") else ""
try:
index = int(value, 0)
self.enum[int(value, 0)] = (str(v.name), description)
except ValueError:
# If the value couldn't be converted as a single integer, skip it
pass
def readable(self):
return self.access in ["read-only", "read-write", "read-writeOnce"]
def writable(self):
return self.access in [
"write-only",
"read-write",
"writeOnce",
"read-writeOnce",
]
def __str__(self):
return str(self.name)
def _main():
"""
Basic test to parse a file and do some things
"""
for f in sys.argv[1:]:
print("Testing file: {}".format(f))
svd = SVDFile(f)
print(svd.peripherals)
key = list(svd.peripherals)[0]
print("Registers in peripheral '{}':".format(key))
print(svd.peripherals[key].registers)
print("Done testing file: {}".format(f))
if __name__ == "__main__":
_main()

520
scripts/debug/PyCortexMDebug/cmdebug/svd_gdb.py Executable file
View File

@@ -0,0 +1,520 @@
#!/usr/bin/env python
"""
This file is part of PyCortexMDebug
PyCortexMDebug is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
PyCortexMDebug is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with PyCortexMDebug. If not, see <http://www.gnu.org/licenses/>.
"""
import gdb
import re
import math
import sys
import struct
import pkg_resources
import fnmatch
import traceback
from .svd import SVDFile
BITS_TO_UNPACK_FORMAT = {
8: "B",
16: "H",
32: "I",
}
class LoadSVD(gdb.Command):
"""A command to load an SVD file and to create the command for inspecting
that object
"""
def __init__(self):
self.vendors = {}
try:
vendor_names = pkg_resources.resource_listdir("cmsis_svd", "data")
for vendor in vendor_names:
fnames = pkg_resources.resource_listdir(
"cmsis_svd", "data/{}".format(vendor)
)
self.vendors[vendor] = [
fname for fname in fnames if fname.lower().endswith(".svd")
]
except:
pass
if len(self.vendors) > 0:
gdb.Command.__init__(self, "svd_load", gdb.COMMAND_USER)
else:
gdb.Command.__init__(
self, "svd_load", gdb.COMMAND_DATA, gdb.COMPLETE_FILENAME
)
def complete(self, text, word):
args = gdb.string_to_argv(text)
num_args = len(args)
if text.endswith(" "):
num_args += 1
if not text:
num_args = 1
# "svd_load <tab>" or "svd_load ST<tab>"
if num_args == 1:
prefix = word.lower()
return [
vendor for vendor in self.vendors if vendor.lower().startswith(prefix)
]
# "svd_load STMicro<tab>" or "svd_load STMicro STM32F1<tab>"
elif num_args == 2 and args[0] in self.vendors:
prefix = word.lower()
filenames = self.vendors[args[0]]
return [fname for fname in filenames if fname.lower().startswith(prefix)]
return gdb.COMPLETE_NONE
@staticmethod
def invoke(args, from_tty):
args = gdb.string_to_argv(args)
argc = len(args)
if argc == 1:
gdb.write("Loading SVD file {}...\n".format(args[0]))
f = args[0]
elif argc == 2:
gdb.write("Loading SVD file {}/{}...\n".format(args[0], args[1]))
f = pkg_resources.resource_filename(
"cmsis_svd", "data/{}/{}".format(args[0], args[1])
)
else:
raise gdb.GdbError(
"Usage: svd_load <vendor> <device.svd> or svd_load <path/to/filename.svd>\n"
)
try:
SVD(SVDFile(f))
except Exception as e:
traceback.print_exc()
raise gdb.GdbError("Could not load SVD file {} : {}...\n".format(f, e))
class SVD(gdb.Command):
"""The CMSIS SVD (System View Description) inspector command
This allows easy access to all peripheral registers supported by the system
in the GDB debug environment
"""
def __init__(self, svd_file):
gdb.Command.__init__(self, "svd", gdb.COMMAND_DATA)
self.svd_file = svd_file
def _print_registers(self, container_name, form, registers):
if len(registers) == 0:
return
try:
regs_iter = registers.itervalues()
except AttributeError:
regs_iter = registers.values()
gdb.write("Registers in %s:\n" % container_name)
reg_list = []
for r in regs_iter:
if r.readable():
try:
data = self.read(r.address(), r.size)
data = self.format(data, form, r.size)
if form == "a":
data += (
" <"
+ re.sub(
r"\s+",
" ",
gdb.execute(
"info symbol {}".format(data), True, True
).strip(),
)
+ ">"
)
except gdb.MemoryError:
data = "(error reading)"
else:
data = "(not readable)"
desc = re.sub(r"\s+", " ", r.description)
reg_list.append((r.name, data, desc))
column1_width = max(len(reg[0]) for reg in reg_list) + 2 # padding
column2_width = max(len(reg[1]) for reg in reg_list)
for reg in reg_list:
gdb.write(
"\t{}:{}{}".format(
reg[0],
"".ljust(column1_width - len(reg[0])),
reg[1].rjust(column2_width),
)
)
if reg[2] != reg[0]:
gdb.write(" {}".format(reg[2]))
gdb.write("\n")
def _print_register_fields(self, container_name, form, register):
gdb.write("Fields in {}:\n".format(container_name))
fields = register.fields
if not register.readable():
data = 0
else:
data = self.read(register.address(), register.size)
field_list = []
try:
fields_iter = fields.itervalues()
except AttributeError:
fields_iter = fields.values()
for f in fields_iter:
desc = re.sub(r"\s+", " ", f.description)
if register.readable():
val = data >> f.offset
val &= (1 << f.width) - 1
if f.enum:
if val in f.enum:
desc = f.enum[val][1] + " - " + desc
val = f.enum[val][0]
else:
val = "Invalid enum value: " + self.format(val, form, f.width)
else:
val = self.format(val, form, f.width)
else:
val = "(not readable)"
field_list.append((f.name, val, desc))
column1_width = max(len(field[0]) for field in field_list) + 2 # padding
column2_width = max(len(field[1]) for field in field_list) # padding
for field in field_list:
gdb.write(
"\t{}:{}{}".format(
field[0],
"".ljust(column1_width - len(field[0])),
field[1].rjust(column2_width),
)
)
if field[2] != field[0]:
gdb.write(" {}".format(field[2]))
gdb.write("\n")
def invoke(self, args, from_tty):
s = str(args).split(" ")
form = ""
if s[0] and s[0][0] == "/":
if len(s[0]) == 1:
gdb.write("Incorrect format\n")
return
else:
form = s[0][1:]
if len(s) == 1:
return
s = s[1:]
if s[0].lower() == "help":
gdb.write("Usage:\n")
gdb.write("=========\n")
gdb.write("svd:\n")
gdb.write("\tList available peripherals\n")
gdb.write("svd [peripheral_name]:\n")
gdb.write("\tDisplay all registers pertaining to that peripheral\n")
gdb.write("svd [peripheral_name] [register_name]:\n")
gdb.write("\tDisplay the fields in that register\n")
gdb.write("svd/[format_character] ...\n")
gdb.write("\tFormat values using that character\n")
gdb.write("\td(default):decimal, x: hex, o: octal, b: binary\n")
gdb.write("\n")
gdb.write(
"Both prefix matching and case-insensitive matching is supported for peripherals, registers, clusters and fields.\n"
)
return
if not len(s[0]):
gdb.write("Available Peripherals:\n")
try:
peripherals = self.svd_file.peripherals.itervalues()
except AttributeError:
peripherals = self.svd_file.peripherals.values()
column_width = max(len(p.name) for p in peripherals) + 2 # padding
try:
peripherals = self.svd_file.peripherals.itervalues()
except AttributeError:
peripherals = self.svd_file.peripherals.values()
for p in peripherals:
desc = re.sub(r"\s+", " ", p.description)
gdb.write(
"\t{}:{}{}\n".format(
p.name, "".ljust(column_width - len(p.name)), desc
)
)
return
def warn_if_ambiguous(smart_dict, key):
if smart_dict.is_ambiguous(key):
gdb.write(
"Warning: {} could prefix match any of: {}\n".format(
key, ", ".join(smart_dict.prefix_match_iter(key))
)
)
registers = None
if len(s) >= 1:
peripheral_name = s[0]
if peripheral_name not in self.svd_file.peripherals:
gdb.write("Peripheral {} does not exist!\n".format(s[0]))
return
warn_if_ambiguous(self.svd_file.peripherals, peripheral_name)
peripheral = self.svd_file.peripherals[peripheral_name]
if len(s) == 1:
self._print_registers(peripheral.name, form, peripheral.registers)
if len(peripheral.clusters) > 0:
try:
clusters_iter = peripheral.clusters.itervalues()
except AttributeError:
clusters_iter = peripheral.clusters.values()
gdb.write("Clusters in %s:\n" % peripheral.name)
reg_list = []
for r in clusters_iter:
desc = re.sub(r"\s+", " ", r.description)
reg_list.append((r.name, "", desc))
column1_width = max(len(reg[0]) for reg in reg_list) + 2 # padding
column2_width = max(len(reg[1]) for reg in reg_list)
for reg in reg_list:
gdb.write(
"\t{}:{}{}".format(
reg[0],
"".ljust(column1_width - len(reg[0])),
reg[1].rjust(column2_width),
)
)
if reg[2] != reg[0]:
gdb.write(" {}".format(reg[2]))
gdb.write("\n")
return
cluster = None
if len(s) == 2:
if s[1] in peripheral.clusters:
warn_if_ambiguous(peripheral.clusters, s[1])
cluster = peripheral.clusters[s[1]]
container = peripheral.name + " > " + cluster.name
self._print_registers(container, form, cluster.registers)
elif s[1] in peripheral.registers:
warn_if_ambiguous(peripheral.registers, s[1])
register = peripheral.registers[s[1]]
container = peripheral.name + " > " + register.name
self._print_register_fields(container, form, register)
else:
found = False
for key in fnmatch.filter(peripheral.registers.keys(), s[1]):
register = peripheral.registers[key]
container = peripheral.name + " > " + register.name
self._print_register_fields(container, form, register)
found = True
if not found:
gdb.write(
"Register/cluster {} in peripheral {} does not exist!\n".format(
s[1], peripheral.name
)
)
return
if len(s) == 3:
if s[1] not in peripheral.clusters:
gdb.write(
"Cluster {} in peripheral {} does not exist!\n".format(
s[1], peripheral.name
)
)
return
warn_if_ambiguous(peripheral.clusters, s[1])
cluster = peripheral.clusters[s[1]]
if s[2] not in cluster.registers:
gdb.write(
"Register {} in cluster {} in peripheral {} does not exist!\n".format(
s[2], cluster.name, peripheral.name
)
)
return
warn_if_ambiguous(cluster.registers, s[2])
register = cluster.registers[s[2]]
container = " > ".join([peripheral.name, cluster.name, register.name])
self._print_register_fields(container, form, register)
return
if len(s) == 4:
if s[1] not in peripheral.registers:
gdb.write(
"Register {} in peripheral {} does not exist!\n".format(
s[1], peripheral.name
)
)
return
warn_if_ambiguous(peripheral.registers, s[1])
reg = peripheral.registers[s[1]]
if s[2] not in reg.fields:
gdb.write(
"Field {} in register {} in peripheral {} does not exist!\n".format(
s[2], reg.name, peripheral.name
)
)
return
warn_if_ambiguous(reg.fields, s[2])
field = reg.fields[s[2]]
if not field.writable() or not reg.writable():
gdb.write(
"Field {} in register {} in peripheral {} is read-only!\n".format(
field.name, reg.name, peripheral.name
)
)
return
try:
val = int(s[3], 0)
except ValueError:
gdb.write(
"{} is not a valid number! You can prefix numbers with 0x for hex, 0b for binary, or any python "
"int literal\n".format(s[3])
)
return
if val >= 1 << field.width or val < 0:
gdb.write(
"{} not a valid number for a field with width {}!\n".format(
val, field.width
)
)
return
if not reg.readable():
data = 0
else:
data = self.read(reg.address(), reg.size)
data &= ~(((1 << field.width) - 1) << field.offset)
data |= val << field.offset
self.write(reg.address(), data, reg.size)
return
gdb.write("Unknown input\n")
def complete(self, text, word):
"""Perform tab-completion for the command"""
text = str(text)
s = text.split(" ")
# Deal with the possibility of a '/' parameter
if s[0] and s[0][0] == "/":
if len(s) > 1:
s = s[1:]
else:
return [] # completion after e.g. "svd/x" but before trailing space
if len(s) == 1:
return list(self.svd_file.peripherals.prefix_match_iter(s[0]))
if len(s) == 2:
reg = s[1].upper()
if len(reg) and reg[0] == "&":
reg = reg[1:]
if s[0] not in self.svd_file.peripherals:
return []
per = self.svd_file.peripherals[s[0]]
return list(per.registers.prefix_match_iter(s[1]))
return []
@staticmethod
def read(address, bits=32):
"""Read from memory and return an integer"""
value = gdb.selected_inferior().read_memory(address, bits / 8)
unpack_format = "I"
if bits in BITS_TO_UNPACK_FORMAT:
unpack_format = BITS_TO_UNPACK_FORMAT[bits]
# gdb.write("{:x} {}\n".format(address, binascii.hexlify(value)))
return struct.unpack_from("<" + unpack_format, value)[0]
@staticmethod
def write(address, data, bits=32):
"""Write data to memory"""
gdb.selected_inferior().write_memory(address, bytes(data), bits / 8)
@staticmethod
def format(value, form, length=32):
"""Format a number based on a format character and length"""
# get current gdb radix setting
radix = int(
re.search(r"\d+", gdb.execute("show output-radix", True, True)).group(0)
)
# override it if asked to
if form == "x" or form == "a":
radix = 16
elif form == "o":
radix = 8
elif form == "b" or form == "t":
radix = 2
# format the output
if radix == 16:
# For addresses, probably best in hex too
l = int(math.ceil(length / 4.0))
return "0x" + "{:X}".format(value).zfill(l)
if radix == 8:
l = int(math.ceil(length / 3.0))
return "0" + "{:o}".format(value).zfill(l)
if radix == 2:
return "0b" + "{:b}".format(value).zfill(length)
# Default: Just return in decimal
return str(value)
def peripheral_list(self):
try:
keys = self.svd_file.peripherals.iterkeys()
except AttributeError:
keys = self.svd_file.peripherals.keys()
return list(keys)
def register_list(self, peripheral):
try:
try:
keys = self.svd_file.peripherals[peripheral].registers.iterkeys()
except AttributeError:
keys = self.svd_file.peripherals[peripheral].registers.keys()
return list(keys)
except:
gdb.write("Peripheral {} doesn't exist\n".format(peripheral))
return []
def field_list(self, peripheral, register):
try:
periph = self.svd_file.peripherals[peripheral]
reg = periph.registers[register]
try:
regs = reg.fields.iterkeys()
except AttributeError:
regs = reg.fields.keys()
return list(regs)
except:
gdb.write("Register {} doesn't exist on {}\n".format(register, peripheral))
return []

15
scripts/debug/STM32WB55_CM4.svd Executable file
View File

File diff suppressed because one or more lines are too long

205
scripts/debug/flipperapps.py Normal file
View File

@@ -0,0 +1,205 @@
from dataclasses import dataclass
from typing import Optional, Tuple, Dict, ClassVar
import struct
import posixpath
import zlib
import gdb
def get_file_crc32(filename):
with open(filename, "rb") as f:
return zlib.crc32(f.read())
@dataclass
class AppState:
name: str
text_address: int = 0
entry_address: int = 0
other_sections: Dict[str, int] = None
debug_link_elf: str = ""
debug_link_crc: int = 0
DEBUG_ELF_ROOT: ClassVar[Optional[str]] = None
def __post_init__(self):
if self.other_sections is None:
self.other_sections = {}
def get_original_elf_path(self) -> str:
if self.DEBUG_ELF_ROOT is None:
raise ValueError("DEBUG_ELF_ROOT not set; call fap-set-debug-elf-root")
return (
posixpath.join(self.DEBUG_ELF_ROOT, self.debug_link_elf)
if self.DEBUG_ELF_ROOT
else self.debug_link_elf
)
def is_debug_available(self) -> bool:
have_debug_info = bool(self.debug_link_elf and self.debug_link_crc)
if not have_debug_info:
print("No debug info available for this app")
return False
debug_elf_path = self.get_original_elf_path()
debug_elf_crc32 = get_file_crc32(debug_elf_path)
if self.debug_link_crc != debug_elf_crc32:
print(
f"Debug info ({debug_elf_path}) CRC mismatch: {self.debug_link_crc:08x} != {debug_elf_crc32:08x}, rebuild app"
)
return False
return True
def get_gdb_load_command(self) -> str:
load_path = self.get_original_elf_path()
print(f"Loading debug information from {load_path}")
load_command = (
f"add-symbol-file -readnow {load_path} 0x{self.text_address:08x} "
)
load_command += " ".join(
f"-s {name} 0x{address:08x}"
for name, address in self.other_sections.items()
)
return load_command
def get_gdb_unload_command(self) -> str:
return f"remove-symbol-file -a 0x{self.text_address:08x}"
@staticmethod
def get_gdb_app_ep(app) -> int:
return int(app["state"]["entry"])
@staticmethod
def parse_debug_link_data(section_data: bytes) -> Tuple[str, int]:
# Debug link format: a null-terminated string with debuggable file name
# Padded with 0's to multiple of 4 bytes
# Followed by 4 bytes of CRC32 checksum of that file
elf_name = section_data[:-4].decode("utf-8").split("\x00")[0]
crc32 = struct.unpack("<I", section_data[-4:])[0]
return (elf_name, crc32)
@classmethod
def from_gdb(cls, gdb_app: "AppState") -> "AppState":
state = AppState(str(gdb_app["manifest"]["name"].string()))
state.entry_address = cls.get_gdb_app_ep(gdb_app)
app_state = gdb_app["state"]
if debug_link_size := int(app_state["debug_link_info"]["debug_link_size"]):
debug_link_data = (
gdb.selected_inferior()
.read_memory(
int(app_state["debug_link_info"]["debug_link"]), debug_link_size
)
.tobytes()
)
state.debug_link_elf, state.debug_link_crc = AppState.parse_debug_link_data(
debug_link_data
)
for idx in range(app_state["mmap_entry_count"]):
mmap_entry = app_state["mmap_entries"][idx]
section_name = mmap_entry["name"].string()
section_addr = int(mmap_entry["address"])
if section_name == ".text":
state.text_address = section_addr
else:
state.other_sections[section_name] = section_addr
return state
class SetFapDebugElfRoot(gdb.Command):
"""Set path to original ELF files for debug info"""
def __init__(self):
super().__init__(
"fap-set-debug-elf-root", gdb.COMMAND_FILES, gdb.COMPLETE_FILENAME
)
self.dont_repeat()
def invoke(self, arg, from_tty):
AppState.DEBUG_ELF_ROOT = arg
try:
global helper
print(f"Set '{arg}' as debug info lookup path for Flipper external apps")
helper.attach_to_fw()
gdb.events.stop.connect(helper.handle_stop)
gdb.events.exited.connect(helper.handle_exit)
except gdb.error as e:
print(f"Support for Flipper external apps debug is not available: {e}")
class FlipperAppStateHelper:
def __init__(self):
self.app_type_ptr = None
self.app_list_ptr = None
self.app_list_entry_type = None
self._current_apps: list[AppState] = []
self.set_debug_mode(True)
def _walk_app_list(self, list_head):
while list_head:
if app := list_head["data"]:
yield app.dereference()
list_head = list_head["next"]
def _exec_gdb_command(self, command: str) -> bool:
try:
gdb.execute(command)
return True
except gdb.error as e:
print(f"Failed to execute GDB command '{command}': {e}")
return False
def _sync_apps(self) -> None:
self.set_debug_mode(True)
if not (app_list := self.app_list_ptr.value()):
print("Reset app loader state")
for app in self._current_apps:
self._exec_gdb_command(app.get_gdb_unload_command())
self._current_apps = []
return
loaded_apps: dict[int, gdb.Value] = dict(
(AppState.get_gdb_app_ep(app), app)
for app in self._walk_app_list(app_list[0])
)
for app in self._current_apps.copy():
if app.entry_address not in loaded_apps:
print(f"Application {app.name} is no longer loaded")
if not self._exec_gdb_command(app.get_gdb_unload_command()):
print(f"Failed to unload debug info for {app.name}")
self._current_apps.remove(app)
for entry_point, app in loaded_apps.items():
if entry_point not in set(app.entry_address for app in self._current_apps):
new_app_state = AppState.from_gdb(app)
print(f"New application loaded. Adding debug info")
if self._exec_gdb_command(new_app_state.get_gdb_load_command()):
self._current_apps.append(new_app_state)
else:
print(f"Failed to load debug info for {new_app_state}")
def attach_to_fw(self) -> None:
print("Attaching to Flipper firmware")
self.app_list_ptr = gdb.lookup_global_symbol(
"flipper_application_loaded_app_list"
)
self.app_type_ptr = gdb.lookup_type("FlipperApplication").pointer()
self.app_list_entry_type = gdb.lookup_type("struct FlipperApplicationList_s")
def handle_stop(self, event) -> None:
self._sync_apps()
def handle_exit(self, event) -> None:
self.set_debug_mode(False)
def set_debug_mode(self, mode: bool) -> None:
gdb.execute(f"set variable furi_hal_debug_gdb_session_active = {int(mode)}")
# Init additional 'fap-set-debug-elf-root' command and set up hooks
SetFapDebugElfRoot()
helper = FlipperAppStateHelper()
print("Support for Flipper external apps debug is loaded")

109
scripts/debug/flipperversion.py Normal file
View File

@@ -0,0 +1,109 @@
from dataclasses import dataclass, field
from typing import Dict, Optional
import gdb
# Must match FuriHalRtcRegisterVersion index in FuriHalRtcRegister enum
RTC_BACKUP_VERSION_REGISTER_IDX = 0x2
RTC_BASE = 0x40002800
RTC_BACKUP_BASE = RTC_BASE + 0x50
VERSION_REGISTER_ADDRESS = RTC_BACKUP_BASE + RTC_BACKUP_VERSION_REGISTER_IDX * 4
VERSION_STRUCT_MAGIC = 0xBE40
@dataclass
class VersionData:
git_hash: str
git_branch: str
build_date: str
version: str
target: int
build_is_dirty: bool
extra: Optional[Dict[str, str]] = field(default_factory=dict)
class VersionLoader:
def __init__(self, version_ptr):
self.version_ptr = version_ptr
self._cstr_type = gdb.lookup_type("char").pointer()
self._uint_type = gdb.lookup_type("unsigned int")
version_signature = version_ptr.dereference().cast(self._uint_type)
is_versioned = (version_signature & (0xFFFF)) == VERSION_STRUCT_MAGIC
if is_versioned:
self._version_data = self.load_versioned(
major=version_signature >> 16 & 0xFF,
minor=version_signature >> 24 & 0xFF,
)
else:
self._version_data = self.load_unversioned()
@property
def version(self) -> VersionData:
return self._version_data
def load_versioned(self, major, minor):
if major != 1:
raise ValueError("Unsupported version struct major version")
# Struct version 1.0
extra_data = int(self.version_ptr[5].cast(self._uint_type))
return VersionData(
git_hash=self.version_ptr[1].cast(self._cstr_type).string(),
git_branch=self.version_ptr[2].cast(self._cstr_type).string(),
build_date=self.version_ptr[3].cast(self._cstr_type).string(),
version=self.version_ptr[4].cast(self._cstr_type).string(),
target=extra_data & 0xF,
build_is_dirty=bool((extra_data >> 8) & 0xF),
)
def load_unversioned(self):
"""Parse an early version of the version struct."""
extra_data = int(self.version_ptr[5].cast(self._uint_type))
return VersionData(
git_hash=self.version_ptr[0].cast(self._cstr_type).string(),
git_branch=self.version_ptr[1].cast(self._cstr_type).string(),
# branch number is #2, but we don't care about it
build_date=self.version_ptr[3].cast(self._cstr_type).string(),
version=self.version_ptr[4].cast(self._cstr_type).string(),
target=extra_data & 0xF,
build_is_dirty=bool((extra_data >> 8) & 0xF),
)
class FlipperFwVersion(gdb.Command):
"""Print the version of Flipper's firmware."""
def __init__(self):
super(FlipperFwVersion, self).__init__("fw-version", gdb.COMMAND_USER)
def invoke(self, arg, from_tty):
void_ptr_type = gdb.lookup_type("void").pointer().pointer()
version_ptr_ptr = gdb.Value(VERSION_REGISTER_ADDRESS).cast(void_ptr_type)
if not version_ptr_ptr:
print("RTC version register is NULL")
return
version_ptr = version_ptr_ptr.dereference()
if not version_ptr:
print("Pointer to version struct is NULL")
return
version_struct = version_ptr.cast(void_ptr_type)
v = VersionLoader(version_struct)
print("Firmware version on attached Flipper:")
print(f"\tVersion: {v.version.version}")
print(f"\tBuilt on: {v.version.build_date}")
print(f"\tGit branch: {v.version.git_branch}")
print(f"\tGit commit: {v.version.git_hash}")
print(f"\tDirty: {v.version.build_is_dirty}")
print(f"\tHW Target: {v.version.target}")
FlipperFwVersion()

90
scripts/debug/fw.jflash Normal file
View File

@@ -0,0 +1,90 @@
AppVersion = 76803
FileVersion = 2
[GENERAL]
aATEModuleSel[24] = 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
ConnectMode = 0
CurrentFile = "..\build\latest\firmware.bin"
DataFileSAddr = 0x08000000
GUIMode = 0
HostName = ""
TargetIF = 1
USBPort = 0
USBSerialNo = 0x00000000
UseATEModuleSelection = 0
[JTAG]
IRLen = 0
MultipleTargets = 0
NumDevices = 0
Speed0 = 8000
Speed1 = 8000
TAP_Number = 0
UseAdaptive0 = 0
UseAdaptive1 = 0
UseMaxSpeed0 = 0
UseMaxSpeed1 = 0
[CPU]
NumInitSteps = 2
InitStep0_Action = "Reset"
InitStep0_Value0 = 0x00000000
InitStep0_Value1 = 0x00000000
InitStep0_Comment = ""
InitStep1_Action = "Halt"
InitStep1_Value0 = 0xFFFFFFFF
InitStep1_Value1 = 0xFFFFFFFF
InitStep1_Comment = ""
NumExitSteps = 1
ExitStep0_Action = "Reset"
ExitStep0_Value0 = 0x00000005
ExitStep0_Value1 = 0x00000032
ExitStep0_Comment = ""
UseScriptFile = 0
ScriptFile = ""
UseRAM = 1
RAMAddr = 0x20000000
RAMSize = 0x00030000
CheckCoreID = 1
CoreID = 0x6BA02477
CoreIDMask = 0x0F000FFF
UseAutoSpeed = 0x00000001
ClockSpeed = 0x00000000
EndianMode = 0
ChipName = "ST STM32WB55RG"
[FLASH]
aRangeSel[1] = 0-255
BankName = "Internal flash"
BankSelMode = 1
BaseAddr = 0x08000000
NumBanks = 1
[PRODUCTION]
AutoPerformsDisconnect = 0
AutoPerformsErase = 1
AutoPerformsProgram = 1
AutoPerformsSecure = 0
AutoPerformsStartApp = 1
AutoPerformsUnsecure = 0
AutoPerformsVerify = 0
EnableFixedVTref = 0
EnableTargetPower = 0
EraseType = 1
FixedVTref = 0x00000CE4
MonitorVTref = 0
MonitorVTrefMax = 0x0000157C
MonitorVTrefMin = 0x000003E8
OverrideTimeouts = 0
ProgramSN = 0
SerialFile = ""
SNAddr = 0x00000000
SNInc = 0x00000001
SNLen = 0x00000004
SNListFile = ""
SNValue = 0x00000001
StartAppType = 1
TargetPowerDelay = 0x00000014
TimeoutErase = 0x00003A98
TimeoutProgram = 0x00002710
TimeoutVerify = 0x00002710
VerifyType = 1
[PERFORMANCE]
DisableSkipBlankDataOnProgram = 0x00000000
PerfromBlankCheckPriorEraseChip = 0x00000001
PerfromBlankCheckPriorEraseSelectedSectors = 0x00000001

10
scripts/debug/gdbinit Normal file
View File

@@ -0,0 +1,10 @@
set confirm off
set pagination off
set print pretty on
set print object on
set print static-members on
set print vtbl on
set print demangle on
set demangle-style gnu-v3
set print sevenbit-strings off

107
scripts/debug/stm32wbx.cfg Normal file
View File

@@ -0,0 +1,107 @@
# script for stm32wbx family
#
# stm32wb devices support both JTAG and SWD transports.
#
source [find target/swj-dp.tcl]
source [find mem_helper.tcl]
if { [info exists CHIPNAME] } {
set _CHIPNAME $CHIPNAME
} else {
set _CHIPNAME stm32wbx
}
set _ENDIAN little
# Work-area is a space in RAM used for flash programming
# By default use 64kB
if { [info exists WORKAREASIZE] } {
set _WORKAREASIZE $WORKAREASIZE
} else {
set _WORKAREASIZE 0x10000
}
#jtag scan chain
if { [info exists CPUTAPID] } {
set _CPUTAPID $CPUTAPID
} else {
if { [using_jtag] } {
set _CPUTAPID 0x6ba00477
} else {
# SWD IDCODE (single drop, arm)
set _CPUTAPID 0x6ba02477
}
}
swj_newdap $_CHIPNAME cpu -irlen 4 -ircapture 0x1 -irmask 0xf -expected-id $_CPUTAPID
dap create $_CHIPNAME.dap -chain-position $_CHIPNAME.cpu
if {[using_jtag]} {
jtag newtap $_CHIPNAME bs -irlen 5
}
set _TARGETNAME $_CHIPNAME.cpu
target create $_TARGETNAME cortex_m -endian $_ENDIAN -dap $_CHIPNAME.dap
$_TARGETNAME configure -work-area-phys 0x20000000 -work-area-size $_WORKAREASIZE -work-area-backup 0
set _FLASHNAME $_CHIPNAME.flash
flash bank $_FLASHNAME stm32l4x 0 0 0 0 $_TARGETNAME
# Common knowledges tells JTAG speed should be <= F_CPU/6.
# F_CPU after reset is MSI 4MHz, so use F_JTAG = 500 kHz to stay on
# the safe side.
#
# Note that there is a pretty wide band where things are
# more or less stable, see http://openocd.zylin.com/#/c/3366/
adapter speed 24000
adapter srst delay 100
if {[using_jtag]} {
jtag_ntrst_delay 100
}
reset_config srst_nogate
if {![using_hla]} {
# if srst is not fitted use SYSRESETREQ to
# perform a soft reset
cortex_m reset_config sysresetreq
}
$_TARGETNAME configure -event reset-init {
# CPU comes out of reset with MSI_ON | MSI_RDY | MSI Range 4 MHz.
# Configure system to use MSI 24 MHz clock, compliant with VOS default Range1.
# 2 WS compliant with VOS=Range1 and 24 MHz.
mmw 0x58004000 0x00000102 0 ;# FLASH_ACR |= PRFTBE | 2(Latency)
mmw 0x58000000 0x00000091 0 ;# RCC_CR = MSI_ON | MSI Range 24 MHz
# Boost JTAG frequency
adapter speed 24000
}
$_TARGETNAME configure -event reset-start {
# Reset clock is MSI (4 MHz)
adapter speed 24000
}
$_TARGETNAME configure -event examine-end {
# Enable debug during low power modes (uses more power)
# DBGMCU_CR |= DBG_STANDBY | DBG_STOP | DBG_SLEEP
mmw 0xE0042004 0x00000007 0
# Stop watchdog counters during halt
# DBGMCU_APB1_FZR1 |= DBG_IWDG_STOP | DBG_WWDG_STOP
mmw 0xE004203C 0x00001800 0
}
$_TARGETNAME configure -event trace-config {
# Set TRACE_IOEN; TRACE_MODE is set to async; when using sync
# change this value accordingly to configure trace pins
# assignment
mmw 0xE0042004 0x00000020 0
}
$_TARGETNAME configure -event gdb-detach {
resume
}

2
scripts/fbt_tools/fbt_debugopts.py
View File

@@ -18,7 +18,7 @@ def GetDevices(env):
def generate(env, **kw):
env.AddMethod(GetDevices)
env.SetDefault(
FBT_DEBUG_DIR="${ROOT_DIR}/debug",
FBT_DEBUG_DIR="${FBT_SCRIPT_DIR}/debug",
)
if (adapter_serial := env.subst("$OPENOCD_ADAPTER_SERIAL")) != "auto":

1
scripts/sconsdist.py
View File

@@ -170,7 +170,6 @@ class Main(App):
"update.dir",
"sdk_headers.dir",
"lib.dir",
"debug.dir",
"scripts.dir",
)

27
scripts/ufbt/SConstruct
View File

@@ -186,6 +186,33 @@ dist_env.PhonyTarget(
FBT_FAP_DEBUG_ELF_ROOT=path_as_posix(dist_env.subst("$FBT_FAP_DEBUG_ELF_ROOT")),
)
# Debug alien elf
debug_other_opts = [
"-ex",
"source ${FBT_DEBUG_DIR}/PyCortexMDebug/PyCortexMDebug.py",
"-ex",
"source ${FBT_DEBUG_DIR}/flipperversion.py",
"-ex",
"fw-version",
]
dist_env.PhonyTarget(
"debug_other",
"${GDBPYCOM}",
GDBOPTS="${GDBOPTS_BASE}",
GDBREMOTE="${OPENOCD_GDB_PIPE}",
GDBPYOPTS=debug_other_opts,
)
dist_env.PhonyTarget(
"debug_other_blackmagic",
"${GDBPYCOM}",
GDBOPTS="${GDBOPTS_BASE} ${GDBOPTS_BLACKMAGIC}",
GDBREMOTE="${BLACKMAGIC_ADDR}",
GDBPYOPTS=debug_other_opts,
)
dist_env.PhonyTarget(
"flash_blackmagic",
"$GDB $GDBOPTS $SOURCES $GDBFLASH",

4
scripts/ufbt/site_tools/ufbt_state.py
View File

@@ -78,10 +78,8 @@ def generate(env, **kw):
env.SetDefault(
# Paths
SDK_DEFINITION=env.File(sdk_data["sdk_symbols"]),
FBT_DEBUG_DIR=pathlib.Path(
sdk_current_sdk_dir_node.Dir(sdk_components["debug.dir"]).abspath
).as_posix(),
FBT_SCRIPT_DIR=scripts_dir,
FBT_DEBUG_DIR=scripts_dir.Dir("debug"),
LIBPATH=sdk_current_sdk_dir_node.Dir(sdk_components["lib.dir"]),
FW_ELF=sdk_current_sdk_dir_node.File(sdk_components["firmware.elf"]),
FW_BIN=sdk_current_sdk_dir_node.File(sdk_components["full.bin"]),