]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/brymen-dmm/api.c
dmm/bm85x: introduce DMM packet parser for Brymen BM850(a/s)
[libsigrok.git] / src / hardware / brymen-dmm / api.c
index 1dcf205ca3000da0c14f2365283d490b1f5eed4d..dacbee889267f7949e4e18ca08daa20ef31110b3 100644 (file)
@@ -25,27 +25,23 @@ static const uint32_t scanopts[] = {
        SR_CONF_SERIALCOMM,
 };
 
-static const uint32_t devopts[] = {
+static const uint32_t drvopts[] = {
        SR_CONF_MULTIMETER,
+};
+
+static const uint32_t devopts[] = {
        SR_CONF_CONTINUOUS,
        SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
        SR_CONF_LIMIT_MSEC | SR_CONF_SET,
 };
 
-SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
-static struct sr_dev_driver *di = &brymen_bm857_driver_info;
-
-static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
-{
-       return std_init(sr_ctx, di, LOG_PREFIX);
-}
-
-static GSList *brymen_scan(const char *conn, const char *serialcomm)
+static GSList *brymen_scan(struct sr_dev_driver *di, const char *conn,
+       const char *serialcomm)
 {
        struct sr_dev_inst *sdi;
        struct dev_context *devc;
-       struct drv_context *drvc;
        struct sr_serial_dev_inst *serial;
+       int rts_toggle_delay_us;
        GSList *devices;
        int ret;
        uint8_t buf[128];
@@ -55,6 +51,21 @@ static GSList *brymen_scan(const char *conn, const char *serialcomm)
 
        if (serial_open(serial, SERIAL_RDWR) != SR_OK)
                return NULL;
+       /*
+        * The device requires an RTS *pulse* before communication.
+        * The vendor's documentation recommends the following sequence:
+        * Open the COM port, wait for 100ms, set RTS=1, wait for 100ms,
+        * set RTS=0, wait for 100ms, set RTS=1, configure bitrate and
+        * frame format, transmit request data, receive response data.
+        */
+       rts_toggle_delay_us = 100 * 1000; /* 100ms */
+       g_usleep(rts_toggle_delay_us);
+       serial_set_handshake(serial, 1, -1);
+       g_usleep(rts_toggle_delay_us);
+       serial_set_handshake(serial, 0, -1);
+       g_usleep(rts_toggle_delay_us);
+       serial_set_handshake(serial, 1, -1);
+       g_usleep(rts_toggle_delay_us);
 
        sr_info("Probing port %s.", conn);
 
@@ -66,7 +77,7 @@ static GSList *brymen_scan(const char *conn, const char *serialcomm)
                goto scan_cleanup;
        }
 
-       len = 128;
+       len = sizeof(buf);
        ret = brymen_stream_detect(serial, buf, &len, brymen_packet_length,
                             brymen_packet_is_valid, 1000, 9600);
        if (ret != SR_OK)
@@ -79,33 +90,33 @@ static GSList *brymen_scan(const char *conn, const char *serialcomm)
        sdi->vendor = g_strdup("Brymen");
        sdi->model = g_strdup("BM85x");
        devc = g_malloc0(sizeof(struct dev_context));
+       sr_sw_limits_init(&devc->sw_limits);
        sdi->inst_type = SR_INST_SERIAL;
        sdi->conn = serial;
-       drvc = di->context;
        sdi->priv = devc;
-       sdi->driver = di;
        sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
-       drvc->instances = g_slist_append(drvc->instances, sdi);
        devices = g_slist_append(devices, sdi);
 
 scan_cleanup:
        serial_close(serial);
 
-       return devices;
+       return std_scan_complete(di, devices);
 }
 
 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
-       struct drv_context *drvc;
        struct sr_config *src;
        GSList *devices, *l;
        const char *conn, *serialcomm;
 
        devices = NULL;
-       drvc = di->context;
-       drvc->instances = NULL;
 
