amt_jtagaccel.c

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                                                   *
 ***************************************************************************/
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#include <jtag/adapter.h>
#include <jtag/interface.h>
 
#if PARPORT_USE_PPDEV == 1
#include <linux/parport.h>
#include <linux/ppdev.h>
#include <sys/ioctl.h>
#else   /* not PARPORT_USE_PPDEV */
#ifndef _WIN32
#include <sys/io.h>
#endif
#endif
 
#if PARPORT_USE_GIVEIO == 1
#if IS_CYGWIN == 1
#include <windows.h>
#endif
#endif
 
/* configuration */
static uint16_t amt_jtagaccel_port;
 
/* interface variables
 */
static uint8_t aw_control_rst;
static uint8_t aw_control_fsm = 0x10;
static uint8_t aw_control_baudrate = 0x20;
 
static int rtck_enabled;
 
#if PARPORT_USE_PPDEV == 1
static int device_handle;
 
static const int addr_mode = IEEE1284_MODE_EPP | IEEE1284_ADDR;
 
/* FIXME do something sane when these ioctl/read/write calls fail. */
 
#define AMT_AW(val) \
    do { \
        int __retval; \
        \
        __retval = ioctl(device_handle, PPSETMODE, &addr_mode); \
        assert(__retval >= 0); \
        __retval = write(device_handle, &val, 1); \
        assert(__retval >= 0); \
    } while (0)
#define AMT_AR(val) \
    do { \
        int __retval; \
        \
        __retval = ioctl(device_handle, PPSETMODE, &addr_mode); \
        assert(__retval >= 0); \
        __retval = read(device_handle, &val, 1); \
        assert(__retval >= 0); \
    } while (0)
 
static const int data_mode = IEEE1284_MODE_EPP | IEEE1284_DATA;
 
#define AMT_DW(val) \
    do { \
        int __retval; \
        \
        __retval = ioctl(device_handle, PPSETMODE, &data_mode); \
        assert(__retval >= 0); \
        __retval = write(device_handle, &val, 1); \
        assert(__retval >= 0); \
    } while (0)
#define AMT_DR(val) \
    do { \
        int __retval; \
        \
        __retval = ioctl(device_handle, PPSETMODE, &data_mode); \
        assert(__retval >= 0); \
        __retval = read(device_handle, &val, 1); \
        assert(__retval >= 0); \
    } while (0)
 
#else
 
#define AMT_AW(val) do { outb(val, amt_jtagaccel_port + 3); } while (0)
#define AMT_AR(val) do { val = inb(amt_jtagaccel_port + 3); } while (0)
#define AMT_DW(val) do { outb(val, amt_jtagaccel_port + 4); } while (0)
#define AMT_DR(val) do { val = inb(amt_jtagaccel_port + 4); } while (0)
 
#endif  /* PARPORT_USE_PPDEV */
 
/* tap_move[i][j]: tap movement command to go from state i to state j
 * 0: Test-Logic-Reset
 * 1: Run-Test/Idle
 * 2: Shift-DR
 * 3: Pause-DR
 * 4: Shift-IR
 * 5: Pause-IR
 */
static const uint8_t amt_jtagaccel_tap_move[6][6][2] = {
    /*     RESET         IDLE        DRSHIFT       DRPAUSE       IRSHIFT       IRPAUSE             */
    { {0x1f, 0x00}, {0x0f, 0x00}, {0x05, 0x00}, {0x0a, 0x00}, {0x06, 0x00}, {0x96, 0x00} }, /* RESET */
    { {0x1f, 0x00}, {0x00, 0x00}, {0x04, 0x00}, {0x05, 0x00}, {0x06, 0x00}, {0x0b, 0x00} }, /* IDLE */
    { {0x1f, 0x00}, {0x0d, 0x00}, {0x00, 0x00}, {0x01, 0x00}, {0x8f, 0x09}, {0x8f, 0x01} }, /* DRSHIFT  */
    { {0x1f, 0x00}, {0x0c, 0x00}, {0x08, 0x00}, {0x00, 0x00}, {0x8f, 0x09}, {0x8f, 0x01} }, /* DRPAUSE  */
    { {0x1f, 0x00}, {0x0d, 0x00}, {0x07, 0x00}, {0x97, 0x00}, {0x00, 0x00}, {0x01, 0x00} }, /* IRSHIFT  */
    { {0x1f, 0x00}, {0x0c, 0x00}, {0x07, 0x00}, {0x97, 0x00}, {0x08, 0x00}, {0x00, 0x00} }, /* IRPAUSE  */
};
 
