]> sigrok.org Git - libsigrok.git/blobdiff - hardware/serial-dmm/api.c
Add and use std_session_send_df_header().
[libsigrok.git] / hardware / serial-dmm / api.c
index 23cb9b356363cc2a504159e4f426965447e9bdcb..b6920819870ab3830629d9a189c95b2464c34ee5 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include <glib.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <string.h>
 #include <errno.h>
+#include <glib.h>
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 #include "protocol.h"
 
 static const int hwopts[] = {
-       SR_HWOPT_CONN,
-       SR_HWOPT_SERIALCOMM,
+       SR_CONF_CONN,
+       SR_CONF_SERIALCOMM,
        0,
 };
 
 static const int hwcaps[] = {
-       SR_HWCAP_MULTIMETER,
-       SR_HWCAP_LIMIT_SAMPLES,
-       SR_HWCAP_CONTINUOUS,
+       SR_CONF_MULTIMETER,
+       SR_CONF_LIMIT_SAMPLES,
+       SR_CONF_LIMIT_MSEC,
+       SR_CONF_CONTINUOUS,
        0,
 };
 
-static const char *probe_names[] = {
-       "Probe",
-       NULL,
-};
-
 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
 SR_PRIV struct sr_dev_driver metex_me31_driver_info;
@@ -58,9 +54,9 @@ SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
 SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
