hla: if the idcode callback returns 0, treat as a wildcard

[openocd.git] / src / jtag / hla / hla_layout.h

diff --git a/src/jtag/hla/hla_layout.h b/src/jtag/hla/hla_layout.h
index d7b5d9353f5d77c24f962e4fa24df3a604af496a..ccc3a003e83d18aa0906b8cbdcc9ae11ababff4b 100644 (file)
--- a/src/jtag/hla/hla_layout.h
+++ b/src/jtag/hla/hla_layout.h
@@ -62,8 +62,17 @@ struct hl_layout_api_s {
                        uint32_t count, const uint8_t *buffer);
        /** */
        int (*write_debug_reg) (void *handle, uint32_t addr, uint32_t val);
-       /** */
-       int (*idcode) (void *fd, uint32_t *idcode);
+       /**
+        * Read the idcode of the target connected to the adapter
+        *
+        * If the adapter doesn't support idcode retrieval, this callback should
+        * store 0 to indicate a wildcard match.
+        *
+        * @param handle A pointer to the device-specific handle
+        * @param idcode Storage for the detected idcode
+        * @returns ERROR_OK on success, or an error code on failure.
+        */
+       int (*idcode) (void *handle, uint32_t *idcode);
        /** */
        enum target_state (*state) (void *fd);
 };