interface.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
 *   Copyright (C) 2009 Zachary T Welch                                    *
 *   zw@superlucidity.net                                                  *
 ***************************************************************************/
 
#ifndef OPENOCD_JTAG_INTERFACE_H
#define OPENOCD_JTAG_INTERFACE_H
 
#include <jtag/jtag.h>
#include <jtag/swim.h>
#include <target/arm_tpiu_swo.h>
#include <transport/transport.h>
 
/* @file
 * The "Cable Helper API" is what the cable drivers can use to help
 * implement their "Cable API".  So a Cable Helper API is a set of
 * helper functions used by cable drivers, and this is different from a
 * Cable API.  A "Cable API" is what higher level code used to talk to a
 * cable.
 */
 
 
void tap_set_state_impl(enum tap_state new_state);
 
#define tap_set_state(new_state) \
    do { \
        LOG_DEBUG_IO("tap_set_state(%s)", tap_state_name(new_state)); \
        tap_set_state_impl(new_state); \
    } while (0)
 
enum tap_state tap_get_state(void);
 
void tap_set_end_state(enum tap_state new_end_state);
 
int tap_set_end_state_stable(enum tap_state new_end_state);
 
enum tap_state tap_get_end_state(void);
 
int tap_get_tms_path(enum tap_state from, enum tap_state to);
 
int tap_get_tms_path_len(enum tap_state from, enum tap_state to);
 
 
int tap_move_ndx(enum tap_state astate);
 
bool tap_is_state_stable(enum tap_state astate);
 
enum tap_state tap_state_transition(enum tap_state current_state, bool tms);
 
static inline bool tap_is_state_next(enum tap_state from, enum tap_state to)
{
    return tap_state_transition(from, false) == to
        || tap_state_transition(from, true) == to;
}
 
void tap_use_new_tms_table(bool use_new);
bool tap_uses_new_tms_table(void);
 
enum tap_state jtag_debug_state_machine_(const void *tms_buf, const void *tdi_buf,
        unsigned int tap_len, enum tap_state start_tap_state);
 
static inline enum tap_state jtag_debug_state_machine(const void *tms_buf,
        const void *tdi_buf, unsigned int tap_len, enum tap_state start_tap_state)
{
    if (LOG_LEVEL_IS(LOG_LVL_DEBUG_IO))
        return jtag_debug_state_machine_(tms_buf, tdi_buf, tap_len, start_tap_state);
    else
        return start_tap_state;
}
 
struct jtag_interface {
    unsigned int supported;
#define DEBUG_CAP_TMS_SEQ   (1 << 0)
 
    int (*execute_queue)(struct jtag_command *cmd_queue);
};
 
struct adapter_driver {
    const char * const name;
 
    unsigned int transport_ids;
 
    unsigned int transport_preferred_id;
 
    const struct command_registration *commands;
 
    int (*init)(void);
 
    int (*quit)(void);
 
    int (*reset)(int srst, int trst);
 
    int (*speed)(int speed);
 
    int (*khz)(int khz, int *jtag_speed);
 
    int (*speed_div)(int speed, int *khz);
 
    int (*power_dropout)(int *power_dropout);
 
    int (*srst_asserted)(int *srst_asserted);
 
    int (*config_trace)(bool enabled, enum tpiu_pin_protocol pin_protocol,
        uint32_t port_size, unsigned int *trace_freq,
        unsigned int traceclkin_freq, uint16_t *prescaler);
 
    int (*poll_trace)(uint8_t *buf, size_t *size);
 
    struct jtag_interface *jtag_ops;
 
    const struct swd_driver *swd_ops;
 
    /* DAP APIs over JTAG transport */
    const struct dap_ops *dap_jtag_ops;
 
    /* DAP APIs over SWD transport */
    const struct dap_ops *dap_swd_ops;
 
    /* SWIM APIs */
    const struct swim_driver *swim_ops;
};
 
int adapter_resets(int assert_trst, int assert_srst);
int adapter_assert_reset(void);
int adapter_deassert_reset(void);
int adapter_config_trace(bool enabled, enum tpiu_pin_protocol pin_protocol,
        uint32_t port_size, unsigned int *trace_freq,
        unsigned int traceclkin_freq, uint16_t *prescaler);
int adapter_poll_trace(uint8_t *buf, size_t *size);
 
// Keep in alphabetic order this list of drivers
extern struct adapter_driver am335xgpio_adapter_driver;
extern struct adapter_driver amt_jtagaccel_adapter_driver;
extern struct adapter_driver angie_adapter_driver;
extern struct adapter_driver armjtagew_adapter_driver;
extern struct adapter_driver at91rm9200_adapter_driver;
extern struct adapter_driver bcm2835gpio_adapter_driver;
extern struct adapter_driver buspirate_adapter_driver;
extern struct adapter_driver ch347_adapter_driver;
extern struct adapter_driver cklink_adapter_driver;
extern struct adapter_driver cmsis_dap_adapter_driver;
extern struct adapter_driver dmem_dap_adapter_driver;
extern struct adapter_driver dummy_adapter_driver;
extern struct adapter_driver ep93xx_adapter_driver;
extern struct adapter_driver esp_usb_adapter_driver;
extern struct adapter_driver eud_adapter_driver;
extern struct adapter_driver ft232r_adapter_driver;
extern struct adapter_driver ftdi_adapter_driver;
extern struct adapter_driver gw16012_adapter_driver;
extern struct adapter_driver hl_adapter_driver;
extern struct adapter_driver imx_gpio_adapter_driver;
extern struct adapter_driver jlink_adapter_driver;
extern struct adapter_driver jtag_dpi_adapter_driver;
extern struct adapter_driver jtag_vpi_adapter_driver;
extern struct adapter_driver kitprog_adapter_driver;
extern struct adapter_driver linuxgpiod_adapter_driver;
extern struct adapter_driver linuxspidev_adapter_driver;
extern struct adapter_driver opendous_adapter_driver;
extern struct adapter_driver openjtag_adapter_driver;
extern struct adapter_driver osbdm_adapter_driver;
extern struct adapter_driver parport_adapter_driver;
extern struct adapter_driver presto_adapter_driver;
extern struct adapter_driver remote_bitbang_adapter_driver;
extern struct adapter_driver rlink_adapter_driver;
extern struct adapter_driver rshim_dap_adapter_driver;
extern struct adapter_driver stlink_dap_adapter_driver;
extern struct adapter_driver sysfsgpio_adapter_driver;
extern struct adapter_driver ulink_adapter_driver;
extern struct adapter_driver usb_blaster_adapter_driver;
extern struct adapter_driver usbprog_adapter_driver;
extern struct adapter_driver vdebug_adapter_driver;
extern struct adapter_driver vsllink_adapter_driver;
extern struct adapter_driver xds110_adapter_driver;
extern struct adapter_driver xlnx_axi_xvc_adapter_driver;
extern struct adapter_driver xlnx_pcie_xvc_adapter_driver;
extern struct adapter_driver xvc_adapter_driver;
 
#endif /* OPENOCD_JTAG_INTERFACE_H */