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  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <stdlib.h>
  22 #include <unistd.h>
  23 #include <string.h>
  24 #include <sigrok.h>
  25 #include "config.h"
  26
  27 #define BUFSIZE                         4096
  28
  29 #define NUM_PROBES                      8
  30 #define NUM_TRIGGER_STAGES              4
  31 #define TRIGGER_TYPES                   "01"
  32
  33 /* Software trigger implementation: positive values indicate trigger stage. */
  34 #define TRIGGER_FIRED                   -1
  35
  36 #define USB_MODEL_NAME                  "Demo Driver"
  37 #define USB_VENDOR_NAME                 "Sigrok project"
  38 #define USB_MODEL_VERSION               "v1.0"
  39
  40 #define GENMODE_RANDOM                  1
  41 #define GENMODE_INC                     2
  42
  43 static GThread *my_thread;
  44 static int thread_running;
  45
  46 static int capabilities[] = {
  47         HWCAP_LOGIC_ANALYZER,
  48         HWCAP_SAMPLERATE,
  49         HWCAP_LIMIT_SAMPLES,
  50 };
  51
  52 /* Random selection of samplerates this "device" shall support. */
  53 static uint64_t supported_samplerates[] = {
  54         KHZ(100),
  55         KHZ(500),
  56         MHZ(1),
  57         MHZ(2),
  58         MHZ(12),
  59         MHZ(24),
  60         0,
  61 };
  62
  63 static struct samplerates samplerates = {
  64         KHZ(100),
  65         MHZ(24),
  66         0,
  67         supported_samplerates,
  68 };
  69
  70 struct databag {
  71         int pipe_fds[2];
  72         uint8_t sample_generator;
  73         uint8_t thread_running;
  74         uint64_t samples_counter;
  75         int device_index;
  76         int loop_sleep;
  77         gpointer session_device_id;
  78 };
  79
  80 /* List of struct sigrok_device_instance, maintained by opendev()/closedev(). */
  81 static GSList *device_instances = NULL;
  82
  83 /* TODO: All of these should go in a device-specific struct. */
  84 static uint64_t cur_samplerate = 0;
  85 static uint64_t limit_samples = 0;
  86 // static uint8_t probe_mask = 0;
  87 // static uint8_t trigger_mask[NUM_TRIGGER_STAGES] = { 0 };
  88 // static uint8_t trigger_value[NUM_TRIGGER_STAGES] = { 0 };
  89 // static uint8_t trigger_buffer[NUM_TRIGGER_STAGES] = { 0 };
  90
  91 // static int trigger_stage = TRIGGER_FIRED;
  92
  93 static int hw_set_configuration(int device_index, int capability, void *value);
  94 static void hw_stop_acquisition(int device_index, gpointer session_device_id);
  95
  96 static int hw_init(char *deviceinfo)
  97 {
  98         /* Avoid compiler warning. */
  99         deviceinfo = deviceinfo;
 100
 101         struct sigrok_device_instance *sdi;
 102
 103         sdi = sigrok_device_instance_new(0, ST_ACTIVE,
 104                  USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
 105
 106         if (!sdi)
 107                 return 0;
 108         device_instances = g_slist_append(device_instances, sdi);
 109
 110         return 1;
 111 }
 112
 113 static int hw_opendev(int device_index)
 114 {
 115         /* Avoid compiler warning. */
 116         device_index = device_index;
 117
 118         /* Nothing needed so far. */
 119         return SIGROK_OK;
 120 }
 121
 122 static void hw_closedev(int device_index)
 123 {
 124         /* Avoid compiler warning. */
 125         device_index = device_index;
 126
 127         /* Nothing needed so far. */
 128 }
 129
 130 static void hw_cleanup(void)
 131 {
 132         /* Nothing needed so far. */
 133 }
 134
 135 static void *hw_get_device_info(int device_index, int device_info_id)
 136 {
 137         /* Avoid compiler warning. */
 138         device_index = device_index;
 139
 140         struct sigrok_device_instance *sdi;
 141         void *info = NULL;
 142
 143         if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
 144                 return NULL;
 145
 146         switch (device_info_id) {
 147         case DI_INSTANCE:
 148                 info = sdi;
 149                 break;
 150         case DI_NUM_PROBES:
 151                 info = GINT_TO_POINTER(NUM_PROBES);
 152                 break;
 153         case DI_SAMPLERATES:
 154                 info = &samplerates;
 155                 break;
 156         case DI_TRIGGER_TYPES:
 157                 info = TRIGGER_TYPES;
 158                 break;
 159         case DI_CUR_SAMPLERATE:
 160                 info = &cur_samplerate;
 161                 break;
 162         }
 163
 164         return info;
 165 }
 166
 167 static int hw_get_status(int device_index)
 168 {
 169         /* Avoid compiler warning. */
 170         device_index = device_index;
 171         return 0; /* FIXME */
 172 }
 173
 174 static int *hw_get_capabilities(void)
 175 {
 176         return capabilities;
 177 }
 178
 179 static int hw_set_configuration(int device_index, int capability, void *value)
 180 {
 181         int ret;
 182         uint64_t *tmp_u64;
 183
 184         /* Avoid compiler warning. */
 185         device_index = device_index;
 186
 187         if (capability == HWCAP_SAMPLERATE) {
 188                 cur_samplerate = *(uint64_t *) value;
 189                 ret = SIGROK_OK;
 190         } else if (capability == HWCAP_PROBECONFIG) {
 191                 // ret = configure_probes((GSList *) value); FIXME
 192                 ret = SIGROK_OK;
 193         } else if (capability == HWCAP_LIMIT_SAMPLES) {
 194                 tmp_u64 = value;
 195                 limit_samples = *tmp_u64;
 196                 ret = SIGROK_OK;
 197         } else {
 198                 ret = SIGROK_ERR;
 199         }
 200
 201         return ret;
 202 }
 203
 204 static void samples_generator(uint8_t *buf, uint64_t sz, void *data)
 205 {
 206         struct databag *mydata = data;
 207         uint64_t i;
 208         uint8_t val;
 209
 210         memset(buf, 0, sz);
 211
 212         switch (mydata->sample_generator) {
 213         case GENMODE_RANDOM: /* Random */
 214                 for (i = 0; i < sz; i++) {
 215                         val = rand() & 0xff;
 216                         *(buf + i) = val;
 217                 }
 218                 break;
 219         case GENMODE_INC: /* Simple increment */
 220                 for (i = 0; i < sz; i++)
 221                         *(buf + i) = i;
 222                 break;
 223         }
 224 }
 225
 226 /* Thread function */
 227 static void thread_func(void *data)
 228 {
 229         struct databag *mydata = data;
 230         uint8_t buf[BUFSIZE];
 231         uint64_t nb_to_send = 0;
 232
 233         while (thread_running) {
 234                 nb_to_send = limit_samples - mydata->samples_counter;
 235
 236                 if (nb_to_send == 0) {
 237                         close(mydata->pipe_fds[1]);
 238                         thread_running = 0;
 239                         hw_stop_acquisition(mydata->device_index,
 240                                             mydata->session_device_id);
 241                 } else if (nb_to_send > BUFSIZE) {
 242                         nb_to_send = BUFSIZE;
 243                 }
 244
 245                 samples_generator(buf, nb_to_send, data);
 246                 mydata->samples_counter += nb_to_send;
 247
 248                 write(mydata->pipe_fds[1], &buf, nb_to_send);
 249                 g_usleep(mydata->loop_sleep);
 250         }
 251 }
 252
 253 /* Callback handling data */
 254 static int receive_data(int fd, int revents, void *user_data)
 255 {
 256         struct datafeed_packet packet;
 257         /* uint16_t samples[1000]; */
 258         char c[BUFSIZE];
 259         uint64_t z;
 260
 261         /* Avoid compiler warnings. */
 262         revents = revents;
 263
 264         z = read(fd, &c, BUFSIZE);
 265         if (z > 0) {
 266                 packet.type = DF_LOGIC8;
 267                 packet.length = z;
 268                 packet.payload = c;
 269                 session_bus(user_data, &packet);
 270         }
 271         return TRUE;
 272 }
 273
 274 static int hw_start_acquisition(int device_index, gpointer session_device_id)
 275 {
 276         struct datafeed_packet *packet;
 277         struct datafeed_header *header;
 278         unsigned char *buf;
 279         struct databag *mydata;
 280
 281         mydata = malloc(sizeof(struct databag));
 282         /* TODO: Error handling. */
 283
 284         mydata->sample_generator = GENMODE_RANDOM;
 285         mydata->session_device_id = session_device_id;
 286         mydata->device_index = device_index;
 287         mydata->samples_counter = 0;
 288         mydata->loop_sleep = 100000;
 289
 290         if (pipe(mydata->pipe_fds)) {
 291                 fprintf(stderr, "Pipe failed.\n");
 292                 return SIGROK_ERR_MALLOC; /* FIXME */
 293
 294         }
 295         source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40, receive_data,
 296                    session_device_id);
 297
 298         /* Run the demo thread. */
 299         g_thread_init(NULL);
 300         thread_running = 1;
 301         my_thread =
 302             g_thread_create((GThreadFunc)thread_func, mydata, TRUE, NULL);
 303         if (!my_thread) {
 304                 fprintf(stderr, "demo: Thread creation failed.\n");
 305                 return SIGROK_ERR_MALLOC; /* FIXME */
 306         }
 307
 308         packet = malloc(sizeof(struct datafeed_packet));
 309         header = malloc(sizeof(struct datafeed_header));
 310         buf = malloc(2048);
 311         if (!packet || !header || !buf)
 312                 return SIGROK_ERR_MALLOC;
 313
 314         /* FIXME */
 315         memset(buf, 0x55, 2048);
 316
 317         packet->type = DF_HEADER;
 318         packet->length = sizeof(struct datafeed_header);
 319         packet->payload = (unsigned char *)header;
 320         header->feed_version = 1;
 321         gettimeofday(&header->starttime, NULL);
 322         header->samplerate = cur_samplerate;
 323         header->protocol_id = PROTO_RAW;
 324         header->num_probes = NUM_PROBES;
 325         session_bus(session_device_id, packet);
 326         free(header);
 327         free(packet);
 328
 329         return SIGROK_OK;
 330 }
 331
 332 /* This stops acquisition on ALL devices, ignoring device_index. */
 333 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
 334 {
 335         struct datafeed_packet packet;
 336
 337         /* QUICK HACK */
 338         device_index = device_index;
 339
 340         /* Send last packet. */
 341         packet.type = DF_END;
 342         session_bus(session_device_id, &packet);
 343 }
 344
 345 struct device_plugin demo_plugin_info = {
 346         "demo",
 347         1,
 348         hw_init,
 349         hw_cleanup,
 350         hw_opendev,
 351         hw_closedev,
 352         hw_get_device_info,
 353         hw_get_status,
 354         hw_get_capabilities,
 355         hw_set_configuration,
 356         hw_start_acquisition,
 357         hw_stop_acquisition,
 358 };