diff options
author | Øyvind Harboe <oyvind.harboe@zylin.com> | 2010-11-09 09:17:49 +0100 |
---|---|---|
committer | Øyvind Harboe <oyvind.harboe@zylin.com> | 2010-11-09 13:03:22 +0100 |
commit | 6c04f1e440be1451b1d7599910e377b90b7dc569 (patch) | |
tree | bd3167a5737db000eb6778c735c262db6d6f4037 /src | |
parent | e7b2958229c7e0d7e98e130764aa50d1ca9017d3 (diff) | |
download | openocd_libswd-6c04f1e440be1451b1d7599910e377b90b7dc569.tar.gz openocd_libswd-6c04f1e440be1451b1d7599910e377b90b7dc569.tar.bz2 openocd_libswd-6c04f1e440be1451b1d7599910e377b90b7dc569.tar.xz openocd_libswd-6c04f1e440be1451b1d7599910e377b90b7dc569.zip |
target: document that target_poll() will report and clear sticky errors
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/target/target.h | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/target/target.h b/src/target/target.h index 4a48e5aa..ef05e751 100644 --- a/src/target/target.h +++ b/src/target/target.h @@ -257,6 +257,18 @@ int target_unregister_event_callback( int (*callback)(struct target *target, enum target_event event, void *priv), void *priv); +/* Poll the status of the target, detect any error conditions and report them. + * + * Also note that this fn will clear such error conditions, so a subsequent + * invocation will then succeed. + * + * These error conditions can be "sticky" error conditions. E.g. writing + * to memory could be implemented as an open loop and if memory writes + * fails, then a note is made of it, the error is sticky, but the memory + * write loop still runs to completion. This improves performance in the + * normal case as there is no need to verify that every single write succeed, + * yet it is possible to detect error condtions. + */ int target_poll(struct target *target); int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution); |