]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/kecheng-kc-330b/api.c
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / hardware / kecheng-kc-330b / api.c
index 293d3c8549b7ca4adceccb5497275d872d6cfec9..60b1164d4f8fa5ffd739f1dd48ca841885d86a44 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <string.h>
 #include "protocol.h"
 
 #define USB_CONN "1041.8101"
-#define VENDOR "Kecheng"
 #define USB_INTERFACE 0
 
-static const uint32_t hwcaps[] = {
+static const uint32_t drvopts[] = {
        SR_CONF_SOUNDLEVELMETER,
-       SR_CONF_LIMIT_SAMPLES,
+};
+
+static const uint32_t devopts[] = {
        SR_CONF_CONTINUOUS,
-       SR_CONF_DATALOG,
-       SR_CONF_SPL_WEIGHT_FREQ,
-       SR_CONF_SPL_WEIGHT_TIME,
-       SR_CONF_DATA_SOURCE,
+       SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_SAMPLE_INTERVAL | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_DATALOG | SR_CONF_GET,
+       SR_CONF_SPL_WEIGHT_FREQ | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_SPL_WEIGHT_TIME | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
 };
 
 SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
@@ -45,36 +49,25 @@ SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
 };
 
 static const char *weight_freq[] = {
-       "A",
-       "C",
+       "A", "C",
 };
 
 static const char *weight_time[] = {
-       "F",
-       "S",
+       "F", "S",
 };
 
 static const char *data_sources[] = {
-       "Live",
-       "Memory",
+       "Live", "Memory",
 };
 
-SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
-static struct sr_dev_driver *di = &kecheng_kc_330b_driver_info;
-
-
-static int init(struct sr_context *sr_ctx)
-{
-       return std_init(sr_ctx, di, LOG_PREFIX);
-}
-
-static int scan_kecheng(struct sr_usb_dev_inst *usb, char **model)
+static int scan_kecheng(struct sr_dev_driver *di,
+               struct sr_usb_dev_inst *usb, char **model)
 {
        struct drv_context *drvc;
        int len, ret;
        unsigned char cmd, buf[32];
 
-       drvc = di->priv;
+       drvc = di->context;
        if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
                return SR_ERR;
 
@@ -107,42 +100,33 @@ static int scan_kecheng(struct sr_usb_dev_inst *usb, char **model)
        return SR_OK;
 }
 
-static GSList *scan(GSList *options)
+static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
        struct drv_context *drvc;
        struct dev_context *devc;
        struct sr_dev_inst *sdi;
-       struct sr_channel *ch;
        GSList *usb_devices, *devices, *l;
        char *model;
 
        (void)options;
 
-       drvc = di->priv;
-       drvc->instances = NULL;
+       drvc = di->context;
 
        devices = NULL;
        if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
                /* We have a list of sr_usb_dev_inst matching the connection
                 * string. Wrap them in sr_dev_inst and we're done. */
                for (l = usb_devices; l; l = l->next) {
-                       if (scan_kecheng(l->data, &model) != SR_OK)
+                       if (scan_kecheng(di, l->data, &model) != SR_OK)
                                continue;
-                       if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR,
-                                       model, NULL)))
-                               return NULL;
-                       g_free(model);
-                       sdi->driver = di;
+                       sdi = g_malloc0(sizeof(struct sr_dev_inst));
+                       sdi->status = SR_ST_INACTIVE;
+                       sdi->vendor = g_strdup("Kecheng");
+                       sdi->model = model; /* Already g_strndup()'d. */
                        sdi->inst_type = SR_INST_USB;
                        sdi->conn = l->data;
-                       if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "SPL")))
-                               return NULL;
-                       sdi->channels = g_slist_append(sdi->channels, ch);
-
-                       if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
-                               sr_dbg("Device context malloc failed.");
-                               return NULL;
-                       }
+                       sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
+                       devc = g_malloc0(sizeof(struct dev_context));
                        sdi->priv = devc;
                        devc->limit_samples = 0;
                        /* The protocol provides no way to read the current
@@ -156,32 +140,22 @@ static GSList *scan(GSList *options)
 
                        /* TODO: Set date/time? */
 
-                       drvc->instances = g_slist_append(drvc->instances, sdi);
                        devices = g_slist_append(devices, sdi);
                }
                g_slist_free(usb_devices);
        } else
                g_slist_free_full(usb_devices, g_free);
 
-       return devices;
-}
-
-static GSList *dev_list(void)
-{
-       return ((struct drv_context *)(di->priv))->instances;
+       return std_scan_complete(di, devices);
 }
 
 static int dev_open(struct sr_dev_inst *sdi)
 {
-       struct drv_context *drvc;
+       struct sr_dev_driver *di = sdi->driver;
+       struct drv_context *drvc = di->context;
        struct sr_usb_dev_inst *usb;
        int ret;
 
-       if (!(drvc = di->priv)) {
-               sr_err("Driver was not initialized.");
-               return SR_ERR;
-       }
-
        usb = sdi->conn;
 
        if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
@@ -196,9 +170,8 @@ static int dev_open(struct sr_dev_inst *sdi)
                sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
                return SR_ERR;
        }
