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