main: invoke jtag_interface_quit() explicitly
[fw/openocd] / src / jtag / presto.c
index 532e798f967ca361228a73b91d220602a912a657..f4e689c2a527f7eb229ab517c184c362e518b88e 100644 (file)
@@ -25,7 +25,6 @@
 #include "windows.h"
 #endif
 
-#define INCLUDE_JTAG_INTERFACE_H
 #include "interface.h"
 #include "time_support.h"
 #include "bitq.h"
 #error "BUG: either FTD2XX and LIBFTDI has to be used"
 #endif
 
-static int presto_jtag_speed(int speed);
-static int presto_jtag_khz(int khz, int *jtag_speed);
-static int presto_jtag_speed_div(int speed, int *khz);
-static int presto_jtag_register_commands(struct command_context_s *cmd_ctx);
-static int presto_jtag_init(void);
-static int presto_jtag_quit(void);
-
-jtag_interface_t presto_interface =
-{
-       .name = "presto",
-       .execute_queue = bitq_execute_queue,
-       .speed = presto_jtag_speed,
-       .khz = presto_jtag_khz,
-       .speed_div = presto_jtag_speed_div,
-       .register_commands = presto_jtag_register_commands,
-       .init = presto_jtag_init,
-       .quit = presto_jtag_quit,
-};
-
-static int presto_bitq_out(int tms, int tdi, int tdo_req);
-static int presto_bitq_flush(void);
-static int presto_bitq_sleep(unsigned long us);
-static int presto_bitq_reset(int trst, int srst);
-static int presto_bitq_in_rdy(void);
-static int presto_bitq_in(void);
-
-static bitq_interface_t presto_bitq =
-{
-       .out = presto_bitq_out,
-       .flush = presto_bitq_flush,
-       .sleep = presto_bitq_sleep,
-       .reset = presto_bitq_reset,
-       .in_rdy = presto_bitq_in_rdy,
-       .in = presto_bitq_in,
-};
-
 /* -------------------------------------------------------------------------- */
 
 #define FT_DEVICE_NAME_LEN 64
@@ -87,8 +50,7 @@ static bitq_interface_t presto_bitq =
 
 #define BUFFER_SIZE (64*62)
 
-typedef struct presto_s
-{
+struct presto {
 #if BUILD_PRESTO_FTD2XX == 1
        FT_HANDLE handle;
        FT_STATUS status;
@@ -99,10 +61,10 @@ typedef struct presto_s
 
        char serial[FT_DEVICE_SERNUM_LEN];
 
-       u8 buff_out[BUFFER_SIZE];
+       uint8_t buff_out[BUFFER_SIZE];
        int buff_out_pos;
 
-       u8 buff_in[BUFFER_SIZE];
+       uint8_t buff_in[BUFFER_SIZE];
        int buff_in_exp; /* expected in buffer length */
        int buff_in_len; /* length of data received */
        int buff_in_pos;
@@ -118,18 +80,17 @@ typedef struct presto_s
        int jtag_tdi_count;
 
        int jtag_speed;
-       
-} presto_t;
+};
 
-static presto_t presto_state;
-static presto_t *presto = &presto_state;
+static struct presto presto_state;
+static struct presto *presto = &presto_state;
 
-static u8 presto_init_seq[] =
+static uint8_t presto_init_seq[] =
 {
        0x80, 0xA0, 0xA8, 0xB0, 0xC0, 0xE0
 };
 
-static int presto_write(u8 *buf, u32 size)
+static int presto_write(uint8_t *buf, uint32_t size)
 {
 #if BUILD_PRESTO_FTD2XX == 1
        DWORD ftbytes;
@@ -140,7 +101,7 @@ static int presto_write(u8 *buf, u32 size)
        }
 
 #elif BUILD_PRESTO_LIBFTDI == 1
-       u32 ftbytes;
+       uint32_t ftbytes;
        if ((presto->retval = ftdi_write_data(&presto->ftdic, buf, size)) < 0)
        {
                LOG_ERROR("ftdi_write_data: %s", ftdi_get_error_string(&presto->ftdic));
@@ -151,14 +112,15 @@ static int presto_write(u8 *buf, u32 size)
 
        if (ftbytes != size)
        {
-               LOG_ERROR("couldn't write the requested number of bytes to PRESTO (%u < %u)", (u32)ftbytes, size);
+               LOG_ERROR("couldn't write the requested number of bytes to PRESTO (%u < %u)",
+                         (unsigned)ftbytes, (unsigned)size);
                return ERROR_JTAG_DEVICE_ERROR;
        }
 
        return ERROR_OK;
 }
 
