From 6c04f1e440be1451b1d7599910e377b90b7dc569 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C3=98yvind=20Harboe?= Date: Tue, 9 Nov 2010 09:17:49 +0100 Subject: [PATCH] target: document that target_poll() will report and clear sticky errors MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Øyvind Harboe --- src/target/target.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/target/target.h b/src/target/target.h index 4a48e5aad6..ef05e7513e 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); -- 2.30.2