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