-       conn = serialcomm = NULL;
+       /*
+        * BEWARE! Default 'conn' is not desirable when the device cannot
+        * reliably get detected. Insist that users specify the port.
+        */
+       conn = NULL;
+       serialcomm = "9600/8n1/dtr=1/rts=1";
        for (l = options; l; l = l->next) {
                src = l->data;
                switch (src->key) {
@@ -120,78 +131,27 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        if (!conn)
                return NULL;
 
-       if (serialcomm) {
-               /* Use the provided comm specs. */
-               devices = brymen_scan(conn, serialcomm);
-       } else {
-               /* But 9600/8n1 should work all of the time. */
-               devices = brymen_scan(conn, "9600/8n1/dtr=1/rts=1");
-       }
+       devices = brymen_scan(di, conn, serialcomm);
 
        return devices;
 }
 
-static GSList *dev_list(const struct sr_dev_driver *di)
-{
-       return ((struct drv_context *)(di->context))->instances;
-}
-
-static int cleanup(const struct sr_dev_driver *di)
-{
-       return std_dev_clear(di, NULL);
-}
-
-static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_set(uint32_t key, GVariant *data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
-       int ret;
 
        (void)cg;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
-       if (!(devc = sdi->priv)) {
-               sr_err("sdi->priv was NULL.");
-               return SR_ERR_BUG;
-       }
-
-       ret = SR_OK;
-       switch (key) {
-       case SR_CONF_LIMIT_SAMPLES:
-               devc->limit_samples = g_variant_get_uint64(data);
-               break;
-       case SR_CONF_LIMIT_MSEC:
-               devc->limit_msec = g_variant_get_uint64(data);
-               break;
-       default:
-               ret = SR_ERR_NA;
-       }
+       devc = sdi->priv;
 
-       return ret;
+       return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 }
 
-static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_list(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       (void)sdi;
-       (void)cg;
-
-       switch (key) {
-       case SR_CONF_SCAN_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
-               break;
-       case SR_CONF_DEVICE_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
-               break;
-       default:
-               return SR_ERR_NA;
-       }
-
-       return SR_OK;
+       return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 }
 
 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
@@ -199,22 +159,11 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        struct dev_context *devc;
        struct sr_serial_dev_inst *serial;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
 
-       /*
-        * 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 acquiring any new samples.
-        */
-       devc->num_samples = 0;
-       devc->starttime = g_get_monotonic_time();
+       sr_sw_limits_acquisition_start(&devc->sw_limits);
+       std_session_send_df_header(sdi);
 
-       std_session_send_df_header(sdi, LOG_PREFIX);
-
-       /* Poll every 50ms, or whenever some data comes in. */
        serial = sdi->conn;
        serial_source_add(sdi->session, serial, G_IO_IN, 50,
                        brymen_dmm_receive_data, (void *)sdi);
@@ -222,27 +171,22 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-static int dev_acquisition_stop(struct sr_dev_inst *sdi)
-{
-       return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
-                       sdi->conn, LOG_PREFIX);
-}
-
-SR_PRIV struct sr_dev_driver brymen_bm857_driver_info = {
+static struct sr_dev_driver brymen_bm857_driver_info = {
        .name = "brymen-bm857",
        .longname = "Brymen BM857",
        .api_version = 1,
-       .init = init,
-       .cleanup = cleanup,
+       .init = std_init,
+       .cleanup = std_cleanup,
        .scan = scan,
-       .dev_list = dev_list,
-       .dev_clear = NULL,
+       .dev_list = std_dev_list,
+       .dev_clear = std_dev_clear,
        .config_get = NULL,
        .config_set = config_set,
        .config_list = config_list,
        .dev_open = std_serial_dev_open,
        .dev_close = std_serial_dev_close,
        .dev_acquisition_start = dev_acquisition_start,
-       .dev_acquisition_stop = dev_acquisition_stop,
+       .dev_acquisition_stop = std_serial_dev_acquisition_stop,
        .context = NULL,
 };
+SR_REGISTER_DEV_DRIVER(brymen_bm857_driver_info);