]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/serial-dmm/api.c
serial-dmm: more DMM parser callbacks (open, var length, config, start)
[libsigrok.git] / src / hardware / serial-dmm / api.c
index 6651e80231b408fe22fcbb5a41062958af981793..660f20802ac9f7289c86a3f788dc461d1a78aeac 100644 (file)
@@ -40,8 +40,8 @@ static const uint32_t drvopts[] = {
 
 static const uint32_t devopts[] = {
        SR_CONF_CONTINUOUS,
-       SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
-       SR_CONF_LIMIT_MSEC | SR_CONF_SET,
+       SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
 };
 
 static GSList *scan(struct sr_dev_driver *di, GSList *options)
@@ -53,8 +53,8 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        struct sr_dev_inst *sdi;
        struct dev_context *devc;
        struct sr_serial_dev_inst *serial;
-       int dropped, ret;
-       size_t len;
+       int ret;
+       size_t dropped, len, packet_len;
        uint8_t buf[128];
        size_t ch_idx;
        char ch_name[12];
@@ -81,16 +81,23 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
 
        if (serial_open(serial, SERIAL_RDWR) != SR_OK)
                return NULL;
-
        sr_info("Probing serial port %s.", conn);
 
+       if (dmm->after_open) {
+               ret = dmm->after_open(serial);
+               if (ret != SR_OK) {
+                       sr_err("Activity after port open failed: %d.", ret);
+                       return NULL;
+               }
+       }
+
        devices = NULL;
 
        /* Request a packet if the DMM requires this. */
        if (dmm->packet_request) {
                if ((ret = dmm->packet_request(serial)) < 0) {
                        sr_err("Failed to request packet: %d.", ret);
-                       return FALSE;
+                       return NULL;
                }
        }
 
@@ -98,37 +105,43 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
         * 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, dmm->packet_size,
-                                  dmm->packet_valid, NULL, NULL, 3000);
-       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 some devices
         * and the serial port or USB to serial adapter.
         */
+       len = sizeof(buf);
+       ret = serial_stream_detect(serial, buf, &len, dmm->packet_size,
+               dmm->packet_valid, dmm->packet_valid_len, &packet_len, 3000);
+       if (ret != SR_OK)
+               goto scan_cleanup;
        dropped = len - dmm->packet_size;
-       if (dropped > 2 * dmm->packet_size)
-               sr_warn("Had to drop too much data.");
-
+       if (dropped > 2 * packet_len)
+               sr_warn("Packet search dropped a lot of data.");
        sr_info("Found device on port %s.", conn);
 
-       sdi = g_malloc0(sizeof(struct sr_dev_inst));
+       /*
+        * Setup optional additional callbacks when sub device drivers
+        * happen to provide them. (This is a compromise to do it here,
+        * and not extend the DMM_CONN() et al set of macros.)
+        */
+       if (dmm->dmm_state_init)
+               dmm->dmm_state = dmm->dmm_state_init();
+
+       /* Setup the device instance. */
+       sdi = g_malloc0(sizeof(*sdi));
        sdi->status = SR_ST_INACTIVE;
        sdi->vendor = g_strdup(dmm->vendor);
        sdi->model = g_strdup(dmm->device);
-       devc = g_malloc0(sizeof(struct dev_context));
+       devc = g_malloc0(sizeof(*devc));
        sr_sw_limits_init(&devc->limits);
        sdi->inst_type = SR_INST_SERIAL;
        sdi->conn = serial;
        sdi->priv = devc;
+
+       /* Create (optionally device dependent) channel(s). */
        dmm->channel_count = 1;
        if (dmm->packet_parse == sr_brymen_bm52x_parse)
                dmm->channel_count = BRYMEN_BM52X_DISPLAY_COUNT;
@@ -154,6 +167,8 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                snprintf(ch_name, sizeof(ch_name), fmt, ch_num);
                sr_channel_new(sdi, ch_idx, SR_CHANNEL_ANALOG, TRUE, ch_name);
        }
+
+       /* Add found device to result set. */
        devices = g_slist_append(devices, sdi);
 
 scan_cleanup:
@@ -162,27 +177,85 @@ scan_cleanup:
        return std_scan_complete(di, devices);
 }
 
-static int config_set(uint32_t key, GVariant *data,
+static int config_get(uint32_t key, GVariant **data,
        const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
+       struct dmm_info *dmm;
 
-       (void)cg;
+       if (!sdi)
+               return SR_ERR_ARG;
+       devc = sdi->priv;
+
+       switch (key) {
+       case SR_CONF_LIMIT_SAMPLES:
+       case SR_CONF_LIMIT_FRAMES:
+       case SR_CONF_LIMIT_MSEC:
+               return sr_sw_limits_config_get(&devc->limits, key, data);
+       default:
+               dmm = (struct dmm_info *)sdi->driver;
+               if (!dmm || !dmm->config_get)
+                       return SR_ERR_NA;
+               return dmm->config_get(dmm->dmm_state, key, data, sdi, cg);
+       }
+       /* UNREACH */
+}
+
+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;
+       struct dmm_info *dmm;
 
+       if (!sdi)
+               return SR_ERR_ARG;
        devc = sdi->priv;
+       (void)cg;
 
-       return sr_sw_limits_config_set(&devc->limits, key, data);
+       switch (key) {
+       case SR_CONF_LIMIT_SAMPLES:
+       case SR_CONF_LIMIT_FRAMES:
+       case SR_CONF_LIMIT_MSEC:
+               return sr_sw_limits_config_set(&devc->limits, key, data);
+       default:
+               dmm = (struct dmm_info *)sdi->driver;
+               if (!dmm || !dmm->config_set)
+                       return SR_ERR_NA;
+               return dmm->config_set(dmm->dmm_state, key, data, sdi, cg);
+       }
 }
 
 static int config_list(uint32_t key, GVariant **data,
        const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
+       struct dmm_info *dmm;
+       int ret;
+
+       /* Use common logic for standard keys. */
+       if (!sdi)
+               return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
+
+       /*
+        * Check for device specific config_list handler. ERR N/A from
+        * that handler is non-fatal, just falls back to common logic.
+        */
+       dmm = (struct dmm_info *)sdi->driver;
+       if (dmm && dmm->config_list) {
+               ret = dmm->config_list(dmm->dmm_state, key, data, sdi, cg);
+               if (ret != SR_ERR_NA)
+                       return ret;
+       }
+
        return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 }
 
 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
