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