]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/kingst-la2016/api.c
kingst-la2016: rephrase comments for style, readability, and text length
[libsigrok.git] / src / hardware / kingst-la2016 / api.c
index f6bf643855377212a4421e16a641794dc061e24b..34c64beb9830e1d4dc6095472f0fa05d5265f34c 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* mostly stolen from src/hardware/saleae-logic16/ */
+/*
+ * This driver implementation initially was derived from the
+ * src/hardware/saleae-logic16/ source code.
+ */
 
 #include <config.h>
-#include <glib.h>
-#include <libusb.h>
-#include <stdlib.h>
-#include <string.h>
-#include <math.h>
+
 #include <libsigrok/libsigrok.h>
+#include <string.h>
+
 #include "libsigrok-internal.h"
 #include "protocol.h"
 
@@ -160,7 +161,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        else
                conn_devices = NULL;
 
-       /* Find all LA2016 devices and upload firmware to them. */
+       /* Find all LA2016 devices, optionally upload firmware to them. */
        devices = NULL;
        libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
        for (i = 0; devlist[i]; i++) {
@@ -173,8 +174,10 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                                        break;
                        }
                        if (!l) {
-                               /* This device matched none of the ones that
-                                * matched the conn specification. */
+                               /*
+                                * A connection parameter was specified and
+                                * this device does not match the filter.
+                                */
                                continue;
                        }
                }
@@ -187,7 +190,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                if (des.idVendor != LA2016_VID || des.idProduct != LA2016_PID)
                        continue;
 
-               /* Already has the firmware */
+               /* USB identification matches, a device was found. */
                sr_dbg("Found a LA2016 device.");
                sdi = g_malloc0(sizeof(struct sr_dev_inst));
                sdi->status = SR_ST_INITIALIZING;
@@ -196,16 +199,17 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                fw_updated = 0;
                dev_addr = libusb_get_device_address(devlist[i]);
                if (des.iProduct != 2) {
-                       sr_info("device at '%s' has no firmware loaded!", connection_id);
+                       sr_info("Device at '%s' has no firmware loaded.", connection_id);
 
                        if (la2016_upload_firmware(drvc->sr_ctx, devlist[i], des.idProduct) != SR_OK) {
-                               sr_err("uC firmware upload failed!");
+                               sr_err("MCU firmware upload failed.");
                                g_free(sdi->connection_id);
                                g_free(sdi);
                                continue;
                        }
                        fw_updated = g_get_monotonic_time();
-                       dev_addr = 0xff; /* to mark that we don't know address yet... ugly */
+                       /* Will re-enumerate. Mark as "unknown address yet". */
+                       dev_addr = 0xff;
                }
 
                sdi->vendor = g_strdup("Kingst");
@@ -263,24 +267,24 @@ static int la2016_dev_open(struct sr_dev_inst *sdi)
                        continue;
 
                if ((sdi->status == SR_ST_INITIALIZING) || (sdi->status == SR_ST_INACTIVE)) {
-                       /*
-                        * Check device by its physical USB bus/port address.
-                        */
+                       /* Check physical USB bus/port address. */
                        if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
                                continue;
 
-                       if (strcmp(sdi->connection_id, connection_id))
-                               /* This is not the one. */
+                       if (strcmp(sdi->connection_id, connection_id)) {
+                               /* Not the device we looked up before. */
                                continue;
+                       }
                }
 
                if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
-                       if (usb->address == 0xff)
+                       if (usb->address == 0xff) {
                                /*
-                                * First time we touch this device after FW
-                                * upload, so we don't know the address yet.
+                                * First encounter after firmware upload.
+                                * Grab current address after enumeration.
                                 */
                                usb->address = libusb_get_device_address(devlist[i]);
+                       }
                } else {
                        sr_err("Failed to open device: %s.", libusb_error_name(ret));
                        ret = SR_ERR;
@@ -289,8 +293,7 @@ static int la2016_dev_open(struct sr_dev_inst *sdi)
 
                ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
                if (ret == LIBUSB_ERROR_BUSY) {
-                       sr_err("Unable to claim USB interface. Another "
-                              "program or driver has already claimed it.");
+                       sr_err("Cannot claim USB interface. Another program or driver using it?");
                        ret = SR_ERR;
                        break;
                } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
@@ -298,13 +301,13 @@ static int la2016_dev_open(struct sr_dev_inst *sdi)
                        ret = SR_ERR;
                        break;
                } else if (ret != 0) {
-                       sr_err("Unable to claim interface: %s.", libusb_error_name(ret));
+                       sr_err("Cannot claim USB interface: %s.", libusb_error_name(ret));
                        ret = SR_ERR;
                        break;
                }
 
                if ((ret = la2016_init_device(sdi)) != SR_OK) {
-                       sr_err("Failed to init device.");
+                       sr_err("Cannot initialize device.");
                        break;
                }
 
