diff options
| author | Tomas Vanek <vanekt@fbl.cz> | 2022-04-29 10:10:58 +0200 |
|---|---|---|
| committer | Antonio Borneo <borneo.antonio@gmail.com> | 2022-05-07 11:04:45 +0000 |
| commit | 4c1919c566e79e6abcf006f3d03e4cc8cba54ff9 (patch) | |
| tree | a867320882b0195f532395f1ed5324487df66044 | |
| parent | 7819834ace37ca7f5d1b834c761dfcb9964ef845 (diff) | |
| download | riscv-openocd-4c1919c566e79e6abcf006f3d03e4cc8cba54ff9.zip riscv-openocd-4c1919c566e79e6abcf006f3d03e4cc8cba54ff9.tar.gz riscv-openocd-4c1919c566e79e6abcf006f3d03e4cc8cba54ff9.tar.bz2 | |
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>
| -rw-r--r-- | src/target/target_type.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/src/target/target_type.h b/src/target/target_type.h index d6b6086..a26c2e7 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); |