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