src/hardware/atten-pps3xxx/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 Bert Vermeulen <bert@biot.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 <string.h>
  22 #include "protocol.h"
  23
  24 /*
  25  * The default serial communication settings on the device are 9600
  26  * baud, 9 data bits. The 9th bit isn't actually used, and the vendor
  27  * software uses Mark parity to absorb the extra bit.
  28  *
  29  * Since 9 data bits is not a standard available in POSIX, we use two
  30  * stop bits to skip over the extra bit instead.
  31  */
  32 #define SERIALCOMM "9600/8n2"
  33
  34 static const uint32_t scanopts[] = {
  35         SR_CONF_CONN,
  36         SR_CONF_SERIALCOMM,
  37 };
  38
  39 static const uint32_t drvopts[] = {
  40         SR_CONF_POWER_SUPPLY,
  41 };
  42
  43 static const uint32_t devopts[] = {
  44         SR_CONF_CONTINUOUS,
  45         SR_CONF_CHANNEL_CONFIG | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  46         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  47 };
  48
  49 static const uint32_t devopts_cg[] = {
  50         SR_CONF_VOLTAGE | SR_CONF_GET,
  51         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  52         SR_CONF_CURRENT | SR_CONF_GET,
  53         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  54         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  55 };
  56
  57 static const char *channel_modes[] = {
  58         "Independent",
  59         "Series",
  60         "Parallel",
  61 };
  62
  63 static const struct pps_model models[] = {
  64         { PPS_3203T_3S, "PPS3203T-3S",
  65                 CHANMODE_INDEPENDENT | CHANMODE_SERIES | CHANMODE_PARALLEL,
  66                 3,
  67                 {
  68                         /* Channel 1 */
  69                         { { 0, 32, 0.01 }, { 0, 3, 0.001 } },
  70                         /* Channel 2 */
  71                         { { 0, 32, 0.01 }, { 0, 3, 0.001 } },
  72                         /* Channel 3 */
  73                         { { 0, 6, 0.01 }, { 0, 3, 0.001 } },
  74                 },
  75         },
  76 };
  77
  78 static GSList *scan(struct sr_dev_driver *di, GSList *options, int modelid)
  79 {
  80         struct sr_dev_inst *sdi;
  81         struct drv_context *drvc;
  82         struct dev_context *devc;
  83         struct sr_config *src;
  84         struct sr_channel *ch;
  85         struct sr_channel_group *cg;
  86         struct sr_serial_dev_inst *serial;
  87         GSList *l, *devices;
  88         const struct pps_model *model;
  89         uint8_t packet[PACKET_SIZE];
  90         unsigned int i;
  91         int delay_ms, ret;
  92         const char *conn, *serialcomm;
  93         char channel[10];
  94
  95         devices = NULL;
  96         drvc = di->context;
  97         drvc->instances = NULL;
  98
  99         conn = serialcomm = NULL;
 100         for (l = options; l; l = l->next) {
 101                 src = l->data;
 102                 switch (src->key) {
 103                 case SR_CONF_CONN:
 104                         conn = g_variant_get_string(src->data, NULL);
 105                         break;
 106                 case SR_CONF_SERIALCOMM:
 107                         serialcomm = g_variant_get_string(src->data, NULL);
 108                         break;
 109                 }
 110         }
 111         if (!conn)
 112                 return NULL;
 113         if (!serialcomm)
 114                 serialcomm = SERIALCOMM;
 115
 116         serial = sr_serial_dev_inst_new(conn, serialcomm);
 117
 118         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 119                 return NULL;
 120
 121         serial_flush(serial);
 122
 123         /* This is how the vendor software scans for hardware. */
 124         memset(packet, 0, PACKET_SIZE);
 125         packet[0] = 0xaa;
 126         packet[1] = 0xaa;
 127         delay_ms = serial_timeout(serial, PACKET_SIZE);
 128         if (serial_write_blocking(serial, packet, PACKET_SIZE, delay_ms) < PACKET_SIZE) {
 129                 sr_err("Unable to write while probing for hardware.");
 130                 return NULL;
 131         }
 132         /* The device responds with a 24-byte packet when it receives a packet.
 133          * At 9600 baud, 300ms is long enough for it to have arrived. */
 134         g_usleep(300 * 1000);
 135         memset(packet, 0, PACKET_SIZE);
 136         if ((ret = serial_read_nonblocking(serial, packet, PACKET_SIZE)) < 0) {
 137                 sr_err("Unable to read while probing for hardware: %s",
 138                                 sr_strerror(ret));
 139                 return NULL;
 140         }
 141         if (ret != PACKET_SIZE || packet[0] != 0xaa || packet[1] != 0xaa) {
 142                 /* Doesn't look like an Atten PPS. */
 143                 return NULL;
 144         }
 145
 146         model = NULL;
 147         for (i = 0; i < ARRAY_SIZE(models); i++) {
 148                 if (models[i].modelid == modelid) {
 149                         model = &models[i];
 150                         break;
 151                 }
 152         }
 153         if (!model) {
 154                 sr_err("Unknown modelid %d", modelid);
 155                 return NULL;
 156         }
 157
 158         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 159         sdi->status = SR_ST_INACTIVE;
 160         sdi->vendor = g_strdup("Atten");
 161         sdi->model = g_strdup(model->name);
 162         sdi->driver = di;
 163         sdi->inst_type = SR_INST_SERIAL;
 164         sdi->conn = serial;
 165         for (i = 0; i < MAX_CHANNELS; i++) {
 166                 snprintf(channel, 10, "CH%d", i + 1);
 167                 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel);
 168                 cg = g_malloc(sizeof(struct sr_channel_group));
 169                 cg->name = g_strdup(channel);
 170                 cg->channels = g_slist_append(NULL, ch);
 171                 cg->priv = NULL;
 172                 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
 173         }
 174
 175         devc = g_malloc0(sizeof(struct dev_context));
 176         devc->model = model;
 177         devc->config = g_malloc0(sizeof(struct per_channel_config) * model->num_channels);
 178         devc->delay_ms = delay_ms;
 179         sdi->priv = devc;
 180         drvc->instances = g_slist_append(drvc->instances, sdi);
 181         devices = g_slist_append(devices, sdi);
 182
 183         serial_close(serial);
 184         if (!devices)
 185                 sr_serial_dev_inst_free(serial);
 186
 187         return devices;
 188 }
 189
 190 static GSList *scan_3203(struct sr_dev_driver *di, GSList *options)
 191 {
 192         return scan(di, options, PPS_3203T_3S);
 193 }
 194
 195 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 196                 const struct sr_channel_group *cg)
 197 {
 198         struct dev_context *devc;
 199         struct sr_channel *ch;
 200         int channel, ret;
 201
 202         if (!sdi)
 203                 return SR_ERR_ARG;
 204
 205         devc = sdi->priv;
 206
 207         ret = SR_OK;
 208         if (!cg) {
 209                 /* No channel group: global options. */
 210                 switch (key) {
 211                 case SR_CONF_CHANNEL_CONFIG:
 212                         *data = g_variant_new_string(channel_modes[devc->channel_mode]);
 213                         break;
 214                 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 215                         *data = g_variant_new_boolean(devc->over_current_protection);
 216                         break;
 217                 default:
 218                         return SR_ERR_NA;
 219                 }
 220         } else {
 221                 /* We only ever have one channel per channel group in this driver. */
 222                 ch = cg->channels->data;
 223                 channel = ch->index;
 224
 225                 switch (key) {
 226                 case SR_CONF_VOLTAGE:
 227                         *data = g_variant_new_double(devc->config[channel].output_voltage_last);
 228                         break;
 229                 case SR_CONF_VOLTAGE_TARGET:
 230                         *data = g_variant_new_double(devc->config[channel].output_voltage_max);
 231                         break;
 232                 case SR_CONF_CURRENT:
 233                         *data = g_variant_new_double(devc->config[channel].output_current_last);
 234                         break;
 235                 case SR_CONF_CURRENT_LIMIT:
 236                         *data = g_variant_new_double(devc->config[channel].output_current_max);
 237                         break;
 238                 case SR_CONF_ENABLED:
 239                         *data = g_variant_new_boolean(devc->config[channel].output_enabled);
 240                         break;
 241                 default:
 242                         return SR_ERR_NA;
 243                 }
 244         }
 245
 246         return ret;
 247 }
 248
 249 static int find_str(const char *str, const char **strings, int array_size)
 250 {
 251         int idx, i;
 252
 253         idx = -1;
 254         for (i = 0; i < array_size; i++) {
 255                 if (!strcmp(str, strings[i])) {
 256                         idx = i;
 257                         break;
 258                 }
 259         }
 260
 261         return idx;
 262 }
 263
 264 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 265                 const struct sr_channel_group *cg)
 266 {
 267         struct dev_context *devc;
 268         struct sr_channel *ch;
 269         gdouble dval;
 270         int channel, ret, ival;
 271         const char *sval;
 272         gboolean bval;
 273
 274         if (sdi->status != SR_ST_ACTIVE)
 275                 return SR_ERR_DEV_CLOSED;
 276
 277         ret = SR_OK;
 278         devc = sdi->priv;
 279         if (!cg) {
 280                 /* No channel group: global options. */
 281                 switch (key) {
 282                 case SR_CONF_CHANNEL_CONFIG:
 283                         sval = g_variant_get_string(data, NULL);
 284                         if ((ival = find_str(sval, channel_modes,
 285                                                         ARRAY_SIZE(channel_modes))) == -1) {
 286                                 ret = SR_ERR_ARG;
 287                                 break;
 288                         }
 289                         if (devc->model->channel_modes && (1 << ival) == 0) {
 290                                 /* Not supported on this model. */
 291                                 ret = SR_ERR_ARG;
 292                         }
 293                         if (ival == devc->channel_mode_set)
 294                                 /* Nothing to do. */
 295                                 break;
 296                         devc->channel_mode_set = ival;
 297                         devc->config_dirty = TRUE;
 298                         break;
 299                 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 300                         bval = g_variant_get_boolean(data);
 301                         if (bval == devc->over_current_protection_set)
 302                                 /* Nothing to do. */
 303                                 break;
 304                         devc->over_current_protection_set = bval;
 305                         devc->config_dirty = TRUE;
 306                         break;
 307                 default:
 308                         return SR_ERR_NA;
 309                 }
 310         } else {
 311                 /* Channel group specified: per-channel options. */
 312                 /* We only ever have one channel per channel group in this driver. */
 313                 ch = cg->channels->data;
 314                 channel = ch->index;
 315
 316                 switch (key) {
 317                 case SR_CONF_VOLTAGE_TARGET:
 318                         dval = g_variant_get_double(data);
 319                         if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
 320                                 ret = SR_ERR_ARG;
 321                         devc->config[channel].output_voltage_max = dval;
 322                         devc->config_dirty = TRUE;
 323                         break;
 324                 case SR_CONF_CURRENT_LIMIT:
 325                         dval = g_variant_get_double(data);
 326                         if (dval < 0 || dval > devc->model->channels[channel].current[1])
 327                                 ret = SR_ERR_ARG;
 328                         devc->config[channel].output_current_max = dval;
 329                         devc->config_dirty = TRUE;
 330                         break;
 331                 case SR_CONF_ENABLED:
 332                         bval = g_variant_get_boolean(data);
 333                         if (bval == devc->config[channel].output_enabled_set)
 334                                 /* Nothing to do. */
 335                                 break;
 336                         devc->config[channel].output_enabled_set = bval;
 337                         devc->config_dirty = TRUE;
 338                         break;
 339                 default:
 340                         ret = SR_ERR_NA;
 341                 }
 342         }
 343
 344         return ret;
 345 }
 346
 347 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 348                 const struct sr_channel_group *cg)
 349 {
 350         struct dev_context *devc;
 351         struct sr_channel *ch;
 352         GVariant *gvar;
 353         GVariantBuilder gvb;
 354         int channel, ret, i;
 355
 356         /* Always available. */
 357         if (key == SR_CONF_SCAN_OPTIONS) {
 358                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 359                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 360                 return SR_OK;
 361         }
 362
 363         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 364                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 365                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 366                 return SR_OK;
 367         }
 368
 369         if (!sdi)
 370                 return SR_ERR_ARG;
 371
 372         devc = sdi->priv;
 373         ret = SR_OK;
 374         if (!cg) {
 375                 /* No channel group: global options. */
 376                 switch (key) {
 377                 case SR_CONF_DEVICE_OPTIONS:
 378                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 379                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 380                         break;
 381                 case SR_CONF_CHANNEL_CONFIG:
 382                         if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
 383                                 /* The 1-channel models. */
 384                                 *data = g_variant_new_strv(channel_modes, 1);
 385                         } else {
 386                                 /* The other models support all modes. */
 387                                 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
 388                         }
 389                         break;
 390                 default:
 391                         return SR_ERR_NA;
 392                 }
 393         } else {
 394                 /* Channel group specified: per-channel options. */
 395                 if (!sdi)
 396                         return SR_ERR_ARG;
 397                 /* We only ever have one channel per channel group in this driver. */
 398                 ch = cg->channels->data;
 399                 channel = ch->index;
 400
 401                 switch (key) {
 402                 case SR_CONF_DEVICE_OPTIONS:
 403                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 404                                         devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
 405                         break;
 406                 case SR_CONF_VOLTAGE_TARGET:
 407                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 408                         /* Min, max, step. */
 409                         for (i = 0; i < 3; i++) {
 410                                 gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]);
 411                                 g_variant_builder_add_value(&gvb, gvar);
 412                         }
 413                         *data = g_variant_builder_end(&gvb);
 414                         break;
 415                 case SR_CONF_CURRENT_LIMIT:
 416                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 417                         /* Min, max, step. */
 418                         for (i = 0; i < 3; i++) {
 419                                 gvar = g_variant_new_double(devc->model->channels[channel].current[i]);
 420                                 g_variant_builder_add_value(&gvb, gvar);
 421                         }
 422                         *data = g_variant_builder_end(&gvb);
 423                         break;
 424                 default:
 425                         return SR_ERR_NA;
 426                 }
 427         }
 428
 429         return ret;
 430 }
 431
 432 static int dev_close(struct sr_dev_inst *sdi)
 433 {
 434         struct dev_context *devc;
 435
 436         devc = sdi->priv;
 437         if (devc->config_dirty)
 438                 /* Some configuration changes were queued up but didn't
 439                  * get sent to the device, likely because we were never
 440                  * in acquisition mode. Send them out now. */
 441                 send_config(sdi);
 442
 443         return std_serial_dev_close(sdi);
 444 }
 445
 446 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 447 {
 448         struct dev_context *devc;
 449         struct sr_serial_dev_inst *serial;
 450         uint8_t packet[PACKET_SIZE];
 451
 452         if (sdi->status != SR_ST_ACTIVE)
 453                 return SR_ERR_DEV_CLOSED;
 454
 455         devc = sdi->priv;
 456         memset(devc->packet, 0x44, PACKET_SIZE);
 457         devc->packet_size = 0;
 458
 459         devc->acquisition_running = TRUE;
 460
 461         serial = sdi->conn;
 462         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 463                         atten_pps3xxx_receive_data, (void *)sdi);
 464         std_session_send_df_header(sdi, LOG_PREFIX);
 465
 466         /* Send a "channel" configuration packet now. */
 467         memset(packet, 0, PACKET_SIZE);
 468         packet[0] = 0xaa;
 469         packet[1] = 0xaa;
 470         send_packet(sdi, packet);
 471
 472         return SR_OK;
 473 }
 474
 475 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 476 {
 477         struct dev_context *devc;
 478
 479         if (sdi->status != SR_ST_ACTIVE)
 480                 return SR_ERR_DEV_CLOSED;
 481
 482         devc = sdi->priv;
 483         devc->acquisition_running = FALSE;
 484
 485         return SR_OK;
 486 }
 487
 488 SR_PRIV struct sr_dev_driver atten_pps3203_driver_info = {
 489         .name = "atten-pps3203",
 490         .longname = "Atten PPS3203T-3S",
 491         .api_version = 1,
 492         .init = std_init,
 493         .cleanup = std_cleanup,
 494         .scan = scan_3203,
 495         .dev_list = std_dev_list,
 496         .dev_clear = NULL,
 497         .config_get = config_get,
 498         .config_set = config_set,
 499         .config_list = config_list,
 500         .dev_open = std_serial_dev_open,
 501         .dev_close = dev_close,
 502         .dev_acquisition_start = dev_acquisition_start,
 503         .dev_acquisition_stop = dev_acquisition_stop,
 504         .context = NULL,
 505 };