-static int presto_read(u8* buf, u32 size)
+static int presto_read(uint8_t* buf, uint32_t size)
 {
 #if BUILD_PRESTO_FTD2XX == 1
        DWORD ftbytes;
@@ -169,7 +131,7 @@ static int presto_read(u8* buf, u32 size)
        }
 
 #elif BUILD_PRESTO_LIBFTDI == 1
-       u32 ftbytes = 0;
+       uint32_t ftbytes = 0;
 
        struct timeval timeout, now;
        gettimeofday(&timeout, NULL);
@@ -193,7 +155,8 @@ static int presto_read(u8* buf, u32 size)
        if (ftbytes != size)
        {
                /* this is just a warning, there might have been timeout when detecting PRESTO, which is not fatal */
-               LOG_WARNING("couldn't read the requested number of bytes from PRESTO (%u < %u)", (u32)ftbytes, size);
+               LOG_WARNING("couldn't read the requested number of bytes from PRESTO (%u < %u)",
+                           (unsigned)ftbytes, (unsigned)size);
                return ERROR_JTAG_DEVICE_ERROR;
        }
 
@@ -203,7 +166,7 @@ static int presto_read(u8* buf, u32 size)
 #if BUILD_PRESTO_FTD2XX == 1
 static int presto_open_ftd2xx(char *req_serial)
 {
-       u32 i;
+       uint32_t i;
        DWORD numdevs;
        DWORD vidpid;
        char devname[FT_DEVICE_NAME_LEN];
@@ -238,7 +201,7 @@ static int presto_open_ftd2xx(char *req_serial)
                        LOG_DEBUG("FT_Open failed: %i", (int)presto->status);
                        continue;
                }
-               LOG_DEBUG("FTDI device %i open", i);
+               LOG_DEBUG("FTDI device %i open", (int)i);
 
                if ((presto->status = FT_GetDeviceInfo(presto->handle, &device, &vidpid,
                                presto->serial, devname, NULL)) == FT_OK)
@@ -250,7 +213,7 @@ static int presto_open_ftd2xx(char *req_serial)
                else
                        LOG_DEBUG("FT_GetDeviceInfo failed: %lu", presto->status);
 
-               LOG_DEBUG("FTDI device %i does not match, closing", i);
+               LOG_DEBUG("FTDI device %i does not match, closing", (int)i);
                FT_Close(presto->handle);
                presto->handle = (FT_HANDLE)INVALID_HANDLE_VALUE;
        }
