]> sigrok.org Git - libsigrok.git/blobdiff - hardware/chronovu-la8/chronovu-la8.c
sr/cli/gtk/qt: s/device/dev/ in many places.
[libsigrok.git] / hardware / chronovu-la8 / chronovu-la8.c
index 4560d69f47ed68f9539bb0a1892aad7722218da5..44ec79d4fc0ab71abdd6dafab389d1afe8aeae1a 100644 (file)
@@ -21,6 +21,7 @@
 #include <ftdi.h>
 #include <glib.h>
 #include <string.h>
+#include <stdlib.h>
 #include "sigrok.h"
 #include "sigrok-internal.h"
 
@@ -39,7 +40,7 @@
 #define BS                             4096 /* Block size */
 #define NUM_BLOCKS                     2048 /* Number of blocks */
 
-static GSList *device_instances = NULL;
+static GSList *dev_insts = NULL;
 
 static const char *probe_names[NUM_PROBES + 1] = {
        "0",
@@ -110,7 +111,7 @@ struct la8 {
        uint8_t divcount;
 };
 
-/* This will be initialized via hw_get_device_info()/SR_DI_SAMPLERATES. */
+/* This will be initialized via hw_get_dev_info()/SR_DI_SAMPLERATES. */
 static uint64_t supported_samplerates[255 + 1] = { 0 };
 
 /*
@@ -135,7 +136,7 @@ static int capabilities[] = {
 
 /* Function prototypes. */
 static int la8_close_usb_reset_sequencer(struct la8 *la8);
-static void hw_stop_acquisition(int device_index, gpointer session_data);
+static int hw_stop_acquisition(int dev_index, gpointer session_data);
 static int la8_reset(struct la8 *la8);
 
 static void fill_supported_samplerates_if_needed(void)
@@ -169,8 +170,8 @@ static int is_valid_samplerate(uint64_t samplerate)
                        return 1;
        }
 
-       sr_warn("la8: %s: invalid samplerate (%" PRIu64 "Hz)",
-               __func__, samplerate);
+       sr_err("la8: %s: invalid samplerate (%" PRIu64 "Hz)",
+              __func__, samplerate);
 
        return 0;
 }
@@ -236,12 +237,12 @@ static int la8_write(struct la8 *la8, uint8_t *buf, int size)
        bytes_written = ftdi_write_data(la8->ftdic, buf, size);
 
        if (bytes_written < 0) {
-               sr_warn("la8: %s: ftdi_write_data: (%d) %s", __func__,
-                       bytes_written, ftdi_get_error_string(la8->ftdic));
+               sr_err("la8: %s: ftdi_write_data: (%d) %s", __func__,
+                      bytes_written, ftdi_get_error_string(la8->ftdic));
                (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
        } else if (bytes_written != size) {
-               sr_warn("la8: %s: bytes to write: %d, bytes written: %d",
-                       __func__, size, bytes_written);
+               sr_err("la8: %s: bytes to write: %d, bytes written: %d",
+                      __func__, size, bytes_written);
                (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
        }
 
@@ -283,11 +284,11 @@ static int la8_read(struct la8 *la8, uint8_t *buf, int size)
        bytes_read = ftdi_read_data(la8->ftdic, buf, size);
 
        if (bytes_read < 0) {
-               sr_warn("la8: %s: ftdi_read_data: (%d) %s", __func__,
-                       bytes_read, ftdi_get_error_string(la8->ftdic));
+               sr_err("la8: %s: ftdi_read_data: (%d) %s", __func__,
+                      bytes_read, ftdi_get_error_string(la8->ftdic));
        } else if (bytes_read != size) {
-               // sr_warn("la8: %s: bytes to read: %d, bytes read: %d",
-               //      __func__, size, bytes_read);
+               // sr_err("la8: %s: bytes to read: %d, bytes read: %d",
+               //        __func__, size, bytes_read);
        }
 
        return bytes_read;
@@ -308,8 +309,8 @@ static int la8_close(struct la8 *la8)
        }
 
        if ((ret = ftdi_usb_close(la8->ftdic)) < 0) {
-               sr_warn("la8: %s: ftdi_usb_close: (%d) %s",
-                       __func__, ret, ftdi_get_error_string(la8->ftdic));
+               sr_err("la8: %s: ftdi_usb_close: (%d) %s",
+                      __func__, ret, ftdi_get_error_string(la8->ftdic));
        }
 
        return ret;
@@ -327,8 +328,6 @@ static int la8_close_usb_reset_sequencer(struct la8 *la8)
        uint8_t buf[8] = {0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01};
        int ret;
 
-       sr_spew("la8: entering %s", __func__);
-
        if (!la8) {
                sr_err("la8: %s: la8 was NULL", __func__);
                return SR_ERR_ARG;
@@ -350,16 +349,14 @@ static int la8_close_usb_reset_sequencer(struct la8 *la8)
 
                /* Log errors, but ignore them (i.e., don't abort). */
                if ((ret = ftdi_usb_purge_buffers(la8->ftdic)) < 0)
-                       sr_warn("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
+                       sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
                            __func__, ret, ftdi_get_error_string(la8->ftdic));
                if ((ret = ftdi_usb_reset(la8->ftdic)) < 0)
-                       sr_warn("la8: %s: ftdi_usb_reset: (%d) %s", __func__,
-                               ret, ftdi_get_error_string(la8->ftdic));
+                       sr_err("la8: %s: ftdi_usb_reset: (%d) %s", __func__,
+                              ret, ftdi_get_error_string(la8->ftdic));
                if ((ret = ftdi_usb_close(la8->ftdic)) < 0)
-                       sr_warn("la8: %s: ftdi_usb_close: (%d) %s", __func__,
-                               ret, ftdi_get_error_string(la8->ftdic));
-       } else {
-               sr_spew("la8: %s: usb_dev was NULL, nothing to do", __func__);
+                       sr_err("la8: %s: ftdi_usb_close: (%d) %s", __func__,
+                              ret, ftdi_get_error_string(la8->ftdic));
        }
 
        ftdi_free(la8->ftdic); /* Returns void. */
@@ -470,16 +467,14 @@ static int configure_probes(struct la8 *la8, GSList *probes)
        return SR_OK;
 }
 
