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                 ret = SR_OK;
 198         } else if (capability == SR_HWCAP_LIMIT_SAMPLES) {
 199                 tmp_u64 = value;
 200                 limit_samples = *tmp_u64;
 201                 ret = SR_OK;
 202         } else if (capability == SR_HWCAP_LIMIT_MSEC) {
 203                 tmp_u64 = value;
 204                 limit_msec = *tmp_u64;
 205                 ret = SR_OK;
 206         } else if (capability == SR_HWCAP_PATTERN_MODE) {
 207                 stropt = value;
 208                 if (!strcmp(stropt, "random")) {
 209                         default_genmode = GENMODE_RANDOM;
 210                         ret = SR_OK;
 211                 } else if (!strcmp(stropt, "incremental")) {
 212                         default_genmode = GENMODE_INC;
 213                         ret = SR_OK;
 214                 } else {
 215                         ret = SR_ERR;
 216                 }
 217         } else {
 218                 ret = SR_ERR;
 219         }
 220
 221         return ret;
 222 }
 223
 224 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
 225 {
 226         static uint64_t p = 0;
 227         struct databag *mydata = data;
 228         uint64_t i;
 229
 230         memset(buf, 0, size);
 231
 232         switch (mydata->sample_generator) {
 233         case GENMODE_DEFAULT:
 234                 for (i = 0; i < size; i++) {
 235                         *(buf + i) = ~(genmode_default[p] >> 1);
 236                         if (++p == 64)
 237                                 p = 0;
 238                 }
 239                 break;
 240         case GENMODE_RANDOM: /* Random */
 241                 for (i = 0; i < size; i++)
 242                         *(buf + i) = (uint8_t)(rand() & 0xff);
 243                 break;
 244         case GENMODE_INC: /* Simple increment */
 245                 for (i = 0; i < size; i++)
 246                         *(buf + i) = i;
 247                 break;
 248         }
 249 }
 250
 251 /* Thread function */
 252 static void thread_func(void *data)
 253 {
 254         struct databag *mydata = data;
 255         uint8_t buf[BUFSIZE];
 256         uint64_t nb_to_send = 0;
 257         int bytes_written;
 258
 259         double time_cur, time_last, time_diff;
 260
 261         time_last = g_timer_elapsed(mydata->timer, NULL);
 262
 263         while (thread_running) {
 264                 /* Rate control */
 265                 time_cur = g_timer_elapsed(mydata->timer, NULL);
 266
 267                 time_diff = time_cur - time_last;
 268                 time_last = time_cur;
 269
 270                 nb_to_send = cur_samplerate * time_diff;
 271
 272                 if (limit_samples)
 273                         nb_to_send = MIN(nb_to_send,
 274                                         limit_samples - mydata->samples_counter);
 275
 276                 /* Make sure we don't overflow. */
 277                 nb_to_send = MIN(nb_to_send, BUFSIZE);
 278
 279                 if (nb_to_send) {
 280                         samples_generator(buf, nb_to_send, data);
 281                         mydata->samples_counter += nb_to_send;
 282
 283                         g_io_channel_write_chars(channels[1], (gchar *)&buf,
 284                                         nb_to_send, (gsize *)&bytes_written, NULL);
 285                 }
 286
 287                 /* Check if we're done. */
 288                 if ((limit_msec && time_cur * 1000 > limit_msec) ||
 289                     (limit_samples && mydata->samples_counter >= limit_samples))
 290                 {
 291                         close(mydata->pipe_fds[1]);
 292                         thread_running = 0;
 293                 }
 294
 295                 g_usleep(10);
 296         }
 297 }
 298
 299 /* Callback handling data */
 300 static int receive_data(int fd, int revents, void *user_data)
 301 {
 302         struct sr_datafeed_packet packet;
 303         char c[BUFSIZE];
 304         gsize z;
 305
 306         /* Avoid compiler warnings. */
 307         fd = fd;
 308         revents = revents;
 309
 310         do {
 311                 g_io_channel_read_chars(channels[0],
 312                                         (gchar *)&c, BUFSIZE, &z, NULL);
 313
 314                 if (z > 0) {
 315                         packet.type = SR_DF_LOGIC;
 316                         packet.length = z;
 317                         packet.unitsize = 1;
 318                         packet.payload = c;
 319                         sr_session_bus(user_data, &packet);
 320                 }
 321         } while (z > 0);
 322
 323         if (!thread_running && z <= 0)
 324         {
 325                 /* Make sure we don't receive more packets */
 326                 g_io_channel_close(channels[0]);
 327
 328                 /* Send last packet. */
 329                 packet.type = SR_DF_END;
 330                 sr_session_bus(user_data, &packet);
 331
 332                 return FALSE;
 333         }
 334
 335         return TRUE;
 336 }
 337
 338 static int hw_start_acquisition(int device_index, gpointer session_device_id)
 339 {
 340         struct sr_datafeed_packet *packet;
 341         struct sr_datafeed_header *header;
 342         struct databag *mydata;
 343
 344         /* TODO: 'mydata' is never g_free()'d? */
 345         if (!(mydata = g_try_malloc(sizeof(struct databag)))) {
 346                 sr_err("demo: %s: mydata malloc failed", __func__);
 347                 return SR_ERR_MALLOC;
 348         }
 349
 350         mydata->sample_generator = default_genmode;
 351         mydata->session_device_id = session_device_id;
 352         mydata->device_index = device_index;
 353         mydata->samples_counter = 0;
 354
 355         if (pipe(mydata->pipe_fds))
 356                 return SR_ERR;
 357
 358         channels[0] = g_io_channel_unix_new(mydata->pipe_fds[0]);
 359         channels[1] = g_io_channel_unix_new(mydata->pipe_fds[1]);
 360
 361         /* Set channel encoding to binary (default is UTF-8). */
 362         g_io_channel_set_encoding(channels[0], NULL, NULL);
 363         g_io_channel_set_encoding(channels[1], NULL, NULL);
 364
 365         /* Make channels to unbuffered. */
 366         g_io_channel_set_buffered(channels[0], FALSE);
 367         g_io_channel_set_buffered(channels[1], FALSE);
 368
 369         sr_source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40,
 370                       receive_data, session_device_id);
 371
 372         /* Run the demo thread. */
 373         g_thread_init(NULL);
 374         /* this needs to be done between g_thread_init() and g_thread_create() */
 375         mydata->timer = g_timer_new();
 376         thread_running = 1;
 377         my_thread =
 378             g_thread_create((GThreadFunc)thread_func, mydata, TRUE, NULL);
 379         if (!my_thread)
 380                 return SR_ERR;
 381
 382         if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
 383                 sr_err("demo: %s: packet malloc failed", __func__);
 384                 return SR_ERR_MALLOC;
 385         }
 386
 387         if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
 388                 sr_err("demo: %s: header malloc failed", __func__);
 389                 return SR_ERR_MALLOC;
 390         }
 391
 392         packet->type = SR_DF_HEADER;
 393         packet->length = sizeof(struct sr_datafeed_header);
 394         packet->payload = (unsigned char *)header;
 395         header->feed_version = 1;
 396         gettimeofday(&header->starttime, NULL);
 397         header->samplerate = cur_samplerate;
 398         header->protocol_id = SR_PROTO_RAW;
 399         header->num_logic_probes = NUM_PROBES;
 400         header->num_analog_probes = 0;
 401         sr_session_bus(session_device_id, packet);
 402         g_free(header);
 403         g_free(packet);
 404
 405         return SR_OK;
 406 }
 407
 408 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
 409 {
 410         /* Avoid compiler warnings. */
 411         device_index = device_index;
 412         session_device_id = session_device_id;
 413
 414         /* Stop generate thread. */
 415         thread_running = 0;
 416 }
 417
 418 struct sr_device_plugin demo_plugin_info = {
 419         .name = "demo",
 420         .longname = "Demo driver and pattern generator",
 421         .api_version = 1,
 422         .init = hw_init,
 423         .cleanup = hw_cleanup,
 424         .open = hw_opendev,
 425         .close = hw_closedev,
 426         .get_device_info = hw_get_device_info,
 427         .get_status = hw_get_status,
 428         .get_capabilities = hw_get_capabilities,
 429         .set_configuration = hw_set_configuration,
 430         .start_acquisition = hw_start_acquisition,
 431         .stop_acquisition = hw_stop_acquisition,
 432 };