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 /* Forward declarations */
32 SR_PRIV struct sr_dev_driver motech_lps_301_driver_info;
33 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen);
34 SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char* fmt, va_list args);
35 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char* fmt, ...);
36 SR_PRIV int lps_cmd_reply(char* reply, struct sr_serial_dev_inst *serial, const char* fmt, ...);
37 SR_PRIV int lps_query_status(struct sr_dev_inst* sdi);
39 /* Serial communication parameters */
40 #define SERIALCOMM "2400/8n1/dtr=1/rts=1/flow=0"
42 #define VENDOR_MOTECH "Motech"
44 /** Driver capabilities generic. */
45 static const uint32_t drvopts[] = {
50 /** Driver scanning options. */
51 static const uint32_t scanopts[] = {
56 /** Hardware capabilities generic. */
57 static const uint32_t devopts[] = {
60 /* Acquisition modes. */
62 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
63 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
64 /* Device configuration */
65 SR_CONF_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
68 /** Hardware capabilities channel 1, 2. */
69 static const uint32_t devopts_ch12[] = {
70 SR_CONF_VOLTAGE | SR_CONF_GET,
71 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
72 SR_CONF_CURRENT | SR_CONF_GET,
73 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
74 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
77 /** Hardware capabilities channel 3. (LPS-304/305 only). */
78 static const uint32_t devopts_ch3[] = {
79 SR_CONF_VOLTAGE | SR_CONF_GET,
80 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
83 static const char *channel_modes[] = {
89 static const struct lps_modelspec models[] = {
90 { LPS_UNKNOWN, "Dummy", 0,
95 { LPS_301, "LPS-301", 1,
98 { { 0, 32, 0.01 }, { 0.005, 2, 0.001 } },
101 { LPS_302, "LPS-302", 1,
104 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
107 { LPS_303, "LPS-303", 1,
110 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
113 { LPS_304, "LPS-304", 3,
116 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
118 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
120 { { 5, 5, 0.0 }, { 0.005, 3, 0.001 } },
123 { LPS_305, "LPS-305", 3,
126 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
128 { { 0, 32, 0.01 }, { 0.005, 3, 0.001 } },
130 { { 3.3, 5, 1.7 }, { 0.005, 3, 0.001 } },
135 static int init_lps301(struct sr_dev_driver *di, struct sr_context *sr_ctx)
137 return std_init(sr_ctx, di, LOG_PREFIX);
140 /** Send command to device with va_list.
142 SR_PRIV int lps_send_va(struct sr_serial_dev_inst *serial, const char* fmt, va_list args)
145 char auxfmt[LINELEN_MAX];
146 char buf[LINELEN_MAX];
148 snprintf(auxfmt, sizeof(auxfmt), "%s\r\n", fmt);
149 vsnprintf(buf, sizeof(buf), auxfmt, args);
151 sr_spew("lps_send_va: \"%s\"", buf);
153 retc = serial_write_blocking(serial, buf, strlen(buf), 0);
161 /** Send command to device.
163 SR_PRIV int lps_send_req(struct sr_serial_dev_inst *serial, const char* fmt, ...)
169 retc = lps_send_va(serial, fmt, args);
175 /** Send command and consume simple OK reply. */
176 SR_PRIV int lps_cmd_ok(struct sr_serial_dev_inst *serial, const char* fmt, ...)
180 char buf[LINELEN_MAX];
186 retc = lps_send_va(serial, fmt, args);
195 buflen = sizeof(buf);
196 retc = lps_read_reply(serial, &bufptr, &buflen);
197 if ((retc == SR_OK) && (buflen == 0))
203 /** Send command and read reply string.
204 * @param reply Pointer to buffer of size LINELEN_MAX. Will be NUL-terminated.
206 SR_PRIV int lps_cmd_reply(char* reply, struct sr_serial_dev_inst *serial, const char* fmt, ...)
210 char buf[LINELEN_MAX];
218 retc = lps_send_va(serial, fmt, args);
227 buflen = sizeof(buf);
228 retc = lps_read_reply(serial, &bufptr, &buflen);
229 if ((retc == SR_OK) && (buflen > 0)) {
237 /** Process integer value returned by STATUS command. */
238 SR_PRIV int lps_process_status(struct sr_dev_inst* sdi, int stat)
240 struct dev_context* devc;
243 devc = (struct dev_context*)sdi->priv;
245 sr_spew("Status: %d", stat);
246 devc->channel_status[0].cc_mode = (stat & 0x01) != 0;
247 sr_spew("Channel 1 %s mode", devc->channel_status[0].cc_mode?"CC":"CV");
248 if (devc->model->num_channels > 1) {
249 devc->channel_status[1].cc_mode = (stat & 0x02) != 0;
250 sr_spew("Channel 2 %s mode", devc->channel_status[1].cc_mode?"CC":"CV");
252 tracking_mode = (stat & 0x0c) >> 2;
253 switch (tracking_mode) {
254 case 0: devc->tracking_mode = 0;
256 case 2: devc->tracking_mode = 1;
258 case 3: devc->tracking_mode = 2;
261 sr_err("Illegal channel tracking mode %d!", tracking_mode);
262 devc->tracking_mode = 0;
266 sr_spew("Channel tracking: %d", devc->tracking_mode);
268 devc->channel_status[0].output_enabled = devc->channel_status[1].output_enabled = stat&0x040?TRUE:FALSE;
269 sr_spew("Channel 1%s output: %s", devc->model->num_channels > 1?"+2":"", devc->channel_status[0].output_enabled?"ON":"OFF");
270 if (devc->model->num_channels > 2) {
271 devc->channel_status[2].output_enabled = stat&0x010?TRUE:FALSE;
272 devc->channel_status[2].output_voltage_last = stat&0x020?3.3:5;
273 sr_spew("Channel 3 output: %s, U=%02f V, overload=%d",
274 devc->channel_status[2].output_enabled?"ON":"OFF",
275 devc->channel_status[2].output_voltage_last,
278 sr_spew("Fan=%d, beep=%d, CC output compensated=%d", stat&0x0100?1:0, stat&0x0200?1:0, stat&0x0400?1:0);
283 /** Send STATUS commend and process status string. */
284 SR_PRIV int lps_query_status(struct sr_dev_inst* sdi)
286 char buf[LINELEN_MAX];
288 struct dev_context* devc;
290 devc = (struct dev_context*)sdi->priv;
292 devc->req_sent_at = g_get_real_time();
294 if ((ret = lps_cmd_reply(buf, sdi->conn, "STATUS")) < 0) {
295 sr_err("%s: Failed to read status: %s.", __func__,
300 if (sr_atoi(buf, &stat) != SR_OK)
303 return lps_process_status(sdi, stat);
306 static gint64 calc_timeout_ms(gint64 start_us)
308 gint64 result = REQ_TIMEOUT_MS - ((g_get_real_time() - start_us) / 1000);
316 /** Read message into buf until "OK" received.
317 * @retval SR_OK Msg received; buf and buflen contain result, if any except OK.
318 * @retval SR_ERR Error, including timeout.
320 SR_PRIV int lps_read_reply(struct sr_serial_dev_inst *serial, char **buf, int *buflen)
323 char buf2[LINELEN_MAX];
326 gint64 timeout_start;
330 /* Read one line. It is either a data message or "OK". */
331 timeout_start = g_get_real_time();
333 /* Up to 5 tries because serial_readline() will consume only one CR or LF per
334 * call, but device sends up to 4 in a row. */
335 for (retries = 0; retries < 5; retries++) {
337 if (serial_readline(serial, buf, buflen, calc_timeout_ms(timeout_start)) != SR_OK)
339 if (!strcmp(*buf, "OK")) { /* We got an OK! */
344 if (*buflen > 0) /* We got a msg! */
348 /* A data msg is in buf (possibly ERROR), need to consume "OK". */
351 for (retries = 0; retries < 5; retries++) {
352 buf2len = sizeof(buf2);
353 if (serial_readline(serial, &buf2ptr, &buf2len, calc_timeout_ms(timeout_start)) != SR_OK)
356 if (!strcmp(buf2ptr, "OK")) { /* We got an OK! */
357 if (!strcmp(*buf, "ERROR")) { /* OK came after msg ERROR! */
358 sr_spew("ERROR found!");
367 return SR_ERR; /* Timeout! */
370 /** Scan for LPS-300 series device.
372 static GSList *do_scan(lps_modelid modelid, struct sr_dev_driver *drv, GSList *options)
374 struct sr_dev_inst *sdi;
375 struct drv_context *drvc;
376 struct dev_context *devc;
377 struct sr_serial_dev_inst *serial;
378 struct sr_channel *ch;
379 struct sr_channel_group *cg;
381 const char *conn, *serialcomm;
383 gchar buf[LINELEN_MAX];
389 conn = serialcomm = NULL;
393 drvc->instances = NULL;
395 sr_spew("scan() called!");
397 /* Process and check options. */
398 if (sr_serial_extract_options(options, &conn, &serialcomm) != SR_OK)
401 serialcomm = SERIALCOMM;
403 /* Init serial port. */
404 serial = sr_serial_dev_inst_new(conn, serialcomm);
406 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
409 /* Query and verify model string. */
410 serial_flush(serial);
411 if (lps_cmd_reply(buf, serial, "MODEL") != SR_OK)
414 /* Check model string. */
415 if (strncmp(buf, "LPS-", 4)) {
416 sr_spew("Unknown model code \"%s\"!", buf);
420 /* Bug in device FW 1.17, model number is empty, so this can't work with this FW! */
421 if (modelid == LPS_UNKNOWN) {
423 for (cnt = LPS_301; cnt <= LPS_305; cnt++) {
424 if (!strcmp(buf, models[cnt].modelstr)) {
429 if (modelid == LPS_UNKNOWN) {
430 sr_err("Unable to detect model from model string '%s'!", buf);
437 if ((ret = lps_cmd_reply(buf, serial, "VERSION")) == SR_OK) {
438 if (strncmp(buf, "Ver-", 4)) {
439 sr_spew("Version string %s not recognized.", buf);
446 else /* Bug in device FW 1.17: Querying version string fails while output is active.
447 Therefore just print an error message, but do not exit with error. */
448 sr_err("Failed to query for hardware version: %s.",
451 sdi = g_malloc0(sizeof(struct sr_dev_inst));
452 sdi->status = SR_ST_INACTIVE;
453 sdi->vendor = g_strdup(VENDOR_MOTECH);
454 sdi->model = g_strdup(models[modelid].modelstr);
455 sdi->version = g_strdup(verstr);
457 sdi->inst_type = SR_INST_SERIAL;
460 devc = g_malloc0(sizeof(struct dev_context));
461 devc->model = &models[modelid];
462 devc->limit_samples = 0;
463 devc->limit_msec = 0;
464 devc->num_samples = 0;
465 devc->elapsed_msec = g_timer_new();
469 /* Setup channels and channel groups. */
470 for (cnt = 0; cnt < models[modelid].num_channels; cnt++) {
471 snprintf(channel, sizeof(channel), "CH%d", cnt + 1);
472 ch = sr_channel_new(sdi, cnt, SR_CHANNEL_ANALOG, TRUE, channel);
474 devc->channel_status[cnt].info = g_slist_append(NULL, ch);
476 cg = g_malloc(sizeof(struct sr_channel_group));
477 snprintf(channel, sizeof(channel), "CG%d", cnt+1);
478 cg->name = g_strdup(channel);
480 cg->channels = g_slist_append(NULL, ch);
482 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
485 drvc->instances = g_slist_append(drvc->instances, sdi);
486 devices = g_slist_append(devices, sdi);
489 if (lps_query_status(sdi) != SR_OK)
492 serial_close(serial);
494 sr_serial_dev_inst_free(serial);
499 sr_info("%s: Error!", __func__);
502 serial_close(serial);
503 sr_serial_dev_inst_free(serial);
507 sr_dev_inst_free(sdi);
512 /** Scan for LPS-301 device. */
513 static GSList *scan_lps301(struct sr_dev_driver *di, GSList *options)
515 return do_scan(LPS_301, di, options);
518 static GSList *dev_list_lps301(const struct sr_dev_driver *di)
520 return ((struct drv_context *)(di->context))->instances;
523 static void dev_clear_private(struct dev_context* devc)
527 /* Free channel_status.info (list only, data owned by sdi). */
528 for (ch_idx = 0; ch_idx < devc->model->num_channels; ch_idx++)
529 g_slist_free(devc->channel_status[ch_idx].info);
531 g_timer_destroy(devc->elapsed_msec);
534 static int dev_clear_lps301(const struct sr_dev_driver *di)
536 return std_dev_clear(di, (std_dev_clear_callback)dev_clear_private);
539 static int cleanup(const struct sr_dev_driver *di)
541 return dev_clear_lps301(di);
544 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
545 const struct sr_channel_group *cg)
547 struct dev_context *devc;
548 struct sr_channel *ch;
557 /* No channel group: global options. */
559 case SR_CONF_LIMIT_SAMPLES:
560 *data = g_variant_new_uint64(devc->limit_samples);
562 case SR_CONF_LIMIT_MSEC:
563 *data = g_variant_new_uint64(devc->limit_msec);
565 case SR_CONF_CHANNEL_CONFIG:
566 *data = g_variant_new_string(channel_modes[devc->tracking_mode]);
572 /* We only ever have one channel per channel group in this driver. */
573 ch = cg->channels->data;
576 case SR_CONF_VOLTAGE:
577 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_last);
579 case SR_CONF_VOLTAGE_TARGET:
580 *data = g_variant_new_double(devc->channel_status[ch_idx].output_voltage_max);
582 case SR_CONF_CURRENT:
583 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_last);
585 case SR_CONF_CURRENT_LIMIT:
586 *data = g_variant_new_double(devc->channel_status[ch_idx].output_current_max);
588 case SR_CONF_ENABLED:
589 *data = g_variant_new_boolean(devc->channel_status[ch_idx].output_enabled);
599 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
600 const struct sr_channel_group *cg)
602 struct dev_context *devc;
603 struct sr_channel *ch;
611 if (sdi->status != SR_ST_ACTIVE)
612 return SR_ERR_DEV_CLOSED;
616 /* Cannot change settings while acquisition active, would cause a mess with commands.
617 * Changing this would be possible, but tricky. */
618 if (devc->acq_running)
622 /* No channel group: global options. */
624 case SR_CONF_LIMIT_MSEC:
625 devc->limit_msec = g_variant_get_uint64(data);
627 case SR_CONF_LIMIT_SAMPLES:
628 devc->limit_samples = g_variant_get_uint64(data);
630 case SR_CONF_CHANNEL_CONFIG:
631 sval = g_variant_get_string(data, NULL);
633 for (idx = 0; idx < (int)ARRAY_SIZE(channel_modes); idx++) {
634 if (!strcmp(sval, channel_modes[idx])) {
636 if (devc->tracking_mode == idx)
637 break; /* Nothing to do! */
638 devc->tracking_mode = idx;
639 if (devc->model->modelid >= LPS_304) /* No use to set anything in the smaller models. */
640 return lps_cmd_ok(sdi->conn, "TRACK%1d", devc->tracking_mode);
642 if (devc->model->modelid <= LPS_303) /* Only first setting possible for smaller models. */
652 /* Channel group specified: per-channel options. */
653 /* We only ever have one channel per channel group in this driver. */
654 ch = cg->channels->data;
658 case SR_CONF_VOLTAGE_TARGET:
659 dval = g_variant_get_double(data);
660 if (dval < 0 || dval > devc->model->channels[ch_idx].voltage[1])
663 if (devc->model->modelid < LPS_304)
666 if (fabs(dval - 5.000) <= 0.001)
668 else if ((devc->model->modelid >= LPS_305) && (fabs(dval - 3.300) <= 0.001))
670 else return SR_ERR_ARG;
673 devc->channel_status[ch_idx].output_voltage_max = dval;
675 return lps_cmd_ok(sdi->conn, "VDD%1.0f", trunc(dval));
677 return lps_cmd_ok(sdi->conn, "VSET%d %05.3f", ch_idx+1, dval);
679 case SR_CONF_CURRENT_LIMIT:
680 dval = g_variant_get_double(data);
681 if (dval < 0 || dval > devc->model->channels[ch_idx].current[1])
683 if (ch_idx == 2) /* No current setting for CH3. */
685 devc->channel_status[ch_idx].output_current_max = dval;
686 return lps_cmd_ok(sdi->conn, "ISET%d %05.4f", ch_idx+1, dval);
688 case SR_CONF_ENABLED:
689 bval = g_variant_get_boolean(data);
690 if (bval == devc->channel_status[ch_idx].output_enabled) /* Nothing to do. */
692 devc->channel_status[ch_idx].output_enabled = bval;
693 if (ch_idx != 2) { /* Channels 1,2 can be set only together. */
694 devc->channel_status[ch_idx^1].output_enabled = bval;
695 return lps_cmd_ok(sdi->conn, "OUT%1d", (int)bval);
696 } else { /* Channel 3: No command to disable output, set voltage to 0 instead. */
698 return lps_cmd_ok(sdi->conn, "VDD%1.0f", devc->channel_status[ch_idx].output_voltage_max);
700 return lps_cmd_ok(sdi->conn, "VDD0");
711 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
712 const struct sr_channel_group *cg)
714 struct dev_context *devc;
715 struct sr_channel *ch;
720 /* Driver options, no device instance necessary. */
722 case SR_CONF_SCAN_OPTIONS:
723 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
724 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
726 case SR_CONF_DEVICE_OPTIONS:
729 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
730 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
739 /* Device options, independent from channel groups. */
742 case SR_CONF_DEVICE_OPTIONS:
743 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
744 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
746 case SR_CONF_CHANNEL_CONFIG:
747 if (devc->model->modelid <= LPS_303) {
748 /* The 1-channel models. */
749 *data = g_variant_new_strv(channel_modes, 1);
751 /* The other models support all modes. */
752 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
760 /* Device options, depending on channel groups. */
761 ch = cg->channels->data;
764 case SR_CONF_DEVICE_OPTIONS:
765 if ((ch_idx == 0) || (ch_idx == 1)) /* CH1, CH2 */
766 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
767 devopts_ch12, ARRAY_SIZE(devopts_ch12), sizeof(uint32_t));
768 else /* Must be CH3 */
769 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
770 devopts_ch3, ARRAY_SIZE(devopts_ch3), sizeof(uint32_t));
772 case SR_CONF_VOLTAGE_TARGET:
773 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
774 /* Min, max, step. */
775 for (i = 0; i < 3; i++) {
776 gvar = g_variant_new_double(devc->model->channels[ch_idx].voltage[i]);
777 g_variant_builder_add_value(&gvb, gvar);
779 *data = g_variant_builder_end(&gvb);
781 case SR_CONF_CURRENT_LIMIT:
782 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
783 /* Min, max, step. */
784 for (i = 0; i < 3; i++) {
785 gvar = g_variant_new_double(devc->model->channels[ch_idx].current[i]);
786 g_variant_builder_add_value(&gvb, gvar);
788 *data = g_variant_builder_end(&gvb);
797 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
800 struct dev_context *devc;
801 struct sr_serial_dev_inst *serial;
803 if (sdi->status != SR_ST_ACTIVE)
804 return SR_ERR_DEV_CLOSED;
808 devc->acq_running = TRUE;
811 serial_source_add(sdi->session, serial, G_IO_IN, 50,
812 motech_lps_30x_receive_data, (void *)sdi);
813 std_session_send_df_header(cb_data, LOG_PREFIX);
815 /* Start timer, if required. */
816 if (devc->limit_msec)
817 g_timer_start(devc->elapsed_msec);
819 devc->acq_req = AQ_NONE;
820 /* Do not start polling device here, the read function will do it in 50 ms. */
825 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
827 struct dev_context *devc;
829 /* Stop timer, if required. */
830 if (sdi && (devc = sdi->priv) && devc->limit_msec)
831 g_timer_stop(devc->elapsed_msec);
833 return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
834 sdi->conn, LOG_PREFIX);
837 SR_PRIV struct sr_dev_driver motech_lps_301_driver_info = {
838 .name = "motech-lps-301",
839 .longname = "Motech LPS-301",
844 .dev_list = dev_list_lps301,
845 .dev_clear = dev_clear_lps301,
846 .config_get = config_get,
847 .config_set = config_set,
848 .config_list = config_list,
849 .dev_open = std_serial_dev_open,
850 .dev_close = std_serial_dev_close,
851 .dev_acquisition_start = dev_acquisition_start,
852 .dev_acquisition_stop = dev_acquisition_stop,