-       sdi->status = SR_ST_ACTIVE;
 
-       return ret;
+       return SR_OK;
 }
 
 static int dev_close(struct sr_dev_inst *sdi)
@@ -206,16 +179,10 @@ static int dev_close(struct sr_dev_inst *sdi)
        struct dev_context *devc;
        struct sr_usb_dev_inst *usb;
 
-       if (!di->priv) {
-               sr_err("Driver was not initialized.");
-               return SR_ERR;
-       }
-
        usb = sdi->conn;
 
        if (!usb->devhdl)
-               /*  Nothing to do. */
-               return SR_OK;
+               return SR_ERR_BUG;
 
        /* This allows a frontend to configure the device without ever
         * doing an acquisition step. */
@@ -226,33 +193,14 @@ static int dev_close(struct sr_dev_inst *sdi)
        libusb_release_interface(usb->devhdl, USB_INTERFACE);
        libusb_close(usb->devhdl);
        usb->devhdl = NULL;
-       sdi->status = SR_ST_INACTIVE;
 
        return SR_OK;
 }
 
-static int cleanup(void)
-{
-       int ret;
-       struct drv_context *drvc;
-
-       if (!(drvc = di->priv))
-               /* Can get called on an unused driver, doesn't matter. */
-               return SR_OK;
-
-
-       ret = std_dev_clear(di, NULL);
-       g_free(drvc);
-       di->priv = NULL;
-
-       return ret;
-}
-
-static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+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;
-       GVariant *rational[2];
        const uint64_t *si;
 
        (void)cg;
@@ -264,14 +212,11 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                break;
        case SR_CONF_SAMPLE_INTERVAL:
                si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
-               rational[0] = g_variant_new_uint64(si[0]);
-               rational[1] = g_variant_new_uint64(si[1]);
-               *data = g_variant_new_tuple(rational, 2);
+               *data = std_gvar_tuple_u64(si[0], si[1]);
                break;
        case SR_CONF_DATALOG:
                /* There really isn't a way to be sure the device is logging. */
                return SR_ERR_NA;
-               break;
        case SR_CONF_SPL_WEIGHT_FREQ:
                if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
                        *data = g_variant_new_string("A");
@@ -297,119 +242,69 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        return SR_OK;
 }
 
-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;
-       uint64_t p, q;
-       unsigned int i;
-       int tmp, ret;
-       const char *tmp_str;
+       int idx;
 
        (void)cg;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
-       if (!di->priv) {
-               sr_err("Driver was not initialized.");
-               return SR_ERR;
-       }
-
        devc = sdi->priv;
-       ret = SR_OK;
        switch (key) {
        case SR_CONF_LIMIT_SAMPLES:
                devc->limit_samples = g_variant_get_uint64(data);
-               sr_dbg("Setting sample limit to %" PRIu64 ".",
-                      devc->limit_samples);
                break;
        case SR_CONF_SAMPLE_INTERVAL:
-               g_variant_get(data, "(tt)", &p, &q);
-               for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
-                       if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
-                               continue;
-                       devc->sample_interval = i;
-                       devc->config_dirty = TRUE;
-                       break;
-               }
-               if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
-                       ret = SR_ERR_ARG;
+               if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(kecheng_kc_330b_sample_intervals))) < 0)
+                       return SR_ERR_ARG;
+               devc->sample_interval = idx;
+               devc->config_dirty = TRUE;
                break;
        case SR_CONF_SPL_WEIGHT_FREQ:
-               tmp_str = g_variant_get_string(data, NULL);
-               if (!strcmp(tmp_str, "A"))
-                       tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
-               else if (!strcmp(tmp_str, "C"))
-                       tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
-               else
+               if ((idx = std_str_idx(data, ARRAY_AND_SIZE(weight_freq))) < 0)
                        return SR_ERR_ARG;
                devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
-               devc->mqflags |= tmp;
+               devc->mqflags |= (weight_freq[idx][0] == 'A') ? SR_MQFLAG_SPL_FREQ_WEIGHT_A : SR_MQFLAG_SPL_FREQ_WEIGHT_C;
                devc->config_dirty = TRUE;
                break;
        case SR_CONF_SPL_WEIGHT_TIME:
-               tmp_str = g_variant_get_string(data, NULL);
-               if (!strcmp(tmp_str, "F"))
-                       tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
-               else if (!strcmp(tmp_str, "S"))
-                       tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
-               else
+               if ((idx = std_str_idx(data, ARRAY_AND_SIZE(weight_time))) < 0)
                        return SR_ERR_ARG;
                devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
-               devc->mqflags |= tmp;
+               devc->mqflags |= (weight_time[idx][0] == 'F') ? SR_MQFLAG_SPL_TIME_WEIGHT_F : SR_MQFLAG_SPL_TIME_WEIGHT_S;
                devc->config_dirty = TRUE;
                break;
        case SR_CONF_DATA_SOURCE:
