* 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. *
***************************************************************************/
#ifdef HAVE_CONFIG_H
/* project specific includes */
#include <helper/binarybuffer.h>
#include <jtag/interface.h>
-#include <jtag/stlink/stlink_layout.h>
-#include <jtag/stlink/stlink_transport.h>
-#include <jtag/stlink/stlink_interface.h>
+#include <jtag/hla/hla_layout.h>
+#include <jtag/hla/hla_transport.h>
+#include <jtag/hla/hla_interface.h>
#include <target/target.h>
#include <target/cortex_m.h>
#define STLINK_NULL_EP 0
#define STLINK_RX_EP (1|ENDPOINT_IN)
#define STLINK_TX_EP (2|ENDPOINT_OUT)
+#define STLINK_TRACE_EP (3|ENDPOINT_IN)
#define STLINK_SG_SIZE (31)
#define STLINK_DATA_SIZE (4*128)
#define STLINK_CMD_SIZE_V2 (16)
/** */
uint8_t databuf[STLINK_DATA_SIZE];
/** */
- enum stlink_transports transport;
+ enum hl_transports transport;
/** */
struct stlink_usb_version version;
/** */
uint16_t pid;
/** this is the currently used jtag api */
enum stlink_jtag_api_version jtag_api;
+ /** */
+ struct {
+ /** whether SWO tracing is enabled or not */
+ bool enabled;
+ /** trace data destination file */
+ FILE *output_f;
+ /** trace module source clock (for prescaler) */
+ uint32_t source_hz;
+ /** trace module clock prescaler */
+ uint32_t prescale;
+ } trace;
};
#define STLINK_DEBUG_ERR_OK 0x80
#define STLINK_DFU_COMMAND 0xF3
#define STLINK_SWIM_COMMAND 0xF4
#define STLINK_GET_CURRENT_MODE 0xF5
+#define STLINK_GET_TARGET_VOLTAGE 0xF7
#define STLINK_DEV_DFU_MODE 0x00
#define STLINK_DEV_MASS_MODE 0x01
#define STLINK_DEBUG_APIV2_GETLASTRWSTATUS 0x3B
#define STLINK_DEBUG_APIV2_DRIVE_NRST 0x3C
+#define STLINK_DEBUG_APIV2_START_TRACE_RX 0x40
+#define STLINK_DEBUG_APIV2_STOP_TRACE_RX 0x41
+#define STLINK_DEBUG_APIV2_GET_TRACE_NB 0x42
+
#define STLINK_DEBUG_APIV2_DRIVE_NRST_LOW 0x00
#define STLINK_DEBUG_APIV2_DRIVE_NRST_HIGH 0x01
#define STLINK_DEBUG_APIV2_DRIVE_NRST_PULSE 0x02
+#define STLINK_TRACE_SIZE 1024
+#define STLINK_TRACE_MAX_HZ 2000000
+#define STLINK_TRACE_MIN_VERSION 13
+
/** */
enum stlink_mode {
STLINK_MODE_UNKNOWN = 0,
return ERROR_OK;
}
+/** */
+static int stlink_usb_read_trace(void *handle, const uint8_t *buf, int size)
+{
+ struct stlink_usb_handle_s *h;
+
+ assert(handle != NULL);
+
+ h = (struct stlink_usb_handle_s *)handle;
+
+ assert(h->version.stlink >= 2);
+
+ if (jtag_libusb_bulk_read(h->fd, STLINK_TRACE_EP, (char *)buf,
+ size, 1000) != size) {
+ LOG_ERROR("bulk trace read failed");
+ return ERROR_FAIL;
+ }
+
+ return ERROR_OK;
+}
+
/** */
static void stlink_usb_xfer_v1_create_cmd(void *handle, uint8_t direction, uint32_t size)
{
else
h->version.jtag_api_max = STLINK_JTAG_API_V1;
- LOG_DEBUG("STLINK v%d JTAG v%d API v%d SWIM v%d VID 0x%04X PID 0x%04X",
+ LOG_INFO("STLINK v%d JTAG v%d API v%d SWIM v%d VID 0x%04X PID 0x%04X",
h->version.stlink,
h->version.jtag,
(h->version.jtag_api_max == STLINK_JTAG_API_V1) ? 1 : 2,
return ERROR_OK;
}
+static int stlink_usb_check_voltage(void *handle, float *target_voltage)
+{
+ struct stlink_usb_handle_s *h;
+ uint32_t adc_results[2];
+
+ h = (struct stlink_usb_handle_s *)handle;
+
+ /* only supported by stlink/v2 and for firmware >= 13 */
+ if (h->version.stlink == 1 || h->version.jtag < 13)
+ return ERROR_COMMAND_NOTFOUND;
+
+ stlink_usb_init_buffer(handle, STLINK_RX_EP, 8);
+
+ h->cmdbuf[h->cmdidx++] = STLINK_GET_TARGET_VOLTAGE;
+
+ int result = stlink_usb_xfer(handle, h->databuf, 8);
+
+ if (result != ERROR_OK)
+ return result;
+
+ /* convert result */
+ adc_results[0] = le_to_h_u32(h->databuf);
+ adc_results[1] = le_to_h_u32(h->databuf + 4);
+
+ *target_voltage = 0;
+
+ if (adc_results[0])
+ *target_voltage = 2 * ((float)adc_results[1]) * (float)(1.2 / adc_results[0]);
+
+ LOG_INFO("Target voltage: %f", (double)*target_voltage);
+
+ return ERROR_OK;
+}
+
/** */
static int stlink_usb_current_mode(void *handle, uint8_t *mode)
{
return ERROR_OK;
}
+static int stlink_usb_assert_srst(void *handle, int srst);
+
/** */
-static int stlink_usb_init_mode(void *handle)
+static int stlink_usb_init_mode(void *handle, bool connect_under_reset)
{
int res;
uint8_t mode;
if (res != ERROR_OK)
return res;
+ /* we check the target voltage here as an aid to debugging connection problems.
+ * the stlink requires the target Vdd to be connected for reliable debugging.
+ * this cmd is supported in all modes except DFU
+ */
+ if (mode != STLINK_DEV_DFU_MODE) {
+
+ float target_voltage;
+
+ /* check target voltage (if supported) */
+ res = stlink_usb_check_voltage(h, &target_voltage);
+
+ if (res != ERROR_OK) {
+ if (res != ERROR_COMMAND_NOTFOUND)
+ LOG_ERROR("voltage check failed");
+ /* attempt to continue as it is not a catastrophic failure */
+ } else {
+ /* check for a sensible target voltage, operating range is 1.65-5.5v
+ * according to datasheet */
+ if (target_voltage < 1.5)
+ LOG_ERROR("target voltage may be too low for reliable debugging");
+ }
+ }
+
LOG_DEBUG("MODE: 0x%02X", mode);
/* set selected mode */
switch (h->transport) {
- case STLINK_TRANSPORT_SWD:
+ case HL_TRANSPORT_SWD:
emode = STLINK_MODE_DEBUG_SWD;
break;
- case STLINK_TRANSPORT_JTAG:
+ case HL_TRANSPORT_JTAG:
emode = STLINK_MODE_DEBUG_JTAG;
break;
- case STLINK_TRANSPORT_SWIM:
+ case HL_TRANSPORT_SWIM:
emode = STLINK_MODE_DEBUG_SWIM;
break;
default:
return ERROR_FAIL;
}
+ if (connect_under_reset) {
+ res = stlink_usb_assert_srst(handle, 0);
+ if (res != ERROR_OK)
+ return res;
+ }
+
res = stlink_usb_mode_enter(handle, emode);
if (res != ERROR_OK)
return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
}
+/** */
+static void stlink_usb_trace_read(void *handle)
+{
+ struct stlink_usb_handle_s *h;
+
+ assert(handle != NULL);
+
+ h = (struct stlink_usb_handle_s *)handle;
+
+ if (h->trace.enabled && h->version.jtag >= STLINK_TRACE_MIN_VERSION) {
+ int res;
+
+ stlink_usb_init_buffer(handle, STLINK_RX_EP, 10);
+
+ h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
+ h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_GET_TRACE_NB;
+
+ res = stlink_usb_xfer(handle, h->databuf, 2);
+ if (res == ERROR_OK) {
+ uint8_t buf[STLINK_TRACE_SIZE];
+ size_t size = le_to_h_u16(h->databuf);
+
+ if (size > 0) {
+ size = size < sizeof(buf) ? size : sizeof(buf) - 1;
+
+ res = stlink_usb_read_trace(handle, buf, size);
+ if (res == ERROR_OK) {
+ /* Log retrieved trace output */
+ if (fwrite(buf, 1, size, h->trace.output_f) > 0)
+ fflush(h->trace.output_f);
+ }
+ }
+ }
+ }
+}
+
static enum target_state stlink_usb_v2_get_status(void *handle)
{
int result;
else if (status & S_RESET_ST)
return TARGET_RESET;
+ stlink_usb_trace_read(handle);
+
return TARGET_RUNNING;
}
return h->databuf[0] == STLINK_DEBUG_ERR_OK ? ERROR_OK : ERROR_FAIL;
}
+/** */
+static int stlink_configure_target_trace_port(void *handle)
+{
+ int res;
+ uint32_t reg;
+ struct stlink_usb_handle_s *h;
+
+ assert(handle != NULL);
+
+ h = (struct stlink_usb_handle_s *)handle;
+
+ /* configure the TPI */
+
+ /* enable the trace subsystem */
+ res = stlink_usb_v2_read_debug_reg(handle, DCB_DEMCR, ®);
+ if (res != ERROR_OK)
+ goto out;
+ res = stlink_usb_write_debug_reg(handle, DCB_DEMCR, TRCENA|reg);
+ if (res != ERROR_OK)
+ goto out;
+ /* set the TPI clock prescaler */
+ res = stlink_usb_write_debug_reg(handle, TPI_ACPR, h->trace.prescale);
+ if (res != ERROR_OK)
+ goto out;
+ /* select the pin protocol. The STLinkv2 only supports asynchronous
+ * UART emulation (NRZ) mode, so that's what we pick. */
+ res = stlink_usb_write_debug_reg(handle, TPI_SPPR, 0x02);
+ if (res != ERROR_OK)
+ goto out;
+ /* disable continuous formatting */
+ res = stlink_usb_write_debug_reg(handle, TPI_FFCR, (1<<8));
+ if (res != ERROR_OK)
+ goto out;
+
+ /* configure the ITM */
+
+ /* unlock access to the ITM registers */
+ res = stlink_usb_write_debug_reg(handle, ITM_LAR, 0xC5ACCE55);
+ if (res != ERROR_OK)
+ goto out;
+ /* enable trace with ATB ID 1 */
+ res = stlink_usb_write_debug_reg(handle, ITM_TCR, (1<<16)|(1<<0)|(1<<2));
+ if (res != ERROR_OK)
+ goto out;
+ /* trace privilege */
+ res = stlink_usb_write_debug_reg(handle, ITM_TPR, 1);
+ if (res != ERROR_OK)
+ goto out;
+ /* trace port enable (port 0) */
+ res = stlink_usb_write_debug_reg(handle, ITM_TER, (1<<0));
+ if (res != ERROR_OK)
+ goto out;
+
+ res = ERROR_OK;
+out:
+ return res;
+}
+
+/** */
+static void stlink_usb_trace_disable(void *handle)
+{
+ int res = ERROR_OK;
+ struct stlink_usb_handle_s *h;
+
+ assert(handle != NULL);
+
+ h = (struct stlink_usb_handle_s *)handle;
+
+ assert(h->version.jtag >= STLINK_TRACE_MIN_VERSION);
+
+ LOG_DEBUG("Tracing: disable\n");
+
+ stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
+ h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
+ h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_STOP_TRACE_RX;
+ res = stlink_usb_xfer(handle, h->databuf, 2);
+
+ if (res == ERROR_OK)
+ h->trace.enabled = false;
+}
+
+
+/** */
+static int stlink_usb_trace_enable(void *handle)
+{
+ int res;
+ struct stlink_usb_handle_s *h;
+
+ assert(handle != NULL);
+
+ h = (struct stlink_usb_handle_s *)handle;
+
+ if (h->version.jtag >= STLINK_TRACE_MIN_VERSION) {
+ uint32_t trace_hz;
+
+ res = stlink_configure_target_trace_port(handle);
+ if (res != ERROR_OK)
+ LOG_ERROR("Unable to configure tracing on target\n");
+
+ trace_hz = h->trace.prescale > 0 ?
+ h->trace.source_hz / (h->trace.prescale + 1) :
+ h->trace.source_hz;
+
+ stlink_usb_init_buffer(handle, STLINK_RX_EP, 10);
+
+ h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_COMMAND;
+ h->cmdbuf[h->cmdidx++] = STLINK_DEBUG_APIV2_START_TRACE_RX;
+ h_u16_to_le(h->cmdbuf+h->cmdidx, (uint16_t)STLINK_TRACE_SIZE);
+ h->cmdidx += 2;
+ h_u32_to_le(h->cmdbuf+h->cmdidx, trace_hz);
+ h->cmdidx += 4;
+
+ res = stlink_usb_xfer(handle, h->databuf, 2);
+
+ if (res == ERROR_OK) {
+ h->trace.enabled = true;
+ LOG_DEBUG("Tracing: recording at %uHz\n", trace_hz);
+ }
+ } else {
+ LOG_ERROR("Tracing is not supported by this version.");
+ res = ERROR_FAIL;
+ }
+
+ return res;
+}
+
/** */
static int stlink_usb_run(void *handle)
{
h = (struct stlink_usb_handle_s *)handle;
- if (h->jtag_api == STLINK_JTAG_API_V2)
- return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_DEBUGEN);
+ if (h->jtag_api == STLINK_JTAG_API_V2) {
+ res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_DEBUGEN);
+
+ /* Try to start tracing, if requested */
+ if (res == ERROR_OK && h->trace.output_f) {
+ if (stlink_usb_trace_enable(handle) == ERROR_OK)
+ LOG_DEBUG("Tracing: enabled\n");
+ else
+ LOG_ERROR("Tracing: enable failed\n");
+ }
+
+ return res;
+ }
stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
h = (struct stlink_usb_handle_s *)handle;
- if (h->jtag_api == STLINK_JTAG_API_V2)
- return stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
+ if (h->jtag_api == STLINK_JTAG_API_V2) {
+ res = stlink_usb_write_debug_reg(handle, DCB_DHCSR, DBGKEY|C_HALT|C_DEBUGEN);
+
+ if (res == ERROR_OK && h->trace.enabled)
+ stlink_usb_trace_disable(handle);
+
+ return res;
+ }
stlink_usb_init_buffer(handle, STLINK_RX_EP, 2);
}
/** */
-static int stlink_usb_open(struct stlink_interface_param_s *param, void **fd)
+static int stlink_usb_close(void *fd)
+{
+ struct stlink_usb_handle_s *h;
+
+ h = (struct stlink_usb_handle_s *)fd;
+
+ if (h->fd)
+ jtag_libusb_close(h->fd);
+
+ free(fd);
+
+ return ERROR_OK;
+}
+
+/** */
+static int stlink_usb_open(struct hl_interface_param_s *param, void **fd)
{
- int err;
+ int err, retry_count = 1;
struct stlink_usb_handle_s *h;
enum stlink_jtag_api_version api;
LOG_DEBUG("stlink_usb_open");
- h = malloc(sizeof(struct stlink_usb_handle_s));
+ h = calloc(1, sizeof(struct stlink_usb_handle_s));
if (h == 0) {
LOG_DEBUG("malloc failed");
h->transport = param->transport;
+ /* set max read/write buffer size in bytes */
+ param->max_buffer = 512;
+
const uint16_t vids[] = { param->vid, 0 };
const uint16_t pids[] = { param->pid, 0 };
LOG_DEBUG("transport: %d vid: 0x%04x pid: 0x%04x", param->transport,
param->vid, param->pid);
- if (jtag_libusb_open(vids, pids, &h->fd) != ERROR_OK) {
- LOG_ERROR("open failed");
- return ERROR_FAIL;
- }
+ /*
+ On certain host USB configurations(e.g. MacBook Air)
+ STLINKv2 dongle seems to have its FW in a funky state if,
+ after plugging it in, you try to use openocd with it more
+ then once (by launching and closing openocd). In cases like
+ that initial attempt to read the FW info via
+ stlink_usb_version will fail and the device has to be reset
+ in order to become operational.
+ */
+ do {
+ if (jtag_libusb_open(vids, pids, &h->fd) != ERROR_OK) {
+ LOG_ERROR("open failed");
+ goto error_open;
+ }
- jtag_libusb_set_configuration(h->fd, 0);
+ jtag_libusb_set_configuration(h->fd, 0);
- if (jtag_libusb_claim_interface(h->fd, 0) != ERROR_OK) {
- LOG_DEBUG("claim interface failed");
- return ERROR_FAIL;
- }
+ if (jtag_libusb_claim_interface(h->fd, 0) != ERROR_OK) {
+ LOG_DEBUG("claim interface failed");
+ goto error_open;
+ }
- /* wrap version for first read */
- switch (param->pid) {
+ /* wrap version for first read */
+ switch (param->pid) {
case 0x3744:
h->version.stlink = 1;
break;
default:
h->version.stlink = 2;
break;
- }
+ }
- /* get the device version */
- err = stlink_usb_version(h);
+ /* get the device version */
+ err = stlink_usb_version(h);
- if (err != ERROR_OK) {
- LOG_ERROR("read version failed");
- jtag_libusb_close(h->fd);
- free(h);
- return err;
- }
+ if (err == ERROR_OK) {
+ break;
+ } else if (h->version.stlink == 1 ||
+ retry_count == 0) {
+ LOG_ERROR("read version failed");
+ goto error_open;
+ } else {
+ err = jtag_libusb_release_interface(h->fd, 0);
+ if (err != ERROR_OK) {
+ LOG_ERROR("release interface failed");
+ goto error_open;
+ }
+
+ err = jtag_libusb_reset_device(h->fd);
+ if (err != ERROR_OK) {
+ LOG_ERROR("reset device failed");
+ goto error_open;
+ }
+
+ jtag_libusb_close(h->fd);
+ /*
+ Give the device one second to settle down and
+ reenumerate.
+ */
+ usleep(1 * 1000 * 1000);
+ retry_count--;
+ }
+ } while (1);
/* compare usb vid/pid */
if ((param->vid != h->vid) || (param->pid != h->pid))
err = ERROR_OK;
switch (h->transport) {
- case STLINK_TRANSPORT_SWD:
- case STLINK_TRANSPORT_JTAG:
+ case HL_TRANSPORT_SWD:
+ case HL_TRANSPORT_JTAG:
if (h->version.jtag == 0)
err = ERROR_FAIL;
break;
- case STLINK_TRANSPORT_SWIM:
+ case HL_TRANSPORT_SWIM:
if (h->version.swim == 0)
err = ERROR_FAIL;
break;
if (err != ERROR_OK) {
LOG_ERROR("mode (transport) not supported by device");
- jtag_libusb_close(h->fd);
- free(h);
- return err;
+ goto error_open;
}
api = h->version.jtag_api_max;
/* set the used jtag api, this will default to the newest supported version */
h->jtag_api = api;
+ if (h->jtag_api >= 2 && param->trace_f && param->trace_source_hz > 0) {
+ uint32_t prescale;
+
+ prescale = param->trace_source_hz > STLINK_TRACE_MAX_HZ ?
+ (param->trace_source_hz / STLINK_TRACE_MAX_HZ) - 1 : 0;
+
+ h->trace.output_f = param->trace_f;
+ h->trace.source_hz = param->trace_source_hz;
+ h->trace.prescale = prescale;
+ }
+
/* initialize the debug hardware */
- err = stlink_usb_init_mode(h);
+ err = stlink_usb_init_mode(h, param->connect_under_reset);
if (err != ERROR_OK) {
LOG_ERROR("init mode failed");
- jtag_libusb_close(h->fd);
- free(h);
- return err;
+ goto error_open;
}
*fd = h;
return ERROR_OK;
-}
-/** */
-static int stlink_usb_close(void *fd)
-{
- return ERROR_OK;
+error_open:
+ stlink_usb_close(h);
+
+ return ERROR_FAIL;
}
/** */
-struct stlink_layout_api_s stlink_usb_layout_api = {
+struct hl_layout_api_s stlink_usb_layout_api = {
/** */
.open = stlink_usb_open,
/** */
projects / fw / openocd / blobdiff