@@ -278,7 +241,7 @@ static int presto_open_ftd2xx(char *req_serial)
        if ((presto->status = FT_Read(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
                return ERROR_JTAG_DEVICE_ERROR;
 
-       if (ftbytes!=1)
+       if (ftbytes != 1)
        {
                LOG_DEBUG("PRESTO reset");
 
@@ -291,7 +254,7 @@ static int presto_open_ftd2xx(char *req_serial)
 
                presto_data = 0;
                for (i = 0; i < 4 * 62; i++)
-                       if ((presto->status=FT_Write(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
+                       if ((presto->status = FT_Write(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
                                return ERROR_JTAG_DEVICE_ERROR;
 
                usleep(100000);
@@ -312,7 +275,7 @@ static int presto_open_ftd2xx(char *req_serial)
                if ((presto->status = FT_Read(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
                        return ERROR_JTAG_DEVICE_ERROR;
 
-               if (ftbytes!=1)
+               if (ftbytes != 1)
                {
                        LOG_DEBUG("PRESTO not responding");
                        return ERROR_JTAG_DEVICE_ERROR;
@@ -333,7 +296,7 @@ static int presto_open_ftd2xx(char *req_serial)
 #elif BUILD_PRESTO_LIBFTDI == 1
 static int presto_open_libftdi(char *req_serial)
 {
-       u8 presto_data;
+       uint8_t presto_data;
 
        LOG_DEBUG("searching for PRESTO using libftdi");
 
@@ -406,22 +369,22 @@ static int presto_open_libftdi(char *req_serial)
 
 static int presto_open(char *req_serial)
 {
-       presto->buff_out_pos=0;
-       presto->buff_in_pos=0;
-       presto->buff_in_len=0;
-       presto->buff_in_exp=0;
-
-       presto->total_out=0;
-       presto->total_in=0;
-
-       presto->jtag_tms=0;
-       presto->jtag_tck=0;
-       presto->jtag_rst=0;
-       presto->jtag_tdi_data=0;
-       presto->jtag_tdi_count=0;
-
-       presto->jtag_speed=0;
-       
+       presto->buff_out_pos = 0;
+       presto->buff_in_pos = 0;
+       presto->buff_in_len = 0;
+       presto->buff_in_exp = 0;
+
+       presto->total_out = 0;
+       presto->total_in = 0;
+
+       presto->jtag_tms = 0;
+       presto->jtag_tck = 0;
+       presto->jtag_rst = 0;
+       presto->jtag_tdi_data = 0;
+       presto->jtag_tdi_count = 0;
+
+       presto->jtag_speed = 0;
+
 #if BUILD_PRESTO_FTD2XX == 1
        return presto_open_ftd2xx(req_serial);
 #elif BUILD_PRESTO_LIBFTDI == 1
@@ -522,7 +485,7 @@ static int presto_sendbyte(int data)
 
        if (presto->buff_out_pos < BUFFER_SIZE)
        {
-               presto->buff_out[presto->buff_out_pos++] = (u8)data;
+               presto->buff_out[presto->buff_out_pos++] = (uint8_t)data;
                if (((data & 0xC0) == 0x40) || ((data & 0xD0)== 0xD0))
                        presto->buff_in_exp++;
        }
@@ -533,7 +496,7 @@ static int presto_sendbyte(int data)
        if (presto->buff_out_pos >= BUFFER_SIZE)
 #elif BUILD_PRESTO_LIBFTDI == 1
        /* libftdi does not do background read, be sure that USB IN buffer does not overflow (128 bytes only!) */
-       if (presto->buff_out_pos >= BUFFER_SIZE || presto->buff_in_exp==128)
+       if (presto->buff_out_pos >= BUFFER_SIZE || presto->buff_in_exp == 128)
 #endif
                return presto_flush();
 
@@ -552,7 +515,7 @@ static int presto_getbyte(void)
        if (presto_flush() != ERROR_OK)
                return -1;
 
-       if (presto->buff_in_pos<presto->buff_in_len)
+       if (presto->buff_in_pos < presto->buff_in_len)
                return presto->buff_in[presto->buff_in_pos++];
 
        return -1;
@@ -576,7 +539,7 @@ static int presto_tdi_flush(void)
        presto_sendbyte(presto->jtag_tdi_data);
        presto->jtag_tdi_count = 0;
        presto->jtag_tdi_data = 0;
-       
+
        return 0;
 }
 
@@ -587,7 +550,7 @@ static int presto_tck_idle(void)
                presto_sendbyte(0xCA);
                presto->jtag_tck = 0;
        }
-       
+
        return 0;
 }
 
@@ -624,14 +587,14 @@ static int presto_bitq_out(int tms, int tdi, int tdo_req)
        }
 
        /* delay with TCK low */
-       for (i=presto->jtag_speed; i>1; i--)
+       for (i = presto->jtag_speed; i > 1; i--)
                presto_sendbyte(cmd);
 
        cmd |= 0x04;
        presto_sendbyte(cmd | (tdo_req ? 0x10 : 0));
 
        /* delay with TCK high */
-       for (i=presto->jtag_speed; i>1; i--)
+       for (i = presto->jtag_speed; i > 1; i--)
                presto_sendbyte(cmd);
 
        presto->jtag_tck = 1;
@@ -651,14 +614,14 @@ static int presto_bitq_flush(void)
 
 static int presto_bitq_in_rdy(void)
 {
-       if (presto->buff_in_pos>=presto->buff_in_len)
+       if (presto->buff_in_pos >= presto->buff_in_len)
                return 0;
        return presto->buff_in_len-presto->buff_in_pos;
 }
 
 static int presto_bitq_in(void)
 {
-       if (presto->buff_in_pos>=presto->buff_in_len)
+       if (presto->buff_in_pos >= presto->buff_in_len)
                return -1;
        if (presto->buff_in[presto->buff_in_pos++]&0x08) return 1;
        return 0;
@@ -700,19 +663,28 @@ static int presto_bitq_reset(int trst, int srst)
        return 0;
 }
 
+static struct bitq_interface presto_bitq = {
+               .out = &presto_bitq_out,
+               .flush = &presto_bitq_flush,
+               .sleep = &presto_bitq_sleep,
+               .reset = &presto_bitq_reset,
+               .in_rdy = &presto_bitq_in_rdy,
+               .in = &presto_bitq_in,
+       };
+
 /* -------------------------------------------------------------------------- */
 
 static int presto_jtag_khz(int khz, int *jtag_speed)
 {
        if (khz < 0)
        {
-               *jtag_speed=0;
+               *jtag_speed = 0;
                return ERROR_INVALID_ARGUMENTS;
        }
 
        if (khz >= 3000) *jtag_speed = 0;
-       else *jtag_speed = (1000+khz-1)/khz;
-       
+       else *jtag_speed = (1000 + khz-1)/khz;
+
        return 0;
 }
 
@@ -720,44 +692,44 @@ static int presto_jtag_speed_div(int speed, int *khz)
 {
        if ((speed < 0) || (speed > 1000))
        {
-               *khz=0;
+               *khz = 0;
                return ERROR_INVALID_ARGUMENTS;
        }
 
        if (speed == 0) *khz = 3000;
        else *khz = 1000/speed;
-       
+
        return 0;
 }
 
 static int presto_jtag_speed(int speed)
 {
        int khz;
-       
+
        if (presto_jtag_speed_div(speed, &khz))
        {
                return ERROR_INVALID_ARGUMENTS;
        }
 
        presto->jtag_speed = speed;
-       
+
        if (khz%1000 == 0)
                LOG_INFO("setting speed to %d, max. TCK freq. is %d MHz", speed, khz/1000);
        else
                LOG_INFO("setting speed to %d, max. TCK freq. is %d kHz", speed, khz);
-       
+
        return 0;
 }
 
 static char *presto_serial;
 
-static int presto_handle_serial_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(presto_handle_serial_command)
 {
-       if (argc == 1)
+       if (CMD_ARGC == 1)
        {
                if (presto_serial)
                        free(presto_serial);
-               presto_serial = strdup(args[0]);
+               presto_serial = strdup(CMD_ARGV[0]);
        }
        else
        {
@@ -767,12 +739,16 @@ static int presto_handle_serial_command(struct command_context_s *cmd_ctx, char
        return ERROR_OK;
 }
 
-static int presto_jtag_register_commands(struct command_context_s *cmd_ctx)
-{
-       register_command(cmd_ctx, NULL, "presto_serial", presto_handle_serial_command,
-               COMMAND_CONFIG, NULL);
-       return ERROR_OK;
-}
+static const struct command_registration presto_command_handlers[] = {
+       {
+               .name = "presto_serial",
+               .handler = &presto_handle_serial_command,
+               .mode = COMMAND_CONFIG,
+               .help = "configure serial port",
+               .usage = "<devname>",
+       },
+       COMMAND_REGISTRATION_DONE
+};
 
 static int presto_jtag_init(void)
 {
@@ -788,7 +764,7 @@ static int presto_jtag_init(void)
        LOG_INFO("PRESTO open, serial number '%s'", presto->serial);
 
        /* use JTAG speed setting from configuration file */
-       presto_jtag_speed(jtag_speed);
+       presto_jtag_speed(jtag_get_speed());
 
        bitq_interface = &presto_bitq;
        return ERROR_OK;
@@ -808,3 +784,17 @@ static int presto_jtag_quit(void)
 
        return ERROR_OK;
 }
+
+struct jtag_interface presto_interface = {
+               .name = "presto",
+
+               .commands = presto_command_handlers,
+
+               .execute_queue = &bitq_execute_queue,
+               .speed = &presto_jtag_speed,
+               .khz = &presto_jtag_khz,
+               .speed_div = &presto_jtag_speed_div,
+
+               .init = &presto_jtag_init,
+               .quit = &presto_jtag_quit,
+       };