src/hardware/baylibre-acme/protocol.h

   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 #ifndef LIBSIGROK_HARDWARE_BAYLIBRE_ACME_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_BAYLIBRE_ACME_PROTOCOL_H
  22
  23 #include <stdint.h>
  24 #include <glib.h>
  25 #include <unistd.h>
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28
  29 #define LOG_PREFIX "baylibre-acme"
  30
  31 /* We support up to 8 energy/temperature probes. */
  32 #define MAX_PROBES              8
  33
  34 /*
  35  * Temperature probes can be connected to the last four ports on the
  36  * ACME cape. When scanning, first look for temperature probes starting
  37  * from this index.
  38  */
  39 #define TEMP_PRB_START_INDEX    4
  40
  41 #define ENRG_PROBE_NAME         "ina226"
  42 #define TEMP_PROBE_NAME         "tmp435"
  43
  44 /* For the user we number the probes starting from 1. */
  45 #define PROBE_NUM(n) ((n) + 1)
  46
  47 enum probe_type {
  48         PROBE_ENRG = 1,
  49         PROBE_TEMP,
  50 };
  51
  52 enum channel_type {
  53         ENRG_PWR = 1,
  54         ENRG_CURR,
  55         ENRG_VOL,
  56         TEMP_IN,
  57         TEMP_OUT,
  58 };
  59
  60 /** Private, per-device-instance driver context. */
  61 struct dev_context {
  62         uint64_t samplerate;
  63         uint64_t limit_samples;
  64         uint64_t limit_msec;
  65
  66         uint32_t num_channels;
  67         uint64_t samples_read;
  68         uint64_t samples_missed;
  69         int64_t start_time;
  70         int64_t last_sample_fin;
  71         int timer_fd;
  72         GIOChannel *channel;
  73 };
  74
  75 SR_PRIV uint8_t bl_acme_get_enrg_addr(int index);
  76 SR_PRIV uint8_t bl_acme_get_temp_addr(int index);
  77
  78 SR_PRIV gboolean bl_acme_is_sane(void);
  79
  80 SR_PRIV gboolean bl_acme_detect_probe(unsigned int addr,
  81                                       int prb_num, const char *prb_name);
  82 SR_PRIV gboolean bl_acme_register_probe(struct sr_dev_inst *sdi, int type,
  83                                         unsigned int addr, int prb_num);
  84
  85 SR_PRIV int bl_acme_get_probe_type(const struct sr_channel_group *cg);
  86 SR_PRIV int bl_acme_probe_has_pws(const struct sr_channel_group *cg);
  87
  88 SR_PRIV void bl_acme_maybe_set_update_interval(const struct sr_dev_inst *sdi,
  89                                                uint64_t samplerate);
  90
  91 SR_PRIV int bl_acme_get_shunt(const struct sr_channel_group *cg,
  92                               uint64_t *shunt);
  93 SR_PRIV int bl_acme_set_shunt(const struct sr_channel_group *cg,
  94                               uint64_t shunt);
  95 SR_PRIV int bl_acme_read_power_state(const struct sr_channel_group *cg,
  96                                      gboolean *off);
  97 SR_PRIV int bl_acme_set_power_off(const struct sr_channel_group *cg,
  98                                   gboolean off);
  99
 100 SR_PRIV int bl_acme_receive_data(int fd, int revents, void *cb_data);
 101
 102 SR_PRIV int bl_acme_open_channel(struct sr_channel *ch);
 103
 104 SR_PRIV void bl_acme_close_channel(struct sr_channel *ch);
 105 #endif