2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Janne Huttunen <jahuttun@gmail.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "libsigrok.h"
25 #include "libsigrok-internal.h"
27 #define LOG_PREFIX "es51919"
30 /** Total size of the buffer. */
32 /** Amount of data currently in the buffer. */
34 /** Offset where the data starts in the buffer. */
36 /** Space for the data. */
40 static struct dev_buffer *dev_buffer_new(size_t size)
42 struct dev_buffer *dbuf;
44 if (!(dbuf = g_try_malloc(sizeof(struct dev_buffer) + size))) {
45 sr_err("Dev buffer malloc failed (size=%zu).", size);
56 static void dev_buffer_destroy(struct dev_buffer *dbuf)
61 static int dev_buffer_fill_serial(struct dev_buffer *dbuf,
62 struct sr_dev_inst *sdi)
64 struct sr_serial_dev_inst *serial;
69 /* If we already have data, move it to the beginning of the buffer. */
70 if (dbuf->len > 0 && dbuf->offset > 0)
71 memmove(dbuf->data, dbuf->data + dbuf->offset, dbuf->len);
75 len = dbuf->size - dbuf->len;
76 len = serial_read_nonblocking(serial, dbuf->data + dbuf->len, len);
78 sr_err("Serial port read error: %d.", len);
87 static uint8_t *dev_buffer_packet_find(struct dev_buffer *dbuf,
88 gboolean (*packet_valid)(const uint8_t *),
93 while (dbuf->len >= packet_size) {
94 if (packet_valid(dbuf->data + dbuf->offset)) {
95 offset = dbuf->offset;
96 dbuf->offset += packet_size;
97 dbuf->len -= packet_size;
98 return dbuf->data + offset;
107 struct dev_sample_counter {
108 /** The current number of already received samples. */
110 /** The current sampling limit (in number of samples). */
114 static void dev_sample_counter_start(struct dev_sample_counter *cnt)
119 static void dev_sample_counter_inc(struct dev_sample_counter *cnt)
124 static void dev_sample_limit_set(struct dev_sample_counter *cnt, uint64_t limit)
129 static gboolean dev_sample_limit_reached(struct dev_sample_counter *cnt)
131 if (cnt->limit && cnt->count >= cnt->limit) {
132 sr_info("Requested sample limit reached.");
139 struct dev_time_counter {
140 /** The starting time of current sampling run. */
142 /** The time limit (in milliseconds). */
146 static void dev_time_counter_start(struct dev_time_counter *cnt)
148 cnt->starttime = g_get_monotonic_time();
151 static void dev_time_limit_set(struct dev_time_counter *cnt, uint64_t limit)
156 static gboolean dev_time_limit_reached(struct dev_time_counter *cnt)
161 time = (g_get_monotonic_time() - cnt->starttime) / 1000;
162 if (time > (int64_t)cnt->limit) {
163 sr_info("Requested time limit reached.");
171 static void serial_conf_get(GSList *options, const char *def_serialcomm,
172 const char **conn, const char **serialcomm)
174 struct sr_config *src;
177 *conn = *serialcomm = NULL;
178 for (l = options; l; l = l->next) {
182 *conn = g_variant_get_string(src->data, NULL);
184 case SR_CONF_SERIALCOMM:
185 *serialcomm = g_variant_get_string(src->data, NULL);
190 if (*serialcomm == NULL)
191 *serialcomm = def_serialcomm;
194 static struct sr_serial_dev_inst *serial_dev_new(GSList *options,
195 const char *def_serialcomm)
198 const char *conn, *serialcomm;
200 serial_conf_get(options, def_serialcomm, &conn, &serialcomm);
205 return sr_serial_dev_inst_new(conn, serialcomm);
208 static int serial_stream_check_buf(struct sr_serial_dev_inst *serial,
209 uint8_t *buf, size_t buflen,
211 packet_valid_callback is_valid,
212 uint64_t timeout_ms, int baudrate)
217 if ((ret = serial_open(serial, SERIAL_RDWR)) != SR_OK)
220 serial_flush(serial);
223 ret = serial_stream_detect(serial, buf, &len, packet_size,
224 is_valid, timeout_ms, baudrate);
226 serial_close(serial);
232 * If we dropped more than two packets worth of data, something is
233 * wrong. We shouldn't quit however, since the dropped bytes might be
234 * just zeroes at the beginning of the stream. Those can occur as a
235 * combination of the nonstandard cable that ships with some devices
236 * and the serial port or USB to serial adapter.
238 dropped = len - packet_size;
239 if (dropped > 2 * packet_size)
240 sr_warn("Had to drop too much data.");
245 static int serial_stream_check(struct sr_serial_dev_inst *serial,
247 packet_valid_callback is_valid,
248 uint64_t timeout_ms, int baudrate)
252 return serial_stream_check_buf(serial, buf, sizeof(buf), packet_size,
253 is_valid, timeout_ms, baudrate);
256 struct std_opt_desc {
257 const uint32_t *scanopts;
258 const int num_scanopts;
259 const uint32_t *devopts;
260 const int num_devopts;
263 static int std_config_list(uint32_t key, GVariant **data,
264 const struct std_opt_desc *d)
267 case SR_CONF_SCAN_OPTIONS:
268 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
269 d->scanopts, d->num_scanopts, sizeof(uint32_t));
271 case SR_CONF_DEVICE_OPTIONS:
272 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
273 d->devopts, d->num_devopts, sizeof(uint32_t));
282 static int send_config_update(struct sr_dev_inst *sdi, struct sr_config *cfg)
284 struct sr_datafeed_packet packet;
285 struct sr_datafeed_meta meta;
287 memset(&meta, 0, sizeof(meta));
289 packet.type = SR_DF_META;
290 packet.payload = &meta;
292 meta.config = g_slist_append(meta.config, cfg);
294 return sr_session_send(sdi, &packet);
297 static int send_config_update_key(struct sr_dev_inst *sdi, uint32_t key,
300 struct sr_config *cfg;
303 cfg = sr_config_new(key, var);
307 ret = send_config_update(sdi, cfg);
315 * Cyrustek ES51919 LCR chipset host protocol.
317 * Public official documentation does not contain the protocol
318 * description, so this is all based on reverse engineering.
320 * Packet structure (17 bytes):
322 * 0x00: header1 ?? (0x00)
323 * 0x01: header2 ?? (0x0d)
326 * bit 0 = hold enabled
327 * bit 1 = reference shown (in delta mode)
329 * bit 3 = calibration mode
330 * bit 4 = sorting mode
333 * bit 7 = parallel measurement (vs. serial)
336 * bit 0-4 = ??? (0x10)
337 * bit 5-7 = test frequency
345 * 0x04: tolerance (sorting mode)
356 * 0x05-0x09: primary measurement
357 * 0x05: measured quantity
362 * 0x06: measurement MSB (0x4e20 = 20000 = outside limits)
363 * 0x07: measurement LSB
364 * 0x08: measurement info
365 * bit 0-2 = decimal point multiplier (10^-val)
381 * 0x09: measurement status
383 * 0 = normal (measurement shown)
384 * 1 = blank (nothing shown)
386 * 3 = outside limits ("OL")
390 * 10 = shorted ("Srt")
391 * bit 4-6 = ??? (maybe part of same field with 0-3)
392 * bit 7 = ??? (some independent flag)
394 * 0x0a-0x0e: secondary measurement
395 * 0x0a: measured quantity
397 * 1 = dissipation factor
399 * 3 = parallel AC resistance / ESR
401 * 0x0b-0x0e: like primary measurement
403 * 0x0f: footer1 (0x0d) ?
404 * 0x10: footer2 (0x0a) ?
407 #define PACKET_SIZE 17
409 static const uint64_t frequencies[] = {
410 100, 120, 1000, 10000, 100000, 0,
413 enum { QUANT_AUTO = 5, };
415 static const char *const quantities1[] = {
416 "NONE", "INDUCTANCE", "CAPACITANCE", "RESISTANCE", "RESISTANCE", "AUTO",
419 static const char *const list_quantities1[] = {
420 "NONE", "INDUCTANCE", "CAPACITANCE", "RESISTANCE", "AUTO",
423 static const char *const quantities2[] = {
424 "NONE", "DISSIPATION", "QUALITY", "RESISTANCE", "ANGLE", "AUTO",
427 enum { MODEL_NONE, MODEL_PAR, MODEL_SER, MODEL_AUTO, };
429 static const char *const models[] = {
430 "NONE", "PARALLEL", "SERIES", "AUTO",
433 /** Private, per-device-instance driver context. */
435 /** Opaque pointer passed in by the frontend. */
438 /** The number of samples. */
439 struct dev_sample_counter sample_count;
441 /** The time limit counter. */
442 struct dev_time_counter time_count;
445 struct dev_buffer *buf;
447 /** The frequency of the test signal (index to frequencies[]). */
450 /** Measured primary quantity (index to quantities1[]). */
453 /** Measured secondary quantity (index to quantities2[]). */
456 /** Equivalent circuit model (index to models[]). */
460 static const uint8_t *pkt_to_buf(const uint8_t *pkt, int is_secondary)
462 return is_secondary ? pkt + 10 : pkt + 5;
465 static int parse_mq(const uint8_t *pkt, int is_secondary, int is_parallel)
469 buf = pkt_to_buf(pkt, is_secondary);
471 switch (is_secondary << 8 | buf[0]) {
474 SR_MQ_PARALLEL_INDUCTANCE : SR_MQ_SERIES_INDUCTANCE;
477 SR_MQ_PARALLEL_CAPACITANCE : SR_MQ_SERIES_CAPACITANCE;
481 SR_MQ_PARALLEL_RESISTANCE : SR_MQ_SERIES_RESISTANCE;
483 return SR_MQ_RESISTANCE;
485 return SR_MQ_DIFFERENCE;
487 return SR_MQ_DISSIPATION_FACTOR;
489 return SR_MQ_QUALITY_FACTOR;
491 return SR_MQ_PHASE_ANGLE;
494 sr_err("Unknown quantity 0x%03x.", is_secondary << 8 | buf[0]);
499 static float parse_value(const uint8_t *buf)
501 static const float decimals[] = {
502 1, 1e-1, 1e-2, 1e-3, 1e-4, 1e-5, 1e-6, 1e-7
506 val = (buf[1] << 8) | buf[2];
507 return (float)val * decimals[buf[3] & 7];
510 static void parse_measurement(const uint8_t *pkt, float *floatval,
511 struct sr_datafeed_analog *analog,
514 static const struct {
518 { SR_UNIT_UNITLESS, 1 }, /* no unit */
519 { SR_UNIT_OHM, 1 }, /* Ohm */
520 { SR_UNIT_OHM, 1e3 }, /* kOhm */
521 { SR_UNIT_OHM, 1e6 }, /* MOhm */
523 { SR_UNIT_HENRY, 1e-6 }, /* uH */
524 { SR_UNIT_HENRY, 1e-3 }, /* mH */
525 { SR_UNIT_HENRY, 1 }, /* H */
526 { SR_UNIT_HENRY, 1e3 }, /* kH */
527 { SR_UNIT_FARAD, 1e-12 }, /* pF */
528 { SR_UNIT_FARAD, 1e-9 }, /* nF */
529 { SR_UNIT_FARAD, 1e-6 }, /* uF */
530 { SR_UNIT_FARAD, 1e-3 }, /* mF */
531 { SR_UNIT_PERCENTAGE, 1 }, /* % */
532 { SR_UNIT_DEGREE, 1 } /* degree */
537 buf = pkt_to_buf(pkt, is_secondary);
542 state = buf[4] & 0xf;
544 if (state != 0 && state != 3)
548 /* Calibration and Sorting modes not supported. */
554 analog->mqflags |= SR_MQFLAG_HOLD;
556 analog->mqflags |= SR_MQFLAG_REFERENCE;
559 analog->mqflags |= SR_MQFLAG_RELATIVE;
562 if ((analog->mq = parse_mq(pkt, is_secondary, pkt[2] & 0x80)) < 0)
565 if ((buf[3] >> 3) >= ARRAY_SIZE(units)) {
566 sr_err("Unknown unit %u.", buf[3] >> 3);
571 analog->unit = units[buf[3] >> 3].unit;
573 *floatval = parse_value(buf);
574 *floatval *= (state == 0) ? units[buf[3] >> 3].mult : INFINITY;
577 static unsigned int parse_freq(const uint8_t *pkt)
583 if (freq >= ARRAY_SIZE(frequencies)) {
584 sr_err("Unknown frequency %u.", freq);
585 freq = ARRAY_SIZE(frequencies) - 1;
591 static unsigned int parse_quant(const uint8_t *pkt, int is_secondary)
598 buf = pkt_to_buf(pkt, is_secondary);
603 static unsigned int parse_model(const uint8_t *pkt)
607 else if (parse_mq(pkt, 0, 0) == SR_MQ_RESISTANCE)
609 else if (pkt[2] & 0x80)
616 static gboolean packet_valid(const uint8_t *pkt)
619 * If the first two bytes of the packet are indeed a constant
620 * header, they should be checked too. Since we don't know it
621 * for sure, we'll just check the last two for now since they
622 * seem to be constant just like in the other Cyrustek chipset
625 if (pkt[15] == 0xd && pkt[16] == 0xa)
631 static int do_config_update(struct sr_dev_inst *sdi, uint32_t key,
634 struct dev_context *devc;
638 return send_config_update_key(devc->cb_data, key, var);
641 static int send_freq_update(struct sr_dev_inst *sdi, unsigned int freq)
643 return do_config_update(sdi, SR_CONF_OUTPUT_FREQUENCY,
644 g_variant_new_uint64(frequencies[freq]));
647 static int send_quant1_update(struct sr_dev_inst *sdi, unsigned int quant)
649 return do_config_update(sdi, SR_CONF_MEASURED_QUANTITY,
650 g_variant_new_string(quantities1[quant]));
653 static int send_quant2_update(struct sr_dev_inst *sdi, unsigned int quant)
655 return do_config_update(sdi, SR_CONF_MEASURED_2ND_QUANTITY,
656 g_variant_new_string(quantities2[quant]));
659 static int send_model_update(struct sr_dev_inst *sdi, unsigned int model)
661 return do_config_update(sdi, SR_CONF_EQUIV_CIRCUIT_MODEL,
662 g_variant_new_string(models[model]));
665 static void handle_packet(struct sr_dev_inst *sdi, const uint8_t *pkt)
667 struct sr_datafeed_packet packet;
668 struct sr_datafeed_analog analog;
669 struct dev_context *devc;
676 val = parse_freq(pkt);
677 if (val != devc->freq) {
678 if (send_freq_update(sdi, val) == SR_OK)
684 val = parse_quant(pkt, 0);
685 if (val != devc->quant1) {
686 if (send_quant1_update(sdi, val) == SR_OK)
692 val = parse_quant(pkt, 1);
693 if (val != devc->quant2) {
694 if (send_quant2_update(sdi, val) == SR_OK)
700 val = parse_model(pkt);
701 if (val != devc->model) {
702 if (send_model_update(sdi, val) == SR_OK)
710 memset(&analog, 0, sizeof(analog));
712 analog.num_samples = 1;
713 analog.data = &floatval;
715 packet.type = SR_DF_ANALOG;
716 packet.payload = &analog;
718 analog.channels = g_slist_append(NULL, sdi->channels->data);
720 parse_measurement(pkt, &floatval, &analog, 0);
721 if (analog.mq >= 0) {
722 if (sr_session_send(devc->cb_data, &packet) == SR_OK)
726 analog.channels = g_slist_append(NULL, sdi->channels->next->data);
728 parse_measurement(pkt, &floatval, &analog, 1);
729 if (analog.mq >= 0) {
730 if (sr_session_send(devc->cb_data, &packet) == SR_OK)
735 dev_sample_counter_inc(&devc->sample_count);
738 static int handle_new_data(struct sr_dev_inst *sdi)
740 struct dev_context *devc;
746 ret = dev_buffer_fill_serial(devc->buf, sdi);
750 while ((pkt = dev_buffer_packet_find(devc->buf, packet_valid,
752 handle_packet(sdi, pkt);
757 static int receive_data(int fd, int revents, void *cb_data)
759 struct sr_dev_inst *sdi;
760 struct dev_context *devc;
764 if (!(sdi = cb_data))
767 if (!(devc = sdi->priv))
770 if (revents == G_IO_IN) {
771 /* Serial data arrived. */
772 handle_new_data(sdi);
775 if (dev_sample_limit_reached(&devc->sample_count) ||
776 dev_time_limit_reached(&devc->time_count))
777 sdi->driver->dev_acquisition_stop(sdi, cb_data);
782 static int add_channel(struct sr_dev_inst *sdi, const char *name)
784 struct sr_channel *ch;
786 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, name)))
789 sdi->channels = g_slist_append(sdi->channels, ch);
794 static const char *const channel_names[] = { "P1", "P2" };
796 static int setup_channels(struct sr_dev_inst *sdi)
803 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
804 ret = add_channel(sdi, channel_names[i]);
812 SR_PRIV void es51919_serial_clean(void *priv)
814 struct dev_context *devc;
819 dev_buffer_destroy(devc->buf);
823 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
827 struct sr_serial_dev_inst *serial;
828 struct sr_dev_inst *sdi;
829 struct dev_context *devc;
836 if (!(serial = serial_dev_new(options, "9600/8n1/rts=1/dtr=1")))
839 ret = serial_stream_check(serial, PACKET_SIZE, packet_valid,
844 sr_info("Found device on port %s.", serial->port);
846 sdi = sr_dev_inst_new();
847 sdi->status = SR_ST_INACTIVE;
848 sdi->vendor = g_strdup(vendor);
849 sdi->model = g_strdup(model);
851 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
852 sr_err("Device context malloc failed.");
856 if (!(devc->buf = dev_buffer_new(PACKET_SIZE * 8)))
859 sdi->inst_type = SR_INST_SERIAL;
864 if (setup_channels(sdi) != SR_OK)
870 es51919_serial_clean(devc);
872 sr_dev_inst_free(sdi);
874 sr_serial_dev_inst_free(serial);
879 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
880 const struct sr_dev_inst *sdi,
881 const struct sr_channel_group *cg)
883 struct dev_context *devc;
887 if (!(devc = sdi->priv))
891 case SR_CONF_OUTPUT_FREQUENCY:
892 *data = g_variant_new_uint64(frequencies[devc->freq]);
894 case SR_CONF_MEASURED_QUANTITY:
895 *data = g_variant_new_string(quantities1[devc->quant1]);
897 case SR_CONF_MEASURED_2ND_QUANTITY:
898 *data = g_variant_new_string(quantities2[devc->quant2]);
900 case SR_CONF_EQUIV_CIRCUIT_MODEL:
901 *data = g_variant_new_string(models[devc->model]);
904 sr_spew("%s: Unsupported key %u", __func__, key);
911 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
912 const struct sr_dev_inst *sdi,
913 const struct sr_channel_group *cg)
915 struct dev_context *devc;
920 if (!(devc = sdi->priv))
924 case SR_CONF_LIMIT_MSEC:
925 val = g_variant_get_uint64(data);
926 dev_time_limit_set(&devc->time_count, val);
927 sr_dbg("Setting time limit to %" PRIu64 ".", val);
929 case SR_CONF_LIMIT_SAMPLES:
930 val = g_variant_get_uint64(data);
931 dev_sample_limit_set(&devc->sample_count, val);
932 sr_dbg("Setting sample limit to %" PRIu64 ".", val);
935 sr_spew("%s: Unsupported key %u", __func__, key);
942 static const uint32_t scanopts[] = {
947 static const uint32_t devopts[] = {
950 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
951 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
952 SR_CONF_OUTPUT_FREQUENCY | SR_CONF_GET | SR_CONF_LIST,
953 SR_CONF_MEASURED_QUANTITY | SR_CONF_GET | SR_CONF_LIST,
954 SR_CONF_MEASURED_2ND_QUANTITY | SR_CONF_GET | SR_CONF_LIST,
955 SR_CONF_EQUIV_CIRCUIT_MODEL | SR_CONF_GET | SR_CONF_LIST,
958 static const struct std_opt_desc opts = {
959 scanopts, ARRAY_SIZE(scanopts),
960 devopts, ARRAY_SIZE(devopts),
963 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
964 const struct sr_dev_inst *sdi,
965 const struct sr_channel_group *cg)
970 if (std_config_list(key, data, &opts) == SR_OK)
974 case SR_CONF_OUTPUT_FREQUENCY:
975 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
976 frequencies, ARRAY_SIZE(frequencies), sizeof(uint64_t));
978 case SR_CONF_MEASURED_QUANTITY:
979 *data = g_variant_new_strv(list_quantities1,
980 ARRAY_SIZE(list_quantities1));
982 case SR_CONF_MEASURED_2ND_QUANTITY:
983 *data = g_variant_new_strv(quantities2,
984 ARRAY_SIZE(quantities2));
986 case SR_CONF_EQUIV_CIRCUIT_MODEL:
987 *data = g_variant_new_strv(models, ARRAY_SIZE(models));
990 sr_spew("%s: Unsupported key %u", __func__, key);
997 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
1000 struct dev_context *devc;
1001 struct sr_serial_dev_inst *serial;
1003 if (sdi->status != SR_ST_ACTIVE)
1004 return SR_ERR_DEV_CLOSED;
1006 if (!(devc = sdi->priv))
1009 devc->cb_data = cb_data;
1011 dev_sample_counter_start(&devc->sample_count);
1012 dev_time_counter_start(&devc->time_count);
1014 /* Send header packet to the session bus. */
1015 std_session_send_df_header(cb_data, LOG_PREFIX);
1017 /* Poll every 50ms, or whenever some data comes in. */
1019 serial_source_add(sdi->session, serial, G_IO_IN, 50,
1020 receive_data, (void *)sdi);
1025 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
1028 return std_serial_dev_acquisition_stop(sdi, cb_data,
1029 std_serial_dev_close, sdi->conn, LOG_PREFIX);