-
-/* After hw_init() this will point to a device-specific entry (see above). */
-static struct sr_dev_driver *di = NULL;
+SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
+SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
+SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
 
 SR_PRIV struct dmm_info dmms[] = {
        {
@@ -140,19 +136,41 @@ SR_PRIV struct dmm_info dmms[] = {
                NULL,
                &radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
        },
+       {
+               "Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
+               2400, FS9721_PACKET_SIZE, NULL,
+               sr_fs9721_packet_valid, sr_fs9721_parse,
+               NULL,
+               &voltcraft_vc820_ser_driver_info,
+               receive_data_VOLTCRAFT_VC820_SER,
+       },
+       {
+               "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
+               2400, FS9721_PACKET_SIZE, NULL,
+               sr_fs9721_packet_valid, sr_fs9721_parse,
+               NULL,
+               &voltcraft_vc840_ser_driver_info,
+               receive_data_VOLTCRAFT_VC840_SER,
+       },
+       {
+               /* Note: ES51922 baudrate is actually 19230! */
+               "UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
+               19200, ES51922_PACKET_SIZE, NULL,
+               sr_es51922_packet_valid, sr_es51922_parse, NULL,
+               &uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
+       },
 };
 
 /* Properly close and free all devices. */
-static int clear_instances(void)
+static int clear_instances(int dmm)
 {
        struct sr_dev_inst *sdi;
        struct drv_context *drvc;
        struct dev_context *devc;
        GSList *l;
+       struct sr_dev_driver *di;
 
-       /* di is not necessarily initialized */
-       if (!di)
-               return SR_OK;
+       di = dmms[dmm].di;
 
        if (!(drvc = di->priv))
                return SR_OK;
@@ -174,38 +192,11 @@ static int clear_instances(void)
 
 static int hw_init(struct sr_context *sr_ctx, int dmm)
 {
-       struct drv_context *drvc;
-
-       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("Driver context malloc failed.");
-               return SR_ERR_MALLOC;
-       }
-
-       di = dmms[dmm].di;
        sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
 
-       drvc->sr_ctx = sr_ctx;
-       //// di->priv = drvc;
-       dmms[dmm].di->priv = drvc;
-
-       return SR_OK;
+       return std_hw_init(sr_ctx, dmms[dmm].di, DRIVER_LOG_DOMAIN);
 }
 
-/* Driver-specific hw_init() function wrappers */
-#define HW_INIT(X) static int hw_init_##X(struct sr_context *sr_ctx) \
-                               { return hw_init(sr_ctx, X); }
-HW_INIT(DIGITEK_DT4000ZC)
-HW_INIT(TEKPOWER_TP4000ZC)
-HW_INIT(METEX_ME31)
-HW_INIT(PEAKTECH_3410)
-HW_INIT(MASTECH_MAS345)
-HW_INIT(VA_VA18B)
-HW_INIT(METEX_M3640D)
-HW_INIT(PEAKTECH_4370)
-HW_INIT(PCE_PCE_DM32)
-HW_INIT(RADIOSHACK_22_168)
-HW_INIT(RADIOSHACK_22_812)
-
 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
 {
        struct sr_dev_inst *sdi;
@@ -224,22 +215,12 @@ static GSList *scan(const char *conn, const char *serialcomm, int dmm)
        if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
                return NULL;
 
-       sr_info("Probing port %s.", conn);
+       sr_info("Probing serial port %s.", conn);
 
-       //// drvc = di->priv;
        drvc = dmms[dmm].di->priv;
        devices = NULL;
        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);
-
        /* Request a packet if the DMM requires this. */
        if (dmms[dmm].packet_request) {
                if ((ret = dmms[dmm].packet_request(serial)) < 0) {
@@ -248,6 +229,14 @@ static GSList *scan(const char *conn, const char *serialcomm, int dmm)
                }
        }
 
+       /*
+        * There's no way to get an ID from the multimeter. It just sends data
+        * periodically (or upon request), 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, dmms[dmm].packet_size,
                                   dmms[dmm].packet_valid, 1000,
                                   dmms[dmm].baudrate);
@@ -258,8 +247,8 @@ static GSList *scan(const char *conn, const char *serialcomm, int dmm)
         * 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.
+        * combination of the nonstandard cable that ships with some devices
+        * and the serial port or USB to serial adapter.
         */
        dropped = len - dmms[dmm].packet_size;
        if (dropped > 2 * dmms[dmm].packet_size)
@@ -294,19 +283,19 @@ scan_cleanup:
 
 static GSList *hw_scan(GSList *options, int dmm)
 {
-       struct sr_hwopt *opt;
+       struct sr_config *src;
        GSList *l, *devices;
        const char *conn, *serialcomm;
 
        conn = serialcomm = NULL;
        for (l = options; l; l = l->next) {
-               opt = l->data;
-               switch (opt->hwopt) {
-               case SR_HWOPT_CONN:
-                       conn = opt->value;
+               src = l->data;
+               switch (src->key) {
+               case SR_CONF_CONN:
+                       conn = src->value;
                        break;
-               case SR_HWOPT_SERIALCOMM:
-                       serialcomm = opt->value;
+               case SR_CONF_SERIALCOMM:
+                       serialcomm = src->value;
                        break;
                }
        }
@@ -324,45 +313,11 @@ static GSList *hw_scan(GSList *options, int dmm)
        return devices;
 }
 
-/* Driver-specific hw_scan() function wrappers */
-#define HW_SCAN(X) static GSList *hw_scan_##X(GSList *options) \
-                               { return hw_scan(options, X); }
-HW_SCAN(DIGITEK_DT4000ZC)
-HW_SCAN(TEKPOWER_TP4000ZC)
-HW_SCAN(METEX_ME31)
-HW_SCAN(PEAKTECH_3410)
-HW_SCAN(MASTECH_MAS345)
-HW_SCAN(VA_VA18B)
-HW_SCAN(METEX_M3640D)
-HW_SCAN(PEAKTECH_4370)
-HW_SCAN(PCE_PCE_DM32)
-HW_SCAN(RADIOSHACK_22_168)
-HW_SCAN(RADIOSHACK_22_812)
-
 static GSList *hw_dev_list(int dmm)
 {
-       struct drv_context *drvc;
-
-       drvc = dmms[dmm].di->priv;
-
-       return drvc->instances;
+       return ((struct drv_context *)(dmms[dmm].di->priv))->instances;
 }
 
-/* Driver-specific hw_dev_list() function wrappers */
-#define HW_DEV_LIST(X) static GSList *hw_dev_list_##X(void) \
-                               { return hw_dev_list(X); }
-HW_DEV_LIST(DIGITEK_DT4000ZC)
-HW_DEV_LIST(TEKPOWER_TP4000ZC)
-HW_DEV_LIST(METEX_ME31)
-HW_DEV_LIST(PEAKTECH_3410)
-HW_DEV_LIST(MASTECH_MAS345)
-HW_DEV_LIST(VA_VA18B)
-HW_DEV_LIST(METEX_M3640D)
-HW_DEV_LIST(PEAKTECH_4370)
-HW_DEV_LIST(PCE_PCE_DM32)
-HW_DEV_LIST(RADIOSHACK_22_168)
-HW_DEV_LIST(RADIOSHACK_22_812)
-
 static int hw_dev_open(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
@@ -384,10 +339,7 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
-       if (!(devc = sdi->priv)) {
-               sr_err("sdi->priv was NULL.");
-               return SR_ERR_BUG;
-       }
+       devc = sdi->priv;
 
        if (devc->serial && devc->serial->fd != -1) {
                serial_close(devc->serial);
@@ -397,40 +349,14 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-static int hw_cleanup(void)
+static int hw_cleanup(int dmm)
 {
-       clear_instances();
+       clear_instances(dmm);
 
        return SR_OK;
 }
 
-static int hw_info_get(int info_id, const void **data,
-                      const struct sr_dev_inst *sdi)
-{
-       (void)sdi;
-
-       switch (info_id) {
-       case SR_DI_HWOPTS:
-               *data = hwopts;
-               break;
-       case SR_DI_HWCAPS:
-               *data = hwcaps;
-               break;
-       case SR_DI_NUM_PROBES:
-               *data = GINT_TO_POINTER(1);
-               break;
-       case SR_DI_PROBE_NAMES:
-               *data = probe_names;
-               break;
-       default:
-               return SR_ERR_ARG;
-       }
-
-       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;
 
@@ -442,14 +368,19 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
                return SR_ERR_BUG;
        }
 
-       switch (hwcap) {
-       case SR_HWCAP_LIMIT_SAMPLES:
+       switch (id) {
+       case SR_CONF_LIMIT_SAMPLES:
                devc->limit_samples = *(const uint64_t *)value;
                sr_dbg("Setting sample limit to %" PRIu64 ".",
                       devc->limit_samples);
                break;
+       case SR_CONF_LIMIT_MSEC:
+               devc->limit_msec = *(const uint64_t *)value;
+               sr_dbg("Setting time limit to %" PRIu64 "ms.",
+                      devc->limit_msec);
+               break;
        default:
-               sr_err("Unknown capability: %d.", hwcap);
+               sr_err("Unknown capability: %d.", id);
                return SR_ERR;
                break;
        }
@@ -457,12 +388,28 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
        return SR_OK;
 }
 
+static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
+{
+
+       (void)sdi;
+
+       switch (key) {
+       case SR_CONF_SCAN_OPTIONS:
+               *data = hwopts;
+               break;
+       case SR_CONF_DEVICE_OPTIONS:
+               *data = hwcaps;
+               break;
+       default:
+               return SR_ERR_ARG;
+       }
+
+       return SR_OK;
+}
+
 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+                                   void *cb_data, int dmm)
 {
-       struct sr_datafeed_packet packet;
-       struct sr_datafeed_header header;
-       struct sr_datafeed_meta_analog meta;
        struct dev_context *devc;
 
        if (!(devc = sdi->priv)) {
@@ -470,8 +417,6 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                return SR_ERR_BUG;
        }
 
-       sr_dbg("Starting acquisition.");
-
        devc->cb_data = cb_data;
 
        /*
@@ -480,25 +425,14 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
         * quit without acquiring any new samples.
         */
        devc->num_samples = 0;
+       devc->starttime = g_get_monotonic_time();
 
        /* Send header packet to the session bus. */
-       sr_dbg("Sending SR_DF_HEADER.");
-       packet.type = SR_DF_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("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);
+       std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 
        /* Poll every 50ms, or whenever some data comes in. */
        sr_source_add(devc->serial->fd, G_IO_IN, 50,
-                     dmms[sdi->driver->subdriver].receive_data, (void *)sdi);
+                     dmms[dmm].receive_data, (void *)sdi);
 
        return SR_OK;
 }
@@ -529,26 +463,47 @@ static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        return SR_OK;
 }
 
-/* Driver structs */
+/* Driver-specific API function wrappers */
+#define HW_INIT(X) \
+static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
+#define HW_CLEANUP(X) \
+static int hw_cleanup_##X(void) { return hw_cleanup(X); }
+#define HW_SCAN(X) \
+static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
+#define HW_DEV_LIST(X) \
+static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
+#define CLEAR_INSTANCES(X) \
+static int clear_instances_##X(void) { return clear_instances(X); }
+#define HW_DEV_ACQUISITION_START(X) \
+static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
+void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
+
+/* Driver structs and API function wrappers */
 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
+HW_INIT(ID_UPPER) \
+HW_CLEANUP(ID_UPPER) \
+HW_SCAN(ID_UPPER) \
+HW_DEV_LIST(ID_UPPER) \
+CLEAR_INSTANCES(ID_UPPER) \
+HW_DEV_ACQUISITION_START(ID_UPPER) \
 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
        .name = NAME, \
        .longname = LONGNAME, \
        .api_version = 1, \
        .init = hw_init_##ID_UPPER, \
-       .cleanup = hw_cleanup, \
+       .cleanup = hw_cleanup_##ID_UPPER, \
        .scan = hw_scan_##ID_UPPER, \
        .dev_list = hw_dev_list_##ID_UPPER, \
-       .dev_clear = clear_instances, \
+       .dev_clear = clear_instances_##ID_UPPER, \
+       .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_start = hw_dev_acquisition_start_##ID_UPPER, \
        .dev_acquisition_stop = hw_dev_acquisition_stop, \
        .priv = NULL, \
-       .subdriver = ID_UPPER, \
 };
+
 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
@@ -560,3 +515,6 @@ DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
+DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
+DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
+DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")