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/>.
25 #include <libsigrok/libsigrok.h>
26 #include "libsigrok-internal.h"
28 #define LOG_PREFIX "es51919"
31 /** Total size of the buffer. */
33 /** Amount of data currently in the buffer. */
35 /** Offset where the data starts in the buffer. */
37 /** Space for the data. */
41 static struct dev_buffer *dev_buffer_new(size_t size)
43 struct dev_buffer *dbuf;
45 dbuf = g_malloc0(sizeof(struct dev_buffer) + size);
53 static void dev_buffer_destroy(struct dev_buffer *dbuf)
58 static int dev_buffer_fill_serial(struct dev_buffer *dbuf,
59 struct sr_dev_inst *sdi)
61 struct sr_serial_dev_inst *serial;
66 /* If we already have data, move it to the beginning of the buffer. */
67 if (dbuf->len > 0 && dbuf->offset > 0)
68 memmove(dbuf->data, dbuf->data + dbuf->offset, dbuf->len);
72 len = dbuf->size - dbuf->len;
73 len = serial_read_nonblocking(serial, dbuf->data + dbuf->len, len);
75 sr_err("Serial port read error: %d.", len);
84 static uint8_t *dev_buffer_packet_find(struct dev_buffer *dbuf,
85 gboolean (*packet_valid)(const uint8_t *),
90 while (dbuf->len >= packet_size) {
91 if (packet_valid(dbuf->data + dbuf->offset)) {
92 offset = dbuf->offset;
93 dbuf->offset += packet_size;
94 dbuf->len -= packet_size;
95 return dbuf->data + offset;
104 struct dev_limit_counter {
105 /** The current number of received samples/frames/etc. */
107 /** The limit (in number of samples/frames/etc.). */
111 static void dev_limit_counter_start(struct dev_limit_counter *cnt)
116 static void dev_limit_counter_inc(struct dev_limit_counter *cnt)
121 static void dev_limit_counter_limit_set(struct dev_limit_counter *cnt,
127 static gboolean dev_limit_counter_limit_reached(struct dev_limit_counter *cnt)
129 if (cnt->limit && cnt->count >= cnt->limit) {
130 sr_info("Requested counter limit reached.");
137 struct dev_time_counter {
138 /** The starting time of current sampling run. */
140 /** The time limit (in milliseconds). */
144 static void dev_time_counter_start(struct dev_time_counter *cnt)
146 cnt->starttime = g_get_monotonic_time();
149 static void dev_time_limit_set(struct dev_time_counter *cnt, uint64_t limit)
154 static gboolean dev_time_limit_reached(struct dev_time_counter *cnt)
159 time = (g_get_monotonic_time() - cnt->starttime) / 1000;
160 if (time > (int64_t)cnt->limit) {
161 sr_info("Requested time limit reached.");
169 static void serial_conf_get(GSList *options, const char *def_serialcomm,
170 const char **conn, const char **serialcomm)
172 struct sr_config *src;
175 *conn = *serialcomm = NULL;
176 for (l = options; l; l = l->next) {
180 *conn = g_variant_get_string(src->data, NULL);
182 case SR_CONF_SERIALCOMM:
183 *serialcomm = g_variant_get_string(src->data, NULL);
188 if (*serialcomm == NULL)
189 *serialcomm = def_serialcomm;
192 static struct sr_serial_dev_inst *serial_dev_new(GSList *options,
193 const char *def_serialcomm)
196 const char *conn, *serialcomm;
198 serial_conf_get(options, def_serialcomm, &conn, &serialcomm);
203 return sr_serial_dev_inst_new(conn, serialcomm);
206 static int serial_stream_check_buf(struct sr_serial_dev_inst *serial,
207 uint8_t *buf, size_t buflen,
209 packet_valid_callback is_valid,
210 uint64_t timeout_ms, int baudrate)
215 if ((ret = serial_open(serial, SERIAL_RDWR)) != SR_OK)
218 serial_flush(serial);
221 ret = serial_stream_detect(serial, buf, &len, packet_size,
222 is_valid, timeout_ms, baudrate);
224 serial_close(serial);
230 * If we dropped more than two packets worth of data, something is
231 * wrong. We shouldn't quit however, since the dropped bytes might be
232 * just zeroes at the beginning of the stream. Those can occur as a
233 * combination of the nonstandard cable that ships with some devices
234 * and the serial port or USB to serial adapter.
236 dropped = len - packet_size;
237 if (dropped > 2 * packet_size)
238 sr_warn("Had to drop too much data.");
243 static int serial_stream_check(struct sr_serial_dev_inst *serial,
245 packet_valid_callback is_valid,
246 uint64_t timeout_ms, int baudrate)
250 return serial_stream_check_buf(serial, buf, sizeof(buf), packet_size,
251 is_valid, timeout_ms, baudrate);
254 static int send_config_update(struct sr_dev_inst *sdi, struct sr_config *cfg)
256 struct sr_datafeed_packet packet;
257 struct sr_datafeed_meta meta;
259 memset(&meta, 0, sizeof(meta));
261 packet.type = SR_DF_META;
262 packet.payload = &meta;
264 meta.config = g_slist_append(meta.config, cfg);
266 return sr_session_send(sdi, &packet);
269 static int send_config_update_key(struct sr_dev_inst *sdi, uint32_t key,
272 struct sr_config *cfg;
275 cfg = sr_config_new(key, var);
279 ret = send_config_update(sdi, cfg);
286 * Cyrustek ES51919 LCR chipset host protocol.
288 * Public official documentation does not contain the protocol
289 * description, so this is all based on reverse engineering.
291 * Packet structure (17 bytes):
293 * 0x00: header1 ?? (0x00)
294 * 0x01: header2 ?? (0x0d)
297 * bit 0 = hold enabled
298 * bit 1 = reference shown (in delta mode)
300 * bit 3 = calibration mode
301 * bit 4 = sorting mode
304 * bit 7 = parallel measurement (vs. serial)
307 * bit 0-4 = ??? (0x10)
308 * bit 5-7 = test frequency
316 * 0x04: tolerance (sorting mode)
327 * 0x05-0x09: primary measurement
328 * 0x05: measured quantity
333 * 0x06: measurement MSB (0x4e20 = 20000 = outside limits)
334 * 0x07: measurement LSB
335 * 0x08: measurement info
336 * bit 0-2 = decimal point multiplier (10^-val)
352 * 0x09: measurement status
354 * 0 = normal (measurement shown)
355 * 1 = blank (nothing shown)
357 * 3 = outside limits ("OL")
361 * 10 = shorted ("Srt")
362 * bit 4-6 = ??? (maybe part of same field with 0-3)
363 * bit 7 = ??? (some independent flag)
365 * 0x0a-0x0e: secondary measurement
366 * 0x0a: measured quantity
368 * 1 = dissipation factor
370 * 3 = parallel AC resistance / ESR
372 * 0x0b-0x0e: like primary measurement
374 * 0x0f: footer1 (0x0d) ?
375 * 0x10: footer2 (0x0a) ?
378 #define PACKET_SIZE 17
380 static const double frequencies[] = {
381 100, 120, 1000, 10000, 100000, 0,
384 enum { MODEL_NONE, MODEL_PAR, MODEL_SER, MODEL_AUTO, };
386 static const char *const models[] = {
387 "NONE", "PARALLEL", "SERIES", "AUTO",
391 struct dev_limit_counter frame_count;
393 struct dev_time_counter time_count;
395 struct dev_buffer *buf;
397 /** The frequency of the test signal (index to frequencies[]). */
400 /** Equivalent circuit model (index to models[]). */
404 static const uint8_t *pkt_to_buf(const uint8_t *pkt, int is_secondary)
406 return is_secondary ? pkt + 10 : pkt + 5;
409 static int parse_mq(const uint8_t *pkt, int is_secondary, int is_parallel)
413 buf = pkt_to_buf(pkt, is_secondary);
415 switch (is_secondary << 8 | buf[0]) {
418 SR_MQ_PARALLEL_INDUCTANCE : SR_MQ_SERIES_INDUCTANCE;
421 SR_MQ_PARALLEL_CAPACITANCE : SR_MQ_SERIES_CAPACITANCE;
425 SR_MQ_PARALLEL_RESISTANCE : SR_MQ_SERIES_RESISTANCE;
427 return SR_MQ_RESISTANCE;
429 return SR_MQ_DIFFERENCE;
431 return SR_MQ_DISSIPATION_FACTOR;
433 return SR_MQ_QUALITY_FACTOR;
435 return SR_MQ_PHASE_ANGLE;
438 sr_err("Unknown quantity 0x%03x.", is_secondary << 8 | buf[0]);
443 static float parse_value(const uint8_t *buf, int *digits)
445 static const int exponents[] = {0, -1, -2, -3, -4, -5, -6, -7};
449 exponent = exponents[buf[3] & 7];
451 val = (buf[1] << 8) | buf[2];
452 return (float)val * powf(10, exponent);
455 static void parse_measurement(const uint8_t *pkt, float *floatval,
456 struct sr_datafeed_analog *analog,
459 static const struct {
463 { SR_UNIT_UNITLESS, 0 }, /* no unit */
464 { SR_UNIT_OHM, 0 }, /* Ohm */
465 { SR_UNIT_OHM, 3 }, /* kOhm */
466 { SR_UNIT_OHM, 6 }, /* MOhm */
468 { SR_UNIT_HENRY, -6 }, /* uH */
469 { SR_UNIT_HENRY, -3 }, /* mH */
470 { SR_UNIT_HENRY, 0 }, /* H */
471 { SR_UNIT_HENRY, 3 }, /* kH */
472 { SR_UNIT_FARAD, -12 }, /* pF */
473 { SR_UNIT_FARAD, -9 }, /* nF */
474 { SR_UNIT_FARAD, -6 }, /* uF */
475 { SR_UNIT_FARAD, -3 }, /* mF */
476 { SR_UNIT_PERCENTAGE, 0 }, /* % */
477 { SR_UNIT_DEGREE, 0 }, /* degree */
480 int digits, exponent;
483 buf = pkt_to_buf(pkt, is_secondary);
485 analog->meaning->mq = 0;
486 analog->meaning->mqflags = 0;
488 state = buf[4] & 0xf;
490 if (state != 0 && state != 3)
494 /* Calibration and Sorting modes not supported. */
500 analog->meaning->mqflags |= SR_MQFLAG_HOLD;
502 analog->meaning->mqflags |= SR_MQFLAG_REFERENCE;
505 analog->meaning->mqflags |= SR_MQFLAG_RELATIVE;
508 if ((analog->meaning->mq = parse_mq(pkt, is_secondary, pkt[2] & 0x80)) == 0)
511 if ((buf[3] >> 3) >= ARRAY_SIZE(units)) {
512 sr_err("Unknown unit %u.", buf[3] >> 3);
513 analog->meaning->mq = 0;
517 analog->meaning->unit = units[buf[3] >> 3].unit;
519 exponent = units[buf[3] >> 3].exponent;
520 *floatval = parse_value(buf, &digits);
521 *floatval *= (state == 0) ? powf(10, exponent) : INFINITY;
522 analog->encoding->digits = digits - exponent;
523 analog->spec->spec_digits = digits - exponent;
526 static unsigned int parse_freq(const uint8_t *pkt)
532 if (freq >= ARRAY_SIZE(frequencies)) {
533 sr_err("Unknown frequency %u.", freq);
534 freq = ARRAY_SIZE(frequencies) - 1;
540 static unsigned int parse_model(const uint8_t *pkt)
544 else if (parse_mq(pkt, 0, 0) == SR_MQ_RESISTANCE)
546 else if (pkt[2] & 0x80)
552 static gboolean packet_valid(const uint8_t *pkt)
555 * If the first two bytes of the packet are indeed a constant
556 * header, they should be checked too. Since we don't know it
557 * for sure, we'll just check the last two for now since they
558 * seem to be constant just like in the other Cyrustek chipset
561 if (pkt[15] == 0xd && pkt[16] == 0xa)
567 static int do_config_update(struct sr_dev_inst *sdi, uint32_t key,
570 return send_config_update_key(sdi, key, var);
573 static int send_freq_update(struct sr_dev_inst *sdi, unsigned int freq)
575 return do_config_update(sdi, SR_CONF_OUTPUT_FREQUENCY,
576 g_variant_new_double(frequencies[freq]));
579 static int send_model_update(struct sr_dev_inst *sdi, unsigned int model)
581 return do_config_update(sdi, SR_CONF_EQUIV_CIRCUIT_MODEL,
582 g_variant_new_string(models[model]));
585 static void handle_packet(struct sr_dev_inst *sdi, const uint8_t *pkt)
587 struct sr_datafeed_packet packet;
588 struct sr_datafeed_analog analog;
589 struct sr_analog_encoding encoding;
590 struct sr_analog_meaning meaning;
591 struct sr_analog_spec spec;
592 struct dev_context *devc;
596 struct sr_channel *channel;
600 val = parse_freq(pkt);
601 if (val != devc->freq) {
602 if (send_freq_update(sdi, val) == SR_OK)
608 val = parse_model(pkt);
609 if (val != devc->model) {
610 if (send_model_update(sdi, val) == SR_OK)
618 /* Note: digits/spec_digits will be overridden later. */
619 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
621 analog.num_samples = 1;
622 analog.data = &floatval;
624 channel = sdi->channels->data;
625 analog.meaning->channels = g_slist_append(NULL, channel);
627 parse_measurement(pkt, &floatval, &analog, 0);
628 if (analog.meaning->mq != 0 && channel->enabled) {
630 packet.type = SR_DF_FRAME_BEGIN;
631 sr_session_send(sdi, &packet);
635 packet.type = SR_DF_ANALOG;
636 packet.payload = &analog;
638 sr_session_send(sdi, &packet);
641 g_slist_free(analog.meaning->channels);
643 channel = sdi->channels->next->data;
644 analog.meaning->channels = g_slist_append(NULL, channel);
646 parse_measurement(pkt, &floatval, &analog, 1);
647 if (analog.meaning->mq != 0 && channel->enabled) {
649 packet.type = SR_DF_FRAME_BEGIN;
650 sr_session_send(sdi, &packet);
654 packet.type = SR_DF_ANALOG;
655 packet.payload = &analog;
657 sr_session_send(sdi, &packet);
660 g_slist_free(analog.meaning->channels);
663 packet.type = SR_DF_FRAME_END;
664 sr_session_send(sdi, &packet);
665 dev_limit_counter_inc(&devc->frame_count);
669 static int handle_new_data(struct sr_dev_inst *sdi)
671 struct dev_context *devc;
677 ret = dev_buffer_fill_serial(devc->buf, sdi);
681 while ((pkt = dev_buffer_packet_find(devc->buf, packet_valid,
683 handle_packet(sdi, pkt);
688 static int receive_data(int fd, int revents, void *cb_data)
690 struct sr_dev_inst *sdi;
691 struct dev_context *devc;
695 if (!(sdi = cb_data))
698 if (!(devc = sdi->priv))
701 if (revents == G_IO_IN) {
702 /* Serial data arrived. */
703 handle_new_data(sdi);
706 if (dev_limit_counter_limit_reached(&devc->frame_count) ||
707 dev_time_limit_reached(&devc->time_count))
708 sr_dev_acquisition_stop(sdi);
713 static const char *const channel_names[] = { "P1", "P2" };
715 static int setup_channels(struct sr_dev_inst *sdi)
719 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
720 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
725 SR_PRIV void es51919_serial_clean(void *priv)
727 struct dev_context *devc;
732 dev_buffer_destroy(devc->buf);
735 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
739 struct sr_serial_dev_inst *serial;
740 struct sr_dev_inst *sdi;
741 struct dev_context *devc;
748 if (!(serial = serial_dev_new(options, "9600/8n1/rts=1/dtr=1")))
751 ret = serial_stream_check(serial, PACKET_SIZE, packet_valid,
756 sr_info("Found device on port %s.", serial->port);
758 sdi = g_malloc0(sizeof(struct sr_dev_inst));
759 sdi->status = SR_ST_INACTIVE;
760 sdi->vendor = g_strdup(vendor);
761 sdi->model = g_strdup(model);
762 devc = g_malloc0(sizeof(struct dev_context));
763 devc->buf = dev_buffer_new(PACKET_SIZE * 8);
764 sdi->inst_type = SR_INST_SERIAL;
768 if (setup_channels(sdi) != SR_OK)
774 es51919_serial_clean(devc);
775 sr_dev_inst_free(sdi);
776 sr_serial_dev_inst_free(serial);
781 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
782 const struct sr_dev_inst *sdi,
783 const struct sr_channel_group *cg)
785 struct dev_context *devc;
792 case SR_CONF_OUTPUT_FREQUENCY:
793 *data = g_variant_new_double(frequencies[devc->freq]);
795 case SR_CONF_EQUIV_CIRCUIT_MODEL:
796 *data = g_variant_new_string(models[devc->model]);
805 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
806 const struct sr_dev_inst *sdi,
807 const struct sr_channel_group *cg)
809 struct dev_context *devc;
814 if (!(devc = sdi->priv))
818 case SR_CONF_LIMIT_MSEC:
819 val = g_variant_get_uint64(data);
820 dev_time_limit_set(&devc->time_count, val);
821 sr_dbg("Setting time limit to %" PRIu64 ".", val);
823 case SR_CONF_LIMIT_FRAMES:
824 val = g_variant_get_uint64(data);
825 dev_limit_counter_limit_set(&devc->frame_count, val);
826 sr_dbg("Setting frame limit to %" PRIu64 ".", val);
829 sr_spew("%s: Unsupported key %u", __func__, key);
836 static const uint32_t scanopts[] = {
841 static const uint32_t drvopts[] = {
845 static const uint32_t devopts[] = {
847 SR_CONF_LIMIT_FRAMES | SR_CONF_SET,
848 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
849 SR_CONF_OUTPUT_FREQUENCY | SR_CONF_GET | SR_CONF_LIST,
850 SR_CONF_EQUIV_CIRCUIT_MODEL | SR_CONF_GET | SR_CONF_LIST,
853 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
854 const struct sr_dev_inst *sdi,
855 const struct sr_channel_group *cg)
858 case SR_CONF_SCAN_OPTIONS:
859 case SR_CONF_DEVICE_OPTIONS:
860 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
861 case SR_CONF_OUTPUT_FREQUENCY:
862 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_DOUBLE,
863 ARRAY_AND_SIZE(frequencies), sizeof(double));
865 case SR_CONF_EQUIV_CIRCUIT_MODEL:
866 *data = g_variant_new_strv(ARRAY_AND_SIZE(models));
875 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi)
877 struct dev_context *devc;
878 struct sr_serial_dev_inst *serial;
880 if (!(devc = sdi->priv))
883 dev_limit_counter_start(&devc->frame_count);
884 dev_time_counter_start(&devc->time_count);
886 std_session_send_df_header(sdi);
889 serial_source_add(sdi->session, serial, G_IO_IN, 50,
890 receive_data, (void *)sdi);