move nor drivers to src/flash/nor
[fw/openocd] / src / jtag / gw16012.c
index 3d72aa27e4799d7e2a3b41dcf2c827e47eea08d0..b827fd53a12e543acf3f48c32a77c8e708674cb2 100644 (file)
@@ -21,9 +21,9 @@
 #include "config.h"
 #endif
 
-#include "replacements.h"
+#include "interface.h"
+#include "commands.h"
 
-#include "jtag.h"
 
 #if 1
 #define _DEBUG_GW16012_IO_
@@ -33,7 +33,6 @@
 /*  -ino: 060521-1036 */
 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
 
-#include <sys/types.h>
 #include <machine/sysarch.h>
 #include <machine/cpufunc.h>
 #define ioperm(startport,length,enable)\
 
 #else
 
-#ifdef _WIN32
-#include "errno.h"
-#endif /* _WIN32 */
-
 #endif /* __FreeBSD__, __FreeBSD_kernel__ */
 
-#include <string.h>
-#include <stdlib.h>
 
 #if PARPORT_USE_PPDEV == 1
 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
 #endif
 #endif
 
-#if PARPORT_USE_GIVEIO == 1
-#if IS_CYGWIN == 1
+#if PARPORT_USE_GIVEIO == 1 && IS_CYGWIN == 1
 #include <windows.h>
-#include <errno.h>
-#endif
 #endif
 
-#include "log.h"
 
 /* configuration */
-u16 gw16012_port;
+uint16_t gw16012_port;
 
 /* interface variables
  */
-static u8 gw16012_msb = 0x0;
-static u8 gw16012_control_value = 0x0;
+static uint8_t gw16012_msb = 0x0;
+static uint8_t gw16012_control_value = 0x0;
 
 #if PARPORT_USE_PPDEV == 1
 static int device_handle;
 #endif
 
-int gw16012_execute_queue(void);
-int gw16012_register_commands(struct command_context_s *cmd_ctx);
-int gw16012_speed(int speed);
-int gw16012_init(void);
-int gw16012_quit(void);
-
-int gw16012_handle_parport_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-
-jtag_interface_t gw16012_interface =
-{
-       .name = "gw16012",
-
-       .execute_queue = gw16012_execute_queue,
-
-       .speed = gw16012_speed,
-       .register_commands = gw16012_register_commands,
-       .init = gw16012_init,
-       .quit = gw16012_quit,
-};
-
-int gw16012_register_commands(struct command_context_s *cmd_ctx)
-{
-       register_command(cmd_ctx, NULL, "parport_port", gw16012_handle_parport_port_command,
-                                        COMMAND_CONFIG, NULL);
-
-       return ERROR_OK;
-}
-
-void gw16012_data(u8 value)
+static void gw16012_data(uint8_t value)
 {
        value = (value & 0x7f) | gw16012_msb;
        gw16012_msb ^= 0x80; /* toggle MSB */
@@ -137,7 +98,7 @@ void gw16012_data(u8 value)
        #endif
 }
 
-void gw16012_control(u8 value)
+static void gw16012_control(uint8_t value)
 {
        if (value != gw16012_control_value)
        {
@@ -159,7 +120,7 @@ void gw16012_control(u8 value)
        }
 }
 
-void gw16012_input(u8 *value)
+static void gw16012_input(uint8_t *value)
 {
        #if PARPORT_USE_PPDEV == 1
                ioctl(device_handle, PPRSTATUS, value);
@@ -173,7 +134,7 @@ void gw16012_input(u8 *value)
 }
 
 /* (1) assert or (0) deassert reset lines */
-void gw16012_reset(int trst, int srst)
+static void gw16012_reset(int trst, int srst)
 {
        LOG_DEBUG("trst: %i, srst: %i", trst, srst);
 
@@ -188,13 +149,13 @@ void gw16012_reset(int trst, int srst)
                gw16012_control(0x0b);
 }
 
-int gw16012_speed(int speed)
+static int gw16012_speed(int speed)
 {
 
        return ERROR_OK;
 }
 
-void gw16012_end_state(int state)
+static void gw16012_end_state(tap_state_t state)
 {
        if (tap_is_state_stable(state))
                tap_set_end_state(state);
@@ -205,14 +166,15 @@ void gw16012_end_state(int state)
        }
 }
 
