- rename log functions to stop conflicts under win32 (wingdi)
[openocd.git] / src / jtag / presto.c
index c8417c22f772feeb0a07a4e29703717540ef68da..d9661fc41f6afb1bc15760920d847aaca3c9836a 100644 (file)
@@ -23,7 +23,6 @@
 
 #if IS_CYGWIN == 1
 #include "windows.h"
-#undef ERROR
 #endif
 
 #include "replacements.h"
@@ -109,7 +108,7 @@ typedef struct presto_s
        struct ftdi_context ftdic;
        int retval;
 #endif
-       
+
        char serial[FT_DEVICE_SERNUM_LEN];
 
        u8 buff_out[BUFFER_SIZE];
@@ -139,76 +138,74 @@ u8 presto_init_seq[] =
        0x80, 0xA0, 0xA8, 0xB0, 0xC0, 0xE0
 };
 
-int presto_write(u8 *buf, int size, u32* bytes_written)
+int presto_write(u8 *buf, int size)
 {
 #if BUILD_PRESTO_FTD2XX == 1
-       DWORD dw_bytes_written;
-       if ((presto->status = FT_Write(presto->handle, buf, size, &dw_bytes_written)) != FT_OK)
+       DWORD ftbytes;
+       if ((presto->status = FT_Write(presto->handle, buf, size, &ftbytes)) != FT_OK)
        {
-               *bytes_written = dw_bytes_written;
-               ERROR("FT_Write returned: %lu", presto->status);
+               LOG_ERROR("FT_Write returned: %lu", presto->status);
                return ERROR_JTAG_DEVICE_ERROR;
        }
-       else
-       {
-               *bytes_written = dw_bytes_written;
-               return ERROR_OK;        
-       }
+
 #elif BUILD_PRESTO_LIBFTDI == 1
+       u32 ftbytes;
        if ((presto->retval = ftdi_write_data(&presto->ftdic, buf, size)) < 0)
        {
-               *bytes_written = 0;
-               ERROR("ftdi_write_data: %s", ftdi_get_error_string(&presto->ftdic));
+               LOG_ERROR("ftdi_write_data: %s", ftdi_get_error_string(&presto->ftdic));
                return ERROR_JTAG_DEVICE_ERROR;
        }
-       else
+       ftbytes = presto->retval;
+#endif
+
+       if (ftbytes != size)
        {
-               *bytes_written = presto->retval; /* FIXME: Correct? */
-               return ERROR_OK;        
+               LOG_ERROR("couldn't write the requested number of bytes to PRESTO (%i < %i)", ftbytes, size);
+               return ERROR_JTAG_DEVICE_ERROR;
        }
-#endif
+
+       return ERROR_OK;
 }
 
