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,
  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 int dev_open(struct sr_dev_inst *sdi)
 146 {
 147         (void)sdi;
 148
 149         sdi->status = SR_ST_ACTIVE;
 150
 151         return SR_OK;
 152 }
 153
 154 static int dev_close(struct sr_dev_inst *sdi)
 155 {
 156         (void)sdi;
 157
 158         sdi->status = SR_ST_INACTIVE;
 159
 160         return SR_OK;
 161 }
 162
 163 static int config_get(uint32_t key, GVariant **data,
 164                       const struct sr_dev_inst *sdi,
 165                       const struct sr_channel_group *cg)
 166 {
 167         struct dev_context *devc;
 168         int ret;
 169         uint64_t shunt;
 170         gboolean power_off;
 171
 172         devc = sdi->priv;
 173
 174         ret = SR_OK;
 175         switch (key) {
 176         case SR_CONF_LIMIT_SAMPLES:
 177         case SR_CONF_LIMIT_MSEC:
 178                 ret = sr_sw_limits_config_get(&devc->limits, key, data);
 179                 break;
 180         case SR_CONF_SAMPLERATE:
 181                 *data = g_variant_new_uint64(devc->samplerate);
 182                 break;
 183         case SR_CONF_PROBE_FACTOR:
 184                 if (!cg)
 185                         return SR_ERR_CHANNEL_GROUP;
 186                 ret = bl_acme_get_shunt(cg, &shunt);
 187                 if (ret == SR_OK)
 188                         *data = g_variant_new_uint64(shunt);
 189                 break;
 190         case SR_CONF_POWER_OFF:
 191                 if (!cg)
 192                         return SR_ERR_CHANNEL_GROUP;
 193                 ret = bl_acme_read_power_state(cg, &power_off);
 194                 if (ret == SR_OK)
 195                         *data = g_variant_new_boolean(power_off);
 196                 break;
 197         default:
 198                 return SR_ERR_NA;
 199         }
 200
 201         return ret;
 202 }
 203
 204 static int config_set(uint32_t key, GVariant *data,
 205                       const struct sr_dev_inst *sdi,
 206                       const struct sr_channel_group *cg)
 207 {
 208         struct dev_context *devc;
 209         uint64_t samplerate;
 210         int ret;
 211
 212         if (sdi->status != SR_ST_ACTIVE)
 213                 return SR_ERR_DEV_CLOSED;
 214
 215         devc = sdi->priv;
 216
 217         ret = SR_OK;
 218         switch (key) {
 219         case SR_CONF_LIMIT_SAMPLES:
 220         case SR_CONF_LIMIT_MSEC:
 221                 ret = sr_sw_limits_config_set(&devc->limits, key, data);
 222                 break;
 223         case SR_CONF_SAMPLERATE:
 224                 samplerate = g_variant_get_uint64(data);
 225                 if (samplerate > MAX_SAMPLE_RATE) {
 226                         sr_err("Maximum sample rate is %d", MAX_SAMPLE_RATE);
 227                         ret = SR_ERR_SAMPLERATE;
 228                         break;
 229                 }
 230                 devc->samplerate = samplerate;
 231                 bl_acme_maybe_set_update_interval(sdi, samplerate);
 232                 break;
 233         case SR_CONF_PROBE_FACTOR:
 234                 if (!cg)
 235                         return SR_ERR_CHANNEL_GROUP;
 236                 ret = bl_acme_set_shunt(cg, g_variant_get_uint64(data));
 237                 break;
 238         case SR_CONF_POWER_OFF:
 239                 if (!cg)
 240                         return SR_ERR_CHANNEL_GROUP;
 241                 ret = bl_acme_set_power_off(cg, g_variant_get_boolean(data));
 242                 break;
 243         default:
 244                 ret = SR_ERR_NA;
 245         }
 246
 247         return ret;
 248 }
 249
 250 static int config_list(uint32_t key, GVariant **data,
 251                        const struct sr_dev_inst *sdi,
 252                        const struct sr_channel_group *cg)
 253 {
 254         uint32_t devopts_cg[MAX_DEVOPTS_CG];
 255         GVariant *gvar;
 256         GVariantBuilder gvb;
 257         int ret, num_devopts_cg = 0;
 258
 259         (void)sdi;
 260         (void)cg;
 261
 262         ret = SR_OK;
 263         if (!cg) {
 264                 switch (key) {
 265                 case SR_CONF_DEVICE_OPTIONS:
 266                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 267                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 268                         break;
 269                 case SR_CONF_SAMPLERATE:
 270                         g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 271                         gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 272                                 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
 273                         g_variant_builder_add(&gvb, "{sv}",
 274                                               "samplerate-steps", gvar);
 275                         *data = g_variant_builder_end(&gvb);
 276                         break;
 277                 default:
 278                         return SR_ERR_NA;
 279                 }
 280         } else {
 281                 switch (key) {
 282                 case SR_CONF_DEVICE_OPTIONS:
 283                         if (bl_acme_get_probe_type(cg) == PROBE_ENRG)
 284                                 devopts_cg[num_devopts_cg++] = HAS_PROBE_FACTOR;
 285                         if (bl_acme_probe_has_pws(cg))
 286                                 devopts_cg[num_devopts_cg++] = HAS_POWER_OFF;
 287
 288                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 289                                 devopts_cg, num_devopts_cg, sizeof(uint32_t));
 290                         break;
 291                 default:
 292                         return SR_ERR_NA;
 293                 }
 294         }
 295
 296         return ret;
 297 }
 298
 299 static void dev_acquisition_close(const struct sr_dev_inst *sdi)
 300 {
 301         GSList *chl;
 302         struct sr_channel *ch;
 303
 304         for (chl = sdi->channels; chl; chl = chl->next) {
 305                 ch = chl->data;
 306                 bl_acme_close_channel(ch);
 307         }
 308 }
 309
 310 static int dev_acquisition_open(const struct sr_dev_inst *sdi)
 311 {
 312         GSList *chl;
 313         struct sr_channel *ch;
 314
 315         for (chl = sdi->channels; chl; chl = chl->next) {
 316                 ch = chl->data;
 317                 if (bl_acme_open_channel(ch)) {
 318                         sr_err("Error opening channel %s", ch->name);
 319                         dev_acquisition_close(sdi);
 320                         return SR_ERR;
 321                 }
 322         }
 323
 324         return 0;
 325 }
 326
 327 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 328 {
 329         struct dev_context *devc;
 330         struct itimerspec tspec = {
 331                 .it_interval = { 0, 0 },
 332                 .it_value = { 0, 0 }
 333         };
 334
 335         if (sdi->status != SR_ST_ACTIVE)
 336                 return SR_ERR_DEV_CLOSED;
 337
 338         if (dev_acquisition_open(sdi))
 339                 return SR_ERR;
 340
 341         devc = sdi->priv;
 342         devc->samples_missed = 0;
 343         devc->timer_fd = timerfd_create(CLOCK_MONOTONIC, 0);
 344         if (devc->timer_fd < 0) {
 345                 sr_err("Error creating timer fd");
 346                 return SR_ERR;
 347         }
 348
 349         tspec.it_interval.tv_sec = 0;
 350         tspec.it_interval.tv_nsec = SR_HZ_TO_NS(devc->samplerate);
 351         tspec.it_value = tspec.it_interval;
 352
 353         if (timerfd_settime(devc->timer_fd, 0, &tspec, NULL)) {
 354                 sr_err("Failed to set timer");
 355                 close(devc->timer_fd);
 356                 return SR_ERR;
 357         }
 358
 359         devc->channel = g_io_channel_unix_new(devc->timer_fd);
 360         g_io_channel_set_flags(devc->channel, G_IO_FLAG_NONBLOCK, NULL);
 361         g_io_channel_set_encoding(devc->channel, NULL, NULL);
 362         g_io_channel_set_buffered(devc->channel, FALSE);
 363
 364         sr_session_source_add_channel(sdi->session, devc->channel,
 365                 G_IO_IN | G_IO_ERR, 1000, bl_acme_receive_data, (void *)sdi);
 366
 367         std_session_send_df_header(sdi, LOG_PREFIX);
 368         sr_sw_limits_acquisition_start(&devc->limits);
 369
 370         return SR_OK;
 371 }
 372
 373 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 374 {
 375         struct dev_context *devc;
 376
 377         devc = sdi->priv;
 378
 379         if (sdi->status != SR_ST_ACTIVE)
 380                 return SR_ERR_DEV_CLOSED;
 381
 382         dev_acquisition_close(sdi);
 383         sr_session_source_remove_channel(sdi->session, devc->channel);
 384         g_io_channel_shutdown(devc->channel, FALSE, NULL);
 385         g_io_channel_unref(devc->channel);
 386         devc->channel = NULL;
 387
 388         std_session_send_df_end(sdi, LOG_PREFIX);
 389
 390         if (devc->samples_missed > 0)
 391                 sr_warn("%" PRIu64 " samples missed", devc->samples_missed);
 392
 393         return SR_OK;
 394 }
 395
 396 SR_PRIV struct sr_dev_driver baylibre_acme_driver_info = {
 397         .name = "baylibre-acme",
 398         .longname = "BayLibre ACME (Another Cute Measurement Equipment)",
 399         .api_version = 1,
 400         .init = init,
 401         .cleanup = std_cleanup,
 402         .scan = scan,
 403         .dev_list = std_dev_list,
 404         .config_get = config_get,
 405         .config_set = config_set,
 406         .config_list = config_list,
 407         .dev_open = dev_open,
 408         .dev_close = dev_close,
 409         .dev_acquisition_start = dev_acquisition_start,
 410         .dev_acquisition_stop = dev_acquisition_stop,
 411         .context = NULL,
 412 };