X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fjtag%2Fcommands.h;h=06ec24837af1a58fb7fb087ac6d1792c9608cd4c;hp=509ca5aadb0ab7fdb286588183c3e5e002f3cce6;hb=517ba0690dcc9e859a05df2113ce32401a5ab254;hpb=2fecae46f62ca98657d650de9fc73d44247971e8 diff --git a/src/jtag/commands.h b/src/jtag/commands.h index 509ca5aadb..06ec24837a 100644 --- a/src/jtag/commands.h +++ b/src/jtag/commands.h @@ -21,24 +21,23 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * ***************************************************************************/ + #ifndef JTAG_COMMANDS_H #define JTAG_COMMANDS_H -#include "jtag.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, + /** From device to host, */ SCAN_IN = 1, - /// From host to device, + /** From host to device, */ SCAN_OUT = 2, - /// Full-duplex scan. + /** Full-duplex scan. */ SCAN_IO = 3 }; @@ -47,111 +46,133 @@ enum scan_type { * structures that should be scanned in/out to the device. */ struct scan_command { - /// instruction/not data scan + /** instruction/not data scan */ bool ir_scan; - /// number of fields in *fields array + /** number of fields in *fields array */ int num_fields; - /// pointer to an array of data scan fields - struct scan_field* fields; - /// state in which JTAG commands should finish + /** pointer to an array of data scan fields */ + struct scan_field *fields; + /** state in which JTAG commands should finish */ tap_state_t end_state; }; struct statemove_command { - /// state in which JTAG commands should finish + /** state in which JTAG commands should finish */ tap_state_t end_state; }; struct pathmove_command { - /// number of states in *path + /** number of states in *path */ int num_states; - /// states that have to be passed - tap_state_t* path; + /** states that have to be passed */ + tap_state_t *path; }; struct runtest_command { - /// number of cycles to spend in Run-Test/Idle state + /** number of cycles to spend in Run-Test/Idle state */ int num_cycles; - /// state in which JTAG commands should finish + /** state in which JTAG commands should finish */ tap_state_t end_state; }; struct stableclocks_command { - /// number of clock cycles that should be sent + /** number of clock cycles that should be sent */ int num_cycles; }; -typedef struct reset_command_s -{ - /// Set TRST output: 0 = deassert, 1 = assert, -1 = no change +struct reset_command { + /** Set TRST output: 0 = deassert, 1 = assert, -1 = no change */ int trst; - /// Set SRST output: 0 = deassert, 1 = assert, -1 = no change + /** 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 +struct end_state_command { + /** 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 +struct sleep_command { + /** number of microseconds to sleep */ uint32_t us; -} sleep_command_t; +}; + +/** + * Encapsulates a series of bits to be clocked out, affecting state + * and mode of the interface. + * + * In JTAG mode these are clocked out on TMS, using TCK. They may be + * used for link resets, transitioning between JTAG and SWD modes, or + * to implement JTAG state machine transitions (implementing pathmove + * or statemove operations). + * + * In SWD mode these are clocked out on SWDIO, using SWCLK, and are + * used for link resets and transitioning between SWD and JTAG modes. + */ +struct tms_command { + /** How many bits should be clocked out. */ + unsigned num_bits; + /** The bits to clock out; the LSB is bit 0 of bits[0]. */ + const uint8_t *bits; +}; /** * Defines a container type that hold a pointer to a JTAG command * structure of any defined type. */ -typedef union jtag_command_container_u -{ - struct scan_command* scan; - struct statemove_command* statemove; - struct pathmove_command* pathmove; - struct runtest_command* runtest; - struct stableclocks_command* stableclocks; - reset_command_t* reset; - end_state_command_t* end_state; - sleep_command_t* sleep; -} jtag_command_container_t; +union jtag_command_container { + struct scan_command *scan; + struct statemove_command *statemove; + struct pathmove_command *pathmove; + struct runtest_command *runtest; + struct stableclocks_command *stableclocks; + struct reset_command *reset; + struct end_state_command *end_state; + struct sleep_command *sleep; + struct tms_command *tms; +}; /** - * The type of the @c jtag_command_container_u contained by a + * The type of the @c jtag_command_container contained by a * @c jtag_command_s structure. */ enum jtag_command_type { JTAG_SCAN = 1, - JTAG_STATEMOVE = 2, + /* JTAG_TLR_RESET's non-minidriver implementation is a + * vestige from a statemove cmd. The statemove command + * is obsolete and replaced by pathmove. + * + * pathmove does not support reset as one of it's states, + * hence the need for an explicit statemove command. + */ + JTAG_TLR_RESET = 2, JTAG_RUNTEST = 3, JTAG_RESET = 4, JTAG_PATHMOVE = 6, JTAG_SLEEP = 7, - JTAG_STABLECLOCKS = 8 + JTAG_STABLECLOCKS = 8, + JTAG_TMS = 9, }; -typedef struct jtag_command_s -{ - jtag_command_container_t cmd; - enum jtag_command_type type; - struct jtag_command_s* next; -} jtag_command_t; +struct jtag_command { + union jtag_command_container cmd; + enum jtag_command_type type; + struct jtag_command *next; +}; -/// The current queue of jtag_command_s structures. -extern jtag_command_t* jtag_command_queue; +/** The current queue of jtag_command_s structures. */ +extern struct jtag_command *jtag_command_queue; -void* cmd_queue_alloc(size_t size); -void cmd_queue_free(void); +void *cmd_queue_alloc(size_t size); -void jtag_queue_command(jtag_command_t *cmd); +void jtag_queue_command(struct jtag_command *cmd); void jtag_command_queue_reset(void); -enum scan_type jtag_scan_type(const struct scan_command* cmd); -int jtag_scan_size(const struct scan_command* cmd); -int jtag_read_buffer(uint8_t* buffer, const struct scan_command* cmd); -int jtag_build_buffer(const struct scan_command* cmd, uint8_t** buffer); +enum scan_type jtag_scan_type(const struct scan_command *cmd); +int jtag_scan_size(const struct scan_command *cmd); +int jtag_read_buffer(uint8_t *buffer, const struct scan_command *cmd); +int jtag_build_buffer(const struct scan_command *cmd, uint8_t **buffer); -#endif // JTAG_COMMANDS_H +#endif /* JTAG_COMMANDS_H */