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