- rlink interface support from Lou Deluxe <lou.openocd012@fixit.nospammail.net>
[openocd.git] / src / jtag / rlink / dtc_cmd.h
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, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20
21 /* A command position with the high nybble of 0x0 is reserved for an error condition. If executed, it stops the DTC and raises the ERROR flag */
22
23 #define DTC_CMD_SHIFT_TMS_BYTES(bytes) ((0x1 << 4) | ((bytes) - 1))
24 /* Shift 1-16 bytes out TMS. TDI is 0. */
25 /* Bytes to shift follow. */
26
27 #define DTC_CMD_SHIFT_TDI_BYTES(bytes) ((0x2 << 4) | ((bytes) - 1))
28 /* Shift 1-16 bytes out TDI. TMS is 0. */
29 /* Bytes to shift follow. */
30
31 #define DTC_CMD_SHIFT_TDI_AND_TMS_BYTES(bytes) ((0x3 << 4) | ((bytes) - 1))
32 /* Shift 1-16 byte pairs out TDI and TMS. */
33 /* Byte pairs to shift follow in TDI, TMS order. */
34
35 #define DTC_CMD_SHIFT_TDO_BYTES(bytes) ((0x4 << 4) | ((bytes) - 1))
36 /* Shift 1-16 bytes in TDO. TMS is unaffected. */
37 /* Reply buffer contains bytes shifted in. */
38
39 #define DTC_CMD_SHIFT_TDIO_BYTES(bytes) ((0x6 << 4) | ((bytes) - 1))
40 /* Shift 1-16 bytes out TDI and in TDO. TMS is unaffected. */
41
42 #define DTC_CMD_SHIFT_TMS_TDI_BIT_PAIR(tms, tdi, tdo) ((0x8 << 4) | ( \
43 (tms) ? (1 << 0) : 0 \
44 ) | ( \
45 (tdi) ? (1 << 1) : 0 \
46 ) | ( \
47 (tdo) ? (1 << 3) : 0 \
48 ))
49 /* Single bit shift. */
50 /* tms and tdi are the levels shifted out on TMS and TDI, respectively. */
51 /* tdo indicates whether a byte will be returned in the reply buffer with its least significant bit set to reflect TDO */
52 /* Care should be taken when tdo is zero, as the underlying code actually does put that byte in the reply buffer. Setting tdo to zero just moves the pointer back. The result is that if this command is executed when the reply buffer is already full, a byte will be written erroneously to memory not belonging to the reply buffer. This could be worked around at the expense of DTC code space and speed. */
53
54 #define DTC_CMD_SHIFT_TMS_BITS(bits) ((0x9 << 4) | ((bits) - 1))
55 /* Shift 1-8 bits out TMS. */
56 /* Bits to be shifted out are left justified in the following byte. */
57
58 #define DTC_CMD_SHIFT_TDIO_BITS(bits) ((0xe << 4) | ((bits) - 1))
59 /* Shift 1-8 bits out TDI and in TDO, TMS is unaffected. */
60 /* Bits to be shifted out are left justified in the following byte. */
61 /* Bits shifted in are right justified in the byte placed in the reply buffer. */
62
63
64 #define DTC_CMD_STOP (0xf << 4)
65 /* Stop processing the command buffer and wait for the next one. */
66 /* A shared status byte is updated with bit 0 set when this has happened, and it is cleared when a new command buffer becomes ready. The host can poll that byte to see when it is safe to read a reply. */