src/hardware/baylibre-acme/protocol.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 <string.h>
  21 #include <stdlib.h>
  22 #include <errno.h>
  23 #include <fcntl.h>
  24 #include <glib/gstdio.h>
  25 #include "protocol.h"
  26 #include "gpio.h"
  27
  28 struct channel_group_priv {
  29         int hwmon_num;
  30         int probe_type;
  31         int index;
  32 };
  33
  34 struct channel_priv {
  35         int ch_type;
  36         struct channel_group_priv *probe;
  37 };
  38
  39 static const uint8_t enrg_i2c_addrs[] = {
  40         0x40, 0x41, 0x44, 0x45, 0x42, 0x43, 0x46, 0x47,
  41 };
  42
  43 static const uint8_t temp_i2c_addrs[] = {
  44         0x0, 0x0, 0x0, 0x0, 0x4c, 0x49, 0x4f, 0x4b,
  45 };
  46
  47 static const uint32_t pws_gpios[] = {
  48         486, 498, 502, 482, 478, 506, 510, 474,
  49 };
  50
  51 static const uint32_t pws_info_gpios[] = {
  52         487, 499, 503, 483, 479, 507, 511, 475,
  53 };
  54
  55 #define MOHM_TO_UOHM(x) ((x) * 1000)
  56 #define UOHM_TO_MOHM(x) ((x) / 1000)
  57
  58 SR_PRIV uint8_t bl_acme_get_enrg_addr(int index)
  59 {
  60         return enrg_i2c_addrs[index];
  61 }
  62
  63 SR_PRIV uint8_t bl_acme_get_temp_addr(int index)
  64 {
  65         return temp_i2c_addrs[index];
  66 }
  67
  68 SR_PRIV gboolean bl_acme_is_sane(void)
  69 {
  70         gboolean status;
  71
  72         /*
  73          * We expect sysfs to be present and mounted at /sys, ina226 and
  74          * tmp435 sensors detected by the system and their appropriate
  75          * drivers loaded and functional.
  76          */
  77         status = g_file_test("/sys", G_FILE_TEST_IS_DIR);
  78         if (!status) {
  79                 sr_err("/sys/ directory not found - sysfs not mounted?");
  80                 return FALSE;
  81         }
  82
  83         return TRUE;
  84 }
  85
  86 static void probe_name_path(unsigned int addr, GString *path)
  87 {
  88         g_string_printf(path,
  89                         "/sys/class/i2c-adapter/i2c-1/1-00%02x/name", addr);
  90 }
  91
  92 /*
  93  * For given address fill buf with the path to appropriate hwmon entry.
  94  */
  95 static void probe_hwmon_path(unsigned int addr, GString *path)
  96 {
  97         g_string_printf(path,
  98                         "/sys/class/i2c-adapter/i2c-1/1-00%02x/hwmon", addr);
  99 }
 100
 101 SR_PRIV gboolean bl_acme_detect_probe(unsigned int addr,
 102                                       int prb_num, const char *prb_name)
 103 {
 104         gboolean ret = FALSE, status;
 105         char *buf = NULL;
 106         GString *path = g_string_sized_new(64);
 107         GError *err = NULL;
 108         gsize size;
 109
 110         probe_name_path(addr, path);
 111         status = g_file_get_contents(path->str, &buf, &size, &err);
 112         if (!status) {
 113                 sr_dbg("Name for probe %d can't be read: %s",
 114                        prb_num, err->message);
 115                 g_string_free(path, TRUE);
 116                 return ret;
 117         }
 118
 119         if (!strncmp(buf, prb_name, strlen(prb_name))) {
 120                 /*
 121                  * Correct driver registered on this address - but is
 122                  * there an actual probe connected?
 123                  */
 124                 probe_hwmon_path(addr, path);
 125                 status = g_file_test(path->str, G_FILE_TEST_IS_DIR);
 126                 if (status) {
 127                         /* We have found an ACME probe. */
 128                         ret = TRUE;
 129                 }
 130         }
 131
 132         g_free(buf);
 133         g_string_free(path, TRUE);
 134
 135         return ret;
 136 }
 137
 138 static int get_hwmon_index(unsigned int addr)
 139 {
 140         int status, hwmon;
 141         GString *path = g_string_sized_new(64);
 142         GError *err = NULL;
 143         GDir *dir;
 144
 145         probe_hwmon_path(addr, path);
 146         dir = g_dir_open(path->str, 0, &err);
 147         if (!dir) {
 148                 sr_err("Error opening %s: %s", path->str, err->message);
 149                 g_string_free(path, TRUE);
 150                 return -1;
 151         }
 152
 153         g_string_free(path, TRUE);
 154
 155         /*
 156          * The directory should contain a single file named hwmonX where X
 157          * is the hwmon index.
 158          */
 159         status = sscanf(g_dir_read_name(dir), "hwmon%d", &hwmon);
 160         g_dir_close(dir);
 161         if (status != 1) {
 162                 sr_err("Unable to determine the hwmon entry");
 163                 return -1;
 164         }
 165
 166         return hwmon;
 167 }
 168
 169 static void append_channel(struct sr_dev_inst *sdi, struct sr_channel_group *cg,
 170                            int index, int type)
 171 {
 172         struct channel_priv *cp;
 173         struct dev_context *devc;
 174         struct sr_channel *ch;
 175         char *name;
 176
 177         devc = sdi->priv;
 178
 179         switch (type) {
 180         case ENRG_PWR:
 181                 name = g_strdup_printf("P%d_ENRG_PWR", index);
 182                 break;
 183         case ENRG_CURR:
 184                 name = g_strdup_printf("P%d_ENRG_CURR", index);
 185                 break;
 186         case ENRG_VOL:
 187                 name = g_strdup_printf("P%d_ENRG_VOL", index);
 188                 break;
 189         case TEMP_IN:
 190                 name = g_strdup_printf("P%d_TEMP_IN", index);
 191                 break;
 192         case TEMP_OUT:
 193                 name = g_strdup_printf("P%d_TEMP_OUT", index);
 194                 break;
 195         default:
 196                 sr_err("Invalid channel type: %d.", type);
 197                 return;
 198         }
 199
 200         cp = g_malloc0(sizeof(struct channel_priv));
 201         cp->ch_type = type;
 202         cp->probe = cg->priv;
 203
 204         ch = sr_channel_new(devc->num_channels++,
 205                             SR_CHANNEL_ANALOG, TRUE, name);
 206         g_free(name);
 207
 208         ch->priv = cp;
 209         cg->channels = g_slist_append(cg->channels, ch);
 210         sdi->channels = g_slist_append(sdi->channels, ch);
 211 }
 212
 213 SR_PRIV gboolean bl_acme_register_probe(struct sr_dev_inst *sdi, int type,
 214                                         unsigned int addr, int prb_num)
 215 {
 216         struct sr_channel_group *cg;
 217         struct channel_group_priv *cgp;
 218         int hwmon;
 219
 220         /* Obtain the hwmon index. */
 221         hwmon = get_hwmon_index(addr);
 222         if (hwmon < 0)
 223                 return FALSE;
 224
 225         cg = g_malloc0(sizeof(struct sr_channel_group));
 226         cgp = g_malloc0(sizeof(struct channel_group_priv));
 227         cgp->hwmon_num = hwmon;
 228         cgp->probe_type = type;
 229         cgp->index = prb_num - 1;
 230         cg->name = g_strdup_printf("Probe_%d", prb_num);
 231         cg->priv = cgp;
 232
 233         if (type == PROBE_ENRG) {
 234                 append_channel(sdi, cg, prb_num, ENRG_PWR);
 235                 append_channel(sdi, cg, prb_num, ENRG_CURR);
 236                 append_channel(sdi, cg, prb_num, ENRG_VOL);
 237         } else if (type == PROBE_TEMP) {
 238                 append_channel(sdi, cg, prb_num, TEMP_IN);
 239                 append_channel(sdi, cg, prb_num, TEMP_OUT);
 240         } else {
 241                 sr_err("Invalid probe type: %d.", type);
 242         }
 243
 244         sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
 245
 246         return TRUE;
 247 }
 248
 249 /*
 250  * Sets path to the hwmon attribute if this channel group
 251  * supports shunt resistance setting. The caller has to supply
 252  * a valid GString.
 253  */
 254 static int get_shunt_path(const struct sr_channel_group *cg, GString *path)
 255 {
 256         struct channel_group_priv *cgp;
 257         int ret = SR_OK, status;
 258
 259         cgp = cg->priv;
 260
 261         if (cgp->probe_type != PROBE_ENRG) {
 262                 sr_err("Probe doesn't support shunt resistance setting");
 263                 return SR_ERR_ARG;
 264         }
 265
 266         g_string_append_printf(path,
 267                                "/sys/class/hwmon/hwmon%d/shunt_resistor",
 268                                cgp->hwmon_num);
 269
 270         /*
 271          * The shunt_resistor sysfs attribute is available
 272          * in the Linux kernel since version 3.20. We have
 273          * to notify the user if this attribute is not present.
 274          */
 275         status = g_file_test(path->str, G_FILE_TEST_EXISTS);
 276         if (!status) {
 277                 sr_err("shunt_resistance attribute not present, please update "
 278                        "your kernel to version >=3.20");
 279                 return SR_ERR_NA;
 280         }
 281
 282         return ret;
 283 }
 284
 285 SR_PRIV int bl_acme_get_shunt(const struct sr_channel_group *cg,
 286                               uint64_t *shunt)
 287 {
 288         GString *path = g_string_sized_new(64);
 289         gchar *contents;
 290         int status, ret = SR_OK;
 291         GError *err = NULL;
 292
 293         status = get_shunt_path(cg, path);
 294         if (status != SR_OK) {
 295                 ret = status;
 296                 goto out;
 297         }
 298
 299         status = g_file_get_contents(path->str, &contents, NULL, &err);
 300         if (!status) {
 301                 sr_err("Error reading shunt resistance: %s", err->message);
 302                 ret = SR_ERR_IO;
 303                 goto out;
 304         }
 305
 306         *shunt = UOHM_TO_MOHM(strtol(contents, NULL, 10));
 307
 308 out:
 309         g_string_free(path, TRUE);
 310         return ret;
 311 }
 312
 313 SR_PRIV int bl_acme_set_shunt(const struct sr_channel_group *cg, uint64_t shunt)
 314 {
 315         GString *path = g_string_sized_new(64);;
 316         int status, ret = SR_OK;
 317         FILE *fd;
 318
 319         status = get_shunt_path(cg, path);
 320         if (status != SR_OK) {
 321                 ret = status;
 322                 goto out;
 323         }
 324
 325         /*
 326          * Can't use g_file_set_contents() here, as it calls open() with
 327          * O_EXEC flag in a sysfs directory thus failing with EACCES.
 328          */
 329         fd = g_fopen(path->str, "w");
 330         if (!fd) {
 331                 sr_err("Error opening %s: %s", path->str, strerror(errno));
 332                 g_string_free(path, TRUE);
 333                 return SR_ERR_IO;
 334         }
 335
 336         g_string_free(path, TRUE);
 337         g_fprintf(fd, "%" PRIu64 "\n", MOHM_TO_UOHM(shunt));
 338         /*
 339          * XXX There's no g_fclose() in GLib. This seems to work,
 340          * but is it safe?
 341          */
 342         fclose(fd);
 343
 344 out:
 345         g_string_free(path, TRUE);
 346         return ret;
 347 }
 348
 349 SR_PRIV int bl_acme_read_power_state(const struct sr_channel_group *cg,
 350                                      gboolean *off)
 351 {
 352         struct channel_group_priv *cgp;
 353         int val;
 354
 355         cgp = cg->priv;
 356
 357         val = sr_gpio_getval_export(pws_info_gpios[cgp->index]);
 358         if (val != 1) {
 359                 sr_err("Probe has no power-switch");
 360                 return SR_ERR_ARG;
 361         }
 362
 363         val = sr_gpio_getval_export(pws_gpios[cgp->index]);
 364         *off = val ? FALSE : TRUE;
 365
 366         return SR_OK;
 367 }
 368
 369 SR_PRIV int bl_acme_set_power_off(const struct sr_channel_group *cg,
 370                                   gboolean off)
 371 {
 372         struct channel_group_priv *cgp;
 373         int val;
 374
 375         cgp = cg->priv;
 376
 377         val = sr_gpio_getval_export(pws_info_gpios[cgp->index]);
 378         if (val != 1) {
 379                 sr_err("Probe has no power-switch");
 380                 return SR_ERR_ARG;
 381         }
 382
 383         val = sr_gpio_setval_export(pws_gpios[cgp->index], off ? 0 : 1);
 384
 385         return SR_OK;
 386 }
 387
 388 static int channel_to_mq(struct sr_channel *ch)
 389 {
 390         struct channel_priv *chp;
 391
 392         chp = ch->priv;
 393
 394         switch (chp->ch_type) {
 395         case ENRG_PWR:
 396                 return SR_MQ_POWER;
 397         case ENRG_CURR:
 398                 return SR_MQ_CURRENT;
 399         case ENRG_VOL:
 400                 return SR_MQ_VOLTAGE;
 401         case TEMP_IN: /* Fallthrough */
 402         case TEMP_OUT:
 403                 return SR_MQ_TEMPERATURE;
 404         default:
 405                 return -1;
 406         }
 407 }
 408
 409 static int channel_to_unit(struct sr_channel *ch)
 410 {
 411         struct channel_priv *chp;
 412
 413         chp = ch->priv;
 414
 415         switch (chp->ch_type) {
 416         case ENRG_PWR:
 417                 return SR_UNIT_WATT;
 418         case ENRG_CURR:
 419                 return SR_UNIT_AMPERE;
 420         case ENRG_VOL:
 421                 return SR_UNIT_VOLT;
 422         case TEMP_IN: /* Fallthrough */
 423         case TEMP_OUT:
 424                 return SR_UNIT_CELSIUS;
 425         default:
 426                 return -1;
 427         }
 428 }
 429
 430 /* We need to scale measurements down from the units used by the drivers. */
 431 static float adjust_data(int val, int type)
 432 {
 433         switch (type) {
 434         case ENRG_PWR:
 435                 return ((float)val) / 1000000.0;
 436         case ENRG_CURR: /* Fallthrough */
 437         case ENRG_VOL: /* Fallthrough */
 438         case TEMP_IN: /* Fallthrough */
 439         case TEMP_OUT:
 440                 return ((float)val) / 1000.0;
 441         default:
 442                 return 0.0;
 443         }
 444 }
 445
 446 static float read_sample(struct sr_channel *ch)
 447 {
 448         struct channel_priv *chp;
 449         char path[64], *file, buf[16];
 450         ssize_t len;
 451         int fd;
 452
 453         chp = ch->priv;
 454
 455         switch (chp->ch_type) {
 456         case ENRG_PWR:  file = "power1_input";  break;
 457         case ENRG_CURR: file = "curr1_input";   break;
 458         case ENRG_VOL:  file = "in1_input";     break;
 459         case TEMP_IN:   file = "temp1_input";   break;
 460         case TEMP_OUT:  file = "temp2_input";   break;
 461         default:
 462                 sr_err("Invalid channel type: %d.", chp->ch_type);
 463                 return -1.0;
 464         }
 465
 466         snprintf(path, sizeof(path), "/sys/class/hwmon/hwmon%d/%s",
 467                  chp->probe->hwmon_num, file);
 468         fd = open(path, O_RDONLY);
 469         if (fd < 0) {
 470                 sr_err("Error opening %s: %s", path, strerror(errno));
 471                 ch->enabled = FALSE;
 472                 return -1.0;
 473         }
 474
 475         len = read(fd, buf, sizeof(buf));
 476         close(fd);
 477         if (len < 0) {
 478                 sr_err("Error reading from %s: %s", path, strerror(errno));
 479                 ch->enabled = FALSE;
 480                 return -1.0;
 481         }
 482
 483         return adjust_data(strtol(buf, NULL, 10), chp->ch_type);
 484 }
 485
 486 SR_PRIV int bl_acme_receive_data(int fd, int revents, void *cb_data)
 487 {
 488         uint32_t cur_time, elapsed_time, diff_time;
 489         int64_t time_to_sleep;
 490         struct sr_datafeed_packet packet, framep;
 491         struct sr_datafeed_analog analog;
 492         struct sr_dev_inst *sdi;
 493         struct sr_channel *ch;
 494         struct dev_context *devc;
 495         GSList *chl, chonly;
 496         float valf;
 497
 498         (void)fd;
 499         (void)revents;
 500
 501         sdi = cb_data;
 502         if (!sdi)
 503                 return TRUE;
 504
 505         devc = sdi->priv;
 506         if (!devc)
 507                 return TRUE;
 508
 509         packet.type = SR_DF_ANALOG;
 510         packet.payload = &analog;
 511         memset(&analog, 0, sizeof(analog));
 512         analog.data = &valf;
 513
 514         /*
 515          * Reading from sysfs takes some time - try to keep up with samplerate.
 516          */
 517         if (devc->samples_read) {
 518                 cur_time = g_get_monotonic_time();
 519                 diff_time = cur_time - devc->last_sample_fin;
 520                 time_to_sleep = G_USEC_PER_SEC / devc->samplerate - diff_time;
 521                 if (time_to_sleep > 0)
 522                         g_usleep(time_to_sleep);
 523         }
 524
 525         framep.type = SR_DF_FRAME_BEGIN;
 526         sr_session_send(cb_data, &framep);
 527
 528         /*
 529          * Due to different units used in each channel we're sending
 530          * samples one-by-one.
 531          */
 532         for (chl = sdi->channels; chl; chl = chl->next) {
 533                 ch = chl->data;
 534                 if (!ch->enabled)
 535                         continue;
 536                 chonly.next = NULL;
 537                 chonly.data = ch;
 538                 analog.channels = &chonly;
 539                 analog.num_samples = 1;
 540                 analog.mq = channel_to_mq(chl->data);
 541                 analog.unit = channel_to_unit(ch);
 542
 543                 valf = read_sample(ch);
 544
 545                 sr_session_send(cb_data, &packet);
 546         }
 547
 548         framep.type = SR_DF_FRAME_END;
 549         sr_session_send(cb_data, &framep);
 550
 551         devc->samples_read++;
 552         if (devc->limit_samples > 0 &&
 553             devc->samples_read >= devc->limit_samples) {
 554                 sr_info("Requested number of samples reached.");
 555                 sdi->driver->dev_acquisition_stop(sdi, cb_data);
 556                 devc->last_sample_fin = g_get_monotonic_time();
 557                 return TRUE;
 558         } else if (devc->limit_msec > 0) {
 559                 cur_time = g_get_monotonic_time();
 560                 elapsed_time = cur_time - devc->start_time;
 561
 562                 if (elapsed_time >= devc->limit_msec) {
 563                         sr_info("Sampling time limit reached.");
 564                         sdi->driver->dev_acquisition_stop(sdi, cb_data);
 565                         devc->last_sample_fin = g_get_monotonic_time();
 566                         return TRUE;
 567                 }
 568         }
 569
 570         devc->last_sample_fin = g_get_monotonic_time();
 571         return TRUE;
 572 }