/*
* This file is part of the sigrok project.
*
- * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
*
* 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
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
-#include "sigrok.h"
-#include "sigrok-internal.h"
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
+
+/**
+ * @file
+ *
+ * Helper functions to filter out unused probes from samples.
+ */
+
+/**
+ * @defgroup grp_filter Probe filter
+ *
+ * Helper functions to filter out unused probes from samples.
+ *
+ * @{
+ */
/**
* Remove unused probes from samples.
* The requested unit size must be big enough to hold as
* much data as is specified by the number of enabled
* probes in 'probelist'.
- * @param probelist Pointer to a list of integers (probe numbers). The probe
- * numbers in this list are 1-based, i.e. the first probe
- * is expected to be numbered 1 (not 0!). Must not be NULL.
+ * @param probelist Pointer to a list of probe numbers, numbered starting
+ * from 0. The list is terminated with -1.
* @param data_in Pointer to the input data buffer. Must not be NULL.
* @param length_in The input data length (>= 1), in number of bytes.
* @param data_out Variable which will point to the newly allocated buffer
* out_unitsize, data_out, and length_out are undefined.
*/
SR_API int sr_filter_probes(int in_unitsize, int out_unitsize,
- const int *probelist, const unsigned char *data_in,
- uint64_t length_in, char **data_out,
+ const int *probelist, const uint8_t *data_in,
+ uint64_t length_in, uint8_t **data_out,
uint64_t *length_out)
{
unsigned int in_offset, out_offset;
}
num_enabled_probes = 0;
- for (i = 0; probelist[i]; i++)
+ for (i = 0; probelist[i] != -1; i++)
num_enabled_probes++;
/* Are there more probes than the target unit size supports? */
if (num_enabled_probes > out_unitsize * 8) {
sr_err("filter: %s: too many probes (%d) for the target unit "
- "size (%d)", num_enabled_probes, out_unitsize, __func__);
+ "size (%d)", __func__, num_enabled_probes, out_unitsize);
return SR_ERR_ARG;
}
while (in_offset <= length_in - in_unitsize) {
memcpy(&sample_in, data_in + in_offset, in_unitsize);
sample_out = out_bit = 0;
- for (i = 0; probelist[i]; i++) {
- if (sample_in & (1 << (probelist[i] - 1)))
+ for (i = 0; probelist[i] != -1; i++) {
+ if (sample_in & (1 << (probelist[i])))
sample_out |= (1 << out_bit);
out_bit++;
}
return SR_OK;
}
+
+/** @} */