target: document possibly unreachable target in deinit_target()

Change-Id: I95ff3d200bb2c8f5bc43a34c92726d9c47f8c172
Signed-off-by: Tomas Vanek <vanekt@fbl.cz>
Reviewed-on: https://review.openocd.org/c/openocd/+/6953
Tested-by: jenkins
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>

diff --git a/src/target/target_type.h b/src/target/target_type.h
index d6b6086b3c59467305a9db5ae444f71402c1f9f2..a26c2e7d875a7145041b9ba3c5ffe343ea4d8520 100644 (file)
--- 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.
         *
        /**
         * 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);
         * @param target The target to deinit
         */
        void (*deinit_target)(struct target *target);