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         SR_HWCAP_LOGIC_ANALYZER,
  58         SR_HWCAP_PATTERN_MODE,
  59         SR_HWCAP_LIMIT_SAMPLES,
  60         SR_HWCAP_LIMIT_MSEC,
  61         SR_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 sr_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 sr_device_instance *sdi;
  95
  96         /* Avoid compiler warnings. */
  97         deviceinfo = deviceinfo;
  98
  99         sdi = sr_device_instance_new(0, SR_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 SR_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 sr_device_instance *sdi;
 133         void *info = NULL;
 134
 135         if (!(sdi = sr_get_device_instance(device_instances, device_index)))
 136                 return NULL;
 137
 138         switch (device_info_id) {
 139         case SR_DI_INSTANCE:
 140                 info = sdi;
 141                 break;
 142         case SR_DI_NUM_PROBES:
 143                 info = GINT_TO_POINTER(NUM_PROBES);
 144                 break;
 145         case SR_DI_CUR_SAMPLERATE:
 146                 info = &cur_samplerate;
 147                 break;
 148         case SR_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 SR_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 == SR_HWCAP_PROBECONFIG) {
 179                 /* Nothing to do, but must be supported */
 180                 ret = SR_OK;
 181         } else if (capability == SR_HWCAP_SAMPLERATE) {
 182                 tmp_u64 = value;
 183                 cur_samplerate = *tmp_u64;
 184                 ret = SR_OK;
 185         } else if (capability == SR_HWCAP_LIMIT_SAMPLES) {
 186                 tmp_u64 = value;
 187                 limit_samples = *tmp_u64;
 188                 ret = SR_OK;
 189         } else if (capability == SR_HWCAP_LIMIT_MSEC) {
 190                 tmp_u64 = value;
 191                 limit_msec = *tmp_u64;
 192                 ret = SR_OK;
 193         } else if (capability == SR_HWCAP_PATTERN_MODE) {
 194                 stropt = value;
 195                 if (!strcmp(stropt, "random")) {
 196                         default_genmode = GENMODE_RANDOM;
 197                         ret = SR_OK;
 198                 } else if (!strcmp(stropt, "incremental")) {
 199                         default_genmode = GENMODE_INC;
 200                         ret = SR_OK;
 201                 } else {
 202                         ret = SR_ERR;
 203                 }
 204         } else {
 205                 ret = SR_ERR;
 206         }
 207
 208         return ret;
 209 }
 210
 211 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
 212 {
 213         static uint64_t p = 0;
 214         struct databag *mydata = data;
 215         uint64_t i;
 216
 217         memset(buf, 0, size);
 218
 219         switch (mydata->sample_generator) {
 220         case GENMODE_DEFAULT:
 221                 for (i = 0; i < size; i++) {
 222                         *(buf + i) = ~(genmode_default[p] >> 1);
 223                         if (++p == 64)
 224                                 p = 0;
 225                 }
 226                 break;
 227         case GENMODE_RANDOM: /* Random */
 228                 for (i = 0; i < size; i++)
 229                         *(buf + i) = (uint8_t)(rand() & 0xff);
 230                 break;
 231         case GENMODE_INC: /* Simple increment */
 232                 for (i = 0; i < size; i++)
 233                         *(buf + i) = i;
 234                 break;
 235         }
 236 }
 237
 238 /* Thread function */
 239 static void thread_func(void *data)
 240 {
 241         struct databag *mydata = data;
 242         uint8_t buf[BUFSIZE];
 243         uint64_t nb_to_send = 0;
 244         int bytes_written;
 245
 246         double time_cur, time_last, time_diff;
 247
 248         time_last = g_timer_elapsed(mydata->timer, NULL);
 249
 250         while (thread_running) {
 251                 /* Rate control */
 252                 time_cur = g_timer_elapsed(mydata->timer, NULL);
 253
 254                 time_diff = time_cur - time_last;
 255                 time_last = time_cur;
 256
 257                 nb_to_send = cur_samplerate * time_diff;
 258
 259                 if (limit_samples)
 260                         nb_to_send = MIN(nb_to_send,
 261                                         limit_samples - mydata->samples_counter);
 262
 263                 /* Make sure we don't overflow. */
 264                 nb_to_send = MIN(nb_to_send, BUFSIZE);
 265
 266                 if (nb_to_send) {
 267                         samples_generator(buf, nb_to_send, data);
 268                         mydata->samples_counter += nb_to_send;
 269
 270                         g_io_channel_write_chars(channels[1], (gchar *)&buf,
 271                                         nb_to_send, (gsize *)&bytes_written, NULL);
 272                 }
 273
 274                 /* Check if we're done. */
 275                 if ((limit_msec && time_cur * 1000 > limit_msec) ||
 276                     (limit_samples && mydata->samples_counter >= limit_samples))
 277                 {
 278                         close(mydata->pipe_fds[1]);
 279                         thread_running = 0;
 280                 }
 281
 282                 g_usleep(10);
 283         }
 284 }
 285
 286 /* Callback handling data */
 287 static int receive_data(int fd, int revents, void *user_data)
 288 {
 289         struct sr_datafeed_packet packet;
 290         char c[BUFSIZE];
 291         gsize z;
 292
 293         /* Avoid compiler warnings. */
 294         fd = fd;
 295         revents = revents;
 296
 297         do {
 298                 g_io_channel_read_chars(channels[0],
 299                                         (gchar *)&c, BUFSIZE, &z, NULL);
 300
 301                 if (z > 0) {
 302                         packet.type = SR_DF_LOGIC;
 303                         packet.length = z;
 304                         packet.unitsize = 1;
 305                         packet.payload = c;
 306                         sr_session_bus(user_data, &packet);
 307                 }
 308         } while (z > 0);
 309
 310         if (!thread_running && z <= 0)
 311         {
 312                 /* Make sure we don't receive more packets */
 313                 g_io_channel_close(channels[0]);
 314
 315                 /* Send last packet. */
 316                 packet.type = SR_DF_END;
 317                 sr_session_bus(user_data, &packet);
 318
 319                 return FALSE;
 320         }
 321
 322         return TRUE;
 323 }
 324
 325 static int hw_start_acquisition(int device_index, gpointer session_device_id)
 326 {
 327         struct sr_datafeed_packet *packet;
 328         struct sr_datafeed_header *header;
 329         struct databag *mydata;
 330
 331         mydata = malloc(sizeof(struct databag));
 332         if (!mydata)
 333                 return SR_ERR_MALLOC;
 334
 335         mydata->sample_generator = default_genmode;
 336         mydata->session_device_id = session_device_id;
 337         mydata->device_index = device_index;
 338         mydata->samples_counter = 0;
 339
 340         if (pipe(mydata->pipe_fds))
 341                 return SR_ERR;
 342
 343         channels[0] = g_io_channel_unix_new(mydata->pipe_fds[0]);
 344         channels[1] = g_io_channel_unix_new(mydata->pipe_fds[1]);
 345
 346         /* Set channel encoding to binary (default is UTF-8). */
 347         g_io_channel_set_encoding(channels[0], NULL, NULL);
 348         g_io_channel_set_encoding(channels[1], NULL, NULL);
 349
 350         /* Make channels to unbuffered. */
 351         g_io_channel_set_buffered(channels[0], FALSE);
 352         g_io_channel_set_buffered(channels[1], FALSE);
 353
 354         source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40, receive_data,
 355                    session_device_id);
 356
 357         /* Run the demo thread. */
 358         g_thread_init(NULL);
 359         /* this needs to be done between g_thread_init() and g_thread_create() */
 360         mydata->timer = g_timer_new();
 361         thread_running = 1;
 362         my_thread =
 363             g_thread_create((GThreadFunc)thread_func, mydata, TRUE, NULL);
 364         if (!my_thread)
 365                 return SR_ERR;
 366
 367         packet = malloc(sizeof(struct sr_datafeed_packet));
 368         header = malloc(sizeof(struct sr_datafeed_header));
 369         if (!packet || !header)
 370                 return SR_ERR_MALLOC;
 371
 372         packet->type = SR_DF_HEADER;
 373         packet->length = sizeof(struct sr_datafeed_header);
 374         packet->payload = (unsigned char *)header;
 375         header->feed_version = 1;
 376         gettimeofday(&header->starttime, NULL);
 377         header->samplerate = cur_samplerate;
 378         header->protocol_id = SR_PROTO_RAW;
 379         header->num_logic_probes = NUM_PROBES;
 380         header->num_analog_probes = 0;
 381         sr_session_bus(session_device_id, packet);
 382         free(header);
 383         free(packet);
 384
 385         return SR_OK;
 386 }
 387
 388 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
 389 {
 390         /* Avoid compiler warnings. */
 391         device_index = device_index;
 392         session_device_id = session_device_id;
 393
 394         /* Stop generate thread. */
 395         thread_running = 0;
 396 }
 397
 398 struct sr_device_plugin demo_plugin_info = {
 399         "demo",
 400         "Demo driver and pattern generator",
 401         1,
 402         hw_init,
 403         hw_cleanup,
 404         hw_opendev,
 405         hw_closedev,
 406         hw_get_device_info,
 407         hw_get_status,
 408         hw_get_capabilities,
 409         hw_set_configuration,
 410         hw_start_acquisition,
 411         hw_stop_acquisition,
 412 };