]> sigrok.org Git - libsigrok.git/blobdiff - hardware/mic-985xx/api.c
Initial driver implementation for MIC 98583.
[libsigrok.git] / hardware / mic-985xx / api.c
index f2fe5a914f03666e443d17b64ddb089c8dffff1b..b8983a6dab69aa336baf78edad383d04cfa89af3 100644 (file)
 
 #include "protocol.h"
 
-SR_PRIV struct sr_dev_driver mic_985xx_driver_info;
-static struct sr_dev_driver *di = &mic_985xx_driver_info;
+static const int hwopts[] = {
+       SR_CONF_CONN,
+       SR_CONF_SERIALCOMM,
+       0,
+};
+
+static const int hwcaps[] = {
+       SR_CONF_THERMOMETER,
+       SR_CONF_HYGROMETER,
+       SR_CONF_LIMIT_SAMPLES,
+       SR_CONF_LIMIT_MSEC,
+       SR_CONF_CONTINUOUS,
+       0,
+};
 
-/* Properly close and free all devices. */
-static int clear_instances(void)
+SR_PRIV struct sr_dev_driver mic_98583_driver_info;
+
+SR_PRIV const struct mic_dev_info mic_devs[] = {
+       {
+               "MIC", "98583", "38400/8n2", 32000, TRUE, TRUE,
+               &mic_98583_driver_info, receive_data_MIC_98583,
+       },
+};
+
+static int clear_instances(int idx)
 {
        struct sr_dev_inst *sdi;
        struct drv_context *drvc;
        struct dev_context *devc;
        GSList *l;
+       struct sr_dev_driver *di;
+
+       di = mic_devs[idx].di;
 
        if (!(drvc = di->priv))
                return SR_OK;
@@ -39,9 +62,7 @@ static int clear_instances(void)
                        continue;
                if (!(devc = sdi->priv))
                        continue;
-
-               /* TODO */
-
+               sr_serial_dev_inst_free(devc->serial);
                sr_dev_inst_free(sdi);
        }
 
@@ -51,108 +72,184 @@ static int clear_instances(void)
        return SR_OK;
 }
 
-static int hw_init(struct sr_context *sr_ctx)
+static int hw_init(struct sr_context *sr_ctx, int idx)
 {
-       return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
+       sr_dbg("Selected '%s' subdriver.", mic_devs[idx].di->name);
+
+       return std_hw_init(sr_ctx, mic_devs[idx].di, DRIVER_LOG_DOMAIN);
 }
 
-static GSList *hw_scan(GSList *options)
+static GSList *scan(const char *conn, const char *serialcomm, int idx)
 {
+       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;
 
-       (void)options;
+       if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
+               return NULL;
 
+       if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
+               return NULL;
+
+       drvc = mic_devs[idx].di->priv;
        devices = NULL;
-       drvc = di->priv;
-       drvc->instances = NULL;
+       serial_flush(serial);
 
-       /* TODO */
+       /* TODO: Query device type. */
+       // ret = mic_cmd_get_device_info(serial);
+
+       sr_info("Found device on port %s.", conn);
+
+       /* TODO: Fill in version from protocol response. */
+       if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, mic_devs[idx].vendor,
+                                   mic_devs[idx].device, "")))
+               goto scan_cleanup;
+
+       if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
+               sr_err("Device context malloc failed.");
+               goto scan_cleanup;
+       }
+
+       devc->serial = serial;
+
+       sdi->priv = devc;
+       sdi->driver = mic_devs[idx].di;
+
+       if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "Temperature")))
+               goto scan_cleanup;
+       sdi->probes = g_slist_append(sdi->probes, probe);
+
+       if (!(probe = sr_probe_new(1, SR_PROBE_ANALOG, TRUE, "Humidity")))
+               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);
+
+scan_cleanup:
+       serial_close(serial);
 
        return devices;
 }
 
-static GSList *hw_dev_list(void)
+static GSList *hw_scan(GSList *options, int idx)
+{
+       struct sr_config *src;
+       GSList *l, *devices;
+       const char *conn, *serialcomm;
+
+       conn = serialcomm = NULL;
+       for (l = options; l; l = l->next) {
+               src = l->data;
+               switch (src->key) {
+               case SR_CONF_CONN:
+                       conn = src->value;
+                       break;
+               case SR_CONF_SERIALCOMM:
+                       serialcomm = src->value;
+                       break;
+               }
+       }
+       if (!conn)
+               return NULL;
+
+       if (serialcomm) {
+               /* Use the provided comm specs. */
+               devices = scan(conn, serialcomm, idx);
+       } else {
+               /* Try the default. */
+               devices = scan(conn, mic_devs[idx].conn, idx);
+       }
+
+       return devices;
+}
+
+static GSList *hw_dev_list(int idx)
 {
        struct drv_context *drvc;
 
-       drvc = di->priv;
+       drvc = mic_devs[idx].di->priv;
 
        return drvc->instances;
 }
 
 static int hw_dev_open(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
+       struct dev_context *devc;
 
-       /* TODO */
+       devc = sdi->priv;
 
-       return SR_OK;
-}
-
-static int hw_dev_close(struct sr_dev_inst *sdi)
-{
-       (void)sdi;
+       if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
+               return SR_ERR;
 
-       /* TODO */
+       sdi->status = SR_ST_ACTIVE;
 
        return SR_OK;
 }
 
