]> sigrok.org Git - libsigrok.git/blobdiff - session_driver.c
sr: rename more functions to sr_thing_action format
[libsigrok.git] / session_driver.c
index 56740fa54a551bcab53c89868d8dd6639362710b..6002639ea24d62bf24e3b397ccdba80b0862eead 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 #include <unistd.h>
 #include <sys/time.h>
 #include <zip.h>
-#include <sigrok.h>
+#include "sigrok.h"
+#include "sigrok-internal.h"
 
 /* size of payloads sent across the session bus */
-#define CHUNKSIZE 4096
+#define CHUNKSIZE (512 * 1024)
 
 struct session_vdevice {
        char *capturefile;
        struct zip *archive;
        struct zip_file *capfile;
+       int bytes_read;
        uint64_t samplerate;
        int unitsize;
        int num_probes;
@@ -45,34 +47,55 @@ static int capabilities[] = {
        0,
 };
 
-
+/**
+ * TODO.
+ *
+ * @param device_index TODO.
+ */
 static struct session_vdevice *get_vdevice_by_index(int device_index)
 {
        struct sr_device_instance *sdi;
        struct session_vdevice *vdevice;
 
-       if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+       /* TODO: Sanity checks on device_index. */
+
+       if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
+               sr_err("session driver: %s: device instance with device "
+                      "index %d was not found", __func__, device_index);
                return NULL;
+       }
+
+       /* TODO: Is sdi->priv == NULL valid? */
 
        vdevice = sdi->priv;
 
        return vdevice;
 }
 
