]> sigrok.org Git - libsigrok.git/blobdiff - hardware/fx2lafw/fx2lafw.c
sr: Fix some TODOs, improve comments/docs.
[libsigrok.git] / hardware / fx2lafw / fx2lafw.c
index cc353a80f06d378a9df217df7c94d27a5534fb9b..d0834dedb870dcfb169456c4dce30c0a6cd7a79e 100644 (file)
 
 #include <stdio.h>
 #include <stdlib.h>
-#include <stdbool.h>
 #include <inttypes.h>
 #include <glib.h>
 #include <libusb.h>
-
 #include "config.h"
 #include "sigrok.h"
 #include "sigrok-internal.h"
@@ -42,7 +40,7 @@ static int fx2lafw_capabilities[] = {
        /* These are really implemented in the driver, not the hardware. */
        SR_HWCAP_LIMIT_SAMPLES,
        SR_HWCAP_CONTINUOUS,
-       0
+       0,
 };
 
 static const char *fx2lafw_probe_names[] = {
@@ -54,7 +52,7 @@ static const char *fx2lafw_probe_names[] = {
        "D5",
        "D6",
        "D7",
-       NULL
+       NULL,
 };
 
 static uint64_t fx2lafw_supported_samplerates[] = {
@@ -66,33 +64,33 @@ static uint64_t fx2lafw_supported_samplerates[] = {
        SR_MHZ(8),
        SR_MHZ(12),
        SR_MHZ(16),
-       SR_MHZ(24)
+       SR_MHZ(24),
 };
 
 static struct sr_samplerates fx2lafw_samplerates = {
        SR_MHZ(1),
        SR_MHZ(24),
        SR_HZ(0),
-       fx2lafw_supported_samplerates
+       fx2lafw_supported_samplerates,
 };
 
 static GSList *dev_insts = NULL;
 static libusb_context *usb_context = NULL;
 
-static int hw_dev_acquisition_stop(int dev_index, gpointer session_dev_id);
+static int hw_dev_acquisition_stop(int dev_index, void *session_dev_id);
 
 /**
  * Check the USB configuration to determine if this is an fx2lafw device.
  *
- * @return true if the device's configuration profile match fx2lafw
- *         configuration, flase otherwise.
+ * @return TRUE if the device's configuration profile match fx2lafw
+ *         configuration, FALSE otherwise.
  */
-static bool check_conf_profile(libusb_device *dev)
+static gboolean check_conf_profile(libusb_device *dev)
 {
        struct libusb_device_descriptor des;
        struct libusb_config_descriptor *conf_dsc = NULL;
        const struct libusb_interface_descriptor *intf_dsc;
-       bool ret = false;
+       gboolean ret = FALSE;
 
        while (!ret) {
                /* Assume it's not a Saleae Logic unless proven wrong. */
@@ -134,7 +132,7 @@ static bool check_conf_profile(libusb_device *dev)
                /* TODO: Check the debug channel... */
 
                /* If we made it here, it must be an fx2lafw. */
-               ret = true;
+               ret = TRUE;
        }
 
        if (conf_dsc)
@@ -148,7 +146,7 @@ static int fx2lafw_open_dev(int dev_index)
        libusb_device **devlist;
        struct libusb_device_descriptor des;
        struct sr_dev_inst *sdi;
-       struct fx2lafw_device *ctx;
+       struct context *ctx;
        int err, skip, i;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
@@ -217,7 +215,7 @@ static int fx2lafw_open_dev(int dev_index)
 
 static void close_dev(struct sr_dev_inst *sdi)
 {
-       struct fx2lafw_device *ctx;
+       struct context *ctx;
 
        ctx = sdi->priv;
 
@@ -232,16 +230,16 @@ static void close_dev(struct sr_dev_inst *sdi)
        sdi->status = SR_ST_INACTIVE;
 }
 
-static struct fx2lafw_device* fx2lafw_device_new(void)
+static struct context *fx2lafw_device_new(void)
 {
-       struct fx2lafw_device *fx2lafw;
+       struct context *ctx;
 
-       if (!(fx2lafw = g_try_malloc0(sizeof(struct fx2lafw_device)))) {
-               sr_err("fx2lafw: %s: fx2lafw_device malloc failed", __func__);
+       if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
+               sr_err("fx2lafw: %s: ctx malloc failed", __func__);
                return NULL;
        }
 
-       return fx2lafw;
+       return ctx;
 }
 
 /*
@@ -253,7 +251,7 @@ static int hw_init(const char *deviceinfo)
        struct sr_dev_inst *sdi;
        struct libusb_device_descriptor des;
        struct fx2lafw_profile *fx2lafw_prof;
-       struct fx2lafw_device *ctx;
+       struct context *ctx;
        libusb_device **devlist;
        int err;
        int devcnt = 0;
@@ -298,7 +296,7 @@ static int hw_init(const char *deviceinfo)
                ctx = fx2lafw_device_new();
                ctx->profile = fx2lafw_prof;
                sdi->priv = ctx;
-               device_instances = g_slist_append(dev_insts, sdi);
+               dev_insts = g_slist_append(dev_insts, sdi);
 
                if (check_conf_profile(devlist[i])) {
                        /* Already has the firmware, so fix the new address. */
@@ -325,14 +323,14 @@ static int hw_init(const char *deviceinfo)
        return devcnt;
 }
 
-static int hw_dev_open(int device_index)
+static int hw_dev_open(int dev_index)
 {
        GTimeVal cur_time;
        struct sr_dev_inst *sdi;
-       struct fx2lafw_device *ctx;
+       struct context *ctx;
        int timediff, err;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, device_index)))
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ERR;
        ctx = sdi->priv;
 
