[sigrok-util.git] / source / drv-protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) {year} {author} <{email}>
 *
 * 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_{upper}_PROTOCOL_H
#define LIBSIGROK_HARDWARE_{upper}_PROTOCOL_H

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

#define LOG_PREFIX "{short}"

/** Private, per-device-instance driver context. */
struct dev_context {{
	/* Model-specific information */

	/* Acquisition settings */

	/* Operational state */

	/* Temporary state across callbacks */

}};

SR_PRIV int {lib}_receive_data(int fd, int revents, void *cb_data);

#endif
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) {year} {author} <{email}>
	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_{upper}_PROTOCOL_H
	21	#define LIBSIGROK_HARDWARE_{upper}_PROTOCOL_H
	22
	23	#include <stdint.h>
	24	#include <glib.h>
	25	#include <libsigrok/libsigrok.h>
	26	#include "libsigrok-internal.h"
	27
	28	#define LOG_PREFIX "{short}"
	29
	30	/** Private, per-device-instance driver context. */
	31	struct dev_context {{
	32	/* Model-specific information */
	33
	34	/* Acquisition settings */
	35
	36	/* Operational state */
	37
	38	/* Temporary state across callbacks */
	39
	40	}};
	41
	42	SR_PRIV int {lib}_receive_data(int fd, int revents, void *cb_data);
	43
	44	#endif