From: Øyvind Harboe Date: Tue, 9 Nov 2010 08:17:49 +0000 (+0100) Subject: target: document that target_poll() will report and clear sticky errors X-Git-Tag: v0.5.0-rc1~348 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=6c04f1e440be1451b1d7599910e377b90b7dc569;p=openocd target: document that target_poll() will report and clear sticky errors Signed-off-by: Øyvind Harboe --- 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);