1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 Zachary T Welch *
9 * zw@superlucidity.net *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifndef JTAG_COMMANDS_H
27 #define JTAG_COMMANDS_H
30 * The inferred type of a scan_command_s structure, indicating whether
31 * the command has the host scan in from the device, the host scan out
32 * to the device, or both.
35 /// From device to host,
37 /// From host to device,
44 * The scan_command provide a means of encapsulating a set of scan_field_s
45 * structures that should be scanned in/out to the device.
48 /// instruction/not data scan
50 /// number of fields in *fields array
52 /// pointer to an array of data scan fields
53 struct scan_field
* fields
;
54 /// state in which JTAG commands should finish
55 tap_state_t end_state
;
58 struct statemove_command
{
59 /// state in which JTAG commands should finish
60 tap_state_t end_state
;
63 struct pathmove_command
{
64 /// number of states in *path
66 /// states that have to be passed
70 struct runtest_command
{
71 /// number of cycles to spend in Run-Test/Idle state
73 /// state in which JTAG commands should finish
74 tap_state_t end_state
;
78 struct stableclocks_command
{
79 /// number of clock cycles that should be sent
84 struct reset_command
{
85 /// Set TRST output: 0 = deassert, 1 = assert, -1 = no change
87 /// Set SRST output: 0 = deassert, 1 = assert, -1 = no change
91 struct end_state_command
{
92 /// state in which JTAG commands should finish
93 tap_state_t end_state
;
96 struct sleep_command
{
97 /// number of microseconds to sleep
102 * Defines a container type that hold a pointer to a JTAG command
103 * structure of any defined type.
105 union jtag_command_container
{
106 struct scan_command
* scan
;
107 struct statemove_command
* statemove
;
108 struct pathmove_command
* pathmove
;
109 struct runtest_command
* runtest
;
110 struct stableclocks_command
* stableclocks
;
111 struct reset_command
* reset
;
112 struct end_state_command
* end_state
;
113 struct sleep_command
* sleep
;
117 * The type of the @c jtag_command_container contained by a
118 * @c jtag_command_s structure.
120 enum jtag_command_type
{
127 JTAG_STABLECLOCKS
= 8
130 struct jtag_command
{
131 union jtag_command_container cmd
;
132 enum jtag_command_type type
;
133 struct jtag_command
*next
;
136 /// The current queue of jtag_command_s structures.
137 extern struct jtag_command
* jtag_command_queue
;
139 void* cmd_queue_alloc(size_t size
);
140 void cmd_queue_free(void);
142 void jtag_queue_command(struct jtag_command
*cmd
);
143 void jtag_command_queue_reset(void);
145 enum scan_type
jtag_scan_type(const struct scan_command
* cmd
);
146 int jtag_scan_size(const struct scan_command
* cmd
);
147 int jtag_read_buffer(uint8_t* buffer
, const struct scan_command
* cmd
);
148 int jtag_build_buffer(const struct scan_command
* cmd
, uint8_t** buffer
);
150 #endif // JTAG_COMMANDS_H