]> sigrok.org Git - libsigrok.git/blame - src/hardware/brymen-dmm/protocol.h
Build: Set local include directories in Makefile.am
[libsigrok.git] / src / hardware / brymen-dmm / protocol.h
CommitLineData
20cbc785
AG
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.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_BRYMEN_DMM_PROTOCOL_H
21#define LIBSIGROK_HARDWARE_BRYMEN_DMM_PROTOCOL_H
22
23#include <stdint.h>
c5d6f5cc
UH
24#include <string.h>
25#include <stdlib.h>
26#include <math.h>
27#include <glib.h>
c1aae900 28#include <libsigrok/libsigrok.h>
20cbc785
AG
29#include "libsigrok-internal.h"
30
3544f848 31#define LOG_PREFIX "brymen-dmm"
20cbc785 32
601fb67c
AG
33#define DMM_BUFSIZE 256
34
35enum packet_len_status {
36 PACKET_HEADER_OK,
37 PACKET_NEED_MORE_DATA,
38 PACKET_INVALID_HEADER,
39};
40
20cbc785
AG
41/** Private, per-device-instance driver context. */
42struct dev_context {
43 /** The current sampling limit (in number of samples). */
44 uint64_t limit_samples;
45
46 /** The current sampling limit (in ms). */
47 uint64_t limit_msec;
48
49 /** Opaque pointer passed in by the frontend. */
50 void *cb_data;
51
52 /** The current number of already received samples. */
53 uint64_t num_samples;
601fb67c
AG
54
55 /** Start time of acquisition session */
56 int64_t starttime;
57
601fb67c
AG
58 uint8_t buf[DMM_BUFSIZE];
59 int bufoffset;
60 int buflen;
61 int next_packet_len;
20cbc785
AG
62};
63
601fb67c 64/**
c5d6f5cc 65 * Callback that assesses the size and status of the incoming packet.
601fb67c
AG
66 *
67 * @return PACKET_HEADER_OK - This is a proper packet header.
c5d6f5cc 68 * PACKET_NEED_MORE_DATA The buffer does not contain the entire header.
601fb67c
AG
69 * PACKET_INVALID_HEADER Not a valid start of packet.
70 */
71typedef int (*packet_length_t)(const uint8_t *buf, int *len);
72
20cbc785 73SR_PRIV int brymen_dmm_receive_data(int fd, int revents, void *cb_data);
601fb67c
AG
74SR_PRIV int brymen_packet_request(struct sr_serial_dev_inst *serial);
75
76SR_PRIV int brymen_packet_length(const uint8_t *buf, int *len);
77SR_PRIV gboolean brymen_packet_is_valid(const uint8_t *buf);
20cbc785 78
933e63a1
BV
79SR_PRIV int brymen_parse(const uint8_t *buf, float *floatval,
80 struct sr_datafeed_analog *analog, void *info);
8162cad7 81
601fb67c
AG
82SR_PRIV int brymen_stream_detect(struct sr_serial_dev_inst *serial,
83 uint8_t *buf, size_t *buflen,
84 packet_length_t get_packet_size,
144f6660 85 packet_valid_callback is_valid,
601fb67c 86 uint64_t timeout_ms, int baudrate);
c5d6f5cc 87
20cbc785 88#endif