]> sigrok.org Git - libsigrok.git/blobdiff - hardware/radioshack-dmm/api.c
Add Metex 14-byte ASCII protocol parser.
[libsigrok.git] / hardware / radioshack-dmm / api.c
index 912a3a9dc5b4dda2e37cc714e0b5440364ed54a0..c32ffbe6e1d62ed55440045e4060fc543800ebe4 100644 (file)
  */
 
 #include <glib.h>
-#include "libsigrok.h"
-#include "libsigrok-internal.h"
-#include "config.h"
-#include "radioshack-dmm.h"
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <string.h>
 #include <errno.h>
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
+#include "protocol.h"
+
+#define SERIALCOMM "4800/8n1"
 
 static const int hwopts[] = {
        SR_HWOPT_CONN,
@@ -50,11 +51,6 @@ static const char *probe_names[] = {
 SR_PRIV struct sr_dev_driver radioshackdmm_driver_info;
 static struct sr_dev_driver *di = &radioshackdmm_driver_info;
 
-static const struct radioshackdmm_profile supported_radioshackdmm[] = {
-       { RADIOSHACK_22_812, "22-812", 100 },
-};
-
-
 /* Properly close and free all devices. */
 static int clear_instances(void)
 {
@@ -86,8 +82,8 @@ static int hw_init(void)
        struct drv_context *drvc;
 
        if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("radioshack-dmm: driver context malloc failed.");
-               return SR_ERR;
+               sr_err("Driver context malloc failed.");
+               return SR_ERR_MALLOC;
        }
 
        di->priv = drvc;
@@ -95,90 +91,54 @@ static int hw_init(void)
        return SR_OK;
 }
 
-static int serial_readline(int fd, char **buf, size_t *buflen,
-                          uint64_t timeout_ms)
-{
-       uint64_t start;
-       int maxlen, len;
-
-       timeout_ms *= 1000;
-       start = g_get_monotonic_time();
-
-       maxlen = *buflen;
-       *buflen = len = 0;
-       while(1) {
-               len = maxlen - *buflen - 1;
-               if (len < 1)
-                       break;
-               len = serial_read(fd, *buf + *buflen, 1);
-               if (len > 0) {
-                       *buflen += len;
-                       *(*buf + *buflen) = '\0';
-                       if (*buflen > 0 && *(*buf + *buflen - 1) == '\r') {
-                               /* Strip LF and terminate. */
-                               *(*buf + --*buflen) = '\0';
-                               break;
-                       }
-               }
-               if (g_get_monotonic_time() - start > timeout_ms)
-                       /* Timeout */
-                       break;
-               g_usleep(2000);
-       }
-
-       return SR_OK;
-}
-
 static GSList *rs_22_812_scan(const char *conn, const char *serialcomm)
 {
        struct sr_dev_inst *sdi;
        struct drv_context *drvc;
        struct dev_context *devc;
        struct sr_probe *probe;
+       struct sr_serial_dev_inst *serial;
        GSList *devices;
-       int fd, retry;
-       size_t len;
+       int retry;
+       size_t len, i, good_packets, dropped;
        char buf[128], *b;
+       const struct rs_22_812_packet *rs_packet;
 
-       if ((fd = serial_open(conn, O_RDWR|O_NONBLOCK)) == -1) {
-               sr_err("radioshack-dmm: unable to open %s: %s",
-                      conn, strerror(errno));
+       if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
                return NULL;
-       }
-       if (serial_set_paramstr(fd, serialcomm) != SR_OK) {
-               sr_err("radioshack-dmm: unable to set serial parameters");
+
+       if (serial_open(serial, O_RDONLY|O_NONBLOCK) != SR_OK)
                return NULL;
-       }
+
+       sr_info("Probing port '%s' readonly.", conn);
 
        drvc = di->priv;
        b = buf;
        retry = 0;
        devices = NULL;
-       /* There's no way to get an ID from the multimeter. It just sends data
-        * periodically, so the best we can do is check if the packets match the
-        * expected format. */
-       while (!devices && retry < 3)
-       {
-               size_t i;
-               size_t good_packets = 0;
+
+       /*
+        * There's no way to get an ID from the multimeter. It just sends data
+        * periodically, so the best we can do is check if the packets match
+        * the expected format.
+        */
+       while (!devices && retry < 3) {
+               good_packets = 0;
                retry++;
-               serial_flush(fd);
+               serial_flush(serial);
 
-               /* Let's get a bit of data and see if we can find a packet */
+               /* Let's get a bit of data and see if we can find a packet. */
                len = sizeof(buf);
-               serial_readline(fd, &b, &len, 250);
-               if( (len == 0) || (len < RS_22_812_PACKET_SIZE) ) {
-                       /* Not enough data received, is the DMM connected ? */
+               serial_readline(serial, &b, &len, 250);
+               if ((len == 0) || (len < RS_22_812_PACKET_SIZE)) {
+                       /* Not enough data received, is the DMM connected? */
                        continue;
                }
 
-               /* Let's treat our buffer like a stream, and find any
-                * valid packets */
-               for( i = 0; i < len - RS_22_812_PACKET_SIZE + 1;
-                   /* don't increment i here */ )
-               {
-                       const rs_22_812_packet *packet = (void *)(&buf[i]);
-                       if( !rs_22_812_is_packet_valid(packet) ){
+               /* Treat our buffer as stream, and find any valid packets. */
+               for (i = 0; i < len - RS_22_812_PACKET_SIZE + 1;) {
+                       rs_packet = (void *)(&buf[i]);
+                       if (!rs_22_812_packet_valid(rs_packet)) {
                                i++;
                                continue;
                        }
@@ -186,27 +146,27 @@ static GSList *rs_22_812_scan(const char *conn, const char *serialcomm)
                        i += RS_22_812_PACKET_SIZE;
                }
 
-               /* If we dropped more than two packets worth of data, something
-                * is wrong */
-               size_t dropped = len - (good_packets * RS_22_812_PACKET_SIZE);
-               if(dropped > 2 * RS_22_812_PACKET_SIZE)
+               /* If we dropped more than two packets, something is wrong. */
+               dropped = len - (good_packets * RS_22_812_PACKET_SIZE);
+               if (dropped > 2 * RS_22_812_PACKET_SIZE)
                        continue;
 
-               /* Let's see if we have anything good */
+               /* Let's see if we have anything good. */
                if (good_packets == 0)
                        continue;
 
-               if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Radioshack",
+               sr_info("Found RadioShack 22-812 on port '%s'.", conn);
+
+               if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "RadioShack",
                                            "22-812", "")))
                        return NULL;
+
                if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
-                       sr_dbg("radioshack-dmm: failed to malloc devc");
+                       sr_err("Device context malloc failed.");
                        return NULL;
                }
 
-               /* devc->profile = RADIOSHACK_22_812; */
-               devc->serial = sr_serial_dev_inst_new(conn, -1);
-               devc->serialcomm = g_strdup(serialcomm);
+               devc->serial = serial;
 
                sdi->priv = devc;
                sdi->driver = di;
@@ -216,14 +176,13 @@ static GSList *rs_22_812_scan(const char *conn, const char *serialcomm)
                drvc->instances = g_slist_append(drvc->instances, sdi);
                devices = g_slist_append(devices, sdi);
                break;
-
        }
-       serial_close(fd);
+       serial_close(serial);
 
        return devices;
 }
 
-static GSList *hw_scan(GSList *options)
+static GSList *hw_scan(GSList * options)
 {
        struct sr_hwopt *opt;
        GSList *l, *devices;
@@ -244,13 +203,12 @@ static GSList *hw_scan(GSList *options)
        if (!conn)
                return NULL;
 
-       if (serialcomm) {
+       if (serialcomm)
                /* Use the provided comm specs. */
                devices = rs_22_812_scan(conn, serialcomm);
-       } else {
-               /* Then try the default 4800 8n1 */
-               devices = rs_22_812_scan(conn, "4800/8n1");
-       }
+       else
+               /* Try the default. */
+               devices = rs_22_812_scan(conn, SERIALCOMM);
 
        return devices;
 }
@@ -269,20 +227,13 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
        struct dev_context *devc;
 
        if (!(devc = sdi->priv)) {
-               sr_err("radioshack-dmm: sdi->priv was NULL.");
+               sr_err("sdi->priv was NULL.");
                return SR_ERR_BUG;
        }
 
-       devc->serial->fd = serial_open(devc->serial->port, O_RDWR | O_NONBLOCK);
-       if (devc->serial->fd == -1) {
-               sr_err("radioshack-dmm: Couldn't open serial port '%s'.",
-                      devc->serial->port);
+       if (serial_open(devc->serial, O_RDONLY) != SR_OK)
                return SR_ERR;
-       }
-       if (serial_set_paramstr(devc->serial->fd, devc->serialcomm) != SR_OK) {
-               sr_err("radioshack-dmm: unable to set serial parameters");
-               return SR_ERR;
-       }
+
        sdi->status = SR_ST_ACTIVE;
 
        return SR_OK;
@@ -293,13 +244,12 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
        struct dev_context *devc;
 
        if (!(devc = sdi->priv)) {
-               sr_err("radioshack-dmm: sdi->priv was NULL.");
+               sr_err("sdi->priv was NULL.");
                return SR_ERR_BUG;
        }
 
        if (devc->serial && devc->serial->fd != -1) {
-               serial_close(devc->serial->fd);
-               devc->serial->fd = -1;
+               serial_close(devc->serial);
                sdi->status = SR_ST_INACTIVE;
        }
 
@@ -314,9 +264,9 @@ static int hw_cleanup(void)
 }
 
 static int hw_info_get(int info_id, const void **data,
-       const struct sr_dev_inst *sdi)
+                      const struct sr_dev_inst *sdi)
 {
-       (void)sdi; /* Does nothing. prevents "unused parameter" warning */
+       (void)sdi;
 
        switch (info_id) {
        case SR_DI_HWOPTS:
@@ -332,6 +282,7 @@ static int hw_info_get(int info_id, const void **data,
                *data = probe_names;
                break;
        default:
+               sr_err("Unknown info_id: %d.", info_id);
                return SR_ERR_ARG;
        }
 
@@ -339,7 +290,7 @@ static int hw_info_get(int info_id, const void **data,
 }
 
 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
-               const void *value)
+                            const void *value)
 {
        struct dev_context *devc;
 
@@ -347,19 +298,19 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
                return SR_ERR;
 
        if (!(devc = sdi->priv)) {
-               sr_err("radioshack-dmm: sdi->priv was NULL.");
+               sr_err("sdi->priv was NULL.");
                return SR_ERR_BUG;
        }
 
        switch (hwcap) {
        case SR_HWCAP_LIMIT_SAMPLES:
                devc->limit_samples = *(const uint64_t *)value;
-               sr_dbg("radioshack-dmm: Setting sample limit to %" PRIu64 ".",
+               sr_dbg("Setting sample limit to %" PRIu64 ".",
                       devc->limit_samples);
                break;
        default:
-               sr_err("radioshack-dmm: Unknown capability: %d.", hwcap);
-               return SR_ERR;
+               sr_err("Unknown capability: %d.", hwcap);
+               return SR_ERR_ARG;
                break;
        }
 
@@ -367,7 +318,7 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 }
 
 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
-               void *cb_data)
+                                   void *cb_data)
 {
        struct sr_datafeed_packet packet;
        struct sr_datafeed_header header;
@@ -375,38 +326,44 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        struct dev_context *devc;
 
        if (!(devc = sdi->priv)) {
-               sr_err("radioshack-dmm: sdi->priv was NULL.");
+               sr_err("sdi->priv was NULL.");
                return SR_ERR_BUG;
        }
 
-       sr_dbg("radioshack-dmm: Starting acquisition.");
+       sr_dbg("Starting acquisition.");
 
        devc->cb_data = cb_data;
 
+       /*
+        * Reset the number of samples to take. If we've already collected our
+        * quota, but we start a new session, and don't reset this, we'll just
+        * quit without aquiring any new samples.
+        */
+       devc->num_samples = 0;
+
        /* Send header packet to the session bus. */
-       sr_dbg("radioshack-dmm: Sending SR_DF_HEADER.");
+       sr_dbg("Sending SR_DF_HEADER.");
        packet.type = SR_DF_HEADER;
-       packet.payload = (uint8_t *)&header;
+       packet.payload = (uint8_t *) & header;
        header.feed_version = 1;
        gettimeofday(&header.starttime, NULL);
        sr_session_send(devc->cb_data, &packet);
 
        /* Send metadata about the SR_DF_ANALOG packets to come. */
-       sr_dbg("radioshack-dmm: Sending SR_DF_META_ANALOG.");
+       sr_dbg("Sending SR_DF_META_ANALOG.");
        packet.type = SR_DF_META_ANALOG;
        packet.payload = &meta;
        meta.num_probes = 1;
        sr_session_send(devc->cb_data, &packet);
 
-       /* Poll every 100ms, or whenever some data comes in. */
+       /* Poll every 50ms, or whenever some data comes in. */
        sr_source_add(devc->serial->fd, G_IO_IN, 50,
-                     radioshack_receive_data, (void *)sdi );
+                     radioshack_dmm_receive_data, (void *)sdi);
 
        return SR_OK;
 }
 
