1 /* rswdp.h - remote serial wire debug protocol 2 * 3 * Copyright 2011 Brian Swetland <swetland@frotz.net> 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 18 /* Remote Serial Wire Debug Protocol */ 19 20 #ifndef _RSWDP_PROTOCOL_H_ 21 #define _RSWDP_PROTOCOL_H_ 22 23 /* Basic framing: 24 * - host and device exchange "transactions" consisting of 25 * some number of "messages". 26 * - each "message" has a 32bit header and may have 0 or more 27 * 32bit words of payload 28 * - a transaction may not exceed 4K (1024 words) 29 * - a transaction is sent in a series of USB BULK packets 30 * - the final packet must be a short packet unless the 31 * transaction is exactly 4K in length 32 * - packets must be a multiple of 4 bytes 33 * - the first message in a transaction must be 34 * CMD_TXN_START or CMD_TXN_ASYNC 35 */ 36 37 #define RSWD_MSG(cmd,op,n) ((((cmd)&0xFF) << 24) | (((op) & 0xFF)<<16) | ((n) & 0xFFFF)) 38 #define RSWD_MSG_CMD(n) (((n) >> 24) & 0xFF) 39 #define RSWD_MSG_OP(n) (((n) >> 16) & 0xFF) 40 #define RSWD_MSG_ARG(n) ((n) & 0xFFFF) 41 42 #define RSWD_TXN_START(seq) (0xAA770000 | ((seq) & 0xFFFF)) 43 #define RSWD_TXN_ASYNC (0xAA001111) 44 45 /* valid: either */ 46 #define CMD_NULL 0x00 /* used for padding */ 47 48 /* valid: host to target */ 49 #define CMD_SWD_WRITE 0x01 /* op=addr arg=count payload: data x count */ 50 #define CMD_SWD_READ 0x02 /* op=addr arg=count payload: data x count */ 51 #define CMD_SWD_DISCARD 0x03 /* op=addr arg=count payload: none (discards) */ 52 #define CMD_ATTACH 0x04 /* do swdp reset/connect handshake */ 53 #define CMD_RESET 0x05 /* arg=1 -> assert RESETn, otherwise deassert */ 54 #define CMD_DOWNLOAD 0x06 /* arg=wordcount, payload: addr x 1, data x n */ 55 #define CMD_EXECUTE 0x07 /* payload: addr x 1 */ 56 #define CMD_TRACE 0x08 /* op=tracebits n=0 */ 57 #define CMD_BOOTLOADER 0x09 /* return to bootloader for reflashing */ 58 #define CMD_SET_CLOCK 0x0A /* set SWCLK rate to n khz */ 59 #define CMD_SWO_CLOCK 0x0B /* set SWOCLK rate to n khz, 0 = disable SWO */ 60 #define CMD_JTAG_IO 0x0C /* op=0, arg=bitcount, data x (count/32) * 2 */ 61 /* tms, tdi word pairs per 32bits */ 62 #define CMD_JTAG_TX 0x0D /* tms=op.0, arg=bitcount, data x (count/32) words of tdi */ 63 #define CMD_JTAG_RX 0x0E /* tms=op.0, tdi=op.1, arg=bitcount, return (count/32) words */ 64 #define CMD_JTAG_VRFY 0x0F /* arg=bitcount, tms/tdi data/mask, error if tdo&mask != data */ 65 66 /* ATTACH ops */ 67 #define ATTACH_SWD_RESET 0 68 #define ATTACH_JTAG_TO_SWD 1 69 #define ATTACH_DORMANT_TO_SWD 2 70 #define ATTACH_SWD_TO_DORMANT 3 71 72 /* valid: target to host */ 73 #define CMD_STATUS 0x10 /* op=errorcode, arg=commands since last TXN_START */ 74 #define CMD_SWD_DATA 0x11 /* op=0 arg=count, payload: data x count */ 75 #define CMD_SWO_DATA 0x12 /* op=0 arg=count, payload: ((count+3)/4) words */ 76 #define CMD_JTAG_DATA 0x14 /* op=0 arg=bitcount, payload: (arg/32) words */ 77 78 /* valid: target to host async */ 79 #define CMD_DEBUG_PRINT 0x20 /* arg*4 bytes of ascii debug output */ 80 81 /* valid: bidirectional query/config messages */ 82 #define CMD_VERSION 0x30 /* arg=bcdversion (0x0100 etc) */ 83 #define CMD_BUILD_STR 0x31 /* arg=wordcount, payload = asciiz */ 84 #define CMD_BOARD_STR 0x32 /* arg=wordcount, payload = asciiz */ 85 #define CMD_RX_MAXDATA 0x33 /* arg=bytes, declares senders rx buffer size */ 86 #define CMD_CLOCK_KHZ 0x34 /* arg=khz, reports active clock rate */ 87 88 /* CMD_STATUS error codes */ 89 #define ERR_NONE 0 90 #define ERR_INTERNAL 1 91 #define ERR_TIMEOUT 2 92 #define ERR_IO 3 93 #define ERR_PARITY 4 94 #define ERR_BAD_MATCH 5 95 96 97 #define RSWD_VERSION_1_0 0x0100 98 #define RSWD_VERSION_1_1 0x0101 99 #define RSWD_VERSION_1_2 0x0102 100 #define RSWD_VERSION_1_3 0x0103 101 102 #define RSWD_VERSION RSWD_VERSION_1_3 103 104 // Pre-1.0 105 // - max packet size fixed at 2048 bytes 106 // 107 // Version 1.0 108 // - CMD_VERSION, CMD_BUILD_STR, CMD_BOARD_STR, CMD_RX_MAXDATA, 109 // CMD_CLOCK_KHZ added 110 // 111 // Version 1.1 112 // - CMD_SWO_DATA arg is now byte count, not word count 113 // 114 // Version 1.2 115 // - CMD_JTAG_IO, CMD_JTAG_RX, CMD_JTAG_TX, CMD_JTAG_VRFY, CMD_JTAG_DATA added 116 // 117 // Version 1.3 118 // - CMD_ATTACH ops (ATTACH_xyz), CMD_CLOCK_KHZ op indicates 0=SWCLK, 1=SWO 119 120 /* CMD_SWD_OP operations - combine for direct AP/DP io */ 121 #define OP_RD 0x00 122 #define OP_WR 0x01 123 #define OP_DP 0x00 124 #define OP_AP 0x02 125 #define OP_X0 0x00 126 #define OP_X4 0x04 127 #define OP_X8 0x08 128 #define OP_XC 0x0C 129 130 /* DP registers */ 131 #define DP_IDCODE (OP_DP|OP_X0) 132 #define DP_ABORT (OP_DP|OP_X0) 133 #define DP_DPCTRL (OP_DP|OP_X4) 134 #define DP_RESEND (OP_DP|OP_X8) 135 #define DP_SELECT (OP_DP|OP_X8) 136 #define DP_BUFFER (OP_DP|OP_XC) 137 138 #endif 139