]> sigrok.org Git - libsigrok.git/blobdiff - hardware/zeroplus-logic-cube/zeroplus.c
Add and use std_session_send_df_header().
[libsigrok.git] / hardware / zeroplus-logic-cube / zeroplus.c
index 3145d767063c035dbd59d78cdafa5a1e4e26463c..4d3df029bbc55e34fef737fca07d0ff48d43a39c 100644 (file)
@@ -27,6 +27,7 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 #include "analyzer.h"
+#include "protocol.h"
 
 #define USB_VENDOR                     0x0c12
 
@@ -38,7 +39,7 @@
 #define USB_INTERFACE                  0
 #define USB_CONFIGURATION              1
 #define NUM_TRIGGER_STAGES             4
-#define TRIGGER_TYPES                  "01"
+#define TRIGGER_TYPE                   "01"
 
 #define PACKET_SIZE                    2048    /* ?? */
 
@@ -71,12 +72,12 @@ static model_t zeroplus_models[] = {
 };
 
 static const int hwcaps[] = {
-       SR_HWCAP_LOGIC_ANALYZER,
-       SR_HWCAP_SAMPLERATE,
-       SR_HWCAP_CAPTURE_RATIO,
+       SR_CONF_LOGIC_ANALYZER,
+       SR_CONF_SAMPLERATE,
+       SR_CONF_CAPTURE_RATIO,
 
        /* These are really implemented in the driver, not the hardware. */
-       SR_HWCAP_LIMIT_SAMPLES,
+       SR_CONF_LIMIT_SAMPLES,
        0,
 };
 
@@ -85,30 +86,14 @@ static const int hwcaps[] = {
  * We currently ignore other untested/unsupported devices here.
  */
 static const char *probe_names[NUM_PROBES + 1] = {
-       "A0",
-       "A1",
-       "A2",
-       "A3",
-       "A4",
-       "A5",
-       "A6",
-       "A7",
-       "B0",
-       "B1",
-       "B2",
-       "B3",
-       "B4",
-       "B5",
-       "B6",
-       "B7",
+       "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7",
+       "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7",
        NULL,
 };
 
 /* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */
 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
-static struct sr_dev_driver *zdi = &zeroplus_logic_cube_driver_info;
-
-static libusb_context *usb_context = NULL;
+static struct sr_dev_driver *di = &zeroplus_logic_cube_driver_info;
 
 /*
  * The hardware supports more samplerates than these, but these are the
@@ -142,10 +127,10 @@ static const uint64_t supported_samplerates[] = {
 };
 
 static const struct sr_samplerates samplerates = {
-       0,
-       0,
-       0,
-       supported_samplerates,
+       .low  = 0,
+       .high = 0,
+       .step = 0,
+       .list = supported_samplerates,
 };
 
 /* Private, per-device-instance driver context. */
@@ -279,12 +264,12 @@ static int clear_instances(void)
        struct drv_context *drvc;
        struct dev_context *devc;
 
-       drvc = zdi->priv;
+       drvc = di->priv;
        for (l = drvc->instances; l; l = l->next) {
                sdi = l->data;
                if (!(devc = sdi->priv)) {
                        /* Log error, but continue cleaning up the rest. */
-                       sr_err("zeroplus: %s: sdi->priv was NULL, continuing", __func__);
+                       sr_err("%s: sdi->priv was NULL, continuing", __func__);
                        continue;
                }
                sr_usb_dev_inst_free(devc->usb);
@@ -299,26 +284,9 @@ static int clear_instances(void)
        return SR_OK;
 }
 
-/*
- * API callbacks
- */
-
-static int hw_init(void)
+static int hw_init(struct sr_context *sr_ctx)
 {
-       struct drv_context *drvc;
-
-       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("zeroplus: driver context malloc failed.");
-               return SR_ERR_MALLOC;
-       }
-       zdi->priv = drvc;
-
-       if (libusb_init(&usb_context) != 0) {
-               sr_err("zp: Failed to initialize USB.");
-               return 0;
-       }
-
-       return SR_OK;
+       return std_hw_init(sr_ctx, di, "zeroplus: ");
 }
 
 static GSList *hw_scan(GSList *options)