@@ -347,7 +345,7 @@ static int hw_dev_open(int device_index)
                g_usleep(300 * 1000);
                timediff = 0;
                while (timediff < MAX_RENUM_DELAY) {
-                       if ((err = fx2lafw_open_dev(device_index)) == SR_OK)
+                       if ((err = fx2lafw_open_dev(dev_index)) == SR_OK)
                                break;
                        g_usleep(100 * 1000);
                        g_get_current_time(&cur_time);
@@ -355,7 +353,7 @@ static int hw_dev_open(int device_index)
                }
                sr_info("fx2lafw: device came back after %d ms", timediff);
        } else {
-               err = fx2lafw_open_dev(device_index);
+               err = fx2lafw_open_dev(dev_index);
        }
 
        if (err != SR_OK) {
@@ -379,7 +377,7 @@ static int hw_dev_close(int dev_index)
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
                sr_err("fx2lafw: %s: sdi was NULL", __func__);
-               return SR_ERR; /* TODO: SR_ERR_ARG? */
+               return SR_ERR_BUG;
        }
 
        /* TODO */
@@ -392,7 +390,7 @@ static int hw_cleanup(void)
 {
        GSList *l;
        struct sr_dev_inst *sdi;
-       struct fx2lafw_device *ctx;
+       struct context *ctx;
        int ret = SR_OK;
 
        for(l = dev_insts; l; l = l->next) {
@@ -424,16 +422,16 @@ static int hw_cleanup(void)
        return ret;
 }
 
-static void *hw_dev_info_get(int device_index, int device_info_id)
+static void *hw_dev_info_get(int dev_index, int dev_info_id)
 {
        struct sr_dev_inst *sdi;
-       struct fx2lafw_device *ctx;
+       struct context *ctx;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, device_index)))
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return NULL;
        ctx = sdi->priv;
 
