hardware/teleinfo/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
   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_TELEINFO_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_TELEINFO_PROTOCOL_H
  22
  23 #include <stdint.h>
  24 #include <glib.h>
  25 #include "libsigrok.h"
  26 #include "libsigrok-internal.h"
  27
  28 /* Message logging helpers with subsystem-specific prefix string. */
  29 #define LOG_PREFIX "teleinfo: "
  30 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  31 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  32 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  33 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  34 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  35 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  36
  37 enum optarif {
  38         OPTARIF_NONE,
  39         OPTARIF_BASE,
  40         OPTARIF_HC,
  41         OPTARIF_EJP,
  42         OPTARIF_BBR,
  43 };
  44
  45 #define TELEINFO_BUF_SIZE 256
  46
  47 /** Private, per-device-instance driver context. */
  48 struct dev_context {
  49         /* Acquisition settings */
  50         uint64_t limit_samples;   /**< The sampling limit (in number of samples). */
  51         uint64_t limit_msec;      /**< The time limit (in milliseconds). */
  52         void *session_cb_data;    /**< Opaque pointer passed in by the frontend. */
  53
  54         /* Operational state */
  55         enum optarif optarif;     /**< The device mode (which mesures are reported) */
  56         uint64_t num_samples;     /**< The number of already received samples. */
  57         int64_t start_time;       /**< The time at which sampling started. */
  58
  59         /* Temporary state across callbacks */
  60         uint8_t buf[TELEINFO_BUF_SIZE];
  61         int buf_len;
  62 };
  63
  64 SR_PRIV gboolean teleinfo_packet_valid(const uint8_t *buf);
  65 SR_PRIV int teleinfo_receive_data(int fd, int revents, void *cb_data);
  66 SR_PRIV int teleinfo_get_optarif(const uint8_t *buf);
  67
  68 #endif