src/hardware/baylibre-acme/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.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 "protocol.h"
  21
  22 SR_PRIV struct sr_dev_driver baylibre_acme_driver_info;
  23
  24 static const uint32_t devopts[] = {
  25         SR_CONF_CONTINUOUS | SR_CONF_SET,
  26         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  27         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  28         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  29 };
  30
  31 /*
  32  * Currently there are two channel-group/probe options for ACME:
  33  *   - SR_CONF_PROBE_FACTOR - allows to modify current shunt resistance
  34  *     calibration
  35  *   - SR_CONF_POWER_OFF - allows to remotely cut-off/restore power to
  36  *     measured devices
  37  *
  38  * They are not static - we have to check each probe's capabilities in
  39  * config_list().
  40  */
  41 #define MAX_DEVOPTS_CG          2
  42 #define HAS_PROBE_FACTOR        (SR_CONF_PROBE_FACTOR | SR_CONF_GET | SR_CONF_SET)
  43 #define HAS_POWER_OFF           (SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET)
  44
  45 #define MAX_SAMPLE_RATE 500 /* In Hz */
  46
  47 static const uint64_t samplerates[] = {
  48         SR_HZ(1),
  49         SR_HZ(MAX_SAMPLE_RATE),
  50         SR_HZ(1),
  51 };
  52
  53 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  54 {
  55         return std_init(sr_ctx, di, LOG_PREFIX);
  56 }
  57
  58 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  59 {
  60         struct drv_context *drvc;
  61         struct dev_context *devc;
  62         struct sr_dev_inst *sdi;
  63         GSList *devices;
  64         gboolean status;
  65         int i;
  66
  67         (void)options;
  68
  69         drvc = di->priv;
  70         devices = NULL;
  71
  72         devc = g_malloc0(sizeof(struct dev_context));
  73         devc->samplerate = SR_HZ(10);
  74
  75         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  76         sdi->status = SR_ST_INACTIVE;
  77         sdi->vendor = g_strdup("BayLibre");
  78         sdi->model = g_strdup("ACME");
  79         sdi->driver = di;
  80         sdi->priv = devc;
  81
  82         status = bl_acme_is_sane();
  83         if (!status)
  84                 goto err_out;
  85
  86         /*
  87          * Iterate over all ACME connectors and check if any probes
  88          * are present.
  89          */
  90         for (i = 0; i < MAX_PROBES; i++) {
  91                 /*
  92                  * First check if there's an energy probe on this connector. If
  93                  * not, and we're already at the fifth probe - see if we can
  94                  * detect a temperature probe.
  95                  */
  96                 status = bl_acme_detect_probe(bl_acme_get_enrg_addr(i),
  97                                               PROBE_NUM(i), ENRG_PROBE_NAME);
  98                 if (status) {
  99                         /* Energy probe detected. */
 100                         status = bl_acme_register_probe(sdi, PROBE_ENRG,
 101                                         bl_acme_get_enrg_addr(i), PROBE_NUM(i));
 102                         if (!status) {
 103                                 sr_err("Error registering power probe %d",
 104                                        PROBE_NUM(i));
 105                                 continue;
 106                         }
 107                 } else if (i >= TEMP_PRB_START_INDEX) {
 108                         status = bl_acme_detect_probe(bl_acme_get_temp_addr(i),
 109                                               PROBE_NUM(i), TEMP_PROBE_NAME);
 110                         if (status) {
 111                                 /* Temperature probe detected. */
 112                                 status = bl_acme_register_probe(sdi,PROBE_TEMP,
 113                                         bl_acme_get_temp_addr(i), PROBE_NUM(i));
 114                                 if (!status) {
 115                                         sr_err("Error registering temp "
 116                                                "probe %d", PROBE_NUM(i));
 117                                         continue;
 118                                 }
 119                         }
 120                 }
 121         }
 122
 123         /*
 124          * Let's assume there's no ACME device present if no probe
 125          * has been registered.
 126          */
 127         if (!sdi->channel_groups)
 128                 goto err_out;
 129
 130         devices = g_slist_append(devices, sdi);
 131         drvc->instances = g_slist_append(drvc->instances, sdi);
 132
 133         return devices;
 134
 135 err_out:
 136         g_free(devc);
 137         sr_dev_inst_free(sdi);
 138
 139         return NULL;
 140 }
 141
 142 static GSList *dev_list(const struct sr_dev_driver *di)
 143 {
 144         return ((struct drv_context *)(di->priv))->instances;
 145 }
 146
 147 static int dev_clear(const struct sr_dev_driver *di)
 148 {
 149         return std_dev_clear(di, NULL);
 150 }
 151
 152 static int dev_open(struct sr_dev_inst *sdi)
 153 {
 154         (void)sdi;
 155
 156         /* Nothing to do here. */
 157         sdi->status = SR_ST_ACTIVE;
 158
 159         return SR_OK;
 160 }
 161
 162 static int dev_close(struct sr_dev_inst *sdi)
 163 {
 164         (void)sdi;
 165
 166         /* Nothing to do here. */
 167         sdi->status = SR_ST_INACTIVE;
 168
 169         return SR_OK;
 170 }
 171
 172 static int cleanup(const struct sr_dev_driver *di)
 173 {
 174         dev_clear(di);
 175
 176         return SR_OK;
 177 }
 178
 179 static int config_get(uint32_t key, GVariant **data,
 180                       const struct sr_dev_inst *sdi,
 181                       const struct sr_channel_group *cg)
 182 {
 183         struct dev_context *devc;
 184         int ret;
 185         uint64_t shunt;
 186         gboolean power_off;
 187
 188         devc = sdi->priv;
 189
 190         ret = SR_OK;
 191         switch (key) {
 192         case SR_CONF_LIMIT_SAMPLES:
 193                 *data = g_variant_new_uint64(devc->limit_samples);
 194                 break;
 195         case SR_CONF_LIMIT_MSEC:
 196                 *data = g_variant_new_uint64(devc->limit_msec);
 197                 break;
 198         case SR_CONF_SAMPLERATE:
 199                 *data = g_variant_new_uint64(devc->samplerate);
 200                 break;
 201         case SR_CONF_PROBE_FACTOR:
 202                 if (!cg)
 203                         return SR_ERR_CHANNEL_GROUP;
 204                 ret = bl_acme_get_shunt(cg, &shunt);
 205                 if (ret == SR_OK)
 206                         *data = g_variant_new_uint64(shunt);
 207                 break;
 208         case SR_CONF_POWER_OFF:
 209                 if (!cg)
 210                         return SR_ERR_CHANNEL_GROUP;
 211                 ret = bl_acme_read_power_state(cg, &power_off);
 212                 if (ret == SR_OK)
 213                         *data = g_variant_new_boolean(power_off);
 214                 break;
 215         default:
 216                 return SR_ERR_NA;
 217         }
 218
 219         return ret;
 220 }
 221
 222 static int config_set(uint32_t key, GVariant *data,
 223                       const struct sr_dev_inst *sdi,
 224                       const struct sr_channel_group *cg)
 225 {
 226         struct dev_context *devc;
 227         uint64_t samplerate;
 228         int ret;
 229
 230         if (sdi->status != SR_ST_ACTIVE)
 231                 return SR_ERR_DEV_CLOSED;
 232
 233         devc = sdi->priv;
 234
 235         ret = SR_OK;
 236         switch (key) {
 237         case SR_CONF_LIMIT_SAMPLES:
 238                 devc->limit_samples = g_variant_get_uint64(data);
 239                 devc->limit_msec = 0;
 240                 break;
 241         case SR_CONF_LIMIT_MSEC:
 242                 devc->limit_msec = g_variant_get_uint64(data) * 1000;
 243                 devc->limit_samples = 0;
 244                 break;
 245         case SR_CONF_SAMPLERATE:
 246                 samplerate = g_variant_get_uint64(data);
 247                 if (samplerate > MAX_SAMPLE_RATE) {
 248                         sr_err("Maximum sample rate is %d", MAX_SAMPLE_RATE);
 249                         ret = SR_ERR_SAMPLERATE;
 250                         break;
 251                 }
 252                 devc->samplerate = samplerate;
 253                 bl_acme_maybe_set_update_interval(sdi, samplerate);
 254                 break;
 255         case SR_CONF_PROBE_FACTOR:
 256                 if (!cg)
 257                         return SR_ERR_CHANNEL_GROUP;
 258                 ret = bl_acme_set_shunt(cg, g_variant_get_uint64(data));
 259                 break;
 260         case SR_CONF_POWER_OFF:
 261                 if (!cg)
 262                         return SR_ERR_CHANNEL_GROUP;
 263                 ret = bl_acme_set_power_off(cg, g_variant_get_boolean(data));
 264                 break;
 265         default:
 266                 ret = SR_ERR_NA;
 267         }
 268
 269         return ret;
 270 }
 271
 272 static int config_list(uint32_t key, GVariant **data,
 273                        const struct sr_dev_inst *sdi,
 274                        const struct sr_channel_group *cg)
 275 {
 276         uint32_t devopts_cg[MAX_DEVOPTS_CG];
 277         GVariant *gvar;
 278         GVariantBuilder gvb;
 279         int ret, num_devopts_cg = 0;
 280
 281         (void)sdi;
 282         (void)cg;
 283
 284         ret = SR_OK;
 285         if (!cg) {
 286                 switch (key) {
 287                 case SR_CONF_DEVICE_OPTIONS:
 288                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 289                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 290                         break;
 291                 case SR_CONF_SAMPLERATE:
 292                         g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 293                         gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 294                                 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
 295                         g_variant_builder_add(&gvb, "{sv}",
 296                                               "samplerate-steps", gvar);
 297                         *data = g_variant_builder_end(&gvb);
 298                         break;
 299                 default:
 300                         return SR_ERR_NA;
 301                 }
 302         } else {
 303                 switch (key) {
 304                 case SR_CONF_DEVICE_OPTIONS:
 305                         if (bl_acme_get_probe_type(cg) == PROBE_ENRG)
 306                                 devopts_cg[num_devopts_cg++] = HAS_PROBE_FACTOR;
 307                         if (bl_acme_probe_has_pws(cg))
 308                                 devopts_cg[num_devopts_cg++] = HAS_POWER_OFF;
 309
 310                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 311                                 devopts_cg, num_devopts_cg, sizeof(uint32_t));
 312                         break;
 313                 default:
 314                         return SR_ERR_NA;
 315                 }
 316         }
 317
 318         return ret;
 319 }
 320
 321 static void dev_acquisition_close(const struct sr_dev_inst *sdi)
 322 {
 323         GSList *chl;
 324         struct sr_channel *ch;
 325
 326         for (chl = sdi->channels; chl; chl = chl->next) {
 327                 ch = chl->data;
 328                 bl_acme_close_channel(ch);
 329         }
 330 }
 331
 332 static int dev_acquisition_open(const struct sr_dev_inst *sdi)
 333 {
 334         GSList *chl;
 335         struct sr_channel *ch;
 336
 337         for (chl = sdi->channels; chl; chl = chl->next) {
 338                 ch = chl->data;
 339                 if (bl_acme_open_channel(ch)) {
 340                         sr_err("Error opening channel %s", ch->name);
 341                         dev_acquisition_close(sdi);
 342                         return SR_ERR;
 343                 }
 344         }
 345
 346         return 0;
 347 }
 348
 349 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 350 {
 351         struct dev_context *devc;
 352
 353         (void)cb_data;
 354
 355         if (sdi->status != SR_ST_ACTIVE)
 356                 return SR_ERR_DEV_CLOSED;
 357
 358         if (dev_acquisition_open(sdi))
 359                 return SR_ERR;
 360
 361         devc = sdi->priv;
 362         devc->samples_read = 0;
 363
 364         if (pipe(devc->pipe_fds)) {
 365                 sr_err("Error setting up pipe");
 366                 return SR_ERR;
 367         }
 368
 369         devc->channel = g_io_channel_unix_new(devc->pipe_fds[0]);
 370         g_io_channel_set_flags(devc->channel, G_IO_FLAG_NONBLOCK, NULL);
 371         g_io_channel_set_encoding(devc->channel, NULL, NULL);
 372         g_io_channel_set_buffered(devc->channel, FALSE);
 373
 374         sr_session_source_add_channel(sdi->session, devc->channel,
 375                 G_IO_IN | G_IO_ERR, 1, bl_acme_receive_data, (void *)sdi);
 376
 377         /* Send header packet to the session bus. */
 378         std_session_send_df_header(sdi, LOG_PREFIX);
 379         devc->start_time = g_get_monotonic_time();
 380
 381         return SR_OK;
 382 }
 383
 384 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 385 {
 386         struct sr_datafeed_packet packet;
 387         struct dev_context *devc;
 388
 389         (void)cb_data;
 390
 391         devc = sdi->priv;
 392
 393         if (sdi->status != SR_ST_ACTIVE)
 394                 return SR_ERR_DEV_CLOSED;
 395
 396         sr_session_source_remove_channel(sdi->session, devc->channel);
 397         g_io_channel_shutdown(devc->channel, FALSE, NULL);
 398         g_io_channel_unref(devc->channel);
 399         devc->channel = NULL;
 400
 401         /* Send last packet. */
 402         packet.type = SR_DF_END;
 403         sr_session_send(sdi, &packet);
 404
 405         return SR_OK;
 406 }
 407
 408 SR_PRIV struct sr_dev_driver baylibre_acme_driver_info = {
 409         .name = "baylibre-acme",
 410         .longname = "BayLibre ACME (Another Cute Measurement Equipment)",
 411         .api_version = 1,
 412         .init = init,
 413         .cleanup = cleanup,
 414         .scan = scan,
 415         .dev_list = dev_list,
 416         .dev_clear = dev_clear,
 417         .config_get = config_get,
 418         .config_set = config_set,
 419         .config_list = config_list,
 420         .dev_open = dev_open,
 421         .dev_close = dev_close,
 422         .dev_acquisition_start = dev_acquisition_start,
 423         .dev_acquisition_stop = dev_acquisition_stop,
 424         .priv = NULL,
 425 };