clarified jtag_khz command.

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

diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index fe240eb66383462227400df855590cde12efca4d..fca7c3500bddbb81ca04fc058db7d26e3880ecc5 100644 (file)
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -195,15 +195,15 @@ typedef struct jtag_interface_s
        int (*register_commands)(struct command_context_s *cmd_ctx);
        int (*init)(void);
        int (*quit)(void);
+       /* returns JTAG maxium speed for KHz. 0=RTCK. The function returns
+       a failure if it can't support the KHz/RTCK. */
+       int (*khz)(int khz, int *jtag_speed);
        
 } jtag_interface_t;
 
 enum jtag_event
 {
-       JTAG_SRST_ASSERTED,
-       JTAG_TRST_ASSERTED,
-       JTAG_SRST_RELEASED,
-       JTAG_TRST_RELEASED,
+       JTAG_TRST_ASSERTED
 };
 
 extern char* jtag_event_strings[];
@@ -225,6 +225,7 @@ extern enum tap_state end_state;
 extern enum tap_state cur_state;
 
 extern int jtag_speed;
+extern int jtag_speed_post_reset;
 
 enum reset_types
 {
@@ -245,13 +246,13 @@ extern int jtag_init(struct command_context_s *cmd_ctx);
 extern int jtag_register_commands(struct command_context_s *cmd_ctx);
 
 /* JTAG interface, can be implemented with a software or hardware fifo */
-extern int jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
+extern void jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 extern int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
-extern int jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
+extern void jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 extern int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
-extern int jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
+extern void jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 extern int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
-extern int jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
+extern void jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 extern int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
 /* execute a state transition within the JTAG standard, but the exact path
  * path that is taken is undefined. Many implementations use precisely
@@ -274,7 +275,7 @@ extern int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields
  * NB! a jtag_add_statemove() to the current state is not
  * a no-operation.
  */
-extern int jtag_add_statemove(enum tap_state endstate);
+extern void jtag_add_statemove(enum tap_state endstate);
 extern int interface_jtag_add_statemove(enum tap_state endstate);
 /* A list of unambigious single clock state transitions, not
  * all drivers can support this, but it is required for e.g.
@@ -285,16 +286,28 @@ extern int interface_jtag_add_statemove(enum tap_state endstate);
  * Note that the first on the list must be reachable 
  * via a single transition from the current state. 
  */
-extern int jtag_add_pathmove(int num_states, enum tap_state *path);
+extern void jtag_add_pathmove(int num_states, enum tap_state *path);
 extern int interface_jtag_add_pathmove(int num_states, enum tap_state *path);
-/* cycle precisely num_cycles in the TAP_RTI state */
-extern int jtag_add_runtest(int num_cycles, enum tap_state endstate);
+/* go to TAP_RTI, if we're not already there and cycle
+ * precisely num_cycles in the TAP_RTI after which move
+ * to the end state, if it is != TAP_RTI
+ */
+extern void jtag_add_runtest(int num_cycles, enum tap_state endstate);
 extern int interface_jtag_add_runtest(int num_cycles, enum tap_state endstate);
+/* If it fails and one of the error messages below are returned, nothing is 
+ * added to the queue and jtag_execute() won't return an error code.
+ * 
+ * ERROR_JTAG_RESET_WOULD_ASSERT_TRST
+ * ERROR_JTAG_RESET_CANT_SRST
+ * 
+ * All other error codes will result in jtag_execute_queue() returning
+ * an error.
+ */
 extern int jtag_add_reset(int trst, int srst);
 extern int interface_jtag_add_reset(int trst, int srst);
-extern int jtag_add_end_state(enum tap_state endstate);
+extern void jtag_add_end_state(enum tap_state endstate);
 extern int interface_jtag_add_end_state(enum tap_state endstate);
-extern int jtag_add_sleep(u32 us);
+extern void jtag_add_sleep(u32 us);
 extern int interface_jtag_add_sleep(u32 us);
 
 
@@ -336,7 +349,6 @@ extern int jtag_register_event_callback(int (*callback)(enum jtag_event event, v
 
 extern int jtag_verify_capture_ir;
 
-
 /* error codes
  * JTAG subsystem uses codes between -100 and -199 */