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 USB_INTERFACE 0
27 static const uint32_t drvopts[] = {
28 SR_CONF_SOUNDLEVELMETER,
31 static const uint32_t devopts[] = {
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,
41 SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
51 static const char *weight_freq[] = {
55 static const char *weight_time[] = {
59 static const char *data_sources[] = {
63 static int scan_kecheng(struct sr_dev_driver *di,
64 struct sr_usb_dev_inst *usb, char **model)
66 struct drv_context *drvc;
68 unsigned char cmd, buf[32];
71 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
75 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
77 libusb_close(usb->devhdl);
78 sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
82 ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
84 libusb_close(usb->devhdl);
85 sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
89 libusb_close(usb->devhdl);
92 if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
93 sr_dbg("Invalid response to Identify command");
97 buf[buf[1] + 2] = '\x0';
98 *model = g_strndup((const gchar *)buf + 2, 30);
103 static GSList *scan(struct sr_dev_driver *di, GSList *options)
105 struct drv_context *drvc;
106 struct dev_context *devc;
107 struct sr_dev_inst *sdi;
108 GSList *usb_devices, *devices, *l;
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) {
120 if (scan_kecheng(di, l->data, &model) != SR_OK)
122 sdi = g_malloc0(sizeof(struct sr_dev_inst));
123 sdi->status = SR_ST_INACTIVE;
124 sdi->vendor = g_strdup("Kecheng");
125 sdi->model = model; /* Already g_strndup()'d. */
126 sdi->inst_type = SR_INST_USB;
128 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
129 devc = g_malloc0(sizeof(struct dev_context));
131 devc->limit_samples = 0;
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;
139 devc->config_dirty = FALSE;
141 /* TODO: Set date/time? */
143 devices = g_slist_append(devices, sdi);
145 g_slist_free(usb_devices);
147 g_slist_free_full(usb_devices, g_free);
149 return std_scan_complete(di, devices);
152 static int dev_open(struct sr_dev_inst *sdi)
154 struct sr_dev_driver *di = sdi->driver;
155 struct drv_context *drvc = di->context;
156 struct sr_usb_dev_inst *usb;
161 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
164 if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
165 sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
169 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
170 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
177 static int dev_close(struct sr_dev_inst *sdi)
179 struct dev_context *devc;
180 struct sr_usb_dev_inst *usb;
187 /* This allows a frontend to configure the device without ever
188 * doing an acquisition step. */
190 if (!devc->config_dirty)
191 kecheng_kc_330b_configure(sdi);
193 libusb_release_interface(usb->devhdl, USB_INTERFACE);
194 libusb_close(usb->devhdl);
200 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
201 const struct sr_channel_group *cg)
203 struct dev_context *devc;
204 GVariant *rational[2];
211 case SR_CONF_LIMIT_SAMPLES:
212 *data = g_variant_new_uint64(devc->limit_samples);
214 case SR_CONF_SAMPLE_INTERVAL:
215 si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
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);
220 case SR_CONF_DATALOG:
221 /* There really isn't a way to be sure the device is logging. */
224 case SR_CONF_SPL_WEIGHT_FREQ:
225 if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
226 *data = g_variant_new_string("A");
228 *data = g_variant_new_string("C");
230 case SR_CONF_SPL_WEIGHT_TIME:
231 if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
232 *data = g_variant_new_string("F");
234 *data = g_variant_new_string("S");
236 case SR_CONF_DATA_SOURCE:
237 if (devc->data_source == DATA_SOURCE_LIVE)
238 *data = g_variant_new_string("Live");
240 *data = g_variant_new_string("Memory");
249 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
250 const struct sr_channel_group *cg)
252 struct dev_context *devc;
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);
267 case SR_CONF_SAMPLE_INTERVAL:
268 g_variant_get(data, "(tt)", &p, &q);
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)
272 devc->sample_interval = i;
273 devc->config_dirty = TRUE;
276 if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
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;
287 devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
288 devc->mqflags |= tmp;
289 devc->config_dirty = TRUE;
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;
299 devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
300 devc->mqflags |= tmp;
301 devc->config_dirty = TRUE;
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;
311 devc->config_dirty = TRUE;
320 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
321 const struct sr_channel_group *cg)
324 case SR_CONF_DEVICE_OPTIONS:
325 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
326 case SR_CONF_SAMPLE_INTERVAL:
327 *data = std_gvar_tuple_array(&kecheng_kc_330b_sample_intervals,
328 ARRAY_SIZE(kecheng_kc_330b_sample_intervals));
330 case SR_CONF_SPL_WEIGHT_FREQ:
331 *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_freq));
333 case SR_CONF_SPL_WEIGHT_TIME:
334 *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_time));
336 case SR_CONF_DATA_SOURCE:
337 *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
346 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
348 struct sr_dev_driver *di = sdi->driver;
349 struct drv_context *drvc;
350 struct dev_context *devc;
351 struct sr_datafeed_packet packet;
352 struct sr_datafeed_meta meta;
353 struct sr_config *src;
354 struct sr_usb_dev_inst *usb;
355 GVariant *gvar, *rational[2];
357 int req_len, buf_len, len, ret;
358 unsigned char buf[9];
364 devc->num_samples = 0;
366 std_session_send_df_header(sdi);
368 if (devc->data_source == DATA_SOURCE_LIVE) {
369 /* Force configuration. */
370 kecheng_kc_330b_configure(sdi);
372 if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
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
382 if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
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;
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. */
389 std_session_send_df_end(sdi);
393 if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
394 devc->stored_samples = devc->limit_samples;
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);
404 sr_session_send(sdi, &packet);
408 if (!(devc->xfer = libusb_alloc_transfer(0)))
411 usb_source_add(sdi->session, drvc->sr_ctx, 10,
412 kecheng_kc_330b_handle_events, (void *)sdi);
414 if (devc->data_source == DATA_SOURCE_LIVE) {
415 buf[0] = CMD_GET_LIVE_SPL;
417 devc->state = LIVE_SPL_WAIT;
418 devc->last_live_request = g_get_monotonic_time() / 1000;
421 buf[0] = CMD_GET_LOG_DATA;
425 devc->state = LOG_DATA_WAIT;
426 if (devc->stored_samples < 63)
427 buf[3] = devc->stored_samples;
430 /* Command ack byte + 2 bytes per sample. */
431 req_len = 1 + buf[3] * 2;
434 ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
435 if (ret != 0 || len != 1) {
436 sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
437 libusb_free_transfer(devc->xfer);
441 libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
442 req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
443 if (libusb_submit_transfer(devc->xfer) != 0) {
444 libusb_free_transfer(devc->xfer);
451 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
453 struct dev_context *devc;
455 /* Signal USB transfer handler to clean up and stop. */
456 sdi->status = SR_ST_STOPPING;
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
466 kecheng_kc_330b_configure(sdi);
472 static struct sr_dev_driver kecheng_kc_330b_driver_info = {
473 .name = "kecheng-kc-330b",
474 .longname = "Kecheng KC-330B",
477 .cleanup = std_cleanup,
479 .dev_list = std_dev_list,
480 .dev_clear = std_dev_clear,
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,
490 SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info);