src/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 #define LOG_PREFIX "teleinfo"
  29
  30 enum optarif {
  31         OPTARIF_NONE,
  32         OPTARIF_BASE,
  33         OPTARIF_HC,
  34         OPTARIF_EJP,
  35         OPTARIF_BBR,
  36 };
  37
  38 #define TELEINFO_BUF_SIZE 256
  39
  40 /** Private, per-device-instance driver context. */
  41 struct dev_context {
  42         /* Acquisition settings */
  43         uint64_t limit_samples;   /**< The sampling limit (in number of samples). */
  44         uint64_t limit_msec;      /**< The time limit (in milliseconds). */
  45         void *session_cb_data;    /**< Opaque pointer passed in by the frontend. */
  46
  47         /* Operational state */
  48         enum optarif optarif;     /**< The device mode (which measures are reported) */
  49         uint64_t num_samples;     /**< The number of already received samples. */
  50         int64_t start_time;       /**< The time at which sampling started. */
  51
  52         /* Temporary state across callbacks */
  53         uint8_t buf[TELEINFO_BUF_SIZE];
  54         int buf_len;
  55 };
  56
  57 SR_PRIV gboolean teleinfo_packet_valid(const uint8_t *buf);
  58 SR_PRIV int teleinfo_receive_data(int fd, int revents, void *cb_data);
  59 SR_PRIV int teleinfo_get_optarif(const uint8_t *buf);
  60
  61 #endif