scpi-pps: Add a missing "break" in config_get().
[libsigrok.git] / src / hardware / kern-scale / api.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2015 Uwe Hermann <uwe@hermann-uwe.de>
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 2 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 #include <config.h>
21 #include <glib.h>
22 #include <libsigrok/libsigrok.h>
23 #include "libsigrok-internal.h"
24 #include "protocol.h"
25
26 static const uint32_t scanopts[] = {
27         SR_CONF_CONN,
28         SR_CONF_SERIALCOMM,
29 };
30
31 static const uint32_t drvopts[] = {
32         SR_CONF_SCALE,
33 };
34
35 static const uint32_t devopts[] = {
36         SR_CONF_CONTINUOUS,
37         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
38         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
39 };
40
41 static GSList *scan(struct sr_dev_driver *di, GSList *options)
42 {
43         struct scale_info *scale;
44         struct sr_config *src;
45         GSList *l, *devices;
46         const char *conn, *serialcomm;
47         struct sr_dev_inst *sdi;
48         struct dev_context *devc;
49         struct sr_serial_dev_inst *serial;
50         int ret;
51         size_t len;
52         uint8_t buf[128];
53
54         scale = (struct scale_info *)di;
55
56         conn = serialcomm = NULL;
57         for (l = options; l; l = l->next) {
58                 src = l->data;
59                 switch (src->key) {
60                 case SR_CONF_CONN:
61                         conn = g_variant_get_string(src->data, NULL);
62                         break;
63                 case SR_CONF_SERIALCOMM:
64                         serialcomm = g_variant_get_string(src->data, NULL);
65                         break;
66                 }
67         }
68         if (!conn)
69                 return NULL;
70
71         if (!serialcomm)
72                 serialcomm = scale->conn;
73
74         serial = sr_serial_dev_inst_new(conn, serialcomm);
75
76         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
77                 return NULL;
78
79         sr_info("Probing serial port %s.", conn);
80
81         devices = NULL;
82         serial_flush(serial);
83
84         sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
85         if (serial_write_blocking(serial, "O1\r\n", 4, 0) < 0)
86                 goto scan_cleanup;
87         /* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */
88
89         /* Let's get a bit of data and see if we can find a packet. */
90         len = sizeof(buf);
91         ret = serial_stream_detect(serial, buf, &len, scale->packet_size,
92                                    scale->packet_valid, 3000, scale->baudrate);
93         if (ret != SR_OK)
94                 goto scan_cleanup;
95
96         sr_info("Found device on port %s.", conn);
97
98         sdi = g_malloc0(sizeof(struct sr_dev_inst));
99         sdi->status = SR_ST_INACTIVE;
100         sdi->vendor = g_strdup(scale->vendor);
101         sdi->model = g_strdup(scale->device);
102         devc = g_malloc0(sizeof(struct dev_context));
103         sr_sw_limits_init(&devc->limits);
104         sdi->inst_type = SR_INST_SERIAL;
105         sdi->conn = serial;
106         sdi->priv = devc;
107         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Mass");
108         devices = g_slist_append(devices, sdi);
109
110 scan_cleanup:
111         serial_close(serial);
112
113         return std_scan_complete(di, devices);
114 }
115
116 static int config_set(uint32_t key, GVariant *data,
117         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
118 {
119         struct dev_context *devc;
120
121         (void)cg;
122
123         devc = sdi->priv;
124
125         return sr_sw_limits_config_set(&devc->limits, key, data);
126 }
127
128 static int config_list(uint32_t key, GVariant **data,
129         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
130 {
131         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
132 }
133
134 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
135 {
136         struct dev_context *devc;
137         struct sr_serial_dev_inst *serial;
138
139         devc = sdi->priv;
140         serial = sdi->conn;
141
142         sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
143         if (serial_write_blocking(serial, "O1\r\n", 4, 0) < 0)
144                 return SR_ERR;
145         /* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */
146
147         sr_sw_limits_acquisition_start(&devc->limits);
148         std_session_send_df_header(sdi);
149
150         serial_source_add(sdi->session, serial, G_IO_IN, 50,
151                       kern_scale_receive_data, (void *)sdi);
152
153         return SR_OK;
154 }
155
156 #define SCALE(ID, CHIPSET, VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
157                         VALID, PARSE) \
158         &((struct scale_info) { \
159                 { \
160                         .name = ID, \
161                         .longname = VENDOR " " MODEL, \
162                         .api_version = 1, \
163                         .init = std_init, \
164                         .cleanup = std_cleanup, \
165                         .scan = scan, \
166                         .dev_list = std_dev_list, \
167                         .dev_clear = std_dev_clear, \
168                         .config_get = NULL, \
169                         .config_set = config_set, \
170                         .config_list = config_list, \
171                         .dev_open = std_serial_dev_open, \
172                         .dev_close = std_serial_dev_close, \
173                         .dev_acquisition_start = dev_acquisition_start, \
174                         .dev_acquisition_stop = std_serial_dev_acquisition_stop, \
175                         .context = NULL, \
176                 }, \
177                 VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
178                 VALID, PARSE, sizeof(struct CHIPSET##_info) \
179         }).di
180
181 /*
182  * Some scales have (user-configurable) 14-byte or 15-byte packets.
183  * We transparently support both variants by specifying the larger value
184  * below and due to the way the stream parser works.
185  *
186  * The scales have a standard baudrate (model dependent) as listed below,
187  * but serial parameters are user-configurable. We support that by letting
188  * the user override them via "serialcomm".
189  */
190
191 SR_REGISTER_DEV_DRIVER_LIST(kern_scale_drivers,
192         SCALE(
193                 "kern-ew-6200-2nm", kern,
194                 "KERN", "EW 6200-2NM", "1200/8n2", 1200,
195                 15 /* (or 14) */, sr_kern_packet_valid, sr_kern_parse
196         )
197 );