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