+       struct dmm_info *dmm;
+       sr_receive_data_callback cb_func;
+       void *cb_data;
+       int ret;
        struct sr_serial_dev_inst *serial;
 
        devc = sdi->priv;
@@ -190,16 +263,28 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        sr_sw_limits_acquisition_start(&devc->limits);
        std_session_send_df_header(sdi);
 
+       cb_func = receive_data;
+       cb_data = (void *)sdi;
+       dmm = (struct dmm_info *)sdi->driver;
+       if (dmm && dmm->acquire_start) {
+               ret = dmm->acquire_start(dmm->dmm_state, sdi,
+                       &cb_func, &cb_data);
+               if (ret < 0)
+                       return ret;
+       }
+
        serial = sdi->conn;
        serial_source_add(sdi->session, serial, G_IO_IN, 50,
-                     receive_data, (void *)sdi);
+               cb_func, cb_data);
 
        return SR_OK;
 }
 
-#define DMM_CONN(ID, CHIPSET, VENDOR, MODEL, \
+#define DMM_ENTRY(ID, CHIPSET, VENDOR, MODEL, \
                CONN, SERIALCOMM, PACKETSIZE, TIMEOUT, DELAY, \
-               REQUEST, VALID, PARSE, DETAILS) \
+               OPEN, REQUEST, VALID, PARSE, DETAILS, \
+               INIT_STATE, FREE_STATE, VALID_LEN, PARSE_LEN, \
+               CFG_GET, CFG_SET, CFG_LIST, ACQ_START) \
        &((struct dmm_info) { \
                { \
                        .name = ID, \
@@ -210,7 +295,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
                        .scan = scan, \
                        .dev_list = std_dev_list, \
                        .dev_clear = std_dev_clear, \
-                       .config_get = NULL, \
+                       .config_get = config_get, \
                        .config_set = config_set, \
                        .config_list = config_list, \
                        .dev_open = std_serial_dev_open, \
@@ -220,13 +305,34 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
                        .context = NULL, \
                }, \
                VENDOR, MODEL, CONN, SERIALCOMM, PACKETSIZE, TIMEOUT, DELAY, \
-               REQUEST, 1, NULL, VALID, PARSE, DETAILS, sizeof(struct CHIPSET##_info) \
+               REQUEST, 1, NULL, VALID, PARSE, DETAILS, \
+               sizeof(struct CHIPSET##_info), \
+               NULL, INIT_STATE, FREE_STATE, \
+               OPEN, VALID_LEN, PARSE_LEN, \
+               CFG_GET, CFG_SET, CFG_LIST, ACQ_START, \
        }).di
 
+#define DMM_CONN(ID, CHIPSET, VENDOR, MODEL, \
+               CONN, SERIALCOMM, PACKETSIZE, TIMEOUT, DELAY, \
+               REQUEST, VALID, PARSE, DETAILS) \
+       DMM_ENTRY(ID, CHIPSET, VENDOR, MODEL, \
+               CONN, SERIALCOMM, PACKETSIZE, TIMEOUT, DELAY, \
+               NULL, REQUEST, VALID, PARSE, DETAILS, \
+               NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL)
+
 #define DMM(ID, CHIPSET, VENDOR, MODEL, SERIALCOMM, PACKETSIZE, TIMEOUT, \
                DELAY, REQUEST, VALID, PARSE, DETAILS) \
-       DMM_CONN(ID, CHIPSET, VENDOR, MODEL, NULL, SERIALCOMM, PACKETSIZE, \
-               TIMEOUT, DELAY, REQUEST, VALID, PARSE, DETAILS)
+       DMM_CONN(ID, CHIPSET, VENDOR, MODEL, \
+               NULL, SERIALCOMM, PACKETSIZE, TIMEOUT, DELAY, \
+               REQUEST, VALID, PARSE, DETAILS)
+
+#define DMM_LEN(ID, CHIPSET, VENDOR, MODEL, \
+               CONN, SERIALCOMM, PACKETSIZE, TIMEOUT, DELAY, \
+               INIT, FREE, OPEN, REQUEST, VALID, PARSE, DETAILS) \
+       DMM_ENTRY(ID, CHIPSET, VENDOR, MODEL, \
+               CONN, SERIALCOMM, PACKETSIZE, TIMEOUT, DELAY, \
+               OPEN, REQUEST, NULL, NULL, DETAILS, \
+               INIT, FREE, VALID, PARSE, NULL, NULL, NULL, NULL)
 
 SR_REGISTER_DEV_DRIVER_LIST(serial_dmm_drivers,
        /*