]> sigrok.org Git - libsigrok.git/blobdiff - session_driver.c
We now require libusb >= 1.0.9.
[libsigrok.git] / session_driver.c
index a69e404d42af4d076195ff56b0541deb29357c79..6ba804285b5d0ff8b2815c062cb879a823baad74 100644 (file)
 #include <unistd.h>
 #include <sys/time.h>
 #include <zip.h>
-#include "sigrok.h"
-#include "sigrok-internal.h"
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
 
 /* size of payloads sent across the session bus */
 #define CHUNKSIZE (512 * 1024)
 
 struct session_vdev {
+       char *sessionfile;
        char *capturefile;
        struct zip *archive;
        struct zip_file *capfile;
@@ -39,49 +40,14 @@ struct session_vdev {
        int num_probes;
 };
 
-static char *sessionfile = NULL;
 static GSList *dev_insts = NULL;
-static int hwcaps[] = {
+static const int hwcaps[] = {
        SR_HWCAP_CAPTUREFILE,
        SR_HWCAP_CAPTURE_UNITSIZE,
        0,
 };
 
-/**
- * TODO.
- *
- * @param dev_index TODO.
- */
-static struct session_vdev *get_vdev_by_index(int dev_index)
-{
-       struct sr_dev_inst *sdi;
-       struct session_vdev *vdev;
-
-       /* TODO: Sanity checks on dev_index. */
-
-       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
-               sr_err("session driver: %s: device instance with device "
-                      "index %d was not found", __func__, dev_index);
-               return NULL;
-       }
-
-       /* TODO: Is sdi->priv == NULL valid? */
-
-       vdev = sdi->priv;
-
-       return vdev;
-}
-
-/**
- * TODO.
- *
- * @param fd TODO.
- * @param revents TODO.
- * @param session_data TODO.
- *
- * @return TODO.
- */
-static int feed_chunk(int fd, int revents, void *session_data)
+static int receive_data(int fd, int revents, void *cb_data)
 {
        struct sr_dev_inst *sdi;
        struct session_vdev *vdev;
@@ -106,9 +72,8 @@ static int feed_chunk(int fd, int revents, void *session_data)
                        continue;
 
                if (!(buf = g_try_malloc(CHUNKSIZE))) {
-                       sr_err("session driver: %s: buf malloc failed",
-                              __func__);
-                       return FALSE; /* TODO: SR_ERR_MALLOC */
+                       sr_err("session driver: %s: buf malloc failed", __func__);
+                       return FALSE;
                }
 
                ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
@@ -120,7 +85,7 @@ static int feed_chunk(int fd, int revents, void *session_data)
                        logic.unitsize = vdev->unitsize;
                        logic.data = buf;
                        vdev->bytes_read += ret;
-                       sr_session_send(session_data, &packet);
+                       sr_session_send(cb_data, &packet);
                } else {
                        /* done with this capture file */
                        zip_fclose(vdev->capfile);
@@ -132,7 +97,8 @@ static int feed_chunk(int fd, int revents, void *session_data)
 
        if (!got_data) {
                packet.type = SR_DF_END;
-               sr_session_send(session_data, &packet);
+               sr_session_send(cb_data, &packet);
+               sr_session_source_remove(-1);
        }
 
        return TRUE;
@@ -141,24 +107,12 @@ static int feed_chunk(int fd, int revents, void *session_data)
 /* driver callbacks */
 static int hw_cleanup(void);
 
-/**
- * TODO.
- *
- * @param devinfo TODO.
- *
- * @return TODO.
- */
-static int hw_init(const char *devinfo)
+static int hw_init(void)
 {
-       sessionfile = g_strdup(devinfo);
 
-       return 0;
+       return SR_OK;
 }
 
-/**
- * TODO.
- *
- */
 static int hw_cleanup(void)
 {
        GSList *l;
@@ -168,21 +122,11 @@ static int hw_cleanup(void)
        g_slist_free(dev_insts);
        dev_insts = NULL;
 
-       sr_session_source_remove(-1);
-
-       g_free(sessionfile);
-
        return SR_OK;
 }
 
-static int hw_dev_open(int dev_index)
+static int hw_dev_open(struct sr_dev_inst *sdi)
 {
-       struct sr_dev_inst *sdi;
-
-       sdi = sr_dev_inst_new(dev_index, SR_ST_INITIALIZING,
-                             NULL, NULL, NULL);
-       if (!sdi)
-               return SR_ERR;
 
        if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
                sr_err("session driver: %s: sdi->priv malloc failed", __func__);
@@ -194,51 +138,36 @@ static int hw_dev_open(int dev_index)
        return SR_OK;
 }
 
-static void *hw_dev_info_get(int dev_index, int dev_info_id)
+static int hw_info_get(int info_id, const void **data,
+       const struct sr_dev_inst *sdi)
 {
        struct session_vdev *vdev;
-       void *info;
 
-       if (dev_info_id != SR_DI_CUR_SAMPLERATE)
-               return NULL;
-
-       if (!(vdev = get_vdev_by_index(dev_index)))
-               return NULL;
-
-       info = &vdev->samplerate;
-
-       return info;
-}
-
-static int hw_dev_status_get(int dev_index)
-{
-       /* Avoid compiler warnings. */
-       (void)dev_index;
-
-       if (sr_dev_list() != NULL)
-               return SR_OK;
-       else
-               return SR_ERR;
-}
+       switch (info_id) {
+       case SR_DI_HWCAPS:
+               *data = hwcaps;
+               break;
+       case SR_DI_CUR_SAMPLERATE:
+               if (sdi) {
+                       vdev = sdi->priv;
+                       *data = &vdev->samplerate;
+               } else
+                       return SR_ERR;
+               break;
+       default:
+               return SR_ERR_ARG;
+       }
 
-/**
- * Get the list of hardware capabilities.
- *
- * @return A pointer to the (hardware) capabilities of this virtual session
- *         driver. This could be NULL, if no such capabilities exist.
- */
-static int *hw_hwcap_get_all(void)
-{
-       return hwcaps;
+       return SR_OK;
 }
 
-static int hw_dev_config_set(int dev_index, int hwcap, void *value)
+static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
+               const void *value)
 {
        struct session_vdev *vdev;
-       uint64_t *tmp_u64;
+       const uint64_t *tmp_u64;
 
-       if (!(vdev = get_vdev_by_index(dev_index)))
-               return SR_ERR;
+       vdev = sdi->priv;
 
        switch (hwcap) {
        case SR_HWCAP_SAMPLERATE:
@@ -247,6 +176,11 @@ static int hw_dev_config_set(int dev_index, int hwcap, void *value)
                sr_info("session driver: setting samplerate to %" PRIu64,
                        vdev->samplerate);
                break;
+       case SR_HWCAP_SESSIONFILE:
+               vdev->sessionfile = g_strdup(value);
+               sr_info("session driver: setting sessionfile to %s",
+                       vdev->sessionfile);
+               break;
        case SR_HWCAP_CAPTUREFILE:
                vdev->capturefile = g_strdup(value);
                sr_info("session driver: setting capturefile to %s",
@@ -269,43 +203,41 @@ static int hw_dev_config_set(int dev_index, int hwcap, void *value)
        return SR_OK;
 }
 
-static int hw_dev_acquisition_start(int dev_index, void *session_dev_id)
+static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
+               void *cb_data)
 {
        struct zip_stat zs;
        struct session_vdev *vdev;
        struct sr_datafeed_header *header;
        struct sr_datafeed_packet *packet;
-       int err;
+       struct sr_datafeed_meta_logic meta;
+       int ret;
 
-       /* Avoid compiler warnings. */
-       (void)session_dev_id;
-
-       if (!(vdev = get_vdev_by_index(dev_index)))
-               return SR_ERR;
+       vdev = sdi->priv;
 
-       sr_info("session_driver: opening archive %s file %s", sessionfile,
+       sr_info("session_driver: opening archive %s file %s", vdev->sessionfile,
                vdev->capturefile);
 
-       if (!(vdev->archive = zip_open(sessionfile, 0, &err))) {
+       if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
                sr_err("session driver: Failed to open session file '%s': "
-                      "zip error %d\n", sessionfile, err);
+                      "zip error %d\n", vdev->sessionfile, ret);
                return SR_ERR;
        }
 
        if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
                sr_err("session driver: Failed to check capture file '%s' in "
-                      "session file '%s'.", vdev->capturefile, sessionfile);
+                      "session file '%s'.", vdev->capturefile, vdev->sessionfile);
                return SR_ERR;
        }
 
        if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
                sr_err("session driver: Failed to open capture file '%s' in "
-                      "session file '%s'.", vdev->capturefile, sessionfile);
+                      "session file '%s'.", vdev->capturefile, vdev->sessionfile);
                return SR_ERR;
        }
 
        /* freewheeling source */