static void amt_jtagaccel_reset(int trst, int srst)
{
    if (trst == 1)
        aw_control_rst |= 0x4;
    else if (trst == 0)
        aw_control_rst &= ~0x4;
 
    if (srst == 1)
        aw_control_rst |= 0x1;
    else if (srst == 0)
        aw_control_rst &= ~0x1;
 
    AMT_AW(aw_control_rst);
}
 
static int amt_jtagaccel_speed(int speed)
{
    aw_control_baudrate &= 0xf0;
    aw_control_baudrate |= speed & 0x0f;
    AMT_AW(aw_control_baudrate);
 
    return ERROR_OK;
}
 
static void amt_jtagaccel_end_state(tap_state_t state)
{
    if (tap_is_state_stable(state))
        tap_set_end_state(state);
    else {
        LOG_ERROR("BUG: %i is not a valid end state", state);
        exit(-1);
    }
}
 
static void amt_wait_scan_busy(void)
{
    int timeout = 4096;
    uint8_t ar_status;
 
    AMT_AR(ar_status);
    while (((ar_status) & 0x80) && (timeout-- > 0))
        AMT_AR(ar_status);
 
    if (ar_status & 0x80) {
        LOG_ERROR(
            "amt_jtagaccel timed out while waiting for end of scan, rtck was %s, last AR_STATUS: 0x%2.2x",
            (rtck_enabled) ? "enabled" : "disabled",
            ar_status);
        exit(-1);
    }
}
 
static void amt_jtagaccel_state_move(void)
{
    uint8_t aw_scan_tms_5;
    uint8_t tms_scan[2];
 
    tap_state_t cur_state = tap_get_state();
    tap_state_t end_state = tap_get_end_state();
 
    tms_scan[0] = amt_jtagaccel_tap_move[tap_move_ndx(cur_state)][tap_move_ndx(end_state)][0];
    tms_scan[1] = amt_jtagaccel_tap_move[tap_move_ndx(cur_state)][tap_move_ndx(end_state)][1];
 
    aw_scan_tms_5 = 0x40 | (tms_scan[0] & 0x1f);
    AMT_AW(aw_scan_tms_5);
    int jtag_speed = 0;
    int retval = adapter_get_speed(&jtag_speed);
    assert(retval == ERROR_OK);
    if (jtag_speed > 3 || rtck_enabled)
        amt_wait_scan_busy();
 
    if (tms_scan[0] & 0x80) {
        aw_scan_tms_5 = 0x40 | (tms_scan[1] & 0x1f);
        AMT_AW(aw_scan_tms_5);
        if (jtag_speed > 3 || rtck_enabled)
            amt_wait_scan_busy();
    }
 
    tap_set_state(end_state);
}
 
static void amt_jtagaccel_runtest(unsigned int num_cycles)
{
    int i = 0;
    uint8_t aw_scan_tms_5;
    uint8_t aw_scan_tms_1to4;
 
    tap_state_t saved_end_state = tap_get_end_state();
 
    /* only do a state_move when we're not already in IDLE */
    if (tap_get_state() != TAP_IDLE) {
        amt_jtagaccel_end_state(TAP_IDLE);
        amt_jtagaccel_state_move();
    }
 
    while (num_cycles - i >= 5) {
        aw_scan_tms_5 = 0x40;
        AMT_AW(aw_scan_tms_5);
        i += 5;
    }
 
    if (num_cycles - i > 0) {
        aw_scan_tms_1to4 = 0x80 | ((num_cycles - i - 1) & 0x3) << 4;
        AMT_AW(aw_scan_tms_1to4);
    }
 
    amt_jtagaccel_end_state(saved_end_state);
    if (tap_get_state() != tap_get_end_state())
        amt_jtagaccel_state_move();
}
 
