2 * This file is part of the libsigrok project.
4 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
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.
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.
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/>.
20 #ifndef LIBSIGROK_HARDWARE_BRYMEN_DMM_PROTOCOL_H
21 #define LIBSIGROK_HARDWARE_BRYMEN_DMM_PROTOCOL_H
28 #include "libsigrok.h"
29 #include "libsigrok-internal.h"
31 /* Message logging helpers with subsystem-specific prefix string. */
32 #define LOG_PREFIX "brymen-dmm: "
33 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
34 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
35 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
36 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
37 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
38 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
40 #define DMM_BUFSIZE 256
42 enum packet_len_status {
44 PACKET_NEED_MORE_DATA,
45 PACKET_INVALID_HEADER,
48 /** Private, per-device-instance driver context. */
50 /** The current sampling limit (in number of samples). */
51 uint64_t limit_samples;
53 /** The current sampling limit (in ms). */
56 /** Opaque pointer passed in by the frontend. */
59 /** The current number of already received samples. */
62 /** Start time of acquisition session */
65 uint8_t buf[DMM_BUFSIZE];
72 * Callback that assesses the size and status of the incoming packet.
74 * @return PACKET_HEADER_OK - This is a proper packet header.
75 * PACKET_NEED_MORE_DATA The buffer does not contain the entire header.
76 * PACKET_INVALID_HEADER Not a valid start of packet.
78 typedef int (*packet_length_t)(const uint8_t *buf, int *len);
80 SR_PRIV int brymen_dmm_receive_data(int fd, int revents, void *cb_data);
81 SR_PRIV int brymen_packet_request(struct sr_serial_dev_inst *serial);
83 SR_PRIV int brymen_packet_length(const uint8_t *buf, int *len);
84 SR_PRIV gboolean brymen_packet_is_valid(const uint8_t *buf);
86 SR_PRIV int brymen_stream_detect(struct sr_serial_dev_inst *serial,
87 uint8_t *buf, size_t *buflen,
88 packet_length_t get_packet_size,
89 packet_valid_t is_valid,
90 uint64_t timeout_ms, int baudrate);