]> sigrok.org Git - libsigrok.git/blobdiff - hardware/tekpower-dmm/api.c
serial: RTS/DTR support on Windows/MinGW.
[libsigrok.git] / hardware / tekpower-dmm / api.c
index 1069935c91416b219dd148ba46faa9246bf4be07..dd53f4dd3d64b017fc4ac823f66c1799521ea0eb 100644 (file)
  */
 
 #include <glib.h>
-#include "libsigrok.h"
-#include "libsigrok-internal.h"
-#include "protocol.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 "2400/8n1"
 
 static const int hwopts[] = {
        SR_HWOPT_CONN,
@@ -46,8 +48,8 @@ static const char *probe_names[] = {
        NULL,
 };
 
-SR_PRIV struct sr_dev_driver tekpower_driver_info;
-static struct sr_dev_driver *di = &tekpower_driver_info;
+SR_PRIV struct sr_dev_driver tekpower_dmm_driver_info;
+static struct sr_dev_driver *di = &tekpower_dmm_driver_info;
 
 /* Properly close and free all devices. */
 static int clear_instances(void)
@@ -80,8 +82,8 @@ static int hw_init(void)
        struct drv_context *drvc;
 
        if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("driver context malloc failed.");
-               return SR_ERR;
+               sr_err("Driver context malloc failed.");
+               return SR_ERR_MALLOC;
        }
 
        di->priv = drvc;
@@ -89,134 +91,79 @@ 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 *lcd14_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;
+       int dropped, ret;
        size_t len;
-       char buf[128], *b;
+       uint8_t buf[128];
 
-       if ((fd = serial_open(conn, O_RDONLY|O_NONBLOCK)) == -1) {
-               sr_err("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("unable to set serial parameters");
+
+       if (serial_open(serial, SERIAL_RDONLY | SERIAL_NONBLOCK) != SR_OK)
                return NULL;
-       }
 
-       sr_info("probing port %s readonly", conn);
+       sr_info("Probing port %s readonly.", conn);
 
        drvc = di->priv;
-       b = buf;
-       retry = 0;
        devices = NULL;
-       serial_flush(fd);
-       /* 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;
-               retry++;
-
-               /* Let's get a bit of data and see if we can find a packet */
-               len = sizeof(buf);
-               serial_readline(fd, &b, &len, 500);
-               if( (len == 0) || (len < LCD14_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 - LCD14_PACKET_SIZE + 1;
-                   /* don't increment i here */ )
-               {
-                       const lcd14_packet *packet = (void *)(&buf[i]);
-                       if( !lcd14_is_packet_valid(packet, NULL) ){
-                               i++;
-                               continue;
-                       }
-                       good_packets++;
-                       i += LCD14_PACKET_SIZE;
-               }
-
-               /* If we dropped more than two packets worth of data, something
-                * is wrong */
-               size_t dropped = len - (good_packets * LCD14_PACKET_SIZE);
-               if(dropped > 2 * LCD14_PACKET_SIZE)
-                       continue;
-
-               /* Let's see if we have anything good */
-               if (good_packets == 0)
-                       continue;
+       serial_flush(serial);
+
+       /*
+        * 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.
+        */
+
+       /* Let's get a bit of data and see if we can find a packet. */
+       len = sizeof(buf);
+
+       ret = serial_stream_detect(serial, buf, &len, FS9721_PACKET_SIZE,
+                                  sr_fs9721_packet_valid, 1000, 2400);
+       if (ret != SR_OK)
+               goto scan_cleanup;
+
+       /*
+        * If we dropped more than two packets worth of data, something is
+        * wrong. We shouldn't quit however, since the dropped bytes might be
+        * just zeroes at the beginning of the stream. Those can occur as a
+        * combination of the nonstandard cable that ships with this device and
+        * the serial port or USB to serial adapter.
+        */
+       dropped = len - FS9721_PACKET_SIZE;
+       if (dropped > 2 * FS9721_PACKET_SIZE)
+               sr_warn("Had to drop too much data.");
+
+       sr_info("Found device on port %s.", conn);
+
+       if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "TekPower",
+                                   "TP4000ZC", "")))
+               goto scan_cleanup;
+
+       if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
+               sr_err("Device context malloc failed.");
+               goto scan_cleanup;
+       }
 
-               sr_info("found device on port %s", conn);
+       devc->serial = serial;
 
-               if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "TekPower",
-                                           "TP4000ZC", "")))
-                       return NULL;
-               if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
-                       sr_dbg("failed to malloc devc");
-                       return NULL;
-               }
+       sdi->priv = devc;
+       sdi->driver = di;
+       if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
+               goto scan_cleanup;
+       sdi->probes = g_slist_append(sdi->probes, probe);
+       drvc->instances = g_slist_append(drvc->instances, sdi);
+       devices = g_slist_append(devices, sdi);
 
-               /* devc->profile = RADIOSHACK_22_812; */
-               devc->serial = sr_serial_dev_inst_new(conn, -1);
-               devc->serialcomm = g_strdup(serialcomm);
-
-               sdi->priv = devc;
-               sdi->driver = di;
-               if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
-                       return NULL;
-               sdi->probes = g_slist_append(sdi->probes, probe);
-               drvc->instances = g_slist_append(drvc->instances, sdi);
-               devices = g_slist_append(devices, sdi);
-               break;
-       }
+scan_cleanup:
+       serial_close(serial);
 
-       serial_close(fd);
        return devices;
 }
 
@@ -245,8 +192,8 @@ static GSList *hw_scan(GSList *options)
                /* Use the provided comm specs. */
                devices = lcd14_scan(conn, serialcomm);
        } else {
-               /* Then try the default 2400 8n1 */
-               devices = lcd14_scan(conn, "2400/8n1");
+               /* Try the default. */
+               devices = lcd14_scan(conn, SERIALCOMM);
        }
 
        return devices;
@@ -270,16 +217,9 @@ static int hw_dev_open(struct sr_dev_inst *sdi)
                return SR_ERR_BUG;
        }
 
-       devc->serial->fd = serial_open(devc->serial->port, O_RDONLY);
-       if (devc->serial->fd == -1) {
-               sr_err("Couldn't open serial port '%s'.",
-                      devc->serial->port);
+       if (serial_open(devc->serial, SERIAL_RDONLY) != SR_OK)
                return SR_ERR;
-       }
-       if (serial_set_paramstr(devc->serial->fd, devc->serialcomm) != SR_OK) {
-               sr_err("unable to set serial parameters");
-               return SR_ERR;
-       }
+
        sdi->status = SR_ST_ACTIVE;
 
        return SR_OK;
@@ -295,8 +235,7 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
        }
 
        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;
        }
 
@@ -311,9 +250,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:
@@ -336,7 +275,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;
 
@@ -364,7 +303,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;
@@ -380,9 +319,11 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 
        devc->cb_data = cb_data;
 
-       /* Reset the number of samples to take. If we've already collected our
+       /*
+        * 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 */
+        * quit without acquiring any new samples.
+        */
        devc->num_samples = 0;
 
        /* Send header packet to the session bus. */
@@ -400,15 +341,14 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        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,
-                     lcd14_receive_data, (void *)sdi );
+                     tekpower_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;
@@ -434,9 +374,9 @@ static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver tekpower_driver_info = {
+SR_PRIV struct sr_dev_driver tekpower_dmm_driver_info = {
        .name = "tekpower-dmm",
-       .longname = "TekPower/Digitek 4000ZC",
+       .longname = "TekPower/Digitek TP4000ZC/DT4000ZC DMM",
        .api_version = 1,
        .init = hw_init,
        .cleanup = hw_cleanup,