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 #ifdef _WIN32
  27 #include <io.h>
  28 #include <fcntl.h>
  29 #define pipe(fds) _pipe(fds, 4096, _O_BINARY)
  30 #endif
  31 #include "config.h"
  32
  33 #define NUM_PROBES             8
  34 #define DEMONAME               "Demo device"
  35 /* size of chunks to send through the session bus */
  36 #define BUFSIZE                4096
  37
  38 enum {
  39         GENMODE_DEFAULT,
  40         GENMODE_RANDOM,
  41         GENMODE_INC,
  42 };
  43
  44 GIOChannel *channels[2];
  45
  46 struct databag {
  47         int pipe_fds[2];
  48         uint8_t sample_generator;
  49         uint8_t thread_running;
  50         uint64_t samples_counter;
  51         int device_index;
  52         gpointer session_device_id;
  53         GTimer *timer;
  54 };
  55
  56 static int capabilities[] = {
  57         HWCAP_LOGIC_ANALYZER,
  58         HWCAP_PATTERN_MODE,
  59         HWCAP_LIMIT_SAMPLES,
  60         HWCAP_LIMIT_MSEC,
  61         HWCAP_CONTINUOUS
  62 };
  63
  64 static const char *patternmodes[] = {
  65         "random",
  66         "incremental",
  67         NULL,
  68 };
  69
  70 static uint8_t genmode_default[] = {
  71         0x4c, 0x92, 0x92, 0x92, 0x64, 0x00, 0x00, 0x00,
  72         0x82, 0xfe, 0xfe, 0x82, 0x00, 0x00, 0x00, 0x00,
  73         0x7c, 0x82, 0x82, 0x92, 0x74, 0x00, 0x00, 0x00,
  74         0xfe, 0x12, 0x12, 0x32, 0xcc, 0x00, 0x00, 0x00,
  75         0x7c, 0x82, 0x82, 0x82, 0x7c, 0x00, 0x00, 0x00,
  76         0xfe, 0x10, 0x28, 0x44, 0x82, 0x00, 0x00, 0x00,
  77         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  78         0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  79 };
  80
  81 /* List of struct sigrok_device_instance, maintained by opendev()/closedev(). */
  82 static GSList *device_instances = NULL;
  83 static uint64_t cur_samplerate = KHZ(200);
  84 static uint64_t limit_samples = 0;
  85 static uint64_t limit_msec = 0;
  86 static int default_genmode = GENMODE_DEFAULT;
  87 static GThread *my_thread;
  88 static int thread_running;
  89
  90 static void hw_stop_acquisition(int device_index, gpointer session_device_id);
  91
  92 static int hw_init(char *deviceinfo)
  93 {
  94         struct sigrok_device_instance *sdi;
  95
  96         /* Avoid compiler warnings. */
  97         deviceinfo = deviceinfo;
  98
  99         sdi = sigrok_device_instance_new(0, ST_ACTIVE, DEMONAME, NULL, NULL);
 100         if (!sdi)
 101                 return 0;
 102
 103         device_instances = g_slist_append(device_instances, sdi);
 104
 105         return 1;
 106 }
 107
 108 static int hw_opendev(int device_index)
 109 {
 110         /* Avoid compiler warnings. */
 111         device_index = device_index;
 112
 113         /* Nothing needed so far. */
 114         return SIGROK_OK;
 115 }
 116
 117 static void hw_closedev(int device_index)
 118 {
 119         /* Avoid compiler warnings. */
 120         device_index = device_index;
 121
 122         /* Nothing needed so far. */
 123 }
 124
 125 static void hw_cleanup(void)
 126 {
 127         /* Nothing needed so far. */
 128 }
 129
 130 static void *hw_get_device_info(int device_index, int device_info_id)
 131 {
 132         struct sigrok_device_instance *sdi;
 133         void *info = NULL;
 134
 135         if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
 136                 return NULL;
 137
 138         switch (device_info_id) {
 139         case DI_INSTANCE:
 140                 info = sdi;
 141                 break;
 142         case DI_NUM_PROBES:
 143                 info = GINT_TO_POINTER(NUM_PROBES);
 144                 break;
 145         case DI_CUR_SAMPLERATE:
 146                 info = &cur_samplerate;
 147                 break;
 148         case DI_PATTERNMODES:
 149                 info = &patternmodes;
 150                 break;
 151         }
 152
 153         return info;
 154 }
 155
 156 static int hw_get_status(int device_index)
 157 {
 158         /* Avoid compiler warnings. */
 159         device_index = device_index;
 160
 161         return ST_ACTIVE;
 162 }
 163
 164 static int *hw_get_capabilities(void)
 165 {
 166         return capabilities;
 167 }
 168
 169 static int hw_set_configuration(int device_index, int capability, void *value)
 170 {
 171         int ret;
 172         uint64_t *tmp_u64;
 173         char *stropt;
 174
 175         /* Avoid compiler warnings. */
 176         device_index = device_index;
 177
 178         if (capability == HWCAP_PROBECONFIG) {
 179                 /* Nothing to do. */
 180                 ret = SIGROK_OK;
 181         } else if (capability == HWCAP_LIMIT_SAMPLES) {
 182                 tmp_u64 = value;
 183                 limit_samples = *tmp_u64;
 184                 ret = SIGROK_OK;
 185         } else if (capability == HWCAP_LIMIT_MSEC) {
 186                 tmp_u64 = value;
 187                 limit_msec = *tmp_u64;
 188                 ret = SIGROK_OK;
 189         } else if (capability == HWCAP_PATTERN_MODE) {
 190                 stropt = value;
 191                 if (!strcmp(stropt, "random")) {
 192                         default_genmode = GENMODE_RANDOM;
 193                         ret = SIGROK_OK;
 194                 } else if (!strcmp(stropt, "incremental")) {
 195                         default_genmode = GENMODE_INC;
 196                         ret = SIGROK_OK;
 197                 } else {
 198                         ret = SIGROK_ERR;
 199                 }
 200         } else {
 201                 ret = SIGROK_ERR;
 202         }
 203
 204         return ret;
 205 }
 206
 207 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
 208 {
 209         struct databag *mydata = data;
 210         uint64_t p, i;
 211
 212         memset(buf, 0, size);
 213
 214         switch (mydata->sample_generator) {
 215         case GENMODE_DEFAULT:
 216                 p = 0;
 217                 for (i = 0; i < size; i++) {
 218                         *(buf + i) = ~(genmode_default[p] >> 1);
 219                         if (++p == 64)
 220                                 p = 0;
 221                 }
 222                 break;
 223         case GENMODE_RANDOM: /* Random */
 224                 for (i = 0; i < size; i++)
 225                         *(buf + i) = (uint8_t)(rand() & 0xff);
 226                 break;
 227         case GENMODE_INC: /* Simple increment */
 228                 for (i = 0; i < size; i++)
 229                         *(buf + i) = i;
 230                 break;
 231         }
 232 }
 233
 234 /* Thread function */
 235 static void thread_func(void *data)
 236 {
 237         struct databag *mydata = data;
 238         uint8_t buf[BUFSIZE];
 239         uint64_t nb_to_send = 0;
 240         int bytes_written;
 241
 242         double time_cur, time_last, time_diff;
 243
 244         time_last = g_timer_elapsed(mydata->timer, NULL);
 245
 246         while (thread_running) {
 247                 /* Rate control */
 248                 time_cur = g_timer_elapsed(mydata->timer, NULL);
 249
 250                 time_diff = time_cur - time_last;
 251                 time_last = time_cur;
 252
 253                 nb_to_send = cur_samplerate * time_diff;
 254
 255                 if (limit_samples)
 256                         nb_to_send = MIN(nb_to_send,
 257                                         limit_samples - mydata->samples_counter);
 258
 259                 /* Make sure we don't overflow. */
 260                 nb_to_send = MIN(nb_to_send, BUFSIZE);
 261
 262                 if (nb_to_send) {
 263                         samples_generator(buf, nb_to_send, data);
 264                         mydata->samples_counter += nb_to_send;
 265
 266                         g_io_channel_write_chars(channels[1], (gchar *)&buf,
 267                                         nb_to_send, (gsize *)&bytes_written, NULL);
 268                 }
 269
 270                 /* Check if we're done. */
 271                 if ((limit_msec && time_cur * 1000 > limit_msec) ||
 272                     (limit_samples && mydata->samples_counter >= limit_samples))
 273                 {
 274                         close(mydata->pipe_fds[1]);
 275                         thread_running = 0;
 276                 }
 277
 278                 g_usleep(10);
 279         }
 280 }
 281
 282 /* Callback handling data */
 283 static int receive_data(int fd, int revents, void *user_data)
 284 {
 285         struct datafeed_packet packet;
 286         char c[BUFSIZE];
 287         gsize z;
 288
 289         /* Avoid compiler warnings. */
 290         fd = fd;
 291         revents = revents;
 292
 293         do {
 294                 g_io_channel_read_chars(channels[0],
 295                                         (gchar *)&c, BUFSIZE, &z, NULL);
 296
 297                 if (z > 0) {
 298                         packet.type = DF_LOGIC;
 299                         packet.length = z;
 300                         packet.unitsize = 1;
 301                         packet.payload = c;
 302                         session_bus(user_data, &packet);
 303                 }
 304         } while (z > 0);
 305
 306         if (!thread_running && z <= 0)
 307         {
 308                 /* Make sure we don't receive more packets */
 309                 g_io_channel_close(channels[0]);
 310
 311                 /* Send last packet. */
 312                 packet.type = DF_END;
 313                 session_bus(user_data, &packet);
 314
 315                 return FALSE;
 316         }
 317
 318         return TRUE;
 319 }
 320
 321 static int hw_start_acquisition(int device_index, gpointer session_device_id)
 322 {
 323         struct datafeed_packet *packet;
 324         struct datafeed_header *header;
 325         struct databag *mydata;
 326
 327         mydata = malloc(sizeof(struct databag));
 328         if (!mydata)
 329                 return SIGROK_ERR_MALLOC;
 330
 331         mydata->sample_generator = default_genmode;
 332         mydata->session_device_id = session_device_id;
 333         mydata->device_index = device_index;
 334         mydata->samples_counter = 0;
 335
 336         if (pipe(mydata->pipe_fds))
 337                 return SIGROK_ERR;
 338
 339         channels[0] = g_io_channel_unix_new(mydata->pipe_fds[0]);
 340         channels[1] = g_io_channel_unix_new(mydata->pipe_fds[1]);
 341
 342         /* Set channel encoding to binary (default is UTF-8). */
 343         g_io_channel_set_encoding(channels[0], NULL, NULL);
 344         g_io_channel_set_encoding(channels[1], NULL, NULL);
 345
 346         /* Make channels to unbuffered. */
 347         g_io_channel_set_buffered(channels[0], FALSE);
 348         g_io_channel_set_buffered(channels[1], FALSE);
 349
 350         source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40, receive_data,
 351                    session_device_id);
 352
 353         /* Run the demo thread. */
 354         g_thread_init(NULL);
 355         mydata->timer = g_timer_new();
 356         thread_running = 1;
 357         my_thread =
 358             g_thread_create((GThreadFunc)thread_func, mydata, TRUE, NULL);
 359         if (!my_thread)
 360                 return SIGROK_ERR;
 361
 362         packet = malloc(sizeof(struct datafeed_packet));
 363         header = malloc(sizeof(struct datafeed_header));
 364         if (!packet || !header)
 365                 return SIGROK_ERR_MALLOC;
 366
 367         packet->type = DF_HEADER;
 368         packet->length = sizeof(struct datafeed_header);
 369         packet->payload = (unsigned char *)header;
 370         header->feed_version = 1;
 371         gettimeofday(&header->starttime, NULL);
 372         header->samplerate = cur_samplerate;
 373         header->protocol_id = PROTO_RAW;
 374         header->num_logic_probes = NUM_PROBES;
 375         header->num_analog_probes = 0;
 376         session_bus(session_device_id, packet);
 377         free(header);
 378         free(packet);
 379
 380         return SIGROK_OK;
 381 }
 382
 383 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
 384 {
 385         /* Avoid compiler warnings. */
 386         device_index = device_index;
 387         session_device_id = session_device_id;
 388
 389         /* Stop generate thread. */
 390         thread_running = 0;
 391 }
 392
 393 struct device_plugin demo_plugin_info = {
 394         "demo",
 395         1,
 396         hw_init,
 397         hw_cleanup,
 398         hw_opendev,
 399         hw_closedev,
 400         hw_get_device_info,
 401         hw_get_status,
 402         hw_get_capabilities,
 403         hw_set_configuration,
 404         hw_start_acquisition,
 405         hw_stop_acquisition,
 406 };