-static int hw_init(const char *deviceinfo)
+static int hw_init(const char *devinfo)
 {
        int ret;
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        struct la8 *la8;
 
-       sr_spew("la8: entering %s", __func__);
-
        /* Avoid compiler errors. */
-       (void)deviceinfo;
+       (void)devinfo;
 
        /* Allocate memory for our private driver context. */
        if (!(la8 = g_try_malloc(sizeof(struct la8)))) {
@@ -518,24 +513,22 @@ static int hw_init(const char *deviceinfo)
        /* Check for the device and temporarily open it. */
        if ((ret = ftdi_usb_open_desc(la8->ftdic, USB_VENDOR_ID,
                        USB_PRODUCT_ID, USB_DESCRIPTION, NULL)) < 0) {
-               sr_dbg("la8: %s: ftdi_usb_open_desc: (%d) %s",
-                      __func__, ret, ftdi_get_error_string(la8->ftdic));
                (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
                goto err_free_ftdic;
        }
        sr_dbg("la8: found device");
 
        /* Register the device with libsigrok. */
-       sdi = sr_device_instance_new(0, SR_ST_INITIALIZING,
+       sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
                        USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
        if (!sdi) {
-               sr_err("la8: %s: sr_device_instance_new failed", __func__);
+               sr_err("la8: %s: sr_dev_inst_new failed", __func__);
                goto err_close_ftdic;
        }
 
        sdi->priv = la8;
 
-       device_instances = g_slist_append(device_instances, sdi);
+       dev_insts = g_slist_append(dev_insts, sdi);
 
        sr_spew("la8: %s finished successfully", __func__);
 
@@ -557,13 +550,13 @@ err_free_nothing:
        return 0;
 }
 
-static int hw_opendev(int device_index)
+static int hw_opendev(int dev_index)
 {
        int ret;
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        struct la8 *la8;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
                sr_err("la8: %s: sdi was NULL", __func__);
                return SR_ERR; /* TODO: SR_ERR_ARG? */
        }
@@ -615,7 +608,7 @@ err_opendev_close_ftdic:
        return SR_ERR;
 }
 
-static int set_samplerate(struct sr_device_instance *sdi, uint64_t samplerate)
+static int set_samplerate(struct sr_dev_inst *sdi, uint64_t samplerate)
 {
        struct la8 *la8;
 
@@ -645,12 +638,12 @@ static int set_samplerate(struct sr_device_instance *sdi, uint64_t samplerate)
        return SR_OK;
 }
 
-static int hw_closedev(int device_index)
+static int hw_closedev(int dev_index)
 {
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        struct la8 *la8;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
                sr_err("la8: %s: sdi was NULL", __func__);
                return SR_ERR; /* TODO: SR_ERR_ARG? */
        }
@@ -678,45 +671,37 @@ static int hw_closedev(int device_index)
        return SR_OK;
 }
 
-static void hw_cleanup(void)
+static int hw_cleanup(void)
 {
        GSList *l;
-       struct sr_device_instance *sdi;
-
-       sr_spew("la8: entering %s", __func__);
+       struct sr_dev_inst *sdi;
+       int ret = SR_OK;
 
        /* Properly close all devices. */
-       for (l = device_instances; l; l = l->next) {
-               if ((sdi = l->data) == NULL) {
-                       sr_warn("la8: %s: sdi was NULL, continuing", __func__);
+       for (l = dev_insts; l; l = l->next) {
+               if (!(sdi = l->data)) {
+                       /* Log error, but continue cleaning up the rest. */
+                       sr_err("la8: %s: sdi was NULL, continuing", __func__);
+                       ret = SR_ERR_BUG;
                        continue;
                }
-#if 0
-               /*
-                * Fixes a segfault as it's free()d elsewhere already.
-                * TODO: Document who is supposed to free this, and when.
-                */
-               if (sdi->priv != NULL)
-                       free(sdi->priv);
-               else
-                       sr_warn("la8: %s: sdi->priv was NULL, nothing "
-                               "to do", __func__);
-#endif
-               sr_device_instance_free(sdi); /* Returns void. */
-       }
-       g_slist_free(device_instances); /* Returns void. */
-       device_instances = NULL;
+               sr_dev_inst_free(sdi); /* Returns void. */
+       }
+       g_slist_free(dev_insts); /* Returns void. */
+       dev_insts = NULL;
+
+       return ret;
 }
 
-static void *hw_get_device_info(int device_index, int device_info_id)
+static void *hw_get_dev_info(int dev_index, int dev_info_id)
 {
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        struct la8 *la8;
        void *info;
 
        sr_spew("la8: entering %s", __func__);
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
                sr_err("la8: %s: sdi was NULL", __func__);
                return NULL;
        }
@@ -726,7 +711,7 @@ static void *hw_get_device_info(int device_index, int device_info_id)
                return NULL;
        }
 
-       switch (device_info_id) {
+       switch (dev_info_id) {
        case SR_DI_INSTANCE:
                info = sdi;
                break;
@@ -756,12 +741,12 @@ static void *hw_get_device_info(int device_index, int device_info_id)
        return info;
 }
 
-static int hw_get_status(int device_index)
+static int hw_get_status(int dev_index)
 {
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
-               sr_warn("la8: %s: sdi was NULL, device not found", __func__);
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
+               sr_err("la8: %s: sdi was NULL, device not found", __func__);
                return SR_ST_NOT_FOUND;
        }
 
@@ -777,14 +762,14 @@ static int *hw_get_capabilities(void)
        return capabilities;
 }
 
-static int hw_set_configuration(int device_index, int capability, void *value)
+static int hw_set_configuration(int dev_index, int capability, void *value)
 {
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        struct la8 *la8;
 
        sr_spew("la8: entering %s", __func__);
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
                sr_err("la8: %s: sdi was NULL", __func__);
                return SR_ERR; /* TODO: SR_ERR_ARG? */
        }
@@ -869,7 +854,7 @@ static int la8_read_block(struct la8 *la8)
 
        /* Check if block read was successful or a timeout occured. */
        if (bytes_read != BS) {
-               sr_warn("la8: %s: trigger timed out", __func__);
+               sr_err("la8: %s: trigger timed out", __func__);
                (void) la8_reset(la8); /* Ignore errors. */
                return SR_ERR;
        }
@@ -985,7 +970,7 @@ static void send_block_to_session_bus(struct la8 *la8, int block)
 static int receive_data(int fd, int revents, void *session_data)
 {
        int i, ret;
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        struct la8 *la8;
 
        /* Avoid compiler errors. */
@@ -1027,9 +1012,9 @@ static int receive_data(int fd, int revents, void *session_data)
        return TRUE;
 }
 
-static int hw_start_acquisition(int device_index, gpointer session_data)
+static int hw_start_acquisition(int dev_index, gpointer session_data)
 {
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        struct la8 *la8;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_header header;
@@ -1038,7 +1023,7 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
 
        sr_spew("la8: entering %s", __func__);
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
                sr_err("la8: %s: sdi was NULL", __func__);
                return SR_ERR; /* TODO: SR_ERR_ARG? */
        }
@@ -1102,31 +1087,33 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
        return SR_OK;
 }
 
