scpi_usbtmc_libusb: Retry if a Bulk-IN request starts with an empty packet
[libsigrok.git] / src / hardware / serial-dmm / protocol.h
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_SERIAL_DMM_PROTOCOL_H
21 #define LIBSIGROK_HARDWARE_SERIAL_DMM_PROTOCOL_H
22
23 #define LOG_PREFIX "serial-dmm"
24
25 struct dmm_info {
26         /** libsigrok driver info struct. */
27         struct sr_dev_driver di;
28         /** Manufacturer/brand. */
29         const char *vendor;
30         /** Model. */
31         const char *device;
32         /** conn string. */
33         const char *conn;
34         /** serialcomm string. */
35         const char *serialcomm;
36         /** Packet size in bytes. */
37         int packet_size;
38         /**
39          * Request timeout [ms] before request is considered lost and a new
40          * one is sent. Used only if device needs polling.
41          */
42         int64_t req_timeout_ms;
43         /**
44          * Delay between reception of packet and next request. Some DMMs
45          * need this. Used only if device needs polling.
46          */
47         int64_t req_delay_ms;
48         /** Packet request function. */
49         int (*packet_request)(struct sr_serial_dev_inst *);
50         /** Number of channels / displays. */
51         size_t channel_count;
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 *);
59         /** */
60         void (*dmm_details)(struct sr_datafeed_analog *, void *);
61         /** Size of chipset info struct. */
62         gsize info_size;
63 };
64
65 #define DMM_BUFSIZE 256
66
67 struct dev_context {
68         struct sr_sw_limits limits;
69
70         uint8_t buf[DMM_BUFSIZE];
71         int bufoffset;
72         int buflen;
73
74         /**
75          * The timestamp [┬Ás] to send the next request.
76          * Used only if device needs polling.
77          */
78         int64_t req_next_at;
79 };
80
81 SR_PRIV int req_packet(struct sr_dev_inst *sdi);
82 SR_PRIV int receive_data(int fd, int revents, void *cb_data);
83
84 #endif