-int presto_read(u8* buf, int size, u32* bytes_read)
+int presto_read(u8* buf, int size)
 {
 #if BUILD_PRESTO_FTD2XX == 1
-       DWORD dw_bytes_read;
-       int timeout = 5;
-       *bytes_read = 0;
-
-       while ((*bytes_read < size) && timeout--)
+       DWORD ftbytes;
+       if ((presto->status = FT_Read(presto->handle, buf, size, &ftbytes)) != FT_OK)
        {
-               if ((presto->status = FT_Read(presto->handle, buf + *bytes_read, size - 
-                       *bytes_read, &dw_bytes_read)) != FT_OK)         
-               {
-                       *bytes_read = 0; 
-                       ERROR("FT_Read returned: %lu", presto->status);
-                       return ERROR_JTAG_DEVICE_ERROR;
-               }
-               *bytes_read += dw_bytes_read; 
+               LOG_ERROR("FT_Read returned: %lu", presto->status);
+               return ERROR_JTAG_DEVICE_ERROR;
        }
+
 #elif BUILD_PRESTO_LIBFTDI == 1
-       int timeout = 100;
-       *bytes_read = 0;
-       
-       while ((*bytes_read < size) && timeout--)
+       u32 ftbytes = 0;
+
+       struct timeval timeout, now;
+       gettimeofday(&timeout, NULL);
+       timeval_add_time(&timeout, 1, 0); /* one second timeout */
+
+       while (ftbytes < size)
        {
-               if ((presto->retval = ftdi_read_data(&presto->ftdic, buf + *bytes_read, size - *bytes_read)) < 0)
+               if ((presto->retval = ftdi_read_data(&presto->ftdic, buf + ftbytes, size - ftbytes)) < 0)
                {
-                       *bytes_read = 0;
-                       ERROR("ftdi_read_data: %s", ftdi_get_error_string(&presto->ftdic));
+                       LOG_ERROR("ftdi_read_data: %s", ftdi_get_error_string(&presto->ftdic));
                        return ERROR_JTAG_DEVICE_ERROR;
                }
-               *bytes_read += presto->retval; /* FIXME: Correct? */
+               ftbytes += presto->retval;
+
+               gettimeofday(&now, NULL);
+               if ((now.tv_sec > timeout.tv_sec) || ((now.tv_sec == timeout.tv_sec) && (now.tv_usec > timeout.tv_usec)))
+                       break;
        }
 #endif
 
-       if (*bytes_read < size)
+       if (ftbytes != size)
        {
-               ERROR("couldn't read the requested number of bytes from PRESTO (%i < %i)", *bytes_read, 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 (%i < %i)", ftbytes, size);
                return ERROR_JTAG_DEVICE_ERROR;
        }
-       
+
        return ERROR_OK;
 }
 
@@ -222,36 +219,36 @@ int presto_open_ftd2xx(char *req_serial)
        FT_DEVICE device;
 
        BYTE presto_data;
-       unsigned long ftbytes;
+       DWORD ftbytes;
 
        presto->handle = (FT_HANDLE)INVALID_HANDLE_VALUE;
-       
+
 #if IS_WIN32 == 0
        /* Add non-standard Vid/Pid to the linux driver */
        if ((presto->status = FT_SetVIDPID(PRESTO_VID, PRESTO_PID)) != FT_OK)
        {
-               ERROR("couldn't add PRESTO VID/PID");
+               LOG_ERROR("couldn't add PRESTO VID/PID");
                exit(-1);
        }
 #endif
 
        if ((presto->status = FT_ListDevices(&numdevs, NULL, FT_LIST_NUMBER_ONLY)) != FT_OK)
        {
-               ERROR("FT_ListDevices failed: %i", (int)presto->status);
+               LOG_ERROR("FT_ListDevices failed: %i", (int)presto->status);
                return ERROR_JTAG_DEVICE_ERROR;
        }
-       
-       DEBUG("FTDI devices available: %i", numdevs);
+
+       LOG_DEBUG("FTDI devices available: %i", numdevs);
        for (i = 0; i < numdevs; i++)
        {
                if ((presto->status = FT_Open(i, &(presto->handle))) != FT_OK)
                {
                        /* this is not fatal, the device may be legitimately open by other process, hence debug message only */
-                       DEBUG("FT_Open failed: %i", (int)presto->status);
+                       LOG_DEBUG("FT_Open failed: %i", (int)presto->status);
                        continue;
                }
-               DEBUG("FTDI device %i open", i);
-                       
+               LOG_DEBUG("FTDI device %i open", i);
+
                if ((presto->status = FT_GetDeviceInfo(presto->handle, &device, &vidpid,
                                presto->serial, devname, NULL)) == FT_OK)
                {
@@ -260,9 +257,9 @@ int presto_open_ftd2xx(char *req_serial)
                                break;
                }
                else
-                       DEBUG("FT_GetDeviceInfo failed: %i", presto->status);
-               
-               DEBUG("FTDI device %i does not match, closing", i);
+                       LOG_DEBUG("FT_GetDeviceInfo failed: %i", presto->status);
+
+               LOG_DEBUG("FTDI device %i does not match, closing", i);
                FT_Close(presto->handle);
                presto->handle = (FT_HANDLE)INVALID_HANDLE_VALUE;
        }
@@ -272,28 +269,28 @@ int presto_open_ftd2xx(char *req_serial)
 
        if ((presto->status = FT_SetLatencyTimer(presto->handle, 1)) != FT_OK)
                return ERROR_JTAG_DEVICE_ERROR;
-       
-       
+
+
        if ((presto->status = FT_SetTimeouts(presto->handle, 100, 0)) != FT_OK)
                return ERROR_JTAG_DEVICE_ERROR;
-       
+
        if ((presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX)) != FT_OK)
                return ERROR_JTAG_DEVICE_ERROR;
