hardware/demo/demo.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  */
  21
  22 #include <stdlib.h>
  23 #include <unistd.h>
  24 #include <string.h>
  25 #include <sigrok.h>
  26 #include <sigrok-internal.h>
  27 #ifdef _WIN32
  28 #include <io.h>
  29 #include <fcntl.h>
  30 #define pipe(fds) _pipe(fds, 4096, _O_BINARY)
  31 #endif
  32 #include "config.h"
  33
  34 #define NUM_PROBES             8
  35 #define DEMONAME               "Demo device"
  36 /* size of chunks to send through the session bus */
  37 #define BUFSIZE                4096
  38
  39 enum {
  40         GENMODE_DEFAULT,
  41         GENMODE_RANDOM,
  42         GENMODE_INC,
  43 };
  44
  45 /* FIXME: Should not be global. */
  46 GIOChannel *channels[2];
  47
  48 struct databag {
  49         int pipe_fds[2];
  50         uint8_t sample_generator;
  51         uint8_t thread_running;
  52         uint64_t samples_counter;
  53         int device_index;
  54         gpointer session_device_id;
  55         GTimer *timer;
  56 };
  57
  58 static int capabilities[] = {
  59         SR_HWCAP_LOGIC_ANALYZER,
  60         SR_HWCAP_SAMPLERATE,
  61         SR_HWCAP_PATTERN_MODE,
  62         SR_HWCAP_LIMIT_SAMPLES,
  63         SR_HWCAP_LIMIT_MSEC,
  64         SR_HWCAP_CONTINUOUS,
  65 };
  66
  67 static struct sr_samplerates samplerates = {
  68         SR_HZ(1),
  69         SR_GHZ(1),
  70         SR_HZ(1),
  71         NULL,
  72 };
  73
  74 static const char *patternmodes[] = {
  75         "random",
  76         "incremental",
  77         NULL,
  78 };
  79
  80 static uint8_t genmode_default[] = {
  81         0x4c, 0x92, 0x92, 0x92, 0x64, 0x00, 0x00, 0x00,
  82         0x82, 0xfe, 0xfe, 0x82, 0x00, 0x00, 0x00, 0x00,
  83         0x7c, 0x82, 0x82, 0x92, 0x74, 0x00, 0x00, 0x00,
  84         0xfe, 0x12, 0x12, 0x32, 0xcc, 0x00, 0x00, 0x00,
  85         0x7c, 0x82, 0x82, 0x82, 0x7c, 0x00, 0x00, 0x00,
  86         0xfe, 0x10, 0x28, 0x44, 0x82, 0x00, 0x00, 0x00,
  87         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  88         0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  89 };
  90
  91 /* List of struct sr_device_instance, maintained by opendev()/closedev(). */
  92 static GSList *device_instances = NULL;
  93 static uint64_t cur_samplerate = SR_KHZ(200);
  94 static uint64_t limit_samples = 0;
  95 static uint64_t limit_msec = 0;
  96 static int default_genmode = GENMODE_DEFAULT;
  97 static GThread *my_thread;
  98 static int thread_running;
  99
 100 static void hw_stop_acquisition(int device_index, gpointer session_device_id);
 101
 102 static int hw_init(const char *deviceinfo)
 103 {
 104         struct sr_device_instance *sdi;
 105
 106         /* Avoid compiler warnings. */
 107         deviceinfo = deviceinfo;
 108
 109         sdi = sr_device_instance_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
 110         if (!sdi)
 111                 return 0;
 112
 113         device_instances = g_slist_append(device_instances, sdi);
 114
 115         return 1;
 116 }
 117
 118 static int hw_opendev(int device_index)
 119 {
 120         /* Avoid compiler warnings. */
 121         device_index = device_index;
 122
 123         /* Nothing needed so far. */
 124         return SR_OK;
 125 }
 126
 127 static void hw_closedev(int device_index)
 128 {
 129         /* Avoid compiler warnings. */
 130         device_index = device_index;
 131
 132         /* Nothing needed so far. */
 133 }
 134
 135 static void hw_cleanup(void)
 136 {
 137         /* Nothing needed so far. */
 138 }
 139
 140 static void *hw_get_device_info(int device_index, int device_info_id)
 141 {
 142         struct sr_device_instance *sdi;
 143         void *info = NULL;
 144
 145         if (!(sdi = sr_get_device_instance(device_instances, device_index)))
 146                 return NULL;
 147
 148         switch (device_info_id) {
 149         case SR_DI_INSTANCE:
 150                 info = sdi;
 151                 break;
 152         case SR_DI_NUM_PROBES:
 153                 info = GINT_TO_POINTER(NUM_PROBES);
 154                 break;
 155         case SR_DI_SAMPLERATES:
 156                 info = &samplerates;
 157                 break;
 158         case SR_DI_CUR_SAMPLERATE:
 159                 info = &cur_samplerate;
 160                 break;
 161         case SR_DI_PATTERNMODES:
 162                 info = &patternmodes;
 163                 break;
 164         }
 165
 166         return info;
 167 }
 168
 169 static int hw_get_status(int device_index)
 170 {
 171         /* Avoid compiler warnings. */
 172         device_index = device_index;
 173
 174         return SR_ST_ACTIVE;
 175 }
 176
 177 static int *hw_get_capabilities(void)
 178 {
 179         return capabilities;
 180 }
 181
 182 static int hw_set_configuration(int device_index, int capability, void *value)
 183 {
 184         int ret;
 185         uint64_t *tmp_u64;
 186         char *stropt;
 187
 188         /* Avoid compiler warnings. */
 189         device_index = device_index;
 190
 191         if (capability == SR_HWCAP_PROBECONFIG) {
 192                 /* Nothing to do, but must be supported */
 193                 ret = SR_OK;
 194         } else if (capability == SR_HWCAP_SAMPLERATE) {
 195                 tmp_u64 = value;
 196                 cur_samplerate = *tmp_u64;
 197                 sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__,
 198                        cur_samplerate);
 199                 ret = SR_OK;
 200         } else if (capability == SR_HWCAP_LIMIT_SAMPLES) {
 201                 tmp_u64 = value;
 202                 limit_samples = *tmp_u64;
 203                 sr_dbg("demo: %s: setting limit_samples to %" PRIu64, __func__,
 204                        limit_samples);
 205                 ret = SR_OK;
 206         } else if (capability == SR_HWCAP_LIMIT_MSEC) {
 207                 tmp_u64 = value;
 208                 limit_msec = *tmp_u64;
 209                 sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__,
 210                        limit_msec);
 211                 ret = SR_OK;
 212         } else if (capability == SR_HWCAP_PATTERN_MODE) {
 213                 stropt = value;
 214                 if (!strcmp(stropt, "random")) {
 215                         default_genmode = GENMODE_RANDOM;
 216                         ret = SR_OK;
 217                 } else if (!strcmp(stropt, "incremental")) {
 218                         default_genmode = GENMODE_INC;
 219                         ret = SR_OK;
 220                 } else {
 221                         ret = SR_ERR;
 222                 }
 223                 sr_dbg("demo: %s: setting patternmode to %d", __func__,
 224                        default_genmode);
 225         } else {
 226                 ret = SR_ERR;
 227         }
 228
 229         return ret;
 230 }
 231
 232 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
 233 {
 234         static uint64_t p = 0;
 235         struct databag *mydata = data;
 236         uint64_t i;
 237
 238         memset(buf, 0, size);
 239
 240         switch (mydata->sample_generator) {
 241         case GENMODE_DEFAULT:
 242                 for (i = 0; i < size; i++) {
 243                         *(buf + i) = ~(genmode_default[p] >> 1);
 244                         if (++p == 64)
 245                                 p = 0;
 246                 }
 247                 break;
 248         case GENMODE_RANDOM: /* Random */
 249                 for (i = 0; i < size; i++)
 250                         *(buf + i) = (uint8_t)(rand() & 0xff);
 251                 break;
 252         case GENMODE_INC: /* Simple increment */
 253                 for (i = 0; i < size; i++)
 254                         *(buf + i) = i;
 255                 break;
 256         }
 257 }
 258
 259 /* Thread function */
 260 static void thread_func(void *data)
 261 {
 262         struct databag *mydata = data;
 263         uint8_t buf[BUFSIZE];
 264         uint64_t nb_to_send = 0;
 265         int bytes_written;
 266
 267         double time_cur, time_last, time_diff;
 268
 269         time_last = g_timer_elapsed(mydata->timer, NULL);
 270
 271         while (thread_running) {
 272                 /* Rate control */
 273                 time_cur = g_timer_elapsed(mydata->timer, NULL);
 274
 275                 time_diff = time_cur - time_last;
 276                 time_last = time_cur;
 277
 278                 nb_to_send = cur_samplerate * time_diff;
 279
 280                 if (limit_samples)
 281                         nb_to_send = MIN(nb_to_send,
 282                                         limit_samples - mydata->samples_counter);
 283
 284                 /* Make sure we don't overflow. */
 285                 nb_to_send = MIN(nb_to_send, BUFSIZE);
 286
 287                 if (nb_to_send) {
 288                         samples_generator(buf, nb_to_send, data);
 289                         mydata->samples_counter += nb_to_send;
 290
 291                         g_io_channel_write_chars(channels[1], (gchar *)&buf,
 292                                         nb_to_send, (gsize *)&bytes_written, NULL);
 293                 }
 294
 295                 /* Check if we're done. */
 296                 if ((limit_msec && time_cur * 1000 > limit_msec) ||
 297                     (limit_samples && mydata->samples_counter >= limit_samples))
 298                 {
 299                         close(mydata->pipe_fds[1]);
 300                         thread_running = 0;
 301                 }
 302
 303                 g_usleep(10);
 304         }
 305 }
 306
 307 /* Callback handling data */
 308 static int receive_data(int fd, int revents, void *user_data)
 309 {
 310         struct sr_datafeed_packet packet;
 311         char c[BUFSIZE];
 312         gsize z;
 313
 314         /* Avoid compiler warnings. */
 315         fd = fd;
 316         revents = revents;
 317
 318         do {
 319                 g_io_channel_read_chars(channels[0],
 320                                         (gchar *)&c, BUFSIZE, &z, NULL);
 321
 322                 if (z > 0) {
 323                         packet.type = SR_DF_LOGIC;
 324                         packet.length = z;
 325                         packet.unitsize = 1;
 326                         packet.payload = c;
 327                         sr_session_bus(user_data, &packet);
 328                 }
 329         } while (z > 0);
 330
 331         if (!thread_running && z <= 0)
 332         {
 333                 /* Make sure we don't receive more packets */
 334                 g_io_channel_close(channels[0]);
 335
 336                 /* Send last packet. */
 337                 packet.type = SR_DF_END;
 338                 sr_session_bus(user_data, &packet);
 339
 340                 return FALSE;
 341         }
 342
 343         return TRUE;
 344 }
 345
 346 static int hw_start_acquisition(int device_index, gpointer session_device_id)
 347 {
 348         struct sr_datafeed_packet *packet;
 349         struct sr_datafeed_header *header;
 350         struct databag *mydata;
 351
 352         /* TODO: 'mydata' is never g_free()'d? */
 353         if (!(mydata = g_try_malloc(sizeof(struct databag)))) {
 354                 sr_err("demo: %s: mydata malloc failed", __func__);
 355                 return SR_ERR_MALLOC;
 356         }
 357
 358         mydata->sample_generator = default_genmode;
 359         mydata->session_device_id = session_device_id;
 360         mydata->device_index = device_index;
 361         mydata->samples_counter = 0;
 362
 363         if (pipe(mydata->pipe_fds))
 364                 return SR_ERR;
 365
 366         channels[0] = g_io_channel_unix_new(mydata->pipe_fds[0]);
 367         channels[1] = g_io_channel_unix_new(mydata->pipe_fds[1]);
 368
 369         /* Set channel encoding to binary (default is UTF-8). */
 370         g_io_channel_set_encoding(channels[0], NULL, NULL);
 371         g_io_channel_set_encoding(channels[1], NULL, NULL);
 372
 373         /* Make channels to unbuffered. */
 374         g_io_channel_set_buffered(channels[0], FALSE);
 375         g_io_channel_set_buffered(channels[1], FALSE);
 376
 377         sr_source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40,
 378                       receive_data, session_device_id);
 379
 380         /* Run the demo thread. */
 381         g_thread_init(NULL);
 382         /* this needs to be done between g_thread_init() and g_thread_create() */
 383         mydata->timer = g_timer_new();
 384         thread_running = 1;
 385         my_thread =
 386             g_thread_create((GThreadFunc)thread_func, mydata, TRUE, NULL);
 387         if (!my_thread)
 388                 return SR_ERR;
 389
 390         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
 391                 sr_err("demo: %s: packet malloc failed", __func__);
 392                 return SR_ERR_MALLOC;
 393         }
 394
 395         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
 396                 sr_err("demo: %s: header malloc failed", __func__);
 397                 return SR_ERR_MALLOC;
 398         }
 399
 400         packet->type = SR_DF_HEADER;
 401         packet->length = sizeof(struct sr_datafeed_header);
 402         packet->payload = (unsigned char *)header;
 403         header->feed_version = 1;
 404         gettimeofday(&header->starttime, NULL);
 405         header->samplerate = cur_samplerate;
 406         header->protocol_id = SR_PROTO_RAW;
 407         header->num_logic_probes = NUM_PROBES;
 408         header->num_analog_probes = 0;
 409         sr_session_bus(session_device_id, packet);
 410         g_free(header);
 411         g_free(packet);
 412
 413         return SR_OK;
 414 }
 415
 416 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
 417 {
 418         /* Avoid compiler warnings. */
 419         device_index = device_index;
 420         session_device_id = session_device_id;
 421
 422         /* Stop generate thread. */
 423         thread_running = 0;
 424 }
 425
 426 struct sr_device_plugin demo_plugin_info = {
 427         .name = "demo",
 428         .longname = "Demo driver and pattern generator",
 429         .api_version = 1,
 430         .init = hw_init,
 431         .cleanup = hw_cleanup,
 432         .opendev = hw_opendev,
 433         .closedev = hw_closedev,
 434         .get_device_info = hw_get_device_info,
 435         .get_status = hw_get_status,
 436         .get_capabilities = hw_get_capabilities,
 437         .set_configuration = hw_set_configuration,
 438         .start_acquisition = hw_start_acquisition,
 439         .stop_acquisition = hw_stop_acquisition,
 440 };