]> sigrok.org Git - libsigrok.git/blob - src/hardware/norma-dmm/protocol.h
Reorganize project tree.
[libsigrok.git] / src / hardware / norma-dmm / protocol.h
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
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_NORMA_DMM_PROTOCOL_H
21 #define LIBSIGROK_HARDWARE_NORMA_DMM_PROTOCOL_H
22
23 #include <stdint.h>
24 #include <string.h>
25 #include <ctype.h>
26 #include <errno.h>
27 #include <math.h>
28 #include <glib.h>
29 #include "libsigrok.h"
30 #include "libsigrok-internal.h"
31
32 /** @file
33  *  Norma DM9x0/Siemens B102x DMMs driver.
34  *  @internal
35  */
36
37 #define LOG_PREFIX "norma-dmm"
38
39 #define NMADMM_BUFSIZE  256
40
41 #define NMADMM_TIMEOUT_MS 2000 /**< Request timeout. */
42
43 /** Norma DMM request types (used ones only, the DMMs support about 50). */
44 enum {
45         NMADMM_REQ_IDN = 0,     /**< Request identity */
46         NMADMM_REQ_STATUS,      /**< Request device status (value + ...) */
47 };
48
49 /** Defines requests used to communicate with device. */
50 struct nmadmm_req {
51         int req_type;           /**< Request type. */
52         const char *req_str;    /**< Request string. */
53 };
54
55 /** Strings for requests. */
56 extern const struct nmadmm_req nmadmm_requests[];
57
58 /** Private, per-device-instance driver context. */
59 struct dev_context {
60         /* Model-specific information */
61         char *version;          /**< Version string */
62         int type;               /**< DM9x0, e.g. 5 = DM950 */
63
64         /* Acquisition settings */
65         uint64_t limit_samples; /**< Target number of samples */
66         uint64_t limit_msec;    /**< Target sampling time */
67
68         /* Opaque pointer passed in by frontend. */
69         void *cb_data;
70
71         /* Operational state */
72         int last_req;                   /**< Last request. */
73         int64_t req_sent_at;            /**< Request sent. */
74         gboolean last_req_pending;      /**< Last request not answered yet. */
75         int lowbatt;                    /**< Low battery. 1=low, 2=critical. */
76
77         /* Temporary state across callbacks */
78         uint64_t num_samples;           /**< Current #samples. */
79         GTimer *elapsed_msec;           /**< Used for limit_msec */
80         uint8_t buf[NMADMM_BUFSIZE];    /**< Buffer for read callback */
81         int buflen;                     /**< Data len in buf */
82 };
83
84 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data);
85 SR_PRIV int xgittoint(char xgit);
86
87 #endif