*
* Copyright (C) 2018 James Churchill <pelrun@gmail.com>
* Copyright (C) 2019 Frank Stettner <frank-stettner@gmx.net>
+ * Copyright (C) 2021 Gerhard Sittig <gerhard.sittig@gmx.net>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*/
#include <config.h>
+
+#include <string.h>
+
#include "protocol.h"
-SR_PRIV int rdtech_dps_read_holding_registers(struct sr_modbus_dev_inst *modbus,
- int address, int nb_registers, uint16_t *registers)
+enum rdtech_dps_register {
+ REG_USET = 0x00, /* Mirror of 0x50 */
+ REG_ISET = 0x01, /* Mirror of 0x51 */
+ REG_UOUT = 0x02,
+ REG_IOUT = 0x03,
+ REG_POWER = 0x04,
+ REG_UIN = 0x05,
+ REG_LOCK = 0x06,
+ REG_PROTECT = 0x07,
+ REG_CV_CC = 0x08,
+ REG_ENABLE = 0x09,
+ REG_BACKLIGHT = 0x0A, /* Mirror of 0x55 */
+ REG_MODEL = 0x0B,
+ REG_VERSION = 0x0C,
+
+ REG_PRESET = 0x23, /* Loads a preset into preset 0. */
+
+ /*
+ * Add (preset * 0x10) to each of the following, for preset 1-9.
+ * Preset 0 regs below are the active output settings.
+ */
+ PRE_USET = 0x50,
+ PRE_ISET = 0x51,
+ PRE_OVPSET = 0x52,
+ PRE_OCPSET = 0x53,
+ PRE_OPPSET = 0x54,
+ PRE_BACKLIGHT = 0x55,
+ PRE_DISABLE = 0x56, /* Disable output if 0 is copied here from a preset (1 is no change). */
+ PRE_BOOT = 0x57, /* Enable output at boot if 1. */
+};
+#define REG_PRESET_STRIDE 0x10
+
+enum rdtech_dps_protect_state {
+ STATE_NORMAL = 0,
+ STATE_OVP = 1,
+ STATE_OCP = 2,
+ STATE_OPP = 3,
+};
+
+enum rdtech_dps_regulation_mode {
+ MODE_CV = 0,
+ MODE_CC = 1,
+};
+
+/* Retries failed modbus read attempts for improved reliability. */
+static int rdtech_dps_read_holding_registers(struct sr_modbus_dev_inst *modbus,
+ int address, int nb_registers, uint16_t *registers)
{
- int i, ret;
+ size_t retries;
+ int ret;
- i = 0;
- do {
+ retries = 3;
+ while (retries--) {
ret = sr_modbus_read_holding_registers(modbus,
address, nb_registers, registers);
- ++i;
- } while (ret != SR_OK && i < 3);
+ if (ret == SR_OK)
+ return ret;
+ }
return ret;
}
-SR_PRIV int rdtech_dps_get_reg(const struct sr_dev_inst *sdi,
- uint16_t address, uint16_t *value)
+/* Get one 16bit register. */
+static int rdtech_dps_get_reg(const struct sr_dev_inst *sdi,
+ uint16_t address, uint16_t *value)
{
struct dev_context *devc;
struct sr_modbus_dev_inst *modbus;
uint16_t registers[1];
int ret;
+ const uint8_t *rdptr;
devc = sdi->priv;
modbus = sdi->conn;
g_mutex_lock(&devc->rw_mutex);
- ret = rdtech_dps_read_holding_registers(modbus, address, 1, registers);
+ ret = rdtech_dps_read_holding_registers(modbus,
+ address, ARRAY_SIZE(registers), registers);
g_mutex_unlock(&devc->rw_mutex);
- *value = RB16(registers + 0);
+
+ rdptr = (void *)registers;
+ *value = read_u16le(rdptr);
+
return ret;
}
-SR_PRIV int rdtech_dps_set_reg(const struct sr_dev_inst *sdi,
- uint16_t address, uint16_t value)
+/* Set one 16bit register. */
+static int rdtech_dps_set_reg(const struct sr_dev_inst *sdi,
+ uint16_t address, uint16_t value)
{
struct dev_context *devc;
struct sr_modbus_dev_inst *modbus;
uint16_t registers[1];
int ret;
+ uint8_t *wrptr;
devc = sdi->priv;
modbus = sdi->conn;
- WB16(registers, value);
+ wrptr = (void *)registers;
+ write_u16le(wrptr, value);
+
g_mutex_lock(&devc->rw_mutex);
- ret = sr_modbus_write_multiple_registers(modbus, address, 1, registers);
+ ret = sr_modbus_write_multiple_registers(modbus, address,
+ ARRAY_SIZE(registers), registers);
g_mutex_unlock(&devc->rw_mutex);
+
return ret;
}
+/* Get DPS model number and firmware version from a connected device. */
SR_PRIV int rdtech_dps_get_model_version(struct sr_modbus_dev_inst *modbus,
- uint16_t *model, uint16_t *version)
+ uint16_t *model, uint16_t *version)
{
- uint16_t registers[2];
+ uint16_t registers[REG_VERSION + 1 - REG_MODEL];
int ret;
+ const uint8_t *rdptr;
+
+ /* Silence a compiler warning about an unused routine. */
+ (void)rdtech_dps_get_reg;
/*
- * No mutex here, because there is no sr_dev_inst when this function
- * is called.
+ * Get the MODEL and VERSION registers. No mutex here, because
+ * there is no sr_dev_inst when this function is called.
*/
- ret = rdtech_dps_read_holding_registers(modbus, REG_MODEL, 2, registers);
- if (ret == SR_OK) {
- *model = RB16(registers + 0);
- *version = RB16(registers + 1);
- sr_info("RDTech PSU model: %d version: %d", *model, *version);
- }
+ ret = rdtech_dps_read_holding_registers(modbus,
+ REG_MODEL, ARRAY_SIZE(registers), registers);
+ if (ret != SR_OK)
+ return ret;
+
+ rdptr = (void *)registers;
+ *model = read_u16le_inc(&rdptr);
+ *version = read_u16le_inc(&rdptr);
+ sr_info("RDTech DPS PSU model: %u version: %u", *model, *version);
+
return ret;
}
-static void send_value(const struct sr_dev_inst *sdi, struct sr_channel *ch,
- float value, enum sr_mq mq, enum sr_mqflag mqflags,
- enum sr_unit unit, int digits)
+/* Send a measured value to the session feed. */
+static int send_value(const struct sr_dev_inst *sdi,
+ struct sr_channel *ch, float value,
+ enum sr_mq mq, enum sr_mqflag mqflags,
+ enum sr_unit unit, int digits)
{
struct sr_datafeed_packet packet;
struct sr_datafeed_analog analog;
struct sr_analog_encoding encoding;
struct sr_analog_meaning meaning;
struct sr_analog_spec spec;
+ int ret;
sr_analog_init(&analog, &encoding, &meaning, &spec, digits);
analog.meaning->channels = g_slist_append(NULL, ch);
packet.type = SR_DF_ANALOG;
packet.payload = &analog;
- sr_session_send(sdi, &packet);
+ ret = sr_session_send(sdi, &packet);
+
g_slist_free(analog.meaning->channels);
+
+ return ret;
+}
+
+/*
+ * Get the device's current state. Exhaustively, relentlessly.
+ * Concentrate all details of communication in the physical transport,
+ * register layout interpretation, and potential model dependency in
+ * this central spot, to simplify maintenance.
+ *
+ * TODO Optionally limit the transfer volume depending on caller's spec
+ * which detail level is desired? Is 10 registers each 16bits an issue
+ * when the UART bitrate is only 9600bps?
+ */
+SR_PRIV int rdtech_dps_get_state(const struct sr_dev_inst *sdi,
+ struct rdtech_dps_state *state)
+{
+ struct dev_context *devc;
+ struct sr_modbus_dev_inst *modbus;
+ uint16_t registers[REG_ENABLE + 1 - REG_USET];
+ int ret;
+ const uint8_t *rdptr;
+ uint16_t uset_raw, iset_raw, uout_raw, iout_raw, power_raw;
+ uint16_t reg_val, reg_state, out_state, ovpset_raw, ocpset_raw;
+ gboolean is_lock, is_out_enabled, is_reg_cc;
+ gboolean uses_ovp, uses_ocp;
+ float volt_target, curr_limit;
+ float ovp_threshold, ocp_threshold;
+ float curr_voltage, curr_current, curr_power;
+
+ if (!sdi || !sdi->priv || !sdi->conn)
+ return SR_ERR_ARG;
+ devc = sdi->priv;
+ modbus = sdi->conn;
+ if (!state)
+ return SR_ERR_ARG;
+
+ /* Transfer a chunk of registers in a single call. */
+ g_mutex_lock(&devc->rw_mutex);
+ ret = rdtech_dps_read_holding_registers(modbus,
+ REG_USET, ARRAY_SIZE(registers), registers);
+ g_mutex_unlock(&devc->rw_mutex);
+ if (ret != SR_OK)
+ return ret;
+
+ /* Interpret the registers' values. */
+ rdptr = (const void *)registers;
+ uset_raw = read_u16le_inc(&rdptr);
+ volt_target = uset_raw / devc->voltage_multiplier;
+ iset_raw = read_u16le_inc(&rdptr);
+ curr_limit = iset_raw / devc->current_multiplier;
+ uout_raw = read_u16le_inc(&rdptr);
+ curr_voltage = uout_raw / devc->voltage_multiplier;
+ iout_raw = read_u16le_inc(&rdptr);
+ curr_current = iout_raw / devc->current_multiplier;
+ power_raw = read_u16le_inc(&rdptr);
+ curr_power = power_raw / 100.0f;
+ (void)read_u16le_inc(&rdptr); /* UIN */
+ reg_val = read_u16le_inc(&rdptr); /* LOCK */
+ is_lock = reg_val != 0;
+ reg_val = read_u16le_inc(&rdptr); /* PROTECT */
+ uses_ovp = reg_val == STATE_OVP;
+ uses_ocp = reg_val == STATE_OCP;
+ reg_state = read_u16le_inc(&rdptr); /* CV_CC */
+ is_reg_cc = reg_state == MODE_CC;
+ out_state = read_u16le_inc(&rdptr); /* ENABLE */
+ is_out_enabled = out_state != 0;
+
+ /*
+ * Transfer another chunk of registers in a single call.
+ * TODO Unfortunately this call site open codes a fixed number
+ * of registers to read. But there is already some leakage of
+ * the register layout in this routine, and adding more device
+ * types in the future will make things "worse". So accept it.
+ */
+ g_mutex_lock(&devc->rw_mutex);
+ ret = rdtech_dps_read_holding_registers(modbus,
+ PRE_OVPSET, 2, registers);
+ g_mutex_unlock(&devc->rw_mutex);
+ if (ret != SR_OK)
+ return ret;
+
+ /* Interpret the registers' values. */
+ rdptr = (const void *)registers;
+ ovpset_raw = read_u16le_inc(&rdptr); /* PRE OVPSET */
+ ovp_threshold = ovpset_raw * devc->voltage_multiplier;
+ ocpset_raw = read_u16le_inc(&rdptr); /* PRE OCPSET */
+ ocp_threshold = ocpset_raw * devc->current_multiplier;
+
+ /* Store gathered details in the high level container. */
+ memset(state, 0, sizeof(*state));
+ state->lock = is_lock;
+ state->mask |= STATE_LOCK;
+ state->output_enabled = is_out_enabled;
+ state->mask |= STATE_OUTPUT_ENABLED;
+ state->regulation_cc = is_reg_cc;
+ state->mask |= STATE_REGULATION_CC;
+ state->protect_ovp = uses_ovp;
+ state->mask |= STATE_PROTECT_OVP;
+ state->protect_ocp = uses_ocp;
+ state->mask |= STATE_PROTECT_OCP;
+ state->protect_enabled = TRUE;
+ state->mask |= STATE_PROTECT_ENABLED;
+ state->voltage_target = volt_target;
+ state->mask |= STATE_VOLTAGE_TARGET;
+ state->current_limit = curr_limit;
+ state->mask |= STATE_CURRENT_LIMIT;
+ state->ovp_threshold = ovp_threshold;
+ state->mask |= STATE_OVP_THRESHOLD;
+ state->ocp_threshold = ocp_threshold;
+ state->mask |= STATE_OCP_THRESHOLD;
+ state->voltage = curr_voltage;
+ state->mask |= STATE_VOLTAGE;
+ state->current = curr_current;
+ state->mask |= STATE_CURRENT;
+ state->power = curr_power;
+ state->mask |= STATE_POWER;
+
+ return SR_OK;
+}
+
+/* Setup device's parameters. Selectively, from caller specs. */
+SR_PRIV int rdtech_dps_set_state(const struct sr_dev_inst *sdi,
+ struct rdtech_dps_state *state)
+{
+ struct dev_context *devc;
+ uint16_t reg_value;
+ int ret;
+
+ if (!sdi || !sdi->priv || !sdi->conn)
+ return SR_ERR_ARG;
+ devc = sdi->priv;
+ if (!state)
+ return SR_ERR_ARG;
+
+ /* Only a subset of known values is settable. */
+ if (state->mask & STATE_OUTPUT_ENABLED) {
+ reg_value = state->output_enabled ? 1 : 0;
+ ret = rdtech_dps_set_reg(sdi, REG_ENABLE, reg_value);
+ if (ret != SR_OK)
+ return ret;
+ }
+ if (state->mask & STATE_VOLTAGE_TARGET) {
+ reg_value = state->voltage_target * devc->voltage_multiplier;
+ ret = rdtech_dps_set_reg(sdi, REG_USET, reg_value);
+ if (ret != SR_OK)
+ return ret;
+ }
+ if (state->mask & STATE_CURRENT_LIMIT) {
+ reg_value = state->current_limit * devc->current_multiplier;
+ ret = rdtech_dps_set_reg(sdi, REG_ISET, reg_value);
+ if (ret != SR_OK)
+ return ret;
+ }
+ if (state->mask & STATE_OVP_THRESHOLD) {
+ reg_value = state->ovp_threshold * devc->voltage_multiplier;
+ ret = rdtech_dps_set_reg(sdi, PRE_OVPSET, reg_value);
+ if (ret != SR_OK)
+ return ret;
+ }
+ if (state->mask & STATE_OCP_THRESHOLD) {
+ reg_value = state->ocp_threshold * devc->current_multiplier;
+ ret = rdtech_dps_set_reg(sdi, PRE_OCPSET, reg_value);
+ if (ret != SR_OK)
+ return ret;
+ }
+ if (state->mask & STATE_LOCK) {
+ reg_value = state->lock ? 1 : 0;
+ ret = rdtech_dps_set_reg(sdi, REG_LOCK, reg_value);
+ if (ret != SR_OK)
+ return ret;
+ }
+
+ return SR_OK;
}
+/* Get the current state when acquisition starts. */
+SR_PRIV int rdtech_dps_seed_receive(const struct sr_dev_inst *sdi)
+{
+ struct dev_context *devc;
+ struct rdtech_dps_state state;
+ int ret;
+
+ ret = rdtech_dps_get_state(sdi, &state);
+ if (ret != SR_OK)
+ return ret;
+
+ if (state.mask & STATE_PROTECT_OVP)
+ devc->curr_ovp_state = state.protect_ovp;
+ if (state.mask & STATE_PROTECT_OCP)
+ devc->curr_ocp_state = state.protect_ocp;
+ if (state.mask & STATE_REGULATION_CC)
+ devc->curr_cc_state = state.regulation_cc;
+ if (state.mask & STATE_OUTPUT_ENABLED)
+ devc->curr_out_state = state.output_enabled;
+
+ return SR_OK;
+}
+
+/* Get measurements, track state changes during acquisition. */
SR_PRIV int rdtech_dps_receive_data(int fd, int revents, void *cb_data)
{
struct sr_dev_inst *sdi;
struct dev_context *devc;
- struct sr_modbus_dev_inst *modbus;
- uint16_t registers[8];
+ struct rdtech_dps_state state;
int ret;
+ struct sr_channel *ch;
+ const char *regulation_text;
(void)fd;
(void)revents;
- if (!(sdi = cb_data))
+ sdi = cb_data;
+ if (!sdi)
return TRUE;
-
- modbus = sdi->conn;
devc = sdi->priv;
- g_mutex_lock(&devc->rw_mutex);
- /*
- * Using the libsigrok function here, because it doesn't matter if the
- * reading fails. It will be done again in the next acquision cycle anyways.
- */
- ret = sr_modbus_read_holding_registers(modbus, REG_UOUT, 8, registers);
- g_mutex_unlock(&devc->rw_mutex);
+ /* Get the device's current state. */
+ ret = rdtech_dps_get_state(sdi, &state);
+ if (ret != SR_OK)
+ return ret;
- if (ret == SR_OK) {
- /* Send channel values */
- std_session_send_df_frame_begin(sdi);
-
- send_value(sdi, sdi->channels->data,
- RB16(registers + 0) / devc->voltage_multiplier,
- SR_MQ_VOLTAGE, SR_MQFLAG_DC, SR_UNIT_VOLT,
- devc->model->voltage_digits);
- send_value(sdi, sdi->channels->next->data,
- RB16(registers + 1) / devc->current_multiplier,
- SR_MQ_CURRENT, SR_MQFLAG_DC, SR_UNIT_AMPERE,
- devc->model->current_digits);
- send_value(sdi, sdi->channels->next->next->data,
- RB16(registers + 2) / 100.0f,
- SR_MQ_POWER, 0, SR_UNIT_WATT, 2);
-
- std_session_send_df_frame_end(sdi);
-
- /* Check for state changes */
- if (devc->actual_ovp_state != (RB16(registers + 5) == STATE_OVP)) {
- devc->actual_ovp_state = RB16(registers + 5) == STATE_OVP;
- sr_session_send_meta(sdi, SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
- g_variant_new_boolean(devc->actual_ovp_state));
- }
- if (devc->actual_ocp_state != (RB16(registers + 5) == STATE_OCP)) {
- devc->actual_ocp_state = RB16(registers + 5) == STATE_OCP;
- sr_session_send_meta(sdi, SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
- g_variant_new_boolean(devc->actual_ocp_state));
- }
- if (devc->actual_regulation_state != RB16(registers + 6)) {
- devc->actual_regulation_state = RB16(registers + 6);
- sr_session_send_meta(sdi, SR_CONF_REGULATION,
- g_variant_new_string(
- devc->actual_regulation_state == MODE_CC ? "CC" : "CV"));
- }
- if (devc->actual_output_state != RB16(registers + 7)) {
- devc->actual_output_state = RB16(registers + 7);
- sr_session_send_meta(sdi, SR_CONF_ENABLED,
- g_variant_new_boolean(devc->actual_output_state));
- }
-
- sr_sw_limits_update_samples_read(&devc->limits, 1);
+
+ /* Submit measurement data to the session feed. */
+ std_session_send_df_frame_begin(sdi);
+ ch = g_slist_nth_data(sdi->channels, 0);
+ send_value(sdi, ch, state.voltage,
+ SR_MQ_VOLTAGE, SR_MQFLAG_DC, SR_UNIT_VOLT,
+ devc->model->voltage_digits);
+ ch = g_slist_nth_data(sdi->channels, 1);
+ send_value(sdi, ch, state.current,
+ SR_MQ_CURRENT, SR_MQFLAG_DC, SR_UNIT_AMPERE,
+ devc->model->current_digits);
+ ch = g_slist_nth_data(sdi->channels, 2);
+ send_value(sdi, ch, state.power,
+ SR_MQ_POWER, 0, SR_UNIT_WATT, 2);
+ std_session_send_df_frame_end(sdi);
+
+ /* Check for state changes. */
+ if (devc->curr_ovp_state != state.protect_ovp) {
+ (void)sr_session_send_meta(sdi,
+ SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
+ g_variant_new_boolean(state.protect_ovp));
+ devc->curr_ovp_state = state.protect_ovp;
+ }
+ if (devc->curr_ocp_state != state.protect_ocp) {
+ (void)sr_session_send_meta(sdi,
+ SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
+ g_variant_new_boolean(state.protect_ocp));
+ devc->curr_ocp_state = state.protect_ocp;
+ }
+ if (devc->curr_cc_state != state.regulation_cc) {
+ regulation_text = state.regulation_cc ? "CC" : "CV";
+ (void)sr_session_send_meta(sdi, SR_CONF_REGULATION,
+ g_variant_new_string(regulation_text));
+ devc->curr_cc_state = state.regulation_cc;
+ }
+ if (devc->curr_out_state != state.output_enabled) {
+ (void)sr_session_send_meta(sdi, SR_CONF_ENABLED,
+ g_variant_new_boolean(state.output_enabled));
+ devc->curr_out_state = state.output_enabled;
}
+ /* Check optional acquisition limits. */
+ sr_sw_limits_update_samples_read(&devc->limits, 1);
if (sr_sw_limits_check(&devc->limits)) {
sr_dev_acquisition_stop(sdi);
return TRUE;
projects / libsigrok.git / blobdiff