-       switch (device_info_id) {
+       switch (dev_info_id) {
        case SR_DI_INST:
                return sdi;
        case SR_DI_NUM_PROBES:
@@ -449,10 +447,10 @@ static void *hw_dev_info_get(int device_index, int device_info_id)
        return NULL;
 }
 
-static int hw_dev_status_get(int device_index)
+static int hw_dev_status_get(int dev_index)
 {
        const struct sr_dev_inst *const sdi =
-               sr_dev_inst_get(dev_insts, device_index);
+               sr_dev_inst_get(dev_insts, dev_index);
 
        if (!sdi)
                return SR_ST_NOT_FOUND;
@@ -468,7 +466,7 @@ static int *hw_hwcap_get_all(void)
 static int hw_dev_config_set(int dev_index, int hwcap, void *value)
 {
        struct sr_dev_inst *sdi;
-       struct fx2lafw_device *ctx;
+       struct context *ctx;
        int ret;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
@@ -485,14 +483,14 @@ static int hw_dev_config_set(int dev_index, int hwcap, void *value)
        return ret;
 }
 
-static int receive_data(int fd, int revents, void *user_data)
+static int receive_data(int fd, int revents, void *cb_data)
 {
        struct timeval tv;
 
        /* Avoid compiler warnings. */
        (void)fd;
        (void)revents;
-       (void)user_data;
+       (void)cb_data;
 
        tv.tv_sec = tv.tv_usec = 0;
        libusb_handle_events_timeout(usb_context, &tv);
@@ -507,7 +505,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
        static int empty_transfer_count = 0;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_logic logic;
-       struct fx2lafw_device *ctx;
+       struct context *ctx;
        int cur_buflen;
        unsigned char *cur_buf, *new_buf;
 
@@ -554,7 +552,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
                         * The FX2 gave up. End the acquisition, the frontend
                         * will work out that the samplecount is short.
                         */
-                       hw_dev_acquisition_stop(-1, ctx->session_data);
+                       hw_dev_acquisition_stop(-1, ctx->session_dev_id);
                }
                return;
        } else {
@@ -567,22 +565,22 @@ static void receive_transfer(struct libusb_transfer *transfer)
        logic.length = cur_buflen;
        logic.unitsize = 1;
        logic.data = cur_buf;
-       sr_session_bus(ctx->session_data, &packet);
+       sr_session_send(ctx->session_dev_id, &packet);
        g_free(cur_buf);
 
        num_samples += cur_buflen;
        if (ctx->limit_samples &&
                (unsigned int) num_samples > ctx->limit_samples) {
-               hw_dev_acquisition_stop(-1, ctx->session_data);
+               hw_dev_acquisition_stop(-1, ctx->session_dev_id);
        }
 }
 
-static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
+static int hw_dev_acquisition_start(int dev_index, void *cb_data)
 {
        struct sr_dev_inst *sdi;
        struct sr_datafeed_packet *packet;
        struct sr_datafeed_header *header;
-       struct fx2lafw_device *ctx;
+       struct context *ctx;
        struct libusb_transfer *transfer;
        const struct libusb_pollfd **lupfd;
        int size, i;
@@ -591,7 +589,7 @@ static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ERR;
        ctx = sdi->priv;
-       ctx->session_data = session_data;
+       ctx->session_dev_id = cb_data;
 
        if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
                sr_err("fx2lafw: %s: packet malloc failed", __func__);
@@ -635,22 +633,32 @@ static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
        gettimeofday(&header->starttime, NULL);
        header->samplerate = 24000000UL;
        header->num_logic_probes = ctx->profile->num_probes;
-       sr_session_bus(session_data, packet);
+       sr_session_send(session_dev_id, packet);
        g_free(header);
        g_free(packet);
 
        return SR_OK;
 }
 
-/* This stops acquisition on ALL devices, ignoring device_index. */
-static int hw_dev_acquisition_stop(int dev_index, gpointer session_data)
+/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
+static int hw_dev_acquisition_stop(int dev_index, void *session_dev_id)
 {
+       struct sr_datafeed_packet packet;
+
+       /* Avoid compiler warnings. */
        (void)dev_index;
-       (void)session_data;
+
+       packet.type = SR_DF_END;
+       sr_session_send(session_dev_id, &packet);
+
+       receive_transfer(NULL);
+
+       /* TODO: Need to cancel and free any queued up transfers. */
+
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_plugin fx2lafw_plugin_info = {
+SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
        .name = "fx2lafw",
        .longname = "fx2lafw",
        .api_version = 1,