vsllink support for stable clocks by Simon Qian <simonqian@SimonQian.com>

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

diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index bd306abaf166f667b47f430df80aae645d2bc627..cc3c9f0af77ffcb085091e87cfa777f851d9093f 100644 (file)
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -29,20 +29,21 @@
 
 #include "command.h"
 
+
 #if 0
 #define _DEBUG_JTAG_IO_
 #endif
 
 /* 16 Tap States, from page 21 of ASSET InterTech, Inc.'s svf.pdf
  */
-enum tap_state
+typedef enum tap_state
 {
        TAP_RESET = 0x0, TAP_IDLE = 0x8,
        TAP_DRSELECT = 0x1, TAP_DRCAPTURE = 0x2, TAP_DRSHIFT = 0x3, TAP_DREXIT1 = 0x4,
        TAP_DRPAUSE = 0x5, TAP_DREXIT2 = 0x6, TAP_DRUPDATE = 0x7,
        TAP_IRSELECT = 0x9, TAP_IRCAPTURE = 0xa, TAP_IRSHIFT = 0xb, TAP_IREXIT1 = 0xc,
        TAP_IRPAUSE = 0xd, TAP_IREXIT2 = 0xe, TAP_IRUPDATE = 0xf
-};
+} tap_state_t;
 
 typedef struct tap_transition_s
 {
@@ -50,7 +51,6 @@ typedef struct tap_transition_s
        enum tap_state low;
 } tap_transition_t;
 
-extern char* tap_state_strings[16];
 extern int tap_move_map[16];   /* map 16 TAP states to 6 stable states */
 extern u8 tap_move[6][6];              /* value scanned to TMS to move from one of six stable states to another */
 extern tap_transition_t tap_transitions[16];   /* describe the TAP state diagram */
@@ -78,11 +78,10 @@ typedef struct scan_field_s
        /* in_check_value/mask, in_handler_error_handler, in_handler_priv can be used by the in handler, otherwise they contain garbage  */
        u8 *in_check_value;     /* used to validate scan results */
        u8 *in_check_mask;      /* check specified bits against check_value */
-       in_handler_t in_handler;            /* process received buffer using this handler */
+       in_handler_t in_handler;/* process received buffer using this handler */
        void *in_handler_priv;  /* additional information for the in_handler */
 } scan_field_t;
 
-
 enum scan_type
 {
        /* IN: from device to host, OUT: from host to device */
@@ -114,6 +113,13 @@ typedef struct runtest_command_s
        enum tap_state end_state;       /* TAP state in which JTAG commands should finish */
 } runtest_command_t;
 
+
+typedef struct stableclocks_command_s
+{
+       int num_cycles;                         /* number of clock cycles that should be sent */
+} stableclocks_command_t;
+
+
 typedef struct reset_command_s
 {
        int trst;                       /* trst/srst 0: deassert, 1: assert, -1: don't change */
@@ -136,6 +142,7 @@ typedef union jtag_command_container_u
        statemove_command_t *statemove;
        pathmove_command_t *pathmove;
        runtest_command_t *runtest;
+       stableclocks_command_t *stableclocks;
        reset_command_t *reset;
        end_state_command_t *end_state;
        sleep_command_t *sleep;
@@ -146,7 +153,8 @@ enum jtag_command_type
        JTAG_SCAN = 1,
        JTAG_STATEMOVE = 2, JTAG_RUNTEST = 3,
        JTAG_RESET = 4, JTAG_END_STATE = 5,
-       JTAG_PATHMOVE = 6, JTAG_SLEEP = 7
+       JTAG_PATHMOVE = 6, JTAG_SLEEP = 7,
+       JTAG_STABLECLOCKS = 8
 };
 
 typedef struct jtag_command_s
@@ -158,12 +166,12 @@ typedef struct jtag_command_s
 
 extern jtag_command_t *jtag_command_queue;
 
-// forward declaration
+/* forward declaration */
 typedef struct jtag_tap_event_action_s jtag_tap_event_action_t;
 
