session_driver.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <sys/types.h>
  21 #include <sys/stat.h>
  22 #include <fcntl.h>
  23 #include <unistd.h>
  24 #include <sys/time.h>
  25 #include <zip.h>
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28
  29 /* size of payloads sent across the session bus */
  30 /** @cond PRIVATE */
  31 #define CHUNKSIZE (512 * 1024)
  32 /** @endcond */
  33
  34 struct session_vdev {
  35         char *sessionfile;
  36         char *capturefile;
  37         struct zip *archive;
  38         struct zip_file *capfile;
  39         int bytes_read;
  40         uint64_t samplerate;
  41         int unitsize;
  42         int num_probes;
  43 };
  44
  45 static GSList *dev_insts = NULL;
  46 static const int hwcaps[] = {
  47         SR_HWCAP_CAPTUREFILE,
  48         SR_HWCAP_CAPTURE_UNITSIZE,
  49         0,
  50 };
  51
  52 static int receive_data(int fd, int revents, void *cb_data)
  53 {
  54         struct sr_dev_inst *sdi;
  55         struct session_vdev *vdev;
  56         struct sr_datafeed_packet packet;
  57         struct sr_datafeed_logic logic;
  58         GSList *l;
  59         void *buf;
  60         int ret, got_data;
  61
  62         (void)fd;
  63         (void)revents;
  64
  65         sr_dbg("session_driver: feed chunk");
  66
  67         got_data = FALSE;
  68         for (l = dev_insts; l; l = l->next) {
  69                 sdi = l->data;
  70                 vdev = sdi->priv;
  71                 if (!vdev)
  72                         /* already done with this instance */
  73                         continue;
  74
  75                 if (!(buf = g_try_malloc(CHUNKSIZE))) {
  76                         sr_err("session driver: %s: buf malloc failed", __func__);
  77                         return FALSE;
  78                 }
  79
  80                 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
  81                 if (ret > 0) {
  82                         got_data = TRUE;
  83                         packet.type = SR_DF_LOGIC;
  84                         packet.payload = &logic;
  85                         logic.length = ret;
  86                         logic.unitsize = vdev->unitsize;
  87                         logic.data = buf;
  88                         vdev->bytes_read += ret;
  89                         sr_session_send(cb_data, &packet);
  90                 } else {
  91                         /* done with this capture file */
  92                         zip_fclose(vdev->capfile);
  93                         g_free(vdev->capturefile);
  94                         g_free(vdev);
  95                         sdi->priv = NULL;
  96                 }
  97         }
  98
  99         if (!got_data) {
 100                 packet.type = SR_DF_END;
 101                 sr_session_send(cb_data, &packet);
 102                 sr_session_source_remove(-1);
 103         }
 104
 105         return TRUE;
 106 }
 107
 108 /* driver callbacks */
 109 static int hw_cleanup(void);
 110
 111 static int hw_init(void)
 112 {
 113
 114         return SR_OK;
 115 }
 116
 117 static int hw_cleanup(void)
 118 {
 119         GSList *l;
 120
 121         for (l = dev_insts; l; l = l->next)
 122                 sr_dev_inst_free(l->data);
 123         g_slist_free(dev_insts);
 124         dev_insts = NULL;
 125
 126         return SR_OK;
 127 }
 128
 129 static int hw_dev_open(struct sr_dev_inst *sdi)
 130 {
 131
 132         if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
 133                 sr_err("session driver: %s: sdi->priv malloc failed", __func__);
 134                 return SR_ERR_MALLOC;
 135         }
 136
 137         dev_insts = g_slist_append(dev_insts, sdi);
 138
 139         return SR_OK;
 140 }
 141
 142 static int hw_info_get(int info_id, const void **data,
 143        const struct sr_dev_inst *sdi)
 144 {
 145         struct session_vdev *vdev;
 146
 147         switch (info_id) {
 148         case SR_DI_HWCAPS:
 149                 *data = hwcaps;
 150                 break;
 151         case SR_DI_CUR_SAMPLERATE:
 152                 if (sdi) {
 153                         vdev = sdi->priv;
 154                         *data = &vdev->samplerate;
 155                 } else
 156                         return SR_ERR;
 157                 break;
 158         default:
 159                 return SR_ERR_ARG;
 160         }
 161
 162         return SR_OK;
 163 }
 164
 165 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 166                 const void *value)
 167 {
 168         struct session_vdev *vdev;
 169         const uint64_t *tmp_u64;
 170
 171         vdev = sdi->priv;
 172
 173         switch (hwcap) {
 174         case SR_HWCAP_SAMPLERATE:
 175                 tmp_u64 = value;
 176                 vdev->samplerate = *tmp_u64;
 177                 sr_info("session driver: setting samplerate to %" PRIu64,
 178                         vdev->samplerate);
 179                 break;
 180         case SR_HWCAP_SESSIONFILE:
 181                 vdev->sessionfile = g_strdup(value);
 182                 sr_info("session driver: setting sessionfile to %s",
 183                         vdev->sessionfile);
 184                 break;
 185         case SR_HWCAP_CAPTUREFILE:
 186                 vdev->capturefile = g_strdup(value);
 187                 sr_info("session driver: setting capturefile to %s",
 188                         vdev->capturefile);
 189                 break;
 190         case SR_HWCAP_CAPTURE_UNITSIZE:
 191                 tmp_u64 = value;
 192                 vdev->unitsize = *tmp_u64;
 193                 break;
 194         case SR_HWCAP_CAPTURE_NUM_PROBES:
 195                 tmp_u64 = value;
 196                 vdev->num_probes = *tmp_u64;
 197                 break;
 198         default:
 199                 sr_err("session driver: %s: unknown capability %d requested",
 200                        __func__, hwcap);
 201                 return SR_ERR;
 202         }
 203
 204         return SR_OK;
 205 }
 206
 207 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 208                 void *cb_data)
 209 {
 210         struct zip_stat zs;
 211         struct session_vdev *vdev;
 212         struct sr_datafeed_header *header;
 213         struct sr_datafeed_packet *packet;
 214         struct sr_datafeed_meta_logic meta;
 215         int ret;
 216
 217         vdev = sdi->priv;
 218
 219         sr_info("session_driver: opening archive %s file %s", vdev->sessionfile,
 220                 vdev->capturefile);
 221
 222         if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
 223                 sr_err("session driver: Failed to open session file '%s': "
 224                        "zip error %d\n", vdev->sessionfile, ret);
 225                 return SR_ERR;
 226         }
 227
 228         if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
 229                 sr_err("session driver: Failed to check capture file '%s' in "
 230                        "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 231                 return SR_ERR;
 232         }
 233
 234         if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
 235                 sr_err("session driver: Failed to open capture file '%s' in "
 236                        "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 237                 return SR_ERR;
 238         }
 239
 240         /* freewheeling source */
 241         sr_session_source_add(-1, 0, 0, receive_data, cb_data);
 242
 243         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
 244                 sr_err("session driver: %s: packet malloc failed", __func__);
 245                 return SR_ERR_MALLOC;
 246         }
 247
 248         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
 249                 sr_err("session driver: %s: header malloc failed", __func__);
 250                 return SR_ERR_MALLOC;
 251         }
 252
 253         /* Send header packet to the session bus. */
 254         packet->type = SR_DF_HEADER;
 255         packet->payload = (unsigned char *)header;
 256         header->feed_version = 1;
 257         gettimeofday(&header->starttime, NULL);
 258         sr_session_send(cb_data, packet);
 259
 260         /* Send metadata about the SR_DF_LOGIC packets to come. */
 261         packet->type = SR_DF_META_LOGIC;
 262         packet->payload = &meta;
 263         meta.samplerate = vdev->samplerate;
 264         meta.num_probes = vdev->num_probes;
 265         sr_session_send(cb_data, packet);
 266
 267         g_free(header);
 268         g_free(packet);
 269
 270         return SR_OK;
 271 }
 272
 273 /** @private */
 274 SR_PRIV struct sr_dev_driver session_driver = {
 275         .name = "session",
 276         .longname = "Session-emulating driver",
 277         .api_version = 1,
 278         .init = hw_init,
 279         .cleanup = hw_cleanup,
 280         .dev_open = hw_dev_open,
 281         .dev_close = NULL,
 282         .info_get = hw_info_get,
 283         .dev_config_set = hw_dev_config_set,
 284         .dev_acquisition_start = hw_dev_acquisition_start,
 285         .dev_acquisition_stop = NULL,
 286 };