-static int hw_cleanup(void)
+static int hw_dev_close(struct sr_dev_inst *sdi)
 {
-       clear_instances();
+       struct dev_context *devc;
 
-       /* TODO */
+       devc = sdi->priv;
+
+       if (devc->serial && devc->serial->fd != -1) {
+               serial_close(devc->serial);
+               sdi->status = SR_ST_INACTIVE;
+       }
 
        return SR_OK;
 }
 
-static int hw_config_get(int id, const void **value,
-                        const struct sr_dev_inst *sdi)
+static int hw_cleanup(int idx)
 {
-       (void)sdi;
-       (void)value;
-
-       switch (id) {
-       /* TODO */
-       default:
-               return SR_ERR_ARG;
-       }
+       clear_instances(idx);
 
        return SR_OK;
 }
 
-static int hw_config_set(int id, const void *value,
-                        const struct sr_dev_inst *sdi)
+static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 {
-       (void)value;
-
-       int ret;
+       struct dev_context *devc;
 
-       if (sdi->status != SR_ST_ACTIVE) {
-               sr_err("Device inactive, can't set config options.");
+       if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR;
-       }
 
-       ret = SR_OK;
+       devc = sdi->priv;
+
        switch (id) {
-       /* TODO */
+       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 hardware capability: %d.", id);
-               ret = SR_ERR_ARG;
+               sr_err("Unknown config: %d.", id);
+               return SR_ERR_ARG;
        }
 
-       return ret;
+       return SR_OK;
 }
 
-static int hw_config_list(int key, const void **data,
-                         const struct sr_dev_inst *sdi)
+static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 {
        (void)sdi;
-       (void)data;
 
        switch (key) {
+       case SR_CONF_SCAN_OPTIONS:
+               *data = hwopts;
+               break;
+       case SR_CONF_DEVICE_OPTIONS:
+               *data = hwcaps;
+               break;
        default:
                return SR_ERR_ARG;
        }
@@ -161,45 +258,101 @@ static int hw_config_list(int key, const void **data,
 }
 
 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+                                   void *cb_data, int idx)
 {
-       (void)sdi;
-       (void)cb_data;
+       struct sr_datafeed_packet packet;
+       struct sr_datafeed_header header;
+       struct dev_context *devc;
+
+       devc = sdi->priv;
+
+       devc->cb_data = cb_data;
 
-       /* TODO */
+       sr_dbg("Starting acquisition.");
+
+       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);
+
+       /* Poll every 100ms, or whenever some data comes in. */
+       sr_source_add(devc->serial->fd, G_IO_IN, 100,
+                     mic_devs[idx].receive_data, (void *)sdi);
 
        return SR_OK;
 }
 
 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
-       (void)cb_data;
+       struct sr_datafeed_packet packet;
+       struct dev_context *devc;
 
        if (sdi->status != SR_ST_ACTIVE) {
                sr_err("Device inactive, can't stop acquisition.");
                return SR_ERR;
        }
 
-       /* TODO */
+       devc = sdi->priv;
+
+       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("Sending SR_DF_END.");
+       packet.type = SR_DF_END;
+       sr_session_send(cb_data, &packet);
 
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver mic_985xx_driver_info = {
-       .name = "mic-985xx",
-       .longname = "MIC 985xx",
-       .api_version = 1,
-       .init = hw_init,
-       .cleanup = hw_cleanup,
-       .scan = hw_scan,
-       .dev_list = hw_dev_list,
-       .dev_clear = clear_instances,
-       .config_get = hw_config_get,
-       .config_set = hw_config_set,
-       .config_list = hw_config_list,
-       .dev_open = hw_dev_open,
-       .dev_close = hw_dev_close,
-       .dev_acquisition_start = hw_dev_acquisition_start,
-       .dev_acquisition_stop = hw_dev_acquisition_stop,
-       .priv = NULL,
+/* 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_##ID_UPPER, \
+       .scan = hw_scan_##ID_UPPER, \
+       .dev_list = hw_dev_list_##ID_UPPER, \
+       .dev_clear = clear_instances_##ID_UPPER, \
+       .config_get = NULL, \
+       .config_set = config_set, \
+       .config_list = config_list, \
+       .dev_open = hw_dev_open, \
+       .dev_close = hw_dev_close, \
+       .dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
+       .dev_acquisition_stop = hw_dev_acquisition_stop, \
+       .priv = NULL, \
 };
+
+DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")