gw16012.c

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
 
/***************************************************************************
 *   Copyright (C) 2006 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 ***************************************************************************/
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#include <jtag/interface.h>
#include <jtag/commands.h>
 
#if 1
#define _DEBUG_GW16012_IO_
#endif
 
/* system includes */
/*  -ino: 060521-1036 */
#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
 
#include <machine/sysarch.h>
#include <machine/cpufunc.h>
#define ioperm(startport, length, enable) \
    386_set_ioperm((startport), (length), (enable))
 
#else
 
#endif /* __FreeBSD__, __FreeBSD_kernel__ */
 
#if PARPORT_USE_PPDEV == 1
#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
#include <dev/ppbus/ppi.h>
#include <dev/ppbus/ppbconf.h>
#define PPRSTATUS   PPIGSTATUS
#define PPWDATA     PPISDATA
#else
#include <linux/parport.h>
#include <linux/ppdev.h>
#endif
#include <fcntl.h>
#include <sys/ioctl.h>
#else /* not PARPORT_USE_PPDEV */
#ifndef _WIN32
#include <sys/io.h>
#endif
#endif
 
#if PARPORT_USE_GIVEIO == 1 && IS_CYGWIN == 1
#include <windows.h>
#endif
 
/* configuration */
static uint16_t gw16012_port;
 
/* interface variables
 */
static uint8_t gw16012_msb;
static uint8_t gw16012_control_value;
 
#if PARPORT_USE_PPDEV == 1
static int device_handle;
#endif
 
static void gw16012_data(uint8_t value)
{
    value = (value & 0x7f) | gw16012_msb;
    gw16012_msb ^= 0x80; /* toggle MSB */
 
#ifdef _DEBUG_GW16012_IO_
    LOG_DEBUG("%2.2x", value);
#endif
 
    #if PARPORT_USE_PPDEV == 1
        ioctl(device_handle, PPWDATA, &value);
    #else
        #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
            outb(gw16012_port, value);
        #else
            outb(value, gw16012_port);
        #endif
    #endif
}
 
static void gw16012_control(uint8_t value)
{
    if (value != gw16012_control_value) {
        gw16012_control_value = value;
 
#ifdef _DEBUG_GW16012_IO_
        LOG_DEBUG("%2.2x", gw16012_control_value);
#endif
 
        #if PARPORT_USE_PPDEV == 1
            ioctl(device_handle, PPWCONTROL, &gw16012_control_value);
        #else
            #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
                outb(gw16012_port + 2, gw16012_control_value);
            #else
                outb(gw16012_control_value, gw16012_port + 2);
            #endif
        #endif
    }
}
 
static void gw16012_input(uint8_t *value)
{
    #if PARPORT_USE_PPDEV == 1
        ioctl(device_handle, PPRSTATUS, value);
    #else
        *value = inb(gw16012_port + 1);
    #endif
 
#ifdef _DEBUG_GW16012_IO_
    LOG_DEBUG("%2.2x", *value);
#endif
}
 
/* (1) assert or (0) deassert reset lines */
static void gw16012_reset(int trst, int srst)
{
    LOG_DEBUG("trst: %i, srst: %i", trst, srst);
 
    if (trst == 0)
        gw16012_control(0x0d);
    else if (trst == 1)
        gw16012_control(0x0c);
 
    if (srst == 0)
        gw16012_control(0x0a);
    else if (srst == 1)
        gw16012_control(0x0b);
}
 
static void gw16012_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 gw16012_state_move(void)
{
    int i = 0, tms = 0;
    uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
    int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
 
    gw16012_control(0x0); /* single-bit mode */
 
    for (i = 0; i < tms_count; i++) {
        tms = (tms_scan >> i) & 1;
        gw16012_data(tms << 1); /* output next TMS bit */
    }
 
    tap_set_state(tap_get_end_state());
}
 
static void gw16012_path_move(struct pathmove_command *cmd)
{
    int num_states = cmd->num_states;
    int state_count;
 
    state_count = 0;
    while (num_states) {
        gw16012_control(0x0); /* single-bit mode */
        if (tap_state_transition(tap_get_state(), false) == cmd->path[state_count])
            gw16012_data(0x0); /* TCK cycle with TMS low */
        else if (tap_state_transition(tap_get_state(), true) == cmd->path[state_count])
            gw16012_data(0x2); /* TCK cycle with TMS high */
        else {
            LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
                    tap_state_name(tap_get_state()), tap_state_name(cmd->path[state_count]));
            exit(-1);
        }
 
        tap_set_state(cmd->path[state_count]);
        state_count++;
        num_states--;
    }
 
    tap_set_end_state(tap_get_state());
}
 
