jtag: report API reset as synchronous

The jtag API reset() is synchronous, but this was not highlighted
in the description.

Change-Id: I76ffb7eec97c8608cfbef0b9268ee18a5f50b221
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Fixes: 8850eb8f2c51 ("swd: get rid of jtag queue to assert/deassert srst")
Reviewed-on: http://openocd.zylin.com/5471
Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
Tested-by: jenkins

diff --git a/src/jtag/interface.h b/src/jtag/interface.h
index f4c6a98ba70b68c9a36703fc4c3003d2daf27aa1..39d2d9d88ea0d46d83626ed85c0a244e1900938a 100644 (file)
--- a/src/jtag/interface.h
+++ b/src/jtag/interface.h
@@ -250,6 +250,8 @@ struct adapter_driver {
 
        /**
         * Control (assert/deassert) the signals SRST and TRST on the interface.
+        * This function is synchronous and should be called after the adapter
+        * queue has been properly flushed.
         * This function is optional.
         * Adapters that don't support resets can either not define this function
         * or return an error code.