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