static void gw16012_runtest(unsigned int num_cycles)
{
    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) {
        gw16012_end_state(TAP_IDLE);
        gw16012_state_move();
    }
 
    for (unsigned int i = 0; i < num_cycles; i++) {
        gw16012_control(0x0); /* single-bit mode */
        gw16012_data(0x0); /* TMS cycle with TMS low */
    }
 
    gw16012_end_state(saved_end_state);
    if (tap_get_state() != tap_get_end_state())
        gw16012_state_move();
}
 
static void gw16012_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 scan_out, scan_in;
 
    /* only if we're not already in the correct Shift state */
    if (!((!ir_scan && (tap_get_state() == TAP_DRSHIFT)) ||
            (ir_scan && (tap_get_state() == TAP_IRSHIFT)))) {
        if (ir_scan)
            gw16012_end_state(TAP_IRSHIFT);
        else
            gw16012_end_state(TAP_DRSHIFT);
 
        gw16012_state_move();
        gw16012_end_state(saved_end_state);
    }
 
    while (type == SCAN_OUT && ((bits_left - 1) > 7)) {
        gw16012_control(0x2); /* seven-bit mode */
        scan_out = buf_get_u32(buffer, bit_count, 7);
        gw16012_data(scan_out);
        bit_count += 7;
        bits_left -= 7;
    }
 
    gw16012_control(0x0); /* single-bit mode */
    while (bits_left-- > 0) {
        uint8_t tms = 0;
 
        scan_out = buf_get_u32(buffer, bit_count, 1);
 
        if (bits_left == 0) /* last bit */ {
            if ((ir_scan && (tap_get_end_state() == TAP_IRSHIFT))
                || (!ir_scan && (tap_get_end_state() == TAP_DRSHIFT)))
                tms = 0;
            else
                tms = 2;
        }
 
        gw16012_data(scan_out | tms);
 
        if (type != SCAN_OUT) {
            gw16012_input(&scan_in);
            buf_set_u32(buffer, bit_count, 1, ((scan_in & 0x08) >> 3));
        }
 
        bit_count++;
    }
 
    if (!((ir_scan && (tap_get_end_state() == TAP_IRSHIFT)) ||
        (!ir_scan && (tap_get_end_state() == TAP_DRSHIFT)))) {
        gw16012_data(0x0);
        if (ir_scan)
            tap_set_state(TAP_IRPAUSE);
        else
            tap_set_state(TAP_DRPAUSE);
 
        if (tap_get_state() != tap_get_end_state())
            gw16012_state_move();
    }
}
 
static int gw16012_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);
                gw16012_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
                break;
            case JTAG_RUNTEST:
                LOG_DEBUG_IO("runtest %u cycles, end in %i", cmd->cmd.runtest->num_cycles,
                        cmd->cmd.runtest->end_state);
                gw16012_end_state(cmd->cmd.runtest->end_state);
                gw16012_runtest(cmd->cmd.runtest->num_cycles);
                break;
            case JTAG_TLR_RESET:
                LOG_DEBUG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
                gw16012_end_state(cmd->cmd.statemove->end_state);
                gw16012_state_move();
                break;
            case JTAG_PATHMOVE:
                LOG_DEBUG_IO("pathmove: %i states, end in %i", cmd->cmd.pathmove->num_states,
                        cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
                gw16012_path_move(cmd->cmd.pathmove);
                break;
            case JTAG_SCAN:
                gw16012_end_state(cmd->cmd.scan->end_state);
                scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
                type = jtag_scan_type(cmd->cmd.scan);
                LOG_DEBUG_IO("%s scan (%i) %i bit end in %i", (cmd->cmd.scan->ir_scan) ? "ir" : "dr",
                    type, scan_size, cmd->cmd.scan->end_state);
                gw16012_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
static int gw16012_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
 
#if PARPORT_USE_PPDEV == 1
 
#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
 
#define GW16012_PPDEV_NAME  "ppi"
 
static int gw16012_init_ioctls(void)
{
    int temp = 0;
    temp = ioctl(device_handle, PPCLAIM);
    if (temp < 0) {
        LOG_ERROR("cannot claim device");
        return ERROR_JTAG_INIT_FAILED;
    }
 
    temp = PARPORT_MODE_COMPAT;
    temp = ioctl(device_handle, PPSETMODE, &temp);
    if (temp < 0) {
        LOG_ERROR(" cannot set compatible mode to device");
        return ERROR_JTAG_INIT_FAILED;
    }
 
    temp = IEEE1284_MODE_COMPAT;
    temp = ioctl(device_handle, PPNEGOT, &temp);
    if (temp < 0) {
        LOG_ERROR("cannot set compatible 1284 mode to device");
        return ERROR_JTAG_INIT_FAILED;
    }
    return ERROR_OK;
}
#else
 
#define GW16012_PPDEV_NAME  "parport"
 
static int gw16012_init_ioctls(void)
{
    return ERROR_OK;
}
 
#endif /* defined(__FreeBSD__) || defined(__FreeBSD_kernel__) */
 
static int gw16012_init_device(void)
{
    const char *device_name = GW16012_PPDEV_NAME;
    char buffer[256];
 
    if (device_handle > 0) {
        LOG_ERROR("device is already opened");
        return ERROR_JTAG_INIT_FAILED;
    }
 
    snprintf(buffer, 256, "/dev/%s%d", device_name, gw16012_port);
    LOG_DEBUG("opening %s...", buffer);
 
    device_handle = open(buffer, O_WRONLY);
    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;
    }
 
    LOG_DEBUG("...open");
 
    if (gw16012_init_ioctls() != ERROR_OK)
        return ERROR_JTAG_INIT_FAILED;
 
    return ERROR_OK;
}
 
