[libsigrok.git] / src / hardware / demo / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
 * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
 * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com>
 * Copyright (C) 2019 Frank Stettner <frank-stettner@gmx.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBSIGROK_HARDWARE_DEMO_PROTOCOL_H
#define LIBSIGROK_HARDWARE_DEMO_PROTOCOL_H

#include <stdint.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

#define LOG_PREFIX "demo"

/* The size in bytes of chunks to send through the session bus. */
#define LOGIC_BUFSIZE			4096
/* Size of the analog pattern space per channel. */
#define ANALOG_BUFSIZE			4096
/* This is a development feature: it starts a new frame every n samples. */
#define SAMPLES_PER_FRAME		1000UL
#define DEFAULT_LIMIT_FRAMES		0

/* Logic patterns we can generate. */
enum logic_pattern_type {
	/**
	 * Spells "sigrok" across 8 channels using '0's (with '1's as
	 * "background") when displayed using the 'bits' output format.
	 * The pattern is repeated every 8 channels, shifted to the right
	 * in time by one bit.
	 */
	PATTERN_SIGROK,

	/** Pseudo-random values on all channels. */
	PATTERN_RANDOM,

	/**
	 * Incrementing number across 8 channels. The pattern is repeated
	 * every 8 channels, shifted to the right in time by one bit.
	 */
	PATTERN_INC,

	/**
	 * Single bit "walking" across all logic channels by being
	 * shifted across data lines, restarting after the last line
	 * was used. An all-zero (all-one) state is inserted to prevent
	 * repetitive patterns (e.g. with 8 data lines, every 8th state
	 * would show the same line state)
	 */
	PATTERN_WALKING_ONE,
	PATTERN_WALKING_ZERO,

	/** All channels have a low logic state. */
	PATTERN_ALL_LOW,

	/** All channels have a high logic state. */
	PATTERN_ALL_HIGH,

	/**
	 * Mimics a cable squid. Derived from the "works with" logo
	 * to occupy a larger number of channels yet "painting"
	 * something that can get recognized.
	 */
	PATTERN_SQUID,

	/** Gray encoded data, like rotary encoder signals. */
	PATTERN_GRAYCODE,
};

/* Analog patterns we can generate. */
enum analog_pattern_type {
	PATTERN_SQUARE,
	PATTERN_SINE,
	PATTERN_TRIANGLE,
	PATTERN_SAWTOOTH,
};

struct dev_context {
	uint64_t cur_samplerate;
	uint64_t limit_samples;
	uint64_t limit_msec;
	uint64_t limit_frames;
	uint64_t sent_samples;
	uint64_t sent_frame_samples; /* Number of samples that were sent for current frame. */
	int64_t start_us;
	int64_t spent_us;
	uint64_t step;
	/* Logic */
	int32_t num_logic_channels;
	size_t logic_unitsize;
	uint64_t all_logic_channels_mask;
	/* There is only ever one logic channel group, so its pattern goes here. */
	enum logic_pattern_type logic_pattern;
	uint8_t logic_data[LOGIC_BUFSIZE];
	/* Analog */
	int32_t num_analog_channels;
	GHashTable *ch_ag;
	gboolean avg; /* True if averaging is enabled */
	uint64_t avg_samples;
	size_t enabled_logic_channels;
	size_t enabled_analog_channels;
	size_t first_partial_logic_index;
	uint8_t first_partial_logic_mask;
	/* Triggers */
	uint64_t capture_ratio;
	gboolean trigger_fired;
	struct soft_trigger_logic *stl;
};

static const char *analog_pattern_str[] = {
	"square",
	"sine",
	"triangle",
	"sawtooth",
};

struct analog_gen {
	struct sr_channel *ch;
	enum sr_mq mq;
	enum sr_mqflag mq_flags;
	enum sr_unit unit;
	enum analog_pattern_type pattern;
	float amplitude;
	float pattern_data[ANALOG_BUFSIZE];
	unsigned int num_samples;
	struct sr_datafeed_analog packet;
	struct sr_analog_encoding encoding;
	struct sr_analog_meaning meaning;
	struct sr_analog_spec spec;
	float avg_val; /* Average value */
	unsigned int num_avgs; /* Number of samples averaged */
};

SR_PRIV void demo_generate_analog_pattern(struct analog_gen *ag, uint64_t sample_rate);
SR_PRIV int demo_prepare_data(int fd, int revents, void *cb_data);

