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
31 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen);
32 SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char *fmt, va_list args);
33 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char *fmt, ...);
34 SR_PRIV int lps_cmd_reply(char *reply, struct sr_serial_dev_inst *serial, const char *fmt, ...);
35 SR_PRIV int lps_query_status(struct sr_dev_inst *sdi);
37 /* Serial communication parameters */
38 #define SERIALCOMM "2400/8n1/dtr=1/rts=1/flow=0"
40 #define VENDOR_MOTECH "Motech"
42 /** Driver capabilities generic. */
43 static const uint32_t drvopts[] = {
48 /** Driver scanning options. */
49 static const uint32_t scanopts[] = {
54 /** Hardware capabilities generic. */
55 static const uint32_t devopts[] = {
58 /* Acquisition modes. */
60 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
61 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
62 /* Device configuration */
63 SR_CONF_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
66 /** Hardware capabilities channel 1, 2. */
67 static const uint32_t devopts_ch12[] = {
68 SR_CONF_VOLTAGE | SR_CONF_GET,
69 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
70 SR_CONF_CURRENT | SR_CONF_GET,
71 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
72 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
75 /** Hardware capabilities channel 3. (LPS-304/305 only). */
76 static const uint32_t devopts_ch3[] = {
77 SR_CONF_VOLTAGE | SR_CONF_GET,
78 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
81 static const char *channel_modes[] = {
87 static const struct lps_modelspec models[] = {
88 { LPS_UNKNOWN, "Dummy", 0,
93 { LPS_301, "LPS-301", 1,
96 { { 0, 32, 0.01 }, { 0.005, 2, 0.001 } },
99 { LPS_302, "LPS-302", 1,
102 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
105 { LPS_303, "LPS-303", 1,
108 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
111 { LPS_304, "LPS-304", 3,
114 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
116 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
118 { { 5, 5, 0.0 }, { 0.005, 3, 0.001 } },
121 { LPS_305, "LPS-305", 3,
124 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
126 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
128 { { 3.3, 5, 1.7 }, { 0.005, 3, 0.001 } },
133 /** Send command to device with va_list.
135 SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char *fmt, va_list args)
138 char auxfmt[LINELEN_MAX];
139 char buf[LINELEN_MAX];
141 snprintf(auxfmt, sizeof(auxfmt), "%s\r\n", fmt);
142 vsnprintf(buf, sizeof(buf), auxfmt, args);
144 sr_spew("lps_send_va: \"%s\"", buf);
146 retc = serial_write_blocking(serial, buf, strlen(buf),
147 serial_timeout(serial, strlen(buf)));
155 /** Send command to device.
157 SR_PRIV int lps_send_req(struct sr_serial_dev_inst *serial, const char *fmt, ...)
163 retc = lps_send_va(serial, fmt, args);
169 /** Send command and consume simple OK reply. */
170 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char *fmt, ...)
174 char buf[LINELEN_MAX];
180 retc = lps_send_va(serial, fmt, args);
189 buflen = sizeof(buf);
190 retc = lps_read_reply(serial, &bufptr, &buflen);
191 if ((retc == SR_OK) && (buflen == 0))
197 /** Send command and read reply string.
198 * @param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated.
200 SR_PRIV int lps_cmd_reply(char *reply, struct sr_serial_dev_inst *serial, const char *fmt, ...)
204 char buf[LINELEN_MAX];
212 retc = lps_send_va(serial, fmt, args);
221 buflen = sizeof(buf);
222 retc = lps_read_reply(serial, &bufptr, &buflen);
223 if ((retc == SR_OK) && (buflen > 0)) {
231 /** Process integer value returned by STATUS command. */
232 SR_PRIV int lps_process_status(struct sr_dev_inst *sdi, int stat)
234 struct dev_context *devc;
239 sr_spew("Status: %d", stat);
240 devc->channel_status[0].cc_mode = (stat & 0x01) != 0;
241 sr_spew("Channel 1 %s mode", devc->channel_status[0].cc_mode?"CC":"CV");
242 if (devc->model->num_channels > 1) {
243 devc->channel_status[1].cc_mode = (stat & 0x02) != 0;
244 sr_spew("Channel 2 %s mode", devc->channel_status[1].cc_mode?"CC":"CV");
246 tracking_mode = (stat & 0x0c) >> 2;
247 switch (tracking_mode) {
248 case 0: devc->tracking_mode = 0;
250 case 2: devc->tracking_mode = 1;
252 case 3: devc->tracking_mode = 2;
255 sr_err("Illegal channel tracking mode %d!", tracking_mode);
256 devc->tracking_mode = 0;
260 sr_spew("Channel tracking: %d", devc->tracking_mode);
262 devc->channel_status[0].output_enabled = devc->channel_status[1].output_enabled = stat&0x040?TRUE:FALSE;
263 sr_spew("Channel 1%s output: %s", devc->model->num_channels > 1?"+2":"", devc->channel_status[0].output_enabled?"ON":"OFF");
264 if (devc->model->num_channels > 2) {
265 devc->channel_status[2].output_enabled = stat&0x010?TRUE:FALSE;
266 devc->channel_status[2].output_voltage_last = stat&0x020?3.3:5;
267 sr_spew("Channel 3 output: %s, U=%02f V, overload=%d",
268 devc->channel_status[2].output_enabled?"ON":"OFF",
269 devc->channel_status[2].output_voltage_last,
272 sr_spew("Fan=%d, beep=%d, CC output compensated=%d", stat&0x0100?1:0, stat&0x0200?1:0, stat&0x0400?1:0);
277 /** Send STATUS commend and process status string. */
278 SR_PRIV int lps_query_status(struct sr_dev_inst *sdi)
280 char buf[LINELEN_MAX];
282 struct dev_context *devc;
286 devc->req_sent_at = g_get_real_time();
288 if ((ret = lps_cmd_reply(buf, sdi->conn, "STATUS")) < 0) {
289 sr_err("%s: Failed to read status: %s.", __func__,
294 if (sr_atoi(buf, &stat) != SR_OK)
297 return lps_process_status(sdi, stat);
300 static gint64 calc_timeout_ms(gint64 start_us)
302 gint64 result = REQ_TIMEOUT_MS - ((g_get_real_time() - start_us) / 1000);
310 /** Read message into buf until "OK" received.
311 * @retval SR_OK Msg received; buf and buflen contain result, if any except OK.
312 * @retval SR_ERR Error, including timeout.
314 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen)
317 char buf2[LINELEN_MAX];
320 gint64 timeout_start;
324 /* Read one line. It is either a data message or "OK". */
325 timeout_start = g_get_real_time();
327 /* Up to 5 tries because serial_readline() will consume only one CR or LF per
328 * call, but device sends up to 4 in a row. */
329 for (retries = 0; retries < 5; retries++) {
331 if (serial_readline(serial, buf, buflen, calc_timeout_ms(timeout_start)) != SR_OK)
333 if (!strcmp(*buf, "OK")) { /* We got an OK! */
338 if (*buflen > 0) /* We got a msg! */
342 /* A data msg is in buf (possibly ERROR), need to consume "OK". */
345 for (retries = 0; retries < 5; retries++) {
346 buf2len = sizeof(buf2);
347 if (serial_readline(serial, &buf2ptr, &buf2len, calc_timeout_ms(timeout_start)) != SR_OK)
350 if (!strcmp(buf2ptr, "OK")) { /* We got an OK! */
351 if (!strcmp(*buf, "ERROR")) { /* OK came after msg ERROR! */
352 sr_spew("ERROR found!");
361 return SR_ERR; /* Timeout! */
364 /** Scan for LPS-300 series device.
366 static GSList *do_scan(lps_modelid modelid, struct sr_dev_driver *drv, GSList *options)
368 struct sr_dev_inst *sdi;
369 struct drv_context *drvc;
370 struct dev_context *devc;
371 struct sr_serial_dev_inst *serial;
372 struct sr_channel *ch;
373 struct sr_channel_group *cg;
375 const char *conn, *serialcomm;
377 gchar buf[LINELEN_MAX];
383 conn = serialcomm = NULL;
387 drvc->instances = NULL;
389 sr_spew("scan() called!");
391 /* Process and check options. */
392 if (sr_serial_extract_options(options, &conn, &serialcomm) != SR_OK)
395 serialcomm = SERIALCOMM;
397 /* Init serial port. */
398 serial = sr_serial_dev_inst_new(conn, serialcomm);
400 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
403 /* Query and verify model string. */
404 serial_flush(serial);
405 if (lps_cmd_reply(buf, serial, "MODEL") != SR_OK)
408 /* Check model string. */
409 if (strncmp(buf, "LPS-", 4)) {
410 sr_spew("Unknown model code \"%s\"!", buf);
414 /* Bug in device FW 1.17, model number is empty, so this can't work with this FW! */
415 if (modelid == LPS_UNKNOWN) {
417 for (cnt = LPS_301; cnt <= LPS_305; cnt++) {
418 if (!strcmp(buf, models[cnt].modelstr)) {
423 if (modelid == LPS_UNKNOWN) {
424 sr_err("Unable to detect model from model string '%s'!", buf);
431 if ((ret = lps_cmd_reply(buf, serial, "VERSION")) == SR_OK) {
432 if (strncmp(buf, "Ver-", 4)) {
433 sr_spew("Version string %s not recognized.", buf);
440 else /* Bug in device FW 1.17: Querying version string fails while output is active.
441 Therefore just print an error message, but do not exit with error. */
442 sr_err("Failed to query for hardware version: %s.",
445 sdi = g_malloc0(sizeof(struct sr_dev_inst));
446 sdi->status = SR_ST_INACTIVE;
447 sdi->vendor = g_strdup(VENDOR_MOTECH);
448 sdi->model = g_strdup(models[modelid].modelstr);
449 sdi->version = g_strdup(verstr);
451 sdi->inst_type = SR_INST_SERIAL;
454 devc = g_malloc0(sizeof(struct dev_context));
455 sr_sw_limits_init(&devc->limits);
456 devc->model = &models[modelid];
460 /* Setup channels and channel groups. */
461 for (cnt = 0; cnt < models[modelid].num_channels; cnt++) {
462 snprintf(channel, sizeof(channel), "CH%d", cnt + 1);
463 ch = sr_channel_new(sdi, cnt, SR_CHANNEL_ANALOG, TRUE, channel);
465 devc->channel_status[cnt].info = g_slist_append(NULL, ch);
467 cg = g_malloc(sizeof(struct sr_channel_group));
468 snprintf(channel, sizeof(channel), "CG%d", cnt+1);
469 cg->name = g_strdup(channel);
471 cg->channels = g_slist_append(NULL, ch);
473 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
476 drvc->instances = g_slist_append(drvc->instances, sdi);
477 devices = g_slist_append(devices, sdi);
480 if (lps_query_status(sdi) != SR_OK)
483 serial_close(serial);
485 sr_serial_dev_inst_free(serial);
490 sr_info("%s: Error!", __func__);
493 serial_close(serial);
494 sr_serial_dev_inst_free(serial);
498 sr_dev_inst_free(sdi);
503 /** Scan for LPS-301 device. */
504 static GSList *scan_lps301(struct sr_dev_driver *di, GSList *options)
506 return do_scan(LPS_301, di, options);
509 static void dev_clear_private(struct dev_context *devc)
513 /* Free channel_status.info (list only, data owned by sdi). */
514 for (ch_idx = 0; ch_idx < devc->model->num_channels; ch_idx++)
515 g_slist_free(devc->channel_status[ch_idx].info);
518 static int dev_clear_lps301(const struct sr_dev_driver *di)
520 return std_dev_clear(di, (std_dev_clear_callback)dev_clear_private);
523 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
524 const struct sr_channel_group *cg)
526 struct dev_context *devc;
527 struct sr_channel *ch;
536 /* No channel group: global options. */
538 case SR_CONF_LIMIT_SAMPLES:
539 case SR_CONF_LIMIT_MSEC:
540 return sr_sw_limits_config_get(&devc->limits, key, data);
541 case SR_CONF_CHANNEL_CONFIG:
542 *data = g_variant_new_string(channel_modes[devc->tracking_mode]);
548 /* We only ever have one channel per channel group in this driver. */
549 ch = cg->channels->data;
552 case SR_CONF_VOLTAGE:
553 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_last);
555 case SR_CONF_VOLTAGE_TARGET:
556 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_max);
558 case SR_CONF_CURRENT:
559 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_last);
561 case SR_CONF_CURRENT_LIMIT:
562 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_max);
564 case SR_CONF_ENABLED:
565 *data = g_variant_new_boolean(devc->channel_status[ch_idx].output_enabled);
575 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
576 const struct sr_channel_group *cg)
578 struct dev_context *devc;
579 struct sr_channel *ch;
587 if (sdi->status != SR_ST_ACTIVE)
588 return SR_ERR_DEV_CLOSED;
592 /* Cannot change settings while acquisition active, would cause a mess with commands.
593 * Changing this would be possible, but tricky. */
594 if (devc->acq_running)
598 /* No channel group: global options. */
600 case SR_CONF_LIMIT_MSEC:
601 case SR_CONF_LIMIT_SAMPLES:
602 return sr_sw_limits_config_set(&devc->limits, key, data);
603 case SR_CONF_CHANNEL_CONFIG:
604 sval = g_variant_get_string(data, NULL);
606 for (idx = 0; idx < (int)ARRAY_SIZE(channel_modes); idx++) {
607 if (!strcmp(sval, channel_modes[idx])) {
609 if (devc->tracking_mode == idx)
610 break; /* Nothing to do! */
611 devc->tracking_mode = idx;
612 if (devc->model->modelid >= LPS_304) /* No use to set anything in the smaller models. */
613 return lps_cmd_ok(sdi->conn, "TRACK%1d", devc->tracking_mode);
615 if (devc->model->modelid <= LPS_303) /* Only first setting possible for smaller models. */
625 /* Channel group specified: per-channel options. */
626 /* We only ever have one channel per channel group in this driver. */
627 ch = cg->channels->data;
631 case SR_CONF_VOLTAGE_TARGET:
632 dval = g_variant_get_double(data);
633 if (dval < 0 || dval > devc->model->channels[ch_idx].voltage[1])
636 if (devc->model->modelid < LPS_304)
639 if (fabs(dval - 5.000) <= 0.001)
641 else if ((devc->model->modelid >= LPS_305) && (fabs(dval - 3.300) <= 0.001))
643 else return SR_ERR_ARG;
646 devc->channel_status[ch_idx].output_voltage_max = dval;
648 return lps_cmd_ok(sdi->conn, "VDD%1.0f", trunc(dval));
650 return lps_cmd_ok(sdi->conn, "VSET%d %05.3f", ch_idx+1, dval);
652 case SR_CONF_CURRENT_LIMIT:
653 dval = g_variant_get_double(data);
654 if (dval < 0 || dval > devc->model->channels[ch_idx].current[1])
656 if (ch_idx == 2) /* No current setting for CH3. */
658 devc->channel_status[ch_idx].output_current_max = dval;
659 return lps_cmd_ok(sdi->conn, "ISET%d %05.4f", ch_idx+1, dval);
661 case SR_CONF_ENABLED:
662 bval = g_variant_get_boolean(data);
663 if (bval == devc->channel_status[ch_idx].output_enabled) /* Nothing to do. */
665 devc->channel_status[ch_idx].output_enabled = bval;
666 if (ch_idx != 2) { /* Channels 1,2 can be set only together. */
667 devc->channel_status[ch_idx^1].output_enabled = bval;
668 return lps_cmd_ok(sdi->conn, "OUT%1d", (int)bval);
669 } else { /* Channel 3: No command to disable output, set voltage to 0 instead. */
671 return lps_cmd_ok(sdi->conn, "VDD%1.0f", devc->channel_status[ch_idx].output_voltage_max);
673 return lps_cmd_ok(sdi->conn, "VDD0");
684 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
685 const struct sr_channel_group *cg)
687 struct dev_context *devc;
688 struct sr_channel *ch;
693 /* Driver options, no device instance necessary. */
695 case SR_CONF_SCAN_OPTIONS:
696 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
697 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
699 case SR_CONF_DEVICE_OPTIONS:
702 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
703 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
712 /* Device options, independent from channel groups. */
715 case SR_CONF_DEVICE_OPTIONS:
716 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
717 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
719 case SR_CONF_CHANNEL_CONFIG:
720 if (devc->model->modelid <= LPS_303) {
721 /* The 1-channel models. */
722 *data = g_variant_new_strv(channel_modes, 1);
724 /* The other models support all modes. */
725 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
733 /* Device options, depending on channel groups. */
734 ch = cg->channels->data;
737 case SR_CONF_DEVICE_OPTIONS:
738 if ((ch_idx == 0) || (ch_idx == 1)) /* CH1, CH2 */
739 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
740 devopts_ch12, ARRAY_SIZE(devopts_ch12), sizeof(uint32_t));
741 else /* Must be CH3 */
742 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
743 devopts_ch3, ARRAY_SIZE(devopts_ch3), sizeof(uint32_t));
745 case SR_CONF_VOLTAGE_TARGET:
746 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
747 /* Min, max, step. */
748 for (i = 0; i < 3; i++) {
749 gvar = g_variant_new_double(devc->model->channels[ch_idx].voltage[i]);
750 g_variant_builder_add_value(&gvb, gvar);
752 *data = g_variant_builder_end(&gvb);
754 case SR_CONF_CURRENT_LIMIT:
755 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
756 /* Min, max, step. */
757 for (i = 0; i < 3; i++) {
758 gvar = g_variant_new_double(devc->model->channels[ch_idx].current[i]);
759 g_variant_builder_add_value(&gvb, gvar);
761 *data = g_variant_builder_end(&gvb);
770 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
772 struct dev_context *devc;
773 struct sr_serial_dev_inst *serial;
775 if (sdi->status != SR_ST_ACTIVE)
776 return SR_ERR_DEV_CLOSED;
780 devc->acq_running = TRUE;
783 serial_source_add(sdi->session, serial, G_IO_IN, 50,
784 motech_lps_30x_receive_data, (void *)sdi);
785 std_session_send_df_header(sdi, LOG_PREFIX);
787 sr_sw_limits_acquisition_start(&devc->limits);
789 devc->acq_req = AQ_NONE;
790 /* Do not start polling device here, the read function will do it in 50 ms. */
795 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
797 return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
798 sdi->conn, LOG_PREFIX);
801 SR_PRIV struct sr_dev_driver motech_lps_301_driver_info = {
802 .name = "motech-lps-301",
803 .longname = "Motech LPS-301",
806 .cleanup = std_cleanup,
808 .dev_list = std_dev_list,
809 .dev_clear = dev_clear_lps301,
810 .config_get = config_get,
811 .config_set = config_set,
812 .config_list = config_list,
813 .dev_open = std_serial_dev_open,
814 .dev_close = std_serial_dev_close,
815 .dev_acquisition_start = dev_acquisition_start,
816 .dev_acquisition_stop = dev_acquisition_stop,