-// this is really: typedef jtag_tap_t
-// But - the typedef is done in "types.h"
-// due to "forward decloration reasons"
+/* this is really: typedef jtag_tap_t */
+/* But - the typedef is done in "types.h" */
+/* due to "forward decloration reasons" */
 struct jtag_tap_s
 {
        const char *chip;
@@ -188,22 +196,21 @@ struct jtag_tap_s
 };
 extern jtag_tap_t *jtag_AllTaps(void);
 extern jtag_tap_t *jtag_TapByPosition(int n);
-extern jtag_tap_t *jtag_TapByPosition( int n );
-extern jtag_tap_t *jtag_TapByString( const char *dotted_name );
-extern jtag_tap_t *jtag_TapByJimObj( Jim_Interp *interp, Jim_Obj *obj );
-extern jtag_tap_t *jtag_TapByAbsPosition( int abs_position );
-extern int         jtag_NumEnabledTaps(void);
-extern int         jtag_NumTotalTaps(void);
-
+extern jtag_tap_t *jtag_TapByPosition(int n);
+extern jtag_tap_t *jtag_TapByString(const char *dotted_name);
+extern jtag_tap_t *jtag_TapByJimObj(Jim_Interp *interp, Jim_Obj *obj);
+extern jtag_tap_t *jtag_TapByAbsPosition(int abs_position);
+extern int jtag_NumEnabledTaps(void);
+extern int jtag_NumTotalTaps(void);
 
 static __inline__ jtag_tap_t *
 jtag_NextEnabledTap( jtag_tap_t *p )
 {
        if( p == NULL ){
-               // start at the head of list
+               /* start at the head of list */
                p = jtag_AllTaps();
        } else {
-               // start *after* this one
+               /* start *after* this one */
                p = p->next_tap;
        }
        while( p ){
@@ -216,9 +223,6 @@ jtag_NextEnabledTap( jtag_tap_t *p )
        return p;
 }
 
-
-
-
 enum reset_line_mode
 {
        LINE_OPEN_DRAIN = 0x0,
@@ -441,6 +445,14 @@ extern void jtag_add_sleep(u32 us);
 extern int interface_jtag_add_sleep(u32 us);
 
 
+/**
+ * Function jtag_add_stable_clocks
+ * first checks that the state in which the clocks are to be issued is
+ * stable, then queues up clock_count clocks for transmission.
+ */
+void jtag_add_clocks( int num_cycles );
+int interface_jtag_add_clocks( int num_cycles );
+
 
 /*
  * For software FIFO implementations, the queued commands can be executed
@@ -468,7 +480,6 @@ extern int interface_jtag_execute_queue(void);
 extern int jtag_power_dropout(int *dropout);
 extern int jtag_srst_asserted(int *srst_asserted);
 
-
 /* JTAG support functions */
 extern void jtag_set_check_value(scan_field_t *field, u8 *value,  u8 *mask, error_handler_t *in_error_handler);
 extern enum scan_type jtag_scan_type(scan_command_t *cmd);
@@ -494,8 +505,6 @@ void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e);
 #define ERROR_JTAG_QUEUE_FAILED                        (-104)
 #define ERROR_JTAG_DEVICE_ERROR                        (-107)
 
-
-
 /* this allows JTAG devices to implement the entire jtag_xxx() layer in hw/sw */
 #ifdef HAVE_JTAG_MINIDRIVER_H
 /* Here a #define MINIDRIVER() and an inline version of hw fifo interface_jtag_add_dr_out can be defined */
@@ -527,9 +536,6 @@ extern void interface_jtag_add_dr_out(jtag_tap_t *tap,
                enum tap_state end_state);
 #endif
 
-
-
-
 static __inline__ void jtag_add_dr_out(jtag_tap_t *tap,
                int num_fields,
                const int *num_bits,
@@ -542,5 +548,11 @@ static __inline__ void jtag_add_dr_out(jtag_tap_t *tap,
        interface_jtag_add_dr_out(tap, num_fields, num_bits, value, cmd_queue_end_state);
 }
 
+/**
+ * Function jtag_state_name
+ * Returns a string suitable for display representing the JTAG tap_state
+ */
+const char* jtag_state_name(enum tap_state state);
+
 
 #endif /* JTAG_H */