@@ -334,19 +302,22 @@ static GSList *hw_scan(GSList *options)
        int ret, devcnt, i, j;
 
        (void)options;
-       drvc = zdi->priv;
+
+       drvc = di->priv;
+
        devices = NULL;
 
        clear_instances();
 
        /* Find all ZEROPLUS analyzers and add them to device list. */
        devcnt = 0;
-       libusb_get_device_list(usb_context, &devlist); /* TODO: Errors. */
+       libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); /* TODO: Errors. */
 
        for (i = 0; devlist[i]; i++) {
                ret = libusb_get_device_descriptor(devlist[i], &des);
                if (ret != 0) {
-                       sr_err("zp: failed to get device descriptor: %d", ret);
+                       sr_err("Failed to get device descriptor: %s.",
+                              libusb_error_name(ret));
                        continue;
                }
 
@@ -360,19 +331,19 @@ static GSList *hw_scan(GSList *options)
                /* Skip if the device was not found */
                if (!prof)
                        continue;
-               sr_info("zp: Found ZEROPLUS model %s", prof->model_name);
+               sr_info("Found ZEROPLUS model %s.", prof->model_name);
 
                /* Register the device with libsigrok. */
                if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
                                VENDOR_NAME, prof->model_name, NULL))) {
-                       sr_err("zp: %s: sr_dev_inst_new failed", __func__);
+                       sr_err("%s: sr_dev_inst_new failed", __func__);
                        return NULL;
                }
-               sdi->driver = zdi;
+               sdi->driver = di;
 
                /* Allocate memory for our private driver context. */
                if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
-                       sr_err("zp: %s: devc malloc failed", __func__);
+                       sr_err("Device context malloc failed.");
                        return NULL;
                }
                sdi->priv = devc;
@@ -411,36 +382,34 @@ static GSList *hw_scan(GSList *options)
 
 static GSList *hw_dev_list(void)
 {
-       struct drv_context *drvc;
-
-       drvc = zdi->priv;
-
-       return drvc->instances;
+       return ((struct drv_context *)(di->priv))->instances;
 }
 
 static int hw_dev_open(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
+       struct drv_context *drvc = di->priv;
        libusb_device **devlist, *dev;
        struct libusb_device_descriptor des;
        int device_count, ret, i;
 
        if (!(devc = sdi->priv)) {
-               sr_err("zp: %s: sdi->priv was NULL", __func__);
+               sr_err("%s: sdi->priv was NULL", __func__);
                return SR_ERR_ARG;
        }
 
-       device_count = libusb_get_device_list(usb_context, &devlist);
+       device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx,
+                                             &devlist);
        if (device_count < 0) {
-               sr_err("zp: Failed to retrieve device list");
+               sr_err("Failed to retrieve device list.");
                return SR_ERR;
        }
 
        dev = NULL;
        for (i = 0; i < device_count; i++) {
                if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
-                       sr_err("fx2lafw: Failed to get device descriptor: %d.",
-                              ret);
+                       sr_err("Failed to get device descriptor: %s.",
+                              libusb_error_name(ret));
                        continue;
                }
                if (libusb_get_bus_number(devlist[i]) == devc->usb->bus
@@ -450,31 +419,32 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
                }
        }
        if (!dev) {
-               sr_err("device on bus %d address %d disappeared!",
-                               devc->usb->bus, devc->usb->address);
+               sr_err("Device on bus %d address %d disappeared!",
+                      devc->usb->bus, devc->usb->address);
                return SR_ERR;
        }
 
        if (!(ret = libusb_open(dev, &(devc->usb->devhdl)))) {
                sdi->status = SR_ST_ACTIVE;
-               sr_info("zp: opened device %d on %d.%d interface %d",
+               sr_info("Opened device %d on %d.%d interface %d.",
                        sdi->index, devc->usb->bus,
                        devc->usb->address, USB_INTERFACE);
        } else {
-               sr_err("zp: failed to open device: %d", ret);
+               sr_err("Failed to open device: %s.", libusb_error_name(ret));
                return SR_ERR;
        }
 
        ret = libusb_set_configuration(devc->usb->devhdl, USB_CONFIGURATION);
        if (ret < 0) {
-               sr_err("zp: Unable to set USB configuration %d: %d",
-                      USB_CONFIGURATION, ret);
+               sr_err("Unable to set USB configuration %d: %s.",
+                      USB_CONFIGURATION, libusb_error_name(ret));
                return SR_ERR;
        }
 
        ret = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE);
        if (ret != 0) {
-               sr_err("zp: Unable to claim interface: %d", ret);
+               sr_err("Unable to claim interface: %s.",
+                      libusb_error_name(ret));
                return SR_ERR;
        }
 
