]> sigrok.org Git - libsigrok.git/blobdiff - hardware/zeroplus-logic-cube/zeroplus.c
sr: change all drivers to use SR_DF_META_LOGIC
[libsigrok.git] / hardware / zeroplus-logic-cube / zeroplus.c
index 68acaaa5e3a105deec1fe30a5b8353052f6cda8d..d27fb39bda4a6c797ad4e2e8d0ce0e05523653f6 100644 (file)
 #include "analyzer.h"
 
 #define USB_VENDOR                     0x0c12
-#define USB_VENDOR_NAME                        "Zeroplus"
-#define USB_MODEL_NAME                 "Logic Cube"
-#define USB_MODEL_VERSION              ""
 
+#define VENDOR_NAME                    "ZEROPLUS"
+#define MODEL_NAME                     "Logic Cube LAP-C"
+#define MODEL_VERSION                  NULL
+
+#define NUM_PROBES                     16
 #define USB_INTERFACE                  0
 #define USB_CONFIGURATION              1
 #define NUM_TRIGGER_STAGES             4
@@ -78,7 +80,7 @@ static int hwcaps[] = {
  * ZEROPLUS LAP-C (16032) numbers the 16 probes A0-A7 and B0-B7.
  * We currently ignore other untested/unsupported devices here.
  */
-static const char *probe_names[] = {
+static const char *probe_names[NUM_PROBES + 1] = {
        "A0",
        "A1",
        "A2",
@@ -135,9 +137,9 @@ static uint64_t supported_samplerates[] = {
 };
 
 static struct sr_samplerates samplerates = {
-       SR_HZ(0),
-       SR_HZ(0),
-       SR_HZ(0),
+       0,
+       0,
+       0,
        supported_samplerates,
 };
 
@@ -176,7 +178,7 @@ static int opendev4(struct sr_dev_inst **sdi, libusb_device *dev,
 {
        struct context *ctx;
        unsigned int i;
-       int err;
+       int ret;
 
        /* Note: sdi is non-NULL, the caller already checked this. */
 
@@ -185,8 +187,8 @@ static int opendev4(struct sr_dev_inst **sdi, libusb_device *dev,
                return -1;
        }
 
-       if ((err = libusb_get_device_descriptor(dev, des))) {
-               sr_err("zp: failed to get device descriptor: %d", err);
+       if ((ret = libusb_get_device_descriptor(dev, des))) {
+               sr_err("zp: failed to get device descriptor: %d", ret);
                return -1;
        }
 
@@ -200,7 +202,7 @@ static int opendev4(struct sr_dev_inst **sdi, libusb_device *dev,
                        if (!(des->idProduct == zeroplus_models[i].pid))
                                continue;
 
-                       sr_info("zp: Found ZeroPlus device 0x%04x (%s)",
+                       sr_info("zp: Found ZEROPLUS device 0x%04x (%s)",
                                des->idProduct, zeroplus_models[i].model_name);
                        ctx->num_channels = zeroplus_models[i].channels;
                        ctx->memory_size = zeroplus_models[i].sample_depth * 1024;
@@ -208,19 +210,19 @@ static int opendev4(struct sr_dev_inst **sdi, libusb_device *dev,
                }
 
                if (ctx->num_channels == 0) {
-                       sr_err("zp: Unknown ZeroPlus device 0x%04x",
+                       sr_err("zp: Unknown ZEROPLUS device 0x%04x",
                               des->idProduct);
                        return -2;
                }
 
                /* Found it. */
-               if (!(err = libusb_open(dev, &(ctx->usb->devhdl)))) {
+               if (!(ret = libusb_open(dev, &(ctx->usb->devhdl)))) {
                        (*sdi)->status = SR_ST_ACTIVE;
                        sr_info("zp: opened device %d on %d.%d interface %d",
                                (*sdi)->index, ctx->usb->bus,
                                ctx->usb->address, USB_INTERFACE);
                } else {
-                       sr_err("zp: failed to open device: %d", err);
+                       sr_err("zp: failed to open device: %d", ret);
                        *sdi = NULL;
                }
        }
@@ -330,7 +332,7 @@ static int hw_init(const char *devinfo)
        struct sr_dev_inst *sdi;
        struct libusb_device_descriptor des;
        libusb_device **devlist;
-       int err, devcnt, i;
+       int ret, devcnt, i;
        struct context *ctx;
 
        /* Avoid compiler warnings. */
@@ -345,7 +347,8 @@ static int hw_init(const char *devinfo)
        /* Set some sane defaults. */
        ctx->cur_samplerate = 0;
        ctx->limit_samples = 0;
-       ctx->num_channels = 32; /* TODO: This isn't initialized before it's needed :( */
+       /* TODO: num_channels isn't initialized before it's needed :( */
+       ctx->num_channels = NUM_PROBES;
        ctx->memory_size = 0;
        ctx->probe_mask = 0;
        memset(ctx->trigger_mask, 0, NUM_TRIGGER_STAGES);
@@ -357,27 +360,27 @@ static int hw_init(const char *devinfo)
                return 0;
        }
 
-       /* Find all ZeroPlus analyzers and add them to device list. */
+       /* Find all ZEROPLUS analyzers and add them to device list. */
        devcnt = 0;
        libusb_get_device_list(usb_context, &devlist); /* TODO: Errors. */
 
        for (i = 0; devlist[i]; i++) {
-               err = libusb_get_device_descriptor(devlist[i], &des);
-               if (err != 0) {
-                       sr_err("zp: failed to get device descriptor: %d", err);
+               ret = libusb_get_device_descriptor(devlist[i], &des);
+               if (ret != 0) {
+                       sr_err("zp: failed to get device descriptor: %d", ret);
                        continue;
                }
 
                if (des.idVendor == USB_VENDOR) {
                        /*
-                        * Definitely a Zeroplus.
+                        * Definitely a ZEROPLUS.
                         * TODO: Any way to detect specific model/version in
-                        * the zeroplus range?
+                        * the ZEROPLUS range?
                         */
                        /* Register the device with libsigrok. */
                        if (!(sdi = sr_dev_inst_new(devcnt,
-                                       SR_ST_INACTIVE, USB_VENDOR_NAME,
-                                       USB_MODEL_NAME, USB_MODEL_VERSION))) {
+                                       SR_ST_INACTIVE, VENDOR_NAME,
+                                       MODEL_NAME, MODEL_VERSION))) {
                                sr_err("zp: %s: sr_dev_inst_new failed",
                                       __func__);
                                return 0;
@@ -402,7 +405,7 @@ static int hw_dev_open(int dev_index)
 {
        struct sr_dev_inst *sdi;
        struct context *ctx;
-       int err;
+       int ret;
 
        if (!(sdi = zp_open_dev(dev_index))) {
                sr_err("zp: unable to open device");
@@ -416,16 +419,16 @@ static int hw_dev_open(int dev_index)
                return SR_ERR_ARG;
        }
 
-       err = libusb_set_configuration(ctx->usb->devhdl, USB_CONFIGURATION);
-       if (err < 0) {
+       ret = libusb_set_configuration(ctx->usb->devhdl, USB_CONFIGURATION);
+       if (ret < 0) {
                sr_err("zp: Unable to set USB configuration %d: %d",
-                      USB_CONFIGURATION, err);
+                      USB_CONFIGURATION, ret);
                return SR_ERR;
        }
 
-       err = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
-       if (err != 0) {
-               sr_err("zp: Unable to claim interface: %d", err);
+       ret = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
+       if (ret != 0) {
+               sr_err("zp: Unable to claim interface: %d", ret);
                return SR_ERR;
        }
 
@@ -512,24 +515,35 @@ static void *hw_dev_info_get(int dev_index, int dev_info_id)
                return NULL;
        }
 
+       sr_spew("zp: %s: dev_index %d, dev_info_id %d.", __func__,
+               dev_index, dev_info_id);
+
        switch (dev_info_id) {
        case SR_DI_INST:
                info = sdi;
+               sr_spew("zp: %s: Returning sdi.", __func__);
                break;
        case SR_DI_NUM_PROBES:
                info = GINT_TO_POINTER(ctx->num_channels);
+               sr_spew("zp: %s: Returning number of probes: %d.", __func__,
+                       NUM_PROBES);
                break;
        case SR_DI_PROBE_NAMES:
                info = probe_names;
+               sr_spew("zp: %s: Returning probenames.", __func__);
                break;
        case SR_DI_SAMPLERATES:
                info = &samplerates;
+               sr_spew("zp: %s: Returning samplerates.", __func__);
                break;
        case SR_DI_TRIGGER_TYPES:
                info = TRIGGER_TYPES;
+               sr_spew("zp: %s: Returning triggertypes: %s.", __func__, info);
                break;
        case SR_DI_CUR_SAMPLERATE:
                info = &ctx->cur_samplerate;
+               sr_spew("zp: %s: Returning samplerate: %" PRIu64 "Hz.",
+                       __func__, ctx->cur_samplerate);
                break;
        default:
                /* Unknown device info ID, return NULL. */
@@ -613,12 +627,13 @@ static int hw_dev_config_set(int dev_index, int hwcap, void *value)
        }
 }
 
-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_logic logic;
        struct sr_datafeed_header header;
+       struct sr_datafeed_meta_logic meta;
        uint64_t samples_read;
        int res;
        unsigned int packet_num;
@@ -653,9 +668,14 @@ static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
        packet.payload = &header;
        header.feed_version = 1;
        gettimeofday(&header.starttime, NULL);
-       header.samplerate = ctx->cur_samplerate;
-       header.num_logic_probes = ctx->num_channels;
-       sr_session_send(session_data, &packet);
+       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 = ctx->cur_samplerate;
+       meta.num_probes = ctx->num_channels;
+       sr_session_send(cb_data, &packet);
 
        if (!(buf = g_try_malloc(PACKET_SIZE))) {
                sr_err("zp: %s: buf malloc failed", __func__);
@@ -676,27 +696,27 @@ static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
                logic.length = PACKET_SIZE;
                logic.unitsize = 4;
                logic.data = buf;
-               sr_session_send(session_data, &packet);
+               sr_session_send(cb_data, &packet);
                samples_read += res / 4;
        }
        analyzer_read_stop(ctx->usb->devhdl);
        g_free(buf);
 
        packet.type = SR_DF_END;
-       sr_session_send(session_data, &packet);
+       sr_session_send(cb_data, &packet);
 
        return SR_OK;
 }
 
-/* This stops acquisition on ALL devices, ignoring dev_index. */
-static int hw_dev_acquisition_stop(int dev_index, gpointer session_dev_id)
+/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
+static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
 {
        struct sr_datafeed_packet packet;
        struct sr_dev_inst *sdi;
        struct context *ctx;
 
        packet.type = SR_DF_END;
-       sr_session_send(session_dev_id, &packet);
+       sr_session_send(cb_data, &packet);
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
                sr_err("zp: %s: sdi was NULL", __func__);
@@ -716,7 +736,7 @@ static int hw_dev_acquisition_stop(int dev_index, gpointer session_dev_id)
 
 SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info = {
        .name = "zeroplus-logic-cube",
-       .longname = "Zeroplus Logic Cube LAP-C series",
+       .longname = "ZEROPLUS Logic Cube LAP-C series",
        .api_version = 1,
        .init = hw_init,
        .cleanup = hw_cleanup,