2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
5 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com> (code from atten-pps3xxx)
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 * <em>Motech LPS-30x series</em> power supply driver
32 /* Forward declarations */
33 SR_PRIV struct sr_dev_driver motech_lps_301_driver_info;
34 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen);
35 SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char *fmt, va_list args);
36 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char *fmt, ...);
37 SR_PRIV int lps_cmd_reply(char *reply, struct sr_serial_dev_inst *serial, const char *fmt, ...);
38 SR_PRIV int lps_query_status(struct sr_dev_inst *sdi);
40 /* Serial communication parameters */
41 #define SERIALCOMM "2400/8n1/dtr=1/rts=1/flow=0"
43 #define VENDOR_MOTECH "Motech"
45 /** Driver capabilities generic. */
46 static const uint32_t drvopts[] = {
51 /** Driver scanning options. */
52 static const uint32_t scanopts[] = {
57 /** Hardware capabilities generic. */
58 static const uint32_t devopts[] = {
61 /* Acquisition modes. */
63 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
64 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
65 /* Device configuration */
66 SR_CONF_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
69 /** Hardware capabilities channel 1, 2. */
70 static const uint32_t devopts_ch12[] = {
71 SR_CONF_VOLTAGE | SR_CONF_GET,
72 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
73 SR_CONF_CURRENT | SR_CONF_GET,
74 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
75 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
78 /** Hardware capabilities channel 3. (LPS-304/305 only). */
79 static const uint32_t devopts_ch3[] = {
80 SR_CONF_VOLTAGE | SR_CONF_GET,
81 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
84 static const char *channel_modes[] = {
90 static const struct lps_modelspec models[] = {
91 { LPS_UNKNOWN, "Dummy", 0,
96 { LPS_301, "LPS-301", 1,
99 { { 0, 32, 0.01 }, { 0.005, 2, 0.001 } },
102 { LPS_302, "LPS-302", 1,
105 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
108 { LPS_303, "LPS-303", 1,
111 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
114 { LPS_304, "LPS-304", 3,
117 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
119 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
121 { { 5, 5, 0.0 }, { 0.005, 3, 0.001 } },
124 { LPS_305, "LPS-305", 3,
127 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
129 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
131 { { 3.3, 5, 1.7 }, { 0.005, 3, 0.001 } },
136 /** Send command to device with va_list.
138 SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char *fmt, va_list args)
141 char auxfmt[LINELEN_MAX];
142 char buf[LINELEN_MAX];
144 snprintf(auxfmt, sizeof(auxfmt), "%s\r\n", fmt);
145 vsnprintf(buf, sizeof(buf), auxfmt, args);
147 sr_spew("lps_send_va: \"%s\"", buf);
149 retc = serial_write_blocking(serial, buf, strlen(buf),
150 serial_timeout(serial, strlen(buf)));
158 /** Send command to device.
160 SR_PRIV int lps_send_req(struct sr_serial_dev_inst *serial, const char *fmt, ...)
166 retc = lps_send_va(serial, fmt, args);
172 /** Send command and consume simple OK reply. */
173 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char *fmt, ...)
177 char buf[LINELEN_MAX];
183 retc = lps_send_va(serial, fmt, args);
192 buflen = sizeof(buf);
193 retc = lps_read_reply(serial, &bufptr, &buflen);
194 if ((retc == SR_OK) && (buflen == 0))
200 /** Send command and read reply string.
201 * @param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated.
203 SR_PRIV int lps_cmd_reply(char *reply, struct sr_serial_dev_inst *serial, const char *fmt, ...)
207 char buf[LINELEN_MAX];
215 retc = lps_send_va(serial, fmt, args);
224 buflen = sizeof(buf);
225 retc = lps_read_reply(serial, &bufptr, &buflen);
226 if ((retc == SR_OK) && (buflen > 0)) {
234 /** Process integer value returned by STATUS command. */
235 SR_PRIV int lps_process_status(struct sr_dev_inst *sdi, int stat)
237 struct dev_context *devc;
242 sr_spew("Status: %d", stat);
243 devc->channel_status[0].cc_mode = (stat & 0x01) != 0;
244 sr_spew("Channel 1 %s mode", devc->channel_status[0].cc_mode?"CC":"CV");
245 if (devc->model->num_channels > 1) {
246 devc->channel_status[1].cc_mode = (stat & 0x02) != 0;
247 sr_spew("Channel 2 %s mode", devc->channel_status[1].cc_mode?"CC":"CV");
249 tracking_mode = (stat & 0x0c) >> 2;
250 switch (tracking_mode) {
251 case 0: devc->tracking_mode = 0;
253 case 2: devc->tracking_mode = 1;
255 case 3: devc->tracking_mode = 2;
258 sr_err("Illegal channel tracking mode %d!", tracking_mode);
259 devc->tracking_mode = 0;
263 sr_spew("Channel tracking: %d", devc->tracking_mode);
265 devc->channel_status[0].output_enabled = devc->channel_status[1].output_enabled = stat&0x040?TRUE:FALSE;
266 sr_spew("Channel 1%s output: %s", devc->model->num_channels > 1?"+2":"", devc->channel_status[0].output_enabled?"ON":"OFF");
267 if (devc->model->num_channels > 2) {
268 devc->channel_status[2].output_enabled = stat&0x010?TRUE:FALSE;
269 devc->channel_status[2].output_voltage_last = stat&0x020?3.3:5;
270 sr_spew("Channel 3 output: %s, U=%02f V, overload=%d",
271 devc->channel_status[2].output_enabled?"ON":"OFF",
272 devc->channel_status[2].output_voltage_last,
275 sr_spew("Fan=%d, beep=%d, CC output compensated=%d", stat&0x0100?1:0, stat&0x0200?1:0, stat&0x0400?1:0);
280 /** Send STATUS commend and process status string. */
281 SR_PRIV int lps_query_status(struct sr_dev_inst *sdi)
283 char buf[LINELEN_MAX];
285 struct dev_context *devc;
289 devc->req_sent_at = g_get_real_time();
291 if ((ret = lps_cmd_reply(buf, sdi->conn, "STATUS")) < 0) {
292 sr_err("%s: Failed to read status: %s.", __func__,
297 if (sr_atoi(buf, &stat) != SR_OK)
300 return lps_process_status(sdi, stat);
303 static gint64 calc_timeout_ms(gint64 start_us)
305 gint64 result = REQ_TIMEOUT_MS - ((g_get_real_time() - start_us) / 1000);
313 /** Read message into buf until "OK" received.
314 * @retval SR_OK Msg received; buf and buflen contain result, if any except OK.
315 * @retval SR_ERR Error, including timeout.
317 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen)
320 char buf2[LINELEN_MAX];
323 gint64 timeout_start;
327 /* Read one line. It is either a data message or "OK". */
328 timeout_start = g_get_real_time();
330 /* Up to 5 tries because serial_readline() will consume only one CR or LF per
331 * call, but device sends up to 4 in a row. */
332 for (retries = 0; retries < 5; retries++) {
334 if (serial_readline(serial, buf, buflen, calc_timeout_ms(timeout_start)) != SR_OK)
336 if (!strcmp(*buf, "OK")) { /* We got an OK! */
341 if (*buflen > 0) /* We got a msg! */
345 /* A data msg is in buf (possibly ERROR), need to consume "OK". */
348 for (retries = 0; retries < 5; retries++) {
349 buf2len = sizeof(buf2);
350 if (serial_readline(serial, &buf2ptr, &buf2len, calc_timeout_ms(timeout_start)) != SR_OK)
353 if (!strcmp(buf2ptr, "OK")) { /* We got an OK! */
354 if (!strcmp(*buf, "ERROR")) { /* OK came after msg ERROR! */
355 sr_spew("ERROR found!");
364 return SR_ERR; /* Timeout! */
367 /** Scan for LPS-300 series device.
369 static GSList *do_scan(lps_modelid modelid, struct sr_dev_driver *drv, GSList *options)
371 struct sr_dev_inst *sdi;
372 struct drv_context *drvc;
373 struct dev_context *devc;
374 struct sr_serial_dev_inst *serial;
375 struct sr_channel *ch;
376 struct sr_channel_group *cg;
378 const char *conn, *serialcomm;
380 gchar buf[LINELEN_MAX];
386 conn = serialcomm = NULL;
390 drvc->instances = NULL;
392 sr_spew("scan() called!");
394 /* Process and check options. */
395 if (sr_serial_extract_options(options, &conn, &serialcomm) != SR_OK)
398 serialcomm = SERIALCOMM;
400 /* Init serial port. */
401 serial = sr_serial_dev_inst_new(conn, serialcomm);
403 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
406 /* Query and verify model string. */
407 serial_flush(serial);
408 if (lps_cmd_reply(buf, serial, "MODEL") != SR_OK)
411 /* Check model string. */
412 if (strncmp(buf, "LPS-", 4)) {
413 sr_spew("Unknown model code \"%s\"!", buf);
417 /* Bug in device FW 1.17, model number is empty, so this can't work with this FW! */
418 if (modelid == LPS_UNKNOWN) {
420 for (cnt = LPS_301; cnt <= LPS_305; cnt++) {
421 if (!strcmp(buf, models[cnt].modelstr)) {
426 if (modelid == LPS_UNKNOWN) {
427 sr_err("Unable to detect model from model string '%s'!", buf);
434 if ((ret = lps_cmd_reply(buf, serial, "VERSION")) == SR_OK) {
435 if (strncmp(buf, "Ver-", 4)) {
436 sr_spew("Version string %s not recognized.", buf);
443 else /* Bug in device FW 1.17: Querying version string fails while output is active.
444 Therefore just print an error message, but do not exit with error. */
445 sr_err("Failed to query for hardware version: %s.",
448 sdi = g_malloc0(sizeof(struct sr_dev_inst));
449 sdi->status = SR_ST_INACTIVE;
450 sdi->vendor = g_strdup(VENDOR_MOTECH);
451 sdi->model = g_strdup(models[modelid].modelstr);
452 sdi->version = g_strdup(verstr);
454 sdi->inst_type = SR_INST_SERIAL;
457 devc = g_malloc0(sizeof(struct dev_context));
458 sr_sw_limits_init(&devc->limits);
459 devc->model = &models[modelid];
463 /* Setup channels and channel groups. */
464 for (cnt = 0; cnt < models[modelid].num_channels; cnt++) {
465 snprintf(channel, sizeof(channel), "CH%d", cnt + 1);
466 ch = sr_channel_new(sdi, cnt, SR_CHANNEL_ANALOG, TRUE, channel);
468 devc->channel_status[cnt].info = g_slist_append(NULL, ch);
470 cg = g_malloc(sizeof(struct sr_channel_group));
471 snprintf(channel, sizeof(channel), "CG%d", cnt+1);
472 cg->name = g_strdup(channel);
474 cg->channels = g_slist_append(NULL, ch);
476 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
479 drvc->instances = g_slist_append(drvc->instances, sdi);
480 devices = g_slist_append(devices, sdi);
483 if (lps_query_status(sdi) != SR_OK)
486 serial_close(serial);
488 sr_serial_dev_inst_free(serial);
493 sr_info("%s: Error!", __func__);
496 serial_close(serial);
497 sr_serial_dev_inst_free(serial);
501 sr_dev_inst_free(sdi);
506 /** Scan for LPS-301 device. */
507 static GSList *scan_lps301(struct sr_dev_driver *di, GSList *options)
509 return do_scan(LPS_301, di, options);
512 static void dev_clear_private(struct dev_context *devc)
516 /* Free channel_status.info (list only, data owned by sdi). */
517 for (ch_idx = 0; ch_idx < devc->model->num_channels; ch_idx++)
518 g_slist_free(devc->channel_status[ch_idx].info);
521 static int dev_clear_lps301(const struct sr_dev_driver *di)
523 return std_dev_clear(di, (std_dev_clear_callback)dev_clear_private);
526 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
527 const struct sr_channel_group *cg)
529 struct dev_context *devc;
530 struct sr_channel *ch;
539 /* No channel group: global options. */
541 case SR_CONF_LIMIT_SAMPLES:
542 case SR_CONF_LIMIT_MSEC:
543 return sr_sw_limits_config_get(&devc->limits, key, data);
544 case SR_CONF_CHANNEL_CONFIG:
545 *data = g_variant_new_string(channel_modes[devc->tracking_mode]);
551 /* We only ever have one channel per channel group in this driver. */
552 ch = cg->channels->data;
555 case SR_CONF_VOLTAGE:
556 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_last);
558 case SR_CONF_VOLTAGE_TARGET:
559 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_max);
561 case SR_CONF_CURRENT:
562 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_last);
564 case SR_CONF_CURRENT_LIMIT:
565 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_max);
567 case SR_CONF_ENABLED:
568 *data = g_variant_new_boolean(devc->channel_status[ch_idx].output_enabled);
578 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
579 const struct sr_channel_group *cg)
581 struct dev_context *devc;
582 struct sr_channel *ch;
590 if (sdi->status != SR_ST_ACTIVE)
591 return SR_ERR_DEV_CLOSED;
595 /* Cannot change settings while acquisition active, would cause a mess with commands.
596 * Changing this would be possible, but tricky. */
597 if (devc->acq_running)
601 /* No channel group: global options. */
603 case SR_CONF_LIMIT_MSEC:
604 case SR_CONF_LIMIT_SAMPLES:
605 return sr_sw_limits_config_set(&devc->limits, key, data);
606 case SR_CONF_CHANNEL_CONFIG:
607 sval = g_variant_get_string(data, NULL);
609 for (idx = 0; idx < (int)ARRAY_SIZE(channel_modes); idx++) {
610 if (!strcmp(sval, channel_modes[idx])) {
612 if (devc->tracking_mode == idx)
613 break; /* Nothing to do! */
614 devc->tracking_mode = idx;
615 if (devc->model->modelid >= LPS_304) /* No use to set anything in the smaller models. */
616 return lps_cmd_ok(sdi->conn, "TRACK%1d", devc->tracking_mode);
618 if (devc->model->modelid <= LPS_303) /* Only first setting possible for smaller models. */
628 /* Channel group specified: per-channel options. */
629 /* We only ever have one channel per channel group in this driver. */
630 ch = cg->channels->data;
634 case SR_CONF_VOLTAGE_TARGET:
635 dval = g_variant_get_double(data);
636 if (dval < 0 || dval > devc->model->channels[ch_idx].voltage[1])
639 if (devc->model->modelid < LPS_304)
642 if (fabs(dval - 5.000) <= 0.001)
644 else if ((devc->model->modelid >= LPS_305) && (fabs(dval - 3.300) <= 0.001))
646 else return SR_ERR_ARG;
649 devc->channel_status[ch_idx].output_voltage_max = dval;
651 return lps_cmd_ok(sdi->conn, "VDD%1.0f", trunc(dval));
653 return lps_cmd_ok(sdi->conn, "VSET%d %05.3f", ch_idx+1, dval);
655 case SR_CONF_CURRENT_LIMIT:
656 dval = g_variant_get_double(data);
657 if (dval < 0 || dval > devc->model->channels[ch_idx].current[1])
659 if (ch_idx == 2) /* No current setting for CH3. */
661 devc->channel_status[ch_idx].output_current_max = dval;
662 return lps_cmd_ok(sdi->conn, "ISET%d %05.4f", ch_idx+1, dval);
664 case SR_CONF_ENABLED:
665 bval = g_variant_get_boolean(data);
666 if (bval == devc->channel_status[ch_idx].output_enabled) /* Nothing to do. */
668 devc->channel_status[ch_idx].output_enabled = bval;
669 if (ch_idx != 2) { /* Channels 1,2 can be set only together. */
670 devc->channel_status[ch_idx^1].output_enabled = bval;
671 return lps_cmd_ok(sdi->conn, "OUT%1d", (int)bval);
672 } else { /* Channel 3: No command to disable output, set voltage to 0 instead. */
674 return lps_cmd_ok(sdi->conn, "VDD%1.0f", devc->channel_status[ch_idx].output_voltage_max);
676 return lps_cmd_ok(sdi->conn, "VDD0");
687 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
688 const struct sr_channel_group *cg)
690 struct dev_context *devc;
691 struct sr_channel *ch;
696 /* Driver options, no device instance necessary. */
698 case SR_CONF_SCAN_OPTIONS:
699 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
700 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
702 case SR_CONF_DEVICE_OPTIONS:
705 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
706 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
715 /* Device options, independent from channel groups. */
718 case SR_CONF_DEVICE_OPTIONS:
719 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
720 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
722 case SR_CONF_CHANNEL_CONFIG:
723 if (devc->model->modelid <= LPS_303) {
724 /* The 1-channel models. */
725 *data = g_variant_new_strv(channel_modes, 1);
727 /* The other models support all modes. */
728 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
736 /* Device options, depending on channel groups. */
737 ch = cg->channels->data;
740 case SR_CONF_DEVICE_OPTIONS:
741 if ((ch_idx == 0) || (ch_idx == 1)) /* CH1, CH2 */
742 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
743 devopts_ch12, ARRAY_SIZE(devopts_ch12), sizeof(uint32_t));
744 else /* Must be CH3 */
745 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
746 devopts_ch3, ARRAY_SIZE(devopts_ch3), sizeof(uint32_t));
748 case SR_CONF_VOLTAGE_TARGET:
749 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
750 /* Min, max, step. */
751 for (i = 0; i < 3; i++) {
752 gvar = g_variant_new_double(devc->model->channels[ch_idx].voltage[i]);
753 g_variant_builder_add_value(&gvb, gvar);
755 *data = g_variant_builder_end(&gvb);
757 case SR_CONF_CURRENT_LIMIT:
758 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
759 /* Min, max, step. */
760 for (i = 0; i < 3; i++) {
761 gvar = g_variant_new_double(devc->model->channels[ch_idx].current[i]);
762 g_variant_builder_add_value(&gvb, gvar);
764 *data = g_variant_builder_end(&gvb);
773 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
775 struct dev_context *devc;
776 struct sr_serial_dev_inst *serial;
778 if (sdi->status != SR_ST_ACTIVE)
779 return SR_ERR_DEV_CLOSED;
783 devc->acq_running = TRUE;
786 serial_source_add(sdi->session, serial, G_IO_IN, 50,
787 motech_lps_30x_receive_data, (void *)sdi);
788 std_session_send_df_header(sdi, LOG_PREFIX);
790 sr_sw_limits_acquisition_start(&devc->limits);
792 devc->acq_req = AQ_NONE;
793 /* Do not start polling device here, the read function will do it in 50 ms. */
798 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
800 return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
801 sdi->conn, LOG_PREFIX);
804 SR_PRIV struct sr_dev_driver motech_lps_301_driver_info = {
805 .name = "motech-lps-301",
806 .longname = "Motech LPS-301",
809 .cleanup = std_cleanup,
811 .dev_list = std_dev_list,
812 .dev_clear = dev_clear_lps301,
813 .config_get = config_get,
814 .config_set = config_set,
815 .config_list = config_list,
816 .dev_open = std_serial_dev_open,
817 .dev_close = std_serial_dev_close,
818 .dev_acquisition_start = dev_acquisition_start,
819 .dev_acquisition_stop = dev_acquisition_stop,