-       sr_session_source_add(-1, 0, 0, feed_chunk, session_dev_id);
+       sr_session_source_add(-1, 0, 0, receive_data, cb_data);
 
        if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
                sr_err("session driver: %s: packet malloc failed", __func__);
@@ -322,9 +254,15 @@ static int hw_dev_acquisition_start(int dev_index, void *session_dev_id)
        packet->payload = (unsigned char *)header;
        header->feed_version = 1;
        gettimeofday(&header->starttime, NULL);
-       header->samplerate = vdev->samplerate;
-       header->num_logic_probes = vdev->num_probes;
-       sr_session_send(session_dev_id, packet);
+       sr_session_send(cb_data, packet);
+
+       /* Send metadata about the SR_DF_LOGIC packets to come. */
+       packet->type = SR_DF_META_LOGIC;
+       packet->payload = &meta;
+       meta.samplerate = vdev->samplerate;
+       meta.num_probes = vdev->num_probes;
+       sr_session_send(cb_data, packet);
+
        g_free(header);
        g_free(packet);
 
@@ -339,9 +277,7 @@ SR_PRIV struct sr_dev_driver session_driver = {
        .cleanup = hw_cleanup,
        .dev_open = hw_dev_open,
        .dev_close = NULL,
-       .dev_info_get = hw_dev_info_get,
-       .dev_status_get = hw_dev_status_get,
-       .hwcap_get_all = hw_hwcap_get_all,
+       .info_get = hw_info_get,
        .dev_config_set = hw_dev_config_set,
        .dev_acquisition_start = hw_dev_acquisition_start,
        .dev_acquisition_stop = NULL,