2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
24 #define USB_CONN "1041.8101"
25 #define VENDOR "Kecheng"
26 #define USB_INTERFACE 0
28 static const uint32_t devopts[] = {
29 SR_CONF_SOUNDLEVELMETER,
31 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
32 SR_CONF_SAMPLE_INTERVAL | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
33 SR_CONF_DATALOG | SR_CONF_GET,
34 SR_CONF_SPL_WEIGHT_FREQ | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
35 SR_CONF_SPL_WEIGHT_TIME | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
36 SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
49 static const char *weight_freq[] = {
54 static const char *weight_time[] = {
59 static const char *data_sources[] = {
64 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
66 static int scan_kecheng(struct sr_dev_driver *di,
67 struct sr_usb_dev_inst *usb, char **model)
69 struct drv_context *drvc;
71 unsigned char cmd, buf[32];
74 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
78 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
80 libusb_close(usb->devhdl);
81 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
85 ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
87 libusb_close(usb->devhdl);
88 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
92 libusb_close(usb->devhdl);
95 if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
96 sr_dbg("Invalid response to Identify command");
100 buf[buf[1] + 2] = '\x0';
101 *model = g_strndup((const gchar *)buf + 2, 30);
106 static GSList *scan(struct sr_dev_driver *di, GSList *options)
108 struct drv_context *drvc;
109 struct dev_context *devc;
110 struct sr_dev_inst *sdi;
111 GSList *usb_devices, *devices, *l;
117 drvc->instances = 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) {
124 if (scan_kecheng(di, l->data, &model) != SR_OK)
126 sdi = g_malloc0(sizeof(struct sr_dev_inst));
127 sdi->status = SR_ST_INACTIVE;
128 sdi->vendor = g_strdup(VENDOR);
129 sdi->model = model; /* Already g_strndup()'d. */
131 sdi->inst_type = SR_INST_USB;
133 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
134 devc = g_malloc0(sizeof(struct dev_context));
136 devc->limit_samples = 0;
137 /* The protocol provides no way to read the current
138 * settings, so we'll enforce these. */
139 devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
140 devc->alarm_low = DEFAULT_ALARM_LOW;
141 devc->alarm_high = DEFAULT_ALARM_HIGH;
142 devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
143 devc->data_source = DEFAULT_DATA_SOURCE;
144 devc->config_dirty = FALSE;
146 /* TODO: Set date/time? */
148 drvc->instances = g_slist_append(drvc->instances, sdi);
149 devices = g_slist_append(devices, sdi);
151 g_slist_free(usb_devices);
153 g_slist_free_full(usb_devices, g_free);
158 static int dev_open(struct sr_dev_inst *sdi)
160 struct sr_dev_driver *di = sdi->driver;
161 struct drv_context *drvc = di->context;
162 struct sr_usb_dev_inst *usb;
167 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
170 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
171 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
175 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
176 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
179 sdi->status = SR_ST_ACTIVE;
184 static int dev_close(struct sr_dev_inst *sdi)
186 struct dev_context *devc;
187 struct sr_usb_dev_inst *usb;
195 /* This allows a frontend to configure the device without ever
196 * doing an acquisition step. */
198 if (!devc->config_dirty)
199 kecheng_kc_330b_configure(sdi);
201 libusb_release_interface(usb->devhdl, USB_INTERFACE);
202 libusb_close(usb->devhdl);
204 sdi->status = SR_ST_INACTIVE;
209 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
210 const struct sr_channel_group *cg)
212 struct dev_context *devc;
213 GVariant *rational[2];
220 case SR_CONF_LIMIT_SAMPLES:
221 *data = g_variant_new_uint64(devc->limit_samples);
223 case SR_CONF_SAMPLE_INTERVAL:
224 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
225 rational[0] = g_variant_new_uint64(si[0]);
226 rational[1] = g_variant_new_uint64(si[1]);
227 *data = g_variant_new_tuple(rational, 2);
229 case SR_CONF_DATALOG:
230 /* There really isn't a way to be sure the device is logging. */
233 case SR_CONF_SPL_WEIGHT_FREQ:
234 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
235 *data = g_variant_new_string("A");
237 *data = g_variant_new_string("C");
239 case SR_CONF_SPL_WEIGHT_TIME:
240 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
241 *data = g_variant_new_string("F");
243 *data = g_variant_new_string("S");
245 case SR_CONF_DATA_SOURCE:
246 if (devc->data_source == DATA_SOURCE_LIVE)
247 *data = g_variant_new_string("Live");
249 *data = g_variant_new_string("Memory");
258 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
259 const struct sr_channel_group *cg)
261 struct dev_context *devc;
269 if (sdi->status != SR_ST_ACTIVE)
270 return SR_ERR_DEV_CLOSED;
275 case SR_CONF_LIMIT_SAMPLES:
276 devc->limit_samples = g_variant_get_uint64(data);
277 sr_dbg("Setting sample limit to %" PRIu64 ".",
278 devc->limit_samples);
280 case SR_CONF_SAMPLE_INTERVAL:
281 g_variant_get(data, "(tt)", &p, &q);
282 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
283 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
285 devc->sample_interval = i;
286 devc->config_dirty = TRUE;
289 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
292 case SR_CONF_SPL_WEIGHT_FREQ:
293 tmp_str = g_variant_get_string(data, NULL);
294 if (!strcmp(tmp_str, "A"))
295 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
296 else if (!strcmp(tmp_str, "C"))
297 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
300 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
301 devc->mqflags |= tmp;
302 devc->config_dirty = TRUE;
304 case SR_CONF_SPL_WEIGHT_TIME:
305 tmp_str = g_variant_get_string(data, NULL);
306 if (!strcmp(tmp_str, "F"))
307 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
308 else if (!strcmp(tmp_str, "S"))
309 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
312 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
313 devc->mqflags |= tmp;
314 devc->config_dirty = TRUE;
316 case SR_CONF_DATA_SOURCE:
317 tmp_str = g_variant_get_string(data, NULL);
318 if (!strcmp(tmp_str, "Live"))
319 devc->data_source = DATA_SOURCE_LIVE;
320 else if (!strcmp(tmp_str, "Memory"))
321 devc->data_source = DATA_SOURCE_MEMORY;
324 devc->config_dirty = TRUE;
333 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
334 const struct sr_channel_group *cg)
336 GVariant *tuple, *rational[2];
344 case SR_CONF_DEVICE_OPTIONS:
345 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
346 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
348 case SR_CONF_SAMPLE_INTERVAL:
349 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
350 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
351 rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
352 rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
353 tuple = g_variant_new_tuple(rational, 2);
354 g_variant_builder_add_value(&gvb, tuple);
356 *data = g_variant_builder_end(&gvb);
358 case SR_CONF_SPL_WEIGHT_FREQ:
359 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
361 case SR_CONF_SPL_WEIGHT_TIME:
362 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
364 case SR_CONF_DATA_SOURCE:
365 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
374 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
376 struct sr_dev_driver *di = sdi->driver;
377 struct drv_context *drvc;
378 struct dev_context *devc;
379 struct sr_datafeed_packet packet;
380 struct sr_datafeed_meta meta;
381 struct sr_config *src;
382 struct sr_usb_dev_inst *usb;
383 GVariant *gvar, *rational[2];
385 int req_len, buf_len, len, ret;
386 unsigned char buf[9];
388 if (sdi->status != SR_ST_ACTIVE)
389 return SR_ERR_DEV_CLOSED;
395 devc->num_samples = 0;
397 std_session_send_df_header(sdi, LOG_PREFIX);
399 if (devc->data_source == DATA_SOURCE_LIVE) {
400 /* Force configuration. */
401 kecheng_kc_330b_configure(sdi);
403 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
405 if (ret != DEVICE_ACTIVE) {
406 sr_err("Device is inactive");
407 /* Still continue though, since the device will
408 * just return 30.0 until the user hits the button
409 * on the device -- and then start feeding good
413 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
415 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
416 devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
417 devc->stored_samples = (buf[7] << 8) | buf[8];
418 if (devc->stored_samples == 0) {
419 /* Notify frontend of empty log by sending start/end packets. */
420 std_session_send_df_end(sdi, LOG_PREFIX);
424 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
425 devc->stored_samples = devc->limit_samples;
427 si = kecheng_kc_330b_sample_intervals[buf[1]];
428 rational[0] = g_variant_new_uint64(si[0]);
429 rational[1] = g_variant_new_uint64(si[1]);
430 gvar = g_variant_new_tuple(rational, 2);
431 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
432 packet.type = SR_DF_META;
433 packet.payload = &meta;
434 meta.config = g_slist_append(NULL, src);
435 sr_session_send(sdi, &packet);
439 if (!(devc->xfer = libusb_alloc_transfer(0)))
442 usb_source_add(sdi->session, drvc->sr_ctx, 10,
443 kecheng_kc_330b_handle_events, (void *)sdi);
445 if (devc->data_source == DATA_SOURCE_LIVE) {
446 buf[0] = CMD_GET_LIVE_SPL;
448 devc->state = LIVE_SPL_WAIT;
449 devc->last_live_request = g_get_monotonic_time() / 1000;
452 buf[0] = CMD_GET_LOG_DATA;
456 devc->state = LOG_DATA_WAIT;
457 if (devc->stored_samples < 63)
458 buf[3] = devc->stored_samples;
461 /* Command ack byte + 2 bytes per sample. */
462 req_len = 1 + buf[3] * 2;
465 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
466 if (ret != 0 || len != 1) {
467 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
468 libusb_free_transfer(devc->xfer);
472 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
473 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
474 if (libusb_submit_transfer(devc->xfer) != 0) {
475 libusb_free_transfer(devc->xfer);
482 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
484 struct dev_context *devc;
486 if (sdi->status != SR_ST_ACTIVE)
487 return SR_ERR_DEV_CLOSED;
489 /* Signal USB transfer handler to clean up and stop. */
490 sdi->status = SR_ST_STOPPING;
493 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
494 /* The protocol doesn't have a command to clear stored data;
495 * it clears it whenever new configuration is set. That means
496 * we can't just configure the device any time we want when
497 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
498 * it is now, when we're sure we've pulled in all the stored
500 kecheng_kc_330b_configure(sdi);
506 SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info = {
507 .name = "kecheng-kc-330b",
508 .longname = "Kecheng KC-330B",
511 .cleanup = std_cleanup,
513 .dev_list = std_dev_list,
515 .config_get = config_get,
516 .config_set = config_set,
517 .config_list = config_list,
518 .dev_open = dev_open,
519 .dev_close = dev_close,
520 .dev_acquisition_start = dev_acquisition_start,
521 .dev_acquisition_stop = dev_acquisition_stop,