]> sigrok.org Git - libsigrok.git/blobdiff - hardware/chronovu-la8/api.c
std: Drop hw_ from function names.
[libsigrok.git] / hardware / chronovu-la8 / api.c
index 08dec08e388dda7bc96c4d52bf07170e20df8e36..cbf91df3040eb738386ae36ce87c646fd531226f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
  *
 SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
 static struct sr_dev_driver *di = &chronovu_la8_driver_info;
 
+/*
+ * This will be initialized via config_list()/SR_CONF_SAMPLERATE.
+ *
+ * Min: 1 sample per 0.01us -> sample time is 0.084s, samplerate 100MHz
+ * Max: 1 sample per 2.55us -> sample time is 21.391s, samplerate 392.15kHz
+ */
+SR_PRIV uint64_t chronovu_la8_samplerates[255] = { 0 };
+
+/* Note: Continuous sampling is not supported by the hardware. */
+SR_PRIV const int32_t chronovu_la8_hwcaps[] = {
+       SR_CONF_LOGIC_ANALYZER,
+       SR_CONF_SAMPLERATE,
+       SR_CONF_LIMIT_MSEC, /* TODO: Not yet implemented. */
+       SR_CONF_LIMIT_SAMPLES, /* TODO: Not yet implemented. */
+};
+
 /*
  * The ChronoVu LA8 can have multiple PIDs. Older versions shipped with
  * a standard FTDI USB VID/PID of 0403:6001, newer ones have 0403:8867.
@@ -38,52 +54,29 @@ static const uint16_t usb_pids[] = {
 };
 
 /* Function prototypes. */
-static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
+static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 
-static int clear_instances(void)
+static void clear_helper(void *priv)
 {
-       GSList *l;
-       struct sr_dev_inst *sdi;
-       struct drv_context *drvc;
        struct dev_context *devc;
+       
+       devc = priv;
 
-       drvc = di->priv;
-
-       /* Properly close all devices. */
-       for (l = drvc->instances; l; l = l->next) {
-               if (!(sdi = l->data)) {
-                       /* Log error, but continue cleaning up the rest. */
-                       sr_err("%s: sdi was NULL, continuing.", __func__);
-                       continue;
-               }
-               if (sdi->priv) {
-                       devc = sdi->priv;
-                       ftdi_free(devc->ftdic);
-               }
-               sr_dev_inst_free(sdi);
-       }
-       g_slist_free(drvc->instances);
-       drvc->instances = NULL;
-
-       return SR_OK;
+       ftdi_free(devc->ftdic);
+       g_free(devc->final_buf);
 }
 
-static int hw_init(struct sr_context *sr_ctx)
+static int clear_instances(void)
 {
-       struct drv_context *drvc;
-
-       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("Driver context malloc failed.");
-               return SR_ERR_MALLOC;
-       }
-
-       drvc->sr_ctx = sr_ctx;
-       di->priv = drvc;
+       return std_dev_clear(di, clear_helper);
+}
 
-       return SR_OK;
+static int init(struct sr_context *sr_ctx)
+{
+       return std_init(sr_ctx, di, LOG_PREFIX);
 }
 
-static GSList *hw_scan(GSList *options)
+static GSList *scan(GSList *options)
 {
        struct sr_dev_inst *sdi;
        struct sr_probe *probe;
@@ -96,6 +89,7 @@ static GSList *hw_scan(GSList *options)
        (void)options;
 
        drvc = di->priv;
+
        devices = NULL;
 
        /* Allocate memory for our private device context. */
@@ -109,7 +103,7 @@ static GSList *hw_scan(GSList *options)
        devc->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
        devc->limit_msec = 0;
        devc->limit_samples = 0;
-       devc->session_dev_id = NULL;
+       devc->cb_data = NULL;
        memset(devc->mangled_buf, 0, BS);
        devc->final_buf = NULL;
        devc->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
@@ -159,9 +153,9 @@ static GSList *hw_scan(GSList *options)
        sdi->driver = di;
        sdi->priv = devc;
 
-       for (i = 0; probe_names[i]; i++) {
+       for (i = 0; chronovu_la8_probe_names[i]; i++) {
                if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
-                                          probe_names[i])))
+                                          chronovu_la8_probe_names[i])))
                        return NULL;
                sdi->probes = g_slist_append(sdi->probes, probe);
        }
@@ -169,8 +163,6 @@ static GSList *hw_scan(GSList *options)
        devices = g_slist_append(devices, sdi);
        drvc->instances = g_slist_append(drvc->instances, sdi);
 