-       
+
        presto_data = 0xD0;
        if ((presto->status = FT_Write(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
                return ERROR_JTAG_DEVICE_ERROR;
-       
+
        /* delay between first write/read turnaround (after purge?) necessary under Linux for unknown reason,
           probably a bug in library threading */
        usleep(100000);
        if ((presto->status = FT_Read(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
                return ERROR_JTAG_DEVICE_ERROR;
-                       
+
        if (ftbytes!=1)
        {
-               DEBUG("PRESTO reset");
-               
+               LOG_DEBUG("PRESTO reset");
+
                if ((presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX)) != FT_OK)
                        return ERROR_JTAG_DEVICE_ERROR;
                if ((presto->status = FT_SetBitMode(presto->handle, 0x80, 1)) != FT_OK)
@@ -310,31 +307,31 @@ int presto_open_ftd2xx(char *req_serial)
 
                if ((presto->status = FT_SetBitMode(presto->handle, 0x00, 0)) != FT_OK)
                        return ERROR_JTAG_DEVICE_ERROR;
-               
+
                if ((presto->status = FT_Purge(presto->handle, FT_PURGE_TX | FT_PURGE_RX)) != FT_OK)
                        return ERROR_JTAG_DEVICE_ERROR;
-       
+
                presto_data = 0xD0;
                if ((presto->status = FT_Write(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
                        return ERROR_JTAG_DEVICE_ERROR;
-               
+
                /* delay between first write/read turnaround (after purge?) necessary under Linux for unknown reason,
                   probably a bug in library threading */
                usleep(100000);
                if ((presto->status = FT_Read(presto->handle, &presto_data, 1, &ftbytes)) != FT_OK)
                        return ERROR_JTAG_DEVICE_ERROR;
-                               
+
                if (ftbytes!=1)
                {
-                       DEBUG("PRESTO not responding");
+                       LOG_DEBUG("PRESTO not responding");
                        return ERROR_JTAG_DEVICE_ERROR;
-               }       
+               }
        }
-       
+
        if ((presto->status = FT_SetTimeouts(presto->handle, 0, 0)) != FT_OK)
                return ERROR_JTAG_DEVICE_ERROR;
-       
-       
+
+
        presto->status = FT_Write(presto->handle, &presto_init_seq, sizeof(presto_init_seq), &ftbytes);
        if (presto->status != FT_OK || ftbytes != sizeof(presto_init_seq))
                return ERROR_JTAG_DEVICE_ERROR;
@@ -346,41 +343,72 @@ int presto_open_ftd2xx(char *req_serial)
 int presto_open_libftdi(char *req_serial)
 {
        u8 presto_data;
-       u32 ftbytes;
-               
-       DEBUG("searching for presto JTAG interface using libftdi");
+
+       LOG_DEBUG("searching for PRESTO using libftdi");
+
+       /* initialize FTDI context structure */
+       if (ftdi_init(&presto->ftdic) < 0)
+       {
+               LOG_ERROR("unable to init libftdi: %s", presto->ftdic.error_str);
+               return ERROR_JTAG_DEVICE_ERROR;
+       }
 
        /* context, vendor id, product id */
        if (ftdi_usb_open_desc(&presto->ftdic, PRESTO_VID, PRESTO_PID, NULL, req_serial) < 0)
        {
-               ERROR("unable to open presto: %s", presto->ftdic.error_str);
+               LOG_ERROR("unable to open PRESTO: %s", presto->ftdic.error_str);
                return ERROR_JTAG_DEVICE_ERROR;
        }
-       
+
        if (ftdi_usb_reset(&presto->ftdic) < 0)
        {
-               ERROR("unable to reset presto device");
+               LOG_ERROR("unable to reset PRESTO device");
                return ERROR_JTAG_DEVICE_ERROR;
        }
 
        if (ftdi_set_latency_timer(&presto->ftdic, 1) < 0)
        {
-               ERROR("unable to set latency timer");
+               LOG_ERROR("unable to set latency timer");
                return ERROR_JTAG_DEVICE_ERROR;
        }
 
        if (ftdi_usb_purge_buffers(&presto->ftdic) < 0)
        {
-               ERROR("unable to purge presto buffer");
+               LOG_ERROR("unable to purge PRESTO buffers");
                return ERROR_JTAG_DEVICE_ERROR;
        }
-       
+
        presto_data = 0xD0;
-       if ((presto->retval = presto_write(&presto_data, 1, &ftbytes)) != ERROR_OK)
+       if (presto_write(&presto_data, 1) != ERROR_OK)
+       {
+               LOG_ERROR("error writing to PRESTO");
                return ERROR_JTAG_DEVICE_ERROR;
-       if ((presto->retval = presto_read(&presto_data, 1, &ftbytes)) != ERROR_OK)
+       }
+
+       if (presto_read(&presto_data, 1) != ERROR_OK)
+       {
+               LOG_DEBUG("no response from PRESTO, retrying");
+
+               if (ftdi_usb_purge_buffers(&presto->ftdic) < 0)
+                       return ERROR_JTAG_DEVICE_ERROR;
+
+               presto_data = 0xD0;
+               if (presto_write(&presto_data, 1) != ERROR_OK)
+                       return ERROR_JTAG_DEVICE_ERROR;
+
+               if (presto_read(&presto_data, 1) != ERROR_OK)
+               {
+                       LOG_ERROR("no response from PRESTO, giving up");
+                       return ERROR_JTAG_DEVICE_ERROR;
+               }
+       }
+
+       if (presto_write(presto_init_seq, sizeof(presto_init_seq)) != ERROR_OK)
+       {
+               LOG_ERROR("error writing PRESTO init sequence");
                return ERROR_JTAG_DEVICE_ERROR;
-       
+       }
+
        return ERROR_OK;
 }
 #endif /* BUILD_PRESTO_LIBFTDI == 1 */
@@ -433,21 +461,19 @@ int presto_close(void)
                result = ERROR_JTAG_DEVICE_ERROR;
        else
                presto->handle = (FT_HANDLE)INVALID_HANDLE_VALUE;
-       
+
 #elif BUILD_PRESTO_LIBFTDI == 1
-       
-       if ((presto->retval = ftdi_write_data(&presto->ftdic, presto_init_seq, sizeof(presto_init_seq))) < 0)
-       {
+
+       if ((presto->retval = ftdi_write_data(&presto->ftdic, presto_init_seq, sizeof(presto_init_seq))) != sizeof(presto_init_seq))
                result = ERROR_JTAG_DEVICE_ERROR;
-       }
-       
+
        if ((presto->retval = ftdi_set_latency_timer(&presto->ftdic, 16)) < 0)
-       {
                result = ERROR_JTAG_DEVICE_ERROR;
-       }
-       
-       ftdi_deinit(&presto->ftdic);
 
+       if ((presto->retval = ftdi_usb_close(&presto->ftdic)) < 0)
+               result = ERROR_JTAG_DEVICE_ERROR;
+       else
+               ftdi_deinit(&presto->ftdic);
 #endif
 
        return result;
@@ -456,33 +482,26 @@ int presto_close(void)
 
 int presto_flush(void)
 {
-       u32 ftbytes;
-
        if (presto->buff_out_pos == 0)
                return ERROR_OK;
 
 #if BUILD_PRESTO_FTD2XX == 1
        if (presto->status != FT_OK)
 #elif BUILD_PRESTO_LIBFTDI == 1
-       if (presto->retval != ERROR_OK)
+       if (presto->retval < 0)
 #endif
-               return ERROR_JTAG_DEVICE_ERROR;
-
-
-       if (presto_write(presto->buff_out, presto->buff_out_pos, &ftbytes) != ERROR_OK)
        {
-               presto->buff_out_pos = 0;
+               LOG_DEBUG("error in previous communication, canceling I/O operation");
                return ERROR_JTAG_DEVICE_ERROR;
        }
 
-       presto->total_out += ftbytes;
-
-       if (presto->buff_out_pos != ftbytes)
+       if (presto_write(presto->buff_out, presto->buff_out_pos) != ERROR_OK)
        {
                presto->buff_out_pos = 0;
                return ERROR_JTAG_DEVICE_ERROR;
        }
 
+       presto->total_out += presto->buff_out_pos;
        presto->buff_out_pos = 0;
 
        if (presto->buff_in_exp == 0)
@@ -491,20 +510,13 @@ int presto_flush(void)
        presto->buff_in_pos = 0;
        presto->buff_in_len = 0;
 
-       if (presto_read(presto->buff_in, presto->buff_in_exp, &ftbytes) != ERROR_OK)
-       {
-               presto->buff_in_exp = 0;
-               return ERROR_JTAG_DEVICE_ERROR;
-       }
-
-       presto->total_in += ftbytes;
-
-       if (ftbytes != presto->buff_in_exp)
+       if (presto_read(presto->buff_in, presto->buff_in_exp) != ERROR_OK)
        {
                presto->buff_in_exp = 0;
                return ERROR_JTAG_DEVICE_ERROR;
        }
 
+       presto->total_in += presto->buff_in_exp;
        presto->buff_in_len = presto->buff_in_exp;
        presto->buff_in_exp = 0;
 
@@ -525,9 +537,14 @@ int presto_sendbyte(int data)
        else
                return ERROR_JTAG_DEVICE_ERROR;
 
+#if BUILD_PRESTO_FTD2XX == 1
        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)
+#endif
                return presto_flush();
-       
+
        return ERROR_OK;
 }
 
@@ -539,7 +556,7 @@ int presto_getbyte(void)
 
        if (presto->buff_in_exp == 0)
                return -1;
-       
+
        if (presto_flush() != ERROR_OK)
                return -1;
 
@@ -569,7 +586,7 @@ int presto_bitq_out(int tms, int tdi, int tdo_req)
                        presto->jtag_tdi_data = (tdi != 0);
                else
                        presto->jtag_tdi_data |= (tdi != 0) << presto->jtag_tdi_count;
-               
+
                if (++presto->jtag_tdi_count == 4)
                {
                        presto->jtag_tdi_data |= (presto->jtag_tdi_count - 1) << 4;
@@ -696,12 +713,12 @@ int presto_jtag_speed(int speed)
 
        if ((speed < 0) || (speed > 3))
        {
-               INFO("valid speed values: 0 (3 MHz), 1 (1.5 MHz), 2 (750 kHz) and 3 (93.75 kHz)");
+               LOG_INFO("valid speed values: 0 (3 MHz), 1 (1.5 MHz), 2 (750 kHz) and 3 (93.75 kHz)");
                return ERROR_INVALID_ARGUMENTS;
        }
 
        jtag_speed = speed;
-       INFO("setting speed to %d, max. TCK freq. is %s", speed, presto_speed_text[speed]);
+       LOG_INFO("setting speed to %d, max. TCK freq. is %s", speed, presto_speed_text[speed]);
        return presto_sendbyte(0xA8 | speed);
 }
 
@@ -718,7 +735,7 @@ int presto_handle_serial_command(struct command_context_s *cmd_ctx, char *cmd, c
        }
        else
        {
-               ERROR("expected exactly one argument to presto_serial <serial-number>");
+               LOG_ERROR("expected exactly one argument to presto_serial <serial-number>");
        }
 
        return ERROR_OK;
@@ -739,16 +756,16 @@ int presto_jtag_init(void)
        {
                presto_close();
                if (presto_serial != NULL)
-                       ERROR("Cannot open PRESTO, serial number '%s'", presto_serial);
+                       LOG_ERROR("Cannot open PRESTO, serial number '%s'", presto_serial);
                else
-                       ERROR("Cannot open PRESTO");
+                       LOG_ERROR("Cannot open PRESTO");
                return ERROR_JTAG_INIT_FAILED;
        }
-       INFO("PRESTO open, serial number '%s'", presto->serial);
-       
+       LOG_INFO("PRESTO open, serial number '%s'", presto->serial);
+
        /* use JTAG speed setting from configuration file */
        presto_jtag_speed(jtag_speed);
-       
+
        bitq_interface = &presto_bitq;
        return ERROR_OK;
 }
@@ -758,7 +775,7 @@ int presto_jtag_quit(void)
 {
        bitq_cleanup();
        presto_close();
-       INFO("PRESTO closed");
+       LOG_INFO("PRESTO closed");
 
        if (presto_serial)
        {

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)