]> sigrok.org Git - libsigrok.git/blobdiff - hardware/asix-sigma/asix-sigma.c
sr: Prefix log messages with subsystem string.
[libsigrok.git] / hardware / asix-sigma / asix-sigma.c
index e7d6f7833103bd608a4a29344bbec7ec2ad9f4ea..d2a7b6e857f2835a8f058c12ca0e4fd3fa77a617 100644 (file)
  * ASIX SIGMA Logic Analyzer Driver
  */
 
-#include "config.h"
 #include <glib.h>
 #include <glib/gstdio.h>
 #include <ftdi.h>
 #include <string.h>
 #include <zlib.h>
-#include <sigrok.h>
-#include <sigrok-internal.h>
+#include "sigrok.h"
+#include "sigrok-internal.h"
 #include "asix-sigma.h"
 
 #define USB_VENDOR                     0xa600
@@ -40,6 +39,7 @@
 #define USB_MODEL_NAME                 "SIGMA"
 #define USB_MODEL_VERSION              ""
 #define TRIGGER_TYPES                  "rf10"
+#define NUM_PROBES                     16
 
 static GSList *device_instances = NULL;
 
@@ -57,6 +57,26 @@ static uint64_t supported_samplerates[] = {
        0,
 };
 
+static const char *probe_names[NUM_PROBES + 1] = {
+       "0",
+       "1",
+       "2",
+       "3",
+       "4",
+       "5",
+       "6",
+       "7",
+       "8",
+       "9",
+       "10",
+       "11",
+       "12",
+       "13",
+       "14",
+       "15",
+       NULL,
+};
+
 static struct sr_samplerates samplerates = {
        SR_KHZ(200),
        SR_MHZ(200),
@@ -98,7 +118,7 @@ static const char *firmware_files[] = {
        "asix-sigma-phasor.fw", /* Frequency counter */
 };
 
-static void hw_stop_acquisition(int device_index, gpointer session_data);
+static int hw_stop_acquisition(int device_index, gpointer session_data);
 
 static int sigma_read(void *buf, size_t size, struct sigma *sigma)
 {
@@ -106,8 +126,8 @@ static int sigma_read(void *buf, size_t size, struct sigma *sigma)
 
        ret = ftdi_read_data(&sigma->ftdic, (unsigned char *)buf, size);
        if (ret < 0) {
-               sr_warn("ftdi_read_data failed: %s",
-                       ftdi_get_error_string(&sigma->ftdic));
+               sr_err("sigma: ftdi_read_data failed: %s",
+                      ftdi_get_error_string(&sigma->ftdic));
        }
 
        return ret;
@@ -119,10 +139,10 @@ static int sigma_write(void *buf, size_t size, struct sigma *sigma)
 
        ret = ftdi_write_data(&sigma->ftdic, (unsigned char *)buf, size);
        if (ret < 0) {
-               sr_warn("ftdi_write_data failed: %s",
-                       ftdi_get_error_string(&sigma->ftdic));
+               sr_err("sigma: ftdi_write_data failed: %s",
+                      ftdi_get_error_string(&sigma->ftdic));
        } else if ((size_t) ret != size) {
-               sr_warn("ftdi_write_data did not complete write\n");
+               sr_err("sigma: ftdi_write_data did not complete write\n");
        }
 
        return ret;
@@ -170,7 +190,7 @@ static uint8_t sigma_get_register(uint8_t reg, struct sigma *sigma)
        uint8_t value;
 
        if (1 != sigma_read_register(reg, &value, 1, sigma)) {
-               sr_warn("sigma_get_register: 1 byte expected");
+               sr_err("sigma: sigma_get_register: 1 byte expected");
                return 0;
        }
 
@@ -317,12 +337,12 @@ static int bin2bitbang(const char *filename,
 
        f = g_fopen(filename, "rb");
        if (!f) {
-               sr_warn("g_fopen(\"%s\", \"rb\")", filename);
+               sr_err("sigma: g_fopen(\"%s\", \"rb\")", filename);
                return SR_ERR;
        }
 
        if (-1 == fseek(f, 0, SEEK_END)) {
-               sr_warn("fseek on %s failed", filename);
+               sr_err("sigma: fseek on %s failed", filename);
                fclose(f);
                return SR_ERR;
        }
@@ -356,7 +376,8 @@ static int bin2bitbang(const char *filename,
        if (ret < 0) {
                g_free(compressed_buf);
                g_free(firmware);
-               sr_warn("Could not unpack Sigma firmware. (Error %d)\n", ret);
+               sr_err("sigma: Could not unpack Sigma firmware. "
+                      "(Error %d)\n", ret);
                return SR_ERR;
        }
 
@@ -384,9 +405,9 @@ static int bin2bitbang(const char *filename,
 
        if (offset != *buf_size) {
                g_free(*buf);
-               sr_warn("Error reading firmware %s "
-                       "offset=%ld, file_size=%ld, buf_size=%zd\n",
-                       filename, offset, file_size, *buf_size);
+               sr_err("sigma: Error reading firmware %s "
+                      "offset=%ld, file_size=%ld, buf_size=%zd\n",
+                      filename, offset, file_size, *buf_size);
 
                return SR_ERR;
        }
@@ -400,7 +421,7 @@ static int hw_init(const char *deviceinfo)
        struct sigma *sigma;
 
        /* Avoid compiler warnings. */
-       deviceinfo = deviceinfo;
+       (void)deviceinfo;
 
        if (!(sigma = g_try_malloc(sizeof(struct sigma)))) {
                sr_err("sigma: %s: sigma malloc failed", __func__);
@@ -424,7 +445,7 @@ static int hw_init(const char *deviceinfo)
        sigma->use_triggers = 0;
 
        /* Register SIGMA device. */
-       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)
                goto free;
@@ -454,21 +475,21 @@ static int upload_firmware(int firmware_idx, struct sigma *sigma)
        /* Make sure it's an ASIX SIGMA. */
        if ((ret = ftdi_usb_open_desc(&sigma->ftdic,
                USB_VENDOR, USB_PRODUCT, USB_DESCRIPTION, NULL)) < 0) {
-               sr_warn("ftdi_usb_open failed: %s",
-                       ftdi_get_error_string(&sigma->ftdic));
+               sr_err("sigma: ftdi_usb_open failed: %s",
+                      ftdi_get_error_string(&sigma->ftdic));
                return 0;
        }
 
        if ((ret = ftdi_set_bitmode(&sigma->ftdic, 0xdf, BITMODE_BITBANG)) < 0) {
-               sr_warn("ftdi_set_bitmode failed: %s",
-                       ftdi_get_error_string(&sigma->ftdic));
+               sr_err("sigma: ftdi_set_bitmode failed: %s",
+                      ftdi_get_error_string(&sigma->ftdic));
                return 0;
        }
 
        /* Four times the speed of sigmalogan - Works well. */
        if ((ret = ftdi_set_baudrate(&sigma->ftdic, 750000)) < 0) {
-               sr_warn("ftdi_set_baudrate failed: %s",
-                       ftdi_get_error_string(&sigma->ftdic));
+               sr_err("sigma: ftdi_set_baudrate failed: %s",
+                      ftdi_get_error_string(&sigma->ftdic));
                return 0;
        }
 
@@ -495,8 +516,8 @@ static int upload_firmware(int firmware_idx, struct sigma *sigma)
                 firmware_files[firmware_idx]);
 
        if ((ret = bin2bitbang(firmware_path, &buf, &buf_size)) != SR_OK) {
-               sr_warn("An error occured while reading the firmware: %s",
-                       firmware_path);
+               sr_err("sigma: An error occured while reading the firmware: %s",
+                      firmware_path);
                return ret;
        }
 
@@ -506,8 +527,8 @@ static int upload_firmware(int firmware_idx, struct sigma *sigma)
        g_free(buf);
 
        if ((ret = ftdi_set_bitmode(&sigma->ftdic, 0x00, BITMODE_RESET)) < 0) {
-               sr_warn("ftdi_set_bitmode failed: %s",
-                       ftdi_get_error_string(&sigma->ftdic));
+               sr_err("sigma: ftdi_set_bitmode failed: %s",
+                      ftdi_get_error_string(&sigma->ftdic));
                return SR_ERR;
        }
 
@@ -524,7 +545,7 @@ static int upload_firmware(int firmware_idx, struct sigma *sigma)
        ret = sigma_read(result, 3, sigma);
        if (ret != 3 ||
            result[0] != 0xa6 || result[1] != 0x55 || result[2] != 0xaa) {
-               sr_warn("Configuration failed. Invalid reply received.");
+               sr_err("sigma: Configuration failed. Invalid reply received.");
                return SR_ERR;
        }
 
@@ -539,7 +560,7 @@ static int hw_opendev(int device_index)
        struct sigma *sigma;
        int ret;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
                return SR_ERR;
 
        sigma = sdi->priv;
@@ -548,8 +569,8 @@ static int hw_opendev(int device_index)
        if ((ret = ftdi_usb_open_desc(&sigma->ftdic,
                USB_VENDOR, USB_PRODUCT, USB_DESCRIPTION, NULL)) < 0) {
 
-               sr_warn("ftdi_usb_open failed: %s",
-                       ftdi_get_error_string(&sigma->ftdic));
+               sr_err("sigma: ftdi_usb_open failed: %s",
+                      ftdi_get_error_string(&sigma->ftdic));
 
                return 0;
        }
@@ -590,7 +611,7 @@ static int set_samplerate(struct sr_device_instance *sdi,
        sigma->samples_per_event = 16 / sigma->num_probes;
        sigma->state.state = SIGMA_IDLE;
 
-       sr_info("Firmware uploaded");
+       sr_info("sigma: Firmware uploaded");
 
        return ret;
 }
@@ -623,8 +644,8 @@ static int configure_probes(struct sr_device_instance *sdi, GSList *probes)
                if (sigma->cur_samplerate >= SR_MHZ(100)) {
                        /* Fast trigger support. */
                        if (trigger_set) {
-                               sr_warn("ASIX SIGMA only supports a single "
-                                       "pin trigger in 100 and 200MHz mode.");
+                               sr_err("sigma: ASIX SIGMA only supports a single "
+                                      "pin trigger in 100 and 200MHz mode.");
                                return SR_ERR;
                        }
                        if (probe->trigger[0] == 'f')
@@ -632,9 +653,9 @@ static int configure_probes(struct sr_device_instance *sdi, GSList *probes)
                        else if (probe->trigger[0] == 'r')
                                sigma->trigger.risingmask |= probebit;
                        else {
-                               sr_warn("ASIX SIGMA only supports "
-                                       "rising/falling trigger in 100 "
-                                       "and 200MHz mode.");
+                               sr_err("sigma: ASIX SIGMA only supports "
+                                      "rising/falling trigger in 100 "
+                                      "and 200MHz mode.");
                                return SR_ERR;
                        }
 
@@ -664,8 +685,8 @@ static int configure_probes(struct sr_device_instance *sdi, GSList *probes)
                          * does not permit ORed triggers.
                          */
                        if (trigger_set > 1) {
-                               sr_warn("ASIX SIGMA only supports 1 rising/"
-                                       "falling triggers.");
+                               sr_err("sigma: ASIX SIGMA only supports 1 "
+                                      "rising/falling triggers.");
                                return SR_ERR;
                        }
                }
@@ -682,7 +703,7 @@ static int hw_closedev(int device_index)
        struct sr_device_instance *sdi;
        struct sigma *sigma;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
                sr_err("sigma: %s: sdi was NULL", __func__);
                return SR_ERR; /* TODO: SR_ERR_ARG? */
        }
@@ -701,20 +722,26 @@ 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;
+       int ret = SR_OK;
 
        /* Properly close all devices. */
        for (l = device_instances; l; l = l->next) {
-               sdi = l->data;
-               if (sdi->priv != NULL)
-                       free(sdi->priv);
-               sr_device_instance_free(sdi);
+               if (!(sdi = l->data)) {
+                       /* Log error, but continue cleaning up the rest. */
+                       sr_err("sigma: %s: sdi was NULL, continuing", __func__);
+                       ret = SR_ERR_BUG;
+                       continue;
+               }
+               sr_dev_inst_free(sdi);
        }
        g_slist_free(device_instances);
        device_instances = NULL;
+
+       return ret;
 }
 
 static void *hw_get_device_info(int device_index, int device_info_id)
@@ -723,8 +750,8 @@ static void *hw_get_device_info(int device_index, int device_info_id)
        struct sigma *sigma;
        void *info = NULL;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
-               fprintf(stderr, "It's NULL.\n");
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
+               sr_err("sigma: %s: sdi was NULL", __func__);
                return NULL;
        }
 
@@ -735,7 +762,10 @@ static void *hw_get_device_info(int device_index, int device_info_id)
                info = sdi;
                break;
        case SR_DI_NUM_PROBES:
-               info = GINT_TO_POINTER(16);
+               info = GINT_TO_POINTER(NUM_PROBES);
+               break;
+       case SR_DI_PROBE_NAMES:
+               info = probe_names;
                break;
        case SR_DI_SAMPLERATES:
                info = &samplerates;
@@ -755,7 +785,7 @@ static int hw_get_status(int device_index)
 {
        struct sr_device_instance *sdi;
 
-       sdi = sr_get_device_instance(device_instances, device_index);
+       sdi = sr_dev_inst_get(device_instances, device_index);
        if (sdi)
                return sdi->status;
        else
@@ -773,7 +803,7 @@ static int hw_set_configuration(int device_index, int capability, void *value)
        struct sigma *sigma;
        int ret;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
                return SR_ERR;
 
        sigma = sdi->priv;
@@ -895,9 +925,6 @@ static int decode_chunk_ts(uint8_t *buf, uint16_t *lastts,
                        tosend = MIN(2048, n - sent);
 
                        packet.type = SR_DF_LOGIC;
-                       /* TODO: fill in timeoffset and duration */
-                       packet.timeoffset = 0;
-                       packet.duration = 0;
                        packet.payload = &logic;
                        logic.length = tosend * sizeof(uint16_t);
                        logic.unitsize = 2;
@@ -943,9 +970,6 @@ static int decode_chunk_ts(uint8_t *buf, uint16_t *lastts,
 
                        if (tosend > 0) {
                                packet.type = SR_DF_LOGIC;
-                               /* TODO: fill in timeoffset and duration */
-                               packet.timeoffset = 0;
-                               packet.duration = 0;
                                packet.payload = &logic;
                                logic.length = tosend * sizeof(uint16_t);
                                logic.unitsize = 2;
@@ -958,9 +982,6 @@ static int decode_chunk_ts(uint8_t *buf, uint16_t *lastts,
                        /* Only send trigger if explicitly enabled. */
                        if (sigma->use_triggers) {
                                packet.type = SR_DF_TRIGGER;
-                               /* TODO: fill in timeoffset only */
-                               packet.timeoffset = 0;
-                               packet.duration = 0;
                                sr_session_bus(sigma->session_id, &packet);
                        }
                }
@@ -970,9 +991,6 @@ static int decode_chunk_ts(uint8_t *buf, uint16_t *lastts,
 
                if (tosend > 0) {
                        packet.type = SR_DF_LOGIC;
-                       /* TODO: fill in timeoffset and duration */
-                       packet.timeoffset = 0;
-                       packet.duration = 0;
                        packet.payload = &logic;
                        logic.length = tosend * sizeof(uint16_t);
                        logic.unitsize = 2;
@@ -997,8 +1015,9 @@ static int receive_data(int fd, int revents, void *session_data)
        uint64_t running_msec;
        struct timeval tv;
 
-       fd = fd;
-       revents = revents;
+       /* Avoid compiler warnings. */
+       (void)fd;
+       (void)revents;
 
        numchunks = (sigma->state.stoppos + 511) / 512;
 
@@ -1033,7 +1052,7 @@ static int receive_data(int fd, int revents, void *session_data)
                newchunks = MIN(chunks_per_read,
                                numchunks - sigma->state.chunks_downloaded);
 
-               sr_info("Downloading sample data: %.0f %%",
+               sr_info("sigma: Downloading sample data: %.0f %%",
                        100.0 * sigma->state.chunks_downloaded / numchunks);
 
                bufsz = sigma_read_dram(sigma->state.chunks_downloaded,
@@ -1245,9 +1264,10 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
        struct triggerinout triggerinout_conf;
        struct triggerlut lut;
 
-       session_data = session_data;
+       /* Avoid compiler warnings. */
+       (void)session_data;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index)))
                return SR_ERR;
 
        sigma = sdi->priv;
@@ -1339,7 +1359,6 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
        gettimeofday(&header.starttime, NULL);
        header.samplerate = sigma->cur_samplerate;
        header.num_logic_probes = sigma->num_probes;
-       header.num_analog_probes = 0;
        sr_session_bus(session_data, &packet);
 
        /* Add capture source. */
@@ -1350,18 +1369,24 @@ 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 device_index, gpointer session_data)
 {
        struct sr_device_instance *sdi;
        struct sigma *sigma;
        uint8_t modestatus;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
-               return;
+       /* Avoid compiler warnings. */
+       (void)session_data;
 
-       sigma = sdi->priv;
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
+               sr_err("sigma: %s: sdi was NULL", __func__);
+               return SR_ERR_BUG;
+       }
 
-       session_data = session_data;
+       if (!(sigma = sdi->priv)) {
+               sr_err("sigma: %s: sdi->priv was NULL", __func__);
+               return SR_ERR_BUG;
+       }
 
        /* Stop acquisition. */
        sigma_set_register(WRITE_MODE, 0x11, sigma);
@@ -1374,18 +1399,19 @@ static void hw_stop_acquisition(int device_index, gpointer session_data)
 
        /* Check if trigger has fired. */
        modestatus = sigma_get_register(READ_MODE, sigma);
-       if (modestatus & 0x20) {
+       if (modestatus & 0x20)
                sigma->state.triggerchunk = sigma->state.triggerpos / 512;
-
-       } else
+       else
                sigma->state.triggerchunk = -1;
 
        sigma->state.chunks_downloaded = 0;
 
        sigma->state.state = SIGMA_DOWNLOAD;
+
+       return SR_OK;
 }
 
-struct sr_device_plugin asix_sigma_plugin_info = {
+SR_PRIV struct sr_device_plugin asix_sigma_plugin_info = {
        .name = "asix-sigma",
        .longname = "ASIX SIGMA",
        .api_version = 1,