imi415
/
openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Tomas Vanek 2022-04-29 10:10:58 +02:00 committed by Antonio Borneo
parent 7819834ace
commit 4c1919c566
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/target/target_type.h
View File

@ -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);