-static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
-               void *cb_data)
+static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
        struct sr_datafeed_packet packet;
        struct dev_context *devc;
@@ -415,17 +372,17 @@ static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
                return SR_ERR;
 
        if (!(devc = sdi->priv)) {
-               sr_err("radioshack-dmm: sdi->priv was NULL.");
+               sr_err("sdi->priv was NULL.");
                return SR_ERR_BUG;
        }
 
-       sr_dbg("radioshack-dmm: Stopping acquisition.");
+       sr_dbg("Stopping acquisition.");
 
        sr_source_remove(devc->serial->fd);
        hw_dev_close((struct sr_dev_inst *)sdi);
 
        /* Send end packet to the session bus. */
-       sr_dbg("radioshack-dmm: Sending SR_DF_END.");
+       sr_dbg("Sending SR_DF_END.");
        packet.type = SR_DF_END;
        sr_session_send(cb_data, &packet);
 
@@ -434,7 +391,7 @@ static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
 
 SR_PRIV struct sr_dev_driver radioshackdmm_driver_info = {
        .name = "radioshack-dmm",
-       .longname = "Radioshack 22-812/22-039 DMMs",
+       .longname = "RadioShack 22-812/22-039 DMMs",
        .api_version = 1,
        .init = hw_init,
        .cleanup = hw_cleanup,