cmd: add missing usage vars

[openocd.git] / src / jtag / interface.h

diff --git a/src/jtag/interface.h b/src/jtag/interface.h
index 3226944e3f5b5ea04f51989f35a10d597c7d3559..1059436e067bbe3be4d0b057d3d87ec352621bd2 100644 (file)
--- a/src/jtag/interface.h
+++ b/src/jtag/interface.h
@@ -209,6 +209,8 @@ struct jtag_interface {
        /** transports supported in C code (NULL terminated vector) */
        const char **transports;
 
+       const struct swd_driver *swd;
+
        /**
         * Execute queued commands.
         * @returns ERROR_OK on success, or an error code on failure.
@@ -229,8 +231,14 @@ struct jtag_interface {
        const struct command_registration *commands;
 
        /**
-        * Interface driver must initalize any resources and connect to a
+        * Interface driver must initialize any resources and connect to a
         * JTAG device.
+        *
+        * quit() is invoked if and only if init() succeeds. quit() is always
+        * invoked if init() succeeds. Same as malloc() + free(). Always
+        * invoke free() if malloc() succeeds and do not invoke free()
+        * otherwise.
+        *
         * @returns ERROR_OK on success, or an error code on failure.
         */
        int (*init)(void);
@@ -238,6 +246,7 @@ struct jtag_interface {
        /**
         * Interface driver must tear down all resources and disconnect from
         * the JTAG device.
+        *
         * @returns ERROR_OK on success, or an error code on failure.
         */
        int (*quit)(void);
@@ -294,4 +303,6 @@ struct jtag_interface {
 
 extern const char *jtag_only[];
 
+extern const struct swd_driver *swd;
+
 #endif // OPENOCD_JTAG_INTERFACE_H