@@ -341,14 +344,16 @@ static int dev_open(struct sr_dev_inst *sdi)
        devc = sdi->priv;
 
        /*
-        * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
-        * milliseconds for the FX2 to renumerate.
+        * When the sigrok driver recently uploaded firmware, wait for
+        * the FX2 to re-enumerate. Deal with the condition that the
+        * MCU can take some 2000ms to be gone from the bus before it
+        * re-appears executing the recently uploaded firmware.
         */
        ret = SR_ERR;
        if (devc->fw_updated > 0) {
                sr_info("Waiting for device to reset after firmware upload.");
-               /* Takes >= 2000ms for the uC to be gone from the USB bus. */
-               reset_done = devc->fw_updated + 18 * (uint64_t)1e5; /* 1.8 seconds */
+               reset_done = devc->fw_updated;
+               reset_done += 1800 * 1000; /* 1.8 seconds */
                now = g_get_monotonic_time();
                if (reset_done > now)
                        g_usleep(reset_done - now);
@@ -373,7 +378,7 @@ static int dev_open(struct sr_dev_inst *sdi)
        }
 
        if (ret != SR_OK) {
-               sr_err("Unable to open device.");
+               sr_err("Cannot open device.");
                return SR_ERR;
        }
 
@@ -418,9 +423,11 @@ static int config_get(uint32_t key, GVariant **data,
                if (!sdi->conn)
                        return SR_ERR_ARG;
                usb = sdi->conn;
-               if (usb->address == 255) {
-                       /* Device still needs to re-enumerate after firmware
-                        * upload, so we don't know its (future) address. */
+               if (usb->address == 0xff) {
+                       /*
+                        * Device still needs to re-enumerate after firmware
+                        * upload, so we don't know its (future) address.
+                        */
                        return SR_ERR;
                }
                *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
@@ -540,191 +547,6 @@ static int config_list(uint32_t key, GVariant **data,
        return SR_OK;
 }
 
-static void send_chunk(struct sr_dev_inst *sdi,
-       const uint8_t *packets, unsigned int num_tfers)
-{
-       struct dev_context *devc;
-       struct sr_datafeed_logic logic;
-       struct sr_datafeed_packet sr_packet;
-       unsigned int max_samples, n_samples, total_samples, free_n_samples;
-       unsigned int i, j, k;
-       int do_signal_trigger;
-       uint16_t *wp;
-       const uint8_t *rp;
-       uint16_t state;
-       uint8_t repetitions;
-
-       devc = sdi->priv;
-
-       logic.unitsize = 2;
-       logic.data = devc->convbuffer;
-
-       sr_packet.type = SR_DF_LOGIC;
-       sr_packet.payload = &logic;
-
-       max_samples = devc->convbuffer_size / 2;
-       n_samples = 0;
-       wp = (uint16_t *)devc->convbuffer;
-       total_samples = 0;
-       do_signal_trigger = 0;
-
-       if (devc->had_triggers_configured && devc->reading_behind_trigger == 0 && devc->info.n_rep_packets_before_trigger == 0) {
-               std_session_send_df_trigger(sdi);
-               devc->reading_behind_trigger = 1;
-       }
-
-       rp = packets;
-       for (i = 0; i < num_tfers; i++) {
-               for (k = 0; k < NUM_PACKETS_IN_CHUNK; k++) {
-                       free_n_samples = max_samples - n_samples;
-                       if (free_n_samples < 256 || do_signal_trigger) {
-                               logic.length = n_samples * 2;
-                               sr_session_send(sdi, &sr_packet);
-                               n_samples = 0;
-                               wp = (uint16_t *)devc->convbuffer;
-                               if (do_signal_trigger) {
-                                       std_session_send_df_trigger(sdi);
-                                       do_signal_trigger = 0;
-                               }
-                       }
-
-                       state = read_u16le_inc(&rp);
-                       repetitions = read_u8_inc(&rp);
-                       for (j = 0; j < repetitions; j++)
-                               *wp++ = state;
-
-                       n_samples += repetitions;
-                       total_samples += repetitions;
-                       devc->total_samples += repetitions;
-                       if (!devc->reading_behind_trigger) {
-                               devc->n_reps_until_trigger--;
-                               if (devc->n_reps_until_trigger == 0) {
-                                       devc->reading_behind_trigger = 1;
-                                       do_signal_trigger = 1;
-                                       sr_dbg("  here is trigger position after %" PRIu64 " samples, %.6fms",
-                                              devc->total_samples,
-                                              (double)devc->total_samples / devc->cur_samplerate * 1e3);
-                               }
-                       }
-               }
-               (void)read_u8_inc(&rp); /* Skip sequence number. */
-       }
-       if (n_samples) {
-               logic.length = n_samples * 2;
-               sr_session_send(sdi, &sr_packet);
-               if (do_signal_trigger) {
-                       std_session_send_df_trigger(sdi);
-               }
-       }
-       sr_dbg("send_chunk done after %d samples", total_samples);
-}
-
-static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
-{
-       struct sr_dev_inst *sdi;
-       struct dev_context *devc;
-       struct sr_usb_dev_inst *usb;
-       int ret;
-
-       sdi = transfer->user_data;
-       devc = sdi->priv;
-       usb = sdi->conn;
-
-       sr_dbg("receive_transfer(): status %s received %d bytes.",
-              libusb_error_name(transfer->status), transfer->actual_length);
-
-       if (transfer->status == LIBUSB_TRANSFER_TIMED_OUT) {
-               sr_err("bulk transfer timeout!");
-               devc->transfer_finished = 1;
-       }
-       send_chunk(sdi, transfer->buffer, transfer->actual_length / TRANSFER_PACKET_LENGTH);
-
-       devc->n_bytes_to_read -= transfer->actual_length;
-       if (devc->n_bytes_to_read) {
-               uint32_t to_read = devc->n_bytes_to_read;
-               /* determine read size for the next usb transfer */
-               if (to_read >= LA2016_USB_BUFSZ)
-                       to_read = LA2016_USB_BUFSZ;
-               else /* last transfer, make read size some multiple of LA2016_EP6_PKTSZ */
-                       to_read = (to_read + (LA2016_EP6_PKTSZ-1)) & ~(LA2016_EP6_PKTSZ-1);
-               libusb_fill_bulk_transfer(
-                       transfer, usb->devhdl,
-                       0x86, transfer->buffer, to_read,
-                       receive_transfer, (void *)sdi, DEFAULT_TIMEOUT_MS);
-
-               if ((ret = libusb_submit_transfer(transfer)) == 0)
-                       return;
-               sr_err("Failed to submit further transfer: %s.", libusb_error_name(ret));
-       }
-
-       g_free(transfer->buffer);
-       libusb_free_transfer(transfer);
-       devc->transfer_finished = 1;
-}
-
-SR_PRIV int la2016_receive_data(int fd, int revents, void *cb_data)
-{
-       const struct sr_dev_inst *sdi;
-       struct dev_context *devc;
-       struct drv_context *drvc;
-       struct timeval tv;
-
-       (void)fd;
-       (void)revents;
-
-       sdi = cb_data;
-       devc = sdi->priv;
-       drvc = sdi->driver->context;
-
-       if (devc->have_trigger == 0) {
-               if (la2016_has_triggered(sdi) == 0) {
-                       /* not yet ready for download */
-                       return TRUE;
-               }
-               devc->have_trigger = 1;
-               devc->transfer_finished = 0;
-               devc->reading_behind_trigger = 0;
-               devc->total_samples = 0;
-               /* we can start retrieving data! */
-               if (la2016_start_retrieval(sdi, receive_transfer) != SR_OK) {
-                       sr_err("failed to start retrieval!");
-                       return FALSE;
-               }
-               sr_dbg("retrieval is started...");
-               std_session_send_df_frame_begin(sdi);
-
-               return TRUE;
-       }
-
-       tv.tv_sec = tv.tv_usec = 0;
-       libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
-
-       if (devc->transfer_finished) {
-               sr_dbg("transfer is finished!");
-               std_session_send_df_frame_end(sdi);
-
-               usb_source_remove(sdi->session, drvc->sr_ctx);
-               std_session_send_df_end(sdi);
-
-               la2016_stop_acquisition(sdi);
-
-               g_free(devc->convbuffer);
-               devc->convbuffer = NULL;
-
-               devc->transfer = NULL;
-
-               sr_dbg("transfer is now finished");
-       }
-
-       return TRUE;
-}
-
-static void abort_acquisition(struct dev_context *devc)
-{
-       if (devc->transfer)
-               libusb_cancel_transfer(devc->transfer);
-}
-
 static int configure_channels(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
@@ -756,13 +578,13 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        devc = sdi->priv;
 
        if (configure_channels(sdi) != SR_OK) {
-               sr_err("Failed to configure channels.");
+               sr_err("Cannot configure channels.");
                return SR_ERR;
        }
 
        devc->convbuffer_size = 4 * 1024 * 1024;
        if (!(devc->convbuffer = g_try_malloc(devc->convbuffer_size))) {
-               sr_err("Conversion buffer malloc failed.");
+               sr_err("Cannot allocate conversion buffer.");
                return SR_ERR_MALLOC;
        }
 
@@ -775,7 +597,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        devc->ctx = drvc->sr_ctx;
 
        if ((ret = la2016_start_acquisition(sdi)) != SR_OK) {
-               abort_acquisition(devc);
+               la2016_abort_acquisition(sdi);
                return ret;
        }
 
@@ -793,7 +615,6 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi)
        int ret;
 
        ret = la2016_abort_acquisition(sdi);
-       abort_acquisition(sdi->priv);
 
        return ret;
 }