#endif
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
	5	* Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
	6	* Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
	7	* Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com>
	8	* Copyright (C) 2019 Frank Stettner <frank-stettner@gmx.net>
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, see <http://www.gnu.org/licenses/>.
	22	*/
	23
	24	#ifndef LIBSIGROK_HARDWARE_DEMO_PROTOCOL_H
	25	#define LIBSIGROK_HARDWARE_DEMO_PROTOCOL_H
	26
	27	#include <stdint.h>
	28	#include <libsigrok/libsigrok.h>
	29	#include "libsigrok-internal.h"
	30
	31	#define LOG_PREFIX "demo"
	32
	33	/* The size in bytes of chunks to send through the session bus. */
	34	#define LOGIC_BUFSIZE 4096
	35	/* Size of the analog pattern space per channel. */
	36	#define ANALOG_BUFSIZE 4096
	37	/* This is a development feature: it starts a new frame every n samples. */
	38	#define SAMPLES_PER_FRAME 1000UL
	39	#define DEFAULT_LIMIT_FRAMES 0
	40
	41	/* Logic patterns we can generate. */
	42	enum logic_pattern_type {
	43	/**
	44	* Spells "sigrok" across 8 channels using '0's (with '1's as
	45	* "background") when displayed using the 'bits' output format.
	46	* The pattern is repeated every 8 channels, shifted to the right
	47	* in time by one bit.
	48	*/
	49	PATTERN_SIGROK,
	50
	51	/** Pseudo-random values on all channels. */
	52	PATTERN_RANDOM,
	53
	54	/**
	55	* Incrementing number across 8 channels. The pattern is repeated
	56	* every 8 channels, shifted to the right in time by one bit.
	57	*/
	58	PATTERN_INC,
	59
	60	/**
	61	* Single bit "walking" across all logic channels by being
	62	* shifted across data lines, restarting after the last line
	63	* was used. An all-zero (all-one) state is inserted to prevent
	64	* repetitive patterns (e.g. with 8 data lines, every 8th state
	65	* would show the same line state)
	66	*/
	67	PATTERN_WALKING_ONE,
	68	PATTERN_WALKING_ZERO,
	69
	70	/** All channels have a low logic state. */
	71	PATTERN_ALL_LOW,
	72
	73	/** All channels have a high logic state. */
	74	PATTERN_ALL_HIGH,
	75
	76	/**
	77	* Mimics a cable squid. Derived from the "works with" logo
	78	* to occupy a larger number of channels yet "painting"
	79	* something that can get recognized.
	80	*/
	81	PATTERN_SQUID,
	82
	83	/** Gray encoded data, like rotary encoder signals. */
	84	PATTERN_GRAYCODE,
	85	};
	86
	87	/* Analog patterns we can generate. */
	88	enum analog_pattern_type {
	89	PATTERN_SQUARE,
	90	PATTERN_SINE,
	91	PATTERN_TRIANGLE,
	92	PATTERN_SAWTOOTH,
	93	};
	94
	95	struct dev_context {
	96	uint64_t cur_samplerate;
	97	uint64_t limit_samples;
	98	uint64_t limit_msec;
	99	uint64_t limit_frames;
	100	uint64_t sent_samples;
	101	uint64_t sent_frame_samples; /* Number of samples that were sent for current frame. */
	102	int64_t start_us;
	103	int64_t spent_us;
	104	uint64_t step;
	105	/* Logic */
	106	int32_t num_logic_channels;
	107	size_t logic_unitsize;
	108	uint64_t all_logic_channels_mask;
	109	/* There is only ever one logic channel group, so its pattern goes here. */
	110	enum logic_pattern_type logic_pattern;
	111	uint8_t logic_data[LOGIC_BUFSIZE];
	112	/* Analog */
	113	int32_t num_analog_channels;
	114	GHashTable *ch_ag;
	115	gboolean avg; /* True if averaging is enabled */
	116	uint64_t avg_samples;
	117	size_t enabled_logic_channels;
	118	size_t enabled_analog_channels;
	119	size_t first_partial_logic_index;
	120	uint8_t first_partial_logic_mask;
	121	/* Triggers */
	122	uint64_t capture_ratio;
	123	gboolean trigger_fired;
	124	struct soft_trigger_logic *stl;
	125	};
	126
	127	static const char *analog_pattern_str[] = {
	128	"square",
	129	"sine",
	130	"triangle",
	131	"sawtooth",
	132	};
	133
	134	struct analog_gen {
	135	struct sr_channel *ch;
	136	enum sr_mq mq;
	137	enum sr_mqflag mq_flags;
	138	enum sr_unit unit;
	139	enum analog_pattern_type pattern;
	140	float amplitude;
	141	float pattern_data[ANALOG_BUFSIZE];
	142	unsigned int num_samples;
	143	struct sr_datafeed_analog packet;
	144	struct sr_analog_encoding encoding;
	145	struct sr_analog_meaning meaning;
	146	struct sr_analog_spec spec;
	147	float avg_val; /* Average value */
	148	unsigned int num_avgs; /* Number of samples averaged */
	149	};
	150
	151	SR_PRIV void demo_generate_analog_pattern(struct analog_gen *ag, uint64_t sample_rate);
	152	SR_PRIV int demo_prepare_data(int fd, int revents, void *cb_data);
	153
	154	#endif