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