X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fyokogawa-dlm%2Fapi.c;h=f80e83dceb7e91537252d05b37a516e12e225ac3;hb=9417f26fd47556c4b4f6ecaa08a2860672664eb9;hp=614c4a7a0164ac229ced45e3d48afabc73f02e90;hpb=107639373df3d592961eb70111e6f4ccb36f74fa;p=libsigrok.git
diff --git a/src/hardware/yokogawa-dlm/api.c b/src/hardware/yokogawa-dlm/api.c
index 614c4a7a..f80e83dc 100644
--- a/src/hardware/yokogawa-dlm/api.c
+++ b/src/hardware/yokogawa-dlm/api.c
@@ -18,25 +18,546 @@
* along with this program. If not, see .
*/
+#include
#include
+#include "scpi.h"
#include "protocol.h"
+static struct sr_dev_driver yokogawa_dlm_driver_info;
-SR_PRIV struct sr_dev_driver yokogawa_dlm_driver_info = {
+static const char *MANUFACTURER_ID = "YOKOGAWA";
+
+static const uint32_t scanopts[] = {
+ SR_CONF_CONN,
+};
+
+static const uint32_t drvopts[] = {
+ SR_CONF_LOGIC_ANALYZER,
+ SR_CONF_OSCILLOSCOPE,
+};
+
+static const uint32_t devopts[] = {
+ SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
+ SR_CONF_SAMPLERATE | SR_CONF_GET,
+ SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+ SR_CONF_NUM_HDIV | SR_CONF_GET,
+ SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_GET | SR_CONF_SET,
+ SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+ SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+};
+
+static const uint32_t devopts_cg_analog[] = {
+ SR_CONF_NUM_VDIV | SR_CONF_GET,
+ SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+ SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+};
+
+static const uint32_t devopts_cg_digital[] = {
+};
+
+enum {
+ CG_INVALID = -1,
+ CG_NONE,
+ CG_ANALOG,
+ CG_DIGITAL,
+};
+
+static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
+{
+ struct sr_dev_inst *sdi;
+ struct dev_context *devc;
+ struct sr_scpi_hw_info *hw_info;
+ char *model_name;
+ int model_index;
+
+ sdi = NULL;
+ devc = NULL;
+ hw_info = NULL;
+
+ if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
+ sr_info("Couldn't get IDN response.");
+ goto fail;
+ }
+
+ if (strcmp(hw_info->manufacturer, MANUFACTURER_ID) != 0)
+ goto fail;
+
+ if (dlm_model_get(hw_info->model, &model_name, &model_index) != SR_OK)
+ goto fail;
+
+ sdi = g_malloc0(sizeof(struct sr_dev_inst));
+ sdi->vendor = g_strdup("Yokogawa");
+ sdi->model = g_strdup(model_name);
+ sdi->version = g_strdup(hw_info->firmware_version);
+
+ sdi->serial_num = g_strdup(hw_info->serial_number);
+
+ sr_scpi_hw_info_free(hw_info);
+ hw_info = NULL;
+
+ devc = g_malloc0(sizeof(struct dev_context));
+
+ sdi->driver = &yokogawa_dlm_driver_info;
+ sdi->priv = devc;
+ sdi->inst_type = SR_INST_SCPI;
+ sdi->conn = scpi;
+
+ if (dlm_device_init(sdi, model_index) != SR_OK)
+ goto fail;
+
+ return sdi;
+
+fail:
+ sr_scpi_hw_info_free(hw_info);
+ sr_dev_inst_free(sdi);
+ g_free(devc);
+
+ return NULL;
+}
+
+static GSList *scan(struct sr_dev_driver *di, GSList *options)
+{
+ return sr_scpi_scan(di->context, options, probe_device);
+}
+
+static void clear_helper(struct dev_context *devc)
+{
+ dlm_scope_state_destroy(devc->model_state);
+ g_free(devc->analog_groups);
+ g_free(devc->digital_groups);
+}
+
+static int dev_clear(const struct sr_dev_driver *di)
+{
+ return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
+}
+
+static int dev_open(struct sr_dev_inst *sdi)
+{
+ if (sr_scpi_open(sdi->conn) != SR_OK)
+ return SR_ERR;
+
+ if (dlm_scope_state_query(sdi) != SR_OK)
+ return SR_ERR;
+
+ return SR_OK;
+}
+
+static int dev_close(struct sr_dev_inst *sdi)
+{
+ return sr_scpi_close(sdi->conn);
+}
+
+/**
+ * Check which category a given channel group belongs to.
+ *
+ * @param devc Our internal device context.
+ * @param cg The channel group to check.
+ *
+ * @retval CG_NONE cg is NULL
+ * @retval CG_ANALOG cg is an analog group
+ * @retval CG_DIGITAL cg is a digital group
+ * @retval CG_INVALID cg is something else
+ */
+static int check_channel_group(struct dev_context *devc,
+ const struct sr_channel_group *cg)
+{
+ const struct scope_config *model;
+
+ if (!devc)
+ return CG_INVALID;
+ model = devc->model_config;
+
+ if (!cg)
+ return CG_NONE;
+
+ if (std_cg_idx(cg, devc->analog_groups, model->analog_channels) >= 0)
+ return CG_ANALOG;
+
+ if (std_cg_idx(cg, devc->digital_groups, model->pods) >= 0)
+ return CG_DIGITAL;
+
+ sr_err("Invalid channel group specified.");
+
+ return CG_INVALID;
+}
+
+static int config_get(uint32_t key, GVariant **data,
+ const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
+{
+ int ret, cg_type, idx;
+ struct dev_context *devc;
+ const struct scope_config *model;
+ struct scope_state *state;
+
+ if (!sdi)
+ return SR_ERR_ARG;
+
+ devc = sdi->priv;
+
+ if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
+ return SR_ERR;
+
+ model = devc->model_config;
+ state = devc->model_state;
+
+ switch (key) {
+ case SR_CONF_NUM_HDIV:
+ *data = g_variant_new_int32(model->num_xdivs);
+ ret = SR_OK;
+ break;
+ case SR_CONF_TIMEBASE:
+ *data = g_variant_new("(tt)",
+ dlm_timebases[state->timebase][0],
+ dlm_timebases[state->timebase][1]);
+ ret = SR_OK;
+ break;
+ case SR_CONF_NUM_VDIV:
+ if (!cg)
+ return SR_ERR_CHANNEL_GROUP;
+ if (cg_type != CG_ANALOG)
+ return SR_ERR_NA;
+ *data = g_variant_new_int32(model->num_ydivs);
+ ret = SR_OK;
+ break;
+ case SR_CONF_VDIV:
+ if (!cg)
+ return SR_ERR_CHANNEL_GROUP;
+ if (cg_type != CG_ANALOG)
+ return SR_ERR_NA;
+ if ((idx = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
+ return SR_ERR_ARG;
+ *data = g_variant_new("(tt)",
+ dlm_vdivs[state->analog_states[idx].vdiv][0],
+ dlm_vdivs[state->analog_states[idx].vdiv][1]);
+ ret = SR_OK;
+ break;
+ case SR_CONF_TRIGGER_SOURCE:
+ *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
+ ret = SR_OK;
+ break;
+ case SR_CONF_TRIGGER_SLOPE:
+ *data = g_variant_new_string(dlm_trigger_slopes[state->trigger_slope]);
+ ret = SR_OK;
+ break;
+ case SR_CONF_HORIZ_TRIGGERPOS:
+ *data = g_variant_new_double(state->horiz_triggerpos);
+ ret = SR_OK;
+ break;
+ case SR_CONF_COUPLING:
+ if (!cg)
+ return SR_ERR_CHANNEL_GROUP;
+ if (cg_type != CG_ANALOG)
+ return SR_ERR_NA;
+ if ((idx = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
+ return SR_ERR_ARG;
+ *data = g_variant_new_string((*model->coupling_options)[state->analog_states[idx].coupling]);
+ ret = SR_OK;
+ break;
+ case SR_CONF_SAMPLERATE:
+ *data = g_variant_new_uint64(state->sample_rate);
+ ret = SR_OK;
+ break;
+ default:
+ ret = SR_ERR_NA;
+ }
+
+ return ret;
+}
+
+static int config_set(uint32_t key, GVariant *data,
+ const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
+{
+ int ret, cg_type, idx, j;
+ char float_str[30];
+ struct dev_context *devc;
+ const struct scope_config *model;
+ struct scope_state *state;
+ double tmp_d;
+ gboolean update_sample_rate;
+
+ if (!sdi || !(devc = sdi->priv))
+ return SR_ERR_ARG;
+
+ if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
+ return SR_ERR;
+
+ model = devc->model_config;
+ state = devc->model_state;
+ update_sample_rate = FALSE;
+
+ switch (key) {
+ case SR_CONF_LIMIT_FRAMES:
+ devc->frame_limit = g_variant_get_uint64(data);
+ ret = SR_OK;
+ break;
+ case SR_CONF_TRIGGER_SOURCE:
+ if ((idx = std_str_idx(data, *model->trigger_sources, model->num_trigger_sources)) < 0)
+ return SR_ERR_ARG;
+ state->trigger_source = idx;
+ /* TODO: A and B trigger support possible? */
+ ret = dlm_trigger_source_set(sdi->conn, (*model->trigger_sources)[idx]);
+ break;
+ case SR_CONF_VDIV:
+ if (!cg)
+ return SR_ERR_CHANNEL_GROUP;
+ if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(dlm_vdivs))) < 0)
+ return SR_ERR_ARG;
+ if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
+ return SR_ERR_ARG;
+ state->analog_states[j].vdiv = idx;
+ g_ascii_formatd(float_str, sizeof(float_str),
+ "%E", (float) dlm_vdivs[idx][0] / dlm_vdivs[idx][1]);
+ if (dlm_analog_chan_vdiv_set(sdi->conn, j + 1, float_str) != SR_OK ||
+ sr_scpi_get_opc(sdi->conn) != SR_OK)
+ return SR_ERR;
+ ret = SR_OK;
+ break;
+ case SR_CONF_TIMEBASE:
+ if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(dlm_timebases))) < 0)
+ return SR_ERR_ARG;
+ state->timebase = idx;
+ g_ascii_formatd(float_str, sizeof(float_str),
+ "%E", (float) dlm_timebases[idx][0] / dlm_timebases[idx][1]);
+ ret = dlm_timebase_set(sdi->conn, float_str);
+ update_sample_rate = TRUE;
+ break;
+ case SR_CONF_HORIZ_TRIGGERPOS:
+ tmp_d = g_variant_get_double(data);
+
+ /* TODO: Check if the calculation makes sense for the DLM. */
+ if (tmp_d < 0.0 || tmp_d > 1.0)
+ return SR_ERR;
+
+ state->horiz_triggerpos = tmp_d;
+ tmp_d = -(tmp_d - 0.5) *
+ ((double) dlm_timebases[state->timebase][0] /
+ dlm_timebases[state->timebase][1])
+ * model->num_xdivs;
+
+ g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
+ ret = dlm_horiz_trigger_pos_set(sdi->conn, float_str);
+ break;
+ case SR_CONF_TRIGGER_SLOPE:
+ if ((idx = std_str_idx(data, ARRAY_AND_SIZE(dlm_trigger_slopes))) < 0)
+ return SR_ERR_ARG;
+ /* Note: See dlm_trigger_slopes[] in protocol.c. */
+ state->trigger_slope = idx;
+ ret = dlm_trigger_slope_set(sdi->conn, state->trigger_slope);
+ break;
+ case SR_CONF_COUPLING:
+ if (!cg)
+ return SR_ERR_CHANNEL_GROUP;
+ if ((idx = std_str_idx(data, *model->coupling_options, model->num_coupling_options)) < 0)
+ return SR_ERR_ARG;
+ if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
+ return SR_ERR_ARG;
+ state->analog_states[j].coupling = idx;
+ if (dlm_analog_chan_coupl_set(sdi->conn, j + 1, (*model->coupling_options)[idx]) != SR_OK ||
+ sr_scpi_get_opc(sdi->conn) != SR_OK)
+ return SR_ERR;
+ ret = SR_OK;
+ break;
+ default:
+ ret = SR_ERR_NA;
+ break;
+ }
+
+ if (ret == SR_OK)
+ ret = sr_scpi_get_opc(sdi->conn);
+
+ if (ret == SR_OK && update_sample_rate)
+ ret = dlm_sample_rate_query(sdi);
+
+ return ret;
+}
+
+static int config_channel_set(const struct sr_dev_inst *sdi,
+ struct sr_channel *ch, unsigned int changes)
+{
+ /* Currently we only handle SR_CHANNEL_SET_ENABLED. */
+ if (changes != SR_CHANNEL_SET_ENABLED)
+ return SR_ERR_NA;
+
+ return dlm_channel_state_set(sdi, ch->index, ch->enabled);
+}
+
+static int config_list(uint32_t key, GVariant **data,
+ const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
+{
+ int cg_type = CG_NONE;
+ struct dev_context *devc;
+ const struct scope_config *model;
+
+ devc = (sdi) ? sdi->priv : NULL;
+ model = (devc) ? devc->model_config : NULL;
+
+ if (!cg) {
+ switch (key) {
+ case SR_CONF_SCAN_OPTIONS:
+ case SR_CONF_DEVICE_OPTIONS:
+ return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
+ case SR_CONF_TIMEBASE:
+ *data = std_gvar_tuple_array(ARRAY_AND_SIZE(dlm_timebases));
+ return SR_OK;
+ case SR_CONF_TRIGGER_SOURCE:
+ if (!model)
+ return SR_ERR_ARG;
+ *data = g_variant_new_strv(*model->trigger_sources, model->num_trigger_sources);
+ return SR_OK;
+ case SR_CONF_TRIGGER_SLOPE:
+ *data = g_variant_new_strv(ARRAY_AND_SIZE(dlm_trigger_slopes));
+ return SR_OK;
+ case SR_CONF_NUM_HDIV:
+ if (!model)
+ return SR_ERR_ARG;
+ *data = g_variant_new_uint32(model->num_xdivs);
+ return SR_OK;
+ default:
+ return SR_ERR_NA;
+ }
+ }
+
+ if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
+ return SR_ERR;
+
+ switch (key) {
+ case SR_CONF_DEVICE_OPTIONS:
+ if (cg_type == CG_ANALOG)
+ *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog));
+ else if (cg_type == CG_DIGITAL)
+ *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_digital));
+ else
+ *data = std_gvar_array_u32(NULL, 0);
+ break;
+ case SR_CONF_COUPLING:
+ if (!cg)
+ return SR_ERR_CHANNEL_GROUP;
+ *data = g_variant_new_strv(*model->coupling_options, model->num_coupling_options);
+ break;
+ case SR_CONF_VDIV:
+ if (!cg)
+ return SR_ERR_CHANNEL_GROUP;
+ *data = std_gvar_tuple_array(ARRAY_AND_SIZE(dlm_vdivs));
+ break;
+ default:
+ return SR_ERR_NA;
+ }
+
+ return SR_OK;
+}
+
+static int dlm_check_channels(GSList *channels)
+{
+ GSList *l;
+ struct sr_channel *ch;
+ gboolean enabled_pod1, enabled_chan4;
+
+ enabled_pod1 = enabled_chan4 = FALSE;
+
+ /* Note: On the DLM2000, CH4 and Logic are shared. */
+ /* TODO Handle non-DLM2000 models. */
+ for (l = channels; l; l = l->next) {
+ ch = l->data;
+ switch (ch->type) {
+ case SR_CHANNEL_ANALOG:
+ if (ch->index == 3)
+ enabled_chan4 = TRUE;
+ break;
+ case SR_CHANNEL_LOGIC:
+ enabled_pod1 = TRUE;
+ break;
+ default:
+ return SR_ERR;
+ }
+ }
+
+ if (enabled_pod1 && enabled_chan4)
+ return SR_ERR;
+
+ return SR_OK;
+}
+
+static int dev_acquisition_start(const struct sr_dev_inst *sdi)
+{
+ GSList *l;
+ gboolean digital_added;
+ struct sr_channel *ch;
+ struct dev_context *devc;
+ struct sr_scpi_dev_inst *scpi;
+
+ scpi = sdi->conn;
+ devc = sdi->priv;
+ digital_added = FALSE;
+
+ g_slist_free(devc->enabled_channels);
+ devc->enabled_channels = NULL;
+
+ for (l = sdi->channels; l; l = l->next) {
+ ch = l->data;
+ if (!ch->enabled)
+ continue;
+ /* Only add a single digital channel. */
+ if (ch->type != SR_CHANNEL_LOGIC || !digital_added) {
+ devc->enabled_channels = g_slist_append(
+ devc->enabled_channels, ch);
+ if (ch->type == SR_CHANNEL_LOGIC)
+ digital_added = TRUE;
+ }
+ }
+
+ if (!devc->enabled_channels)
+ return SR_ERR;
+
+ if (dlm_check_channels(devc->enabled_channels) != SR_OK) {
+ sr_err("Invalid channel configuration specified!");
+ return SR_ERR_NA;
+ }
+
+ /* Request data for the first enabled channel. */
+ devc->current_channel = devc->enabled_channels;
+ dlm_channel_data_request(sdi);
+
+ sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 5,
+ dlm_data_receive, (void *)sdi);
+
+ return SR_OK;
+}
+
+static int dev_acquisition_stop(struct sr_dev_inst *sdi)
+{
+ struct dev_context *devc;
+
+ std_session_send_df_end(sdi);
+
+ devc = sdi->priv;
+
+ devc->num_frames = 0;
+ g_slist_free(devc->enabled_channels);
+ devc->enabled_channels = NULL;
+
+ sr_scpi_source_remove(sdi->session, sdi->conn);
+
+ return SR_OK;
+}
+
+static struct sr_dev_driver yokogawa_dlm_driver_info = {
.name = "yokogawa-dlm",
- .longname = "Yokogawa DL/DLM driver",
+ .longname = "Yokogawa DL/DLM",
.api_version = 1,
- .init = NULL,
- .cleanup = NULL,
- .scan = NULL,
- .dev_list = NULL,
- .dev_clear = NULL,
- .config_get = NULL,
- .config_set = NULL,
- .config_list = NULL,
- .dev_open = NULL,
- .dev_close = NULL,
- .dev_acquisition_start = NULL,
- .dev_acquisition_stop = NULL,
- .priv = NULL,
+ .init = std_init,
+ .cleanup = std_cleanup,
+ .scan = scan,
+ .dev_list = std_dev_list,
+ .dev_clear = dev_clear,
+ .config_get = config_get,
+ .config_set = config_set,
+ .config_channel_set = config_channel_set,
+ .config_list = config_list,
+ .dev_open = dev_open,
+ .dev_close = dev_close,
+ .dev_acquisition_start = dev_acquisition_start,
+ .dev_acquisition_stop = dev_acquisition_stop,
+ .context = NULL,
};
+SR_REGISTER_DEV_DRIVER(yokogawa_dlm_driver_info);