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_SERIAL_DMM_PROTOCOL_H
21 #define LIBSIGROK_HARDWARE_SERIAL_DMM_PROTOCOL_H
23 #define LOG_PREFIX "serial-dmm"
26 /** libsigrok driver info struct. */
27 struct sr_dev_driver di;
28 /** Manufacturer/brand. */
34 /** serialcomm string. */
35 const char *serialcomm;
36 /** Packet size in bytes. */
39 * Request timeout [ms] before request is considered lost and a new
40 * one is sent. Used only if device needs polling.
42 uint64_t req_timeout_ms;
44 * Delay between reception of packet and next request. Some DMMs
45 * need this. Used only if device needs polling.
47 uint64_t req_delay_ms;
48 /** Packet request function. */
49 int (*packet_request)(struct sr_serial_dev_inst *);
50 /** Number of channels / displays. */
52 /** (Optional) printf formats for channel names. */
53 const char **channel_formats;
54 /** Packet validation function. */
55 gboolean (*packet_valid)(const uint8_t *);
56 /** Packet parsing function. */
57 int (*packet_parse)(const uint8_t *, float *,
58 struct sr_datafeed_analog *, void *);
60 void (*dmm_details)(struct sr_datafeed_analog *, void *);
61 /** Size of chipset info struct. */
63 /* Serial-dmm items "with state" and variable length packets. */
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,
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);
83 #define DMM_BUFSIZE 256
86 struct sr_sw_limits limits;
88 uint8_t buf[DMM_BUFSIZE];
92 * The timestamp [µs] to send the next request.
93 * Used only if device needs polling.
98 SR_PRIV int req_packet(struct sr_dev_inst *sdi);
99 SR_PRIV int receive_data(int fd, int revents, void *cb_data);