]> sigrok.org Git - libsigrok.git/blobdiff - hardware/zeroplus-logic-cube/zeroplus.c
probe names: Fix cosmetics, add docs, fix off-by-one.
[libsigrok.git] / hardware / zeroplus-logic-cube / zeroplus.c
index cb56a09f8873b859dd3717354dc26b3a4ace06bd..066d4c7697e47cec83a50c8de793740b5aa1e788 100644 (file)
@@ -24,7 +24,8 @@
 #include <inttypes.h>
 #include <glib.h>
 #include <libusb.h>
-#include <sigrok.h>
+#include "sigrok.h"
+#include "sigrok-internal.h"
 #include "analyzer.h"
 
 #define USB_VENDOR                     0x0c12
@@ -51,7 +52,7 @@ typedef struct {
  * Note -- 16032, 16064 and 16128 *usually* -- but not always -- have the
  * same 128K sample depth.
  */
-model_t zeroplus_models[] = {
+static model_t zeroplus_models[] = {
        {0x7009, "LAP-C(16064)",  16, 64,   100},
        {0x700A, "LAP-C(16128)",  16, 128,  200},
        {0x700B, "LAP-C(32128)",  32, 128,  200},
@@ -72,6 +73,42 @@ static int capabilities[] = {
        0,
 };
 
+static const char *probe_names[] = {
+       "0",
+       "1",
+       "2",
+       "3",
+       "4",
+       "5",
+       "6",
+       "7",
+       "8",
+       "9",
+       "10",
+       "11",
+       "12",
+       "13",
+       "14",
+       "15",
+       "16",
+       "17",
+       "18",
+       "19",
+       "20",
+       "21",
+       "22",
+       "23",
+       "24",
+       "25",
+       "26",
+       "27",
+       "28",
+       "29",
+       "30",
+       "31",
+       NULL,
+};
+
 /* List of struct sr_device_instance, maintained by opendev()/closedev(). */
 static GSList *device_instances = NULL;
 
@@ -87,37 +124,40 @@ static libusb_context *usb_context = NULL;
  * that high.
  */
 static uint64_t supported_samplerates[] = {
-       100,
-       500,
-       KHZ(1),
-       KHZ(5),
-       KHZ(25),
-       KHZ(50),
-       KHZ(100),
-       KHZ(200),
-       KHZ(400),
-       KHZ(800),
-       MHZ(1),
-       MHZ(10),
-       MHZ(25),
-       MHZ(50),
-       MHZ(80),
-       MHZ(100),
-       MHZ(150),
-       MHZ(200),
+       SR_HZ(100),
+       SR_HZ(500),
+       SR_KHZ(1),
+       SR_KHZ(5),
+       SR_KHZ(25),
+       SR_KHZ(50),
+       SR_KHZ(100),
+       SR_KHZ(200),
+       SR_KHZ(400),
+       SR_KHZ(800),
+       SR_MHZ(1),
+       SR_MHZ(10),
+       SR_MHZ(25),
+       SR_MHZ(50),
+       SR_MHZ(80),
+       SR_MHZ(100),
+       SR_MHZ(150),
+       SR_MHZ(200),
        0,
 };
 
-static struct samplerates samplerates = {
-       0, 0, 0,
+static struct sr_samplerates samplerates = {
+       SR_HZ(0),
+       SR_HZ(0),
+       SR_HZ(0),
        supported_samplerates,
 };
 
 /* TODO: All of these should go in a device-specific struct. */
 static uint64_t cur_samplerate = 0;
+static uint64_t period_ps = 0;
 static uint64_t limit_samples = 0;
-int num_channels = 32; /* TODO: This isn't initialized before it's needed :( */
-uint64_t memory_size = 0;
+static int num_channels = 32; /* TODO: This isn't initialized before it's needed :( */
+static uint64_t memory_size = 0;
 static uint8_t probe_mask = 0;
 static uint8_t trigger_mask[NUM_TRIGGER_STAGES] = { 0 };
 static uint8_t trigger_value[NUM_TRIGGER_STAGES] = { 0 };
@@ -147,7 +187,7 @@ static int opendev4(struct sr_device_instance **sdi, libusb_device *dev,
        int err;
 
        if ((err = libusb_get_device_descriptor(dev, des))) {
-               g_warning("failed to get device descriptor: %d", err);
+               sr_warn("failed to get device descriptor: %d", err);
                return -1;
        }
 
@@ -161,27 +201,26 @@ static int opendev4(struct sr_device_instance **sdi, libusb_device *dev,
                        if (!(des->idProduct == zeroplus_models[i].pid))
                                continue;
 
-                       g_message("Found PID=%04X (%s)", des->idProduct,
-                                 zeroplus_models[i].model_name);
+                       sr_info("Found PID=%04X (%s)", des->idProduct,
+                               zeroplus_models[i].model_name);
                        num_channels = zeroplus_models[i].channels;
                        memory_size = zeroplus_models[i].sample_depth * 1024;
                        break;
                }
 
                if (num_channels == 0) {
-                       g_warning("Unknown ZeroPlus device %04X",
-                                 des->idProduct);
+                       sr_warn("Unknown ZeroPlus device %04X", des->idProduct);
                        return -2;
                }
 
                /* Found it. */
                if (!(err = libusb_open(dev, &((*sdi)->usb->devhdl)))) {
                        (*sdi)->status = SR_ST_ACTIVE;
-                       g_message("opened device %d on %d.%d interface %d",
-                            (*sdi)->index, (*sdi)->usb->bus,
-                            (*sdi)->usb->address, USB_INTERFACE);
+                       sr_info("opened device %d on %d.%d interface %d",
+                               (*sdi)->index, (*sdi)->usb->bus,
+                               (*sdi)->usb->address, USB_INTERFACE);
                } else {
-                       g_warning("failed to open device: %d", err);
+                       sr_warn("failed to open device: %d", err);
                        *sdi = NULL;
                }
        }
@@ -189,7 +228,7 @@ static int opendev4(struct sr_device_instance **sdi, libusb_device *dev,
        return 0;
 }
 
-struct sr_device_instance *zp_open_device(int device_index)
+static struct sr_device_instance *zp_open_device(int device_index)
 {
        struct sr_device_instance *sdi;
        libusb_device **devlist;
@@ -224,8 +263,8 @@ static void close_device(struct sr_device_instance *sdi)
        if (!sdi->usb->devhdl)
                return;
 
-       g_message("closing device %d on %d.%d interface %d", sdi->index,
-                 sdi->usb->bus, sdi->usb->address, USB_INTERFACE);
+       sr_info("closing device %d on %d.%d interface %d", sdi->index,
+               sdi->usb->bus, sdi->usb->address, USB_INTERFACE);
        libusb_release_interface(sdi->usb->devhdl, USB_INTERFACE);
        libusb_close(sdi->usb->devhdl);
        sdi->usb->devhdl = NULL;
@@ -273,7 +312,7 @@ static int configure_probes(GSList *probes)
  * API callbacks
  */
 
-static int hw_init(char *deviceinfo)
+static int hw_init(const char *deviceinfo)
 {
        struct sr_device_instance *sdi;
        struct libusb_device_descriptor des;
@@ -281,10 +320,10 @@ static int hw_init(char *deviceinfo)
        int err, devcnt, i;
 
        /* Avoid compiler warnings. */
-       deviceinfo = deviceinfo;
+       (void)deviceinfo;
 
        if (libusb_init(&usb_context) != 0) {
-               g_warning("Failed to initialize USB.");
+               sr_warn("Failed to initialize USB.");
                return 0;
        }
 
@@ -295,7 +334,7 @@ static int hw_init(char *deviceinfo)
        for (i = 0; devlist[i]; i++) {
                err = libusb_get_device_descriptor(devlist[i], &des);
                if (err != 0) {
-                       g_warning("failed to get device descriptor: %d", err);
+                       sr_warn("failed to get device descriptor: %d", err);
                        continue;
                }
 
@@ -329,13 +368,13 @@ static int hw_opendev(int device_index)
        int err;
 
        if (!(sdi = zp_open_device(device_index))) {
-               g_warning("unable to open device");
+               sr_warn("unable to open device");
                return SR_ERR;
        }
 
        err = libusb_claim_interface(sdi->usb->devhdl, USB_INTERFACE);
        if (err != 0) {
-               g_warning("Unable to claim interface: %d", err);
+               sr_warn("Unable to claim interface: %d", err);
                return SR_ERR;
        }
        analyzer_reset(sdi->usb->devhdl);
@@ -368,12 +407,19 @@ static int hw_opendev(int device_index)
        return SR_OK;
 }
 
-static void hw_closedev(int device_index)
+static int hw_closedev(int device_index)
 {
        struct sr_device_instance *sdi;
 
-       if ((sdi = sr_get_device_instance(device_instances, device_index)))
-               close_device(sdi);
+       if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+               sr_err("lap-c: %s: sdi was NULL", __func__);
+               return SR_ERR; /* TODO: SR_ERR_ARG? */
+       }
+
+       /* TODO */
+       close_device(sdi);
+
+       return SR_OK;
 }
 
 static void hw_cleanup(void)
@@ -410,6 +456,9 @@ static void *hw_get_device_info(int device_index, int device_info_id)
        case SR_DI_NUM_PROBES:
                info = GINT_TO_POINTER(num_channels);
                break;
+       case SR_DI_PROBE_NAMES:
+               info = probe_names;
+               break;
        case SR_DI_SAMPLERATES:
                info = &samplerates;
                break;
@@ -443,15 +492,16 @@ static int *hw_get_capabilities(void)
 /* TODO: This will set the same samplerate for all devices. */
 static int set_configuration_samplerate(uint64_t samplerate)
 {
-       g_message("%s(%" PRIu64 ")", __FUNCTION__, samplerate);
-       if (samplerate > MHZ(1))
-               analyzer_set_freq(samplerate / MHZ(1), FREQ_SCALE_MHZ);
-       else if (samplerate > KHZ(1))
-               analyzer_set_freq(samplerate / KHZ(1), FREQ_SCALE_KHZ);
+       sr_info("%s(%" PRIu64 ")", __func__, samplerate);
+       if (samplerate > SR_MHZ(1))
+               analyzer_set_freq(samplerate / SR_MHZ(1), FREQ_SCALE_MHZ);
+       else if (samplerate > SR_KHZ(1))
+               analyzer_set_freq(samplerate / SR_KHZ(1), FREQ_SCALE_KHZ);
        else
                analyzer_set_freq(samplerate, FREQ_SCALE_HZ);
 
        cur_samplerate = samplerate;
+       period_ps = 1000000000000 / samplerate;
 
        return SR_OK;
 }
@@ -479,11 +529,13 @@ static int hw_set_configuration(int device_index, int capability, void *value)
        }
 }
 
-static int hw_start_acquisition(int device_index, gpointer session_device_id)
+static int hw_start_acquisition(int device_index, gpointer session_data)
 {
        struct sr_device_instance *sdi;
        struct sr_datafeed_packet packet;
+       struct sr_datafeed_logic logic;
        struct sr_datafeed_header header;
+       uint64_t samples_read;
        int res;
        unsigned int packet_num;
        unsigned char *buf;
@@ -495,51 +547,51 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        analyzer_configure(sdi->usb->devhdl);
 
        analyzer_start(sdi->usb->devhdl);
-       g_message("Waiting for data");
+       sr_info("Waiting for data");
        analyzer_wait_data(sdi->usb->devhdl);
 
-       g_message("Stop address    = 0x%x",
-                 analyzer_get_stop_address(sdi->usb->devhdl));
-       g_message("Now address     = 0x%x",
-                 analyzer_get_now_address(sdi->usb->devhdl));
-       g_message("Trigger address = 0x%x",
-                 analyzer_get_trigger_address(sdi->usb->devhdl));
+       sr_info("Stop address    = 0x%x", analyzer_get_stop_address(sdi->usb->devhdl));
+       sr_info("Now address     = 0x%x", analyzer_get_now_address(sdi->usb->devhdl));
+       sr_info("Trigger address = 0x%x", analyzer_get_trigger_address(sdi->usb->devhdl));
 
        packet.type = SR_DF_HEADER;
-       packet.length = sizeof(struct sr_datafeed_header);
-       packet.payload = (unsigned char *)&header;
+       packet.payload = &header;
        header.feed_version = 1;
        gettimeofday(&header.starttime, NULL);
        header.samplerate = cur_samplerate;
-       header.protocol_id = SR_PROTO_RAW;
        header.num_logic_probes = num_channels;
        header.num_analog_probes = 0;
-       session_bus(session_device_id, &packet);
+       sr_session_bus(session_data, &packet);
 
-       buf = g_malloc(PACKET_SIZE);
-       if (!buf)
-               return SR_ERR;
+       if (!(buf = g_try_malloc(PACKET_SIZE))) {
+               sr_err("lap-c: %s: buf malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
+
+       samples_read = 0;
        analyzer_read_start(sdi->usb->devhdl);
        /* Send the incoming transfer to the session bus. */
        for (packet_num = 0; packet_num < (memory_size * 4 / PACKET_SIZE);
             packet_num++) {
                res = analyzer_read_data(sdi->usb->devhdl, buf, PACKET_SIZE);
-#if 0
-               g_message("Tried to read %llx bytes, actually read %x bytes",
-                         PACKET_SIZE, res);
-#endif
+               sr_info("Tried to read %llx bytes, actually read %x bytes",
+                       PACKET_SIZE, res);
 
                packet.type = SR_DF_LOGIC;
-               packet.length = PACKET_SIZE;
-               packet.unitsize = 4;
-               packet.payload = buf;
-               session_bus(session_device_id, &packet);
+               packet.timeoffset = samples_read * period_ps;
+               packet.duration = res / 4 * period_ps;
+               packet.payload = &logic;
+               logic.length = PACKET_SIZE;
+               logic.unitsize = 4;
+               logic.data = buf;
+               sr_session_bus(session_data, &packet);
+               samples_read += res / 4;
        }
        analyzer_read_stop(sdi->usb->devhdl);
        g_free(buf);
 
        packet.type = SR_DF_END;
-       session_bus(session_device_id, &packet);
+       sr_session_bus(session_data, &packet);
 
        return SR_OK;
 }
@@ -551,7 +603,7 @@ static void hw_stop_acquisition(int device_index, gpointer session_device_id)
        struct sr_device_instance *sdi;
 
        packet.type = SR_DF_END;
-       session_bus(session_device_id, &packet);
+       sr_session_bus(session_device_id, &packet);
 
        if (!(sdi = sr_get_device_instance(device_instances, device_index)))
                return; /* TODO: Cry? */
@@ -561,17 +613,17 @@ static void hw_stop_acquisition(int device_index, gpointer session_device_id)
 }
 
 struct sr_device_plugin zeroplus_logic_cube_plugin_info = {
-       "zeroplus-logic-cube",
-       "Zeroplus Logic Cube LAP-C series",
-       1,
-       hw_init,
-       hw_cleanup,
-       hw_opendev,
-       hw_closedev,
-       hw_get_device_info,
-       hw_get_status,
-       hw_get_capabilities,
-       hw_set_configuration,
-       hw_start_acquisition,
-       hw_stop_acquisition,
+       .name = "zeroplus-logic-cube",
+       .longname = "Zeroplus Logic Cube LAP-C series",
+       .api_version = 1,
+       .init = hw_init,
+       .cleanup = hw_cleanup,
+       .opendev = hw_opendev,
+       .closedev = hw_closedev,
+       .get_device_info = hw_get_device_info,
+       .get_status = hw_get_status,
+       .get_capabilities = hw_get_capabilities,
+       .set_configuration = hw_set_configuration,
+       .start_acquisition = hw_start_acquisition,
+       .stop_acquisition = hw_stop_acquisition,
 };