adapter.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) 2018 Pengutronix, Oleksij Rempel <kernel@pengutronix.de>
 */
 
#ifndef OPENOCD_JTAG_ADAPTER_H
#define OPENOCD_JTAG_ADAPTER_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <limits.h>
 
enum adapter_gpio_drive_mode {
    ADAPTER_GPIO_DRIVE_MODE_PUSH_PULL,
    ADAPTER_GPIO_DRIVE_MODE_OPEN_DRAIN,
    ADAPTER_GPIO_DRIVE_MODE_OPEN_SOURCE,
};
 
enum adapter_gpio_direction {
    ADAPTER_GPIO_DIRECTION_INPUT,
    ADAPTER_GPIO_DIRECTION_OUTPUT,
    ADAPTER_GPIO_DIRECTION_BIDIRECTIONAL,
};
 
enum adapter_gpio_init_state {
    ADAPTER_GPIO_INIT_STATE_INACTIVE, /* Should be zero so it is the default state */
    ADAPTER_GPIO_INIT_STATE_ACTIVE,
    ADAPTER_GPIO_INIT_STATE_INPUT,
};
 
enum adapter_gpio_exit_state {
    ADAPTER_GPIO_EXIT_STATE_NO_CHANGE, /* Should be zero so it is the default state */
    ADAPTER_GPIO_EXIT_STATE_INACTIVE,
    ADAPTER_GPIO_EXIT_STATE_ACTIVE,
    ADAPTER_GPIO_EXIT_STATE_INPUT,
};
 
enum adapter_gpio_pull {
    ADAPTER_GPIO_PULL_NONE,
    ADAPTER_GPIO_PULL_UP,
    ADAPTER_GPIO_PULL_DOWN,
};
 
enum adapter_gpio_config_index {
    ADAPTER_GPIO_IDX_TDO,
    ADAPTER_GPIO_IDX_TDI,
    ADAPTER_GPIO_IDX_TMS,
    ADAPTER_GPIO_IDX_TCK,
    ADAPTER_GPIO_IDX_TRST,
    ADAPTER_GPIO_IDX_SWDIO,
    ADAPTER_GPIO_IDX_SWDIO_DIR,
    ADAPTER_GPIO_IDX_SWCLK,
    ADAPTER_GPIO_IDX_SRST,
    ADAPTER_GPIO_IDX_LED,
    ADAPTER_GPIO_IDX_USER0,
    ADAPTER_GPIO_IDX_NUM, /* must be the last item */
};
 
struct adapter_gpio_config {
    unsigned int gpio_num;
    unsigned int chip_num;
    enum adapter_gpio_drive_mode drive; /* For outputs only */
    enum adapter_gpio_init_state init_state;
    enum adapter_gpio_exit_state exit_state;
    bool active_low;
    enum adapter_gpio_pull pull;
};
 
struct command_context;
 
int adapter_register_commands(struct command_context *ctx);
 
int adapter_init(struct command_context *cmd_ctx);
 
int adapter_quit(void);
 
bool is_adapter_initialized(void);
 
const char *adapter_usb_get_location(void);
 
bool adapter_usb_location_equal(uint8_t dev_bus, uint8_t *port_path, size_t path_len);
 
int adapter_get_speed(int *speed);
 
int adapter_get_speed_readable(int *speed);
 
int adapter_config_rclk(unsigned int fallback_speed_khz);
 
unsigned int adapter_get_speed_khz(void);
 
const char *adapter_get_required_serial(void);
 
const char *adapter_gpio_get_name(enum adapter_gpio_config_index idx);
 
const struct adapter_gpio_config *adapter_gpio_get_config(void);
 
#define ADAPTER_GPIO_NOT_SET UINT_MAX
 
#endif /* OPENOCD_JTAG_ADAPTER_H */