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