-       sr_spew("Device init successful.");
-
        /* Close device. We'll reopen it again when we need it. */
        (void) la8_close(devc); /* Log, but ignore errors. */
 
@@ -189,16 +181,12 @@ err_free_nothing:
        return NULL;
 }
 
-static GSList *hw_dev_list(void)
+static GSList *dev_list(void)
 {
-       struct drv_context *drvc;
-
-       drvc = di->priv;
-
-       return drvc->instances;
+       return ((struct drv_context *)(di->priv))->instances;
 }
 
-static int hw_dev_open(struct sr_dev_inst *sdi)
+static int dev_open(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
        int ret;
@@ -251,16 +239,11 @@ err_dev_open_close_ftdic:
        return SR_ERR;
 }
 
-static int hw_dev_close(struct sr_dev_inst *sdi)
+static int dev_close(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
-       if (!(devc = sdi->priv)) {
-               sr_err("%s: sdi->priv was NULL.", __func__);
-               return SR_ERR_BUG;
-       }
-
-       sr_dbg("Closing device.");
+       devc = sdi->priv;
 
        if (sdi->status == SR_ST_ACTIVE) {
                sr_dbg("Status ACTIVE, closing device.");
@@ -271,97 +254,107 @@ static int hw_dev_close(struct sr_dev_inst *sdi)
 
        sdi->status = SR_ST_INACTIVE;
 
-       sr_dbg("Freeing sample buffer.");
-       g_free(devc->final_buf);
-
        return SR_OK;
 }
 
-static int hw_cleanup(void)
+static int cleanup(void)
 {
-       if (!di->priv)
-               /* Can get called on an unused driver, doesn't matter. */
-               return SR_OK;
-
-       clear_instances();
-
-       return SR_OK;
+       return clear_instances();
 }
 
-static int hw_info_get(int info_id, const void **data,
-                      const struct sr_dev_inst *sdi)
+static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
-       switch (info_id) {
-       case SR_DI_HWCAPS:
-               *data = hwcaps;
-               break;
-       case SR_DI_SAMPLERATES:
-               fill_supported_samplerates_if_needed();
-               *data = &samplerates;
-               sr_spew("%s: Returning samplerates.", __func__);
-               break;
-       case SR_DI_TRIGGER_TYPES:
-               *data = (char *)TRIGGER_TYPES;
-               sr_spew("%s: Returning trigger types: %s.", __func__,
-                       TRIGGER_TYPES);
-               break;
-       case SR_DI_CUR_SAMPLERATE:
+       switch (id) {
+       case SR_CONF_SAMPLERATE:
                if (sdi) {
                        devc = sdi->priv;
-                       *data = &devc->cur_samplerate;
+                       *data = g_variant_new_uint64(devc->cur_samplerate);
                        sr_spew("%s: Returning samplerate: %" PRIu64 "Hz.",
                                __func__, devc->cur_samplerate);
                } else
                        return SR_ERR;
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        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, GVariant *data, const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR_DEV_CLOSED;
+
        if (!(devc = sdi->priv)) {
                sr_err("%s: sdi->priv was NULL.", __func__);
                return SR_ERR_BUG;
        }
 
-       switch (hwcap) {
+       switch (id) {
        case SR_CONF_SAMPLERATE:
-               if (set_samplerate(sdi, *(const uint64_t *)value) == SR_ERR) {
+               if (set_samplerate(sdi, g_variant_get_uint64(data)) == SR_ERR) {
                        sr_err("%s: setting samplerate failed.", __func__);
                        return SR_ERR;
                }
                sr_dbg("SAMPLERATE = %" PRIu64, devc->cur_samplerate);
                break;
        case SR_CONF_LIMIT_MSEC:
-               if (*(const uint64_t *)value == 0) {
+               if (g_variant_get_uint64(data) == 0) {
                        sr_err("%s: LIMIT_MSEC can't be 0.", __func__);
                        return SR_ERR;
                }
-               devc->limit_msec = *(const uint64_t *)value;
+               devc->limit_msec = g_variant_get_uint64(data);
                sr_dbg("LIMIT_MSEC = %" PRIu64, devc->limit_msec);
                break;
        case SR_CONF_LIMIT_SAMPLES:
-               if (*(const uint64_t *)value < MIN_NUM_SAMPLES) {
+               if (g_variant_get_uint64(data) < MIN_NUM_SAMPLES) {
                        sr_err("%s: LIMIT_SAMPLES too small.", __func__);
                        return SR_ERR;
                }
-               devc->limit_samples = *(const uint64_t *)value;
+               devc->limit_samples = g_variant_get_uint64(data);
                sr_dbg("LIMIT_SAMPLES = %" PRIu64, devc->limit_samples);
                break;
        default:
-               /* Unknown capability, return SR_ERR. */
-               sr_err("%s: Unknown capability: %d.", __func__, hwcap);
-               return SR_ERR;
+               return SR_ERR_NA;
+       }
+
+       return SR_OK;
+}
+
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
+{
+       GVariant *gvar;
+       GVariantBuilder gvb;
+
+       (void)sdi;
+
+       switch (key) {
+       case SR_CONF_DEVICE_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               chronovu_la8_hwcaps,
+                               ARRAY_SIZE(chronovu_la8_hwcaps),
+                               sizeof(int32_t));
                break;
+       case SR_CONF_SAMPLERATE:
+               fill_supported_samplerates_if_needed();
+               g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
+               gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
+                               chronovu_la8_samplerates,
+                               ARRAY_SIZE(chronovu_la8_samplerates),
+                               sizeof(uint64_t));
+               g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
+               *data = g_variant_builder_end(&gvb);
+               break;
+       case SR_CONF_TRIGGER_TYPE:
+               *data = g_variant_new_string(TRIGGER_TYPE);
+               break;
+       default:
+               return SR_ERR_NA;
        }
 
        return SR_OK;
@@ -394,7 +387,7 @@ static int receive_data(int fd, int revents, void *cb_data)
        /* Get one block of data. */
        if ((ret = la8_read_block(devc)) < 0) {
                sr_err("%s: la8_read_block error: %d.", __func__, ret);
-               hw_dev_acquisition_stop(sdi, sdi);
+               dev_acquisition_stop(sdi, sdi);
                return FALSE;
        }
 
@@ -410,20 +403,20 @@ static int receive_data(int fd, int revents, void *cb_data)
        for (i = 0; i < NUM_BLOCKS; i++)
                send_block_to_session_bus(devc, i);
 
-       hw_dev_acquisition_stop(sdi, sdi);
+       dev_acquisition_stop(sdi, sdi);
 
        return TRUE;
 }
 
-static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 {
        struct dev_context *devc;
-       struct sr_datafeed_packet packet;
-       struct sr_datafeed_header header;
        uint8_t buf[4];
        int bytes_written;
 
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR_DEV_CLOSED;
+
        if (!(devc = sdi->priv)) {
                sr_err("%s: sdi->priv was NULL.", __func__);
                return SR_ERR_BUG;
@@ -445,8 +438,6 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                return SR_ERR;
        }
 
-       sr_dbg("Starting acquisition.");
-
        /* Fill acquisition parameters into buf[]. */
        buf[0] = devc->divcount;
        buf[1] = 0xff; /* This byte must always be 0xff. */
@@ -464,17 +455,12 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                return SR_ERR;
        }
 
-       sr_dbg("Acquisition started successfully.");
+       sr_dbg("Hardware acquisition started successfully.");
 
-       devc->session_dev_id = cb_data;
+       devc->cb_data = cb_data;
 
        /* Send header packet to the session bus. */
-       sr_dbg("Sending SR_DF_HEADER.");
-       packet.type = SR_DF_HEADER;
-       packet.payload = &header;
-       header.feed_version = 1;
-       gettimeofday(&header.starttime, NULL);
-       sr_session_send(devc->session_dev_id, &packet);
+       std_session_send_df_header(cb_data, LOG_PREFIX);
 
        /* Time when we should be done (for detecting trigger timeouts). */
        devc->done = (devc->divcount + 1) * 0.08388608 + time(NULL)
@@ -488,7 +474,7 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
-static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
        struct sr_datafeed_packet packet;
 
@@ -509,16 +495,17 @@ SR_PRIV struct sr_dev_driver chronovu_la8_driver_info = {
        .name = "chronovu-la8",
        .longname = "ChronoVu LA8",
        .api_version = 1,
-       .init = hw_init,
-       .cleanup = hw_cleanup,
-       .scan = hw_scan,
-       .dev_list = hw_dev_list,
+       .init = init,
+       .cleanup = cleanup,
+       .scan = scan,
+       .dev_list = dev_list,
        .dev_clear = clear_instances,
-       .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_stop = hw_dev_acquisition_stop,
+       .config_get = config_get,
+       .config_set = config_set,
+       .config_list = config_list,
+       .dev_open = dev_open,
+       .dev_close = dev_close,
+       .dev_acquisition_start = dev_acquisition_start,
+       .dev_acquisition_stop = dev_acquisition_stop,
        .priv = NULL,
 };