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