-static void hw_stop_acquisition(int device_index, gpointer session_data)
+static int hw_stop_acquisition(int dev_index, gpointer session_data)
 {
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        struct la8 *la8;
        struct sr_datafeed_packet packet;
 
        sr_dbg("la8: stopping acquisition");
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
                sr_err("la8: %s: sdi was NULL", __func__);
-               return;
+               return SR_ERR_BUG;
        }
 
        if (!(la8 = sdi->priv)) {
                sr_err("la8: %s: sdi->priv was NULL", __func__);
-               return;
+               return SR_ERR_BUG;
        }
 
        /* Send end packet to the session bus. */
        sr_dbg("la8: %s: sending SR_DF_END", __func__);
        packet.type = SR_DF_END;
        sr_session_bus(session_data, &packet);
+
+       return SR_OK;
 }
 
-SR_PRIV struct sr_device_plugin chronovu_la8_plugin_info = {
+SR_PRIV struct sr_dev_plugin chronovu_la8_plugin_info = {
        .name = "chronovu-la8",
        .longname = "ChronoVu LA8",
        .api_version = 1,
@@ -1134,7 +1121,7 @@ SR_PRIV struct sr_device_plugin chronovu_la8_plugin_info = {
        .cleanup = hw_cleanup,
        .opendev = hw_opendev,
        .closedev = hw_closedev,
-       .get_device_info = hw_get_device_info,
+       .get_dev_info = hw_get_dev_info,
        .get_status = hw_get_status,
        .get_capabilities = hw_get_capabilities,
        .set_configuration = hw_set_configuration,