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 static int init_lps301(struct sr_dev_driver *di, struct sr_context *sr_ctx)
138 return std_init(sr_ctx, di, LOG_PREFIX);
141 /** Send command to device with va_list.
143 SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char *fmt, va_list args)
146 char auxfmt[LINELEN_MAX];
147 char buf[LINELEN_MAX];
149 snprintf(auxfmt, sizeof(auxfmt), "%s\r\n", fmt);
150 vsnprintf(buf, sizeof(buf), auxfmt, args);
152 sr_spew("lps_send_va: \"%s\"", buf);
154 retc = serial_write_blocking(serial, buf, strlen(buf),
155 serial_timeout(serial, strlen(buf)));
163 /** Send command to device.
165 SR_PRIV int lps_send_req(struct sr_serial_dev_inst *serial, const char *fmt, ...)
171 retc = lps_send_va(serial, fmt, args);
177 /** Send command and consume simple OK reply. */
178 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char *fmt, ...)
182 char buf[LINELEN_MAX];
188 retc = lps_send_va(serial, fmt, args);
197 buflen = sizeof(buf);
198 retc = lps_read_reply(serial, &bufptr, &buflen);
199 if ((retc == SR_OK) && (buflen == 0))
205 /** Send command and read reply string.
206 * @param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated.
208 SR_PRIV int lps_cmd_reply(char *reply, struct sr_serial_dev_inst *serial, const char *fmt, ...)
212 char buf[LINELEN_MAX];
220 retc = lps_send_va(serial, fmt, args);
229 buflen = sizeof(buf);
230 retc = lps_read_reply(serial, &bufptr, &buflen);
231 if ((retc == SR_OK) && (buflen > 0)) {
239 /** Process integer value returned by STATUS command. */
240 SR_PRIV int lps_process_status(struct sr_dev_inst *sdi, int stat)
242 struct dev_context *devc;
245 devc = (struct dev_context *)sdi->priv;
247 sr_spew("Status: %d", stat);
248 devc->channel_status[0].cc_mode = (stat & 0x01) != 0;
249 sr_spew("Channel 1 %s mode", devc->channel_status[0].cc_mode?"CC":"CV");
250 if (devc->model->num_channels > 1) {
251 devc->channel_status[1].cc_mode = (stat & 0x02) != 0;
252 sr_spew("Channel 2 %s mode", devc->channel_status[1].cc_mode?"CC":"CV");
254 tracking_mode = (stat & 0x0c) >> 2;
255 switch (tracking_mode) {
256 case 0: devc->tracking_mode = 0;
258 case 2: devc->tracking_mode = 1;
260 case 3: devc->tracking_mode = 2;
263 sr_err("Illegal channel tracking mode %d!", tracking_mode);
264 devc->tracking_mode = 0;
268 sr_spew("Channel tracking: %d", devc->tracking_mode);
270 devc->channel_status[0].output_enabled = devc->channel_status[1].output_enabled = stat&0x040?TRUE:FALSE;
271 sr_spew("Channel 1%s output: %s", devc->model->num_channels > 1?"+2":"", devc->channel_status[0].output_enabled?"ON":"OFF");
272 if (devc->model->num_channels > 2) {
273 devc->channel_status[2].output_enabled = stat&0x010?TRUE:FALSE;
274 devc->channel_status[2].output_voltage_last = stat&0x020?3.3:5;
275 sr_spew("Channel 3 output: %s, U=%02f V, overload=%d",
276 devc->channel_status[2].output_enabled?"ON":"OFF",
277 devc->channel_status[2].output_voltage_last,
280 sr_spew("Fan=%d, beep=%d, CC output compensated=%d", stat&0x0100?1:0, stat&0x0200?1:0, stat&0x0400?1:0);
285 /** Send STATUS commend and process status string. */
286 SR_PRIV int lps_query_status(struct sr_dev_inst *sdi)
288 char buf[LINELEN_MAX];
290 struct dev_context *devc;
292 devc = (struct dev_context *)sdi->priv;
294 devc->req_sent_at = g_get_real_time();
296 if ((ret = lps_cmd_reply(buf, sdi->conn, "STATUS")) < 0) {
297 sr_err("%s: Failed to read status: %s.", __func__,
302 if (sr_atoi(buf, &stat) != SR_OK)
305 return lps_process_status(sdi, stat);
308 static gint64 calc_timeout_ms(gint64 start_us)
310 gint64 result = REQ_TIMEOUT_MS - ((g_get_real_time() - start_us) / 1000);
318 /** Read message into buf until "OK" received.
319 * @retval SR_OK Msg received; buf and buflen contain result, if any except OK.
320 * @retval SR_ERR Error, including timeout.
322 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen)
325 char buf2[LINELEN_MAX];
328 gint64 timeout_start;
332 /* Read one line. It is either a data message or "OK". */
333 timeout_start = g_get_real_time();
335 /* Up to 5 tries because serial_readline() will consume only one CR or LF per
336 * call, but device sends up to 4 in a row. */
337 for (retries = 0; retries < 5; retries++) {
339 if (serial_readline(serial, buf, buflen, calc_timeout_ms(timeout_start)) != SR_OK)
341 if (!strcmp(*buf, "OK")) { /* We got an OK! */
346 if (*buflen > 0) /* We got a msg! */
350 /* A data msg is in buf (possibly ERROR), need to consume "OK". */
353 for (retries = 0; retries < 5; retries++) {
354 buf2len = sizeof(buf2);
355 if (serial_readline(serial, &buf2ptr, &buf2len, calc_timeout_ms(timeout_start)) != SR_OK)
358 if (!strcmp(buf2ptr, "OK")) { /* We got an OK! */
359 if (!strcmp(*buf, "ERROR")) { /* OK came after msg ERROR! */
360 sr_spew("ERROR found!");
369 return SR_ERR; /* Timeout! */
372 /** Scan for LPS-300 series device.
374 static GSList *do_scan(lps_modelid modelid, struct sr_dev_driver *drv, GSList *options)
376 struct sr_dev_inst *sdi;
377 struct drv_context *drvc;
378 struct dev_context *devc;
379 struct sr_serial_dev_inst *serial;
380 struct sr_channel *ch;
381 struct sr_channel_group *cg;
383 const char *conn, *serialcomm;
385 gchar buf[LINELEN_MAX];
391 conn = serialcomm = NULL;
395 drvc->instances = NULL;
397 sr_spew("scan() called!");
399 /* Process and check options. */
400 if (sr_serial_extract_options(options, &conn, &serialcomm) != SR_OK)
403 serialcomm = SERIALCOMM;
405 /* Init serial port. */
406 serial = sr_serial_dev_inst_new(conn, serialcomm);
408 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
411 /* Query and verify model string. */
412 serial_flush(serial);
413 if (lps_cmd_reply(buf, serial, "MODEL") != SR_OK)
416 /* Check model string. */
417 if (strncmp(buf, "LPS-", 4)) {
418 sr_spew("Unknown model code \"%s\"!", buf);
422 /* Bug in device FW 1.17, model number is empty, so this can't work with this FW! */
423 if (modelid == LPS_UNKNOWN) {
425 for (cnt = LPS_301; cnt <= LPS_305; cnt++) {
426 if (!strcmp(buf, models[cnt].modelstr)) {
431 if (modelid == LPS_UNKNOWN) {
432 sr_err("Unable to detect model from model string '%s'!", buf);
439 if ((ret = lps_cmd_reply(buf, serial, "VERSION")) == SR_OK) {
440 if (strncmp(buf, "Ver-", 4)) {
441 sr_spew("Version string %s not recognized.", buf);
448 else /* Bug in device FW 1.17: Querying version string fails while output is active.
449 Therefore just print an error message, but do not exit with error. */
450 sr_err("Failed to query for hardware version: %s.",
453 sdi = g_malloc0(sizeof(struct sr_dev_inst));
454 sdi->status = SR_ST_INACTIVE;
455 sdi->vendor = g_strdup(VENDOR_MOTECH);
456 sdi->model = g_strdup(models[modelid].modelstr);
457 sdi->version = g_strdup(verstr);
459 sdi->inst_type = SR_INST_SERIAL;
462 devc = g_malloc0(sizeof(struct dev_context));
463 devc->model = &models[modelid];
464 devc->limit_samples = 0;
465 devc->limit_msec = 0;
466 devc->num_samples = 0;
467 devc->elapsed_msec = g_timer_new();
471 /* Setup channels and channel groups. */
472 for (cnt = 0; cnt < models[modelid].num_channels; cnt++) {
473 snprintf(channel, sizeof(channel), "CH%d", cnt + 1);
474 ch = sr_channel_new(sdi, cnt, SR_CHANNEL_ANALOG, TRUE, channel);
476 devc->channel_status[cnt].info = g_slist_append(NULL, ch);
478 cg = g_malloc(sizeof(struct sr_channel_group));
479 snprintf(channel, sizeof(channel), "CG%d", cnt+1);
480 cg->name = g_strdup(channel);
482 cg->channels = g_slist_append(NULL, ch);
484 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
487 drvc->instances = g_slist_append(drvc->instances, sdi);
488 devices = g_slist_append(devices, sdi);
491 if (lps_query_status(sdi) != SR_OK)
494 serial_close(serial);
496 sr_serial_dev_inst_free(serial);
501 sr_info("%s: Error!", __func__);
504 serial_close(serial);
505 sr_serial_dev_inst_free(serial);
509 sr_dev_inst_free(sdi);
514 /** Scan for LPS-301 device. */
515 static GSList *scan_lps301(struct sr_dev_driver *di, GSList *options)
517 return do_scan(LPS_301, di, options);
520 static GSList *dev_list_lps301(const struct sr_dev_driver *di)
522 return ((struct drv_context *)(di->context))->instances;
525 static void dev_clear_private(struct dev_context *devc)
529 /* Free channel_status.info (list only, data owned by sdi). */
530 for (ch_idx = 0; ch_idx < devc->model->num_channels; ch_idx++)
531 g_slist_free(devc->channel_status[ch_idx].info);
533 g_timer_destroy(devc->elapsed_msec);
536 static int dev_clear_lps301(const struct sr_dev_driver *di)
538 return std_dev_clear(di, (std_dev_clear_callback)dev_clear_private);
541 static int cleanup(const struct sr_dev_driver *di)
543 return dev_clear_lps301(di);
546 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
547 const struct sr_channel_group *cg)
549 struct dev_context *devc;
550 struct sr_channel *ch;
559 /* No channel group: global options. */
561 case SR_CONF_LIMIT_SAMPLES:
562 *data = g_variant_new_uint64(devc->limit_samples);
564 case SR_CONF_LIMIT_MSEC:
565 *data = g_variant_new_uint64(devc->limit_msec);
567 case SR_CONF_CHANNEL_CONFIG:
568 *data = g_variant_new_string(channel_modes[devc->tracking_mode]);
574 /* We only ever have one channel per channel group in this driver. */
575 ch = cg->channels->data;
578 case SR_CONF_VOLTAGE:
579 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_last);
581 case SR_CONF_VOLTAGE_TARGET:
582 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_max);
584 case SR_CONF_CURRENT:
585 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_last);
587 case SR_CONF_CURRENT_LIMIT:
588 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_max);
590 case SR_CONF_ENABLED:
591 *data = g_variant_new_boolean(devc->channel_status[ch_idx].output_enabled);
601 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
602 const struct sr_channel_group *cg)
604 struct dev_context *devc;
605 struct sr_channel *ch;
613 if (sdi->status != SR_ST_ACTIVE)
614 return SR_ERR_DEV_CLOSED;
618 /* Cannot change settings while acquisition active, would cause a mess with commands.
619 * Changing this would be possible, but tricky. */
620 if (devc->acq_running)
624 /* No channel group: global options. */
626 case SR_CONF_LIMIT_MSEC:
627 devc->limit_msec = g_variant_get_uint64(data);
629 case SR_CONF_LIMIT_SAMPLES:
630 devc->limit_samples = g_variant_get_uint64(data);
632 case SR_CONF_CHANNEL_CONFIG:
633 sval = g_variant_get_string(data, NULL);
635 for (idx = 0; idx < (int)ARRAY_SIZE(channel_modes); idx++) {
636 if (!strcmp(sval, channel_modes[idx])) {
638 if (devc->tracking_mode == idx)
639 break; /* Nothing to do! */
640 devc->tracking_mode = idx;
641 if (devc->model->modelid >= LPS_304) /* No use to set anything in the smaller models. */
642 return lps_cmd_ok(sdi->conn, "TRACK%1d", devc->tracking_mode);
644 if (devc->model->modelid <= LPS_303) /* Only first setting possible for smaller models. */
654 /* Channel group specified: per-channel options. */
655 /* We only ever have one channel per channel group in this driver. */
656 ch = cg->channels->data;
660 case SR_CONF_VOLTAGE_TARGET:
661 dval = g_variant_get_double(data);
662 if (dval < 0 || dval > devc->model->channels[ch_idx].voltage[1])
665 if (devc->model->modelid < LPS_304)
668 if (fabs(dval - 5.000) <= 0.001)
670 else if ((devc->model->modelid >= LPS_305) && (fabs(dval - 3.300) <= 0.001))
672 else return SR_ERR_ARG;
675 devc->channel_status[ch_idx].output_voltage_max = dval;
677 return lps_cmd_ok(sdi->conn, "VDD%1.0f", trunc(dval));
679 return lps_cmd_ok(sdi->conn, "VSET%d %05.3f", ch_idx+1, dval);
681 case SR_CONF_CURRENT_LIMIT:
682 dval = g_variant_get_double(data);
683 if (dval < 0 || dval > devc->model->channels[ch_idx].current[1])
685 if (ch_idx == 2) /* No current setting for CH3. */
687 devc->channel_status[ch_idx].output_current_max = dval;
688 return lps_cmd_ok(sdi->conn, "ISET%d %05.4f", ch_idx+1, dval);
690 case SR_CONF_ENABLED:
691 bval = g_variant_get_boolean(data);
692 if (bval == devc->channel_status[ch_idx].output_enabled) /* Nothing to do. */
694 devc->channel_status[ch_idx].output_enabled = bval;
695 if (ch_idx != 2) { /* Channels 1,2 can be set only together. */
696 devc->channel_status[ch_idx^1].output_enabled = bval;
697 return lps_cmd_ok(sdi->conn, "OUT%1d", (int)bval);
698 } else { /* Channel 3: No command to disable output, set voltage to 0 instead. */
700 return lps_cmd_ok(sdi->conn, "VDD%1.0f", devc->channel_status[ch_idx].output_voltage_max);
702 return lps_cmd_ok(sdi->conn, "VDD0");
713 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
714 const struct sr_channel_group *cg)
716 struct dev_context *devc;
717 struct sr_channel *ch;
722 /* Driver options, no device instance necessary. */
724 case SR_CONF_SCAN_OPTIONS:
725 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
726 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
728 case SR_CONF_DEVICE_OPTIONS:
731 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
732 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
741 /* Device options, independent from channel groups. */
744 case SR_CONF_DEVICE_OPTIONS:
745 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
746 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
748 case SR_CONF_CHANNEL_CONFIG:
749 if (devc->model->modelid <= LPS_303) {
750 /* The 1-channel models. */
751 *data = g_variant_new_strv(channel_modes, 1);
753 /* The other models support all modes. */
754 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
762 /* Device options, depending on channel groups. */
763 ch = cg->channels->data;
766 case SR_CONF_DEVICE_OPTIONS:
767 if ((ch_idx == 0) || (ch_idx == 1)) /* CH1, CH2 */
768 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
769 devopts_ch12, ARRAY_SIZE(devopts_ch12), sizeof(uint32_t));
770 else /* Must be CH3 */
771 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
772 devopts_ch3, ARRAY_SIZE(devopts_ch3), sizeof(uint32_t));
774 case SR_CONF_VOLTAGE_TARGET:
775 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
776 /* Min, max, step. */
777 for (i = 0; i < 3; i++) {
778 gvar = g_variant_new_double(devc->model->channels[ch_idx].voltage[i]);
779 g_variant_builder_add_value(&gvb, gvar);
781 *data = g_variant_builder_end(&gvb);
783 case SR_CONF_CURRENT_LIMIT:
784 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
785 /* Min, max, step. */
786 for (i = 0; i < 3; i++) {
787 gvar = g_variant_new_double(devc->model->channels[ch_idx].current[i]);
788 g_variant_builder_add_value(&gvb, gvar);
790 *data = g_variant_builder_end(&gvb);
799 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
801 struct dev_context *devc;
802 struct sr_serial_dev_inst *serial;
804 if (sdi->status != SR_ST_ACTIVE)
805 return SR_ERR_DEV_CLOSED;
809 devc->acq_running = TRUE;
812 serial_source_add(sdi->session, serial, G_IO_IN, 50,
813 motech_lps_30x_receive_data, (void *)sdi);
814 std_session_send_df_header(cb_data, LOG_PREFIX);
816 /* Start timer, if required. */
817 if (devc->limit_msec)
818 g_timer_start(devc->elapsed_msec);
820 devc->acq_req = AQ_NONE;
821 /* Do not start polling device here, the read function will do it in 50 ms. */
826 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
828 struct dev_context *devc;
830 /* Stop timer, if required. */
831 if (sdi && (devc = sdi->priv) && devc->limit_msec)
832 g_timer_stop(devc->elapsed_msec);
834 return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
835 sdi->conn, LOG_PREFIX);
838 SR_PRIV struct sr_dev_driver motech_lps_301_driver_info = {
839 .name = "motech-lps-301",
840 .longname = "Motech LPS-301",
845 .dev_list = dev_list_lps301,
846 .dev_clear = dev_clear_lps301,
847 .config_get = config_get,
848 .config_set = config_set,
849 .config_list = config_list,
850 .dev_open = std_serial_dev_open,
851 .dev_close = std_serial_dev_close,
852 .dev_acquisition_start = dev_acquisition_start,
853 .dev_acquisition_stop = dev_acquisition_stop,