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 struct std_opt_desc {
255 const uint32_t *scanopts;
256 const int num_scanopts;
257 const uint32_t *devopts;
258 const int num_devopts;
261 static int std_config_list(uint32_t key, GVariant **data,
262 const struct std_opt_desc *d)
265 case SR_CONF_SCAN_OPTIONS:
266 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
267 d->scanopts, d->num_scanopts, sizeof(uint32_t));
269 case SR_CONF_DEVICE_OPTIONS:
270 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
271 d->devopts, d->num_devopts, sizeof(uint32_t));
280 static int send_config_update(struct sr_dev_inst *sdi, struct sr_config *cfg)
282 struct sr_datafeed_packet packet;
283 struct sr_datafeed_meta meta;
285 memset(&meta, 0, sizeof(meta));
287 packet.type = SR_DF_META;
288 packet.payload = &meta;
290 meta.config = g_slist_append(meta.config, cfg);
292 return sr_session_send(sdi, &packet);
295 static int send_config_update_key(struct sr_dev_inst *sdi, uint32_t key,
298 struct sr_config *cfg;
301 cfg = sr_config_new(key, var);
305 ret = send_config_update(sdi, cfg);
312 * Cyrustek ES51919 LCR chipset host protocol.
314 * Public official documentation does not contain the protocol
315 * description, so this is all based on reverse engineering.
317 * Packet structure (17 bytes):
319 * 0x00: header1 ?? (0x00)
320 * 0x01: header2 ?? (0x0d)
323 * bit 0 = hold enabled
324 * bit 1 = reference shown (in delta mode)
326 * bit 3 = calibration mode
327 * bit 4 = sorting mode
330 * bit 7 = parallel measurement (vs. serial)
333 * bit 0-4 = ??? (0x10)
334 * bit 5-7 = test frequency
342 * 0x04: tolerance (sorting mode)
353 * 0x05-0x09: primary measurement
354 * 0x05: measured quantity
359 * 0x06: measurement MSB (0x4e20 = 20000 = outside limits)
360 * 0x07: measurement LSB
361 * 0x08: measurement info
362 * bit 0-2 = decimal point multiplier (10^-val)
378 * 0x09: measurement status
380 * 0 = normal (measurement shown)
381 * 1 = blank (nothing shown)
383 * 3 = outside limits ("OL")
387 * 10 = shorted ("Srt")
388 * bit 4-6 = ??? (maybe part of same field with 0-3)
389 * bit 7 = ??? (some independent flag)
391 * 0x0a-0x0e: secondary measurement
392 * 0x0a: measured quantity
394 * 1 = dissipation factor
396 * 3 = parallel AC resistance / ESR
398 * 0x0b-0x0e: like primary measurement
400 * 0x0f: footer1 (0x0d) ?
401 * 0x10: footer2 (0x0a) ?
404 #define PACKET_SIZE 17
406 static const double frequencies[] = {
407 100, 120, 1000, 10000, 100000, 0,
410 enum { MODEL_NONE, MODEL_PAR, MODEL_SER, MODEL_AUTO, };
412 static const char *const models[] = {
413 "NONE", "PARALLEL", "SERIES", "AUTO",
416 /** Private, per-device-instance driver context. */
418 /** Opaque pointer passed in by the frontend. */
421 /** The number of frames. */
422 struct dev_limit_counter frame_count;
424 /** The time limit counter. */
425 struct dev_time_counter time_count;
428 struct dev_buffer *buf;
430 /** The frequency of the test signal (index to frequencies[]). */
433 /** Equivalent circuit model (index to models[]). */
437 static const uint8_t *pkt_to_buf(const uint8_t *pkt, int is_secondary)
439 return is_secondary ? pkt + 10 : pkt + 5;
442 static int parse_mq(const uint8_t *pkt, int is_secondary, int is_parallel)
446 buf = pkt_to_buf(pkt, is_secondary);
448 switch (is_secondary << 8 | buf[0]) {
451 SR_MQ_PARALLEL_INDUCTANCE : SR_MQ_SERIES_INDUCTANCE;
454 SR_MQ_PARALLEL_CAPACITANCE : SR_MQ_SERIES_CAPACITANCE;
458 SR_MQ_PARALLEL_RESISTANCE : SR_MQ_SERIES_RESISTANCE;
460 return SR_MQ_RESISTANCE;
462 return SR_MQ_DIFFERENCE;
464 return SR_MQ_DISSIPATION_FACTOR;
466 return SR_MQ_QUALITY_FACTOR;
468 return SR_MQ_PHASE_ANGLE;
471 sr_err("Unknown quantity 0x%03x.", is_secondary << 8 | buf[0]);
476 static float parse_value(const uint8_t *buf)
478 static const float decimals[] = {
479 1, 1e-1, 1e-2, 1e-3, 1e-4, 1e-5, 1e-6, 1e-7
483 val = (buf[1] << 8) | buf[2];
484 return (float)val * decimals[buf[3] & 7];
487 static void parse_measurement(const uint8_t *pkt, float *floatval,
488 struct sr_datafeed_analog_old *analog,
491 static const struct {
495 { SR_UNIT_UNITLESS, 1 }, /* no unit */
496 { SR_UNIT_OHM, 1 }, /* Ohm */
497 { SR_UNIT_OHM, 1e3 }, /* kOhm */
498 { SR_UNIT_OHM, 1e6 }, /* MOhm */
500 { SR_UNIT_HENRY, 1e-6 }, /* uH */
501 { SR_UNIT_HENRY, 1e-3 }, /* mH */
502 { SR_UNIT_HENRY, 1 }, /* H */
503 { SR_UNIT_HENRY, 1e3 }, /* kH */
504 { SR_UNIT_FARAD, 1e-12 }, /* pF */
505 { SR_UNIT_FARAD, 1e-9 }, /* nF */
506 { SR_UNIT_FARAD, 1e-6 }, /* uF */
507 { SR_UNIT_FARAD, 1e-3 }, /* mF */
508 { SR_UNIT_PERCENTAGE, 1 }, /* % */
509 { SR_UNIT_DEGREE, 1 } /* degree */
514 buf = pkt_to_buf(pkt, is_secondary);
519 state = buf[4] & 0xf;
521 if (state != 0 && state != 3)
525 /* Calibration and Sorting modes not supported. */
531 analog->mqflags |= SR_MQFLAG_HOLD;
533 analog->mqflags |= SR_MQFLAG_REFERENCE;
536 analog->mqflags |= SR_MQFLAG_RELATIVE;
539 if ((analog->mq = parse_mq(pkt, is_secondary, pkt[2] & 0x80)) < 0)
542 if ((buf[3] >> 3) >= ARRAY_SIZE(units)) {
543 sr_err("Unknown unit %u.", buf[3] >> 3);
548 analog->unit = units[buf[3] >> 3].unit;
550 *floatval = parse_value(buf);
551 *floatval *= (state == 0) ? units[buf[3] >> 3].mult : INFINITY;
554 static unsigned int parse_freq(const uint8_t *pkt)
560 if (freq >= ARRAY_SIZE(frequencies)) {
561 sr_err("Unknown frequency %u.", freq);
562 freq = ARRAY_SIZE(frequencies) - 1;
568 static unsigned int parse_model(const uint8_t *pkt)
572 else if (parse_mq(pkt, 0, 0) == SR_MQ_RESISTANCE)
574 else if (pkt[2] & 0x80)
580 static gboolean packet_valid(const uint8_t *pkt)
583 * If the first two bytes of the packet are indeed a constant
584 * header, they should be checked too. Since we don't know it
585 * for sure, we'll just check the last two for now since they
586 * seem to be constant just like in the other Cyrustek chipset
589 if (pkt[15] == 0xd && pkt[16] == 0xa)
595 static int do_config_update(struct sr_dev_inst *sdi, uint32_t key,
598 struct dev_context *devc;
602 return send_config_update_key(devc->cb_data, key, var);
605 static int send_freq_update(struct sr_dev_inst *sdi, unsigned int freq)
607 return do_config_update(sdi, SR_CONF_OUTPUT_FREQUENCY,
608 g_variant_new_double(frequencies[freq]));
611 static int send_model_update(struct sr_dev_inst *sdi, unsigned int model)
613 return do_config_update(sdi, SR_CONF_EQUIV_CIRCUIT_MODEL,
614 g_variant_new_string(models[model]));
617 static void handle_packet(struct sr_dev_inst *sdi, const uint8_t *pkt)
619 struct sr_datafeed_packet packet;
620 struct sr_datafeed_analog_old analog;
621 struct dev_context *devc;
628 val = parse_freq(pkt);
629 if (val != devc->freq) {
630 if (send_freq_update(sdi, val) == SR_OK)
636 val = parse_model(pkt);
637 if (val != devc->model) {
638 if (send_model_update(sdi, val) == SR_OK)
646 memset(&analog, 0, sizeof(analog));
648 analog.num_samples = 1;
649 analog.data = &floatval;
651 analog.channels = g_slist_append(NULL, sdi->channels->data);
653 parse_measurement(pkt, &floatval, &analog, 0);
654 if (analog.mq >= 0) {
656 packet.type = SR_DF_FRAME_BEGIN;
657 sr_session_send(devc->cb_data, &packet);
661 packet.type = SR_DF_ANALOG_OLD;
662 packet.payload = &analog;
664 sr_session_send(devc->cb_data, &packet);
667 g_slist_free(analog.channels);
668 analog.channels = g_slist_append(NULL, sdi->channels->next->data);
670 parse_measurement(pkt, &floatval, &analog, 1);
671 if (analog.mq >= 0) {
673 packet.type = SR_DF_FRAME_BEGIN;
674 sr_session_send(devc->cb_data, &packet);
678 packet.type = SR_DF_ANALOG_OLD;
679 packet.payload = &analog;
681 sr_session_send(devc->cb_data, &packet);
684 g_slist_free(analog.channels);
687 packet.type = SR_DF_FRAME_END;
688 sr_session_send(devc->cb_data, &packet);
689 dev_limit_counter_inc(&devc->frame_count);
693 static int handle_new_data(struct sr_dev_inst *sdi)
695 struct dev_context *devc;
701 ret = dev_buffer_fill_serial(devc->buf, sdi);
705 while ((pkt = dev_buffer_packet_find(devc->buf, packet_valid,
707 handle_packet(sdi, pkt);
712 static int receive_data(int fd, int revents, void *cb_data)
714 struct sr_dev_inst *sdi;
715 struct dev_context *devc;
719 if (!(sdi = cb_data))
722 if (!(devc = sdi->priv))
725 if (revents == G_IO_IN) {
726 /* Serial data arrived. */
727 handle_new_data(sdi);
730 if (dev_limit_counter_limit_reached(&devc->frame_count) ||
731 dev_time_limit_reached(&devc->time_count))
732 sdi->driver->dev_acquisition_stop(sdi, cb_data);
737 static const char *const channel_names[] = { "P1", "P2" };
739 static int setup_channels(struct sr_dev_inst *sdi)
746 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
747 sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
752 SR_PRIV void es51919_serial_clean(void *priv)
754 struct dev_context *devc;
759 dev_buffer_destroy(devc->buf);
763 SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options,
767 struct sr_serial_dev_inst *serial;
768 struct sr_dev_inst *sdi;
769 struct dev_context *devc;
776 if (!(serial = serial_dev_new(options, "9600/8n1/rts=1/dtr=1")))
779 ret = serial_stream_check(serial, PACKET_SIZE, packet_valid,
784 sr_info("Found device on port %s.", serial->port);
786 sdi = g_malloc0(sizeof(struct sr_dev_inst));
787 sdi->status = SR_ST_INACTIVE;
788 sdi->vendor = g_strdup(vendor);
789 sdi->model = g_strdup(model);
790 devc = g_malloc0(sizeof(struct dev_context));
791 devc->buf = dev_buffer_new(PACKET_SIZE * 8);
792 sdi->inst_type = SR_INST_SERIAL;
796 if (setup_channels(sdi) != SR_OK)
802 es51919_serial_clean(devc);
804 sr_dev_inst_free(sdi);
806 sr_serial_dev_inst_free(serial);
811 SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data,
812 const struct sr_dev_inst *sdi,
813 const struct sr_channel_group *cg)
815 struct dev_context *devc;
819 if (!(devc = sdi->priv))
823 case SR_CONF_OUTPUT_FREQUENCY:
824 *data = g_variant_new_double(frequencies[devc->freq]);
826 case SR_CONF_EQUIV_CIRCUIT_MODEL:
827 *data = g_variant_new_string(models[devc->model]);
830 sr_spew("%s: Unsupported key %u", __func__, key);
837 SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data,
838 const struct sr_dev_inst *sdi,
839 const struct sr_channel_group *cg)
841 struct dev_context *devc;
846 if (!(devc = sdi->priv))
850 case SR_CONF_LIMIT_MSEC:
851 val = g_variant_get_uint64(data);
852 dev_time_limit_set(&devc->time_count, val);
853 sr_dbg("Setting time limit to %" PRIu64 ".", val);
855 case SR_CONF_LIMIT_FRAMES:
856 val = g_variant_get_uint64(data);
857 dev_limit_counter_limit_set(&devc->frame_count, val);
858 sr_dbg("Setting frame limit to %" PRIu64 ".", val);
861 sr_spew("%s: Unsupported key %u", __func__, key);
868 static const uint32_t scanopts[] = {
873 static const uint32_t devopts[] = {
876 SR_CONF_LIMIT_FRAMES | SR_CONF_SET,
877 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
878 SR_CONF_OUTPUT_FREQUENCY | SR_CONF_GET | SR_CONF_LIST,
879 SR_CONF_EQUIV_CIRCUIT_MODEL | SR_CONF_GET | SR_CONF_LIST,
882 static const struct std_opt_desc opts = {
883 scanopts, ARRAY_SIZE(scanopts),
884 devopts, ARRAY_SIZE(devopts),
887 SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data,
888 const struct sr_dev_inst *sdi,
889 const struct sr_channel_group *cg)
894 if (std_config_list(key, data, &opts) == SR_OK)
898 case SR_CONF_OUTPUT_FREQUENCY:
899 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_DOUBLE,
900 frequencies, ARRAY_SIZE(frequencies), sizeof(double));
902 case SR_CONF_EQUIV_CIRCUIT_MODEL:
903 *data = g_variant_new_strv(models, ARRAY_SIZE(models));
906 sr_spew("%s: Unsupported key %u", __func__, key);
913 SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi,
916 struct dev_context *devc;
917 struct sr_serial_dev_inst *serial;
919 if (sdi->status != SR_ST_ACTIVE)
920 return SR_ERR_DEV_CLOSED;
922 if (!(devc = sdi->priv))
925 devc->cb_data = cb_data;
927 dev_limit_counter_start(&devc->frame_count);
928 dev_time_counter_start(&devc->time_count);
930 /* Send header packet to the session bus. */
931 std_session_send_df_header(cb_data, LOG_PREFIX);
933 /* Poll every 50ms, or whenever some data comes in. */
935 serial_source_add(sdi->session, serial, G_IO_IN, 50,
936 receive_data, (void *)sdi);
941 SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi,
944 return std_serial_dev_acquisition_stop(sdi, cb_data,
945 std_serial_dev_close, sdi->conn, LOG_PREFIX);