]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/ftdi-la/api.c
ftdi: address ftdi_usb_purge_buffers() deprecation in libftdi 1.5
[libsigrok.git] / src / hardware / ftdi-la / api.c
index 0927d3a274387d14d1fe1dd34a1377f72a73ee23..2e7e59f49324c4b63310e4fb6c03ced6f229ed29 100644 (file)
@@ -28,8 +28,11 @@ static const uint32_t scanopts[] = {
        SR_CONF_CONN,
 };
 
-static const uint32_t devopts[] = {
+static const uint32_t drvopts[] = {
        SR_CONF_LOGIC_ANALYZER,
+};
+
+static const uint32_t devopts[] = {
        SR_CONF_CONTINUOUS,
        SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
        SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
@@ -47,44 +50,69 @@ static const struct ftdi_chip_desc ft2232h_desc = {
        .product = 0x6010,
        .samplerate_div = 20,
        .channel_names = {
-               "ADBUS0",
-               "ADBUS1",
-               "ADBUS2",
-               "ADBUS3",
-               "ADBUS4",
-               "ADBUS5",
-               "ADBUS6",
-               "ADBUS7",
+               "ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3",
+               "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
                /* TODO: BDBUS[0..7] channels. */
                NULL
        }
 };
 
+static const struct ftdi_chip_desc ft2232h_tumpa_desc = {
+       .vendor = 0x0403,
+       .product = 0x8a98,
+       .samplerate_div = 20,
+       /* 20 pin JTAG header */
+       .channel_names = {
+               "TCK", "TDI", "TDO", "TMS", "RST", "nTRST", "DBGRQ", "RTCK",
+               NULL
+       }
+};
+
+static const struct ftdi_chip_desc ft4232h_desc = {
+       .vendor = 0x0403,
+       .product = 0x6011,
+       .samplerate_div = 20,
+       .channel_names = {
+               "ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
+               /* TODO: BDBUS[0..7], CDBUS[0..7], DDBUS[0..7] channels. */
+               NULL
+       }
+};
+
 static const struct ftdi_chip_desc ft232r_desc = {
        .vendor = 0x0403,
        .product = 0x6001,
        .samplerate_div = 30,
        .channel_names = {
-               "TXD",
-               "RXD",
-               "RTS#",
-               "CTS#",
-               "DTR#",
-               "DSR#",
-               "DCD#",
-               "RI#",
+               "TXD", "RXD", "RTS#", "CTS#", "DTR#", "DSR#", "DCD#", "RI#",
+               NULL
+       }
+};
+
+static const struct ftdi_chip_desc ft232h_desc = {
+       .vendor = 0x0403,
+       .product = 0x6014,
+       .samplerate_div = 30,
+       .channel_names = {
+               "ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7",
                NULL
        }
 };
 
 static const struct ftdi_chip_desc *chip_descs[] = {
        &ft2232h_desc,
+       &ft2232h_tumpa_desc,
+       &ft4232h_desc,
        &ft232r_desc,
+       &ft232h_desc,
+       NULL,
 };
 
 static void scan_device(struct ftdi_context *ftdic,
        struct libusb_device *dev, GSList **devices)
 {
+       static const int usb_str_maxlen = 32;
+
        struct libusb_device_descriptor usb_desc;
        const struct ftdi_chip_desc *desc;
        struct dev_context *devc;
@@ -97,18 +125,19 @@ static void scan_device(struct ftdi_context *ftdic,
        desc = NULL;
        for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) {
                desc = chip_descs[i];
+               if (!desc)
+                       break;
                if (desc->vendor == usb_desc.idVendor &&
                        desc->product == usb_desc.idProduct)
                        break;
        }
 
        if (!desc) {
-               sr_spew("Unsupported FTDI device 0x%4x:0x%4x.",
+               sr_spew("Unsupported FTDI device 0x%04x:0x%04x.",
                        usb_desc.idVendor, usb_desc.idProduct);
                return;
        }
 
-       /* Allocate memory for our private device context. */
        devc = g_malloc0(sizeof(struct dev_context));
 
        /* Allocate memory for the incoming data. */
@@ -116,14 +145,42 @@ static void scan_device(struct ftdi_context *ftdic,
 
        devc->desc = desc;
 
-       vendor = g_malloc(32);
-       model = g_malloc(32);
-       serial_num = g_malloc(32);
-       rv = ftdi_usb_get_strings(ftdic, dev, vendor, 32,
-                       model, 32, serial_num, 32);
+       vendor = g_malloc(usb_str_maxlen);
+       model = g_malloc(usb_str_maxlen);
+       serial_num = g_malloc(usb_str_maxlen);
+       rv = ftdi_usb_get_strings(ftdic, dev, vendor, usb_str_maxlen,
+                       model, usb_str_maxlen, serial_num, usb_str_maxlen);
        switch (rv) {
        case 0:
                break;
+       /* ftdi_usb_get_strings() fails on first miss, hence fall through. */
+       case -7:
+               sr_dbg("The device lacks a manufacturer descriptor.");
+               g_snprintf(vendor, usb_str_maxlen, "Generic");
+               /* FALLTHROUGH */
+       case -8:
+               sr_dbg("The device lacks a product descriptor.");
+               switch (usb_desc.idProduct) {
+               case 0x6001:
+                       g_snprintf(model, usb_str_maxlen, "FT232R");
+                       break;
+               case 0x6010:
+                       g_snprintf(model, usb_str_maxlen, "FT2232H");
+                       break;
+               case 0x6011:
+                       g_snprintf(model, usb_str_maxlen, "FT4232H");
+                       break;
+               case 0x6014:
+                       g_snprintf(model, usb_str_maxlen, "FT232H");
+                       break;
+               case 0x8a98:
+                       g_snprintf(model, usb_str_maxlen, "FT2232H-TUMPA");
+                       break;
+               default:
+                       g_snprintf(model, usb_str_maxlen, "Unknown");
+                       break;
+               }
+               /* FALLTHROUGH */
        case -9:
                sr_dbg("The device lacks a serial number.");
                g_free(serial_num);
@@ -135,7 +192,6 @@ static void scan_device(struct ftdi_context *ftdic,
        }
        sr_dbg("Found an FTDI device: %s.", model);
 
-       /* Register the device with libsigrok. */
        sdi = g_malloc0(sizeof(struct sr_dev_inst));
        sdi->status = SR_ST_INACTIVE;
        sdi->vendor = vendor;
@@ -178,8 +234,6 @@ static GSList *scan_all(struct ftdi_context *ftdic, GSList *options)
                return NULL;
        }
 
-       sr_dbg("Number of FTDI devices found: %d", ret);
-
        curdev = devlist;
        while (curdev) {
                scan_device(ftdic, curdev->dev, &devices);
@@ -213,7 +267,6 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                }
        }
 
-       /* Allocate memory for the FTDI context (ftdic) and initialize it. */
        ftdic = ftdi_new();
        if (!ftdic) {
                sr_err("Failed to initialize libftdi.");
@@ -242,18 +295,14 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        return std_scan_complete(di, devices);
 }
 
-static void clear_helper(void *priv)
+static void clear_helper(struct dev_context *devc)
 {
-       struct dev_context *devc;
-
-       devc = priv;
        g_free(devc->data_buf);
-       g_free(devc);
 }
 
 static int dev_clear(const struct sr_dev_driver *di)
 {
-       return std_dev_clear(di, clear_helper);
+       return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 }
 
 static int dev_open(struct sr_dev_inst *sdi)
@@ -276,23 +325,19 @@ static int dev_open(struct sr_dev_inst *sdi)
                goto err_ftdi_free;
        }
 
-       /* Purge RX/TX buffers in the FTDI chip. */
-       ret = ftdi_usb_purge_buffers(devc->ftdic);
+       ret = PURGE_FTDI_BOTH(devc->ftdic);
        if (ret < 0) {
                sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip buffers purged successfully.");
 
-       /* Reset the FTDI bitmode. */
        ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET);
        if (ret < 0) {
                sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip bitmode reset successfully.");
 
        ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG);
        if (ret < 0) {
@@ -300,15 +345,15 @@ static int dev_open(struct sr_dev_inst *sdi)
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip bitbang mode entered successfully.");
-
-       sdi->status = SR_ST_ACTIVE;
 
        return SR_OK;
+
 err_dev_open_close_ftdic:
        ftdi_usb_close(devc->ftdic);
+
 err_ftdi_free:
        ftdi_free(devc->ftdic);
+
        return SR_ERR;
 }
 
@@ -318,13 +363,12 @@ static int dev_close(struct sr_dev_inst *sdi)
 
        devc = sdi->priv;
 
-       if (devc->ftdic) {
-               ftdi_usb_close(devc->ftdic);
-               ftdi_free(devc->ftdic);
-               devc->ftdic = NULL;
-       }
+       if (!devc->ftdic)
+               return SR_ERR_BUG;
 
-       sdi->status = SR_ST_INACTIVE;
+       ftdi_usb_close(devc->ftdic);
+       ftdi_free(devc->ftdic);
+       devc->ftdic = NULL;
 
        return SR_OK;
 }
@@ -332,16 +376,13 @@ static int dev_close(struct sr_dev_inst *sdi)
 static int config_get(uint32_t key, GVariant **data,
        const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       int ret;
        struct dev_context *devc;
        struct sr_usb_dev_inst *usb;
-       char str[128];
 
        (void)cg;
 
        devc = sdi->priv;
 
-       ret = SR_OK;
        switch (key) {
        case SR_CONF_SAMPLERATE:
                *data = g_variant_new_uint64(devc->cur_samplerate);
@@ -350,40 +391,32 @@ static int config_get(uint32_t key, GVariant **data,
                if (!sdi || !sdi->conn)
                        return SR_ERR_ARG;
                usb = sdi->conn;
-               snprintf(str, 128, "%d.%d", usb->bus, usb->address);
-               *data = g_variant_new_string(str);
+               *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
                break;
        default:
                return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
 static int config_set(uint32_t key, GVariant *data,
        const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       int ret;
        struct dev_context *devc;
        uint64_t value;
 
        (void)cg;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
 
-       ret = SR_OK;
        switch (key) {
        case SR_CONF_LIMIT_MSEC:
                value = g_variant_get_uint64(data);
                /* TODO: Implement. */
-               ret = SR_ERR_NA;
-               break;
+               (void)value;
+               return SR_ERR_NA;
        case SR_CONF_LIMIT_SAMPLES:
-               if (g_variant_get_uint64(data) == 0)
-                       return SR_ERR_ARG;
                devc->limit_samples = g_variant_get_uint64(data);
                break;
        case SR_CONF_SAMPLERATE:
@@ -393,44 +426,27 @@ static int config_set(uint32_t key, GVariant *data,
                devc->cur_samplerate = value;
                return ftdi_la_set_samplerate(devc);
        default:
-               ret = SR_ERR_NA;
+               return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
 static int config_list(uint32_t key, GVariant **data,
        const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       int ret;
-       GVariant *gvar;
-       GVariantBuilder gvb;
-
-       (void)sdi;
-       (void)cg;
-
-       ret = SR_OK;
        switch (key) {
        case SR_CONF_SCAN_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                       scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
-               break;
        case SR_CONF_DEVICE_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                       devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
-               break;
+               return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
        case SR_CONF_SAMPLERATE:
-               g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
-               gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
-                       samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
-               g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
-               *data = g_variant_builder_end(&gvb);
+               *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
                break;
        default:
                return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
@@ -439,9 +455,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 
        devc = sdi->priv;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        if (!devc->ftdic)
                return SR_ERR_BUG;
 
@@ -462,10 +475,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 
 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 {
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
-       sr_dbg("Stopping acquisition.");
        sr_session_source_remove(sdi->session, -1);
 
        std_session_send_df_end(sdi);