-void gw16012_state_move(void)
+static void gw16012_state_move(void)
 {
-       int i=0, tms=0;
-       u8 tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
+       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 < 7; i++)
+       for (i = 0; i < tms_count; i++)
        {
                tms = (tms_scan >> i) & 1;
                gw16012_data(tms << 1); /* output next TMS bit */
@@ -221,7 +183,7 @@ void gw16012_state_move(void)
        tap_set_state(tap_get_end_state());
 }
 
-void gw16012_path_move(pathmove_command_t *cmd)
+static void gw16012_path_move(struct pathmove_command *cmd)
 {
        int num_states = cmd->num_states;
        int state_count;
@@ -252,7 +214,7 @@ void gw16012_path_move(pathmove_command_t *cmd)
        tap_set_end_state(tap_get_state());
 }
 
-void gw16012_runtest(int num_cycles)
+static void gw16012_runtest(int num_cycles)
 {
        tap_state_t saved_end_state = tap_get_end_state();
        int i;
@@ -275,12 +237,12 @@ void gw16012_runtest(int num_cycles)
                gw16012_state_move();
 }
 
-void gw16012_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size)
+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();
-       u8 scan_out, scan_in;
+       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))))
@@ -306,7 +268,7 @@ void gw16012_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size)
        gw16012_control(0x0); /* single-bit mode */
        while (bits_left-- > 0)
        {
-               u8 tms = 0;
+               uint8_t tms = 0;
 
                scan_out = buf_get_u32(buffer, bit_count, 1);
 
@@ -348,12 +310,12 @@ void gw16012_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size)
        }
 }
 