static void amt_jtagaccel_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size)
{
    int bits_left = scan_size;
    int bit_count = 0;
    tap_state_t saved_end_state = tap_get_end_state();
    uint8_t aw_tdi_option;
    uint8_t dw_tdi_scan;
    uint8_t dr_tdo;
    uint8_t aw_tms_scan;
    uint8_t tms_scan[2];
    int jtag_speed_var;
    int retval = adapter_get_speed(&jtag_speed_var);
    assert(retval == ERROR_OK);
 
    if (ir_scan)
        amt_jtagaccel_end_state(TAP_IRSHIFT);
    else
        amt_jtagaccel_end_state(TAP_DRSHIFT);
 
    /* Only move if we're not already there */
    if (tap_get_state() != tap_get_end_state())
        amt_jtagaccel_state_move();
 
    amt_jtagaccel_end_state(saved_end_state);
 
    /* handle unaligned bits at the beginning */
    if ((scan_size - 1) % 8) {
        aw_tdi_option = 0x30 | (((scan_size - 1) % 8) - 1);
        AMT_AW(aw_tdi_option);
 
        dw_tdi_scan = buf_get_u32(buffer, bit_count, (scan_size - 1) % 8) & 0xff;
        AMT_DW(dw_tdi_scan);
        if (jtag_speed_var > 3 || rtck_enabled)
            amt_wait_scan_busy();
 
        if ((type == SCAN_IN) || (type == SCAN_IO)) {
            AMT_DR(dr_tdo);
            dr_tdo = dr_tdo >> (8 - ((scan_size - 1) % 8));
            buf_set_u32(buffer, bit_count, (scan_size - 1) % 8, dr_tdo);
        }
 
        bit_count += (scan_size - 1) % 8;
        bits_left -= (scan_size - 1) % 8;
    }
 
    while (bits_left - 1 >= 8) {
        dw_tdi_scan = buf_get_u32(buffer, bit_count, 8) & 0xff;
        AMT_DW(dw_tdi_scan);
        if (jtag_speed_var > 3 || rtck_enabled)
            amt_wait_scan_busy();
 
        if ((type == SCAN_IN) || (type == SCAN_IO)) {
            AMT_DR(dr_tdo);
            buf_set_u32(buffer, bit_count, 8, dr_tdo);
        }
 
        bit_count += 8;
        bits_left -= 8;
    }
 
    tms_scan[0] =
        amt_jtagaccel_tap_move[tap_move_ndx(tap_get_state())][tap_move_ndx(tap_get_end_state())][0];
    tms_scan[1] =
        amt_jtagaccel_tap_move[tap_move_ndx(tap_get_state())][tap_move_ndx(tap_get_end_state())][1];
    aw_tms_scan = 0x40 | (tms_scan[0] & 0x1f) | (buf_get_u32(buffer, bit_count, 1) << 5);
    AMT_AW(aw_tms_scan);
    if (jtag_speed_var > 3 || rtck_enabled)
        amt_wait_scan_busy();
 
    if ((type == SCAN_IN) || (type == SCAN_IO)) {
        AMT_DR(dr_tdo);
        dr_tdo = dr_tdo >> 7;
        buf_set_u32(buffer, bit_count, 1, dr_tdo);
    }
 
    if (tms_scan[0] & 0x80) {
        aw_tms_scan = 0x40 | (tms_scan[1] & 0x1f);
        AMT_AW(aw_tms_scan);
        if (jtag_speed_var > 3 || rtck_enabled)
            amt_wait_scan_busy();
    }
    tap_set_state(tap_get_end_state());
}
 
