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
33 /* Forward declarations */
34 SR_PRIV struct sr_dev_driver motech_lps_301_driver_info;
35 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen);
36 SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char* fmt, va_list args);
37 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char* fmt, ...);
38 SR_PRIV int lps_cmd_reply(char* reply, struct sr_serial_dev_inst *serial, const char* fmt, ...);
39 SR_PRIV int lps_query_status(struct sr_dev_inst* sdi);
41 /* Serial communication parameters */
42 #define SERIALCOMM "2400/8n1/dtr=1/rts=1/flow=0"
44 #define VENDOR_MOTECH "Motech"
46 /** Driver scanning options. */
47 static const int32_t hwopts[] = {
52 /** Hardware capabilities generic. */
53 static const int32_t hwcaps[] = {
56 /* Aquisition modes. */
57 SR_CONF_LIMIT_SAMPLES,
60 /* Device configuration */
61 SR_CONF_OUTPUT_CHANNEL_CONFIG,
64 /** Hardware capabilities channel 1, 2. */
65 static const int32_t hwcaps_ch12[] = {
66 SR_CONF_OUTPUT_VOLTAGE,
67 SR_CONF_OUTPUT_VOLTAGE_MAX,
68 SR_CONF_OUTPUT_CURRENT,
69 SR_CONF_OUTPUT_CURRENT_MAX,
70 SR_CONF_OUTPUT_ENABLED,
73 /** Hardware capabilities channel 3. (LPS-304/305 only). */
74 static const int32_t hwcaps_ch3[] = {
75 SR_CONF_OUTPUT_VOLTAGE,
76 SR_CONF_OUTPUT_ENABLED,
79 static const char *channel_modes[] = {
85 static struct lps_modelspec models[] = {
86 { LPS_UNKNOWN, "Dummy", 0,
91 { LPS_301, "LPS-301", 1,
94 { { 0, 32, 0.01 }, { 0.005, 2, 0.001 } },
97 { LPS_302, "LPS-302", 1,
100 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
103 { LPS_303, "LPS-303", 1,
106 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
109 { LPS_304, "LPS-304", 3,
112 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
114 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
116 { { 5, 5, 0.0 }, { 0.005, 3, 0.001 } },
119 { LPS_305, "LPS-305", 3,
122 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
124 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
126 { { 3.3, 5, 1.7 }, { 0.005, 3, 0.001 } },
131 static int init_lps301(struct sr_context *sr_ctx)
133 return std_init(sr_ctx, &motech_lps_301_driver_info, LOG_PREFIX);
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_nonblocking(serial, buf, strlen(buf));
157 /** Send command to device.
159 SR_PRIV int lps_send_req(struct sr_serial_dev_inst *serial, const char* fmt, ...)
165 retc = lps_send_va(serial, fmt, args);
171 /** Send command and consume simple OK reply. */
172 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char* fmt, ...)
176 char buf[LINELEN_MAX];
182 retc = lps_send_va(serial, fmt, args);
191 buflen = sizeof(buf);
192 retc = lps_read_reply(serial, &bufptr, &buflen);
193 if ((retc == SR_OK) && (buflen == 0))
199 /** Send command and read reply string.
200 * \param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated.
202 SR_PRIV int lps_cmd_reply(char* reply, struct sr_serial_dev_inst *serial, const char* fmt, ...)
206 char buf[LINELEN_MAX];
214 retc = lps_send_va(serial, fmt, args);
223 buflen = sizeof(buf);
224 retc = lps_read_reply(serial, &bufptr, &buflen);
225 if ((retc == SR_OK) && (buflen > 0)) {
233 /** Process integer value returned by STATUS command. */
234 SR_PRIV int lps_process_status(struct sr_dev_inst* sdi, int stat)
236 struct dev_context* devc;
239 devc = (struct dev_context*)sdi->priv;
241 sr_spew("Status: %d", stat);
242 devc->channel_status[0].cc_mode = (stat & 0x01) != 0;
243 sr_spew("Channel 1 %s mode", devc->channel_status[0].cc_mode?"CC":"CV");
244 if (devc->model->num_channels > 1) {
245 devc->channel_status[1].cc_mode = (stat & 0x02) != 0;
246 sr_spew("Channel 2 %s mode", devc->channel_status[1].cc_mode?"CC":"CV");
248 tracking_mode = (stat & 0x0c) >> 2;
249 switch (tracking_mode) {
250 case 0: devc->tracking_mode = 0;
252 case 2: devc->tracking_mode = 1;
254 case 3: devc->tracking_mode = 2;
257 sr_err("Illegal channel tracking mode %d!", tracking_mode);
258 devc->tracking_mode = 0;
262 sr_spew("Channel tracking: %d", devc->tracking_mode);
264 devc->channel_status[0].output_enabled = devc->channel_status[1].output_enabled = stat&0x040?TRUE:FALSE;
265 sr_spew("Channel 1%s output: %s", devc->model->num_channels > 1?"+2":"", devc->channel_status[0].output_enabled?"ON":"OFF");
266 if (devc->model->num_channels > 2) {
267 devc->channel_status[2].output_enabled = stat&0x010?TRUE:FALSE;
268 devc->channel_status[2].output_voltage_last = stat&0x020?3.3:5;
269 sr_spew("Channel 3 output: %s, U=%02f V, overload=%d",
270 devc->channel_status[2].output_enabled?"ON":"OFF",
271 devc->channel_status[2].output_voltage_last,
274 sr_spew("Fan=%d, beep=%d, CC output compensated=%d", stat&0x0100?1:0, stat&0x0200?1:0, stat&0x0400?1:0);
279 /** Send STATUS commend and process status string. */
280 SR_PRIV int lps_query_status(struct sr_dev_inst* sdi)
282 char buf[LINELEN_MAX];
284 struct dev_context* devc;
286 devc = (struct dev_context*)sdi->priv;
288 devc->req_sent_at = g_get_real_time();
290 if (lps_cmd_reply(buf, sdi->conn, "STATUS") < 0) {
291 sr_err("%s: Failed to read status: %d %s", __func__, errno, strerror(errno));
295 if (sr_atoi(buf, &stat) != SR_OK)
298 return lps_process_status(sdi, stat);
301 static gint64 calc_timeout_ms(gint64 start_us)
303 gint64 result = REQ_TIMEOUT_MS - ((g_get_real_time() - start_us) / 1000);
311 /** Read message into buf until "OK" received.
312 * \retval SR_OK Msg received; buf and buflen contain result, if any except OK.
313 * \retval SR_ERR Error, including timeout.
315 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen)
318 char buf2[LINELEN_MAX];
321 gint64 timeout_start;
325 /* Read one line. It is either a data message or "OK". */
326 timeout_start = g_get_real_time();
328 /* Up to 5 tries because serial_readline() will consume only one CR or LF per
329 * call, but device sends up to 4 in a row. */
330 for (retries = 0; retries < 5; retries++) {
332 if (serial_readline(serial, buf, buflen, calc_timeout_ms(timeout_start)) != SR_OK)
334 if (!strcmp(*buf, "OK")) { /* We got an OK! */
339 if (*buflen > 0) /* We got a msg! */
343 /* A data msg is in buf (possibly ERROR), need to consume "OK". */
346 for (retries = 0; retries < 5; retries++) {
347 buf2len = sizeof(buf2);
348 if (serial_readline(serial, &buf2ptr, &buf2len, calc_timeout_ms(timeout_start)) != SR_OK)
351 if (!strcmp(buf2ptr, "OK")) { /* We got an OK! */
352 if (!strcmp(*buf, "ERROR")) { /* OK came after msg ERROR! */
353 sr_spew("ERROR found!");
362 return SR_ERR; /* Timeout! */
365 /** Scan for LPS-300 series device.
367 static GSList *do_scan(lps_modelid modelid, struct sr_dev_driver *drv, GSList *options)
369 struct sr_dev_inst *sdi;
370 struct drv_context *drvc;
371 struct dev_context *devc;
372 struct sr_serial_dev_inst *serial;
373 struct sr_channel *ch;
374 struct sr_channel_group *cg;
376 const char *conn, *serialcomm;
378 gchar buf[LINELEN_MAX];
384 conn = serialcomm = NULL;
388 drvc->instances = NULL;
390 sr_spew("scan() called!");
392 /* Process and check options. */
393 if (sr_serial_extract_options(options, &conn, &serialcomm) != SR_OK)
396 serialcomm = SERIALCOMM;
398 /* Init serial port. */
399 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
402 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
405 /* Query and verify model string. */
406 serial_flush(serial);
407 if (lps_cmd_reply(buf, serial, "MODEL") != SR_OK)
410 /* Check model string. */
411 if (strncmp(buf, "LPS-", 4)) {
412 sr_spew("Unknown model code \"%s\"!", buf);
416 /* Bug in device FW 1.17, model number is empty, so this can't work with this FW! */
417 if (modelid == LPS_UNKNOWN) {
419 for (cnt = LPS_301; cnt <= LPS_305; cnt++) {
420 if (!strcmp(buf, models[cnt].modelstr)) {
425 if (modelid == LPS_UNKNOWN) {
426 sr_err("Unable to detect model from model string '%s'!", buf);
433 if (lps_cmd_reply(buf, serial, "VERSION") == SR_OK) {
434 if (strncmp(buf, "Ver-", 4)) {
435 sr_spew("Version string %s not recognized.", buf);
443 else /* Bug in device FW 1.17: Quering 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: %d %s", errno, strerror(errno));
447 sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_MOTECH, models[modelid].modelstr, verstr);
449 sdi->inst_type = SR_INST_SERIAL;
452 devc = g_malloc0(sizeof(struct dev_context));
453 devc->model = &models[modelid];
454 devc->limit_samples = 0;
455 devc->limit_msec = 0;
456 devc->num_samples = 0;
457 devc->elapsed_msec = g_timer_new();
461 /* Setup channels and channel groups. */
462 for (cnt = 0; cnt < models[modelid].num_channels; cnt++) {
463 snprintf(channel, sizeof(channel), "CH%d", cnt + 1);
464 ch = sr_channel_new(cnt, SR_CHANNEL_ANALOG, TRUE, channel);
465 sdi->channels = g_slist_append(sdi->channels, ch);
467 devc->channel_status[cnt].info = g_slist_append(NULL, ch);
469 cg = g_malloc(sizeof(struct sr_channel_group));
470 snprintf(channel, sizeof(channel), "CG%d", cnt+1);
471 cg->name = g_strdup(channel);
473 cg->channels = g_slist_append(NULL, ch);
475 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
478 drvc->instances = g_slist_append(drvc->instances, sdi);
479 devices = g_slist_append(devices, sdi);
482 if (lps_query_status(sdi) != SR_OK)
485 serial_close(serial);
487 sr_serial_dev_inst_free(serial);
492 sr_info("%s: Error!", __func__);
495 serial_close(serial);
496 sr_serial_dev_inst_free(serial);
501 sr_dev_inst_free(sdi);
506 /** Scan for LPS-301 device. */
507 static GSList *scan_lps301(GSList *options)
509 return do_scan(LPS_301, &motech_lps_301_driver_info, options);
512 static GSList *doDevList(struct sr_dev_driver *drv)
514 return ((struct drv_context *)(drv->priv))->instances;
517 static GSList *dev_list_lps301(void)
519 return doDevList(&motech_lps_301_driver_info);
522 static void dev_clear_private(struct dev_context* devc)
526 /* Free channel_status.info (list only, data owned by sdi). */
527 for (ch_idx = 0; ch_idx < devc->model->num_channels; ch_idx++)
528 g_slist_free(devc->channel_status[ch_idx].info);
530 g_timer_destroy(devc->elapsed_msec);
533 static int dev_clear_lps301(void)
535 return std_dev_clear(&motech_lps_301_driver_info, (std_dev_clear_callback)dev_clear_private);
538 static int cleanup(void)
540 return dev_clear_lps301();
543 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
544 const struct sr_channel_group *cg)
546 struct dev_context *devc;
547 struct sr_channel *ch;
556 /* No channel group: global options. */
558 case SR_CONF_LIMIT_SAMPLES:
559 *data = g_variant_new_uint64(devc->limit_samples);
561 case SR_CONF_LIMIT_MSEC:
562 *data = g_variant_new_uint64(devc->limit_msec);
564 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
565 *data = g_variant_new_string(channel_modes[devc->tracking_mode]);
571 /* We only ever have one channel per channel group in this driver. */
572 ch = cg->channels->data;
575 case SR_CONF_OUTPUT_VOLTAGE:
576 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_last);
578 case SR_CONF_OUTPUT_VOLTAGE_MAX:
579 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_max);
581 case SR_CONF_OUTPUT_CURRENT:
582 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_last);
584 case SR_CONF_OUTPUT_CURRENT_MAX:
585 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_max);
587 case SR_CONF_OUTPUT_ENABLED:
588 *data = g_variant_new_boolean(devc->channel_status[ch_idx].output_enabled);
598 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
599 const struct sr_channel_group *cg)
601 struct dev_context *devc;
602 struct sr_channel *ch;
610 if (sdi->status != SR_ST_ACTIVE)
611 return SR_ERR_DEV_CLOSED;
615 /* Cannot change settings while acquisition active, would cause a mess with commands.
616 * Changing this would be possible, but tricky. */
617 if (devc->acq_running)
621 /* No channel group: global options. */
623 case SR_CONF_LIMIT_MSEC:
624 if (g_variant_get_uint64(data) == 0) {
625 sr_err("LIMIT_MSEC can't be 0.");
628 devc->limit_msec = g_variant_get_uint64(data);
629 sr_dbg("Setting time limit to %" PRIu64 "ms.",
632 case SR_CONF_LIMIT_SAMPLES:
633 devc->limit_samples = g_variant_get_uint64(data);
634 sr_dbg("Setting sample limit to %" PRIu64 ".",
635 devc->limit_samples);
637 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
638 sval = g_variant_get_string(data, NULL);
640 for (idx = 0; idx < (int)ARRAY_SIZE(channel_modes); idx++)
642 if (!strcmp(sval, channel_modes[idx])) {
644 if (devc->tracking_mode == idx)
645 break; /* Nothing to do! */
646 devc->tracking_mode = idx;
647 if (devc->model->modelid >= LPS_304) /* No use to set anything in the smaller models. */
648 return lps_cmd_ok(sdi->conn, "TRACK%1d", devc->tracking_mode);
650 if (devc->model->modelid <= LPS_303) /* Only first setting possible for smaller models. */
661 /* Channel group specified: per-channel options. */
662 /* We only ever have one channel per channel group in this driver. */
663 ch = cg->channels->data;
667 case SR_CONF_OUTPUT_VOLTAGE_MAX:
668 dval = g_variant_get_double(data);
669 if (dval < 0 || dval > devc->model->channels[ch_idx].voltage[1])
672 if (devc->model->modelid < LPS_304)
675 if (fabs(dval - 5.000) <= 0.001)
677 else if ((devc->model->modelid >= LPS_305) && (fabs(dval - 3.300) <= 0.001))
679 else return SR_ERR_ARG;
682 devc->channel_status[ch_idx].output_voltage_max = dval;
684 return lps_cmd_ok(sdi->conn, "VDD%1.0f", trunc(dval));
686 return lps_cmd_ok(sdi->conn, "VSET%d %05.3f", ch_idx+1, dval);
688 case SR_CONF_OUTPUT_CURRENT_MAX:
689 dval = g_variant_get_double(data);
690 if (dval < 0 || dval > devc->model->channels[ch_idx].current[1])
692 if (ch_idx == 2) /* No current setting for CH3. */
694 devc->channel_status[ch_idx].output_current_max = dval;
695 return lps_cmd_ok(sdi->conn, "ISET%d %05.4f", ch_idx+1, dval);
697 case SR_CONF_OUTPUT_ENABLED:
698 bval = g_variant_get_boolean(data);
699 if (bval == devc->channel_status[ch_idx].output_enabled) /* Nothing to do. */
701 devc->channel_status[ch_idx].output_enabled = bval;
702 if (ch_idx != 2) { /* Channels 1,2 can be set only together. */
703 devc->channel_status[ch_idx^1].output_enabled = bval;
704 return lps_cmd_ok(sdi->conn, "OUT%1d", (int)bval);
705 } else { /* Channel 3: No command to disable output, set voltage to 0 instead. */
707 return lps_cmd_ok(sdi->conn, "VDD%1.0f", devc->channel_status[ch_idx].output_voltage_max);
709 return lps_cmd_ok(sdi->conn, "VDD0");
720 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
721 const struct sr_channel_group *cg)
723 struct dev_context *devc;
724 struct sr_channel *ch;
731 /* Driver options, no device instance necessary. */
733 case SR_CONF_SCAN_OPTIONS:
734 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
735 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
744 /* Device options, independant from channel groups. */
747 case SR_CONF_DEVICE_OPTIONS:
748 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
749 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
751 case SR_CONF_OUTPUT_CHANNEL_CONFIG:
752 if (devc->model->modelid <= LPS_303) {
753 /* The 1-channel models. */
754 *data = g_variant_new_strv(channel_modes, 1);
756 /* The other models support all modes. */
757 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
766 /* Device options, depending on channel groups. */
767 ch = cg->channels->data;
770 case SR_CONF_DEVICE_OPTIONS:
771 if ((ch_idx == 0) || (ch_idx == 1)) /* CH1, CH2 */
772 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
773 hwcaps_ch12, ARRAY_SIZE(hwcaps_ch12), sizeof(int32_t));
774 else /* Must be CH3 */
775 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
776 hwcaps_ch3, ARRAY_SIZE(hwcaps_ch3), sizeof(int32_t));
778 case SR_CONF_OUTPUT_VOLTAGE_MAX:
779 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
780 /* Min, max, step. */
781 for (i = 0; i < 3; i++) {
782 gvar = g_variant_new_double(devc->model->channels[ch_idx].voltage[i]);
783 g_variant_builder_add_value(&gvb, gvar);
785 *data = g_variant_builder_end(&gvb);
787 case SR_CONF_OUTPUT_CURRENT_MAX:
788 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
789 /* Min, max, step. */
790 for (i = 0; i < 3; i++) {
791 gvar = g_variant_new_double(devc->model->channels[ch_idx].current[i]);
792 g_variant_builder_add_value(&gvb, gvar);
794 *data = g_variant_builder_end(&gvb);
803 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
806 struct dev_context *devc;
807 struct sr_serial_dev_inst *serial;
809 if (sdi->status != SR_ST_ACTIVE)
810 return SR_ERR_DEV_CLOSED;
814 devc->acq_running = TRUE;
817 serial_source_add(sdi->session, serial, G_IO_IN, 50,
818 motech_lps_30x_receive_data, (void *)sdi);
819 std_session_send_df_header(cb_data, LOG_PREFIX);
821 /* Start timer, if required. */
822 if (devc->limit_msec)
823 g_timer_start(devc->elapsed_msec);
825 devc->acq_req = AQ_NONE;
826 /* Do not start polling device here, the read function will do it in 50 ms. */
831 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
833 struct dev_context *devc;
835 /* Stop timer, if required. */
836 if (sdi && (devc = sdi->priv) && devc->limit_msec)
837 g_timer_stop(devc->elapsed_msec);
839 return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
840 sdi->conn, LOG_PREFIX);
843 SR_PRIV struct sr_dev_driver motech_lps_301_driver_info = {
844 .name = "motech-lps-301",
845 .longname = "Motech LPS-301",
850 .dev_list = dev_list_lps301,
851 .dev_clear = dev_clear_lps301,
852 .config_get = config_get,
853 .config_set = config_set,
854 .config_list = config_list,
855 .dev_open = std_serial_dev_open,
856 .dev_close = std_serial_dev_close,
857 .dev_acquisition_start = dev_acquisition_start,
858 .dev_acquisition_stop = dev_acquisition_stop,