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 static int scan_kecheng(struct sr_dev_driver *di,
65 struct sr_usb_dev_inst *usb, char **model)
67 struct drv_context *drvc;
69 unsigned char cmd, buf[32];
72 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
76 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
78 libusb_close(usb->devhdl);
79 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
83 ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
85 libusb_close(usb->devhdl);
86 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
90 libusb_close(usb->devhdl);
93 if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
94 sr_dbg("Invalid response to Identify command");
98 buf[buf[1] + 2] = '\x0';
99 *model = g_strndup((const gchar *)buf + 2, 30);
104 static GSList *scan(struct sr_dev_driver *di, GSList *options)
106 struct drv_context *drvc;
107 struct dev_context *devc;
108 struct sr_dev_inst *sdi;
109 GSList *usb_devices, *devices, *l;
117 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
118 /* We have a list of sr_usb_dev_inst matching the connection
119 * string. Wrap them in sr_dev_inst and we're done. */
120 for (l = usb_devices; l; l = l->next) {
121 if (scan_kecheng(di, l->data, &model) != SR_OK)
123 sdi = g_malloc0(sizeof(struct sr_dev_inst));
124 sdi->status = SR_ST_INACTIVE;
125 sdi->vendor = g_strdup(VENDOR);
126 sdi->model = model; /* Already g_strndup()'d. */
127 sdi->inst_type = SR_INST_USB;
129 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
130 devc = g_malloc0(sizeof(struct dev_context));
132 devc->limit_samples = 0;
133 /* The protocol provides no way to read the current
134 * settings, so we'll enforce these. */
135 devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
136 devc->alarm_low = DEFAULT_ALARM_LOW;
137 devc->alarm_high = DEFAULT_ALARM_HIGH;
138 devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
139 devc->data_source = DEFAULT_DATA_SOURCE;
140 devc->config_dirty = FALSE;
142 /* TODO: Set date/time? */
144 devices = g_slist_append(devices, sdi);
146 g_slist_free(usb_devices);
148 g_slist_free_full(usb_devices, g_free);
150 return std_scan_complete(di, devices);
153 static int dev_open(struct sr_dev_inst *sdi)
155 struct sr_dev_driver *di = sdi->driver;
156 struct drv_context *drvc = di->context;
157 struct sr_usb_dev_inst *usb;
162 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
165 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
166 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
170 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
171 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
174 sdi->status = SR_ST_ACTIVE;
179 static int dev_close(struct sr_dev_inst *sdi)
181 struct dev_context *devc;
182 struct sr_usb_dev_inst *usb;
190 /* This allows a frontend to configure the device without ever
191 * doing an acquisition step. */
193 if (!devc->config_dirty)
194 kecheng_kc_330b_configure(sdi);
196 libusb_release_interface(usb->devhdl, USB_INTERFACE);
197 libusb_close(usb->devhdl);
199 sdi->status = SR_ST_INACTIVE;
204 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
205 const struct sr_channel_group *cg)
207 struct dev_context *devc;
208 GVariant *rational[2];
215 case SR_CONF_LIMIT_SAMPLES:
216 *data = g_variant_new_uint64(devc->limit_samples);
218 case SR_CONF_SAMPLE_INTERVAL:
219 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
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);
224 case SR_CONF_DATALOG:
225 /* There really isn't a way to be sure the device is logging. */
228 case SR_CONF_SPL_WEIGHT_FREQ:
229 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
230 *data = g_variant_new_string("A");
232 *data = g_variant_new_string("C");
234 case SR_CONF_SPL_WEIGHT_TIME:
235 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
236 *data = g_variant_new_string("F");
238 *data = g_variant_new_string("S");
240 case SR_CONF_DATA_SOURCE:
241 if (devc->data_source == DATA_SOURCE_LIVE)
242 *data = g_variant_new_string("Live");
244 *data = g_variant_new_string("Memory");
253 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
254 const struct sr_channel_group *cg)
256 struct dev_context *devc;
264 if (sdi->status != SR_ST_ACTIVE)
265 return SR_ERR_DEV_CLOSED;
270 case SR_CONF_LIMIT_SAMPLES:
271 devc->limit_samples = g_variant_get_uint64(data);
272 sr_dbg("Setting sample limit to %" PRIu64 ".",
273 devc->limit_samples);
275 case SR_CONF_SAMPLE_INTERVAL:
276 g_variant_get(data, "(tt)", &p, &q);
277 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
278 if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
280 devc->sample_interval = i;
281 devc->config_dirty = TRUE;
284 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
287 case SR_CONF_SPL_WEIGHT_FREQ:
288 tmp_str = g_variant_get_string(data, NULL);
289 if (!strcmp(tmp_str, "A"))
290 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
291 else if (!strcmp(tmp_str, "C"))
292 tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
295 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
296 devc->mqflags |= tmp;
297 devc->config_dirty = TRUE;
299 case SR_CONF_SPL_WEIGHT_TIME:
300 tmp_str = g_variant_get_string(data, NULL);
301 if (!strcmp(tmp_str, "F"))
302 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
303 else if (!strcmp(tmp_str, "S"))
304 tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
307 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
308 devc->mqflags |= tmp;
309 devc->config_dirty = TRUE;
311 case SR_CONF_DATA_SOURCE:
312 tmp_str = g_variant_get_string(data, NULL);
313 if (!strcmp(tmp_str, "Live"))
314 devc->data_source = DATA_SOURCE_LIVE;
315 else if (!strcmp(tmp_str, "Memory"))
316 devc->data_source = DATA_SOURCE_MEMORY;
319 devc->config_dirty = TRUE;
328 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
329 const struct sr_channel_group *cg)
331 GVariant *tuple, *rational[2];
339 case SR_CONF_DEVICE_OPTIONS:
340 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
341 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
343 case SR_CONF_SAMPLE_INTERVAL:
344 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
345 for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
346 rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
347 rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
348 tuple = g_variant_new_tuple(rational, 2);
349 g_variant_builder_add_value(&gvb, tuple);
351 *data = g_variant_builder_end(&gvb);
353 case SR_CONF_SPL_WEIGHT_FREQ:
354 *data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
356 case SR_CONF_SPL_WEIGHT_TIME:
357 *data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
359 case SR_CONF_DATA_SOURCE:
360 *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
369 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
371 struct sr_dev_driver *di = sdi->driver;
372 struct drv_context *drvc;
373 struct dev_context *devc;
374 struct sr_datafeed_packet packet;
375 struct sr_datafeed_meta meta;
376 struct sr_config *src;
377 struct sr_usb_dev_inst *usb;
378 GVariant *gvar, *rational[2];
380 int req_len, buf_len, len, ret;
381 unsigned char buf[9];
383 if (sdi->status != SR_ST_ACTIVE)
384 return SR_ERR_DEV_CLOSED;
390 devc->num_samples = 0;
392 std_session_send_df_header(sdi);
394 if (devc->data_source == DATA_SOURCE_LIVE) {
395 /* Force configuration. */
396 kecheng_kc_330b_configure(sdi);
398 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
400 if (ret != DEVICE_ACTIVE) {
401 sr_err("Device is inactive");
402 /* Still continue though, since the device will
403 * just return 30.0 until the user hits the button
404 * on the device -- and then start feeding good
408 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
410 devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
411 devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
412 devc->stored_samples = (buf[7] << 8) | buf[8];
413 if (devc->stored_samples == 0) {
414 /* Notify frontend of empty log by sending start/end packets. */
415 std_session_send_df_end(sdi);
419 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
420 devc->stored_samples = devc->limit_samples;
422 si = kecheng_kc_330b_sample_intervals[buf[1]];
423 rational[0] = g_variant_new_uint64(si[0]);
424 rational[1] = g_variant_new_uint64(si[1]);
425 gvar = g_variant_new_tuple(rational, 2);
426 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
427 packet.type = SR_DF_META;
428 packet.payload = &meta;
429 meta.config = g_slist_append(NULL, src);
430 sr_session_send(sdi, &packet);
434 if (!(devc->xfer = libusb_alloc_transfer(0)))
437 usb_source_add(sdi->session, drvc->sr_ctx, 10,
438 kecheng_kc_330b_handle_events, (void *)sdi);
440 if (devc->data_source == DATA_SOURCE_LIVE) {
441 buf[0] = CMD_GET_LIVE_SPL;
443 devc->state = LIVE_SPL_WAIT;
444 devc->last_live_request = g_get_monotonic_time() / 1000;
447 buf[0] = CMD_GET_LOG_DATA;
451 devc->state = LOG_DATA_WAIT;
452 if (devc->stored_samples < 63)
453 buf[3] = devc->stored_samples;
456 /* Command ack byte + 2 bytes per sample. */
457 req_len = 1 + buf[3] * 2;
460 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
461 if (ret != 0 || len != 1) {
462 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
463 libusb_free_transfer(devc->xfer);
467 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
468 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
469 if (libusb_submit_transfer(devc->xfer) != 0) {
470 libusb_free_transfer(devc->xfer);
477 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
479 struct dev_context *devc;
481 if (sdi->status != SR_ST_ACTIVE)
482 return SR_ERR_DEV_CLOSED;
484 /* Signal USB transfer handler to clean up and stop. */
485 sdi->status = SR_ST_STOPPING;
488 if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
489 /* The protocol doesn't have a command to clear stored data;
490 * it clears it whenever new configuration is set. That means
491 * we can't just configure the device any time we want when
492 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
493 * it is now, when we're sure we've pulled in all the stored
495 kecheng_kc_330b_configure(sdi);
501 static struct sr_dev_driver kecheng_kc_330b_driver_info = {
502 .name = "kecheng-kc-330b",
503 .longname = "Kecheng KC-330B",
506 .cleanup = std_cleanup,
508 .dev_list = std_dev_list,
510 .config_get = config_get,
511 .config_set = config_set,
512 .config_list = config_list,
513 .dev_open = dev_open,
514 .dev_close = dev_close,
515 .dev_acquisition_start = dev_acquisition_start,
516 .dev_acquisition_stop = dev_acquisition_stop,
519 SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info);