-static int feed_chunk(int fd, int revents, void *user_data)
+/**
+ * TODO.
+ *
+ * @param fd TODO.
+ * @param revents TODO.
+ * @param session_data TODO.
+ *
+ * @return TODO.
+ */
+static int feed_chunk(int fd, int revents, void *session_data)
 {
        struct sr_device_instance *sdi;
        struct session_vdevice *vdevice;
        struct sr_datafeed_packet packet;
+       struct sr_datafeed_logic logic;
        GSList *l;
        void *buf;
        int ret, got_data;
 
-       /* avoid compiler warning */
-       fd = fd;
-       revents = revents;
+       /* Avoid compiler warnings. */
+       (void)fd;
+       (void)revents;
 
-       g_debug("session_driver: feed chunk");
+       sr_dbg("session_driver: feed chunk");
 
        got_data = FALSE;
        for (l = device_instances; l; l = l->next) {
@@ -82,15 +105,21 @@ static int feed_chunk(int fd, int revents, void *user_data)
                        /* already done with this instance */
                        continue;
 
-               buf = g_malloc(CHUNKSIZE);
+               if (!(buf = g_try_malloc(CHUNKSIZE))) {
+                       sr_err("session: %s: buf malloc failed", __func__);
+                       return FALSE; /* TODO: SR_ERR_MALLOC */
+               }
+
                ret = zip_fread(vdevice->capfile, buf, CHUNKSIZE);
                if (ret > 0) {
                        got_data = TRUE;
                        packet.type = SR_DF_LOGIC;
-                       packet.length = ret;
-                       packet.unitsize = vdevice->unitsize;
-                       packet.payload = buf;
-                       sr_session_bus(user_data, &packet);
+                       packet.payload = &logic;
+                       logic.length = ret;
+                       logic.unitsize = vdevice->unitsize;
+                       logic.data = buf;
+                       vdevice->bytes_read += ret;
+                       sr_session_bus(session_data, &packet);
                } else {
                        /* done with this capture file */
                        zip_fclose(vdevice->capfile);
@@ -102,45 +131,66 @@ static int feed_chunk(int fd, int revents, void *user_data)
 
        if (!got_data) {
                packet.type = SR_DF_END;
-               packet.length = 0;
-               sr_session_bus(user_data, &packet);
+               sr_session_bus(session_data, &packet);
        }
 
        return TRUE;
 }
 
 /* driver callbacks */
+static int hw_cleanup(void);
 
-static int hw_init(char *deviceinfo)
+/**
+ * TODO.
+ *
+ * @param deviceinfo TODO.
+ *
+ * @return TODO.
+ */
+static int hw_init(const char *deviceinfo)
 {
-
        sessionfile = g_strdup(deviceinfo);
 
        return 0;
 }
 
-static void hw_cleanup(void)
+/**
+ * TODO.
+ *
+ */
+static int hw_cleanup(void)
 {
        GSList *l;
 
+       /* TODO: Error handling. */
+
        for (l = device_instances; l; l = l->next)
-               sr_device_instance_free(l->data);
+               sr_dev_inst_free(l->data);
+
+       g_slist_free(device_instances);
+       device_instances = NULL;
+
+       sr_session_source_remove(-1);
 
        g_free(sessionfile);
 
+       return SR_OK;
 }
 
 static int hw_opendev(int device_index)
 {
        struct sr_device_instance *sdi;
 
-       sdi = sr_device_instance_new(device_index, SR_ST_INITIALIZING,
+       sdi = sr_dev_inst_new(device_index, SR_ST_INITIALIZING,
                NULL, NULL, NULL);
        if (!sdi)
                return SR_ERR;
-       sdi->priv = g_malloc0(sizeof(struct session_vdevice));
-       if (!sdi->priv)
-               return SR_ERR;
+
+       if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdevice)))) {
+               sr_err("session: %s: sdi->priv malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
+
        device_instances = g_slist_append(device_instances, sdi);
 
        return SR_OK;
@@ -164,19 +214,23 @@ static void *hw_get_device_info(int device_index, int device_info_id)
 
 static int hw_get_status(int device_index)
 {
+       /* Avoid compiler warnings. */
+       (void)device_index;
 
-       /* avoid compiler warning */
-       device_index = device_index;
-
-       if (devices)
+       if (sr_dev_list() != NULL)
                return SR_OK;
        else
                return SR_ERR;
 }
 
+/**
+ * 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_get_capabilities(void)
 {
-
        return capabilities;
 }
 
@@ -192,9 +246,13 @@ static int hw_set_configuration(int device_index, int capability, void *value)
        case SR_HWCAP_SAMPLERATE:
                tmp_u64 = value;
                vdevice->samplerate = *tmp_u64;
+               sr_info("session driver: setting samplerate to %" PRIu64,
+                       vdevice->samplerate);
                break;
        case SR_HWCAP_CAPTUREFILE:
                vdevice->capturefile = g_strdup(value);
+               sr_info("session driver: setting capturefile to %s",
+                       vdevice->capturefile);
                break;
        case SR_HWCAP_CAPTURE_UNITSIZE:
                tmp_u64 = value;
@@ -205,6 +263,8 @@ static int hw_set_configuration(int device_index, int capability, void *value)
                vdevice->num_probes = *tmp_u64;
                break;
        default:
+               sr_err("session driver: %s: unknown capability %d requested",
+                      __func__, capability);
                return SR_ERR;
        }
 
@@ -219,50 +279,54 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        struct sr_datafeed_packet *packet;
        int err;
 
-       /* avoid compiler warning */
-       session_device_id = session_device_id;
+       /* Avoid compiler warnings. */
+       (void)session_device_id;
 
        if (!(vdevice = get_vdevice_by_index(device_index)))
                return SR_ERR;
 
-       g_message("session_driver: opening archive %s file %s",
-                       sessionfile, vdevice->capturefile);
+       sr_info("session_driver: opening archive %s file %s", sessionfile,
+               vdevice->capturefile);
 
        if (!(vdevice->archive = zip_open(sessionfile, 0, &err))) {
-               g_warning("Failed to open session file '%s': zip error %d\n",
-                               sessionfile, err);
+               sr_err("Failed to open session file '%s': zip error %d\n",
+                      sessionfile, err);
                return SR_ERR;
        }
 
        if (zip_stat(vdevice->archive, vdevice->capturefile, 0, &zs) == -1) {
-               g_warning("Failed to check capture file '%s' in session file '%s'.",
-                               vdevice->capturefile, sessionfile);
+               sr_err("Failed to check capture file '%s' in session file "
+                      "'%s'.", vdevice->capturefile, sessionfile);
                return SR_ERR;
        }
 
-       if (!(vdevice->capfile = zip_fopen(vdevice->archive, vdevice->capturefile, 0))) {
-               g_warning("Failed to open capture file '%s' in session file '%s'.",
-                               vdevice->capturefile, sessionfile);
+       if (!(vdevice->capfile = zip_fopen(vdevice->archive,
+                                          vdevice->capturefile, 0))) {
+               sr_err("Failed to open capture file '%s' in session file '%s'.",
+                      vdevice->capturefile, sessionfile);
                return SR_ERR;
        }
 
        /* freewheeling source */
        sr_session_source_add(-1, 0, 0, feed_chunk, session_device_id);
 
+       if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
+               sr_err("session: %s: packet malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
+
+       if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
+               sr_err("session: %s: header malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
+
        /* Send header packet to the session bus. */
-       packet = g_malloc(sizeof(struct sr_datafeed_packet));
-       header = g_malloc(sizeof(struct sr_datafeed_header));
-       if (!packet || !header)
-               return SR_ERR;
        packet->type = SR_DF_HEADER;
-       packet->length = sizeof(struct sr_datafeed_header);
        packet->payload = (unsigned char *)header;
        header->feed_version = 1;
        gettimeofday(&header->starttime, NULL);
-       header->samplerate = 0;
-       header->protocol_id = SR_PROTO_RAW;
+       header->samplerate = vdevice->samplerate;
        header->num_logic_probes = vdevice->num_probes;
-       header->num_analog_probes = 0;
        sr_session_bus(session_device_id, packet);
        g_free(header);
        g_free(packet);
@@ -270,7 +334,7 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        return SR_OK;
 }
 
-
+/* Not static, it's used elsewhere (via 'extern'). */
 struct sr_device_plugin session_driver = {
        "session",
        "Session-emulating driver",