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