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 | SR_CONF_SET,
  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(sr_ctx, di, 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 GSList *dev_list(const struct sr_dev_driver *di)
 203 {
 204         return ((struct drv_context *)(di->context))->instances;
 205 }
 206
 207 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 208                 const struct sr_channel_group *cg)
 209 {
 210         struct dev_context *devc;
 211         struct sr_channel *ch;
 212         int channel, ret;
 213
 214         if (!sdi)
 215                 return SR_ERR_ARG;
 216
 217         devc = sdi->priv;
 218
 219         ret = SR_OK;
 220         if (!cg) {
 221                 /* No channel group: global options. */
 222                 switch (key) {
 223                 case SR_CONF_CHANNEL_CONFIG:
 224                         *data = g_variant_new_string(channel_modes[devc->channel_mode]);
 225                         break;
 226                 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 227                         *data = g_variant_new_boolean(devc->over_current_protection);
 228                         break;
 229                 default:
 230                         return SR_ERR_NA;
 231                 }
 232         } else {
 233                 /* We only ever have one channel per channel group in this driver. */
 234                 ch = cg->channels->data;
 235                 channel = ch->index;
 236
 237                 switch (key) {
 238                 case SR_CONF_VOLTAGE:
 239                         *data = g_variant_new_double(devc->config[channel].output_voltage_last);
 240                         break;
 241                 case SR_CONF_VOLTAGE_TARGET:
 242                         *data = g_variant_new_double(devc->config[channel].output_voltage_max);
 243                         break;
 244                 case SR_CONF_CURRENT:
 245                         *data = g_variant_new_double(devc->config[channel].output_current_last);
 246                         break;
 247                 case SR_CONF_CURRENT_LIMIT:
 248                         *data = g_variant_new_double(devc->config[channel].output_current_max);
 249                         break;
 250                 case SR_CONF_ENABLED:
 251                         *data = g_variant_new_boolean(devc->config[channel].output_enabled);
 252                         break;
 253                 default:
 254                         return SR_ERR_NA;
 255                 }
 256         }
 257
 258         return ret;
 259 }
 260
 261 static int find_str(const char *str, const char **strings, int array_size)
 262 {
 263         int idx, i;
 264
 265         idx = -1;
 266         for (i = 0; i < array_size; i++) {
 267                 if (!strcmp(str, strings[i])) {
 268                         idx = i;
 269                         break;
 270                 }
 271         }
 272
 273         return idx;
 274 }
 275
 276 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 277                 const struct sr_channel_group *cg)
 278 {
 279         struct dev_context *devc;
 280         struct sr_channel *ch;
 281         gdouble dval;
 282         int channel, ret, ival;
 283         const char *sval;
 284         gboolean bval;
 285
 286         if (sdi->status != SR_ST_ACTIVE)
 287                 return SR_ERR_DEV_CLOSED;
 288
 289         ret = SR_OK;
 290         devc = sdi->priv;
 291         if (!cg) {
 292                 /* No channel group: global options. */
 293                 switch (key) {
 294                 case SR_CONF_CHANNEL_CONFIG:
 295                         sval = g_variant_get_string(data, NULL);
 296                         if ((ival = find_str(sval, channel_modes,
 297                                                         ARRAY_SIZE(channel_modes))) == -1) {
 298                                 ret = SR_ERR_ARG;
 299                                 break;
 300                         }
 301                         if (devc->model->channel_modes && (1 << ival) == 0) {
 302                                 /* Not supported on this model. */
 303                                 ret = SR_ERR_ARG;
 304                         }
 305                         if (ival == devc->channel_mode_set)
 306                                 /* Nothing to do. */
 307                                 break;
 308                         devc->channel_mode_set = ival;
 309                         devc->config_dirty = TRUE;
 310                         break;
 311                 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 312                         bval = g_variant_get_boolean(data);
 313                         if (bval == devc->over_current_protection_set)
 314                                 /* Nothing to do. */
 315                                 break;
 316                         devc->over_current_protection_set = bval;
 317                         devc->config_dirty = TRUE;
 318                         break;
 319                 default:
 320                         return SR_ERR_NA;
 321                 }
 322         } else {
 323                 /* Channel group specified: per-channel options. */
 324                 /* We only ever have one channel per channel group in this driver. */
 325                 ch = cg->channels->data;
 326                 channel = ch->index;
 327
 328                 switch (key) {
 329                 case SR_CONF_VOLTAGE_TARGET:
 330                         dval = g_variant_get_double(data);
 331                         if (dval < 0 || dval > devc->model->channels[channel].voltage[1])
 332                                 ret = SR_ERR_ARG;
 333                         devc->config[channel].output_voltage_max = dval;
 334                         devc->config_dirty = TRUE;
 335                         break;
 336                 case SR_CONF_CURRENT_LIMIT:
 337                         dval = g_variant_get_double(data);
 338                         if (dval < 0 || dval > devc->model->channels[channel].current[1])
 339                                 ret = SR_ERR_ARG;
 340                         devc->config[channel].output_current_max = dval;
 341                         devc->config_dirty = TRUE;
 342                         break;
 343                 case SR_CONF_ENABLED:
 344                         bval = g_variant_get_boolean(data);
 345                         if (bval == devc->config[channel].output_enabled_set)
 346                                 /* Nothing to do. */
 347                                 break;
 348                         devc->config[channel].output_enabled_set = bval;
 349                         devc->config_dirty = TRUE;
 350                         break;
 351                 default:
 352                         ret = SR_ERR_NA;
 353                 }
 354         }
 355
 356         return ret;
 357 }
 358
 359 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 360                 const struct sr_channel_group *cg)
 361 {
 362         struct dev_context *devc;
 363         struct sr_channel *ch;
 364         GVariant *gvar;
 365         GVariantBuilder gvb;
 366         int channel, ret, i;
 367
 368         /* Always available. */
 369         if (key == SR_CONF_SCAN_OPTIONS) {
 370                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 371                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 372                 return SR_OK;
 373         }
 374
 375         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 376                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 377                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 378                 return SR_OK;
 379         }
 380
 381         if (!sdi)
 382                 return SR_ERR_ARG;
 383
 384         devc = sdi->priv;
 385         ret = SR_OK;
 386         if (!cg) {
 387                 /* No channel group: global options. */
 388                 switch (key) {
 389                 case SR_CONF_DEVICE_OPTIONS:
 390                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 391                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 392                         break;
 393                 case SR_CONF_CHANNEL_CONFIG:
 394                         if (devc->model->channel_modes == CHANMODE_INDEPENDENT) {
 395                                 /* The 1-channel models. */
 396                                 *data = g_variant_new_strv(channel_modes, 1);
 397                         } else {
 398                                 /* The other models support all modes. */
 399                                 *data = g_variant_new_strv(channel_modes, ARRAY_SIZE(channel_modes));
 400                         }
 401                         break;
 402                 default:
 403                         return SR_ERR_NA;
 404                 }
 405         } else {
 406                 /* Channel group specified: per-channel options. */
 407                 if (!sdi)
 408                         return SR_ERR_ARG;
 409                 /* We only ever have one channel per channel group in this driver. */
 410                 ch = cg->channels->data;
 411                 channel = ch->index;
 412
 413                 switch (key) {
 414                 case SR_CONF_DEVICE_OPTIONS:
 415                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 416                                         devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
 417                         break;
 418                 case SR_CONF_VOLTAGE_TARGET:
 419                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 420                         /* Min, max, step. */
 421                         for (i = 0; i < 3; i++) {
 422                                 gvar = g_variant_new_double(devc->model->channels[channel].voltage[i]);
 423                                 g_variant_builder_add_value(&gvb, gvar);
 424                         }
 425                         *data = g_variant_builder_end(&gvb);
 426                         break;
 427                 case SR_CONF_CURRENT_LIMIT:
 428                         g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 429                         /* Min, max, step. */
 430                         for (i = 0; i < 3; i++) {
 431                                 gvar = g_variant_new_double(devc->model->channels[channel].current[i]);
 432                                 g_variant_builder_add_value(&gvb, gvar);
 433                         }
 434                         *data = g_variant_builder_end(&gvb);
 435                         break;
 436                 default:
 437                         return SR_ERR_NA;
 438                 }
 439         }
 440
 441         return ret;
 442 }
 443
 444 static int dev_close(struct sr_dev_inst *sdi)
 445 {
 446         struct dev_context *devc;
 447
 448         devc = sdi->priv;
 449         if (devc->config_dirty)
 450                 /* Some configuration changes were queued up but didn't
 451                  * get sent to the device, likely because we were never
 452                  * in acquisition mode. Send them out now. */
 453                 send_config(sdi);
 454
 455         return std_serial_dev_close(sdi);
 456 }
 457
 458 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 459 {
 460         struct dev_context *devc;
 461         struct sr_serial_dev_inst *serial;
 462         uint8_t packet[PACKET_SIZE];
 463
 464         if (sdi->status != SR_ST_ACTIVE)
 465                 return SR_ERR_DEV_CLOSED;
 466
 467         devc = sdi->priv;
 468         memset(devc->packet, 0x44, PACKET_SIZE);
 469         devc->packet_size = 0;
 470
 471         devc->acquisition_running = TRUE;
 472
 473         serial = sdi->conn;
 474         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 475                         atten_pps3xxx_receive_data, (void *)sdi);
 476         std_session_send_df_header(sdi, LOG_PREFIX);
 477
 478         /* Send a "channel" configuration packet now. */
 479         memset(packet, 0, PACKET_SIZE);
 480         packet[0] = 0xaa;
 481         packet[1] = 0xaa;
 482         send_packet(sdi, packet);
 483
 484         return SR_OK;
 485 }
 486
 487 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 488 {
 489         struct dev_context *devc;
 490
 491         if (sdi->status != SR_ST_ACTIVE)
 492                 return SR_ERR_DEV_CLOSED;
 493
 494         devc = sdi->priv;
 495         devc->acquisition_running = FALSE;
 496
 497         return SR_OK;
 498 }
 499
 500 SR_PRIV struct sr_dev_driver atten_pps3203_driver_info = {
 501         .name = "atten-pps3203",
 502         .longname = "Atten PPS3203T-3S",
 503         .api_version = 1,
 504         .init = init,
 505         .cleanup = std_cleanup,
 506         .scan = scan_3203,
 507         .dev_list = dev_list,
 508         .dev_clear = NULL,
 509         .config_get = config_get,
 510         .config_set = config_set,
 511         .config_list = config_list,
 512         .dev_open = std_serial_dev_open,
 513         .dev_close = dev_close,
 514         .dev_acquisition_start = dev_acquisition_start,
 515         .dev_acquisition_stop = dev_acquisition_stop,
 516         .context = NULL,
 517 };