#else /* PARPORT_USE_PPDEV */
 
static int gw16012_init_device(void)
{
    if (gw16012_port == 0) {
        gw16012_port = 0x378;
        LOG_WARNING("No gw16012 port specified, using default '0x378' (LPT1)");
    }
 
    LOG_DEBUG("requesting privileges for parallel port 0x%" PRIx16 "...", gw16012_port);
#if PARPORT_USE_GIVEIO == 1
    if (gw16012_get_giveio_access() != 0) {
#else /* PARPORT_USE_GIVEIO */
    if (ioperm(gw16012_port, 3, 1) != 0) {
#endif /* PARPORT_USE_GIVEIO */
        LOG_ERROR("missing privileges for direct i/o");
        return ERROR_JTAG_INIT_FAILED;
    }
    LOG_DEBUG("...privileges granted");
 
    /* make sure parallel port is in right mode (clear tristate and interrupt */
#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
    outb(gw16012_port + 2, 0x0);
#else
    outb(0x0, gw16012_port + 2);
#endif
    return ERROR_OK;
}
 
#endif /* PARPORT_USE_PPDEV */
 
static int gw16012_init(void)
{
    uint8_t status_port;
 
    if (gw16012_init_device() != ERROR_OK)
        return ERROR_JTAG_INIT_FAILED;
 
    gw16012_input(&status_port);
    gw16012_msb = (status_port & 0x80) ^ 0x80;
 
    gw16012_reset(0, 0);
 
    return ERROR_OK;
}
 
static int gw16012_quit(void)
{
 
    return ERROR_OK;
}
 
COMMAND_HANDLER(gw16012_handle_parport_port_command)
{
    if (CMD_ARGC == 1) {
        /* only if the port wasn't overwritten by cmdline */
        if (gw16012_port == 0)
            COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], gw16012_port);
        else {
            LOG_ERROR("The parport port was already configured!");
            return ERROR_FAIL;
        }
    }
 
    command_print(CMD, "parport port = %u", gw16012_port);
 
    return ERROR_OK;
}
 
static const struct command_registration gw16012_command_handlers[] = {
    {
        .name = "parport_port",
        .handler = gw16012_handle_parport_port_command,
        .mode = COMMAND_CONFIG,
        .help = "Display the address of the I/O port (e.g. 0x378) "
            "or the number of the '/dev/parport' device used.  "
            "If a parameter is provided, first change that port.",
        .usage = "[port_number]",
    },
    COMMAND_REGISTRATION_DONE
};
 
static struct jtag_interface gw16012_interface = {
    .execute_queue = gw16012_execute_queue,
};
 
struct adapter_driver gw16012_adapter_driver = {
    .name = "gw16012",
    .transports = jtag_only,
    .commands = gw16012_command_handlers,
 
    .init = gw16012_init,
    .quit = gw16012_quit,
 
    .jtag_ops = &gw16012_interface,
};