[libsigrok.git] / hardware / kecheng-kc-330b / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
 *
 * 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_KECHENG_KC_330B_PROTOCOL_H
#define LIBSIGROK_HARDWARE_KECHENG_KC_330B_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 "kecheng-kc-330b: "
#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)

#define EP_IN 0x80 | 1
#define EP_OUT 2

/* 500ms */
#define DEFAULT_SAMPLE_INTERVAL 1
#define DEFAULT_ALARM_LOW 40
#define DEFAULT_ALARM_HIGH 120
#define DEFAULT_WEIGHT_TIME SR_MQFLAG_SPL_TIME_WEIGHT_F
#define DEFAULT_WEIGHT_FREQ SR_MQFLAG_SPL_FREQ_WEIGHT_A
/* Live */
#define DEFAULT_DATA_SOURCE DATA_SOURCE_LIVE


enum {
	CMD_CONFIGURE = 0x01,
	CMD_IDENTIFY = 0x02,
	CMD_SET_DATE_TIME = 0x03,
	CMD_GET_LIVE_SPL = 0x08,
};

enum {
	DATA_SOURCE_LIVE,
	DATA_SOURCE_MEMORY,
};

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

	/* Acquisition settings */
	uint64_t limit_samples;
	int sample_interval;
	int alarm_low;
	int alarm_high;
	uint64_t mqflags;
	int data_source;

	/* Operational state */
	uint64_t num_samples;
	void *cb_data;
	int usbfd[10];

	/* Temporary state across callbacks */

};

SR_PRIV int kecheng_kc_330b_handle_events(int fd, int revents, void *cb_data);
SR_PRIV int kecheng_kc_330b_configure(const struct sr_dev_inst *sdi);
SR_PRIV int kecheng_kc_330b_set_date_time(struct sr_dev_inst *sdi);
SR_PRIV int kecheng_kc_330b_recording_get(const struct sr_dev_inst *sdi,
		gboolean *tmp);

#endif
Commit	Line	Data
ed759a08 BV	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
	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_KECHENG_KC_330B_PROTOCOL_H
	21	#define LIBSIGROK_HARDWARE_KECHENG_KC_330B_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 "kecheng-kc-330b: "
	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
bc7be4a9 BV	37	#define EP_IN 0x80 \| 1
	38	#define EP_OUT 2
	39
	40	/* 500ms */
	41	#define DEFAULT_SAMPLE_INTERVAL 1
	42	#define DEFAULT_ALARM_LOW 40
	43	#define DEFAULT_ALARM_HIGH 120
	44	#define DEFAULT_WEIGHT_TIME SR_MQFLAG_SPL_TIME_WEIGHT_F
	45	#define DEFAULT_WEIGHT_FREQ SR_MQFLAG_SPL_FREQ_WEIGHT_A
	46	/* Live */
	47	#define DEFAULT_DATA_SOURCE DATA_SOURCE_LIVE
	48
	49
	50	enum {
	51	CMD_CONFIGURE = 0x01,
a8806f03	52	CMD_IDENTIFY = 0x02,
bc7be4a9 BV	53	CMD_SET_DATE_TIME = 0x03,
	54	CMD_GET_LIVE_SPL = 0x08,
	55	};
	56
	57	enum {
	58	DATA_SOURCE_LIVE,
	59	DATA_SOURCE_MEMORY,
a8806f03 BV	60	};
a8806f03 BV	61
ed759a08 BV	62	/** Private, per-device-instance driver context. */
	63	struct dev_context {
	64	/* Model-specific information */
	65
	66	/* Acquisition settings */
a8806f03	67	uint64_t limit_samples;
bc7be4a9 BV	68	int sample_interval;
	69	int alarm_low;
	70	int alarm_high;
	71	uint64_t mqflags;
	72	int data_source;
ed759a08 BV	73
ed759a08 BV	74	/* Operational state */
bc7be4a9 BV	75	uint64_t num_samples;
	76	void *cb_data;
	77	int usbfd[10];
ed759a08 BV	78
	79	/* Temporary state across callbacks */
	80
	81	};
	82
bc7be4a9 BV	83	SR_PRIV int kecheng_kc_330b_handle_events(int fd, int revents, void *cb_data);
	84	SR_PRIV int kecheng_kc_330b_configure(const struct sr_dev_inst *sdi);
	85	SR_PRIV int kecheng_kc_330b_set_date_time(struct sr_dev_inst *sdi);
	86	SR_PRIV int kecheng_kc_330b_recording_get(const struct sr_dev_inst *sdi,
	87	gboolean *tmp);
ed759a08 BV	88
ed759a08 BV	89	#endif