1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
# Test user script.
@command(help="test command")
def testcmd(f: float, i: int, s: str):
assert isinstance(f, float)
assert isinstance(i, int)
assert isinstance(s, str)
@command("anothertestcmd", help="second test command")
def testcmd2(*args):
assert isinstance(args, tuple)
assert all(isinstance(s, str) for s in args)
# Provides stub implementations of all hooks.
def will_connect(board):
"""@brief Pre-init hook for the board.
@param self
@param board A Board instance that is about to be initialized.
@return Ignored.
"""
pass
def did_connect(board):
"""@brief Post-initialization hook for the board.
@param self
@param board A Board instance.
@return Ignored.
"""
pass
def will_init_target(target, init_sequence):
"""@brief Hook to review and modify init call sequence prior to execution.
@param self
@param target A CoreSightTarget object about to be initialized.
@param init_sequence The CallSequence that will be invoked. Because call sequences are
mutable, this parameter can be modified before return to change the init calls.
@return Ignored.
"""
pass
def did_init_target(target):
"""@brief Post-initialization hook.
@param self
@param target A CoreSightTarget.
@return Ignored.
"""
pass
def will_start_debug_core(core):
"""@brief Hook to enable debug for the given core.
@param self
@param core A CortexM object about to be initialized.
@retval True Do not perform the normal procedure to start core debug.
@retval "False or None" Continue with normal behaviour.
"""
pass
def did_start_debug_core(core):
"""@brief Post-initialization hook.
@param self
@param core A CortexM object.
@return Ignored.
"""
pass
def will_stop_debug_core(core):
"""@brief Pre-cleanup hook for the core.
@param self
@param core A CortexM object.
@retval True Do not perform the normal procedure to disable core debug.
@retval "False or None" Continue with normal behaviour.
"""
pass
def did_stop_debug_core(core):
"""@brief Post-cleanup hook for the core.
@param self
@param core A CortexM object.
@return Ignored.
"""
pass
def will_disconnect(target, resume):
"""@brief Pre-disconnect hook.
@param self
@param target Either a CoreSightTarget or CortexM object.
@param resume The value of the `disconnect_on_resume` option.
@return Ignored.
"""
pass
def did_disconnect(target, resume):
"""@brief Post-disconnect hook.
@param self
@param target Either a CoreSightTarget or CortexM object.
@param resume The value of the `disconnect_on_resume` option.
@return Ignored."""
pass
def will_reset(core, reset_type):
"""@brief Pre-reset hook.
@param self
@param core A CortexM instance.
@param reset_type One of the Target.ResetType enumerations.
@retval True
@retval "False or None"
"""
pass
def did_reset(core, reset_type):
"""@brief Post-reset hook.
@param self
@param core A CortexM instance.
@param reset_type One of the Target.ResetType enumerations.
@return Ignored.
"""
pass
def set_reset_catch(core, reset_type):
"""@brief Hook to prepare target for halting on reset.
@param self
@param core A CortexM instance.
@param reset_type One of the Target.ResetType enumerations.
@retval True
@retval "False or None"
"""
pass
def clear_reset_catch(core, reset_type):
"""@brief Hook to clean up target after a reset and halt.
@param self
@param core A CortexM instance.
@param reset_type
@return Ignored.
"""
pass
def mass_erase(target):
"""@brief Hook to override mass erase.
@param self
@param target A CoreSightTarget object.
@retval True Indicate that mass erase was performed by the hook.
@retval "False or None" Mass erase was not overridden and the caller should proceed with the standard
mass erase procedure.
"""
pass
def trace_start(target, mode):
"""@brief Hook to prepare for tracing the target.
@param self
@param target A CoreSightTarget object.
@param mode The trace mode. Currently always 0 to indicate SWO.
@return Ignored.
"""
pass
def trace_stop(target, mode):
"""@brief Hook to clean up after tracing the target.
@param self
@param target A CoreSightTarget object.
@param mode The trace mode. Currently always 0 to indicate SWO.
@return Ignored.
"""
pass
|
