]> sigrok.org Git - libsigrok.git/blame - hardware/mic-985xx/api.c
link-mso19: Adjust to GVariant-based sr_config_* functions
[libsigrok.git] / hardware / mic-985xx / api.c
CommitLineData
7ec5b549
UH
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#include "protocol.h"
22
0cd8e231
UH
23static const int hwopts[] = {
24 SR_CONF_CONN,
25 SR_CONF_SERIALCOMM,
26 0,
27};
28
29static const int hwcaps[] = {
30 SR_CONF_THERMOMETER,
31 SR_CONF_HYGROMETER,
32 SR_CONF_LIMIT_SAMPLES,
33 SR_CONF_LIMIT_MSEC,
34 SR_CONF_CONTINUOUS,
35 0,
36};
7ec5b549 37
6f3e5335 38SR_PRIV struct sr_dev_driver mic_98581_driver_info;
0cd8e231
UH
39SR_PRIV struct sr_dev_driver mic_98583_driver_info;
40
41SR_PRIV const struct mic_dev_info mic_devs[] = {
42 {
6f3e5335
UH
43 "MIC", "98581", "38400/8n2", 32000, TRUE, FALSE, 6,
44 packet_valid_temp,
45 &mic_98581_driver_info, receive_data_MIC_98581,
46 },
47 {
48 "MIC", "98583", "38400/8n2", 32000, TRUE, TRUE, 10,
49 packet_valid_temp_hum,
0cd8e231
UH
50 &mic_98583_driver_info, receive_data_MIC_98583,
51 },
52};
53
54static int clear_instances(int idx)
7ec5b549
UH
55{
56 struct sr_dev_inst *sdi;
57 struct drv_context *drvc;
58 struct dev_context *devc;
59 GSList *l;
0cd8e231
UH
60 struct sr_dev_driver *di;
61
62 di = mic_devs[idx].di;
7ec5b549
UH
63
64 if (!(drvc = di->priv))
65 return SR_OK;
66
67 for (l = drvc->instances; l; l = l->next) {
68 if (!(sdi = l->data))
69 continue;
70 if (!(devc = sdi->priv))
71 continue;
0cd8e231 72 sr_serial_dev_inst_free(devc->serial);
7ec5b549
UH
73 sr_dev_inst_free(sdi);
74 }
75
76 g_slist_free(drvc->instances);
77 drvc->instances = NULL;
78
79 return SR_OK;
80}
81
0cd8e231 82static int hw_init(struct sr_context *sr_ctx, int idx)
7ec5b549 83{
0cd8e231
UH
84 sr_dbg("Selected '%s' subdriver.", mic_devs[idx].di->name);
85
86 return std_hw_init(sr_ctx, mic_devs[idx].di, DRIVER_LOG_DOMAIN);
7ec5b549
UH
87}
88
0cd8e231 89static GSList *scan(const char *conn, const char *serialcomm, int idx)
7ec5b549 90{
0cd8e231 91 struct sr_dev_inst *sdi;
7ec5b549 92 struct drv_context *drvc;
0cd8e231
UH
93 struct dev_context *devc;
94 struct sr_probe *probe;
95 struct sr_serial_dev_inst *serial;
7ec5b549
UH
96 GSList *devices;
97
0cd8e231
UH
98 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
99 return NULL;
7ec5b549 100
0cd8e231
UH
101 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
102 return NULL;
103
104 drvc = mic_devs[idx].di->priv;
7ec5b549 105 devices = NULL;
0cd8e231 106 serial_flush(serial);
7ec5b549 107
0cd8e231
UH
108 /* TODO: Query device type. */
109 // ret = mic_cmd_get_device_info(serial);
110
111 sr_info("Found device on port %s.", conn);
112
113 /* TODO: Fill in version from protocol response. */
114 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, mic_devs[idx].vendor,
115 mic_devs[idx].device, "")))
116 goto scan_cleanup;
117
118 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
119 sr_err("Device context malloc failed.");
120 goto scan_cleanup;
121 }
122
123 devc->serial = serial;
124
125 sdi->priv = devc;
126 sdi->driver = mic_devs[idx].di;
127
128 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "Temperature")))
129 goto scan_cleanup;
130 sdi->probes = g_slist_append(sdi->probes, probe);
131
6f3e5335
UH
132 if (mic_devs[idx].has_humidity) {
133 if (!(probe = sr_probe_new(1, SR_PROBE_ANALOG, TRUE, "Humidity")))
134 goto scan_cleanup;
135 sdi->probes = g_slist_append(sdi->probes, probe);
136 }
0cd8e231
UH
137
138 drvc->instances = g_slist_append(drvc->instances, sdi);
139 devices = g_slist_append(devices, sdi);
140
141scan_cleanup:
142 serial_close(serial);
7ec5b549
UH
143
144 return devices;
145}
146
0cd8e231
UH
147static GSList *hw_scan(GSList *options, int idx)
148{
149 struct sr_config *src;
150 GSList *l, *devices;
151 const char *conn, *serialcomm;
152
153 conn = serialcomm = NULL;
154 for (l = options; l; l = l->next) {
155 src = l->data;
156 switch (src->key) {
157 case SR_CONF_CONN:
158 conn = src->value;
159 break;
160 case SR_CONF_SERIALCOMM:
161 serialcomm = src->value;
162 break;
163 }
164 }
165 if (!conn)
166 return NULL;
167
168 if (serialcomm) {
169 /* Use the provided comm specs. */
170 devices = scan(conn, serialcomm, idx);
171 } else {
172 /* Try the default. */
173 devices = scan(conn, mic_devs[idx].conn, idx);
174 }
175
176 return devices;
177}
178
179static GSList *hw_dev_list(int idx)
7ec5b549 180{
0e94d524 181 return ((struct drv_context *)(mic_devs[idx].di->priv))->instances;
7ec5b549
UH
182}
183
184static int hw_dev_open(struct sr_dev_inst *sdi)
185{
0cd8e231 186 struct dev_context *devc;
7ec5b549 187
0cd8e231 188 devc = sdi->priv;
7ec5b549 189
0cd8e231
UH
190 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
191 return SR_ERR;
7ec5b549 192
0cd8e231 193 sdi->status = SR_ST_ACTIVE;
7ec5b549
UH
194
195 return SR_OK;
196}
197
0cd8e231 198static int hw_dev_close(struct sr_dev_inst *sdi)
7ec5b549 199{
0cd8e231 200 struct dev_context *devc;
7ec5b549 201
0cd8e231
UH
202 devc = sdi->priv;
203
204 if (devc->serial && devc->serial->fd != -1) {
205 serial_close(devc->serial);
206 sdi->status = SR_ST_INACTIVE;
207 }
7ec5b549
UH
208
209 return SR_OK;
210}
211
0cd8e231 212static int hw_cleanup(int idx)
7ec5b549 213{
0cd8e231 214 clear_instances(idx);
7ec5b549
UH
215
216 return SR_OK;
217}
218
0cd8e231 219static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
7ec5b549 220{
0cd8e231 221 struct dev_context *devc;
7ec5b549 222
0cd8e231 223 if (sdi->status != SR_ST_ACTIVE)
7ec5b549 224 return SR_ERR;
7ec5b549 225
0cd8e231
UH
226 devc = sdi->priv;
227
7ec5b549 228 switch (id) {
0cd8e231
UH
229 case SR_CONF_LIMIT_SAMPLES:
230 devc->limit_samples = *(const uint64_t *)value;
231 sr_dbg("Setting sample limit to %" PRIu64 ".",
232 devc->limit_samples);
233 break;
234 case SR_CONF_LIMIT_MSEC:
235 devc->limit_msec = *(const uint64_t *)value;
236 sr_dbg("Setting time limit to %" PRIu64 "ms.",
237 devc->limit_msec);
238 break;
7ec5b549 239 default:
0cd8e231
UH
240 sr_err("Unknown config: %d.", id);
241 return SR_ERR_ARG;
7ec5b549
UH
242 }
243
0cd8e231 244 return SR_OK;
7ec5b549
UH
245}
246
0cd8e231 247static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
7ec5b549
UH
248{
249 (void)sdi;
7ec5b549
UH
250
251 switch (key) {
0cd8e231
UH
252 case SR_CONF_SCAN_OPTIONS:
253 *data = hwopts;
254 break;
255 case SR_CONF_DEVICE_OPTIONS:
256 *data = hwcaps;
257 break;
7ec5b549
UH
258 default:
259 return SR_ERR_ARG;
260 }
261
262 return SR_OK;
263}
264
265static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
0cd8e231 266 void *cb_data, int idx)
7ec5b549 267{
0cd8e231
UH
268 struct dev_context *devc;
269
270 devc = sdi->priv;
271
272 devc->cb_data = cb_data;
7ec5b549 273
0cd8e231
UH
274 devc->num_samples = 0;
275 devc->starttime = g_get_monotonic_time();
276
277 /* Send header packet to the session bus. */
4afdfd46 278 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
0cd8e231
UH
279
280 /* Poll every 100ms, or whenever some data comes in. */
281 sr_source_add(devc->serial->fd, G_IO_IN, 100,
282 mic_devs[idx].receive_data, (void *)sdi);
7ec5b549
UH
283
284 return SR_OK;
285}
286
287static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
288{
cd2f0fe2
UH
289 return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
290 ((struct dev_context *)(sdi->priv))->serial, DRIVER_LOG_DOMAIN);
7ec5b549
UH
291}
292
0cd8e231
UH
293/* Driver-specific API function wrappers */
294#define HW_INIT(X) \
295static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
296#define HW_CLEANUP(X) \
297static int hw_cleanup_##X(void) { return hw_cleanup(X); }
298#define HW_SCAN(X) \
299static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
300#define HW_DEV_LIST(X) \
301static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
302#define CLEAR_INSTANCES(X) \
303static int clear_instances_##X(void) { return clear_instances(X); }
304#define HW_DEV_ACQUISITION_START(X) \
305static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
306void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
307
308/* Driver structs and API function wrappers */
309#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
310HW_INIT(ID_UPPER) \
311HW_CLEANUP(ID_UPPER) \
312HW_SCAN(ID_UPPER) \
313HW_DEV_LIST(ID_UPPER) \
314CLEAR_INSTANCES(ID_UPPER) \
315HW_DEV_ACQUISITION_START(ID_UPPER) \
316SR_PRIV struct sr_dev_driver ID##_driver_info = { \
317 .name = NAME, \
318 .longname = LONGNAME, \
319 .api_version = 1, \
320 .init = hw_init_##ID_UPPER, \
321 .cleanup = hw_cleanup_##ID_UPPER, \
322 .scan = hw_scan_##ID_UPPER, \
323 .dev_list = hw_dev_list_##ID_UPPER, \
324 .dev_clear = clear_instances_##ID_UPPER, \
325 .config_get = NULL, \
326 .config_set = config_set, \
327 .config_list = config_list, \
328 .dev_open = hw_dev_open, \
329 .dev_close = hw_dev_close, \
330 .dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
331 .dev_acquisition_stop = hw_dev_acquisition_stop, \
332 .priv = NULL, \
7ec5b549 333};
0cd8e231 334
6f3e5335 335DRV(mic_98581, MIC_98581, "mic-98581", "MIC 98581")
0cd8e231 336DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")