OpenOCD
rlink_dtc_cmd.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2008 Lou Deluxe *
3  * lou.openocd012@fixit.nospammail.net *
4  * *
5  * This program is free software; you can redistribute it and/or modify *
6  * it under the terms of the GNU General Public License as published by *
7  * the Free Software Foundation; either version 2 of the License, or *
8  * (at your option) any later version. *
9  * *
10  * This program is distributed in the hope that it will be useful, *
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13  * GNU General Public License for more details. *
14  * *
15  * You should have received a copy of the GNU General Public License *
16  * along with this program. If not, see <http://www.gnu.org/licenses/>. *
17  ***************************************************************************/
18 
19 #ifndef OPENOCD_JTAG_DRIVERS_RLINK_DTC_CMD_H
20 #define OPENOCD_JTAG_DRIVERS_RLINK_DTC_CMD_H
21 
22 /* A command position with the high nybble of 0x0 is reserved for an error condition.
23  * If executed, it stops the DTC and raises the ERROR flag */
24 
25 #define DTC_CMD_SHIFT_TMS_BYTES(bytes) ((0x1 << 4) | ((bytes) - 1))
26 /* Shift 1-16 bytes out TMS. TDI is 0. */
27 /* Bytes to shift follow. */
28 
29 #define DTC_CMD_SHIFT_TDI_BYTES(bytes) ((0x2 << 4) | ((bytes) - 1))
30 /* Shift 1-16 bytes out TDI. TMS is 0. */
31 /* Bytes to shift follow. */
32 
33 #define DTC_CMD_SHIFT_TDI_AND_TMS_BYTES(bytes) ((0x3 << 4) | ((bytes) - 1))
34 /* Shift 1-16 byte pairs out TDI and TMS. */
35 /* Byte pairs to shift follow in TDI, TMS order. */
36 
37 #define DTC_CMD_SHIFT_TDO_BYTES(bytes) ((0x4 << 4) | ((bytes) - 1))
38 /* Shift 1-16 bytes in TDO. TMS is unaffected. */
39 /* Reply buffer contains bytes shifted in. */
40 
41 #define DTC_CMD_SHIFT_TDIO_BYTES(bytes) ((0x6 << 4) | ((bytes) - 1))
42 /* Shift 1-16 bytes out TDI and in TDO. TMS is unaffected. */
43 
44 #define DTC_CMD_SHIFT_TMS_TDI_BIT_PAIR(tms, tdi, tdo) ((0x8 << 4) | (\
45  (tms) ? (1 << 0) : 0 \
46 ) | (\
47  (tdi) ? (1 << 1) : 0 \
48 ) | (\
49  (tdo) ? (1 << 3) : 0 \
50 ))
51 /* Single bit shift.
52  * tms and tdi are the levels shifted out on TMS and TDI, respectively.
53  * tdo indicates whether a byte will be returned in the reply buffer with its
54  * least significant bit set to reflect TDO
55  * Care should be taken when tdo is zero, as the underlying code actually does put
56  * that byte in the reply buffer. Setting tdo to zero just moves the pointer back.
57  * The result is that if this command is executed when the reply buffer is already full,
58  * a byte will be written erroneously to memory not belonging to the reply buffer.
59  * This could be worked around at the expense of DTC code space and speed. */
60 
61 #define DTC_CMD_SHIFT_TMS_BITS(bits) ((0x9 << 4) | ((bits) - 1))
62 /* Shift 1-8 bits out TMS. */
63 /* Bits to be shifted out are left justified in the following byte. */
64 
65 #define DTC_CMD_SHIFT_TDIO_BITS(bits) ((0xe << 4) | ((bits) - 1))
66 /* Shift 1-8 bits out TDI and in TDO, TMS is unaffected. */
67 /* Bits to be shifted out are left justified in the following byte. */
68 /* Bits shifted in are right justified in the byte placed in the reply buffer. */
69 
70 #define DTC_CMD_STOP (0xf << 4)
71 /* Stop processing the command buffer and wait for the next one. */
72 /* A shared status byte is updated with bit 0 set when this has happened,
73  * and it is cleared when a new command buffer becomes ready.
74  * The host can poll that byte to see when it is safe to read a reply. */
75 
76 #endif /* OPENOCD_JTAG_DRIVERS_RLINK_DTC_CMD_H */