src/hardware/hp-3457a/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2016 Alexandru Gagniuc <mr.nuke.me@gmail.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include <scpi.h>
  22 #include <string.h>
  23 #include "protocol.h"
  24
  25 static const uint32_t scanopts[] = {
  26         SR_CONF_CONN,
  27 };
  28
  29 static const uint32_t drvopts[] = {
  30         SR_CONF_MULTIMETER,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         SR_CONF_CONTINUOUS,
  35         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  36         SR_CONF_MEASURED_QUANTITY | SR_CONF_SET,
  37         SR_CONF_ADC_POWERLINE_CYCLES | SR_CONF_SET | SR_CONF_GET,
  38 };
  39
  40 SR_PRIV struct sr_dev_driver hp_3457a_driver_info;
  41
  42 static int create_front_channel(struct sr_dev_inst *sdi, int chan_idx)
  43 {
  44         struct sr_channel *channel;
  45         struct sr_channel_group *front;
  46         struct channel_context *chanc;
  47
  48         chanc = g_malloc(sizeof(*chanc));
  49         chanc->location = CONN_FRONT;
  50
  51         channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG,
  52                                  TRUE, "Front");
  53         channel->priv = chanc;
  54
  55         front = g_malloc0(sizeof(*front));
  56         front->name = g_strdup("Front");
  57         front->channels = g_slist_append(front->channels, channel);
  58
  59         sdi->channel_groups = g_slist_append(sdi->channel_groups, front);
  60
  61         return chan_idx;
  62 }
  63
  64 static int create_rear_channels(struct sr_dev_inst *sdi, int chan_idx,
  65                                  const struct rear_card_info *card)
  66 {
  67         unsigned int i;
  68         struct sr_channel *channel;
  69         struct sr_channel_group *group;
  70         struct channel_context *chanc;
  71         char name[16];
  72
  73         /* When card is NULL, we couldn't identify the type of card. */
  74         if (!card)
  75                 return chan_idx;
  76
  77         group = g_malloc0(sizeof(*group));
  78         group->priv = NULL;
  79         group->name = g_strdup(card->cg_name);
  80         sdi->channel_groups = g_slist_append(sdi->channel_groups, group);
  81
  82         for (i = 0; i < card->num_channels; i++) {
  83
  84                 chanc = g_malloc(sizeof(*chanc));
  85                 chanc->location = CONN_REAR;
  86
  87                 if (card->type == REAR_TERMINALS) {
  88                         chanc->index = -1;
  89                         g_snprintf(name, sizeof(name), "%s", card->cg_name);
  90                 } else {
  91                         chanc->index = i;
  92                         g_snprintf(name, sizeof(name), "%s%u", card->cg_name, i);
  93                 }
  94
  95                 channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG,
  96                                         FALSE, name);
  97                 channel->priv = chanc;
  98                 group->channels = g_slist_append(group->channels, channel);
  99         }
 100
 101         return chan_idx;
 102 }
 103
 104 static gchar *get_revision(struct sr_scpi_dev_inst *scpi)
 105 {
 106         int ret, major, minor;
 107         GArray *rev_numbers;
 108
 109         /* Report a version of '0.0' if we can't parse the response. */
 110         major = minor = 0;
 111
 112         ret = sr_scpi_get_floatv(scpi, "REV?", &rev_numbers);
 113         if ((ret == SR_OK) && (rev_numbers->len >= 2)) {
 114                 major = (int)g_array_index(rev_numbers, float, 0);
 115                 minor = (int)g_array_index(rev_numbers, float, 1);
 116         }
 117
 118         g_array_free(rev_numbers, TRUE);
 119
 120         return g_strdup_printf("%d.%d", major, minor);
 121 }
 122
 123 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
 124 {
 125         int ret, idx;
 126         char *response;
 127         struct sr_dev_inst *sdi;
 128         struct dev_context *devc;
 129
 130         /*
 131          * This command ensures we receive an EOI after every response, so that
 132          * we don't wait the entire timeout after the response is received.
 133          */
 134         if (sr_scpi_send(scpi, "END ALWAYS") != SR_OK)
 135                 return NULL;
 136
 137         ret = sr_scpi_get_string(scpi, "ID?", &response);
 138         if ((ret != SR_OK) || !response)
 139                 return NULL;
 140
 141         if (strcmp(response, "HP3457A"))
 142                 return NULL;
 143
 144         g_free(response);
 145
 146         devc = g_malloc0(sizeof(struct dev_context));
 147         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 148         sdi->vendor = g_strdup("Hewlett-Packard");
 149         sdi->model = g_strdup("3457A");
 150         sdi->version = get_revision(scpi);
 151         sdi->conn = scpi;
 152         sdi->driver = &hp_3457a_driver_info;
 153         sdi->inst_type = SR_INST_SCPI;
 154         sdi->priv = devc;
 155
 156         /* There is no way to probe the measurement mode. It must be set. */
 157         devc->measurement_mq = 0;
 158         devc->measurement_unit = 0;
 159
 160         /* Probe rear card option and create channels accordingly (TODO). */
 161         devc->rear_card = hp_3457a_probe_rear_card(scpi);
 162         idx = 0;
 163         idx = create_front_channel(sdi, idx);
 164         create_rear_channels(sdi, idx, devc->rear_card);
 165
 166         return sdi;
 167 }
 168
 169 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 170 {
 171         return std_init(sr_ctx, di, LOG_PREFIX);
 172 }
 173
 174 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 175 {
 176         return sr_scpi_scan(di->context, options, probe_device);
 177 }
 178
 179 /*
 180  * We need to set the HP 3457A to a known state, and there are quite a number
 181  * of knobs to tweak. Here's a brief explanation of what's going on. For more
 182  * details, print out and consult the user manual.
 183  *   PRESET
 184  *     Set the instrument to a pre-determined state. This is easier and faster
 185  *     than sending a few dozen commands. Some of the PRESET defaults include
 186  *     ASCII output format, and synchronous triggering. See user manual for
 187  *     more details.
 188  *
 189  * After the PRESET command, the instrument is in a known state, and only those
 190  * parameters for which the default is unsuitable are modified:
 191  *   INBUF ON
 192  *     Enable the HP-IB input buffer. This allows the instrument to release the
 193  *     HP-IB bus before processing the command, and increases throughput on
 194  *     GPIB buses with more than one device.
 195  *   TRIG HOLD
 196  *     Do not trigger new measurements until instructed to do so.
 197  */
 198 static int dev_open(struct sr_dev_inst *sdi)
 199 {
 200         struct sr_scpi_dev_inst *scpi = sdi->conn;
 201         struct dev_context *devc;
 202
 203         if (sr_scpi_open(scpi) != SR_OK)
 204                 return SR_ERR;
 205
 206         devc = sdi->priv;
 207
 208         sr_scpi_send(scpi, "PRESET");
 209         sr_scpi_send(scpi, "INBUF ON");
 210         sr_scpi_send(scpi, "TRIG HOLD");
 211         sr_scpi_get_float(scpi, "NPLC?", &devc->nplc);
 212
 213         sdi->status = SR_ST_ACTIVE;
 214
 215         return SR_OK;
 216 }
 217
 218 static int dev_close(struct sr_dev_inst *sdi)
 219 {
 220         struct sr_scpi_dev_inst *scpi = sdi->conn;
 221
 222         if (sdi->status != SR_ST_ACTIVE)
 223                 return SR_ERR_DEV_CLOSED;
 224
 225         /* Disable scan-advance (preserve relay life). */
 226         sr_scpi_send(scpi, "SADV HOLD");
 227         /* Switch back to auto-triggering. */
 228         sr_scpi_send(scpi, "TRIG AUTO");
 229
 230         sr_scpi_close(scpi);
 231
 232         sdi->status = SR_ST_INACTIVE;
 233
 234         return SR_OK;
 235 }
 236
 237 static int config_get(uint32_t key, GVariant **data,
 238         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 239 {
 240         int ret;
 241         struct dev_context *devc;
 242
 243         (void)cg;
 244
 245         devc = sdi->priv;
 246
 247         ret = SR_OK;
 248         switch (key) {
 249         case SR_CONF_ADC_POWERLINE_CYCLES:
 250                 *data = g_variant_new_double(devc->nplc);
 251                 break;
 252         default:
 253                 return SR_ERR_NA;
 254         }
 255
 256         return ret;
 257 }
 258
 259 static int config_set(uint32_t key, GVariant *data,
 260                       const struct sr_dev_inst *sdi,
 261                       const struct sr_channel_group *cg)
 262 {
 263         int ret;
 264         enum sr_mq mq;
 265         enum sr_mqflag mq_flags;
 266         struct dev_context *devc;
 267         GVariant *tuple_child;
 268
 269         (void)cg;
 270
 271         if (sdi->status != SR_ST_ACTIVE)
 272                 return SR_ERR_DEV_CLOSED;
 273
 274         devc = sdi->priv;
 275
 276         ret = SR_OK;
 277         switch (key) {
 278         case SR_CONF_LIMIT_SAMPLES:
 279                 devc->limit_samples = g_variant_get_uint64(data);
 280                 break;
 281         case SR_CONF_MEASURED_QUANTITY:
 282                 tuple_child = g_variant_get_child_value(data, 0);
 283                 mq = g_variant_get_uint32(tuple_child);
 284                 tuple_child = g_variant_get_child_value(data, 1);
 285                 mq_flags = g_variant_get_uint64(tuple_child);
 286                 ret = hp_3457a_set_mq(sdi, mq, mq_flags);
 287                 g_variant_unref(tuple_child);
 288                 break;
 289         case SR_CONF_ADC_POWERLINE_CYCLES:
 290                 ret = hp_3457a_set_nplc(sdi, g_variant_get_double(data));
 291                 break;
 292         default:
 293                 ret = SR_ERR_NA;
 294         }
 295
 296         return ret;
 297 }
 298
 299 static int config_list(uint32_t key, GVariant **data,
 300         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 301 {
 302         int ret;
 303
 304         if (key == SR_CONF_SCAN_OPTIONS) {
 305                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 306                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 307                 return SR_OK;
 308         } else if ((key == SR_CONF_DEVICE_OPTIONS) && !sdi) {
 309                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 310                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 311                 return SR_OK;
 312         } else if ((key == SR_CONF_DEVICE_OPTIONS) && !cg) {
 313                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 314                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 315                 return SR_OK;
 316         }
 317
 318         /* From here on, we're only concerned with channel group config. */
 319         if (!cg)
 320                 return SR_ERR_NA;
 321
 322         /*
 323          * TODO: Implement channel group configuration when adding support for
 324          * plug-in cards.
 325          */
 326
 327         ret = SR_OK;
 328         switch (key) {
 329         default:
 330                 ret = SR_ERR_NA;
 331         }
 332
 333         return ret;
 334 }
 335
 336 static void create_channel_index_list(GSList *channels, GArray **arr)
 337 {
 338         struct sr_channel *channel;
 339         struct channel_context *chanc;
 340         GSList *list_elem;
 341
 342         *arr = g_array_new(FALSE, FALSE, sizeof(unsigned int));
 343
 344         for (list_elem = channels; list_elem; list_elem = list_elem->next) {
 345                 channel = list_elem->data;
 346                 chanc = channel->priv;
 347                 g_array_append_val(*arr, chanc->index);
 348         }
 349 }
 350
 351 /*
 352  * TRIG SGL
 353  *   Trigger the first measurement, then hold. We can't let the instrument
 354  *   auto-trigger because we read several registers to make a complete
 355  *   reading. If the instrument were auto-triggering, we could get the
 356  *   reading for sample N, but a new measurement is made and when we read the
 357  *   HIRES register, it contains data for sample N+1. This would produce
 358  *   wrong readings.
 359  * SADV AUTO
 360  *   Activate the scan-advance feature. This automatically connects the next
 361  *   channel in the scan list to the A/D converter. This way, we do not need to
 362  *   occupy the HP-IB bus to send channel select commands.
 363  */
 364 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 365 {
 366         int ret;
 367         gboolean front_selected, rear_selected;
 368         struct sr_scpi_dev_inst *scpi;
 369         struct sr_channel *channel;
 370         struct dev_context *devc;
 371         struct channel_context *chanc;
 372         GArray *ch_list;
 373         GSList *channels;
 374
 375         if (sdi->status != SR_ST_ACTIVE)
 376                 return SR_ERR_DEV_CLOSED;
 377
 378         scpi = sdi->conn;
 379         devc = sdi->priv;
 380
 381         ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100,
 382                                  hp_3457a_receive_data, (void *)sdi);
 383         if (ret != SR_OK)
 384                 return ret;
 385
 386         std_session_send_df_header(sdi, LOG_PREFIX);
 387
 388         front_selected = rear_selected = FALSE;
 389         devc->active_channels = NULL;
 390
 391         for (channels = sdi->channels; channels; channels = channels->next) {
 392                 channel = channels->data;
 393
 394                 if (!channel->enabled)
 395                         continue;
 396
 397                 chanc = channel->priv;
 398
 399                 if (chanc->location == CONN_FRONT)
 400                         front_selected = TRUE;
 401                 if (chanc->location == CONN_REAR)
 402                         rear_selected = TRUE;
 403
 404                 devc->active_channels = g_slist_append(devc->active_channels, channel);
 405         }
 406
 407         if (front_selected && rear_selected) {
 408                 sr_err("Can not use front and rear channels at the same time!");
 409                 g_slist_free(devc->active_channels);
 410                 return SR_ERR_ARG;
 411         }
 412
 413         devc->current_channel = devc->active_channels->data;
 414         devc->num_active_channels = g_slist_length(devc->active_channels);
 415
 416         hp_3457a_select_input(sdi, front_selected ? CONN_FRONT : CONN_REAR);
 417
 418         /* For plug-in cards, use the scan-advance features to scan channels. */
 419         if (rear_selected && (devc->rear_card->card_id != REAR_TERMINALS)) {
 420                 create_channel_index_list(devc->active_channels, &ch_list);
 421                 hp_3457a_send_scan_list(sdi, (void *)ch_list->data, ch_list->len);
 422                 sr_scpi_send(scpi, "SADV AUTO");
 423                 g_array_free(ch_list, TRUE);
 424         }
 425
 426         /* Start first measurement. */
 427         sr_scpi_send(scpi, "TRIG SGL");
 428         devc->acq_state = ACQ_TRIGGERED_MEASUREMENT;
 429         devc->num_samples = 0;
 430
 431         return SR_OK;
 432 }
 433
 434 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 435 {
 436         struct dev_context *devc;
 437
 438         devc = sdi->priv;
 439
 440         g_slist_free(devc->active_channels);
 441
 442         return SR_OK;
 443 }
 444
 445 SR_PRIV struct sr_dev_driver hp_3457a_driver_info = {
 446         .name = "hp-3457a",
 447         .longname = "HP 3457A",
 448         .api_version = 1,
 449         .init = init,
 450         .cleanup = std_cleanup,
 451         .scan = scan,
 452         .dev_list = std_dev_list,
 453         .config_get = config_get,
 454         .config_set = config_set,
 455         .config_list = config_list,
 456         .dev_open = dev_open,
 457         .dev_close = dev_close,
 458         .dev_acquisition_start = dev_acquisition_start,
 459         .dev_acquisition_stop = dev_acquisition_stop,
 460         .context = NULL,
 461 };