sr: adjust copyright year

[libsigrok.git] / session_driver.c

diff --git a/session_driver.c b/session_driver.c
index fd5b11fc55cab186aa6e6d3ccd034811e2e4c965..f1c01918222e6827d1f14bd7529d5a5f4be9551b 100644 (file)
--- a/session_driver.c
+++ b/session_driver.c
@@ -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
@@ -23,16 +23,17 @@
 #include <unistd.h>
 #include <sys/time.h>
 #include <zip.h>
-#include <sigrok.h>
-#include <sigrok-internal.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;
@@ -46,20 +47,40 @@ 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_get_device_instance(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;
 }
 
+/**
+ * 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;
@@ -86,20 +107,18 @@ static int feed_chunk(int fd, int revents, void *session_data)
 
                if (!(buf = g_try_malloc(CHUNKSIZE))) {
                        sr_err("session: %s: buf malloc failed", __func__);
-                       // return SR_ERR_MALLOC;
-                       return FALSE;
+                       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.timeoffset = 0;
-                       packet.duration = 0;
                        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 */
@@ -121,15 +140,25 @@ static int feed_chunk(int fd, int revents, void *session_data)
 /* driver callbacks */
 static void hw_cleanup(void);
 
+/**
+ * TODO.
+ *
+ * @param deviceinfo TODO.
+ *
+ * @return TODO.
+ */
 static int hw_init(const char *deviceinfo)
 {
-       hw_cleanup();
 
        sessionfile = g_strdup(deviceinfo);
 
        return 0;
 }
 
+/**
+ * TODO.
+ *
+ */
 static void hw_cleanup(void)
 {
        GSList *l;
@@ -143,7 +172,6 @@ static void hw_cleanup(void)
        sr_session_source_remove(-1);
 
        g_free(sessionfile);
-
 }
 
 static int hw_opendev(int device_index)
@@ -186,15 +214,20 @@ static int hw_get_status(int device_index)
        /* Avoid compiler warnings. */
        (void)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;
 }
 
@@ -210,9 +243,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;
@@ -223,6 +260,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;
        }
 
@@ -247,20 +286,21 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
                vdevice->capturefile);
 
        if (!(vdevice->archive = zip_open(sessionfile, 0, &err))) {
-               sr_warn("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) {
-               sr_warn("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))) {
-               sr_warn("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;
        }
 
@@ -284,7 +324,6 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        gettimeofday(&header->starttime, NULL);
        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);
@@ -292,6 +331,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",