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_status_get(int dev_index)
 186 {
 187         /* Avoid compiler warnings. */
 188         (void)dev_index;
 189
 190         if (sr_dev_list() != NULL)
 191                 return SR_OK;
 192         else
 193                 return SR_ERR;
 194 }
 195
 196 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
 197                 const void *value)
 198 {
 199         struct session_vdev *vdev;
 200         const uint64_t *tmp_u64;
 201
 202         vdev = sdi->priv;
 203
 204         switch (hwcap) {
 205         case SR_HWCAP_SAMPLERATE:
 206                 tmp_u64 = value;
 207                 vdev->samplerate = *tmp_u64;
 208                 sr_info("session driver: setting samplerate to %" PRIu64,
 209                         vdev->samplerate);
 210                 break;
 211         case SR_HWCAP_SESSIONFILE:
 212                 vdev->sessionfile = g_strdup(value);
 213                 sr_info("session driver: setting sessionfile to %s",
 214                         vdev->sessionfile);
 215                 break;
 216         case SR_HWCAP_CAPTUREFILE:
 217                 vdev->capturefile = g_strdup(value);
 218                 sr_info("session driver: setting capturefile to %s",
 219                         vdev->capturefile);
 220                 break;
 221         case SR_HWCAP_CAPTURE_UNITSIZE:
 222                 tmp_u64 = value;
 223                 vdev->unitsize = *tmp_u64;
 224                 break;
 225         case SR_HWCAP_CAPTURE_NUM_PROBES:
 226                 tmp_u64 = value;
 227                 vdev->num_probes = *tmp_u64;
 228                 break;
 229         default:
 230                 sr_err("session driver: %s: unknown capability %d requested",
 231                        __func__, hwcap);
 232                 return SR_ERR;
 233         }
 234
 235         return SR_OK;
 236 }
 237
 238 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 239                 void *cb_data)
 240 {
 241         struct zip_stat zs;
 242         struct session_vdev *vdev;
 243         struct sr_datafeed_header *header;
 244         struct sr_datafeed_packet *packet;
 245         struct sr_datafeed_meta_logic meta;
 246         int ret;
 247
 248         vdev = sdi->priv;
 249
 250         sr_info("session_driver: opening archive %s file %s", vdev->sessionfile,
 251                 vdev->capturefile);
 252
 253         if (!(vdev->archive = zip_open(vdev->sessionfile, 0, &ret))) {
 254                 sr_err("session driver: Failed to open session file '%s': "
 255                        "zip error %d\n", vdev->sessionfile, ret);
 256                 return SR_ERR;
 257         }
 258
 259         if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
 260                 sr_err("session driver: Failed to check capture file '%s' in "
 261                        "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 262                 return SR_ERR;
 263         }
 264
 265         if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
 266                 sr_err("session driver: Failed to open capture file '%s' in "
 267                        "session file '%s'.", vdev->capturefile, vdev->sessionfile);
 268                 return SR_ERR;
 269         }
 270
 271         /* freewheeling source */
 272         sr_session_source_add(-1, 0, 0, receive_data, cb_data);
 273
 274         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
 275                 sr_err("session driver: %s: packet malloc failed", __func__);
 276                 return SR_ERR_MALLOC;
 277         }
 278
 279         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
 280                 sr_err("session driver: %s: header malloc failed", __func__);
 281                 return SR_ERR_MALLOC;
 282         }
 283
 284         /* Send header packet to the session bus. */
 285         packet->type = SR_DF_HEADER;
 286         packet->payload = (unsigned char *)header;
 287         header->feed_version = 1;
 288         gettimeofday(&header->starttime, NULL);
 289         sr_session_send(cb_data, packet);
 290
 291         /* Send metadata about the SR_DF_LOGIC packets to come. */
 292         packet->type = SR_DF_META_LOGIC;
 293         packet->payload = &meta;
 294         meta.samplerate = vdev->samplerate;
 295         meta.num_probes = vdev->num_probes;
 296         sr_session_send(cb_data, packet);
 297
 298         g_free(header);
 299         g_free(packet);
 300
 301         return SR_OK;
 302 }
 303
 304 SR_PRIV struct sr_dev_driver session_driver = {
 305         .name = "session",
 306         .longname = "Session-emulating driver",
 307         .api_version = 1,
 308         .init = hw_init,
 309         .cleanup = hw_cleanup,
 310         .dev_open = hw_dev_open,
 311         .dev_close = NULL,
 312         .info_get = hw_info_get,
 313         .dev_status_get = hw_dev_status_get,
 314         .dev_config_set = hw_dev_config_set,
 315         .dev_acquisition_start = hw_dev_acquisition_start,
 316         .dev_acquisition_stop = NULL,
 317 };