src/hardware/yokogawa-dlm/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 abraxa (Soeren Apel) <soeren@apelpie.net>
   5  * Based on the Hameg HMO driver by poljar (Damir Jelić) <poljarinho@gmail.com>
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  */
  20
  21 #include <config.h>
  22 #include <stdlib.h>
  23 #include "scpi.h"
  24 #include "protocol.h"
  25
  26 static struct sr_dev_driver yokogawa_dlm_driver_info;
  27
  28 static const char *MANUFACTURER_ID = "YOKOGAWA";
  29
  30 static const uint32_t scanopts[] = {
  31         SR_CONF_CONN,
  32 };
  33
  34 static const uint32_t drvopts[] = {
  35         SR_CONF_LOGIC_ANALYZER,
  36         SR_CONF_OSCILLOSCOPE,
  37 };
  38
  39 static const uint32_t devopts[] = {
  40         SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
  41         SR_CONF_SAMPLERATE | SR_CONF_GET,
  42         SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  43         SR_CONF_NUM_HDIV | SR_CONF_GET,
  44         SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_GET | SR_CONF_SET,
  45         SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  46         SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  47 };
  48
  49 static const uint32_t devopts_cg_analog[] = {
  50         SR_CONF_NUM_VDIV | SR_CONF_GET,
  51         SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  52         SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  53 };
  54
  55 static const uint32_t devopts_cg_digital[] = {
  56         /* EMPTY */
  57 };
  58
  59 enum {
  60         CG_INVALID = -1,
  61         CG_NONE,
  62         CG_ANALOG,
  63         CG_DIGITAL,
  64 };
  65
  66 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
  67 {
  68         struct sr_dev_inst *sdi;
  69         struct dev_context *devc;
  70         struct sr_scpi_hw_info *hw_info;
  71         char *model_name;
  72         int model_index;
  73
  74         sdi = NULL;
  75         devc = NULL;
  76         hw_info = NULL;
  77
  78         if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
  79                 sr_info("Couldn't get IDN response.");
  80                 goto fail;
  81         }
  82
  83         if (strcmp(hw_info->manufacturer, MANUFACTURER_ID) != 0)
  84                 goto fail;
  85
  86         if (dlm_model_get(hw_info->model, &model_name, &model_index) != SR_OK)
  87                 goto fail;
  88
  89         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  90         sdi->vendor = g_strdup("Yokogawa");
  91         sdi->model = g_strdup(model_name);
  92         sdi->version = g_strdup(hw_info->firmware_version);
  93
  94         sdi->serial_num = g_strdup(hw_info->serial_number);
  95
  96         sr_scpi_hw_info_free(hw_info);
  97         hw_info = NULL;
  98
  99         devc = g_malloc0(sizeof(struct dev_context));
 100
 101         sdi->driver = &yokogawa_dlm_driver_info;
 102         sdi->priv = devc;
 103         sdi->inst_type = SR_INST_SCPI;
 104         sdi->conn = scpi;
 105
 106         if (dlm_device_init(sdi, model_index) != SR_OK)
 107                 goto fail;
 108
 109         return sdi;
 110
 111 fail:
 112         sr_scpi_hw_info_free(hw_info);
 113         sr_dev_inst_free(sdi);
 114         g_free(devc);
 115
 116         return NULL;
 117 }
 118
 119 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 120 {
 121         return sr_scpi_scan(di->context, options, probe_device);
 122 }
 123
 124 static void clear_helper(struct dev_context *devc)
 125 {
 126         dlm_scope_state_destroy(devc->model_state);
 127         g_free(devc->analog_groups);
 128         g_free(devc->digital_groups);
 129 }
 130
 131 static int dev_clear(const struct sr_dev_driver *di)
 132 {
 133         return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 134 }
 135
 136 static int dev_open(struct sr_dev_inst *sdi)
 137 {
 138         if (sr_scpi_open(sdi->conn) != SR_OK)
 139                 return SR_ERR;
 140
 141         if (dlm_scope_state_query(sdi) != SR_OK)
 142                 return SR_ERR;
 143
 144         return SR_OK;
 145 }
 146
 147 static int dev_close(struct sr_dev_inst *sdi)
 148 {
 149         return sr_scpi_close(sdi->conn);
 150 }
 151
 152 /**
 153  * Check which category a given channel group belongs to.
 154  *
 155  * @param devc Our internal device context.
 156  * @param cg The channel group to check.
 157  *
 158  * @retval CG_NONE cg is NULL
 159  * @retval CG_ANALOG cg is an analog group
 160  * @retval CG_DIGITAL cg is a digital group
 161  * @retval CG_INVALID cg is something else
 162  */
 163 static int check_channel_group(struct dev_context *devc,
 164                         const struct sr_channel_group *cg)
 165 {
 166         const struct scope_config *model;
 167
 168         if (!devc)
 169                 return CG_INVALID;
 170         model = devc->model_config;
 171
 172         if (!cg)
 173                 return CG_NONE;
 174
 175         if (std_cg_idx(cg, devc->analog_groups, model->analog_channels) >= 0)
 176                 return CG_ANALOG;
 177
 178         if (std_cg_idx(cg, devc->digital_groups, model->pods) >= 0)
 179                 return CG_DIGITAL;
 180
 181         sr_err("Invalid channel group specified.");
 182
 183         return CG_INVALID;
 184 }
 185
 186 static int config_get(uint32_t key, GVariant **data,
 187         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 188 {
 189         int ret, cg_type, idx;
 190         struct dev_context *devc;
 191         const struct scope_config *model;
 192         struct scope_state *state;
 193
 194         if (!sdi)
 195                 return SR_ERR_ARG;
 196
 197         devc = sdi->priv;
 198
 199         if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
 200                 return SR_ERR;
 201
 202         model = devc->model_config;
 203         state = devc->model_state;
 204
 205         switch (key) {
 206         case SR_CONF_NUM_HDIV:
 207                 *data = g_variant_new_int32(model->num_xdivs);
 208                 ret = SR_OK;
 209                 break;
 210         case SR_CONF_TIMEBASE:
 211                 *data = g_variant_new("(tt)",
 212                                 dlm_timebases[state->timebase][0],
 213                                 dlm_timebases[state->timebase][1]);
 214                 ret = SR_OK;
 215                 break;
 216         case SR_CONF_NUM_VDIV:
 217                 if (!cg)
 218                         return SR_ERR_CHANNEL_GROUP;
 219                 if (cg_type != CG_ANALOG)
 220                         return SR_ERR_NA;
 221                 *data = g_variant_new_int32(model->num_ydivs);
 222                 ret = SR_OK;
 223                 break;
 224         case SR_CONF_VDIV:
 225                 if (!cg)
 226                         return SR_ERR_CHANNEL_GROUP;
 227                 if (cg_type != CG_ANALOG)
 228                         return SR_ERR_NA;
 229                 if ((idx = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
 230                         return SR_ERR_ARG;
 231                 *data = g_variant_new("(tt)",
 232                                 dlm_vdivs[state->analog_states[idx].vdiv][0],
 233                                 dlm_vdivs[state->analog_states[idx].vdiv][1]);
 234                 ret = SR_OK;
 235                 break;
 236         case SR_CONF_TRIGGER_SOURCE:
 237                 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
 238                 ret = SR_OK;
 239                 break;
 240         case SR_CONF_TRIGGER_SLOPE:
 241                 *data = g_variant_new_string(dlm_trigger_slopes[state->trigger_slope]);
 242                 ret = SR_OK;
 243                 break;
 244         case SR_CONF_HORIZ_TRIGGERPOS:
 245                 *data = g_variant_new_double(state->horiz_triggerpos);
 246                 ret = SR_OK;
 247                 break;
 248         case SR_CONF_COUPLING:
 249                 if (!cg)
 250                         return SR_ERR_CHANNEL_GROUP;
 251                 if (cg_type != CG_ANALOG)
 252                         return SR_ERR_NA;
 253                 if ((idx = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
 254                         return SR_ERR_ARG;
 255                 *data = g_variant_new_string((*model->coupling_options)[state->analog_states[idx].coupling]);
 256                 ret = SR_OK;
 257                 break;
 258         case SR_CONF_SAMPLERATE:
 259                 *data = g_variant_new_uint64(state->sample_rate);
 260                 ret = SR_OK;
 261                 break;
 262         default:
 263                 ret = SR_ERR_NA;
 264         }
 265
 266         return ret;
 267 }
 268
 269 static int config_set(uint32_t key, GVariant *data,
 270         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 271 {
 272         int ret, cg_type, idx, j;
 273         char float_str[30];
 274         struct dev_context *devc;
 275         const struct scope_config *model;
 276         struct scope_state *state;
 277         double tmp_d;
 278         gboolean update_sample_rate;
 279
 280         if (!sdi || !(devc = sdi->priv))
 281                 return SR_ERR_ARG;
 282
 283         if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
 284                 return SR_ERR;
 285
 286         model = devc->model_config;
 287         state = devc->model_state;
 288         update_sample_rate = FALSE;
 289
 290         switch (key) {
 291         case SR_CONF_LIMIT_FRAMES:
 292                 devc->frame_limit = g_variant_get_uint64(data);
 293                 ret = SR_OK;
 294                 break;
 295         case SR_CONF_TRIGGER_SOURCE:
 296                 if ((idx = std_str_idx(data, *model->trigger_sources, model->num_trigger_sources)) < 0)
 297                         return SR_ERR_ARG;
 298                 state->trigger_source = idx;
 299                 /* TODO: A and B trigger support possible? */
 300                 ret = dlm_trigger_source_set(sdi->conn, (*model->trigger_sources)[idx]);
 301                 break;
 302         case SR_CONF_VDIV:
 303                 if (!cg)
 304                         return SR_ERR_CHANNEL_GROUP;
 305                 if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(dlm_vdivs))) < 0)
 306                         return SR_ERR_ARG;
 307                 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
 308                         return SR_ERR_ARG;
 309                 state->analog_states[j].vdiv = idx;
 310                 g_ascii_formatd(float_str, sizeof(float_str),
 311                                 "%E", (float) dlm_vdivs[idx][0] / dlm_vdivs[idx][1]);
 312                 if (dlm_analog_chan_vdiv_set(sdi->conn, j + 1, float_str) != SR_OK ||
 313                                 sr_scpi_get_opc(sdi->conn) != SR_OK)
 314                         return SR_ERR;
 315                 ret = SR_OK;
 316                 break;
 317         case SR_CONF_TIMEBASE:
 318                 if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(dlm_timebases))) < 0)
 319                         return SR_ERR_ARG;
 320                 state->timebase = idx;
 321                 g_ascii_formatd(float_str, sizeof(float_str),
 322                                 "%E", (float) dlm_timebases[idx][0] / dlm_timebases[idx][1]);
 323                 ret = dlm_timebase_set(sdi->conn, float_str);
 324                 update_sample_rate = TRUE;
 325                 break;
 326         case SR_CONF_HORIZ_TRIGGERPOS:
 327                 tmp_d = g_variant_get_double(data);
 328
 329                 /* TODO: Check if the calculation makes sense for the DLM. */
 330                 if (tmp_d < 0.0 || tmp_d > 1.0)
 331                         return SR_ERR;
 332
 333                 state->horiz_triggerpos = tmp_d;
 334                 tmp_d = -(tmp_d - 0.5) *
 335                                 ((double) dlm_timebases[state->timebase][0] /
 336                                 dlm_timebases[state->timebase][1])
 337                                 * model->num_xdivs;
 338
 339                 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
 340                 ret = dlm_horiz_trigger_pos_set(sdi->conn, float_str);
 341                 break;
 342         case SR_CONF_TRIGGER_SLOPE:
 343                 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(dlm_trigger_slopes))) < 0)
 344                         return SR_ERR_ARG;
 345                 /* Note: See dlm_trigger_slopes[] in protocol.c. */
 346                 state->trigger_slope = idx;
 347                 ret = dlm_trigger_slope_set(sdi->conn, state->trigger_slope);
 348                 break;
 349         case SR_CONF_COUPLING:
 350                 if (!cg)
 351                         return SR_ERR_CHANNEL_GROUP;
 352                 if ((idx = std_str_idx(data, *model->coupling_options, model->num_coupling_options)) < 0)
 353                         return SR_ERR_ARG;
 354                 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
 355                         return SR_ERR_ARG;
 356                 state->analog_states[j].coupling = idx;
 357                 if (dlm_analog_chan_coupl_set(sdi->conn, j + 1, (*model->coupling_options)[idx]) != SR_OK ||
 358                                 sr_scpi_get_opc(sdi->conn) != SR_OK)
 359                         return SR_ERR;
 360                 ret = SR_OK;
 361                 break;
 362         default:
 363                 ret = SR_ERR_NA;
 364                 break;
 365         }
 366
 367         if (ret == SR_OK)
 368                 ret = sr_scpi_get_opc(sdi->conn);
 369
 370         if (ret == SR_OK && update_sample_rate)
 371                 ret = dlm_sample_rate_query(sdi);
 372
 373         return ret;
 374 }
 375
 376 static int config_channel_set(const struct sr_dev_inst *sdi,
 377         struct sr_channel *ch, unsigned int changes)
 378 {
 379         /* Currently we only handle SR_CHANNEL_SET_ENABLED. */
 380         if (changes != SR_CHANNEL_SET_ENABLED)
 381                 return SR_ERR_NA;
 382
 383         return dlm_channel_state_set(sdi, ch->index, ch->enabled);
 384 }
 385
 386 static int config_list(uint32_t key, GVariant **data,
 387         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 388 {
 389         int cg_type = CG_NONE;
 390         struct dev_context *devc;
 391         const struct scope_config *model;
 392
 393         devc = (sdi) ? sdi->priv : NULL;
 394         model = (devc) ? devc->model_config : NULL;
 395
 396         if (!cg) {
 397                 switch (key) {
 398                 case SR_CONF_SCAN_OPTIONS:
 399                 case SR_CONF_DEVICE_OPTIONS:
 400                         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 401                 case SR_CONF_TIMEBASE:
 402                         *data = std_gvar_tuple_array(ARRAY_AND_SIZE(dlm_timebases));
 403                         return SR_OK;
 404                 case SR_CONF_TRIGGER_SOURCE:
 405                         if (!model)
 406                                 return SR_ERR_ARG;
 407                         *data = g_variant_new_strv(*model->trigger_sources, model->num_trigger_sources);
 408                         return SR_OK;
 409                 case SR_CONF_TRIGGER_SLOPE:
 410                         *data = g_variant_new_strv(ARRAY_AND_SIZE(dlm_trigger_slopes));
 411                         return SR_OK;
 412                 case SR_CONF_NUM_HDIV:
 413                         if (!model)
 414                                 return SR_ERR_ARG;
 415                         *data = g_variant_new_uint32(model->num_xdivs);
 416                         return SR_OK;
 417                 default:
 418                         return SR_ERR_NA;
 419                 }
 420         }
 421
 422         if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
 423                 return SR_ERR;
 424
 425         switch (key) {
 426         case SR_CONF_DEVICE_OPTIONS:
 427                 if (cg_type == CG_ANALOG) {
 428                         *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog));
 429                         break;
 430                 }
 431                 if (cg_type == CG_DIGITAL) {
 432                         if (!ARRAY_SIZE(devopts_cg_digital)) {
 433                                 *data = std_gvar_array_u32(NULL, 0);
 434                                 break;
 435                         }
 436                         *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_digital));
 437                         break;
 438                 }
 439                 *data = std_gvar_array_u32(NULL, 0);
 440                 break;
 441         case SR_CONF_COUPLING:
 442                 if (!cg)
 443                         return SR_ERR_CHANNEL_GROUP;
 444                 *data = g_variant_new_strv(*model->coupling_options, model->num_coupling_options);
 445                 break;
 446         case SR_CONF_VDIV:
 447                 if (!cg)
 448                         return SR_ERR_CHANNEL_GROUP;
 449                 *data = std_gvar_tuple_array(ARRAY_AND_SIZE(dlm_vdivs));
 450                 break;
 451         default:
 452                 return SR_ERR_NA;
 453         }
 454
 455         return SR_OK;
 456 }
 457
 458 static int dlm_check_channels(GSList *channels)
 459 {
 460         GSList *l;
 461         struct sr_channel *ch;
 462         gboolean enabled_pod1, enabled_chan4;
 463
 464         enabled_pod1 = enabled_chan4 = FALSE;
 465
 466         /* Note: On the DLM2000, CH4 and Logic are shared. */
 467         /* TODO Handle non-DLM2000 models. */
 468         for (l = channels; l; l = l->next) {
 469                 ch = l->data;
 470                 switch (ch->type) {
 471                 case SR_CHANNEL_ANALOG:
 472                         if (ch->index == 3)
 473                                 enabled_chan4 = TRUE;
 474                         break;
 475                 case SR_CHANNEL_LOGIC:
 476                         enabled_pod1 = TRUE;
 477                         break;
 478                 default:
 479                         return SR_ERR;
 480                 }
 481         }
 482
 483         if (enabled_pod1 && enabled_chan4)
 484                 return SR_ERR;
 485
 486         return SR_OK;
 487 }
 488
 489 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 490 {
 491         GSList *l;
 492         gboolean digital_added;
 493         struct sr_channel *ch;
 494         struct dev_context *devc;
 495         struct sr_scpi_dev_inst *scpi;
 496
 497         scpi = sdi->conn;
 498         devc = sdi->priv;
 499         digital_added = FALSE;
 500
 501         g_slist_free(devc->enabled_channels);
 502         devc->enabled_channels = NULL;
 503
 504         for (l = sdi->channels; l; l = l->next) {
 505                 ch = l->data;
 506                 if (!ch->enabled)
 507                         continue;
 508                 /* Only add a single digital channel. */
 509                 if (ch->type != SR_CHANNEL_LOGIC || !digital_added) {
 510                         devc->enabled_channels = g_slist_append(
 511                                 devc->enabled_channels, ch);
 512                         if (ch->type == SR_CHANNEL_LOGIC)
 513                                 digital_added = TRUE;
 514                 }
 515         }
 516
 517         if (!devc->enabled_channels)
 518                 return SR_ERR;
 519
 520         if (dlm_check_channels(devc->enabled_channels) != SR_OK) {
 521                 sr_err("Invalid channel configuration specified!");
 522                 return SR_ERR_NA;
 523         }
 524
 525         /* Request data for the first enabled channel. */
 526         devc->current_channel = devc->enabled_channels;
 527         dlm_channel_data_request(sdi);
 528
 529         sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 5,
 530                         dlm_data_receive, (void *)sdi);
 531
 532         return SR_OK;
 533 }
 534
 535 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 536 {
 537         struct dev_context *devc;
 538
 539         std_session_send_df_end(sdi);
 540
 541         devc = sdi->priv;
 542
 543         devc->num_frames = 0;
 544         g_slist_free(devc->enabled_channels);
 545         devc->enabled_channels = NULL;
 546
 547         sr_scpi_source_remove(sdi->session, sdi->conn);
 548
 549         return SR_OK;
 550 }
 551
 552 static struct sr_dev_driver yokogawa_dlm_driver_info = {
 553         .name = "yokogawa-dlm",
 554         .longname = "Yokogawa DL/DLM",
 555         .api_version = 1,
 556         .init = std_init,
 557         .cleanup = std_cleanup,
 558         .scan = scan,
 559         .dev_list = std_dev_list,
 560         .dev_clear = dev_clear,
 561         .config_get = config_get,
 562         .config_set = config_set,
 563         .config_channel_set = config_channel_set,
 564         .config_list = config_list,
 565         .dev_open = dev_open,
 566         .dev_close = dev_close,
 567         .dev_acquisition_start = dev_acquisition_start,
 568         .dev_acquisition_stop = dev_acquisition_stop,
 569         .context = NULL,
 570 };
 571 SR_REGISTER_DEV_DRIVER(yokogawa_dlm_driver_info);