]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/ikalogic-scanaplus/api.c
drivers: Drop unneeded or duplicate comments.
[libsigrok.git] / src / hardware / ikalogic-scanaplus / api.c
index 439116cc69dc757c9b69cf1fee0c0ed6087ccef9..86c1402e511e635ec2fe4538140f143d555befe3 100644 (file)
 
 #define SAMPLE_BUF_SIZE                        (8 * 1024 * 1024)
 
-static const uint32_t devopts[] = {
+static const uint32_t drvopts[] = {
        SR_CONF_LOGIC_ANALYZER,
+};
+
+static const uint32_t devopts[] = {
        SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
        SR_CONF_LIMIT_MSEC | SR_CONF_SET,
        SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
 };
 
-/* Channels are numbered 1-9. */
 static const char *channel_names[] = {
        "1", "2", "3", "4", "5", "6", "7", "8", "9",
 };
@@ -43,21 +45,16 @@ static const char *channel_names[] = {
 /* Note: The IKALOGIC ScanaPLUS always samples at 100MHz. */
 static const uint64_t samplerates[1] = { SR_MHZ(100) };
 
-static void clear_helper(void *priv)
+static void clear_helper(struct dev_context *devc)
 {
-       struct dev_context *devc;
-
-       devc = priv;
-
        ftdi_free(devc->ftdic);
        g_free(devc->compressed_buf);
        g_free(devc->sample_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 GSList *scan(struct sr_dev_driver *di, GSList *options)
@@ -69,7 +66,6 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
 
        (void)options;
 
-       /* Allocate memory for our private device context. */
        devc = g_malloc0(sizeof(struct dev_context));
 
        /* Allocate memory for the incoming compressed samples. */
@@ -84,13 +80,11 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                goto err_free_compressed_buf;
        }
 
-       /* Allocate memory for the FTDI context (ftdic) and initialize it. */
        if (!(devc->ftdic = ftdi_new())) {
                sr_err("Failed to initialize libftdi.");
                goto err_free_sample_buf;
        }
 
-       /* Check for the device and temporarily open it. */
        ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
                                 USB_IPRODUCT, NULL);
        if (ret < 0) {
@@ -101,7 +95,6 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                goto err_free_ftdic;
        }
 
-       /* Register the device with libsigrok. */
        sdi = g_malloc0(sizeof(struct sr_dev_inst));
        sdi->status = SR_ST_INACTIVE;
        sdi->vendor = g_strdup(USB_VENDOR_NAME);
@@ -111,14 +104,13 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        for (i = 0; i < ARRAY_SIZE(channel_names); i++)
                sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
 
-       /* Close device. We'll reopen it again when we need it. */
        scanaplus_close(devc);
 
        return std_scan_complete(di, g_slist_append(NULL, sdi));
 
        scanaplus_close(devc);
 err_free_ftdic:
-       ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
+       ftdi_free(devc->ftdic);
 err_free_sample_buf:
        g_free(devc->sample_buf);
 err_free_compressed_buf:
@@ -136,16 +128,13 @@ static int dev_open(struct sr_dev_inst *sdi)
 
        devc = sdi->priv;
 
-       /* Select interface A, otherwise communication will fail. */
        ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
        if (ret < 0) {
                sr_err("Failed to set FTDI interface A (%d): %s", ret,
                       ftdi_get_error_string(devc->ftdic));
                return SR_ERR;
        }
-       sr_dbg("FTDI chip interface A set successfully.");
 
-       /* Open the device. */
        ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
                                 USB_IPRODUCT, NULL);
        if (ret < 0) {
@@ -153,51 +142,40 @@ static int dev_open(struct sr_dev_inst *sdi)
                       ftdi_get_error_string(devc->ftdic));
                return SR_ERR;
        }
-       sr_dbg("FTDI device opened successfully.");
 
-       /* Purge RX/TX buffers in the FTDI chip. */
        if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 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, 0xff, 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.");
 
-       /* Set FTDI bitmode to "sync FIFO". */
        ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
        if (ret < 0) {
                sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip sync FIFO mode entered successfully.");
 
-       /* Set the FTDI latency timer to 2. */
        ret = ftdi_set_latency_timer(devc->ftdic, 2);
        if (ret < 0) {
                sr_err("Failed to set FTDI latency timer (%d): %s.",
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip latency timer set successfully.");
 
-       /* Set the FTDI read data chunk size to 64kB. */
        ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
        if (ret < 0) {
                sr_err("Failed to set FTDI read data chunk size (%d): %s.",
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_dev_open_close_ftdic;
        }
-       sr_dbg("FTDI chip read data chunk size set successfully.");
 
        /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
        if ((ret = scanaplus_get_device_id(devc)) < 0) {
@@ -207,33 +185,21 @@ static int dev_open(struct sr_dev_inst *sdi)
        sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
               devc->devid[0], devc->devid[1], devc->devid[2]);
 
-       sdi->status = SR_ST_ACTIVE;
-
        return SR_OK;
 
 err_dev_open_close_ftdic:
        scanaplus_close(devc);
+
        return SR_ERR;
 }
 
 static int dev_close(struct sr_dev_inst *sdi)
 {
-       int ret;
        struct dev_context *devc;
 
-       ret = SR_OK;
        devc = sdi->priv;
 
-       if (sdi->status == SR_ST_ACTIVE) {
-               sr_dbg("Status ACTIVE, closing device.");
-               ret = scanaplus_close(devc);
-       } else {
-               sr_spew("Status not ACTIVE, nothing to do.");
-       }
-
-       sdi->status = SR_ST_INACTIVE;
-
-       return ret;
+       return scanaplus_close(devc);
 }
 
 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
@@ -261,9 +227,6 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
 
        (void)cg;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
 
        switch (key) {
@@ -297,14 +260,9 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
        GVariant *gvar;
        GVariantBuilder gvb;
 
-       (void)sdi;
-       (void)cg;
-
        switch (key) {
        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, NULL, 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"),
@@ -325,9 +283,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        int ret;
        struct dev_context *devc;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
 
        if (!devc->ftdic)