2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
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.
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.
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
26 #include <sigrok-internal.h>
30 #define pipe(fds) _pipe(fds, 4096, _O_BINARY)
35 #define DEMONAME "Demo device"
36 /* size of chunks to send through the session bus */
45 /* FIXME: Should not be global. */
46 GIOChannel *channels[2];
50 uint8_t sample_generator;
51 uint8_t thread_running;
52 uint64_t samples_counter;
54 gpointer session_device_id;
58 static int capabilities[] = {
59 SR_HWCAP_LOGIC_ANALYZER,
61 SR_HWCAP_PATTERN_MODE,
62 SR_HWCAP_LIMIT_SAMPLES,
67 static struct sr_samplerates samplerates = {
74 static const char *patternmodes[] = {
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,
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;
100 static void hw_stop_acquisition(int device_index, gpointer session_device_id);
102 static int hw_init(const char *deviceinfo)
104 struct sr_device_instance *sdi;
106 /* Avoid compiler warnings. */
107 deviceinfo = deviceinfo;
109 sdi = sr_device_instance_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
113 device_instances = g_slist_append(device_instances, sdi);
118 static int hw_opendev(int device_index)
120 /* Avoid compiler warnings. */
121 device_index = device_index;
123 /* Nothing needed so far. */
128 static int hw_closedev(int device_index)
130 /* Avoid compiler warnings. */
131 device_index = device_index;
133 /* Nothing needed so far. */
138 static void hw_cleanup(void)
140 /* Nothing needed so far. */
143 static void *hw_get_device_info(int device_index, int device_info_id)
145 struct sr_device_instance *sdi;
148 if (!(sdi = sr_get_device_instance(device_instances, device_index)))
151 switch (device_info_id) {
155 case SR_DI_NUM_PROBES:
156 info = GINT_TO_POINTER(NUM_PROBES);
158 case SR_DI_SAMPLERATES:
161 case SR_DI_CUR_SAMPLERATE:
162 info = &cur_samplerate;
164 case SR_DI_PATTERNMODES:
165 info = &patternmodes;
172 static int hw_get_status(int device_index)
174 /* Avoid compiler warnings. */
175 device_index = device_index;
180 static int *hw_get_capabilities(void)
185 static int hw_set_configuration(int device_index, int capability, void *value)
190 /* Avoid compiler warnings. */
191 device_index = device_index;
193 if (capability == SR_HWCAP_PROBECONFIG) {
194 /* Nothing to do, but must be supported */
196 } else if (capability == SR_HWCAP_SAMPLERATE) {
197 cur_samplerate = *(uint64_t *)value;
198 sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__,
201 } else if (capability == SR_HWCAP_LIMIT_SAMPLES) {
202 limit_samples = *(uint64_t *)value;
203 sr_dbg("demo: %s: setting limit_samples to %" PRIu64, __func__,
206 } else if (capability == SR_HWCAP_LIMIT_MSEC) {
207 limit_msec = *(uint64_t *)value;
208 sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__,
211 } else if (capability == SR_HWCAP_PATTERN_MODE) {
213 if (!strcmp(stropt, "random")) {
214 default_genmode = GENMODE_RANDOM;
216 } else if (!strcmp(stropt, "incremental")) {
217 default_genmode = GENMODE_INC;
222 sr_dbg("demo: %s: setting patternmode to %d", __func__,
231 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
233 static uint64_t p = 0;
234 struct databag *mydata = data;
237 memset(buf, 0, size);
239 switch (mydata->sample_generator) {
240 case GENMODE_DEFAULT:
241 for (i = 0; i < size; i++) {
242 *(buf + i) = ~(genmode_default[p] >> 1);
247 case GENMODE_RANDOM: /* Random */
248 for (i = 0; i < size; i++)
249 *(buf + i) = (uint8_t)(rand() & 0xff);
251 case GENMODE_INC: /* Simple increment */
252 for (i = 0; i < size; i++)
258 /* Thread function */
259 static void thread_func(void *data)
261 struct databag *mydata = data;
262 uint8_t buf[BUFSIZE];
263 uint64_t nb_to_send = 0;
266 double time_cur, time_last, time_diff;
268 time_last = g_timer_elapsed(mydata->timer, NULL);
270 while (thread_running) {
272 time_cur = g_timer_elapsed(mydata->timer, NULL);
274 time_diff = time_cur - time_last;
275 time_last = time_cur;
277 nb_to_send = cur_samplerate * time_diff;
280 nb_to_send = MIN(nb_to_send,
281 limit_samples - mydata->samples_counter);
283 /* Make sure we don't overflow. */
284 nb_to_send = MIN(nb_to_send, BUFSIZE);
287 samples_generator(buf, nb_to_send, data);
288 mydata->samples_counter += nb_to_send;
290 g_io_channel_write_chars(channels[1], (gchar *)&buf,
291 nb_to_send, (gsize *)&bytes_written, NULL);
294 /* Check if we're done. */
295 if ((limit_msec && time_cur * 1000 > limit_msec) ||
296 (limit_samples && mydata->samples_counter >= limit_samples))
298 close(mydata->pipe_fds[1]);
306 /* Callback handling data */
307 static int receive_data(int fd, int revents, void *user_data)
309 struct sr_datafeed_packet packet;
313 /* Avoid compiler warnings. */
318 g_io_channel_read_chars(channels[0],
319 (gchar *)&c, BUFSIZE, &z, NULL);
322 packet.type = SR_DF_LOGIC;
326 sr_session_bus(user_data, &packet);
330 if (!thread_running && z <= 0)
332 /* Make sure we don't receive more packets */
333 g_io_channel_close(channels[0]);
335 /* Send last packet. */
336 packet.type = SR_DF_END;
337 sr_session_bus(user_data, &packet);
345 static int hw_start_acquisition(int device_index, gpointer session_device_id)
347 struct sr_datafeed_packet *packet;
348 struct sr_datafeed_header *header;
349 struct databag *mydata;
351 /* TODO: 'mydata' is never g_free()'d? */
352 if (!(mydata = g_try_malloc(sizeof(struct databag)))) {
353 sr_err("demo: %s: mydata malloc failed", __func__);
354 return SR_ERR_MALLOC;
357 mydata->sample_generator = default_genmode;
358 mydata->session_device_id = session_device_id;
359 mydata->device_index = device_index;
360 mydata->samples_counter = 0;
362 if (pipe(mydata->pipe_fds))
365 channels[0] = g_io_channel_unix_new(mydata->pipe_fds[0]);
366 channels[1] = g_io_channel_unix_new(mydata->pipe_fds[1]);
368 /* Set channel encoding to binary (default is UTF-8). */
369 g_io_channel_set_encoding(channels[0], NULL, NULL);
370 g_io_channel_set_encoding(channels[1], NULL, NULL);
372 /* Make channels to unbuffered. */
373 g_io_channel_set_buffered(channels[0], FALSE);
374 g_io_channel_set_buffered(channels[1], FALSE);
376 sr_source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40,
377 receive_data, session_device_id);
379 /* Run the demo thread. */
381 /* this needs to be done between g_thread_init() and g_thread_create() */
382 mydata->timer = g_timer_new();
385 g_thread_create((GThreadFunc)thread_func, mydata, TRUE, NULL);
389 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
390 sr_err("demo: %s: packet malloc failed", __func__);
391 return SR_ERR_MALLOC;
394 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
395 sr_err("demo: %s: header malloc failed", __func__);
396 return SR_ERR_MALLOC;
399 packet->type = SR_DF_HEADER;
400 packet->length = sizeof(struct sr_datafeed_header);
401 packet->payload = (unsigned char *)header;
402 header->feed_version = 1;
403 gettimeofday(&header->starttime, NULL);
404 header->samplerate = cur_samplerate;
405 header->protocol_id = SR_PROTO_RAW;
406 header->num_logic_probes = NUM_PROBES;
407 header->num_analog_probes = 0;
408 sr_session_bus(session_device_id, packet);
415 static void hw_stop_acquisition(int device_index, gpointer session_device_id)
417 /* Avoid compiler warnings. */
418 device_index = device_index;
419 session_device_id = session_device_id;
421 /* Stop generate thread. */
425 struct sr_device_plugin demo_plugin_info = {
427 .longname = "Demo driver and pattern generator",
430 .cleanup = hw_cleanup,
431 .opendev = hw_opendev,
432 .closedev = hw_closedev,
433 .get_device_info = hw_get_device_info,
434 .get_status = hw_get_status,
435 .get_capabilities = hw_get_capabilities,
436 .set_configuration = hw_set_configuration,
437 .start_acquisition = hw_start_acquisition,
438 .stop_acquisition = hw_stop_acquisition,