]> sigrok.org Git - libsigrok.git/blame - src/hardware/kecheng-kc-330b/api.c
drivers: Factor out std_gvar_array_*().
[libsigrok.git] / src / hardware / kecheng-kc-330b / api.c
CommitLineData
ed759a08
BV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.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
6ec6c43b 20#include <config.h>
bc7be4a9 21#include <string.h>
ed759a08
BV
22#include "protocol.h"
23
a8806f03
BV
24#define USB_CONN "1041.8101"
25#define VENDOR "Kecheng"
26#define USB_INTERFACE 0
a8806f03 27
05199c0a 28static const uint32_t drvopts[] = {
a8806f03 29 SR_CONF_SOUNDLEVELMETER,
05199c0a
UH
30};
31
32static const uint32_t devopts[] = {
a8806f03 33 SR_CONF_CONTINUOUS,
5827f61b
BV
34 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
35 SR_CONF_SAMPLE_INTERVAL | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
36 SR_CONF_DATALOG | SR_CONF_GET,
37 SR_CONF_SPL_WEIGHT_FREQ | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
38 SR_CONF_SPL_WEIGHT_TIME | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
bc7be4a9
BV
40};
41
df035528 42SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
bc7be4a9
BV
43 { 1, 8 },
44 { 1, 2 },
45 { 1, 1 },
46 { 2, 1 },
47 { 5, 1 },
48 { 10, 1 },
49 { 60, 1 },
50};
51
52static const char *weight_freq[] = {
53 "A",
54 "C",
55};
56
57static const char *weight_time[] = {
58 "F",
59 "S",
60};
61
62static const char *data_sources[] = {
63 "Live",
64 "Memory",
a8806f03
BV
65};
66
4f840ce9
ML
67static int scan_kecheng(struct sr_dev_driver *di,
68 struct sr_usb_dev_inst *usb, char **model)
a8806f03
BV
69{
70 struct drv_context *drvc;
71 int len, ret;
72 unsigned char cmd, buf[32];
73
41812aca 74 drvc = di->context;
a8806f03
BV
75 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
76 return SR_ERR;
77
78 cmd = CMD_IDENTIFY;
79 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
80 if (ret != 0) {
81 libusb_close(usb->devhdl);
82 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
83 return SR_ERR;
84 }
85
86 ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
87 if (ret != 0) {
88 libusb_close(usb->devhdl);
89 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
90 return SR_ERR;
91 }
92
93 libusb_close(usb->devhdl);
94 usb->devhdl = NULL;
95
96 if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
97 sr_dbg("Invalid response to Identify command");
98 return SR_ERR;
99 }
100
101 buf[buf[1] + 2] = '\x0';
102 *model = g_strndup((const gchar *)buf + 2, 30);
a8806f03
BV
103
104 return SR_OK;
105}
106
4f840ce9 107static GSList *scan(struct sr_dev_driver *di, GSList *options)
ed759a08
BV
108{
109 struct drv_context *drvc;
a8806f03
BV
110 struct dev_context *devc;
111 struct sr_dev_inst *sdi;
a8806f03
BV
112 GSList *usb_devices, *devices, *l;
113 char *model;
ed759a08
BV
114
115 (void)options;
116
41812aca 117 drvc = di->context;
ed759a08 118
a8806f03
BV
119 devices = NULL;
120 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
121 /* We have a list of sr_usb_dev_inst matching the connection
122 * string. Wrap them in sr_dev_inst and we're done. */
123 for (l = usb_devices; l; l = l->next) {
4f840ce9 124 if (scan_kecheng(di, l->data, &model) != SR_OK)
a8806f03 125 continue;
aac29cc1 126 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
127 sdi->status = SR_ST_INACTIVE;
128 sdi->vendor = g_strdup(VENDOR);
129 sdi->model = model; /* Already g_strndup()'d. */
a8806f03
BV
130 sdi->inst_type = SR_INST_USB;
131 sdi->conn = l->data;
5e23fcab 132 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
f57d8ffe 133 devc = g_malloc0(sizeof(struct dev_context));
a8806f03
BV
134 sdi->priv = devc;
135 devc->limit_samples = 0;
bc7be4a9
BV
136 /* The protocol provides no way to read the current
137 * settings, so we'll enforce these. */
138 devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
139 devc->alarm_low = DEFAULT_ALARM_LOW;
140 devc->alarm_high = DEFAULT_ALARM_HIGH;
141 devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
142 devc->data_source = DEFAULT_DATA_SOURCE;
85ed4ab3 143 devc->config_dirty = FALSE;
bc7be4a9
BV
144
145 /* TODO: Set date/time? */
a8806f03 146
a8806f03
BV
147 devices = g_slist_append(devices, sdi);
148 }
149 g_slist_free(usb_devices);
150 } else
151 g_slist_free_full(usb_devices, g_free);
ed759a08 152
15a5bfe4 153 return std_scan_complete(di, devices);
ed759a08
BV
154}
155
ed759a08
BV
156static int dev_open(struct sr_dev_inst *sdi)
157{
4f840ce9 158 struct sr_dev_driver *di = sdi->driver;
efa98402 159 struct drv_context *drvc = di->context;
a8806f03
BV
160 struct sr_usb_dev_inst *usb;
161 int ret;
162
a8806f03 163 usb = sdi->conn;
ed759a08 164
a8806f03
BV
165 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
166 return SR_ERR;
ed759a08 167
85ed4ab3
BV
168 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
169 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
170 return SR_ERR;
171 }
172
a8806f03
BV
173 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
174 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
175 return SR_ERR;
176 }
ed759a08 177
7e463623 178 return SR_OK;
ed759a08
BV
179}
180
181static int dev_close(struct sr_dev_inst *sdi)
182{
85ed4ab3 183 struct dev_context *devc;
a8806f03
BV
184 struct sr_usb_dev_inst *usb;
185
a8806f03 186 usb = sdi->conn;
ed759a08 187
a8806f03 188 if (!usb->devhdl)
f1ba6b4b 189 return SR_ERR_BUG;
ed759a08 190
85ed4ab3
BV
191 /* This allows a frontend to configure the device without ever
192 * doing an acquisition step. */
193 devc = sdi->priv;
194 if (!devc->config_dirty)
195 kecheng_kc_330b_configure(sdi);
196
a8806f03
BV
197 libusb_release_interface(usb->devhdl, USB_INTERFACE);
198 libusb_close(usb->devhdl);
199 usb->devhdl = NULL;
ed759a08
BV
200
201 return SR_OK;
202}
203
584560f1 204static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 205 const struct sr_channel_group *cg)
ed759a08 206{
a8806f03 207 struct dev_context *devc;
bc7be4a9
BV
208 GVariant *rational[2];
209 const uint64_t *si;
ed759a08 210
53b4680f 211 (void)cg;
d3c74a6f 212
a8806f03 213 devc = sdi->priv;
ed759a08 214 switch (key) {
a8806f03
BV
215 case SR_CONF_LIMIT_SAMPLES:
216 *data = g_variant_new_uint64(devc->limit_samples);
217 break;
bc7be4a9 218 case SR_CONF_SAMPLE_INTERVAL:
df035528 219 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
bc7be4a9
BV
220 rational[0] = g_variant_new_uint64(si[0]);
221 rational[1] = g_variant_new_uint64(si[1]);
222 *data = g_variant_new_tuple(rational, 2);
223 break;
224 case SR_CONF_DATALOG:
85ed4ab3
BV
225 /* There really isn't a way to be sure the device is logging. */
226 return SR_ERR_NA;
bc7be4a9
BV
227 break;
228 case SR_CONF_SPL_WEIGHT_FREQ:
229 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
230 *data = g_variant_new_string("A");
231 else
232 *data = g_variant_new_string("C");
233 break;
234 case SR_CONF_SPL_WEIGHT_TIME:
235 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
236 *data = g_variant_new_string("F");
237 else
238 *data = g_variant_new_string("S");
239 break;
240 case SR_CONF_DATA_SOURCE:
241 if (devc->data_source == DATA_SOURCE_LIVE)
242 *data = g_variant_new_string("Live");
243 else
244 *data = g_variant_new_string("Memory");
245 break;
ed759a08
BV
246 default:
247 return SR_ERR_NA;
248 }
249
a8806f03 250 return SR_OK;
ed759a08
BV
251}
252
584560f1 253static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 254 const struct sr_channel_group *cg)
ed759a08 255{
a8806f03 256 struct dev_context *devc;
bc7be4a9
BV
257 uint64_t p, q;
258 unsigned int i;
a9010323 259 int tmp;
bc7be4a9 260 const char *tmp_str;
ed759a08 261
53b4680f 262 (void)cg;
d3c74a6f 263
a8806f03 264 devc = sdi->priv;
ed759a08 265 switch (key) {
a8806f03
BV
266 case SR_CONF_LIMIT_SAMPLES:
267 devc->limit_samples = g_variant_get_uint64(data);
268 sr_dbg("Setting sample limit to %" PRIu64 ".",
269 devc->limit_samples);
270 break;
bc7be4a9
BV
271 case SR_CONF_SAMPLE_INTERVAL:
272 g_variant_get(data, "(tt)", &p, &q);
df035528
BV
273 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
274 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
bc7be4a9
BV
275 continue;
276 devc->sample_interval = i;
85ed4ab3 277 devc->config_dirty = TRUE;
bc7be4a9
BV
278 break;
279 }
df035528 280 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
a9010323 281 return SR_ERR_ARG;
bc7be4a9
BV
282 break;
283 case SR_CONF_SPL_WEIGHT_FREQ:
284 tmp_str = g_variant_get_string(data, NULL);
285 if (!strcmp(tmp_str, "A"))
286 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
287 else if (!strcmp(tmp_str, "C"))
288 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
289 else
290 return SR_ERR_ARG;
291 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
292 devc->mqflags |= tmp;
85ed4ab3 293 devc->config_dirty = TRUE;
bc7be4a9
BV
294 break;
295 case SR_CONF_SPL_WEIGHT_TIME:
296 tmp_str = g_variant_get_string(data, NULL);
297 if (!strcmp(tmp_str, "F"))
298 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
299 else if (!strcmp(tmp_str, "S"))
300 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
301 else
302 return SR_ERR_ARG;
303 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
304 devc->mqflags |= tmp;
85ed4ab3 305 devc->config_dirty = TRUE;
bc7be4a9
BV
306 break;
307 case SR_CONF_DATA_SOURCE:
308 tmp_str = g_variant_get_string(data, NULL);
309 if (!strcmp(tmp_str, "Live"))
310 devc->data_source = DATA_SOURCE_LIVE;
311 else if (!strcmp(tmp_str, "Memory"))
312 devc->data_source = DATA_SOURCE_MEMORY;
313 else
314 return SR_ERR;
85ed4ab3 315 devc->config_dirty = TRUE;
bc7be4a9 316 break;
ed759a08 317 default:
a9010323 318 return SR_ERR_NA;
ed759a08
BV
319 }
320
a9010323 321 return SR_OK;
ed759a08
BV
322}
323
584560f1 324static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 325 const struct sr_channel_group *cg)
ed759a08 326{
ed759a08 327 switch (key) {
a8806f03 328 case SR_CONF_DEVICE_OPTIONS:
05199c0a 329 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
bc7be4a9 330 case SR_CONF_SAMPLE_INTERVAL:
db944f16
UH
331 *data = std_gvar_tuple_array(&kecheng_kc_330b_sample_intervals,
332 ARRAY_SIZE(kecheng_kc_330b_sample_intervals));
bc7be4a9
BV
333 break;
334 case SR_CONF_SPL_WEIGHT_FREQ:
335 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
336 break;
337 case SR_CONF_SPL_WEIGHT_TIME:
338 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
339 break;
340 case SR_CONF_DATA_SOURCE:
341 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
342 break;
ed759a08
BV
343 default:
344 return SR_ERR_NA;
345 }
346
a8806f03 347 return SR_OK;
ed759a08
BV
348}
349
695dc859 350static int dev_acquisition_start(const struct sr_dev_inst *sdi)
ed759a08 351{
4f840ce9 352 struct sr_dev_driver *di = sdi->driver;
bc7be4a9
BV
353 struct drv_context *drvc;
354 struct dev_context *devc;
85ed4ab3
BV
355 struct sr_datafeed_packet packet;
356 struct sr_datafeed_meta meta;
357 struct sr_config *src;
bc7be4a9 358 struct sr_usb_dev_inst *usb;
85ed4ab3 359 GVariant *gvar, *rational[2];
85ed4ab3 360 const uint64_t *si;
7f22cd95 361 int req_len, buf_len, len, ret;
85ed4ab3 362 unsigned char buf[9];
ed759a08 363
41812aca 364 drvc = di->context;
bc7be4a9
BV
365 devc = sdi->priv;
366 usb = sdi->conn;
367
bc7be4a9
BV
368 devc->num_samples = 0;
369
bee2b016 370 std_session_send_df_header(sdi);
85ed4ab3 371
f336618c 372 if (devc->data_source == DATA_SOURCE_LIVE) {
85ed4ab3
BV
373 /* Force configuration. */
374 kecheng_kc_330b_configure(sdi);
375
f336618c
BV
376 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
377 return SR_ERR;
f336618c
BV
378 if (ret != DEVICE_ACTIVE) {
379 sr_err("Device is inactive");
380 /* Still continue though, since the device will
381 * just return 30.0 until the user hits the button
382 * on the device -- and then start feeding good
383 * samples back. */
384 }
85ed4ab3
BV
385 } else {
386 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
387 return SR_ERR;
7f22cd95
BV
388 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
389 devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
85ed4ab3
BV
390 devc->stored_samples = (buf[7] << 8) | buf[8];
391 if (devc->stored_samples == 0) {
392 /* Notify frontend of empty log by sending start/end packets. */
bee2b016 393 std_session_send_df_end(sdi);
85ed4ab3
BV
394 return SR_OK;
395 }
396
397 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
398 devc->stored_samples = devc->limit_samples;
399
400 si = kecheng_kc_330b_sample_intervals[buf[1]];
401 rational[0] = g_variant_new_uint64(si[0]);
402 rational[1] = g_variant_new_uint64(si[1]);
403 gvar = g_variant_new_tuple(rational, 2);
404 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
405 packet.type = SR_DF_META;
406 packet.payload = &meta;
407 meta.config = g_slist_append(NULL, src);
695dc859 408 sr_session_send(sdi, &packet);
85ed4ab3 409 g_free(src);
f336618c
BV
410 }
411
df035528
BV
412 if (!(devc->xfer = libusb_alloc_transfer(0)))
413 return SR_ERR;
414
102f1239 415 usb_source_add(sdi->session, drvc->sr_ctx, 10,
6c60facc 416 kecheng_kc_330b_handle_events, (void *)sdi);
bc7be4a9 417
85ed4ab3
BV
418 if (devc->data_source == DATA_SOURCE_LIVE) {
419 buf[0] = CMD_GET_LIVE_SPL;
420 buf_len = 1;
421 devc->state = LIVE_SPL_WAIT;
422 devc->last_live_request = g_get_monotonic_time() / 1000;
423 req_len = 3;
424 } else {
425 buf[0] = CMD_GET_LOG_DATA;
426 buf[1] = 0;
427 buf[2] = 0;
428 buf_len = 4;
429 devc->state = LOG_DATA_WAIT;
430 if (devc->stored_samples < 63)
431 buf[3] = devc->stored_samples;
432 else
433 buf[3] = 63;
434 /* Command ack byte + 2 bytes per sample. */
435 req_len = 1 + buf[3] * 2;
436 }
437
438 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
bc7be4a9
BV
439 if (ret != 0 || len != 1) {
440 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
df035528
BV
441 libusb_free_transfer(devc->xfer);
442 return SR_ERR;
443 }
df035528
BV
444
445 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
85ed4ab3 446 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
df035528
BV
447 if (libusb_submit_transfer(devc->xfer) != 0) {
448 libusb_free_transfer(devc->xfer);
bc7be4a9
BV
449 return SR_ERR;
450 }
ed759a08
BV
451
452 return SR_OK;
453}
454
695dc859 455static int dev_acquisition_stop(struct sr_dev_inst *sdi)
ed759a08 456{
85ed4ab3
BV
457 struct dev_context *devc;
458
df035528
BV
459 /* Signal USB transfer handler to clean up and stop. */
460 sdi->status = SR_ST_STOPPING;
ed759a08 461
85ed4ab3
BV
462 devc = sdi->priv;
463 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
464 /* The protocol doesn't have a command to clear stored data;
465 * it clears it whenever new configuration is set. That means
466 * we can't just configure the device any time we want when
467 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
468 * it is now, when we're sure we've pulled in all the stored
469 * data. */
470 kecheng_kc_330b_configure(sdi);
471 }
472
ed759a08
BV
473 return SR_OK;
474}
475
dd5c48a6 476static struct sr_dev_driver kecheng_kc_330b_driver_info = {
ed759a08
BV
477 .name = "kecheng-kc-330b",
478 .longname = "Kecheng KC-330B",
479 .api_version = 1,
c2fdcc25 480 .init = std_init,
700d6b64 481 .cleanup = std_cleanup,
ed759a08 482 .scan = scan,
c01bf34c 483 .dev_list = std_dev_list,
f778bf02 484 .dev_clear = std_dev_clear,
ed759a08
BV
485 .config_get = config_get,
486 .config_set = config_set,
487 .config_list = config_list,
488 .dev_open = dev_open,
489 .dev_close = dev_close,
490 .dev_acquisition_start = dev_acquisition_start,
491 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 492 .context = NULL,
ed759a08 493};
dd5c48a6 494SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info);