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 drvopts[] = {
29 SR_CONF_SOUNDLEVELMETER,
32 static const uint32_t devopts[] = {
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,
42 SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
52 static const char *weight_freq[] = {
57 static const char *weight_time[] = {
62 static const char *data_sources[] = {
67 static int scan_kecheng(struct sr_dev_driver *di,
68 struct sr_usb_dev_inst *usb, char **model)
70 struct drv_context *drvc;
72 unsigned char cmd, buf[32];
75 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
79 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
81 libusb_close(usb->devhdl);
82 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
86 ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
88 libusb_close(usb->devhdl);
89 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
93 libusb_close(usb->devhdl);
96 if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
97 sr_dbg("Invalid response to Identify command");
101 buf[buf[1] + 2] = '\x0';
102 *model = g_strndup((const gchar *)buf + 2, 30);
107 static GSList *scan(struct sr_dev_driver *di, GSList *options)
109 struct drv_context *drvc;
110 struct dev_context *devc;
111 struct sr_dev_inst *sdi;
112 GSList *usb_devices, *devices, *l;
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. */
130 sdi->inst_type = SR_INST_USB;
132 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
133 devc = g_malloc0(sizeof(struct dev_context));
135 devc->limit_samples = 0;
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;
143 devc->config_dirty = FALSE;
145 /* TODO: Set date/time? */
147 devices = g_slist_append(devices, sdi);
149 g_slist_free(usb_devices);
151 g_slist_free_full(usb_devices, g_free);
153 return std_scan_complete(di, devices);
156 static int dev_open(struct sr_dev_inst *sdi)
158 struct sr_dev_driver *di = sdi->driver;
159 struct drv_context *drvc = di->context;
160 struct sr_usb_dev_inst *usb;
165 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
168 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
169 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
173 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
174 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
181 static int dev_close(struct sr_dev_inst *sdi)
183 struct dev_context *devc;
184 struct sr_usb_dev_inst *usb;
191 /* This allows a frontend to configure the device without ever
192 * doing an acquisition step. */
194 if (!devc->config_dirty)
195 kecheng_kc_330b_configure(sdi);
197 libusb_release_interface(usb->devhdl, USB_INTERFACE);
198 libusb_close(usb->devhdl);
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;
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);
271 case SR_CONF_SAMPLE_INTERVAL:
272 g_variant_get(data, "(tt)", &p, &q);
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)
276 devc->sample_interval = i;
277 devc->config_dirty = TRUE;
280 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
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;
291 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
292 devc->mqflags |= tmp;
293 devc->config_dirty = TRUE;
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;
303 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
304 devc->mqflags |= tmp;
305 devc->config_dirty = TRUE;
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;
315 devc->config_dirty = TRUE;
324 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
325 const struct sr_channel_group *cg)
328 case SR_CONF_DEVICE_OPTIONS:
329 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
330 case SR_CONF_SAMPLE_INTERVAL:
331 *data = std_gvar_tuple_array(&kecheng_kc_330b_sample_intervals,
332 ARRAY_SIZE(kecheng_kc_330b_sample_intervals));
334 case SR_CONF_SPL_WEIGHT_FREQ:
335 *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_freq));
337 case SR_CONF_SPL_WEIGHT_TIME:
338 *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_time));
340 case SR_CONF_DATA_SOURCE:
341 *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
350 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
352 struct sr_dev_driver *di = sdi->driver;
353 struct drv_context *drvc;
354 struct dev_context *devc;
355 struct sr_datafeed_packet packet;
356 struct sr_datafeed_meta meta;
357 struct sr_config *src;
358 struct sr_usb_dev_inst *usb;
359 GVariant *gvar, *rational[2];
361 int req_len, buf_len, len, ret;
362 unsigned char buf[9];
368 devc->num_samples = 0;
370 std_session_send_df_header(sdi);
372 if (devc->data_source == DATA_SOURCE_LIVE) {
373 /* Force configuration. */
374 kecheng_kc_330b_configure(sdi);
376 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
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
386 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
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;
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. */
393 std_session_send_df_end(sdi);
397 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
398 devc->stored_samples = devc->limit_samples;
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);
408 sr_session_send(sdi, &packet);
412 if (!(devc->xfer = libusb_alloc_transfer(0)))
415 usb_source_add(sdi->session, drvc->sr_ctx, 10,
416 kecheng_kc_330b_handle_events, (void *)sdi);
418 if (devc->data_source == DATA_SOURCE_LIVE) {
419 buf[0] = CMD_GET_LIVE_SPL;
421 devc->state = LIVE_SPL_WAIT;
422 devc->last_live_request = g_get_monotonic_time() / 1000;
425 buf[0] = CMD_GET_LOG_DATA;
429 devc->state = LOG_DATA_WAIT;
430 if (devc->stored_samples < 63)
431 buf[3] = devc->stored_samples;
434 /* Command ack byte + 2 bytes per sample. */
435 req_len = 1 + buf[3] * 2;
438 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
439 if (ret != 0 || len != 1) {
440 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
441 libusb_free_transfer(devc->xfer);
445 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
446 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
447 if (libusb_submit_transfer(devc->xfer) != 0) {
448 libusb_free_transfer(devc->xfer);
455 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
457 struct dev_context *devc;
459 /* Signal USB transfer handler to clean up and stop. */
460 sdi->status = SR_ST_STOPPING;
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
470 kecheng_kc_330b_configure(sdi);
476 static struct sr_dev_driver kecheng_kc_330b_driver_info = {
477 .name = "kecheng-kc-330b",
478 .longname = "Kecheng KC-330B",
481 .cleanup = std_cleanup,
483 .dev_list = std_dev_list,
484 .dev_clear = std_dev_clear,
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,
494 SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info);