-int gw16012_execute_queue(void)
+static int gw16012_execute_queue(void)
 {
-       jtag_command_t *cmd = jtag_command_queue; /* currently processed command */
+       struct jtag_command *cmd = jtag_command_queue; /* currently processed command */
        int scan_size;
        enum scan_type type;
-       u8 *buffer;
+       uint8_t *buffer;
        int retval;
 
        /* return ERROR_OK, unless a jtag_read_buffer returns a failed check
@@ -365,13 +327,6 @@ int gw16012_execute_queue(void)
        {
                switch (cmd->type)
                {
-                       case JTAG_END_STATE:
-#ifdef _DEBUG_JTAG_IO_
-                               LOG_DEBUG("end_state: %i", cmd->cmd.end_state->end_state);
-#endif
-                               if (cmd->cmd.end_state->end_state != -1)
-                                       gw16012_end_state(cmd->cmd.end_state->end_state);
-                               break;
                        case JTAG_RESET:
 #ifdef _DEBUG_JTAG_IO_
                                LOG_DEBUG("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
@@ -386,16 +341,14 @@ int gw16012_execute_queue(void)
 #ifdef _DEBUG_JTAG_IO_
                                LOG_DEBUG("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
 #endif
-                               if (cmd->cmd.runtest->end_state != -1)
-                                       gw16012_end_state(cmd->cmd.runtest->end_state);
+                               gw16012_end_state(cmd->cmd.runtest->end_state);
                                gw16012_runtest(cmd->cmd.runtest->num_cycles);
                                break;
                        case JTAG_STATEMOVE:
 #ifdef _DEBUG_JTAG_IO_
                                LOG_DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
 #endif
-                               if (cmd->cmd.statemove->end_state != -1)
-                                       gw16012_end_state(cmd->cmd.statemove->end_state);
+                               gw16012_end_state(cmd->cmd.statemove->end_state);
                                gw16012_state_move();
                                break;
                        case JTAG_PATHMOVE:
@@ -405,8 +358,7 @@ int gw16012_execute_queue(void)
                                gw16012_path_move(cmd->cmd.pathmove);
                                break;
                        case JTAG_SCAN:
-                               if (cmd->cmd.scan->end_state != -1)
-                                       gw16012_end_state(cmd->cmd.scan->end_state);
+                               gw16012_end_state(cmd->cmd.scan->end_state);
                                scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
                                type = jtag_scan_type(cmd->cmd.scan);
 #ifdef _DEBUG_JTAG_IO_
@@ -436,97 +388,115 @@ int gw16012_execute_queue(void)
 }
 
 #if PARPORT_USE_GIVEIO == 1
-int gw16012_get_giveio_access()
+static int gw16012_get_giveio_access(void)
 {
        HANDLE h;
        OSVERSIONINFO version;
 
        version.dwOSVersionInfoSize = sizeof version;
-       if (!GetVersionEx( &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 );
+       h = CreateFile("\\\\.\\giveio", GENERIC_READ, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
        if (h == INVALID_HANDLE_VALUE) {
                errno = ENODEV;
                return -1;
        }
 
-       CloseHandle( h );
+       CloseHandle(h);
 
        return 0;
 }
 #endif
 
-int gw16012_init(void)
-{
-#if PARPORT_USE_PPDEV == 1
-       char buffer[256];
-       int i = 0;
-#endif
-       u8 status_port;
-
 #if PARPORT_USE_PPDEV == 1
-       if (device_handle>0)
-       {
-               LOG_ERROR("device is already opened");
-               return ERROR_JTAG_INIT_FAILED;
-       }
 
 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
-       LOG_DEBUG("opening /dev/ppi%d...", gw16012_port);
 
-       snprintf(buffer, 256, "/dev/ppi%d", gw16012_port);
-       device_handle = open(buffer, O_WRONLY);
-#else
-       LOG_DEBUG("opening /dev/parport%d...", gw16012_port);
+#define GW16012_PPDEV_NAME     "ppi"
 
-       snprintf(buffer, 256, "/dev/parport%d", gw16012_port);
-       device_handle = open(buffer, O_WRONLY);
-#endif
-       if (device_handle<0)
+static int gw16012_init_ioctls(void)
+{
+       int temp = 0;
+       temp = ioctl(device_handle, PPCLAIM);
+       if (temp < 0)
        {
-               LOG_ERROR("cannot open device. check it exists and that user read and write rights are set");
+               LOG_ERROR("cannot claim device");
                return ERROR_JTAG_INIT_FAILED;
        }
 
-       LOG_DEBUG("...open");
+       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;
+       }
 
-#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
-       i=ioctl(device_handle, PPCLAIM);
-       if (i<0)
+       temp = IEEE1284_MODE_COMPAT;
+       temp = ioctl(device_handle, PPNEGOT, &temp);
+       if (temp < 0)
        {
-               LOG_ERROR("cannot claim device");
+               LOG_ERROR("cannot set compatible 1284 mode to device");
                return ERROR_JTAG_INIT_FAILED;
        }
+       return ERROR_OK;
+}
+#else
+
+#define GW16012_PPDEV_NAME     "parport"
 
-       i = PARPORT_MODE_COMPAT;
-       i= ioctl(device_handle, PPSETMODE, & i);
-       if (i<0)
+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(" cannot set compatible mode to device");
+               LOG_ERROR("device is already opened");
                return ERROR_JTAG_INIT_FAILED;
        }
 
-       i = IEEE1284_MODE_COMPAT;
-       i = ioctl(device_handle, PPNEGOT, & i);
-       if (i<0)
+       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 set compatible 1284 mode to device");
+               LOG_ERROR("cannot open device. check it exists and that user read and write rights are set");
                return ERROR_JTAG_INIT_FAILED;
        }
-#endif
-#else
+
+       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%lx...", (long unsigned)(gw16012_port) );
+       LOG_DEBUG("requesting privileges for parallel port 0x%lx...", (long unsigned)(gw16012_port));
 #if PARPORT_USE_GIVEIO == 1
        if (gw16012_get_giveio_access() != 0)
 #else /* PARPORT_USE_GIVEIO */
@@ -544,31 +514,70 @@ int gw16012_init(void)
 #else
        outb(0x0, gw16012_port + 2);
 #endif
-#endif /* PARPORT_USE_PPDEV */
+       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_speed(jtag_speed);
+       gw16012_speed(jtag_get_speed());
        gw16012_reset(0, 0);
 
        return ERROR_OK;
 }
 
-int gw16012_quit(void)
+static int gw16012_quit(void)
 {
 
        return ERROR_OK;
 }
 
-int gw16012_handle_parport_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(gw16012_handle_parport_port_command)
 {
-       if (argc == 0)
-               return ERROR_OK;
+       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;
+               }
+       }
 
-       /* only if the port wasn't overwritten by cmdline */
-       if (gw16012_port == 0)
-               gw16012_port = strtoul(args[0], NULL, 0);
+       command_print(CMD_CTX, "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 = "configure the parallel port to use",
+               .usage = "<port_num>",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+struct jtag_interface gw16012_interface = {
+               .name = "gw16012",
+               .commands = gw16012_command_handlers,
+               .init = &gw16012_init,
+               .quit = &gw16012_quit,
+               .speed = &gw16012_speed,
+               .execute_queue = &gw16012_execute_queue,
+       };