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 "sigrok.h"
  27 #include "sigrok-internal.h"
  28
  29 /* size of payloads sent across the session bus */
  30 #define CHUNKSIZE (512 * 1024)
  31
  32 struct session_vdev {
  33         char *capturefile;
  34         struct zip *archive;
  35         struct zip_file *capfile;
  36         int bytes_read;
  37         uint64_t samplerate;
  38         int unitsize;
  39         int num_probes;
  40 };
  41
  42 static char *sessionfile = NULL;
  43 static GSList *dev_insts = NULL;
  44 static int hwcaps[] = {
  45         SR_HWCAP_CAPTUREFILE,
  46         SR_HWCAP_CAPTURE_UNITSIZE,
  47         0,
  48 };
  49
  50 /**
  51  * TODO.
  52  *
  53  * @param dev_index TODO.
  54  */
  55 static struct session_vdev *get_vdev_by_index(int dev_index)
  56 {
  57         struct sr_dev_inst *sdi;
  58         struct session_vdev *vdev;
  59
  60         /* TODO: Sanity checks on dev_index. */
  61
  62         if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
  63                 sr_err("session driver: %s: device instance with device "
  64                        "index %d was not found", __func__, dev_index);
  65                 return NULL;
  66         }
  67
  68         /* TODO: Is sdi->priv == NULL valid? */
  69
  70         vdev = sdi->priv;
  71
  72         return vdev;
  73 }
  74
  75 /**
  76  * TODO.
  77  *
  78  * @param fd TODO.
  79  * @param revents TODO.
  80  * @param session_data TODO.
  81  *
  82  * @return TODO.
  83  */
  84 static int feed_chunk(int fd, int revents, void *session_data)
  85 {
  86         struct sr_dev_inst *sdi;
  87         struct session_vdev *vdev;
  88         struct sr_datafeed_packet packet;
  89         struct sr_datafeed_logic logic;
  90         GSList *l;
  91         void *buf;
  92         int ret, got_data;
  93
  94         /* Avoid compiler warnings. */
  95         (void)fd;
  96         (void)revents;
  97
  98         sr_dbg("session_driver: feed chunk");
  99
 100         got_data = FALSE;
 101         for (l = dev_insts; l; l = l->next) {
 102                 sdi = l->data;
 103                 vdev = sdi->priv;
 104                 if (!vdev)
 105                         /* already done with this instance */
 106                         continue;
 107
 108                 if (!(buf = g_try_malloc(CHUNKSIZE))) {
 109                         sr_err("session driver: %s: buf malloc failed",
 110                                __func__);
 111                         return FALSE; /* TODO: SR_ERR_MALLOC */
 112                 }
 113
 114                 ret = zip_fread(vdev->capfile, buf, CHUNKSIZE);
 115                 if (ret > 0) {
 116                         got_data = TRUE;
 117                         packet.type = SR_DF_LOGIC;
 118                         packet.payload = &logic;
 119                         logic.length = ret;
 120                         logic.unitsize = vdev->unitsize;
 121                         logic.data = buf;
 122                         vdev->bytes_read += ret;
 123                         sr_session_bus(session_data, &packet);
 124                 } else {
 125                         /* done with this capture file */
 126                         zip_fclose(vdev->capfile);
 127                         g_free(vdev->capturefile);
 128                         g_free(vdev);
 129                         sdi->priv = NULL;
 130                 }
 131         }
 132
 133         if (!got_data) {
 134                 packet.type = SR_DF_END;
 135                 sr_session_bus(session_data, &packet);
 136         }
 137
 138         return TRUE;
 139 }
 140
 141 /* driver callbacks */
 142 static int hw_cleanup(void);
 143
 144 /**
 145  * TODO.
 146  *
 147  * @param devinfo TODO.
 148  *
 149  * @return TODO.
 150  */
 151 static int hw_init(const char *devinfo)
 152 {
 153         sessionfile = g_strdup(devinfo);
 154
 155         return 0;
 156 }
 157
 158 /**
 159  * TODO.
 160  *
 161  */
 162 static int hw_cleanup(void)
 163 {
 164         GSList *l;
 165
 166         for (l = dev_insts; l; l = l->next)
 167                 sr_dev_inst_free(l->data);
 168         g_slist_free(dev_insts);
 169         dev_insts = NULL;
 170
 171         sr_session_source_remove(-1);
 172
 173         g_free(sessionfile);
 174
 175         return SR_OK;
 176 }
 177
 178 static int hw_opendev(int dev_index)
 179 {
 180         struct sr_dev_inst *sdi;
 181
 182         sdi = sr_dev_inst_new(dev_index, SR_ST_INITIALIZING,
 183                               NULL, NULL, NULL);
 184         if (!sdi)
 185                 return SR_ERR;
 186
 187         if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdev)))) {
 188                 sr_err("session driver: %s: sdi->priv malloc failed", __func__);
 189                 return SR_ERR_MALLOC;
 190         }
 191
 192         dev_insts = g_slist_append(dev_insts, sdi);
 193
 194         return SR_OK;
 195 }
 196
 197 static void *hw_dev_info_get(int dev_index, int dev_info_id)
 198 {
 199         struct session_vdev *vdev;
 200         void *info;
 201
 202         if (dev_info_id != SR_DI_CUR_SAMPLERATE)
 203                 return NULL;
 204
 205         if (!(vdev = get_vdev_by_index(dev_index)))
 206                 return NULL;
 207
 208         info = &vdev->samplerate;
 209
 210         return info;
 211 }
 212
 213 static int hw_get_status(int dev_index)
 214 {
 215         /* Avoid compiler warnings. */
 216         (void)dev_index;
 217
 218         if (sr_dev_list() != NULL)
 219                 return SR_OK;
 220         else
 221                 return SR_ERR;
 222 }
 223
 224 /**
 225  * Get the list of hardware capabilities.
 226  *
 227  * @return A pointer to the (hardware) capabilities of this virtual session
 228  *         driver. This could be NULL, if no such capabilities exist.
 229  */
 230 static int *hw_hwcap_get_all(void)
 231 {
 232         return hwcaps;
 233 }
 234
 235 static int hw_config_set(int dev_index, int hwcap, void *value)
 236 {
 237         struct session_vdev *vdev;
 238         uint64_t *tmp_u64;
 239
 240         if (!(vdev = get_vdev_by_index(dev_index)))
 241                 return SR_ERR;
 242
 243         switch (hwcap) {
 244         case SR_HWCAP_SAMPLERATE:
 245                 tmp_u64 = value;
 246                 vdev->samplerate = *tmp_u64;
 247                 sr_info("session driver: setting samplerate to %" PRIu64,
 248                         vdev->samplerate);
 249                 break;
 250         case SR_HWCAP_CAPTUREFILE:
 251                 vdev->capturefile = g_strdup(value);
 252                 sr_info("session driver: setting capturefile to %s",
 253                         vdev->capturefile);
 254                 break;
 255         case SR_HWCAP_CAPTURE_UNITSIZE:
 256                 tmp_u64 = value;
 257                 vdev->unitsize = *tmp_u64;
 258                 break;
 259         case SR_HWCAP_CAPTURE_NUM_PROBES:
 260                 tmp_u64 = value;
 261                 vdev->num_probes = *tmp_u64;
 262                 break;
 263         default:
 264                 sr_err("session driver: %s: unknown capability %d requested",
 265                        __func__, hwcap);
 266                 return SR_ERR;
 267         }
 268
 269         return SR_OK;
 270 }
 271
 272 static int hw_start_acquisition(int dev_index, gpointer session_dev_id)
 273 {
 274         struct zip_stat zs;
 275         struct session_vdev *vdev;
 276         struct sr_datafeed_header *header;
 277         struct sr_datafeed_packet *packet;
 278         int err;
 279
 280         /* Avoid compiler warnings. */
 281         (void)session_dev_id;
 282
 283         if (!(vdev = get_vdev_by_index(dev_index)))
 284                 return SR_ERR;
 285
 286         sr_info("session_driver: opening archive %s file %s", sessionfile,
 287                 vdev->capturefile);
 288
 289         if (!(vdev->archive = zip_open(sessionfile, 0, &err))) {
 290                 sr_err("session driver: Failed to open session file '%s': "
 291                        "zip error %d\n", sessionfile, err);
 292                 return SR_ERR;
 293         }
 294
 295         if (zip_stat(vdev->archive, vdev->capturefile, 0, &zs) == -1) {
 296                 sr_err("session driver: Failed to check capture file '%s' in "
 297                        "session file '%s'.", vdev->capturefile, sessionfile);
 298                 return SR_ERR;
 299         }
 300
 301         if (!(vdev->capfile = zip_fopen(vdev->archive, vdev->capturefile, 0))) {
 302                 sr_err("session driver: Failed to open capture file '%s' in "
 303                        "session file '%s'.", vdev->capturefile, sessionfile);
 304                 return SR_ERR;
 305         }
 306
 307         /* freewheeling source */
 308         sr_session_source_add(-1, 0, 0, feed_chunk, session_dev_id);
 309
 310         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
 311                 sr_err("session driver: %s: packet malloc failed", __func__);
 312                 return SR_ERR_MALLOC;
 313         }
 314
 315         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
 316                 sr_err("session driver: %s: header malloc failed", __func__);
 317                 return SR_ERR_MALLOC;
 318         }
 319
 320         /* Send header packet to the session bus. */
 321         packet->type = SR_DF_HEADER;
 322         packet->payload = (unsigned char *)header;
 323         header->feed_version = 1;
 324         gettimeofday(&header->starttime, NULL);
 325         header->samplerate = vdev->samplerate;
 326         header->num_logic_probes = vdev->num_probes;
 327         sr_session_bus(session_dev_id, packet);
 328         g_free(header);
 329         g_free(packet);
 330
 331         return SR_OK;
 332 }
 333
 334 SR_PRIV struct sr_dev_plugin session_driver = {
 335         .name = "session",
 336         .longname = "Session-emulating driver",
 337         .api_version = 1,
 338         .init = hw_init,
 339         .cleanup = hw_cleanup,
 340         .opendev = hw_opendev,
 341         .closedev = NULL,
 342         .dev_info_get = hw_dev_info_get,
 343         .get_status = hw_get_status,
 344         .hwcap_get_all = hw_hwcap_get_all,
 345         .config_set = hw_config_set,
 346         .start_acquisition = hw_start_acquisition,
 347         .stop_acquisition = NULL,
 348 };