]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/fx2lafw/api.c
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / hardware / fx2lafw / api.c
index bffd2534f60f1121dea408240be3a5fe50391447..255788bfdd0731233ca75e0a9454bb7021ce5de2 100644 (file)
 static const struct fx2lafw_profile supported_fx2[] = {
        /*
         * CWAV USBee AX
-        * EE Electronics ESLA201A
-        * ARMFLY AX-Pro
+        * ARMFLY AX-Pro (clone of the CWAV USBee AX)
+        * ARMFLY Mini-Logic (clone of the CWAV USBee AX)
+        * EE Electronics ESLA201A (clone of the CWAV USBee AX)
+        * HT USBee-AxPro (clone of the CWAV USBee AX)
+        * MCU123 USBee AX Pro clone (clone of the CWAV USBee AX)
+        * Noname LHT00SU1 (clone of the CWAV USBee AX)
+        * XZL_Studio AX (clone of the CWAV USBee AX)
         */
        { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
                "fx2lafw-cwav-usbeeax.fw",
                DEV_CAPS_AX_ANALOG, NULL, NULL},
+
        /*
         * CWAV USBee DX
-        * XZL-Studio DX
+        * HT USBee-DxPro (clone of the CWAV USBee DX), not yet supported!
+        * XZL-Studio DX (clone of the CWAV USBee DX)
         */
        { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
                "fx2lafw-cwav-usbeedx.fw",
@@ -55,9 +62,12 @@ static const struct fx2lafw_profile supported_fx2[] = {
 
        /*
         * Saleae Logic
-        * EE Electronics ESLA100
-        * Robomotic MiniLogic
-        * Robomotic BugLogic 3
+        * EE Electronics ESLA100 (clone of the Saleae Logic)
+        * Hantek 6022BL in LA mode (clone of the Saleae Logic)
+        * Instrustar ISDS205X in LA mode (clone of the Saleae Logic)
+        * Robomotic MiniLogic (clone of the Saleae Logic)
+        * Robomotic BugLogic 3 (clone of the Saleae Logic)
+        * MCU123 Saleae Logic clone (clone of the Saleae Logic)
         */
        { 0x0925, 0x3881, "Saleae", "Logic", NULL,
                "fx2lafw-saleae-logic.fw",
@@ -67,6 +77,7 @@ static const struct fx2lafw_profile supported_fx2[] = {
         * Default Cypress FX2 without EEPROM, e.g.:
         * Lcsoft Mini Board
         * Braintechnology USB Interface V2.x
+        * fx2grok-tiny
         */
        { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
                "fx2lafw-cypress-fx2.fw",
@@ -81,6 +92,7 @@ static const struct fx2lafw_profile supported_fx2[] = {
 
        /*
         * sigrok FX2 based 8-channel logic analyzer
+        * fx2grok-flat (before and after renumeration)
         */
        { 0x1d50, 0x608c, "sigrok", "FX2 LA (8ch)", NULL,
                "fx2lafw-sigrok-fx2-8ch.fw",
@@ -93,11 +105,19 @@ static const struct fx2lafw_profile supported_fx2[] = {
                "fx2lafw-sigrok-fx2-16ch.fw",
                DEV_CAPS_16BIT, NULL, NULL },
 
+       /*
+        * usb-c-grok
+        */
+       { 0x1d50, 0x608f, "sigrok", "usb-c-grok", NULL,
+               "fx2lafw-usb-c-grok.fw",
+               0, NULL, NULL},
+
        ALL_ZERO
 };
 
 static const uint32_t scanopts[] = {
        SR_CONF_CONN,
+       SR_CONF_PROBE_NAMES,
 };
 
 static const uint32_t drvopts[] = {
@@ -106,6 +126,7 @@ static const uint32_t drvopts[] = {
 
 static const uint32_t devopts[] = {
        SR_CONF_CONTINUOUS,
+       SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
        SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
        SR_CONF_CONN | SR_CONF_GET,
        SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
@@ -138,6 +159,16 @@ static const uint64_t samplerates[] = {
        SR_MHZ(12),
        SR_MHZ(16),
        SR_MHZ(24),
+       SR_MHZ(48),
+};
+
+static const char *channel_names_logic[] = {
+       "D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
+       "D8", "D9", "D10", "D11", "D12", "D13", "D14", "D15",
+};
+
+static const char *channel_names_analog[] = {
+       "A0", "A1", "A2", "A3",
 };
 
 static gboolean is_plausible(const struct libusb_device_descriptor *des)
@@ -169,21 +200,27 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        struct libusb_device_descriptor des;
        libusb_device **devlist;
        struct libusb_device_handle *hdl;
-       int ret, i, j;
-       int num_logic_channels = 0, num_analog_channels = 0;
+       int ret, i;
+       size_t j, num_logic_channels, num_analog_channels;
        const char *conn;
+       const char *probe_names;
        char manufacturer[64], product[64], serial_num[64], connection_id[64];
-       char channel_name[16];
+       size_t ch_max, ch_idx;
+       const char *channel_name;
 
        drvc = di->context;
 
        conn = NULL;
+       probe_names = NULL;
        for (l = options; l; l = l->next) {
                src = l->data;
                switch (src->key) {
                case SR_CONF_CONN:
                        conn = g_variant_get_string(src->data, NULL);
                        break;
+               case SR_CONF_PROBE_NAMES:
+                       probe_names = g_variant_get_string(src->data, NULL);
+                       break;
                }
        }
        if (conn)
@@ -251,10 +288,11 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                        continue;
                }
 
-               usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
-
                libusb_close(hdl);
 
+               if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
+                       continue;
+
                prof = NULL;
                for (j = 0; supported_fx2[j].vid; j++) {
                        if (des.idVendor == supported_fx2[j].vid &&
@@ -279,38 +317,56 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                sdi->serial_num = g_strdup(serial_num);
                sdi->connection_id = g_strdup(connection_id);
 
+               devc = fx2lafw_dev_new();
+               devc->profile = prof;
+               sdi->priv = devc;
+               devices = g_slist_append(devices, sdi);
+
                /* Fill in channellist according to this device's profile. */
                num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
+               if (num_logic_channels > ARRAY_SIZE(channel_names_logic))
+                       num_logic_channels = ARRAY_SIZE(channel_names_logic);
                num_analog_channels = prof->dev_caps & DEV_CAPS_AX_ANALOG ? 1 : 0;
+               if (num_analog_channels > ARRAY_SIZE(channel_names_analog))
+                       num_analog_channels = ARRAY_SIZE(channel_names_analog);
+
+               /*
+                * Allow user specs to override the builtin probe names.
+                *
+                * Implementor's note: Because the device's number of
+                * logic channels is not known at compile time, and thus
+                * the location of the analog channel names is not known
+                * at compile time, and the construction of a list with
+                * default names at runtime is not done here, and we
+                * don't want to keep several default lists around, this
+                * implementation only supports to override the names of
+                * logic probes. The use case which motivated the config
+                * key is protocol decoders, which are logic only.
+                */
+               ch_max = num_logic_channels;
+               devc->channel_names = sr_parse_probe_names(probe_names,
+                       channel_names_logic, ch_max, ch_max, &ch_max);
+               ch_idx = 0;
 
                /* Logic channels, all in one channel group. */
-               cg = g_malloc0(sizeof(struct sr_channel_group));
-               cg->name = g_strdup("Logic");
+               cg = sr_channel_group_new(sdi, "Logic", NULL);
                for (j = 0; j < num_logic_channels; j++) {
-                       sprintf(channel_name, "D%d", j);
-                       ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC,
-                                               TRUE, channel_name);
+                       channel_name = devc->channel_names[j];
+                       ch = sr_channel_new(sdi, ch_idx++, SR_CHANNEL_LOGIC,
+                               TRUE, channel_name);
                        cg->channels = g_slist_append(cg->channels, ch);
                }
-               sdi->channel_groups = g_slist_append(NULL, cg);
 
                for (j = 0; j < num_analog_channels; j++) {
-                       snprintf(channel_name, 16, "A%d", j);
-                       ch = sr_channel_new(sdi, j + num_logic_channels,
-                                       SR_CHANNEL_ANALOG, TRUE, channel_name);
+                       channel_name = channel_names_analog[j];
+                       ch = sr_channel_new(sdi, ch_idx++, SR_CHANNEL_ANALOG,
+                               TRUE, channel_name);
 
                        /* Every analog channel gets its own channel group. */
-                       cg = g_malloc0(sizeof(struct sr_channel_group));
-                       cg->name = g_strdup(channel_name);
+                       cg = sr_channel_group_new(sdi, channel_name, NULL);
                        cg->channels = g_slist_append(NULL, ch);
-                       sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
                }
 
-               devc = fx2lafw_dev_new();
-               devc->profile = prof;
-               sdi->priv = devc;
-               devices = g_slist_append(devices, sdi);
-
                devc->samplerates = samplerates;
                devc->num_samplerates = ARRAY_SIZE(samplerates);
                has_firmware = usb_match_manuf_prod(devlist[i],
@@ -325,14 +381,16 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                                        libusb_get_device_address(devlist[i]), NULL);
                } else {
                        if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
-                                       USB_CONFIGURATION, prof->firmware) == SR_OK)
+                                       USB_CONFIGURATION, prof->firmware) == SR_OK) {
                                /* Store when this device's FW was updated. */
                                devc->fw_updated = g_get_monotonic_time();
-                       else
+                       } else {
                                sr_err("Firmware upload failed for "
-                                      "device %d.%d (logical).",
+                                      "device %d.%d (logical), name %s.",
                                       libusb_get_bus_number(devlist[i]),
-                                      libusb_get_device_address(devlist[i]));
+                                      libusb_get_device_address(devlist[i]),
+                                      prof->firmware);
+                       }
                        sdi->inst_type = SR_INST_USB;
                        sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
                                        0xff, NULL);
@@ -449,7 +507,6 @@ static int config_get(uint32_t key, GVariant **data,
 {
        struct dev_context *devc;
        struct sr_usb_dev_inst *usb;
-       char str[128];
 
        (void)cg;
 
@@ -467,8 +524,10 @@ static int config_get(uint32_t key, GVariant **data,
                        /* Device still needs to re-enumerate after firmware
                         * upload, so we don't know its (future) address. */
                        return SR_ERR;
-               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;
+       case SR_CONF_LIMIT_FRAMES:
+               *data = g_variant_new_uint64(devc->limit_frames);
                break;
        case SR_CONF_LIMIT_SAMPLES:
                *data = g_variant_new_uint64(devc->limit_samples);
@@ -490,8 +549,7 @@ static int config_set(uint32_t key, GVariant *data,
        const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
-       uint64_t arg;
-       int i, ret;
+       int idx;
 
        (void)cg;
 
@@ -500,32 +558,26 @@ static int config_set(uint32_t key, GVariant *data,
 
        devc = sdi->priv;
 
-       ret = SR_OK;
-
        switch (key) {
        case SR_CONF_SAMPLERATE:
-               arg = g_variant_get_uint64(data);
-               for (i = 0; i < devc->num_samplerates; i++) {
-                       if (devc->samplerates[i] == arg) {
-                               devc->cur_samplerate = arg;
-                               break;
-                       }
-               }
-               if (i == devc->num_samplerates)
-                       ret = SR_ERR_ARG;
+               if ((idx = std_u64_idx(data, devc->samplerates, devc->num_samplerates)) < 0)
+                       return SR_ERR_ARG;
+               devc->cur_samplerate = devc->samplerates[idx];
+               break;
+       case SR_CONF_LIMIT_FRAMES:
+               devc->limit_frames = g_variant_get_uint64(data);
                break;
        case SR_CONF_LIMIT_SAMPLES:
                devc->limit_samples = g_variant_get_uint64(data);
                break;
        case SR_CONF_CAPTURE_RATIO:
                devc->capture_ratio = g_variant_get_uint64(data);
-               ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
                break;
        default:
-               ret = SR_ERR_NA;
+               return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
 static int config_list(uint32_t key, GVariant **data,
@@ -538,8 +590,12 @@ static int config_list(uint32_t key, GVariant **data,
        switch (key) {
        case SR_CONF_SCAN_OPTIONS:
        case SR_CONF_DEVICE_OPTIONS:
+               if (cg)
+                       return SR_ERR_NA;
                return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
        case SR_CONF_SAMPLERATE:
+               if (!devc)
+                       return SR_ERR_NA;
                *data = std_gvar_samplerates(devc->samplerates, devc->num_samplerates);
                break;
        case SR_CONF_TRIGGER_MATCH: