2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com>
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.
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.
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/>.
26 #include <arpa/inet.h>
27 #include <glib/gstdio.h>
42 struct channel_group_priv {
56 struct channel_group_priv *probe;
59 #define EEPROM_SERIAL_SIZE 16
60 #define EEPROM_TAG_SIZE 32
62 #define EEPROM_PROBE_TYPE_USB 1
63 #define EEPROM_PROBE_TYPE_JACK 2
64 #define EEPROM_PROBE_TYPE_HE10 3
71 uint8_t serial[EEPROM_SERIAL_SIZE];
72 int8_t tag[EEPROM_TAG_SIZE];
75 #define EEPROM_SIZE (3 * sizeof(uint32_t) + 1 + EEPROM_SERIAL_SIZE + EEPROM_TAG_SIZE)
77 #define EEPROM_OFF_TYPE 0
78 #define EEPROM_OFF_REV sizeof(uint32_t)
79 #define EEPROM_OFF_SHUNT (2 * sizeof(uint32_t))
80 #define EEPROM_OFF_PWR_SW (3 * sizeof(uint32_t))
81 #define EEPROM_OFF_SERIAL (3 * sizeof(uint32_t) + 1)
82 #define EEPROM_OFF_TAG (EEPROM_OFF_SERIAL + EEPROM_SERIAL_SIZE)
84 static const uint8_t enrg_i2c_addrs[] = {
85 0x40, 0x41, 0x44, 0x45, 0x42, 0x43, 0x46, 0x47,
88 static const uint8_t temp_i2c_addrs[] = {
89 0x0, 0x0, 0x0, 0x0, 0x4c, 0x49, 0x4f, 0x4b,
92 static const uint32_t revA_pws_gpios[] = {
93 486, 498, 502, 482, 478, 506, 510, 474,
96 static const uint32_t revA_pws_info_gpios[] = {
97 487, 499, 503, 483, 479, 507, 511, 475,
100 static const uint32_t revB_pws_gpios[] = {
101 489, 491, 493, 495, 497, 499, 501, 503,
104 #define MOHM_TO_UOHM(x) ((x) * 1000)
105 #define UOHM_TO_MOHM(x) ((x) / 1000)
107 SR_PRIV uint8_t bl_acme_get_enrg_addr(int index)
109 return enrg_i2c_addrs[index];
112 SR_PRIV uint8_t bl_acme_get_temp_addr(int index)
114 return temp_i2c_addrs[index];
117 SR_PRIV gboolean bl_acme_is_sane(void)
122 * We expect sysfs to be present and mounted at /sys, ina226 and
123 * tmp435 sensors detected by the system and their appropriate
124 * drivers loaded and functional.
126 status = g_file_test("/sys", G_FILE_TEST_IS_DIR);
128 sr_err("/sys/ directory not found - sysfs not mounted?");
135 static void probe_name_path(unsigned int addr, GString *path)
137 g_string_printf(path,
138 "/sys/class/i2c-adapter/i2c-1/1-00%02x/name", addr);
142 * For given address fill buf with the path to appropriate hwmon entry.
144 static void probe_hwmon_path(unsigned int addr, GString *path)
146 g_string_printf(path,
147 "/sys/class/i2c-adapter/i2c-1/1-00%02x/hwmon", addr);
150 static void probe_eeprom_path(unsigned int addr, GString *path)
152 g_string_printf(path,
153 "/sys/class/i2c-dev/i2c-1/device/1-00%02x/eeprom",
157 SR_PRIV gboolean bl_acme_detect_probe(unsigned int addr,
158 int prb_num, const char *prb_name)
160 gboolean ret = FALSE, status;
162 GString *path = g_string_sized_new(64);
166 probe_name_path(addr, path);
167 status = g_file_get_contents(path->str, &buf, &size, &err);
169 sr_dbg("Name for probe %d can't be read: %s",
170 prb_num, err->message);
171 g_string_free(path, TRUE);
176 if (!strncmp(buf, prb_name, strlen(prb_name))) {
178 * Correct driver registered on this address - but is
179 * there an actual probe connected?
181 probe_hwmon_path(addr, path);
182 status = g_file_test(path->str, G_FILE_TEST_IS_DIR);
184 /* We have found an ACME probe. */
190 g_string_free(path, TRUE);
195 static int get_hwmon_index(unsigned int addr)
198 GString *path = g_string_sized_new(64);
202 probe_hwmon_path(addr, path);
203 dir = g_dir_open(path->str, 0, &err);
205 sr_err("Error opening %s: %s", path->str, err->message);
206 g_string_free(path, TRUE);
211 g_string_free(path, TRUE);
214 * The directory should contain a single file named hwmonX where X
215 * is the hwmon index.
217 status = sscanf(g_dir_read_name(dir), "hwmon%d", &hwmon);
220 sr_err("Unable to determine the hwmon entry");
227 static void append_channel(struct sr_dev_inst *sdi, struct sr_channel_group *cg,
230 struct channel_priv *cp;
231 struct dev_context *devc;
232 struct sr_channel *ch;
239 name = g_strdup_printf("P%d_ENRG_PWR", index);
242 name = g_strdup_printf("P%d_ENRG_CURR", index);
245 name = g_strdup_printf("P%d_ENRG_VOL", index);
248 name = g_strdup_printf("P%d_TEMP_IN", index);
251 name = g_strdup_printf("P%d_TEMP_OUT", index);
254 sr_err("Invalid channel type: %d.", type);
258 cp = g_malloc0(sizeof(struct channel_priv));
260 cp->probe = cg->priv;
262 ch = sr_channel_new(sdi, devc->num_channels++,
263 SR_CHANNEL_ANALOG, TRUE, name);
267 cg->channels = g_slist_append(cg->channels, ch);
270 static int read_probe_eeprom(unsigned int addr, struct probe_eeprom *eeprom)
272 GString *path = g_string_sized_new(64);
273 char eeprom_buf[EEPROM_SIZE];
277 probe_eeprom_path(addr, path);
278 fd = g_open(path->str, O_RDONLY);
279 g_string_free(path, TRUE);
283 rd = read(fd, eeprom_buf, EEPROM_SIZE);
285 if (rd != EEPROM_SIZE)
288 eeprom->type = RB32(eeprom_buf + EEPROM_OFF_TYPE);
289 eeprom->rev = RB32(eeprom_buf + EEPROM_OFF_REV);
290 eeprom->shunt = RB32(eeprom_buf + EEPROM_OFF_SHUNT);
291 eeprom->pwr_sw = R8(eeprom_buf + EEPROM_OFF_PWR_SW);
292 /* Don't care about the serial number and tag for now. */
294 /* Check if we have some sensible values. */
295 if (eeprom->rev != 'B')
296 /* 'B' is the only supported revision with EEPROM for now. */
299 if (eeprom->type != EEPROM_PROBE_TYPE_USB &&
300 eeprom->type != EEPROM_PROBE_TYPE_JACK &&
301 eeprom->type != EEPROM_PROBE_TYPE_HE10)
307 /* Some i2c slave addresses on revision B probes differ from revision A. */
308 static int revB_addr_to_num(unsigned int addr)
315 default: return addr - 0x3f;
319 SR_PRIV gboolean bl_acme_register_probe(struct sr_dev_inst *sdi, int type,
320 unsigned int addr, int prb_num)
322 struct sr_channel_group *cg;
323 struct channel_group_priv *cgp;
324 struct probe_eeprom eeprom;
328 /* Obtain the hwmon index. */
329 hwmon = get_hwmon_index(addr);
333 cg = g_malloc0(sizeof(struct sr_channel_group));
334 cgp = g_malloc0(sizeof(struct channel_group_priv));
338 * See if we can read the EEPROM contents. If not, assume it's
339 * a revision A probe.
341 memset(&eeprom, 0, sizeof(struct probe_eeprom));
342 status = read_probe_eeprom(addr, &eeprom);
343 cgp->rev = status < 0 ? ACME_REV_A : ACME_REV_B;
345 prb_num = cgp->rev == ACME_REV_A ? prb_num : revB_addr_to_num(addr);
347 cgp->hwmon_num = hwmon;
348 cgp->probe_type = type;
349 cgp->index = prb_num - 1;
350 cg->name = g_strdup_printf("Probe_%d", prb_num);
352 if (cgp->rev == ACME_REV_A) {
353 gpio = revA_pws_info_gpios[cgp->index];
354 cgp->has_pws = sr_gpio_getval_export(gpio);
355 cgp->pws_gpio = revA_pws_gpios[cgp->index];
357 cgp->has_pws = eeprom.pwr_sw;
358 cgp->pws_gpio = revB_pws_gpios[cgp->index];
361 * For revision B we can already try to set the shunt
362 * resistance according to the EEPROM contents.
364 * Keep the default value if shunt in EEPROM == 0.
366 if (eeprom.shunt > 0)
367 bl_acme_set_shunt(cg, UOHM_TO_MOHM(eeprom.shunt));
370 if (type == PROBE_ENRG) {
371 append_channel(sdi, cg, prb_num, ENRG_PWR);
372 append_channel(sdi, cg, prb_num, ENRG_CURR);
373 append_channel(sdi, cg, prb_num, ENRG_VOL);
374 } else if (type == PROBE_TEMP) {
375 append_channel(sdi, cg, prb_num, TEMP_IN);
376 append_channel(sdi, cg, prb_num, TEMP_OUT);
378 sr_err("Invalid probe type: %d.", type);
381 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
386 SR_PRIV int bl_acme_get_probe_type(const struct sr_channel_group *cg)
388 struct channel_group_priv *cgp = cg->priv;
390 return cgp->probe_type;
393 SR_PRIV int bl_acme_probe_has_pws(const struct sr_channel_group *cg)
395 struct channel_group_priv *cgp = cg->priv;
401 * Sets path to the hwmon attribute if this channel group
402 * supports shunt resistance setting. The caller has to supply
405 static int get_shunt_path(const struct sr_channel_group *cg, GString *path)
407 struct channel_group_priv *cgp;
408 int ret = SR_OK, status;
412 if (cgp->probe_type != PROBE_ENRG) {
413 sr_err("Probe doesn't support shunt resistance setting");
417 g_string_append_printf(path,
418 "/sys/class/hwmon/hwmon%d/shunt_resistor",
422 * The shunt_resistor sysfs attribute is available
423 * in the Linux kernel since version 3.20. We have
424 * to notify the user if this attribute is not present.
426 status = g_file_test(path->str, G_FILE_TEST_EXISTS);
428 sr_err("shunt_resistance attribute not present, please update "
429 "your kernel to version >=3.20");
437 * Try setting the update_interval sysfs attribute for each probe according
440 SR_PRIV void bl_acme_maybe_set_update_interval(const struct sr_dev_inst *sdi,
443 struct sr_channel_group *cg;
444 struct channel_group_priv *cgp;
449 for (l = sdi->channel_groups; l != NULL; l = l->next) {
453 hwmon = g_string_sized_new(64);
454 g_string_append_printf(hwmon,
455 "/sys/class/hwmon/hwmon%d/update_interval",
458 if (g_file_test(hwmon->str, G_FILE_TEST_EXISTS)) {
459 fd = g_fopen(hwmon->str, "w");
461 g_string_free(hwmon, TRUE);
465 g_fprintf(fd, "%" PRIu64 "\n", 1000 / samplerate);
469 g_string_free(hwmon, TRUE);
473 SR_PRIV int bl_acme_get_shunt(const struct sr_channel_group *cg,
476 GString *path = g_string_sized_new(64);
478 int status, ret = SR_OK;
481 status = get_shunt_path(cg, path);
482 if (status != SR_OK) {
487 status = g_file_get_contents(path->str, &contents, NULL, &err);
489 sr_err("Error reading shunt resistance: %s", err->message);
495 *shunt = UOHM_TO_MOHM(strtol(contents, NULL, 10));
498 g_string_free(path, TRUE);
502 SR_PRIV int bl_acme_set_shunt(const struct sr_channel_group *cg, uint64_t shunt)
504 GString *path = g_string_sized_new(64);;
505 int status, ret = SR_OK;
508 status = get_shunt_path(cg, path);
509 if (status != SR_OK) {
515 * Can't use g_file_set_contents() here, as it calls open() with
516 * O_EXEC flag in a sysfs directory thus failing with EACCES.
518 fd = g_fopen(path->str, "w");
520 sr_err("Error opening %s: %s", path->str, g_strerror(errno));
525 g_fprintf(fd, "%" PRIu64 "\n", MOHM_TO_UOHM(shunt));
529 g_string_free(path, TRUE);
533 SR_PRIV int bl_acme_read_power_state(const struct sr_channel_group *cg,
536 struct channel_group_priv *cgp;
541 if (!bl_acme_probe_has_pws(cg)) {
542 sr_err("Probe has no power-switch");
546 val = sr_gpio_getval_export(cgp->pws_gpio);
547 *off = val ? FALSE : TRUE;
552 SR_PRIV int bl_acme_set_power_off(const struct sr_channel_group *cg,
555 struct channel_group_priv *cgp;
560 if (!bl_acme_probe_has_pws(cg)) {
561 sr_err("Probe has no power-switch");
565 val = sr_gpio_setval_export(cgp->pws_gpio, off ? 0 : 1);
567 sr_err("Error setting power-off state: gpio: %d",
575 static int channel_to_mq(struct sr_channel *ch)
577 struct channel_priv *chp;
581 switch (chp->ch_type) {
585 return SR_MQ_CURRENT;
587 return SR_MQ_VOLTAGE;
588 case TEMP_IN: /* Fallthrough */
590 return SR_MQ_TEMPERATURE;
596 static int channel_to_unit(struct sr_channel *ch)
598 struct channel_priv *chp;
602 switch (chp->ch_type) {
606 return SR_UNIT_AMPERE;
609 case TEMP_IN: /* Fallthrough */
611 return SR_UNIT_CELSIUS;
617 /* We need to scale measurements down from the units used by the drivers. */
618 static int type_digits(int type)
623 case ENRG_CURR: /* Fallthrough */
624 case ENRG_VOL: /* Fallthrough */
625 case TEMP_IN: /* Fallthrough */
633 static float read_sample(struct sr_channel *ch)
635 struct channel_priv *chp;
643 lseek(fd, 0, SEEK_SET);
645 len = read(fd, buf, sizeof(buf));
647 sr_err("Error reading from channel %s (hwmon: %d): %s",
648 ch->name, chp->probe->hwmon_num, g_strerror(errno));
653 chp->digits = type_digits(chp->ch_type);
654 return strtol(buf, NULL, 10) * powf(10, -chp->digits);
657 SR_PRIV int bl_acme_open_channel(struct sr_channel *ch)
659 struct channel_priv *chp;
666 switch (chp->ch_type) {
667 case ENRG_PWR: file = "power1_input"; break;
668 case ENRG_CURR: file = "curr1_input"; break;
669 case ENRG_VOL: file = "in1_input"; break;
670 case TEMP_IN: file = "temp1_input"; break;
671 case TEMP_OUT: file = "temp2_input"; break;
673 sr_err("Invalid channel type: %d.", chp->ch_type);
677 snprintf(path, sizeof(path), "/sys/class/hwmon/hwmon%d/%s",
678 chp->probe->hwmon_num, file);
680 fd = open(path, O_RDONLY);
682 sr_err("Error opening %s: %s", path, g_strerror(errno));
692 SR_PRIV void bl_acme_close_channel(struct sr_channel *ch)
694 struct channel_priv *chp;
701 SR_PRIV int bl_acme_receive_data(int fd, int revents, void *cb_data)
703 uint64_t nrexpiration;
704 struct sr_datafeed_packet packet, framep;
705 struct sr_datafeed_analog analog;
706 struct sr_analog_encoding encoding;
707 struct sr_analog_meaning meaning;
708 struct sr_analog_spec spec;
709 struct sr_dev_inst *sdi;
710 struct sr_channel *ch;
711 struct channel_priv *chp;
712 struct dev_context *devc;
727 packet.type = SR_DF_ANALOG;
728 packet.payload = &analog;
729 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
731 if (read(devc->timer_fd, &nrexpiration, sizeof(nrexpiration)) < 0) {
732 sr_warn("Failed to read timer information");
737 * We were not able to process the previous timer expiration, we are
740 if (nrexpiration > 1)
741 devc->samples_missed += nrexpiration - 1;
744 * XXX This is a nasty workaround...
746 * At high sampling rates and maximum channels we are not able to
747 * acquire samples fast enough, even though frontends still think
748 * that samples arrive on time. This causes shifts in frontend
751 * To compensate for the delay we check if any clock events were
752 * missed and - if so - don't really read the next value, but send
753 * the same sample as fast as possible. We do it until we are back
756 * At high sampling rate this doesn't seem to visibly reduce the
759 for (i = 0; i < nrexpiration; i++) {
760 framep.type = SR_DF_FRAME_BEGIN;
761 sr_session_send(sdi, &framep);
764 * Due to different units used in each channel we're sending
765 * samples one-by-one.
767 for (chl = sdi->channels; chl; chl = chl->next) {
775 analog.num_samples = 1;
776 analog.meaning->channels = &chonly;
777 analog.meaning->mq = channel_to_mq(chl->data);
778 analog.meaning->unit = channel_to_unit(ch);
781 chp->val = read_sample(ch);
783 analog.encoding->digits = chp->digits;
784 analog.spec->spec_digits = chp->digits;
785 analog.data = &chp->val;
786 sr_session_send(sdi, &packet);
789 framep.type = SR_DF_FRAME_END;
790 sr_session_send(sdi, &framep);
793 sr_sw_limits_update_samples_read(&devc->limits, 1);
795 if (sr_sw_limits_check(&devc->limits)) {
796 sdi->driver->dev_acquisition_stop(sdi);