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/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 dbuf = g_malloc0(sizeof(struct dev_buffer) + size);
52 static void dev_buffer_destroy(struct dev_buffer *dbuf)
57 static int dev_buffer_fill_serial(struct dev_buffer *dbuf,
58 struct sr_dev_inst *sdi)
60 struct sr_serial_dev_inst *serial;
65 /* If we already have data, move it to the beginning of the buffer. */
66 if (dbuf->len > 0 && dbuf->offset > 0)
67 memmove(dbuf->data, dbuf->data + dbuf->offset, dbuf->len);
71 len = dbuf->size - dbuf->len;
72 len = serial_read_nonblocking(serial, dbuf->data + dbuf->len, len);
74 sr_err("Serial port read error: %d.", len);
83 static uint8_t *dev_buffer_packet_find(struct dev_buffer *dbuf,
84 gboolean (*packet_valid)(const uint8_t *),
89 while (dbuf->len >= packet_size) {
90 if (packet_valid(dbuf->data + dbuf->offset)) {
91 offset = dbuf->offset;
92 dbuf->offset += packet_size;
93 dbuf->len -= packet_size;
94 return dbuf->data + offset;
103 struct dev_limit_counter {
104 /** The current number of received samples/frames/etc. */
106 /** The limit (in number of samples/frames/etc.). */
110 static void dev_limit_counter_start(struct dev_limit_counter *cnt)
115 static void dev_limit_counter_inc(struct dev_limit_counter *cnt)
120 static void dev_limit_counter_limit_set(struct dev_limit_counter *cnt,
126 static gboolean dev_limit_counter_limit_reached(struct dev_limit_counter *cnt)
128 if (cnt->limit && cnt->count >= cnt->limit) {
129 sr_info("Requested counter limit reached.");
136 struct dev_time_counter {
137 /** The starting time of current sampling run. */
139 /** The time limit (in milliseconds). */
143 static void dev_time_counter_start(struct dev_time_counter *cnt)
145 cnt->starttime = g_get_monotonic_time();
148 static void dev_time_limit_set(struct dev_time_counter *cnt, uint64_t limit)
153 static gboolean dev_time_limit_reached(struct dev_time_counter *cnt)
158 time = (g_get_monotonic_time() - cnt->starttime) / 1000;
159 if (time > (int64_t)cnt->limit) {
160 sr_info("Requested time limit reached.");
168 static void serial_conf_get(GSList *options, const char *def_serialcomm,
169 const char **conn, const char **serialcomm)
171 struct sr_config *src;
174 *conn = *serialcomm = NULL;
175 for (l = options; l; l = l->next) {
179 *conn = g_variant_get_string(src->data, NULL);
181 case SR_CONF_SERIALCOMM:
182 *serialcomm = g_variant_get_string(src->data, NULL);
187 if (*serialcomm == NULL)
188 *serialcomm = def_serialcomm;
191 static struct sr_serial_dev_inst *serial_dev_new(GSList *options,
192 const char *def_serialcomm)
195 const char *conn, *serialcomm;
197 serial_conf_get(options, def_serialcomm, &conn, &serialcomm);
202 return sr_serial_dev_inst_new(conn, serialcomm);
205 static int serial_stream_check_buf(struct sr_serial_dev_inst *serial,
206 uint8_t *buf, size_t buflen,
208 packet_valid_callback is_valid,
209 uint64_t timeout_ms, int baudrate)
214 if ((ret = serial_open(serial, SERIAL_RDWR)) != SR_OK)
217 serial_flush(serial);
220 ret = serial_stream_detect(serial, buf, &len, packet_size,
221 is_valid, timeout_ms, baudrate);
223 serial_close(serial);
229 * If we dropped more than two packets worth of data, something is
230 * wrong. We shouldn't quit however, since the dropped bytes might be
231 * just zeroes at the beginning of the stream. Those can occur as a
232 * combination of the nonstandard cable that ships with some devices
233 * and the serial port or USB to serial adapter.
235 dropped = len - packet_size;
236 if (dropped > 2 * packet_size)
237 sr_warn("Had to drop too much data.");
242 static int serial_stream_check(struct sr_serial_dev_inst *serial,
244 packet_valid_callback is_valid,
245 uint64_t timeout_ms, int baudrate)
249 return serial_stream_check_buf(serial, buf, sizeof(buf), packet_size,
250 is_valid, timeout_ms, baudrate);
253 struct std_opt_desc {
254 const uint32_t *scanopts;
255 const int num_scanopts;
256 const uint32_t *devopts;
257 const int num_devopts;
260 static int std_config_list(uint32_t key, GVariant **data,
261 const struct std_opt_desc *d)
264 case SR_CONF_SCAN_OPTIONS:
265 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
266 d->scanopts, d->num_scanopts, sizeof(uint32_t));
268 case SR_CONF_DEVICE_OPTIONS:
269 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
270 d->devopts, d->num_devopts, sizeof(uint32_t));
279 static int send_config_update(struct sr_dev_inst *sdi, struct sr_config *cfg)
281 struct sr_datafeed_packet packet;
282 struct sr_datafeed_meta meta;
284 memset(&meta, 0, sizeof(meta));
286 packet.type = SR_DF_META;
287 packet.payload = &meta;
289 meta.config = g_slist_append(meta.config, cfg);
291 return sr_session_send(sdi, &packet);
294 static int send_config_update_key(struct sr_dev_inst *sdi, uint32_t key,
297 struct sr_config *cfg;
300 cfg = sr_config_new(key, var);
304 ret = send_config_update(sdi, cfg);
311 * Cyrustek ES51919 LCR chipset host protocol.
313 * Public official documentation does not contain the protocol
314 * description, so this is all based on reverse engineering.
316 * Packet structure (17 bytes):
318 * 0x00: header1 ?? (0x00)
319 * 0x01: header2 ?? (0x0d)
322 * bit 0 = hold enabled
323 * bit 1 = reference shown (in delta mode)
325 * bit 3 = calibration mode
326 * bit 4 = sorting mode
329 * bit 7 = parallel measurement (vs. serial)
332 * bit 0-4 = ??? (0x10)
333 * bit 5-7 = test frequency
341 * 0x04: tolerance (sorting mode)
352 * 0x05-0x09: primary measurement
353 * 0x05: measured quantity
358 * 0x06: measurement MSB (0x4e20 = 20000 = outside limits)
359 * 0x07: measurement LSB
360 * 0x08: measurement info
361 * bit 0-2 = decimal point multiplier (10^-val)
377 * 0x09: measurement status
379 * 0 = normal (measurement shown)
380 * 1 = blank (nothing shown)
382 * 3 = outside limits ("OL")
386 * 10 = shorted ("Srt")
387 * bit 4-6 = ??? (maybe part of same field with 0-3)
388 * bit 7 = ??? (some independent flag)
390 * 0x0a-0x0e: secondary measurement
391 * 0x0a: measured quantity
393 * 1 = dissipation factor
395 * 3 = parallel AC resistance / ESR
397 * 0x0b-0x0e: like primary measurement
399 * 0x0f: footer1 (0x0d) ?
400 * 0x10: footer2 (0x0a) ?
403 #define PACKET_SIZE 17
405 static const double frequencies[] = {
406 100, 120, 1000, 10000, 100000, 0,
409 enum { MODEL_NONE, MODEL_PAR, MODEL_SER, MODEL_AUTO, };
411 static const char *const models[] = {
412 "NONE", "PARALLEL", "SERIES", "AUTO",
415 /** Private, per-device-instance driver context. */
417 /** Opaque pointer passed in by the frontend. */
420 /** The number of frames. */
421 struct dev_limit_counter frame_count;
423 /** The time limit counter. */
424 struct dev_time_counter time_count;
427 struct dev_buffer *buf;
429 /** The frequency of the test signal (index to frequencies[]). */
432 /** Equivalent circuit model (index to models[]). */
436 static const uint8_t *pkt_to_buf(const uint8_t *pkt, int is_secondary)
438 return is_secondary ? pkt + 10 : pkt + 5;
441 static int parse_mq(const uint8_t *pkt, int is_secondary, int is_parallel)
445 buf = pkt_to_buf(pkt, is_secondary);
447 switch (is_secondary << 8 | buf[0]) {
450 SR_MQ_PARALLEL_INDUCTANCE : SR_MQ_SERIES_INDUCTANCE;
453 SR_MQ_PARALLEL_CAPACITANCE : SR_MQ_SERIES_CAPACITANCE;
457 SR_MQ_PARALLEL_RESISTANCE : SR_MQ_SERIES_RESISTANCE;
459 return SR_MQ_RESISTANCE;
461 return SR_MQ_DIFFERENCE;
463 return SR_MQ_DISSIPATION_FACTOR;
465 return SR_MQ_QUALITY_FACTOR;
467 return SR_MQ_PHASE_ANGLE;
470 sr_err("Unknown quantity 0x%03x.", is_secondary << 8 | buf[0]);
475 static float parse_value(const uint8_t *buf)
477 static const float decimals[] = {
478 1, 1e-1, 1e-2, 1e-3, 1e-4, 1e-5, 1e-6, 1e-7
482 val = (buf[1] << 8) | buf[2];
483 return (float)val * decimals[buf[3] & 7];
486 static void parse_measurement(const uint8_t *pkt, float *floatval,
487 struct sr_datafeed_analog *analog,
490 static const struct {
494 { SR_UNIT_UNITLESS, 1 }, /* no unit */
495 { SR_UNIT_OHM, 1 }, /* Ohm */
496 { SR_UNIT_OHM, 1e3 }, /* kOhm */
497 { SR_UNIT_OHM, 1e6 }, /* MOhm */
499 { SR_UNIT_HENRY, 1e-6 }, /* uH */
500 { SR_UNIT_HENRY, 1e-3 }, /* mH */
501 { SR_UNIT_HENRY, 1 }, /* H */
502 { SR_UNIT_HENRY, 1e3 }, /* kH */
503 { SR_UNIT_FARAD, 1e-12 }, /* pF */
504 { SR_UNIT_FARAD, 1e-9 }, /* nF */
505 { SR_UNIT_FARAD, 1e-6 }, /* uF */
506 { SR_UNIT_FARAD, 1e-3 }, /* mF */
507 { SR_UNIT_PERCENTAGE, 1 }, /* % */
508 { SR_UNIT_DEGREE, 1 } /* degree */
513 buf = pkt_to_buf(pkt, is_secondary);
518 state = buf[4] & 0xf;
520 if (state != 0 && state != 3)
524 /* Calibration and Sorting modes not supported. */
530 analog->mqflags |= SR_MQFLAG_HOLD;
532 analog->mqflags |= SR_MQFLAG_REFERENCE;
535 analog->mqflags |= SR_MQFLAG_RELATIVE;
538 if ((analog->mq = parse_mq(pkt, is_secondary, pkt[2] & 0x80)) < 0)
541 if ((buf[3] >> 3) >= ARRAY_SIZE(units)) {
542 sr_err("Unknown unit %u.", buf[3] >> 3);
547 analog->unit = units[buf[3] >> 3].unit;
549 *floatval = parse_value(buf);
550 *floatval *= (state == 0) ? units[buf[3] >> 3].mult : INFINITY;
553 static unsigned int parse_freq(const uint8_t *pkt)
559 if (freq >= ARRAY_SIZE(frequencies)) {
560 sr_err("Unknown frequency %u.", freq);
561 freq = ARRAY_SIZE(frequencies) - 1;
567 static unsigned int parse_model(const uint8_t *pkt)
571 else if (parse_mq(pkt, 0, 0) == SR_MQ_RESISTANCE)
573 else if (pkt[2] & 0x80)
579 static gboolean packet_valid(const uint8_t *pkt)
582 * If the first two bytes of the packet are indeed a constant
583 * header, they should be checked too. Since we don't know it
584 * for sure, we'll just check the last two for now since they
585 * seem to be constant just like in the other Cyrustek chipset
588 if (pkt[15] == 0xd && pkt[16] == 0xa)
594 static int do_config_update(struct sr_dev_inst *sdi, uint32_t key,
597 struct dev_context *devc;
601 return send_config_update_key(devc->cb_data, key, var);
604 static int send_freq_update(struct sr_dev_inst *sdi, unsigned int freq)
606 return do_config_update(sdi, SR_CONF_OUTPUT_FREQUENCY,
607 g_variant_new_double(frequencies[freq]));
610 static int send_model_update(struct sr_dev_inst *sdi, unsigned int model)
612 return do_config_update(sdi, SR_CONF_EQUIV_CIRCUIT_MODEL,
613 g_variant_new_string(models[model]));
616 static void handle_packet(struct sr_dev_inst *sdi, const uint8_t *pkt)
618 struct sr_datafeed_packet packet;
619 struct sr_datafeed_analog analog;
620 struct dev_context *devc;
627 val = parse_freq(pkt);
628 if (val != devc->freq) {
629 if (send_freq_update(sdi, val) == SR_OK)
635 val = parse_model(pkt);
636 if (val != devc->model) {
637 if (send_model_update(sdi, val) == SR_OK)
645 memset(&analog, 0, sizeof(analog));
647 analog.num_samples = 1;
648 analog.data = &floatval;
650 analog.channels = g_slist_append(NULL, sdi->channels->data);
652 parse_measurement(pkt, &floatval, &analog, 0);
653 if (analog.mq >= 0) {
655 packet.type = SR_DF_FRAME_BEGIN;
656 sr_session_send(devc->cb_data, &packet);
660 packet.type = SR_DF_ANALOG;
661 packet.payload = &analog;
663 sr_session_send(devc->cb_data, &packet);
666 g_slist_free(analog.channels);
667 analog.channels = g_slist_append(NULL, sdi->channels->next->data);
669 parse_measurement(pkt, &floatval, &analog, 1);
670 if (analog.mq >= 0) {
672 packet.type = SR_DF_FRAME_BEGIN;
673 sr_session_send(devc->cb_data, &packet);
677 packet.type = SR_DF_ANALOG;
678 packet.payload = &analog;
680 sr_session_send(devc->cb_data, &packet);
683 g_slist_free(analog.channels);
686 packet.type = SR_DF_FRAME_END;
687 sr_session_send(devc->cb_data, &packet);
688 dev_limit_counter_inc(&devc->frame_count);
692 static int handle_new_data(struct sr_dev_inst *sdi)
694 struct dev_context *devc;
700 ret = dev_buffer_fill_serial(devc->buf, sdi);
704 while ((pkt = dev_buffer_packet_find(devc->buf, packet_valid,
706 handle_packet(sdi, pkt);
711 static int receive_data(int fd, int revents, void *cb_data)
713 struct sr_dev_inst *sdi;
714 struct dev_context *devc;
718 if (!(sdi = cb_data))
721 if (!(devc = sdi->priv))
724 if (revents == G_IO_IN) {
725 /* Serial data arrived. */
726 handle_new_data(sdi);
729 if (dev_limit_counter_limit_reached(&devc->frame_count) ||
730 dev_time_limit_reached(&devc->time_count))
731 sdi->driver->dev_acquisition_stop(sdi, cb_data);
736 static const char *const channel_names[] = { "P1", "P2" };
738 static int setup_channels(struct sr_dev_inst *sdi)
745 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
746 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
751 SR_PRIV void es51919_serial_clean(void *priv)
753 struct dev_context *devc;
758 dev_buffer_destroy(devc->buf);
762 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
766 struct sr_serial_dev_inst *serial;
767 struct sr_dev_inst *sdi;
768 struct dev_context *devc;
775 if (!(serial = serial_dev_new(options, "9600/8n1/rts=1/dtr=1")))
778 ret = serial_stream_check(serial, PACKET_SIZE, packet_valid,
783 sr_info("Found device on port %s.", serial->port);
785 sdi = g_malloc0(sizeof(struct sr_dev_inst));
786 sdi->status = SR_ST_INACTIVE;
787 sdi->vendor = g_strdup(vendor);
788 sdi->model = g_strdup(model);
789 devc = g_malloc0(sizeof(struct dev_context));
790 devc->buf = dev_buffer_new(PACKET_SIZE * 8);
791 sdi->inst_type = SR_INST_SERIAL;
795 if (setup_channels(sdi) != SR_OK)
801 es51919_serial_clean(devc);
803 sr_dev_inst_free(sdi);
805 sr_serial_dev_inst_free(serial);
810 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
811 const struct sr_dev_inst *sdi,
812 const struct sr_channel_group *cg)
814 struct dev_context *devc;
818 if (!(devc = sdi->priv))
822 case SR_CONF_OUTPUT_FREQUENCY:
823 *data = g_variant_new_double(frequencies[devc->freq]);
825 case SR_CONF_EQUIV_CIRCUIT_MODEL:
826 *data = g_variant_new_string(models[devc->model]);
829 sr_spew("%s: Unsupported key %u", __func__, key);
836 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
837 const struct sr_dev_inst *sdi,
838 const struct sr_channel_group *cg)
840 struct dev_context *devc;
845 if (!(devc = sdi->priv))
849 case SR_CONF_LIMIT_MSEC:
850 val = g_variant_get_uint64(data);
851 dev_time_limit_set(&devc->time_count, val);
852 sr_dbg("Setting time limit to %" PRIu64 ".", val);
854 case SR_CONF_LIMIT_FRAMES:
855 val = g_variant_get_uint64(data);
856 dev_limit_counter_limit_set(&devc->frame_count, val);
857 sr_dbg("Setting frame limit to %" PRIu64 ".", val);
860 sr_spew("%s: Unsupported key %u", __func__, key);
867 static const uint32_t scanopts[] = {
872 static const uint32_t devopts[] = {
875 SR_CONF_LIMIT_FRAMES | SR_CONF_SET,
876 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
877 SR_CONF_OUTPUT_FREQUENCY | SR_CONF_GET | SR_CONF_LIST,
878 SR_CONF_EQUIV_CIRCUIT_MODEL | SR_CONF_GET | SR_CONF_LIST,
881 static const struct std_opt_desc opts = {
882 scanopts, ARRAY_SIZE(scanopts),
883 devopts, ARRAY_SIZE(devopts),
886 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
887 const struct sr_dev_inst *sdi,
888 const struct sr_channel_group *cg)
893 if (std_config_list(key, data, &opts) == SR_OK)
897 case SR_CONF_OUTPUT_FREQUENCY:
898 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_DOUBLE,
899 frequencies, ARRAY_SIZE(frequencies), sizeof(double));
901 case SR_CONF_EQUIV_CIRCUIT_MODEL:
902 *data = g_variant_new_strv(models, ARRAY_SIZE(models));
905 sr_spew("%s: Unsupported key %u", __func__, key);
912 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
915 struct dev_context *devc;
916 struct sr_serial_dev_inst *serial;
918 if (sdi->status != SR_ST_ACTIVE)
919 return SR_ERR_DEV_CLOSED;
921 if (!(devc = sdi->priv))
924 devc->cb_data = cb_data;
926 dev_limit_counter_start(&devc->frame_count);
927 dev_time_counter_start(&devc->time_count);
929 /* Send header packet to the session bus. */
930 std_session_send_df_header(cb_data, LOG_PREFIX);
932 /* Poll every 50ms, or whenever some data comes in. */
934 serial_source_add(sdi->session, serial, G_IO_IN, 50,
935 receive_data, (void *)sdi);
940 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
943 return std_serial_dev_acquisition_stop(sdi, cb_data,
944 std_serial_dev_close, sdi->conn, LOG_PREFIX);