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