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