From: Soeren Apel Date: Wed, 27 Sep 2023 19:38:20 +0000 (+0200) Subject: raspberrypi-pico: api.c cleanup X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=c5776ef73257bfb180c24f9ca76a3cd92c30b5fe;p=libsigrok.git raspberrypi-pico: api.c cleanup --- diff --git a/src/hardware/raspberrypi-pico/api.c b/src/hardware/raspberrypi-pico/api.c index f843fe5d..171b5eaa 100644 --- a/src/hardware/raspberrypi-pico/api.c +++ b/src/hardware/raspberrypi-pico/api.c @@ -28,24 +28,26 @@ #include "libsigrok-internal.h" #include "protocol.h" -/*Baud rate is really a don't care because we run USB CDC, dtr must be 1. -flow should be zero since we don't use xon/xoff -*/ +/* Baud rate is really a don't care because we run USB CDC, dtr must be 1. + * flow should be zero since we don't use xon/xoff */ #define SERIALCOMM "115200/8n1/dtr=1/rts=0/flow=0" -/* Use the force_detect scan option as a way to pass user information to the device - the string must use only 0-9,a-z,A-Z,'.','=' and '-'* and be less than 60 characters */ + +/* Use the force_detect scan option as a way to pass user information to the + * device the string must use only 0-9,a-z,A-Z,'.','=' and '-'* and be less than + * 60 characters */ static const uint32_t scanopts[] = { - SR_CONF_CONN, /*Required OS name for the port, i.e. /dev/ttyACM0 */ - SR_CONF_SERIALCOMM, /*Optional config of the port, i.e. 115200/8n1 */ - SR_CONF_FORCE_DETECT + SR_CONF_CONN, /* Required OS name for the port, i.e. /dev/ttyACM0 */ + SR_CONF_SERIALCOMM, /* Optional config of the port, i.e. 115200/8n1 */ + SR_CONF_FORCE_DETECT }; -/*Sample rate can either provide a std_gvar_samplerates_steps or a std_gvar_samplerates. -The latter is just a long list of every supported rate. -For the steps, pulseview/pv/toolbars/mainbar.cpp will do a min,max,step. If step is -1 then it provides a 1,2,5,10 select otherwise it allows a spin box. -Going with the full list because while the spin box is more flexible, it is harder to read -*/ + +/* Sample rate can either provide a std_gvar_samplerates_steps or a + * std_gvar_samplerates. The latter is just a long list of every supported rate. + * For the steps, pulseview/pv/toolbars/mainbar.cpp will do a min,max,step. If + * step is 1 then it provides a 1,2,5,10 select otherwise it allows a spin box. + * Going with the full list because while the spin box is more flexible, it is + * harder to read */ static const uint64_t samplerates[] = { SR_KHZ(5), SR_KHZ(6), @@ -60,16 +62,16 @@ static const uint64_t samplerates[] = { SR_KHZ(100), SR_KHZ(125), SR_KHZ(150), - SR_KHZ(160),/*max rate of 3 ADC channels that has integer divisor/dividend*/ + SR_KHZ(160), /* max rate of 3 ADC chans that has integer divisor/dividend */ SR_KHZ(200), - SR_KHZ(250), /*max rate of 2 ADC channels*/ + SR_KHZ(250), /* max rate of 2 ADC chans */ SR_KHZ(300), SR_KHZ(400), SR_KHZ(500), SR_KHZ(600), SR_KHZ(800), - /*Give finer granularity near the thresholds of RLE effectiveness ~1-4Msps - Also use 1.2 and 2.4 as likely max values for ADC overclocking */ + /* Give finer granularity near the thresholds of RLE effectiveness ~1-4Msps + * Also use 1.2 and 2.4 as likely max values for ADC overclocking */ SR_MHZ(1), SR_MHZ(1.2), SR_MHZ(1.5), @@ -86,17 +88,17 @@ static const uint64_t samplerates[] = { SR_MHZ(30), SR_MHZ(40), SR_MHZ(60), - /*The baseline 120Mhz PICO clock won't support an 80 or 100 - with non fractional divisor, but an overclocked version or one - that modified sysclk could */ + /* The baseline 120Mhz PICO clock won't support an 80 or 100 + * with non fractional divisor, but an overclocked version or one + * that modified sysclk could */ SR_MHZ(80), - SR_MHZ(100), - SR_MHZ(120), - /*These may not be practically useful, but someone might want to - try to make it work with overclocking */ - SR_MHZ(150), - SR_MHZ(200), - SR_MHZ(240) + SR_MHZ(100), + SR_MHZ(120), + /* These may not be practically useful, but someone might want to + * try to make it work with overclocking */ + SR_MHZ(150), + SR_MHZ(200), + SR_MHZ(240), }; static const uint32_t drvopts[] = { @@ -133,7 +135,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList * options) GSList *l; int num_read; int i; - const char *conn,*serialcomm,*force_detect; + const char *conn, *serialcomm, *force_detect; char buf[32]; char ustr[64]; int len; @@ -152,7 +154,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList * options) break; case SR_CONF_FORCE_DETECT: force_detect = g_variant_get_string(src->data, NULL); - sr_info("Force detect string %s",force_detect); + sr_info("Force detect string %s", force_detect); break; } } @@ -179,15 +181,14 @@ static GSList *scan(struct sr_dev_driver *di, GSList * options) if (len) sr_dbg("Dropping in flight serial data"); } while (len > 0); - /*Send the user string with the identify */ - if(force_detect - && (strlen(force_detect)<=60)){ - sprintf(ustr,"i%s\n",force_detect); - sr_info("User string %s",ustr); - num_read = send_serial_w_resp(serial, ustr, buf, 17); - }else{ - num_read = send_serial_w_resp(serial, "i\n", buf, 17); - } + /* Send the user string with the identify */ + if (force_detect && (strlen(force_detect) <= 60)) { + sprintf(ustr,"i%s\n", force_detect); + sr_info("User string %s", ustr); + num_read = send_serial_w_resp(serial, ustr, buf, 17); + } else { + num_read = send_serial_w_resp(serial, "i\n", buf, 17); + } if (num_read < 16) { sr_err("1st identify failed"); serial_close(serial); @@ -206,17 +207,17 @@ static GSList *scan(struct sr_dev_driver *di, GSList * options) return NULL; } } - /*Expected ID response is SRPICO,AxxyDzz,VV - where xx are number of analog channels, y is bytes per analog sample (7 bits per byte) - and zz is number of digital channels, and VV is two digit version# which must be 02 */ - if ((num_read < 16) - || (strncmp(buf, "SRPICO,A", 8)) - || (buf[11] != 'D') - || (buf[15] != '0') - || (buf[16] != '2')) { - sr_err("ERROR:Bad response string %s %d", buf, num_read); + + /* Expected ID response is SRPICO,AxxyDzz,VV + * where xx are number of analog channels, y is bytes per analog sample + * (7 bits per byte), zz is number of digital channels, and VV is two digit + * version# which must be 02 */ + if ((num_read < 16) || (strncmp(buf, "SRPICO,A", 8)) \ + || (buf[11] != 'D') || (buf[15] != '0') || (buf[16] != '2')) { + sr_err("ERROR: Bad response string %s %d", buf, num_read); return NULL; } + a_size = buf[10] - '0'; buf[10] = '\0'; /*Null to end the str for atois */ buf[14] = '\0'; @@ -232,87 +233,86 @@ static GSList *scan(struct sr_dev_driver *di, GSList * options) sdi->driver = &raspberrypi_pico_driver_info; sdi->inst_type = SR_INST_SERIAL; sdi->serial_num = g_strdup("N/A"); - if (((num_a == 0) && (num_d == 0)) - || (num_a > MAX_ANALOG_CHANNELS) - || (num_d > MAX_DIGITAL_CHANNELS) - || (a_size < 1) - || (a_size > 4)) { + + if (((num_a == 0) && (num_d == 0)) \ + || (num_a > MAX_ANALOG_CHANNELS) || (num_d > MAX_DIGITAL_CHANNELS) + || (a_size < 1) || (a_size > 4)) { sr_err("ERROR: invalid channel config a %d d %d asz %d", - num_a, num_d, a_size); + num_a, num_d, a_size); return NULL; } + devc = g_malloc0(sizeof(struct dev_context)); devc->a_size = a_size; devc->num_a_channels = num_a; devc->num_d_channels = num_d; devc->a_chan_mask = ((1 << num_a) - 1); devc->d_chan_mask = ((1 << num_d) - 1); -/*The number of bytes that each digital sample in the buffers sent to the session. -All logical channels are packed together, where a slice of N channels takes roundup(N/8) bytes -This never changes even if channels are disabled because PV expects disabled channels to still -be accounted for in the packing */ + + /* The number of bytes that each digital sample in the buffers sent to the + * session. All logical channels are packed together, where a slice of N + * channels takes roundup(N/8) bytes. This never changes even if channels + * are disabled because PV expects disabled channels to still be accounted + * for in the packing */ devc->dig_sample_bytes = ((devc->num_d_channels + 7) / 8); - /*These are the slice sizes of the data on the wire - 1 7 bit field per byte */ + /* These are the slice sizes of the data on the wire + * 1 7 bit field per byte */ devc->bytes_per_slice = (devc->num_a_channels * devc->a_size); + if (devc->num_d_channels > 0) { - /* logic sent in groups of 7*/ + /* logic sent in groups of 7*/ devc->bytes_per_slice += (devc->num_d_channels + 6) / 7; } sr_dbg("num channels a %d d %d bps %d dsb %d", num_a, num_d, - devc->bytes_per_slice, devc->dig_sample_bytes); -/* Each analog channel is it's own group -Digital are just channels -Grouping of channels is rather arbitrary as parameters like sample rate and number of samples -apply to all changes. Analog channels do have a scale and offset, but that is applied -without involvement of the session. -*/ + devc->bytes_per_slice, devc->dig_sample_bytes); + + /* Each analog channel is its own group; digital are just channels; + * Grouping of channels is rather arbitrary as parameters like sample rate + * and number of samples apply to all channels. Analog channels do have a + * scale and offset, but that is applied automatically. */ devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group *) * - devc->num_a_channels); + devc->num_a_channels); for (i = 0; i < devc->num_a_channels; i++) { channel_name = g_strdup_printf("A%d", i); - ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, - channel_name); - devc->analog_groups[i] = - g_malloc0(sizeof(struct sr_channel_group)); + ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_name); + devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group)); devc->analog_groups[i]->name = channel_name; - devc->analog_groups[i]->channels = - g_slist_append(NULL, ch); - sdi->channel_groups = - g_slist_append(sdi->channel_groups, - devc->analog_groups[i]); + devc->analog_groups[i]->channels = g_slist_append(NULL, ch); + sdi->channel_groups = g_slist_append(sdi->channel_groups, + devc->analog_groups[i]); } if (devc->num_d_channels > 0) { for (i = 0; i < devc->num_d_channels; i++) { - /*Name digital channels starting at D2 to match pico board pin names*/ + /* Name digital channels starting at D2 to match pico board names */ channel_name = g_strdup_printf("D%d", i + 2); - sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, - channel_name); + sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name); g_free(channel_name); } - } - /*In large sample usages we get the call to receive with large transfers. - Since the CDC serial implemenation can silenty lose data as it gets close to full, allocate - storage for a half buffer which in a worst case scenario has 2x ratio of transmitted bytes - to storage bytes. - Note: The intent of making this buffer large is to prevent CDC serial buffer overflows. - However, it is likely that if the host is running slow (i.e. it's a raspberry pi model 3) that it becomes - compute bound and doesn't service CDC serial responses in time to not overflow the internal CDC buffers. - And thus no serial buffer is large enough. But, it's only 32K.... */ + + /* In large sample usages we get the call to receive with large transfers. + * Since the CDC serial implemenation can silenty lose data as it gets close + * to full, allocate storage for a half buffer which in a worst case + * scenario has 2x ratio of transmitted bytes to storage bytes. + * Note: The intent of making this buffer large is to prevent CDC serial + * buffer overflows. However, it is likely that if the host is running slow + * (i.e. it's a raspberry pi model 3) that it becomes compute bound and + * doesn't service CDC serial responses in time to not overflow the internal + * CDC buffers. Thus no serial buffer is large enough. + * But, it's only 32K... */ devc->serial_buffer_size = 32000; devc->buffer = NULL; - sr_dbg("Setting serial buffer size: %i.", - devc->serial_buffer_size); + sr_dbg("Setting serial buffer size: %i.", devc->serial_buffer_size); + devc->cbuf_wrptr = 0; - /*While slices are sent as a group of one sample across all channels, sigrok wants analog - channel data sent as separate packets. - Logical trace values are packed together. - An RLE byte in normal mode can represent up to 1640 samples. - In D4 an RLE byte can represents up to 640 samples. - Rather than making the sample_buf_size 1640x the size of serial buff, we require that the process loops - push samples to the session as we get anywhere close to full.*/ + /* While slices are sent as a group of one sample across all channels, + * sigrok wants analog channel data sent as separate packets. Logical trace + * values are packed together. An RLE byte in normal mode can represent up + * to 1640 samples. In D4 an RLE byte can represent up to 640 samples. + * Rather than making the sample_buf_size 1640x the size of serial buffer, + * we require that the process loops push samples to the session as we get + * anywhere close to full. */ devc->sample_buf_size = devc->serial_buffer_size; for (i = 0; i < devc->num_a_channels; i++) { @@ -323,39 +323,34 @@ without involvement of the session. devc->sample_rate = 5000; devc->capture_ratio = 10; devc->rxstate = RX_IDLE; - sdi->priv = devc; - /*Set an initial value as various code relies on an inital value.*/ + /*Set an initial value as various code relies on an inital value. */ devc->limit_samples = 1000; + sdi->priv = devc; + if (raspberrypi_pico_get_dev_cfg(sdi) != SR_OK) { return NULL; }; - sr_err("sr_err level logging enabled"); - sr_warn("sr_warn level logging enabled"); - sr_info("sr_info level logging enabled"); - sr_dbg("sr_dbg level logging enabled"); - sr_spew("sr_spew level logging enabled"); serial_close(serial); return std_scan_complete(di, g_slist_append(NULL, sdi)); - } - - -/*Note that on the initial driver load we pull all values into local storage. - Thus gets can return local data, but sets have to issue commands to device. */ +/* Note that on the initial driver load we pull all values into local storage. + * Thus gets can return local data, but sets have to issue commands to device. */ static int config_set(uint32_t key, GVariant * data, - const struct sr_dev_inst *sdi, - const struct sr_channel_group *cg) + const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { struct dev_context *devc; int ret; (void) cg; + if (!sdi) return SR_ERR_ARG; + devc = sdi->priv; ret = SR_OK; + sr_dbg("Got config_set key %d \n", key); switch (key) { case SR_CONF_SAMPLERATE: @@ -371,7 +366,7 @@ static int config_set(uint32_t key, GVariant * data, break; default: - sr_err("ERROR:config_set undefine %d\n", key); + sr_err("ERROR: config_set given undefined key %d\n", key); ret = SR_ERR_NA; } @@ -379,12 +374,14 @@ static int config_set(uint32_t key, GVariant * data, } static int config_get(uint32_t key, GVariant ** data, - const struct sr_dev_inst *sdi, - const struct sr_channel_group *cg) + const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { struct dev_context *devc; - sr_dbg("at config_get key %d", key); + + sr_dbg("config_get given key %d", key); + (void) cg; + if (!sdi) return SR_ERR_ARG; @@ -401,55 +398,49 @@ static int config_get(uint32_t key, GVariant ** data, *data = g_variant_new_uint64(devc->capture_ratio); break; case SR_CONF_LIMIT_SAMPLES: - sr_spew("config_get limit_samples of %lu", - devc->limit_samples); + sr_spew("config_get limit_samples of %lu", devc->limit_samples); *data = g_variant_new_uint64(devc->limit_samples); break; default: - sr_spew("unsupported cfg_get key %d", key); + sr_spew("unsupported config_get key %d", key); return SR_ERR_NA; } return SR_OK; } static int config_list(uint32_t key, GVariant ** data, - const struct sr_dev_inst *sdi, - const struct sr_channel_group *cg) + const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { (void) cg; - /*scan or device options are the only ones that can be called without a defined instance*/ - if ((key == SR_CONF_SCAN_OPTIONS) - || (key == SR_CONF_DEVICE_OPTIONS)) { - return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, - drvopts, devopts); + + /* Scan or device options are the only ones that can be called without a + * defined instance */ + if ((key == SR_CONF_SCAN_OPTIONS) || (key == SR_CONF_DEVICE_OPTIONS)) { + return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts); } + if (!sdi) { - sr_err - ("ERROR:\n\r\n\r\n\r Call to config list with null sdi\n\r\n\r"); + sr_err("ERROR: Call to config list with null sdi"); return SR_ERR_ARG; } - sr_dbg("start config_list with key %X\n", key); + + sr_dbg("Start config_list with key %X", key); switch (key) { case SR_CONF_SAMPLERATE: - sr_dbg("Return sample rate list"); - *data = - std_gvar_samplerates(ARRAY_AND_SIZE - (samplerates)); + *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates)); break; - /*This must be set to get SW trigger support*/ + /* This must be set to get SW trigger support */ case SR_CONF_TRIGGER_MATCH: - *data = - std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches)); + *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches)); break; case SR_CONF_LIMIT_SAMPLES: - /*Really this limit is up to the memory capacity of the host, - and users that pick huge values deserve what they get. - But setting this limit to prevent really crazy things. */ + /* Really this limit is up to the memory capacity of the host, + * and users that pick huge values deserve what they get. + * But setting this limit to prevent really crazy things. */ *data = std_gvar_tuple_u64(1LL, 1000000000LL); - sr_dbg("sr_config_list limit samples "); break; default: - sr_dbg("reached default statement of config_list"); + sr_dbg("Reached default statement of config_list"); return SR_ERR_NA; } @@ -468,197 +459,183 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi) GSList *l; int a_enabled = 0, d_enabled = 0, len; serial = sdi->conn; - int i,num_read; + int i, num_read; + devc = sdi->priv; sr_dbg("Enter acq start"); sr_dbg("dsbstart %d", devc->dig_sample_bytes); + devc->buffer = g_malloc(devc->serial_buffer_size); if (!(devc->buffer)) { - sr_err("ERROR:serial buffer malloc fail"); + sr_err("ERROR: serial buffer malloc fail"); return SR_ERR_MALLOC; } - /*Get device in idle state*/ + + /* Get device in idle state */ if (serial_drain(serial) != SR_OK) { - sr_err("Initial Drain Failed\n\r"); + sr_err("Initial Drain Failed"); return SR_ERR; } + send_serial_char(serial, '*'); if (serial_drain(serial) != SR_OK) { - sr_err("Second Drain Failed\n\r"); + sr_err("Second Drain Failed"); return SR_ERR; } for (l = sdi->channels; l; l = l->next) { ch = l->data; - sr_dbg("c %d enabled %d name %s\n", ch->index, ch->enabled, - ch->name); + sr_dbg("c %d enabled %d name %s\n", ch->index, ch->enabled, ch->name); if (ch->name[0] == 'A') { devc->a_chan_mask &= ~(1 << ch->index); if (ch->enabled) { - devc->a_chan_mask |= - (ch->enabled << ch->index); + devc->a_chan_mask |= (ch->enabled << ch->index); a_enabled++; } } if (ch->name[0] == 'D') { devc->d_chan_mask &= ~(1 << ch->index); if (ch->enabled) { - devc->d_chan_mask |= - (ch->enabled << ch->index); + devc->d_chan_mask |= (ch->enabled << ch->index); d_enabled++; } } + sr_info("Channel enable masks D 0x%X A 0x%X", devc->d_chan_mask, devc->a_chan_mask); - sprintf(tmpstr, "%c%d%d\n", ch->name[0], ch->enabled, - ch->index); + sprintf(tmpstr, "%c%d%d\n", ch->name[0], ch->enabled, ch->index); if (send_serial_w_ack(serial, tmpstr) != SR_OK) { - sr_err("ERROR:Channel enable fail"); + sr_err("ERROR: Channel enable fail"); return SR_ERR; - } else { - } - }/*for all channels*/ - /*ensure data channels are continuous*/ + } + + /* Ensure data channels are continuous */ int invalid = 0; for (i = 0; i < 32; i++) { if ((devc->d_chan_mask >> i) & 1) { if (invalid) { - sr_err - ("Digital channel mask 0x%X not continous\n\r", - devc->d_chan_mask); + sr_err("Digital channel mask 0x%X not continous", + devc->d_chan_mask); return SR_ERR; } - } else { + } else invalid = 1; - } } - /*recalculate bytes_per_slice based on which analog channels are enabled */ + + /* Recalculate bytes_per_slice based on which analog channels are enabled */ devc->bytes_per_slice = (a_enabled * devc->a_size); - for (i = 0; i < devc->num_d_channels; i += 7) { - if (((devc->d_chan_mask) >> i) & (0x7F)) { + for (i = 0; i < devc->num_d_channels; i += 7) + if (((devc->d_chan_mask) >> i) & (0x7F)) (devc->bytes_per_slice)++; - } - } + if ((a_enabled == 0) && (d_enabled == 0)) { sr_err("ERROR:No channels enabled"); return SR_ERR; } + sr_dbg("bps %d\n", devc->bytes_per_slice); - /*Apply sample rate limits - While earlier versions forced a lower sample rate, the PICO seems to allow - ADC overclocking, and by not enforcing these limits it may support other devices. - Thus call sr_err to get something into the device logs, but allowing it to progress.*/ - if ((a_enabled == 3) && (devc->sample_rate > 160000)) { - sr_err - ("WARN:3 channel ADC sample rate above 160khz"); - } - if ((a_enabled == 2) && (devc->sample_rate > 250000)) { - sr_err - ("WARN:2 channel ADC sample rate above 250khz"); - } - if ((a_enabled == 1) && (devc->sample_rate > 500000)) { - sr_err - ("WARN:1 channel ADC sample rate above 500khz"); - } - /*Depending on channel configs, rates below 5ksps are possible - but such a low rate can easily stream and this eliminates a lot - of special cases. */ + /* Apply sample rate limits; while earlier versions forced a lower sample + * rate, the PICO seems to allow ADC overclocking, and by not enforcing + * these limits it may support other devices. Thus call sr_err to get + * something into the device logs, but allowing it to progress. */ + if ((a_enabled == 3) && (devc->sample_rate > 160000)) + sr_err("WARN: 3 channel ADC sample rate above 160khz"); + if ((a_enabled == 2) && (devc->sample_rate > 250000)) + sr_err("WARN: 2 channel ADC sample rate above 250khz"); + if ((a_enabled == 1) && (devc->sample_rate > 500000)) + sr_err("WARN: 1 channel ADC sample rate above 500khz"); + + /* Depending on channel configs, rates below 5ksps are possible but such a + * low rate can easily stream and this eliminates a lot of special cases. */ if (devc->sample_rate < 5000) { sr_err("Sample rate override to min of 5ksps"); devc->sample_rate = 5000; } - /*While PICO specs a max clock ~120-125Mhz, it does overclock in many cases - so leaving is a warning. */ - if (devc->sample_rate > 120000000) { - sr_err("WARN: Sample rate above 120Msps"); - } - /*It may take a very large number of samples to notice, but if digital and analog are enabled - and either PIO or ADC are fractional the samples will skew over time. - 24Mhz is the max common divisor to the 120Mhz and 48Mhz ADC clock - so force an integer divisor to 24Mhz. */ + + /* While PICO specs a max clock ~120-125Mhz, it does overclock in many cases + * so leaving a warning. */ + if (devc->sample_rate > 120000000) + sr_warn("WARN: Sample rate above 120Msps"); + + /* It may take a very large number of samples to notice, but if digital and + * analog are enabled and either PIO or ADC are fractional the samples will + * skew over time. 24Mhz is the max common divisor to the 120Mhz and 48Mhz + * ADC clock so force an integer divisor to 24Mhz. */ if ((a_enabled > 0) && (d_enabled > 0)) { if (24000000ULL % (devc->sample_rate)) { - uint32_t commondivint = - 24000000ULL / (devc->sample_rate); - /*Always increment the divisor so that we go down in frequency to avoid max sample rate issues */ + uint32_t commondivint = 24000000ULL / (devc->sample_rate); + /* Always increment the divisor so that we go down in frequency to + * avoid max sample rate issues */ commondivint++; devc->sample_rate = 24000000ULL / commondivint; - /*Make sure the divisor increement didn't make use go too low. */ - if (devc->sample_rate < 5000) { + /* Make sure the divisor increment didn't make us go too low. */ + if (devc->sample_rate < 5000) devc->sample_rate = 50000; - } - sr_err - ("WARN: Forcing common integer divisor sample rate of %lu div %u\n\r", - devc->sample_rate, commondivint); - } - - } - /*If we are only digital or only analog print a warning that the - fractional divisors aren't a true PLL fractional feedback loop and thus - could have sample to sample variation. - These warnings of course assume that the device is programmed with the expected ratios - but non PICO implementations, or PICO implementations that use different divisors could avoid. - This generally won't be a problem because most of the sampe_rate pulldown values are integer divisors. */ - if (a_enabled > 0) { - if (48000000ULL % (devc->sample_rate * a_enabled)) { - sr_warn - ("WARN: Non integer ADC divisor of 48Mhz clock for sample rate %lu may cause sample to sample variability.", - devc->sample_rate); - } - } - if (d_enabled > 0) { - if (120000000ULL % (devc->sample_rate)) { - sr_warn - ("WARN: Non integer PIO divisor of 120Mhz for sample rate %lu may cause sample to sample variability.", - devc->sample_rate); + sr_warn("WARN: Forcing common integer divisor sample rate of " \ + "%lu div %u", devc->sample_rate, commondivint); } } - + /* If we are only digital or only analog print a warning that the fractional + * divisors aren't a true PLL fractional feedback loop and thus could have + * sample to sample variation. These warnings of course assume that the + * device is programmed with the expected ratios but non PICO + * implementations, or PICO implementations that use different divisors + * could avoid. This generally won't be a problem because most of the + * sample_rate pulldown values are integer divisors. */ + if ((a_enabled > 0) && (48000000ULL % (devc->sample_rate * a_enabled))) + sr_warn("WARN: Non integer ADC divisor of 48Mhz clock for sample " \ + "rate %lu may cause sample to sample variability.", + devc->sample_rate); + if ((d_enabled > 0) && (120000000ULL % (devc->sample_rate))) + sr_warn("WARN: Non integer PIO divisor of 120Mhz for sample rate " \ + "%lu may cause sample to sample variability.", devc->sample_rate); + sprintf(tmpstr, "L%" PRIu64 "\n", devc->limit_samples); if (send_serial_w_ack(serial, tmpstr) != SR_OK) { sr_err("Sample limit to device failed"); return SR_ERR; } - /*To support future devices that may allow the analog scale/offset to change, call get_dev_cfg again to get new values */ - if(raspberrypi_pico_get_dev_cfg(sdi) != SR_OK){ - sr_err("get_dev_cfg failure on start"); - return SR_ERR; + + /* To support future devices that may allow the analog scale/offset to + * change, call get_dev_cfg again to get new values */ + if (raspberrypi_pico_get_dev_cfg(sdi) != SR_OK) { + sr_err("get_dev_cfg failure on start"); + return SR_ERR; } - /*With all other params set, we use the final sample rate setting as an opportunity for the device - to communicate any errors in configuration. - A single "*" indicates success. - A "*" with subsequent data is success, but allows for the device to print something - to the error console without aborting. - A non "*" in the first character blocks the start */ + /* With all other params set, we use the final sample rate setting as an + * opportunity for the device to communicate any errors in configuration. + * A single "*" indicates success. + * A "*" with subsequent data is success, but allows for the device to + * print something to the error console without aborting. + * A non "*" in the first character blocks the start. */ sprintf(tmpstr, "R%lu\n", devc->sample_rate); num_read = send_serial_w_resp(serial, tmpstr, buf, 30); - buf[num_read]=0; - if((num_read>1)&&(buf[0]=='*')){ - sr_err("Sample rate to device success with resp %s",buf); - } - else if(!((num_read==1)&&(buf[0]=='*'))){ + buf[num_read] = 0; + if ((num_read > 1) && (buf[0] == '*')) + sr_dbg("Sample rate to device success with resp %s", buf); + else if (!((num_read == 1) && (buf[0] == '*'))) { sr_err("Sample rate to device failed"); - if(num_read>0){ - buf[num_read]=0; - sr_err("sample_rate error string %s",buf); + if (num_read > 0) { + buf[num_read]=0; + sr_err("sample_rate error string %s",buf); } return SR_ERR; } + devc->sent_samples = 0; devc->byte_cnt = 0; devc->bytes_avail = 0; devc->wrptr = 0; devc->cbuf_wrptr = 0; - len = - serial_read_blocking(serial, devc->buffer, - devc->serial_buffer_size, - serial_timeout(serial, 4)); + len = serial_read_blocking(serial, devc->buffer, devc->serial_buffer_size, + serial_timeout(serial, 4)); + if (len > 0) { sr_info("Pre-ARM drain had %d characters:", len); devc->buffer[len] = 0; @@ -666,105 +643,105 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi) } for (i = 0; i < devc->num_a_channels; i++) { - devc->a_data_bufs[i] = - g_malloc(devc->sample_buf_size * sizeof(float)); + devc->a_data_bufs[i] = g_malloc(devc->sample_buf_size * sizeof(float)); if (!(devc->a_data_bufs[i])) { - sr_err("ERROR:analog buffer malloc fail"); + sr_err("ERROR: analog buffer malloc fail"); return SR_ERR_MALLOC; } } + if (devc->num_d_channels > 0) { - devc->d_data_buf = - g_malloc(devc->sample_buf_size * - devc->dig_sample_bytes); + devc->d_data_buf = g_malloc(devc->sample_buf_size * + devc->dig_sample_bytes); if (!(devc->d_data_buf)) { - sr_err("ERROR:logic buffer malloc fail"); + sr_err("ERROR: logic buffer malloc fail"); return SR_ERR_MALLOC; } } - devc->pretrig_entries = - (devc->capture_ratio * devc->limit_samples) / 100; - /*While the driver supports the passing of trigger info to the device - it has been found that the sw overhead of supporting triggering and - pretrigger buffer entries etc.. ends up slowing the cores down enough - that the effective continous sample rate isn't much higher than that of sending - untriggered samples across USB. Thus this code will remain but likely may - not be used by the device, unless HW based triggers are implemented */ + + devc->pretrig_entries = (devc->capture_ratio * devc->limit_samples) / 100; + /* While the driver supports the passing of trigger info to the device + * it has been found that the sw overhead of supporting triggering and + * pretrigger buffer entries etc.. ends up slowing the cores down enough + * that the effective continous sample rate isn't much higher than that of + * sending untriggered samples across USB. Thus this code will remain but + * likely may not be used by the device, unless HW based triggers are + * implemented */ if ((trigger = sr_session_trigger_get(sdi->session))) { - if (g_slist_length(trigger->stages) > 1) - return SR_ERR_NA; + if (g_slist_length(trigger->stages) > 1) + return SR_ERR_NA; - struct sr_trigger_stage *stage; - struct sr_trigger_match *match; + struct sr_trigger_stage *stage; + struct sr_trigger_match *match; GSList *l; stage = g_slist_nth_data(trigger->stages, 0); - if (!stage) - return SR_ERR_ARG; - for (l = stage->matches; l; l = l->next) { - match = l->data; - if (!match->match) - continue; - if (!match->channel->enabled) - continue; - int idx = match->channel->index; - int8_t val; - switch(match->match){ - case SR_TRIGGER_ZERO: - val=0; break; - case SR_TRIGGER_ONE: - val=1; break; - case SR_TRIGGER_RISING: - val=2; break; - case SR_TRIGGER_FALLING: - val=3; break; - case SR_TRIGGER_EDGE: - val=4; break; - default: - val=-1; + if (!stage) + return SR_ERR_ARG; + for (l = stage->matches; l; l = l->next) { + match = l->data; + if (!match->match) + continue; + if (!match->channel->enabled) + continue; + int idx = match->channel->index; + int8_t val; + switch(match->match) { + case SR_TRIGGER_ZERO: + val = 0; break; + case SR_TRIGGER_ONE: + val = 1; break; + case SR_TRIGGER_RISING: + val = 2; break; + case SR_TRIGGER_FALLING: + val = 3; break; + case SR_TRIGGER_EDGE: + val = 4; break; + default: + val = -1; } - sr_info("Trigger value idx %d match %d",idx,match->match); - /*Only set trigger on enabled channels*/ - if((val>=0) && ((devc->d_chan_mask>>idx)&1)){ - sprintf(&tmpstr[0], "t%d%02d\n", val,idx+2); - if (send_serial_w_ack(serial, tmpstr) != SR_OK) { - sr_err("Trigger cfg to device failed"); - return SR_ERR; - } - + sr_info("Trigger value idx %d match %d", idx, match->match); + /* Only set trigger on enabled channels */ + if ((val >= 0) && ((devc->d_chan_mask >> idx) & 1)) { + sprintf(&tmpstr[0], "t%d%02d\n", val, idx+2); + if (send_serial_w_ack(serial, tmpstr) != SR_OK) { + sr_err("Trigger cfg to device failed"); + return SR_ERR; + } } - } - sprintf(&tmpstr[0], "p%d\n", devc->pretrig_entries); + } + + sprintf(&tmpstr[0], "p%d\n", devc->pretrig_entries); if (send_serial_w_ack(serial, tmpstr) != SR_OK) { - sr_err("Pretrig to device failed"); - return SR_ERR; - } - devc->stl = - soft_trigger_logic_new(sdi, trigger, - devc->pretrig_entries); + sr_err("Pretrig to device failed"); + return SR_ERR; + } + + devc->stl = soft_trigger_logic_new(sdi, trigger, devc->pretrig_entries); if (!devc->stl) return SR_ERR_MALLOC; + devc->trigger_fired = FALSE; if (devc->pretrig_entries > 0) { - sr_dbg("Allocating pretrig buffers size %d", - devc->pretrig_entries); + sr_dbg("Allocating pretrig buffers size %d", devc->pretrig_entries); for (i = 0; i < devc->num_a_channels; i++) { if ((devc->a_chan_mask >> i) & 1) { - devc->a_pretrig_bufs[i] = - g_malloc0(sizeof(float) * - devc-> - pretrig_entries); + devc->a_pretrig_bufs[i] = g_malloc0(sizeof(float) * + devc->pretrig_entries); if (!devc->a_pretrig_bufs[i]) { - sr_err - ("ERROR:Analog pretrigger buffer malloc failure, disabling"); + sr_err("ERROR:Analog pretrigger buffer malloc " \ + "failure, disabling"); devc->trigger_fired = TRUE; } - } - } - } + } + } + } + sr_info("Entering sw triggered mode"); - /*post the receive before starting the device to ensure we are ready to receive data ASAP*/ + /* Post the receive before starting the device to ensure we are ready + * to receive data ASAP */ serial_source_add(sdi->session, serial, G_IO_IN, 200, - raspberrypi_pico_receive, (void *) sdi); + raspberrypi_pico_receive, (void*)sdi); + sprintf(tmpstr, "C\n"); if (send_serial_str(serial, tmpstr) != SR_OK) return SR_ERR; @@ -774,60 +751,70 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi) devc->pretrig_entries = 0; sr_info("Entering fixed sample mode"); serial_source_add(sdi->session, serial, G_IO_IN, 200, - raspberrypi_pico_receive, (void *) sdi); + raspberrypi_pico_receive, (void*)sdi); + sprintf(tmpstr, "F\n"); if (send_serial_str(serial, tmpstr) != SR_OK) return SR_ERR; } + std_session_send_df_header(sdi); sr_dbg("dsbstartend %d", devc->dig_sample_bytes); if (devc->trigger_fired) std_session_send_df_trigger(sdi); - /*Keep this at the end as we don't want to be RX_ACTIVE unless everything is ok*/ + + /* Keep this at the end as we don't want to be RX_ACTIVE unless everything + * is ok */ devc->rxstate = RX_ACTIVE; return SR_OK; } -/*This function is called either by the protocol code if we reached all of the samples -or an error condition, and also by the user clicking stop in pulseview. -It must always be called for any acquistion that was started to free memory. */ +/* This function is called either by the protocol code if we reached all of the + * samples or an error condition, and also by the user clicking stop in + * pulseview. It must always be called for any acquistion that was started to + * free memory. */ static int dev_acquisition_stop(struct sr_dev_inst *sdi) { struct dev_context *devc; struct sr_serial_dev_inst *serial; - sr_dbg("****at dev_acquisition_stop"); int len; devc = sdi->priv; serial = sdi->conn; + sr_dbg("At dev_acquisition_stop"); + std_session_send_df_end(sdi); - /*If we reached this while still active it is likely because the stop button was pushed - in pulseview. - That is generally some kind of error condition, so we don't try to check the bytenct */ - if (devc->rxstate == RX_ACTIVE) { + + /* If we reached this while still active it is likely because the stop + * button was pushed in pulseview. That is generally some kind of error + * condition, so we don't try to check the bytenct */ + if (devc->rxstate == RX_ACTIVE) sr_err("Reached dev_acquisition_stop in RX_ACTIVE"); - } + if (devc->rxstate != RX_IDLE) { - sr_err("Sending plus to stop device stream\n\r"); + sr_err("Sending plus to stop device stream"); send_serial_char(serial, '+'); } - /*In case we get calls to receive force it to exit */ + + /* In case we get calls to receive force it to exit */ devc->rxstate = RX_IDLE; - /*drain data from device so that it doesn't confuse subsequent commands*/ + + /* Drain data from device so that it doesn't confuse subsequent commands */ do { - len = - serial_read_blocking(serial, devc->buffer, - devc->serial_buffer_size, 100); + len = serial_read_blocking(serial, devc->buffer, + devc->serial_buffer_size, 100); if (len) - sr_err("Dropping %d device bytes\n\r", len); + sr_err("Dropping %d device bytes", len); } while (len > 0); + if (devc->buffer) { g_free(devc->buffer); devc->buffer = NULL; } + for (int i = 0; i < devc->num_a_channels; i++) { if (devc->a_data_bufs[i]) { g_free(devc->a_data_bufs[i]); @@ -838,13 +825,16 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi) g_free(devc->d_data_buf); devc->d_data_buf = NULL; } + for (int i = 0; i < devc->num_a_channels; i++) { if (devc->a_pretrig_bufs[i]) g_free(devc->a_pretrig_bufs[i]); devc->a_pretrig_bufs[i] = NULL; } + serial = sdi->conn; serial_source_remove(sdi->session, serial); + return SR_OK; }