@@ -513,15 +483,12 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
-       if (!(devc = sdi->priv)) {
-               sr_err("zp: %s: sdi->priv was NULL", __func__);
-               return SR_ERR;
-       }
+       devc = sdi->priv;
 
        if (!devc->usb->devhdl)
                return SR_ERR;
 
-       sr_info("zp: closing device %d on %d.%d interface %d", sdi->index,
+       sr_info("Closing device %d on %d.%d interface %d.", sdi->index,
                devc->usb->bus, devc->usb->address, USB_INTERFACE);
        libusb_release_interface(devc->usb->devhdl, USB_INTERFACE);
        libusb_reset_device(devc->usb->devhdl);
@@ -536,54 +503,25 @@ static int hw_cleanup(void)
 {
        struct drv_context *drvc;
 
-       if (!(drvc = zdi->priv))
+       if (!(drvc = di->priv))
                return SR_OK;
 
        clear_instances();
 
-       if (usb_context)
-               libusb_exit(usb_context);
-       usb_context = NULL;
-
        return SR_OK;
 }
 
-static int hw_info_get(int info_id, const void **data,
-       const struct sr_dev_inst *sdi)
+static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
-       switch (info_id) {
-       case SR_DI_HWCAPS:
-               *data = hwcaps;
-               break;
-       case SR_DI_NUM_PROBES:
-               if (sdi) {
-                       devc = sdi->priv;
-                       *data = GINT_TO_POINTER(devc->num_channels);
-                       sr_spew("zp: %s: Returning number of channels: %d.",
-                                       __func__, devc->num_channels);
-               } else
-                       return SR_ERR;
-               break;
-       case SR_DI_PROBE_NAMES:
-               *data = probe_names;
-               sr_spew("zp: %s: Returning probenames.", __func__);
-               break;
-       case SR_DI_SAMPLERATES:
-               *data = &samplerates;
-               sr_spew("zp: %s: Returning samplerates.", __func__);
-               break;
-       case SR_DI_TRIGGER_TYPES:
-               *data = TRIGGER_TYPES;
-               sr_spew("zp: %s: Returning triggertypes: %s.", __func__, TRIGGER_TYPES);
-               break;
-       case SR_DI_CUR_SAMPLERATE:
+       switch (id) {
+       case SR_CONF_SAMPLERATE:
                if (sdi) {
                        devc = sdi->priv;
                        *data = &devc->cur_samplerate;
-                       sr_spew("zp: %s: Returning samplerate: %" PRIu64 "Hz.",
-                               __func__, devc->cur_samplerate);
+                       sr_spew("Returning samplerate: %" PRIu64 "Hz.",
+                               devc->cur_samplerate);
                } else
                        return SR_ERR;
                break;
@@ -601,12 +539,13 @@ static int set_samplerate(struct dev_context *devc, uint64_t samplerate)
        for (i = 0; supported_samplerates[i]; i++)
                if (samplerate == supported_samplerates[i])
                        break;
+
        if (!supported_samplerates[i] || samplerate > devc->max_samplerate) {
-               sr_err("zp: %s: unsupported samplerate", __func__);
+               sr_err("Unsupported samplerate.");
                return SR_ERR_ARG;
        }
 
-       sr_info("zp: Setting samplerate to %" PRIu64 "Hz.", samplerate);
+       sr_info("Setting samplerate to %" PRIu64 "Hz.", samplerate);
 
        if (samplerate >= SR_MHZ(1))
                analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
@@ -634,7 +573,7 @@ static int set_limit_samples(struct dev_context *devc, uint64_t samples)
        else
                devc->memory_size = MEMORY_SIZE_512K;
 
-       sr_info("zp: Setting memory size to %dK.",
+       sr_info("Setting memory size to %dK.",
                get_memory_size(devc->memory_size) / 1024);
 
        analyzer_set_memory_size(devc->memory_size);
@@ -645,44 +584,64 @@ static int set_limit_samples(struct dev_context *devc, uint64_t samples)
 static int set_capture_ratio(struct dev_context *devc, uint64_t ratio)
 {
        if (ratio > 100) {
-               sr_err("zp: %s: invalid capture ratio", __func__);
+               sr_err("Invalid capture ratio: %" PRIu64 ".", ratio);
                return SR_ERR_ARG;
        }
 
        devc->capture_ratio = ratio;
 
-       sr_info("zp: Setting capture ratio to %d%%.", devc->capture_ratio);
+       sr_info("Setting capture ratio to %d%%.", devc->capture_ratio);
 
        return SR_OK;
 }
 
-static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
-                            const void *value)
+static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
        if (!sdi) {
-               sr_err("zp: %s: sdi was NULL", __func__);
+               sr_err("%s: sdi was NULL", __func__);
                return SR_ERR_ARG;
        }
 
        if (!(devc = sdi->priv)) {
-               sr_err("zp: %s: sdi->priv was NULL", __func__);
+               sr_err("%s: sdi->priv was NULL", __func__);
                return SR_ERR_ARG;
        }
 
-       switch (hwcap) {
-       case SR_HWCAP_SAMPLERATE:
+       switch (id) {
+       case SR_CONF_SAMPLERATE:
                return set_samplerate(devc, *(const uint64_t *)value);
-       case SR_HWCAP_LIMIT_SAMPLES:
+       case SR_CONF_LIMIT_SAMPLES:
                return set_limit_samples(devc, *(const uint64_t *)value);
-       case SR_HWCAP_CAPTURE_RATIO:
+       case SR_CONF_CAPTURE_RATIO:
                return set_capture_ratio(devc, *(const uint64_t *)value);
        default:
                return SR_ERR;
        }
 }
 
+static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
+{
+       (void)sdi;
+
+       switch (key) {
+       case SR_CONF_DEVICE_OPTIONS:
+               *data = hwcaps;
+               break;
+       case SR_CONF_SAMPLERATE:
+               *data = &samplerates;
+               break;
+       case SR_CONF_TRIGGER_TYPE:
+               *data = TRIGGER_TYPE;
+               break;
+       default:
+               return SR_ERR_ARG;
+       }
+
+       return SR_OK;
+}
+
 static void set_triggerbar(struct dev_context *devc)
 {
        unsigned int ramsize;
@@ -707,8 +666,8 @@ static void set_triggerbar(struct dev_context *devc)
        analyzer_set_triggerbar_address(triggerbar);
        analyzer_set_ramsize_trigger_address(ramsize - triggerbar);
 
-       sr_dbg("zp: triggerbar_address = %d(0x%x)", triggerbar, triggerbar);
-       sr_dbg("zp: ramsize_triggerbar_address = %d(0x%x)",
+       sr_dbg("triggerbar_address = %d(0x%x)", triggerbar, triggerbar);
+       sr_dbg("ramsize_triggerbar_address = %d(0x%x)",
               ramsize - triggerbar, ramsize - triggerbar);
 }
 
@@ -717,8 +676,6 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 {
        struct sr_datafeed_packet packet;
        struct sr_datafeed_logic logic;
-       struct sr_datafeed_header header;
-       struct sr_datafeed_meta_logic meta;
        //uint64_t samples_read;
        int res;
        unsigned int packet_num;
@@ -727,12 +684,12 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        struct dev_context *devc;
 
        if (!(devc = sdi->priv)) {
-               sr_err("zp: %s: sdi->priv was NULL", __func__);
+               sr_err("%s: sdi->priv was NULL", __func__);
                return SR_ERR_ARG;
        }
 
        if (configure_probes(sdi) != SR_OK) {
-               sr_err("zp: failed to configured probes");
+               sr_err("Failed to configure probes.");
                return SR_ERR;
        }
 
@@ -742,31 +699,21 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        analyzer_configure(devc->usb->devhdl);
 
        analyzer_start(devc->usb->devhdl);
-       sr_info("zp: Waiting for data");
+       sr_info("Waiting for data.");
        analyzer_wait_data(devc->usb->devhdl);
 
-       sr_info("zp: Stop address    = 0x%x",
+       sr_info("Stop address    = 0x%x.",
                analyzer_get_stop_address(devc->usb->devhdl));
-       sr_info("zp: Now address     = 0x%x",
+       sr_info("Now address     = 0x%x.",
                analyzer_get_now_address(devc->usb->devhdl));
-       sr_info("zp: Trigger address = 0x%x",
+       sr_info("Trigger address = 0x%x.",
                analyzer_get_trigger_address(devc->usb->devhdl));
 
-       packet.type = SR_DF_HEADER;
-       packet.payload = &header;
-       header.feed_version = 1;
-       gettimeofday(&header.starttime, NULL);
-       sr_session_send(cb_data, &packet);
-
-       /* Send metadata about the SR_DF_LOGIC packets to come. */
-       packet.type = SR_DF_META_LOGIC;
-       packet.payload = &meta;
-       meta.samplerate = devc->cur_samplerate;
-       meta.num_probes = devc->num_channels;
-       sr_session_send(cb_data, &packet);
+       /* Send header packet to the session bus. */
+       std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 
        if (!(buf = g_try_malloc(PACKET_SIZE))) {
-               sr_err("zp: %s: buf malloc failed", __func__);
+               sr_err("Packet buffer malloc failed.");
                return SR_ERR_MALLOC;
        }
 
@@ -778,7 +725,7 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                n = devc->max_memory_size * 4;
        for (packet_num = 0; packet_num < n / PACKET_SIZE; packet_num++) {
                res = analyzer_read_data(devc->usb->devhdl, buf, PACKET_SIZE);
-               sr_info("zp: Tried to read %d bytes, actually read %d bytes",
+               sr_info("Tried to read %d bytes, actually read %d bytes.",
                        PACKET_SIZE, res);
 
                packet.type = SR_DF_LOGIC;
@@ -808,7 +755,7 @@ static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        sr_session_send(cb_data, &packet);
 
        if (!(devc = sdi->priv)) {
-               sr_err("zp: %s: sdi->priv was NULL", __func__);
+               sr_err("%s: sdi->priv was NULL", __func__);
                return SR_ERR_BUG;
        }
 
@@ -827,10 +774,11 @@ SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
        .scan = hw_scan,
        .dev_list = hw_dev_list,
        .dev_clear = hw_cleanup,
+       .config_get = config_get,
+       .config_set = config_set,
+       .config_list = config_list,
        .dev_open = hw_dev_open,
        .dev_close = hw_dev_close,
-       .info_get = hw_info_get,
-       .dev_config_set = hw_dev_config_set,
        .dev_acquisition_start = hw_dev_acquisition_start,
        .dev_acquisition_stop = hw_dev_acquisition_stop,
        .priv = NULL,