session_driver.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2011 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 4096
  31
  32 struct session_vdevice {
  33         char *capturefile;
  34         struct zip *archive;
  35         struct zip_file *capfile;
  36         uint64_t samplerate;
  37         int unitsize;
  38         int num_probes;
  39 };
  40
  41 static char *sessionfile = NULL;
  42 static GSList *device_instances = NULL;
  43 static int capabilities[] = {
  44         SR_HWCAP_CAPTUREFILE,
  45         SR_HWCAP_CAPTURE_UNITSIZE,
  46         0,
  47 };
  48
  49
  50 static struct session_vdevice *get_vdevice_by_index(int device_index)
  51 {
  52         struct sr_device_instance *sdi;
  53         struct session_vdevice *vdevice;
  54
  55         if (!(sdi = sr_get_device_instance(device_instances, device_index)))
  56                 return NULL;
  57
  58         vdevice = sdi->priv;
  59
  60         return vdevice;
  61 }
  62
  63 static int feed_chunk(int fd, int revents, void *session_data)
  64 {
  65         struct sr_device_instance *sdi;
  66         struct session_vdevice *vdevice;
  67         struct sr_datafeed_packet packet;
  68         struct sr_datafeed_logic logic;
  69         GSList *l;
  70         void *buf;
  71         int ret, got_data;
  72
  73         /* avoid compiler warning */
  74         fd = fd;
  75         revents = revents;
  76
  77         sr_dbg("session_driver: feed chunk");
  78
  79         got_data = FALSE;
  80         for (l = device_instances; l; l = l->next) {
  81                 sdi = l->data;
  82                 vdevice = sdi->priv;
  83                 if (!vdevice)
  84                         /* already done with this instance */
  85                         continue;
  86
  87                 if (!(buf = g_try_malloc(CHUNKSIZE))) {
  88                         sr_err("session: %s: buf malloc failed", __func__);
  89                         // return SR_ERR_MALLOC;
  90                         return FALSE;
  91                 }
  92
  93                 ret = zip_fread(vdevice->capfile, buf, CHUNKSIZE);
  94                 if (ret > 0) {
  95                         got_data = TRUE;
  96                         packet.type = SR_DF_LOGIC;
  97                         packet.timeoffset = 0;
  98                         packet.duration = 0;
  99                         packet.payload = &logic;
 100                         logic.length = ret;
 101                         logic.unitsize = vdevice->unitsize;
 102                         logic.data = buf;
 103                         sr_session_bus(session_data, &packet);
 104                 } else {
 105                         /* done with this capture file */
 106                         zip_fclose(vdevice->capfile);
 107                         g_free(vdevice->capturefile);
 108                         g_free(vdevice);
 109                         sdi->priv = NULL;
 110                 }
 111         }
 112
 113         if (!got_data) {
 114                 packet.type = SR_DF_END;
 115                 sr_session_bus(session_data, &packet);
 116         }
 117
 118         return TRUE;
 119 }
 120
 121 /* driver callbacks */
 122
 123 static int hw_init(const char *deviceinfo)
 124 {
 125
 126         sessionfile = g_strdup(deviceinfo);
 127
 128         return 0;
 129 }
 130
 131 static void hw_cleanup(void)
 132 {
 133         GSList *l;
 134
 135         for (l = device_instances; l; l = l->next)
 136                 sr_device_instance_free(l->data);
 137
 138         g_free(sessionfile);
 139
 140 }
 141
 142 static int hw_opendev(int device_index)
 143 {
 144         struct sr_device_instance *sdi;
 145
 146         sdi = sr_device_instance_new(device_index, SR_ST_INITIALIZING,
 147                 NULL, NULL, NULL);
 148         if (!sdi)
 149                 return SR_ERR;
 150
 151         if (!(sdi->priv = g_try_malloc0(sizeof(struct session_vdevice)))) {
 152                 sr_err("session: %s: sdi->priv malloc failed", __func__);
 153                 return SR_ERR_MALLOC;
 154         }
 155
 156         device_instances = g_slist_append(device_instances, sdi);
 157
 158         return SR_OK;
 159 }
 160
 161 static void *hw_get_device_info(int device_index, int device_info_id)
 162 {
 163         struct session_vdevice *vdevice;
 164         void *info;
 165
 166         if (device_info_id != SR_DI_CUR_SAMPLERATE)
 167                 return NULL;
 168
 169         if (!(vdevice = get_vdevice_by_index(device_index)))
 170                 return NULL;
 171
 172         info = &vdevice->samplerate;
 173
 174         return info;
 175 }
 176
 177 static int hw_get_status(int device_index)
 178 {
 179
 180         /* avoid compiler warning */
 181         device_index = device_index;
 182
 183         if (devices)
 184                 return SR_OK;
 185         else
 186                 return SR_ERR;
 187 }
 188
 189 static int *hw_get_capabilities(void)
 190 {
 191
 192         return capabilities;
 193 }
 194
 195 static int hw_set_configuration(int device_index, int capability, void *value)
 196 {
 197         struct session_vdevice *vdevice;
 198         uint64_t *tmp_u64;
 199
 200         if (!(vdevice = get_vdevice_by_index(device_index)))
 201                 return SR_ERR;
 202
 203         switch (capability) {
 204         case SR_HWCAP_SAMPLERATE:
 205                 tmp_u64 = value;
 206                 vdevice->samplerate = *tmp_u64;
 207                 break;
 208         case SR_HWCAP_CAPTUREFILE:
 209                 vdevice->capturefile = g_strdup(value);
 210                 break;
 211         case SR_HWCAP_CAPTURE_UNITSIZE:
 212                 tmp_u64 = value;
 213                 vdevice->unitsize = *tmp_u64;
 214                 break;
 215         case SR_HWCAP_CAPTURE_NUM_PROBES:
 216                 tmp_u64 = value;
 217                 vdevice->num_probes = *tmp_u64;
 218                 break;
 219         default:
 220                 return SR_ERR;
 221         }
 222
 223         return SR_OK;
 224 }
 225
 226 static int hw_start_acquisition(int device_index, gpointer session_device_id)
 227 {
 228         struct zip_stat zs;
 229         struct session_vdevice *vdevice;
 230         struct sr_datafeed_header *header;
 231         struct sr_datafeed_packet *packet;
 232         int err;
 233
 234         /* avoid compiler warning */
 235         session_device_id = session_device_id;
 236
 237         if (!(vdevice = get_vdevice_by_index(device_index)))
 238                 return SR_ERR;
 239
 240         sr_info("session_driver: opening archive %s file %s", sessionfile,
 241                 vdevice->capturefile);
 242
 243         if (!(vdevice->archive = zip_open(sessionfile, 0, &err))) {
 244                 sr_warn("Failed to open session file '%s': zip error %d\n",
 245                         sessionfile, err);
 246                 return SR_ERR;
 247         }
 248
 249         if (zip_stat(vdevice->archive, vdevice->capturefile, 0, &zs) == -1) {
 250                 sr_warn("Failed to check capture file '%s' in session file '%s'.",
 251                         vdevice->capturefile, sessionfile);
 252                 return SR_ERR;
 253         }
 254
 255         if (!(vdevice->capfile = zip_fopen(vdevice->archive, vdevice->capturefile, 0))) {
 256                 sr_warn("Failed to open capture file '%s' in session file '%s'.",
 257                         vdevice->capturefile, sessionfile);
 258                 return SR_ERR;
 259         }
 260
 261         /* freewheeling source */
 262         sr_session_source_add(-1, 0, 0, feed_chunk, session_device_id);
 263
 264         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
 265                 sr_err("session: %s: packet malloc failed", __func__);
 266                 return SR_ERR_MALLOC;
 267         }
 268
 269         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
 270                 sr_err("session: %s: header malloc failed", __func__);
 271                 return SR_ERR_MALLOC;
 272         }
 273
 274         /* Send header packet to the session bus. */
 275         packet->type = SR_DF_HEADER;
 276         packet->payload = (unsigned char *)header;
 277         header->feed_version = 1;
 278         gettimeofday(&header->starttime, NULL);
 279         header->samplerate = 0;
 280         header->num_logic_probes = vdevice->num_probes;
 281         header->num_analog_probes = 0;
 282         sr_session_bus(session_device_id, packet);
 283         g_free(header);
 284         g_free(packet);
 285
 286         return SR_OK;
 287 }
 288
 289 struct sr_device_plugin session_driver = {
 290         "session",
 291         "Session-emulating driver",
 292         1,
 293         hw_init,
 294         hw_cleanup,
 295         hw_opendev,
 296         NULL,
 297         hw_get_device_info,
 298         hw_get_status,
 299         hw_get_capabilities,
 300         hw_set_configuration,
 301         hw_start_acquisition,
 302         NULL,
 303 };