-               tmp_str = g_variant_get_string(data, NULL);
-               if (!strcmp(tmp_str, "Live"))
-                       devc->data_source = DATA_SOURCE_LIVE;
-               else if (!strcmp(tmp_str, "Memory"))
-                       devc->data_source = DATA_SOURCE_MEMORY;
-               else
-                       return SR_ERR;
+               if ((idx = std_str_idx(data, ARRAY_AND_SIZE(data_sources))) < 0)
+                       return SR_ERR_ARG;
+               devc->data_source = idx;
                devc->config_dirty = TRUE;
                break;
        default:
-               ret = SR_ERR_NA;
+               return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
-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)
 {
-       GVariant *tuple, *rational[2];
-       GVariantBuilder gvb;
-       unsigned int i;
-
-       (void)sdi;
-       (void)cg;
-
        switch (key) {
        case SR_CONF_DEVICE_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(uint32_t));
-               break;
+               return STD_CONFIG_LIST(key, data, sdi, cg, NO_OPTS, drvopts, devopts);
        case SR_CONF_SAMPLE_INTERVAL:
-               g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
-               for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
-                       rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
-                       rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
-                       tuple = g_variant_new_tuple(rational, 2);
-                       g_variant_builder_add_value(&gvb, tuple);
-               }
-               *data = g_variant_builder_end(&gvb);
+               *data = std_gvar_tuple_array(ARRAY_AND_SIZE(kecheng_kc_330b_sample_intervals));
                break;
        case SR_CONF_SPL_WEIGHT_FREQ:
-               *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
+               *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_freq));
                break;
        case SR_CONF_SPL_WEIGHT_TIME:
-               *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
+               *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_time));
                break;
        case SR_CONF_DATA_SOURCE:
-               *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
+               *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
                break;
        default:
                return SR_ERR_NA;
@@ -418,32 +313,27 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
        return SR_OK;
 }
 
-static int dev_acquisition_start(const struct sr_dev_inst *sdi,
-               void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
+       struct sr_dev_driver *di = sdi->driver;
        struct drv_context *drvc;
        struct dev_context *devc;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_meta meta;
        struct sr_config *src;
        struct sr_usb_dev_inst *usb;
-       GVariant *gvar, *rational[2];
+       GVariant *gvar;
        const uint64_t *si;
-       int stored_mqflags, req_len, buf_len, len, ret;
+       int req_len, buf_len, len, ret;
        unsigned char buf[9];
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
-       drvc = di->priv;
+       drvc = di->context;
        devc = sdi->priv;
        usb = sdi->conn;
 
-       devc->cb_data = cb_data;
        devc->num_samples = 0;
 
-       /* Send header packet to the session bus. */
-       std_session_send_df_header(cb_data, LOG_PREFIX);
+       std_session_send_df_header(sdi);
 
        if (devc->data_source == DATA_SOURCE_LIVE) {
                /* Force configuration. */
@@ -461,13 +351,12 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        } else {
                if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
                        return SR_ERR;
-               stored_mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
-               stored_mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
+               devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
+               devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
                devc->stored_samples = (buf[7] << 8) | buf[8];
                if (devc->stored_samples == 0) {
                        /* Notify frontend of empty log by sending start/end packets. */
-                       packet.type = SR_DF_END;
-                       sr_session_send(cb_data, &packet);
+                       std_session_send_df_end(sdi);
                        return SR_OK;
                }
 
@@ -475,15 +364,15 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
                        devc->stored_samples = devc->limit_samples;
 
                si = kecheng_kc_330b_sample_intervals[buf[1]];
-               rational[0] = g_variant_new_uint64(si[0]);
-               rational[1] = g_variant_new_uint64(si[1]);
-               gvar = g_variant_new_tuple(rational, 2);
+               gvar = std_gvar_tuple_u64(si[0], si[1]);
+
                src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
                packet.type = SR_DF_META;
                packet.payload = &meta;
                meta.config = g_slist_append(NULL, src);
-               sr_session_send(devc->cb_data, &packet);
-               g_free(src);
+               sr_session_send(sdi, &packet);
+               g_slist_free(meta.config);
+               sr_config_free(src);
        }
 
        if (!(devc->xfer = libusb_alloc_transfer(0)))
@@ -529,15 +418,10 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
-static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
-       (void)cb_data;
-
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        /* Signal USB transfer handler to clean up and stop. */
        sdi->status = SR_ST_STOPPING;
 
@@ -555,15 +439,15 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
+static struct sr_dev_driver kecheng_kc_330b_driver_info = {
        .name = "kecheng-kc-330b",
        .longname = "Kecheng KC-330B",
        .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 = config_get,
        .config_set = config_set,
        .config_list = config_list,
@@ -571,5 +455,6 @@ SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
        .dev_close = dev_close,
        .dev_acquisition_start = dev_acquisition_start,
        .dev_acquisition_stop = dev_acquisition_stop,
-       .priv = NULL,
+       .context = NULL,
 };
+SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info);