From 4c1919c566e79e6abcf006f3d03e4cc8cba54ff9 Mon Sep 17 00:00:00 2001 From: Tomas Vanek Date: Fri, 29 Apr 2022 10:10:58 +0200 Subject: [PATCH] target: document possibly unreachable target in deinit_target() Change-Id: I95ff3d200bb2c8f5bc43a34c92726d9c47f8c172 Signed-off-by: Tomas Vanek Reviewed-on: https://review.openocd.org/c/openocd/+/6953 Tested-by: jenkins Reviewed-by: Antonio Borneo --- src/target/target_type.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/target/target_type.h b/src/target/target_type.h index d6b6086b3c..a26c2e7d87 100644 --- a/src/target/target_type.h +++ b/src/target/target_type.h @@ -242,6 +242,17 @@ struct target_type { /** * Free all the resources allocated by the target. * + * WARNING: deinit_target is called unconditionally regardless the target has + * ever been examined/initialised or not. + * If a problem has prevented establishing JTAG/SWD/... communication + * or + * if the target was created with -defer-examine flag and has never been + * examined + * then it is not possible to communicate with the target. + * + * If you need to talk to the target during deinit, first check if + * target_was_examined()! + * * @param target The target to deinit */ void (*deinit_target)(struct target *target); -- 2.30.2