static int amt_jtagaccel_execute_queue(struct jtag_command *cmd_queue)
{
    struct jtag_command *cmd = cmd_queue;   /* currently processed command */
    int scan_size;
    enum scan_type type;
    uint8_t *buffer;
    int retval;
 
    /* return ERROR_OK, unless a jtag_read_buffer returns a failed check
     * that wasn't handled by a caller-provided error handler
     */
    retval = ERROR_OK;
 
    while (cmd) {
        switch (cmd->type) {
            case JTAG_RESET:
                LOG_DEBUG_IO("reset trst: %i srst %i",
                        cmd->cmd.reset->trst,
                        cmd->cmd.reset->srst);
                if (cmd->cmd.reset->trst == 1)
                    tap_set_state(TAP_RESET);
                amt_jtagaccel_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
                break;
            case JTAG_RUNTEST:
                LOG_DEBUG_IO("runtest %i cycles, end in %i",
                        cmd->cmd.runtest->num_cycles,
                        cmd->cmd.runtest->end_state);
                amt_jtagaccel_end_state(cmd->cmd.runtest->end_state);
                amt_jtagaccel_runtest(cmd->cmd.runtest->num_cycles);
                break;
            case JTAG_TLR_RESET:
                LOG_DEBUG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
                amt_jtagaccel_end_state(cmd->cmd.statemove->end_state);
                amt_jtagaccel_state_move();
                break;
            case JTAG_SCAN:
                LOG_DEBUG_IO("scan end in %i", cmd->cmd.scan->end_state);
                amt_jtagaccel_end_state(cmd->cmd.scan->end_state);
                scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
                type = jtag_scan_type(cmd->cmd.scan);
                amt_jtagaccel_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size);
                if (jtag_read_buffer(buffer, cmd->cmd.scan) != ERROR_OK)
                    retval = ERROR_JTAG_QUEUE_FAILED;
                free(buffer);
                break;
            case JTAG_SLEEP:
                LOG_DEBUG_IO("sleep %" PRIu32, cmd->cmd.sleep->us);
                jtag_sleep(cmd->cmd.sleep->us);
                break;
            default:
                LOG_ERROR("BUG: unknown JTAG command type encountered");
                exit(-1);
        }
        cmd = cmd->next;
    }
 
    return retval;
}
 
#if PARPORT_USE_GIVEIO == 1
int amt_jtagaccel_get_giveio_access(void)
{
    HANDLE h;
    OSVERSIONINFO version;
 
    version.dwOSVersionInfoSize = sizeof(version);
    if (!GetVersionEx(&version)) {
        errno = EINVAL;
        return -1;
    }
    if (version.dwPlatformId != VER_PLATFORM_WIN32_NT)
        return 0;
 
    h = CreateFile("\\\\.\\giveio",
            GENERIC_READ,
            0,
            NULL,
            OPEN_EXISTING,
            FILE_ATTRIBUTE_NORMAL,
            NULL);
    if (h == INVALID_HANDLE_VALUE) {
        errno = ENODEV;
        return -1;
    }
 
    CloseHandle(h);
 
    return 0;
}
#endif
 
