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