[libsigrok.git] / src / hardware / icstation-usbrelay / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2021-2023 Frank Stettner <frank-stettner@gmx.net>
 *
 * 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_ICSTATION_USBRELAY_PROTOCOL_H
#define LIBSIGROK_HARDWARE_ICSTATION_USBRELAY_PROTOCOL_H

#include <glib.h>
#include <libsigrok/libsigrok.h>
#include <stdint.h>

#include "libsigrok-internal.h"

#define LOG_PREFIX "icstation-usbrelay"

/* Known models. */
enum icstation_model {
	ICSE012A = 1,
	ICSE013A,
	ICSE014A,
};

/* Supported device profiles */
struct ics_usbrelay_profile {
	enum icstation_model model;
	uint8_t id;
	const char *modelname;
	size_t nb_channels;
};

struct dev_context {
	size_t relay_count;
	uint8_t relay_mask;
	uint8_t relay_state;
};

struct channel_group_context {
	size_t index;
};

SR_PRIV int icstation_usbrelay_identify(struct sr_serial_dev_inst *serial,
	uint8_t *id);
SR_PRIV int icstation_usbrelay_start(const struct sr_dev_inst *sdi);
SR_PRIV int icstation_usbrelay_switch_cg(const struct sr_dev_inst *sdi,
	const struct sr_channel_group *cg, gboolean on);

#endif
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2021-2023 Frank Stettner <frank-stettner@gmx.net>
	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_ICSTATION_USBRELAY_PROTOCOL_H
	21	#define LIBSIGROK_HARDWARE_ICSTATION_USBRELAY_PROTOCOL_H
	22
	23	#include <glib.h>
	24	#include <libsigrok/libsigrok.h>
	25	#include <stdint.h>
	26
	27	#include "libsigrok-internal.h"
	28
	29	#define LOG_PREFIX "icstation-usbrelay"
	30
	31	/* Known models. */
	32	enum icstation_model {
	33	ICSE012A = 1,
	34	ICSE013A,
	35	ICSE014A,
	36	};
	37
	38	/* Supported device profiles */
	39	struct ics_usbrelay_profile {
	40	enum icstation_model model;
	41	uint8_t id;
	42	const char *modelname;
	43	size_t nb_channels;
	44	};
	45
	46	struct dev_context {
	47	size_t relay_count;
	48	uint8_t relay_mask;
	49	uint8_t relay_state;
	50	};
	51
	52	struct channel_group_context {
	53	size_t index;
	54	};
	55
	56	SR_PRIV int icstation_usbrelay_identify(struct sr_serial_dev_inst *serial,
	57	uint8_t *id);
	58	SR_PRIV int icstation_usbrelay_start(const struct sr_dev_inst *sdi);
	59	SR_PRIV int icstation_usbrelay_switch_cg(const struct sr_dev_inst *sdi,
	60	const struct sr_channel_group *cg, gboolean on);
	61
	62	#endif