static int amt_jtagaccel_init(void)
{
#if PARPORT_USE_PPDEV == 1
    char buffer[256];
    int i = 0;
    uint8_t control_port;
#else
    uint8_t status_port;
#endif
    uint8_t ar_status;
 
#if PARPORT_USE_PPDEV == 1
    if (device_handle > 0) {
        LOG_ERROR("device is already opened");
        return ERROR_JTAG_INIT_FAILED;
    }
 
    snprintf(buffer, 256, "/dev/parport%d", amt_jtagaccel_port);
    device_handle = open(buffer, O_RDWR);
 
    if (device_handle < 0) {
        LOG_ERROR(
            "cannot open device. check it exists and that user read and write rights are set");
        return ERROR_JTAG_INIT_FAILED;
    }
 
    i = ioctl(device_handle, PPCLAIM);
    if (i < 0) {
        LOG_ERROR("cannot claim device");
        return ERROR_JTAG_INIT_FAILED;
    }
 
    i = IEEE1284_MODE_EPP;
    i = ioctl(device_handle, PPSETMODE, &i);
    if (i < 0) {
        LOG_ERROR(" cannot set compatible mode to device");
        return ERROR_JTAG_INIT_FAILED;
    }
 
    control_port = 0x00;
    i = ioctl(device_handle, PPWCONTROL, &control_port);
 
    control_port = 0x04;
    i = ioctl(device_handle, PPWCONTROL, &control_port);
 
#else
    if (amt_jtagaccel_port == 0) {
        amt_jtagaccel_port = 0x378;
        LOG_WARNING("No parport port specified, using default '0x378' (LPT1)");
    }
 
#if PARPORT_USE_GIVEIO == 1
    if (amt_jtagaccel_get_giveio_access() != 0) {
#else   /* PARPORT_USE_GIVEIO */
    if (ioperm(amt_jtagaccel_port, 5, 1) != 0) {
#endif  /* PARPORT_USE_GIVEIO */
        LOG_ERROR("missing privileges for direct i/o");
        return ERROR_JTAG_INIT_FAILED;
    }
 
    /* prepare epp port
     * clear timeout */
    status_port = inb(amt_jtagaccel_port + 1);
    outb(status_port | 0x1, amt_jtagaccel_port + 1);
 
    /* reset epp port */
    outb(0x00, amt_jtagaccel_port + 2);
    outb(0x04, amt_jtagaccel_port + 2);
#endif
 
    if (rtck_enabled) {
        /* set RTCK enable bit */
        aw_control_fsm |= 0x02;
    }
 
    /* enable JTAG port */
    aw_control_fsm |= 0x04;
    AMT_AW(aw_control_fsm);
 
    enum reset_types jtag_reset_config = jtag_get_reset_config();
    if (jtag_reset_config & RESET_TRST_OPEN_DRAIN)
        aw_control_rst &= ~0x8;
    else
        aw_control_rst |= 0x8;
 
    if (jtag_reset_config & RESET_SRST_PUSH_PULL)
        aw_control_rst &= ~0x2;
    else
        aw_control_rst |= 0x2;
 
    amt_jtagaccel_reset(0, 0);
 
    /* read status register */
    AMT_AR(ar_status);
    LOG_DEBUG("AR_STATUS: 0x%2.2x", ar_status);
 
    return ERROR_OK;
}
 
static int amt_jtagaccel_quit(void)
{
 
    return ERROR_OK;
}
 
COMMAND_HANDLER(amt_jtagaccel_handle_parport_port_command)
{
    if (CMD_ARGC == 1) {
        /* only if the port wasn't overwritten by cmdline */
        if (amt_jtagaccel_port == 0) {
            uint16_t port;
            COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], port);
            amt_jtagaccel_port = port;
        } else {
            LOG_ERROR("The parport port was already configured!");
            return ERROR_FAIL;
        }
    }
 
    command_print(CMD, "parport port = %u", amt_jtagaccel_port);
 
    return ERROR_OK;
}
 
COMMAND_HANDLER(amt_jtagaccel_handle_rtck_command)
{
    if (CMD_ARGC == 0) {
        command_print(CMD,
            "amt_jtagaccel RTCK feature %s",
            (rtck_enabled) ? "enabled" : "disabled");
        return ERROR_OK;
    } else {
        if (strcmp(CMD_ARGV[0], "enabled") == 0)
            rtck_enabled = 1;
        else
            rtck_enabled = 0;
    }
 
    return ERROR_OK;
}
 
static const struct command_registration amtjtagaccel_command_handlers[] = {
    {
        .name = "parport_port",
        .handler = &amt_jtagaccel_handle_parport_port_command,
        .mode = COMMAND_CONFIG,
        .help = "configure or display the parallel port to use",
        .usage = "[port_num]",
    },
    {
        .name = "rtck",
        .handler = &amt_jtagaccel_handle_rtck_command,
        .mode = COMMAND_CONFIG,
        .help = "configure or display RTCK support",
        .usage = "[enable|disable]",
    },
    COMMAND_REGISTRATION_DONE
};
 
static struct jtag_interface amt_jtagaccel_interface = {
    .execute_queue = amt_jtagaccel_execute_queue,
};
 
struct adapter_driver amt_jtagaccel_adapter_driver = {
    .name = "amt_jtagaccel",
    .transports = jtag_only,
    .commands = amtjtagaccel_command_handlers,
 
    .init = amt_jtagaccel_init,
    .quit = amt_jtagaccel_quit,
    .speed = amt_jtagaccel_speed,
 
    .jtag_ops = &amt_jtagaccel_interface,
};