#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
-//This is used by sr_dbg/log etc
-#define LOG_PREFIX "srgn"
- //number of bytes between markers
+/*This is used by sr_dbg/log etc to indicate where a printout came from*/
+#define LOG_PREFIX "srpico"
+/*/number of bytes between markers*/
#define MRK_STRIDE 128
-//This must be 32 or or less since many channel enable/disable masks and other elements may be only 32 bits wide.
-//But is reduced further based on pico board limitations
-#define MAX_ANALOG_CHANNELS 3
-#define MAX_DIGITAL_CHANNELS 21
-//digits input to sr_analog_init
+/*These must be 32 or or less since many channel enable/disable masks and other elements may be only 32 bits wide.
+Setting values larger than what a PICO can support to enable other devices, or possibly modes where
+channels are created from internal values rather than external pins */
+#define MAX_ANALOG_CHANNELS 8
+#define MAX_DIGITAL_CHANNELS 32
+/*digits input to sr_analog_init */
#define ANALOG_DIGITS 4
SR_PRIV int send_serial_str(struct sr_serial_dev_inst *serial, char *str);
char *str);
typedef enum rxstate {
- RX_IDLE = 0, //not receiving
- RX_ACTIVE = 1, //receiving data
- RX_STOPPED = 2, //received stop marker, waiting for byte cnt
- RX_ABORT = 3, //received aborted marker or other error
+ RX_IDLE = 0, /*not receiving */
+ RX_ACTIVE = 1, /*receiving data */
+ RX_STOPPED = 2, /*received stop marker, waiting for byte cnt */
+ RX_ABORT = 3, /*received aborted marker or other error */
} rxstate_t;
-//TODO todo - stopped review here - renam wrptr, and review all variables
struct dev_context {
-/*Configuration Parameters */
- //It is up to the user to understand sample rates and serial download speed etc and
- // do the right thing. i.e. don't expect continuous streaming bandwidth greater
- //than serial link speed etc...
- //The number of samples the user expects to see.
- uint64_t limit_samples;
- uint64_t sample_rate;
- //Number of samples that have been received and processed
- uint32_t num_samples;
- //Initial Number of analog and digital channels.
- //This is set by initial device config. Channels can be disabled/enabled,
- //but can not be added/removed once driver is loaded.
- uint16_t num_a_channels;
- uint16_t num_d_channels;
- //Masks of enabled channels based on user input
- uint32_t a_chan_mask;
- uint32_t d_chan_mask;
- // Channel groups -each analog channel is it's own group
- struct sr_channel_group **analog_groups;
- struct sr_channel_group *digital_group;
- //Data size in bytes for each analog channel in bytes
- //must be 1 as only single byte samples are supported in this version
- uint8_t a_size;
- //Offset and scale for each analog channel to covert bytes to float
- float a_offset[MAX_ANALOG_CHANNELS];
- float a_scale[MAX_ANALOG_CHANNELS];
- // % ratio of pre-trigger to post trigger samples
- uint64_t capture_ratio;
- // total number of bytes of data sent for one sample across all channels
- uint16_t bytes_per_slice;
- //The number of bytes needed to store all channels for one sample in the device data buff
- uint32_t dig_sample_bytes;
+/* Configuration Parameters */
+ /* It is up to the user to understand sample rates and serial download speed etc and
+ do the right thing. i.e. don't expect continuous streaming bandwidth greater
+ than serial link speed etc...
+ The number of samples the user expects to see. */
+ uint64_t limit_samples;
+ uint64_t sample_rate;
+ /* Number of samples that have been received and processed */
+ uint32_t num_samples;
+ /* Initial Number of analog and digital channels.
+ This is set by initial device config. Channels can be disabled/enabled,
+ but can not be added/removed once driver is loaded. */
+ uint16_t num_a_channels;
+ uint16_t num_d_channels;
+ /* Masks of enabled channels based on user input*/
+ uint32_t a_chan_mask;
+ uint32_t d_chan_mask;
+ /* Channel groups -each analog channel is it's own group*/
+ struct sr_channel_group **analog_groups;
+ struct sr_channel_group *digital_group;
+ /* Data size in bytes for each analog channel in bytes
+ must be 1 as only single byte samples are supported in this version*/
+ uint8_t a_size;
+ /* Offset and scale for each analog channel to covert bytes to float*/
+ float a_offset[MAX_ANALOG_CHANNELS];
+ float a_scale[MAX_ANALOG_CHANNELS];
+ /* % ratio of pre-trigger to post trigger samples*/
+ uint64_t capture_ratio;
+ /* total number of bytes of data sent for one sample across all channels*/
+ uint16_t bytes_per_slice;
+ /* The number of bytes needed to store all channels for one sample in the device data buff*/
+ uint32_t dig_sample_bytes;
+
/* Tracking/status once started */
- //number of bytes in the current serial input stream
- uint32_t bytes_avail;
- //Samples sent to the session */
- uint32_t sent_samples;
- //count total received bytes to detect lost info*/
- uint64_t byte_cnt;
- //For SW based triggering we put the device into continuous transmit and stop when
- // we detect a sample and capture all the samples we need. trigger_fired is thus set when
- // the sw trigger logic detects a trigger.
- //For non triggered modes we send a start and a number of samples and the device
- //transmits that much. trigger_fired is set immediately at the start.
- gboolean trigger_fired;
- //Has the device, via an "!" indicated it has stopped sending data, or has a marker
- //error been detected
- // gboolean device_stopped;
- rxstate_t rxstate;
+ /* number of bytes in the current serial input stream */
+ uint32_t bytes_avail;
+ /* Samples sent to the session */
+ uint32_t sent_samples;
+ /* count total received bytes to detect lost info*/
+ uint64_t byte_cnt;
+ /* For SW based triggering we put the device into continuous transmit and stop when
+ we detect a sample and capture all the samples we need. trigger_fired is thus set when
+ the sw trigger logic detects a trigger.
+ For non triggered modes we send a start and a number of samples and the device
+ transmits that much. trigger_fired is set immediately at the start. */
+ gboolean trigger_fired;
+ rxstate_t rxstate;
+
/* Serial Related */
- // Serial data buffer
- unsigned char *buffer;
- //Size of incoming serial buffer
- uint32_t serial_buffer_size;
- //Current byte in serial read stream that is being processed
- uint32_t ser_rdptr;
- //write pointer into the serial input buffer
- uint32_t wrptr;
+ /* Serial data buffer */
+ unsigned char *buffer;
+ /* Size of incoming serial buffer*/
+ uint32_t serial_buffer_size;
+ /* Current byte in serial read stream that is being processed */
+ uint32_t ser_rdptr;
+ /* write pointer into the serial input buffer */
+ uint32_t wrptr;
/* Buffering Related */
- /* parsed serial read data is split into each channels dedicated buffer for analog */
- float *a_data_bufs[MAX_ANALOG_CHANNELS];
- /*digital samples are stored packed together since cli/pulseview want it that way */
- uint8_t *d_data_buf;
- /*write point for the the per channel data buffers */
- uint32_t cbuf_wrptr;
- /*size of packet data buffers for each channel */
- uint32_t sample_buf_size;
-/* RLE related*/
- /*Previous sample values to duplicate for rle */
- float a_last[MAX_ANALOG_CHANNELS];
- uint8_t d_last[4];
+ /* parsed serial read data is split into each channels dedicated buffer for analog */
+ float *a_data_bufs[MAX_ANALOG_CHANNELS];
+ /* digital samples are stored packed together since cli/pulseview want it that way */
+ uint8_t *d_data_buf;
+ /* write pointer for the the per channel data buffers */
+ uint32_t cbuf_wrptr;
+ /* size of packet data buffers for each channel */
+ uint32_t sample_buf_size;
+ /* RLE related*/
+ /* Previous sample values to duplicate for rle */
+ float a_last[MAX_ANALOG_CHANNELS];
+ uint8_t d_last[4];
/* SW Trigger Related */
- struct soft_trigger_logic *stl;
- //Maximum number of entries to store pre-trigger
- uint32_t pretrig_entries;
- /* Analog pre-trigger storage for software based triggering
- because sw based only has internal storage for logic */
- float *a_pretrig_bufs[MAX_ANALOG_CHANNELS];
- uint32_t pretrig_wr_ptr;
+ struct soft_trigger_logic *stl;
+ /* Maximum number of entries to store pre-trigger*/
+ uint32_t pretrig_entries;
+ /* Analog pre-trigger storage for software based triggering
+ because sw based only has internal storage for logic */
+ float *a_pretrig_bufs[MAX_ANALOG_CHANNELS];
+ uint32_t pretrig_wr_ptr;
};