X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Finput%2Fchronovu_la8.c;h=91d05b90427fc349eec28299f76ae901cee49f39;hb=08f023fe97e402d68106299d04726f9094f00c45;hp=7c957febbb5673eacd7dfd68d627106e78961748;hpb=02e24c0ce0d8677039f1ba9b10322c7967ee1a13;p=libsigrok.git diff --git a/src/input/chronovu_la8.c b/src/input/chronovu_la8.c index 7c957feb..91d05b90 100644 --- a/src/input/chronovu_la8.c +++ b/src/input/chronovu_la8.c @@ -14,48 +14,98 @@ * 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, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * along with this program; if not, see . */ +#include #include #include #include #include -#include "libsigrok.h" +#include #include "libsigrok-internal.h" #define LOG_PREFIX "input/chronovu-la8" #define DEFAULT_NUM_CHANNELS 8 -#define DEFAULT_SAMPLERATE "100MHz" -#define MAX_CHUNK_SIZE 4096 -#define CHRONOVU_LA8_FILESIZE 8 * 1024 * 1024 + 5 +#define DEFAULT_SAMPLERATE SR_MHZ(100) +#define CHUNK_SIZE (4 * 1024 * 1024) + +/* + * File layout: + * - Fixed size 8MiB data part at offset 0. + * - Either one byte per sample for LA8. + * - Or two bytes per sample for LA16, in little endian format. + * - Five byte "header" at offset 8MiB. + * - One "clock divider" byte. The byte value is the divider factor + * minus 1. Value 0xff is invalid. Base clock is 100MHz for LA8, or + * 200MHz for LA16. + * - Four bytes for the trigger position. This 32bit value is the + * sample number in little endian format, or 0 when unused. + */ +#define CHRONOVU_LA8_DATASIZE (8 * 1024 * 1024) +#define CHRONOVU_LA8_HDRSIZE (sizeof(uint8_t) + sizeof(uint32_t)) +#define CHRONOVU_LA8_FILESIZE (CHRONOVU_LA8_DATASIZE + CHRONOVU_LA8_HDRSIZE) + +/* + * Implementation note: + * + * The .format_match() routine only checks the file size, but none of + * the header fields. Only little would be gained (only clock divider + * 0xff could get tested), but complexity would increase dramatically. + * Also the .format_match() routine is unlikely to receive large enough + * a buffer to include the header. Neither is the filename available to + * the .format_match() routine. + * + * There is no way to programmatically tell whether the file was created + * by LA8 or LA16 software, i.e. with 8 or 16 logic channels. If the + * filename was available, one might guess based on the file extension, + * but still would require user specs if neither of the known extensions + * were used or the input is fed from a pipe. + * + * The current input module implementation assumes that users specify + * the (channel count and) sample rate. Input data gets processed and + * passed along to the session bus, before the file "header" is seen. + * A future implementation could move channel creation from init() to + * receive() or end() (actually: a common routine called from those two + * routines), and could defer sample processing and feeding the session + * until the header was seen, including deferred samplerate calculation + * after having seen the header. But again this improvement depends on + * the availability of either the filename or the device type. Also note + * that applications then had to keep sending data to the input module's + * receive() routine until sufficient amounts of input data were seen + * including the header (see bug #1017). + */ struct context { gboolean started; uint64_t samplerate; + uint64_t samples_remain; }; -static int format_match(GHashTable *metadata) +static int format_match(GHashTable *metadata, unsigned int *confidence) { - int size; - - size = GPOINTER_TO_INT(g_hash_table_lookup(metadata, + uint64_t size; + + /* + * In the absence of a reliable condition like magic strings, + * we can only guess based on the file size. Since this is + * rather weak a condition, signal "little confidence" and + * optionally give precedence to better matches. + */ + size = GPOINTER_TO_SIZE(g_hash_table_lookup(metadata, GINT_TO_POINTER(SR_INPUT_META_FILESIZE))); - if (size == CHRONOVU_LA8_FILESIZE) - return TRUE; + if (size != CHRONOVU_LA8_FILESIZE) + return SR_ERR; + *confidence = 100; - return FALSE; + return SR_OK; } static int init(struct sr_input *in, GHashTable *options) { - struct sr_channel *ch; struct context *inc; - uint64_t samplerate; int num_channels, i; - const char *s; char name[16]; num_channels = g_variant_get_int32(g_hash_table_lookup(options, "numchannels")); @@ -64,100 +114,122 @@ static int init(struct sr_input *in, GHashTable *options) return SR_ERR_ARG; } - s = g_variant_get_string(g_hash_table_lookup(options, "samplerate"), NULL); - if (sr_parse_sizestring(s, &samplerate) != SR_OK) { - sr_err("Invalid samplerate '%s'.", s); - return SR_ERR_ARG; - } - - in->sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, NULL, NULL, NULL); + in->sdi = g_malloc0(sizeof(struct sr_dev_inst)); in->priv = inc = g_malloc0(sizeof(struct context)); - inc->samplerate = samplerate; + + inc->samplerate = g_variant_get_uint64(g_hash_table_lookup(options, "samplerate")); for (i = 0; i < num_channels; i++) { - snprintf(name, 16, "%d", i); - ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE, name); - in->sdi->channels = g_slist_append(in->sdi->channels, ch); + snprintf(name, sizeof(name), "%d", i); + sr_channel_new(in->sdi, i, SR_CHANNEL_LOGIC, TRUE, name); } return SR_OK; } -static int receive(const struct sr_input *in, GString *buf) +static int process_buffer(struct sr_input *in) { struct sr_datafeed_packet packet; - struct sr_datafeed_meta meta; struct sr_datafeed_logic logic; - struct sr_config *src; struct context *inc; gsize chunk_size, i; - int chunk, num_channels; + gsize chunk; + uint16_t unitsize; inc = in->priv; + unitsize = (g_slist_length(in->sdi->channels) + 7) / 8; - g_string_append_len(in->buf, buf->str, buf->len); + if (!inc->started) { + std_session_send_df_header(in->sdi); - num_channels = g_slist_length(in->sdi->channels); + if (inc->samplerate) { + (void)sr_session_send_meta(in->sdi, SR_CONF_SAMPLERATE, + g_variant_new_uint64(inc->samplerate)); + } - std_session_send_df_header(in->sdi, LOG_PREFIX); - inc->started = TRUE; + inc->samples_remain = CHRONOVU_LA8_DATASIZE; + inc->samples_remain /= unitsize; - packet.type = SR_DF_META; - packet.payload = &meta; - src = sr_config_new(SR_CONF_SAMPLERATE, g_variant_new_uint64(inc->samplerate)); - meta.config = g_slist_append(NULL, src); - sr_session_send(in->sdi, &packet); - sr_config_free(src); + inc->started = TRUE; + } packet.type = SR_DF_LOGIC; packet.payload = &logic; - logic.unitsize = (num_channels + 7) / 8; - logic.data = in->buf->str; + logic.unitsize = unitsize; - /* Cut off at multiple of unitsize. */ + /* Cut off at multiple of unitsize. Avoid sending the "header". */ chunk_size = in->buf->len / logic.unitsize * logic.unitsize; + chunk_size = MIN(chunk_size, inc->samples_remain * unitsize); - chunk = 0; for (i = 0; i < chunk_size; i += chunk) { - chunk = MAX(MAX_CHUNK_SIZE, chunk_size - i); - logic.length = chunk; - sr_session_send(in->sdi, &packet); + logic.data = in->buf->str + i; + chunk = MIN(CHUNK_SIZE, chunk_size - i); + if (chunk) { + logic.length = chunk; + sr_session_send(in->sdi, &packet); + inc->samples_remain -= chunk / unitsize; + } } - - if (in->buf->len > chunk_size) - g_string_erase(in->buf, 0, in->buf->len - chunk_size); + g_string_erase(in->buf, 0, chunk_size); return SR_OK; } -static int cleanup(struct sr_input *in) +static int receive(struct sr_input *in, GString *buf) +{ + int ret; + + g_string_append_len(in->buf, buf->str, buf->len); + + if (!in->sdi_ready) { + /* sdi is ready, notify frontend. */ + in->sdi_ready = TRUE; + return SR_OK; + } + + ret = process_buffer(in); + + return ret; +} + +static int end(struct sr_input *in) { - struct sr_datafeed_packet packet; struct context *inc; + int ret; + + if (in->sdi_ready) + ret = process_buffer(in); + else + ret = SR_OK; inc = in->priv; + if (inc->started) + std_session_send_df_end(in->sdi); - if (inc->started) { - packet.type = SR_DF_END; - sr_session_send(in->sdi, &packet); - } - g_free(in->priv); - in->priv = NULL; + return ret; +} + +static int reset(struct sr_input *in) +{ + struct context *inc = in->priv; + + inc->started = FALSE; + g_string_truncate(in->buf, 0); return SR_OK; } static struct sr_option options[] = { - { "numchannels", "Number of channels", "Number of channels", NULL, NULL }, - { "samplerate", "Sample rate", "Sample rate", NULL, NULL }, - { 0 } + { "numchannels", "Number of logic channels", "The number of (logic) channels in the data", NULL, NULL }, + { "samplerate", "Sample rate (Hz)", "The sample rate of the (logic) data in Hz", NULL, NULL }, + ALL_ZERO }; -static struct sr_option *get_options(void) +static const struct sr_option *get_options(void) { if (!options[0].def) { options[0].def = g_variant_ref_sink(g_variant_new_int32(DEFAULT_NUM_CHANNELS)); - options[1].def = g_variant_ref_sink(g_variant_new_string(DEFAULT_SAMPLERATE)); + options[1].def = g_variant_ref_sink(g_variant_new_uint64(DEFAULT_SAMPLERATE)); } return options; @@ -165,12 +237,14 @@ static struct sr_option *get_options(void) SR_PRIV struct sr_input_module input_chronovu_la8 = { .id = "chronovu-la8", - .name = "Chronovu-LA8", - .desc = "ChronoVu LA8", + .name = "ChronoVu LA8/LA16", + .desc = "ChronoVu LA8/LA16 native file format data", + .exts = (const char*[]){"kdt", "kd1", NULL}, .metadata = { SR_INPUT_META_FILESIZE | SR_INPUT_META_REQUIRED }, .options = get_options, .format_match = format_match, .init = init, .receive = receive, - .cleanup = cleanup, + .end = end, + .reset = reset, };