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 #define CHUNKSIZE (512 * 1024)
  31
  32 struct session_vdev {
  33         char *sessionfile;
  34         char *capturefile;
  35         struct zip *archive;
  36         struct zip_file *capfile;
  37         int bytes_read;
  38         uint64_t samplerate;
  39         int unitsize;
  40         int num_probes;
  41 };
  42
  43 static GSList *dev_insts = NULL;
  44 static const int hwcaps[] = {
  45         SR_HWCAP_CAPTUREFILE,
  46         SR_HWCAP_CAPTURE_UNITSIZE,
  47         0,
  48 };
  49
  50 static int receive_data(int fd, int revents, void *cb_data)
  51 {
  52         struct sr_dev_inst *sdi;
  53         struct session_vdev *vdev;
  54         struct sr_datafeed_packet packet;
  55         struct sr_datafeed_logic logic;
  56         GSList *l;
  57         void *buf;
  58         int ret, got_data;
  59
  60         /* Avoid compiler warnings. */
  61         (void)fd;
  62         (void)revents;
  63
  64         sr_dbg("session_driver: feed chunk");
  65
  66         got_data = FALSE;
  67         for (l = dev_insts; l; l = l->next) {
  68                 sdi = l->data;
  69                 vdev = sdi->priv;
  70                 if (!vdev)
  71                         /* already done with this instance */
  72                         continue;
  73
  74                 if (!(buf = g_try_malloc(CHUNKSIZE))) {
  75                         sr_err("session driver: %s: buf malloc failed", __func__);
  76                         return FALSE;
  77                 }
  78
  79                 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
  80                 if (ret > 0) {
  81                         got_data = TRUE;
  82                         packet.type = SR_DF_LOGIC;
  83                         packet.payload = &logic;
  84                         logic.length = ret;
  85                         logic.unitsize = vdev->unitsize;
  86                         logic.data = buf;
  87                         vdev->bytes_read += ret;
  88                         sr_session_send(cb_data, &packet);
  89                 } else {
  90                         /* done with this capture file */
  91                         zip_fclose(vdev->capfile);
  92                         g_free(vdev->capturefile);
  93                         g_free(vdev);
  94                         sdi->priv = NULL;
  95                 }
  96         }
  97
  98         if (!got_data) {
  99                 packet.type = SR_DF_END;
 100                 sr_session_send(cb_data, &packet);
 101                 sr_session_source_remove(-1);
 102         }
 103
 104         return TRUE;
 105 }
 106
 107 /* driver callbacks */
 108 static int hw_cleanup(void);
 109
 110 static int hw_init(void)
 111 {
 112
 113         return SR_OK;
 114 }
 115
 116 static int hw_cleanup(void)
 117 {
 118         GSList *l;
 119
 120         for (l = dev_insts; l; l = l->next)
 121                 sr_dev_inst_free(l->data);
 122         g_slist_free(dev_insts);
 123         dev_insts = NULL;
 124
 125         return SR_OK;
 126 }
 127
 128 static int hw_dev_open(struct sr_dev_inst *sdi)
 129 {
 130
 131         if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
 132                 sr_err("session driver: %s: sdi->priv malloc failed", __func__);
 133                 return SR_ERR_MALLOC;
 134         }
 135
 136         dev_insts = g_slist_append(dev_insts, sdi);
 137
 138         return SR_OK;
 139 }
 140
 141 static int hw_info_get(int info_id, const void **data,
 142        const struct sr_dev_inst *sdi)
 143 {
 144         struct session_vdev *vdev;
 145
 146         switch (info_id) {
 147         case SR_DI_HWCAPS:
 148                 *data = hwcaps;
 149                 break;
 150         case SR_DI_CUR_SAMPLERATE:
 151                 if (sdi) {
 152                         vdev = sdi->priv;
 153                         *data = &vdev->samplerate;
 154                 } else
 155                         return SR_ERR;
 156                 break;
 157         default:
 158                 return SR_ERR_ARG;
 159         }
 160
 161         return SR_OK;
 162 }
 163
 164 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 165                 const void *value)
 166 {
 167         struct session_vdev *vdev;
 168         const uint64_t *tmp_u64;
 169
 170         vdev = sdi->priv;
 171
 172         switch (hwcap) {
 173         case SR_HWCAP_SAMPLERATE:
 174                 tmp_u64 = value;
 175                 vdev->samplerate = *tmp_u64;
 176                 sr_info("session driver: setting samplerate to %" PRIu64,
 177                         vdev->samplerate);
 178                 break;
 179         case SR_HWCAP_SESSIONFILE:
 180                 vdev->sessionfile = g_strdup(value);
 181                 sr_info("session driver: setting sessionfile to %s",
 182                         vdev->sessionfile);
 183                 break;
 184         case SR_HWCAP_CAPTUREFILE:
 185                 vdev->capturefile = g_strdup(value);
 186                 sr_info("session driver: setting capturefile to %s",
 187                         vdev->capturefile);
 188                 break;
 189         case SR_HWCAP_CAPTURE_UNITSIZE:
 190                 tmp_u64 = value;
 191                 vdev->unitsize = *tmp_u64;
 192                 break;
 193         case SR_HWCAP_CAPTURE_NUM_PROBES:
 194                 tmp_u64 = value;
 195                 vdev->num_probes = *tmp_u64;
 196                 break;
 197         default:
 198                 sr_err("session driver: %s: unknown capability %d requested",
 199                        __func__, hwcap);
 200                 return SR_ERR;
 201         }
 202
 203         return SR_OK;
 204 }
 205
 206 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 207                 void *cb_data)
 208 {
 209         struct zip_stat zs;
 210         struct session_vdev *vdev;
 211         struct sr_datafeed_header *header;
 212         struct sr_datafeed_packet *packet;
 213         struct sr_datafeed_meta_logic meta;
 214         int ret;
 215
 216         vdev = sdi->priv;
 217
 218         sr_info("session_driver: opening archive %s file %s", vdev->sessionfile,
 219                 vdev->capturefile);
 220
 221         if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
 222                 sr_err("session driver: Failed to open session file '%s': "
 223                        "zip error %d\n", vdev->sessionfile, ret);
 224                 return SR_ERR;
 225         }
 226
 227         if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
 228                 sr_err("session driver: Failed to check capture file '%s' in "
 229                        "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 230                 return SR_ERR;
 231         }
 232
 233         if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
 234                 sr_err("session driver: Failed to open capture file '%s' in "
 235                        "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 236                 return SR_ERR;
 237         }
 238
 239         /* freewheeling source */
 240         sr_session_source_add(-1, 0, 0, receive_data, cb_data);
 241
 242         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
 243                 sr_err("session driver: %s: packet malloc failed", __func__);
 244                 return SR_ERR_MALLOC;
 245         }
 246
 247         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
 248                 sr_err("session driver: %s: header malloc failed", __func__);
 249                 return SR_ERR_MALLOC;
 250         }
 251
 252         /* Send header packet to the session bus. */
 253         packet->type = SR_DF_HEADER;
 254         packet->payload = (unsigned char *)header;
 255         header->feed_version = 1;
 256         gettimeofday(&header->starttime, NULL);
 257         sr_session_send(cb_data, packet);
 258
 259         /* Send metadata about the SR_DF_LOGIC packets to come. */
 260         packet->type = SR_DF_META_LOGIC;
 261         packet->payload = &meta;
 262         meta.samplerate = vdev->samplerate;
 263         meta.num_probes = vdev->num_probes;
 264         sr_session_send(cb_data, packet);
 265
 266         g_free(header);
 267         g_free(packet);
 268
 269         return SR_OK;
 270 }
 271
 272 SR_PRIV struct sr_dev_driver session_driver = {
 273         .name = "session",
 274         .longname = "Session-emulating driver",
 275         .api_version = 1,
 276         .init = hw_init,
 277         .cleanup = hw_cleanup,
 278         .dev_open = hw_dev_open,
 279         .dev_close = NULL,
 280         .info_get = hw_info_get,
 281         .dev_config_set = hw_dev_config_set,
 282         .dev_acquisition_start = hw_dev_acquisition_start,
 283         .dev_acquisition_stop = NULL,
 284 };