Move Doxygen documentation for IR/DR scan routines to header file.

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

diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index 341f7702c479d13c48f4a9c6890e7e26e2c9bc6d..e9caf9840876381c69a0a7eca2e22a5880a1e10d 100644 (file)
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -175,21 +175,20 @@ struct jtag_tap_s
 
        jtag_tap_t* next_tap;
 };
-extern jtag_tap_t* jtag_AllTaps(void);
+extern jtag_tap_t* jtag_all_taps(void);
 extern const char *jtag_tap_name(const jtag_tap_t *tap);
-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)
+extern jtag_tap_t* jtag_tap_by_string(const char* dotted_name);
+extern jtag_tap_t* jtag_tap_by_jim_obj(Jim_Interp* interp, Jim_Obj* obj);
+extern jtag_tap_t* jtag_tap_by_position(unsigned abs_position);
+extern unsigned jtag_tap_count_enabled(void);
+extern unsigned jtag_tap_count(void);
+
+static __inline__ jtag_tap_t* jtag_tap_next_enabled(jtag_tap_t* p)
 {
        if (p == NULL)
        {
                /* start at the head of list */
-               p = jtag_AllTaps();
+               p = jtag_all_taps();
        }
        else
        {
@@ -309,12 +308,29 @@ extern int  jtag_register_commands(struct command_context_s* cmd_ctx);
  * end state and a subsequent jtag_add_pathmove() must be issued.
  */
 
+/**
+ * Generate an IR SCAN with a list of scan fields with one entry for
+ * each enabled TAP.
+ *
+ * If the input field list contains an instruction value for a TAP then
+ * that is used otherwise the TAP is set to bypass.
+ *
+ * TAPs for which no fields are passed are marked as bypassed for
+ * subsequent DR SCANs.
+ *
+ */
 extern void jtag_add_ir_scan(int num_fields, scan_field_t* fields, tap_state_t endstate);
 /**
  * The same as jtag_add_ir_scan except no verification is performed out
  * the output values.
  */
 extern void jtag_add_ir_scan_noverify(int num_fields, const scan_field_t *fields, tap_state_t state);
+/**
+ * Duplicate the scan fields passed into the function into an IR SCAN
+ * command.  This function assumes that the caller handles extra fields
+ * for bypassed TAPs.
+ */
+extern void jtag_add_plain_ir_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
 
 
 /**
@@ -328,10 +344,20 @@ extern void jtag_add_ir_scan_noverify(int num_fields, const scan_field_t *fields
  */
 extern void jtag_alloc_in_value32(scan_field_t *field);
 
+/**
+ * Generate a DR SCAN using the fields passed to the function.
+ * For connected TAPs, the function checks in_fields and uses fields
+ * specified there.  For bypassed TAPs, the function generates a dummy
+ * 1-bit field.  The bypass status of TAPs is set by jtag_add_ir_scan().
+ */
 extern void jtag_add_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
 /// A version of jtag_add_dr_scan() that uses the check_value/mask fields
 extern void jtag_add_dr_scan_check(int num_fields, scan_field_t* fields, tap_state_t endstate);
-extern void jtag_add_plain_ir_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
+/**
+ * Duplicate the scan fields passed into the function into a DR SCAN
+ * command.  Unlike jtag_add_dr_scan(), this function assumes that the
+ * caller handles extra fields for bypassed TAPs.
+ */
 extern void jtag_add_plain_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
 
 
@@ -447,6 +473,12 @@ extern void jtag_add_tlr(void);
  * can only implement a few transitions and therefore
  * a partial implementation of pathmove would have little practical
  * application.
+ *
+ * If an error occurs, jtag_error will contain one of these error codes:
+ *   - ERROR_JTAG_NOT_STABLE_STATE -- The final state was not stable.
+ *   - ERROR_JTAG_STATE_INVALID -- The path passed through TAP_RESET.
+ *   - ERROR_JTAG_TRANSITION_INVALID -- The path includes invalid
+ *     state transitions.
  */
 extern void jtag_add_pathmove(int num_states, const tap_state_t* path);
 
@@ -561,7 +593,16 @@ static __inline__ void jtag_set_error(int error)
        jtag_error=error;
 }
 
-
+/**
+ * Resets jtag_error to ERROR_OK, returning its previous value.
+ * @returns The previous value of @c jtag_error.
+ */
+static inline int jtag_error_clear(void)
+{
+       int temp = jtag_error;
+       jtag_error = ERROR_OK;
+       return temp;
+}
 
 /* can be implemented by hw+sw */
 extern int jtag_power_dropout(int* dropout);
@@ -597,6 +638,8 @@ void jtag_tap_handle_event(jtag_tap_t* tap, enum jtag_tap_event e);
 #define ERROR_JTAG_QUEUE_FAILED      (-104)
 #define ERROR_JTAG_NOT_STABLE_STATE  (-105)
 #define ERROR_JTAG_DEVICE_ERROR      (-107)
+#define ERROR_JTAG_STATE_INVALID     (-108)
+#define ERROR_JTAG_TRANSITION_INVALID (-109)
 
 /**
  * jtag_add_dr_out() is a version of jtag_add_dr_scan() which
@@ -640,11 +683,21 @@ extern void jtag_add_dr_out(jtag_tap_t* tap,
  */
 extern int jtag_add_statemove(tap_state_t goal_state);
 
+
+
 /// @returns the number of times the scan queue has been flushed
 int jtag_get_flush_queue_count(void);
+
 void jtag_set_nsrst_delay(unsigned delay);
+unsigned jtag_get_nsrst_delay(void);
+
 void jtag_set_ntrst_delay(unsigned delay);
+unsigned jtag_get_ntrst_delay(void);
+
 void jtag_set_speed_khz(unsigned speed);
 unsigned jtag_get_speed_khz(void);
 
+void jtag_set_verify(bool enable);
+bool jtag_will_verify(void);
+
 #endif /* JTAG_H */