]> sigrok.org Git - libsigrok.git/blame - src/hardware/serial-dmm/protocol.h
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / hardware / serial-dmm / protocol.h
CommitLineData
7dc55d93 1/*
50985c20 2 * This file is part of the libsigrok project.
7dc55d93
AG
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
21a7f269
UH
20#ifndef LIBSIGROK_HARDWARE_SERIAL_DMM_PROTOCOL_H
21#define LIBSIGROK_HARDWARE_SERIAL_DMM_PROTOCOL_H
7dc55d93 22
3544f848 23#define LOG_PREFIX "serial-dmm"
7dc55d93 24
729b01f9 25struct dmm_info {
bcbef5ed
ML
26 /** libsigrok driver info struct. */
27 struct sr_dev_driver di;
95ecc765 28 /** Manufacturer/brand. */
2c240774 29 const char *vendor;
95ecc765 30 /** Model. */
2c240774 31 const char *device;
0527cc3a
GS
32 /** conn string. */
33 const char *conn;
09c650d5
GS
34 /** serialcomm string. */
35 const char *serialcomm;
95ecc765 36 /** Packet size in bytes. */
070668a0 37 size_t packet_size;
d9251a2c
UH
38 /**
39 * Request timeout [ms] before request is considered lost and a new
40 * one is sent. Used only if device needs polling.
41 */
070668a0 42 uint64_t req_timeout_ms;
d9251a2c
UH
43 /**
44 * Delay between reception of packet and next request. Some DMMs
45 * need this. Used only if device needs polling.
46 */
070668a0 47 uint64_t req_delay_ms;
5d037430 48 /** Packet request function. */
ce3777ad 49 int (*packet_request)(struct sr_serial_dev_inst *);
556a926d
GS
50 /** Number of channels / displays. */
51 size_t channel_count;
7d40b5ee
GS
52 /** (Optional) printf formats for channel names. */
53 const char **channel_formats;
5d037430 54 /** Packet validation function. */
729b01f9 55 gboolean (*packet_valid)(const uint8_t *);
5d037430 56 /** Packet parsing function. */
729b01f9 57 int (*packet_parse)(const uint8_t *, float *,
ffa2b6f9 58 struct sr_datafeed_analog *, void *);
5d037430 59 /** */
ffa2b6f9 60 void (*dmm_details)(struct sr_datafeed_analog *, void *);
bcbef5ed
ML
61 /** Size of chipset info struct. */
62 gsize info_size;
070668a0
GS
63 /* Serial-dmm items "with state" and variable length packets. */
64 void *dmm_state;
65 void *(*dmm_state_init)(void);
66 void (*dmm_state_free)(void *state);
67 int (*after_open)(struct sr_serial_dev_inst *serial);
68 int (*packet_valid_len)(void *state, const uint8_t *data, size_t dlen,
69 size_t *pkt_len);
70 int (*packet_parse_len)(void *state, const uint8_t *data, size_t dlen,
71 double *val, struct sr_datafeed_analog *analog, void *info);
72 int (*config_get)(void *state, uint32_t key, GVariant **data,
73 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
74 int (*config_set)(void *state, uint32_t key, GVariant *data,
75 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
76 int (*config_list)(void *state, uint32_t key, GVariant **data,
77 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
78 /** Hook at acquisition start. Can re-route the receive routine. */
79 int (*acquire_start)(void *state, const struct sr_dev_inst *sdi,
80 sr_receive_data_callback *cb, void **cb_data);
729b01f9
UH
81};
82
729b01f9 83#define DMM_BUFSIZE 256
7dc55d93 84
7dc55d93 85struct dev_context {
9f51c463 86 struct sr_sw_limits limits;
f9b9bd63 87
7dc55d93 88 uint8_t buf[DMM_BUFSIZE];
070668a0 89 size_t buflen;
2baac44d 90
d9251a2c
UH
91 /**
92 * The timestamp [µs] to send the next request.
93 * Used only if device needs polling.
94 */
070668a0 95 uint64_t req_next_at;
7dc55d93
AG
96};
97
bcbef5ed
ML
98SR_PRIV int req_packet(struct sr_dev_inst *sdi);
99SR_PRIV int receive_data(int fd, int revents, void *cb_data);
f086b830 100
bbabddbd 101#endif