Move JTAG command APIs into new jtag/commands.h header file.

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

diff --git a/src/jtag/jtag.h b/src/jtag/jtag.h
index 72c45a901f0c46fb96e6e51d762404a968b77f75..bc9470e1bb84769934595f7ccd38a6e2534b3584 100644 (file)
--- a/src/jtag/jtag.h
+++ b/src/jtag/jtag.h
@@ -142,136 +142,6 @@ typedef struct scan_field_s
        u8 intmp[4];
 } scan_field_t;
 
-#ifdef INCLUDE_JTAG_INTERFACE_H
-
-/**
- * The inferred type of a scan_command_s structure, indicating whether
- * the command has the host scan in from the device, the host scan out
- * to the device, or both.
- */
-enum scan_type {
-       /// From device to host,
-       SCAN_IN = 1,
-       /// From host to device,
-       SCAN_OUT = 2,
-       /// Full-duplex scan.
-       SCAN_IO = 3
-};
-
-/**
- * The scan_command provide a means of encapsulating a set of scan_field_s
- * structures that should be scanned in/out to the device.
- */
-typedef struct scan_command_s
-{
-       /// instruction/not data scan
-       bool ir_scan;
-       /// number of fields in *fields array
-       int num_fields;
-       /// pointer to an array of data scan fields
-       scan_field_t* fields;
-       /// state in which JTAG commands should finish
-       tap_state_t end_state;
-} scan_command_t;
-
-typedef struct statemove_command_s
-{
-       /// state in which JTAG commands should finish
-       tap_state_t end_state;
-} statemove_command_t;
-
-typedef struct pathmove_command_s
-{
-       /// number of states in *path
-       int num_states;
-       /// states that have to be passed
-       tap_state_t* path;
-} pathmove_command_t;
-
-typedef struct runtest_command_s
-{
-       /// number of cycles to spend in Run-Test/Idle state
-       int num_cycles;
-       /// state in which JTAG commands should finish
-       tap_state_t end_state;
-} runtest_command_t;
-
-
-typedef struct stableclocks_command_s
-{
-       /// number of clock cycles that should be sent
-       int num_cycles;
-} stableclocks_command_t;
-
-
-typedef struct reset_command_s
-{
-       /// Set TRST output: 0=deassert, 1=assert, -1=no change
-       int trst;
-       /// Set SRST output: 0=deassert, 1=assert, -1=no change
-       int srst;
-} reset_command_t;
-
-typedef struct end_state_command_s
-{
-       /// state in which JTAG commands should finish
-       tap_state_t end_state;
-} end_state_command_t;
-
-typedef struct sleep_command_s
-{
-       /// number of microseconds to sleep
-       u32 us;
-} sleep_command_t;
-
-/**
- * Defines a container type that hold a pointer to a JTAG command
- * structure of any defined type.
- */
-typedef union jtag_command_container_u
-{
-       scan_command_t*         scan;
-       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;
-} jtag_command_container_t;
-
-/**
- * The type of the @c jtag_command_container_u contained by a
- * @c jtag_command_s structure.
- */
-enum jtag_command_type {
-       JTAG_SCAN         = 1,
-       JTAG_STATEMOVE    = 2,
-       JTAG_RUNTEST      = 3,
-       JTAG_RESET        = 4,
-       JTAG_PATHMOVE     = 6,
-       JTAG_SLEEP        = 7,
-       JTAG_STABLECLOCKS = 8
-};
-
-typedef struct jtag_command_s
-{
-       jtag_command_container_t cmd;
-       enum jtag_command_type   type;
-       struct jtag_command_s*   next;
-} jtag_command_t;
-
-/// The current queue of jtag_command_s structures.
-extern jtag_command_t* jtag_command_queue;
-
-extern void* cmd_queue_alloc(size_t size);
-extern void cmd_queue_free(void);
-
-extern void jtag_queue_command(jtag_command_t *cmd);
-extern void jtag_command_queue_reset(void);
-
-#endif // INCLUDE_JTAG_INTERFACE_H
-
 typedef struct jtag_tap_event_action_s jtag_tap_event_action_t;
 
 /* this is really: typedef jtag_tap_t */
@@ -683,10 +553,7 @@ extern int jtag_srst_asserted(int* srst_asserted);
 extern void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask);
 
 #ifdef INCLUDE_JTAG_INTERFACE_H
-extern enum scan_type jtag_scan_type(const scan_command_t* cmd);
-extern int jtag_scan_size(const scan_command_t* cmd);
-extern int jtag_read_buffer(u8* buffer, const scan_command_t* cmd);
-extern int jtag_build_buffer(const scan_command_t* cmd, u8** buffer);
+#include "commands.h"
 #endif // INCLUDE_JTAG_INTERFACE_H
 
 extern void jtag_sleep(u32 us);