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