libsigrok/hardware/teleinfo/protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBSIGROK_HARDWARE_TELEINFO_PROTOCOL_H
#define LIBSIGROK_HARDWARE_TELEINFO_PROTOCOL_H

#include <stdint.h>
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"

/* Message logging helpers with subsystem-specific prefix string. */
#define LOG_PREFIX "teleinfo: "
#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)

enum optarif {
	OPTARIF_NONE,
	OPTARIF_BASE,
	OPTARIF_HC,
	OPTARIF_EJP,
	OPTARIF_BBR,
};

#define TELEINFO_BUF_SIZE 256

/** Private, per-device-instance driver context. */
struct dev_context {
	/* Acquisition settings */
	uint64_t limit_samples;   /**< The sampling limit (in number of samples). */
	uint64_t limit_msec;      /**< The time limit (in milliseconds). */
	void *session_cb_data;    /**< Opaque pointer passed in by the frontend. */

	/* Operational state */
	enum optarif optarif;     /**< The device mode (which mesures are reported) */
	uint64_t num_samples;     /**< The number of already received samples. */
	int64_t start_time;       /**< The time at which sampling started. */

	/* Temporary state across callbacks */
	uint8_t buf[TELEINFO_BUF_SIZE];
	int buf_len;
};

SR_PRIV gboolean teleinfo_packet_valid(const uint8_t *buf);
SR_PRIV int teleinfo_receive_data(int fd, int revents, void *cb_data);
SR_PRIV int teleinfo_get_optarif(const uint8_t *buf);

#endif