]>
Commit | Line | Data |
---|---|---|
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 | ||
20 | #include <config.h> | |
21 | #include <string.h> | |
22 | #include "protocol.h" | |
23 | ||
24 | #define USB_CONN "1041.8101" | |
25 | #define USB_INTERFACE 0 | |
26 | ||
27 | static const uint32_t drvopts[] = { | |
28 | SR_CONF_SOUNDLEVELMETER, | |
29 | }; | |
30 | ||
31 | static const uint32_t devopts[] = { | |
32 | SR_CONF_CONTINUOUS, | |
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, | |
39 | }; | |
40 | ||
41 | SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = { | |
42 | { 1, 8 }, | |
43 | { 1, 2 }, | |
44 | { 1, 1 }, | |
45 | { 2, 1 }, | |
46 | { 5, 1 }, | |
47 | { 10, 1 }, | |
48 | { 60, 1 }, | |
49 | }; | |
50 | ||
51 | static const char *weight_freq[] = { | |
52 | "A", "C", | |
53 | }; | |
54 | ||
55 | static const char *weight_time[] = { | |
56 | "F", "S", | |
57 | }; | |
58 | ||
59 | static const char *data_sources[] = { | |
60 | "Live", "Memory", | |
61 | }; | |
62 | ||
63 | static int scan_kecheng(struct sr_dev_driver *di, | |
64 | struct sr_usb_dev_inst *usb, char **model) | |
65 | { | |
66 | struct drv_context *drvc; | |
67 | int len, ret; | |
68 | unsigned char cmd, buf[32]; | |
69 | ||
70 | drvc = di->context; | |
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); | |
99 | ||
100 | return SR_OK; | |
101 | } | |
102 | ||
103 | static GSList *scan(struct sr_dev_driver *di, GSList *options) | |
104 | { | |
105 | struct drv_context *drvc; | |
106 | struct dev_context *devc; | |
107 | struct sr_dev_inst *sdi; | |
108 | GSList *usb_devices, *devices, *l; | |
109 | char *model; | |
110 | ||
111 | (void)options; | |
112 | ||
113 | drvc = di->context; | |
114 | ||
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) { | |
120 | if (scan_kecheng(di, l->data, &model) != SR_OK) | |
121 | continue; | |
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; | |
127 | sdi->conn = l->data; | |
128 | sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL"); | |
129 | devc = g_malloc0(sizeof(struct dev_context)); | |
130 | sdi->priv = devc; | |
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; | |
140 | ||
141 | /* TODO: Set date/time? */ | |
142 | ||
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); | |
148 | ||
149 | return std_scan_complete(di, devices); | |
150 | } | |
151 | ||
152 | static int dev_open(struct sr_dev_inst *sdi) | |
153 | { | |
154 | struct sr_dev_driver *di = sdi->driver; | |
155 | struct drv_context *drvc = di->context; | |
156 | struct sr_usb_dev_inst *usb; | |
157 | int ret; | |
158 | ||
159 | usb = sdi->conn; | |
160 | ||
161 | if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK) | |
162 | return SR_ERR; | |
163 | ||
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 | ||
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 | } | |
173 | ||
174 | return SR_OK; | |
175 | } | |
176 | ||
177 | static int dev_close(struct sr_dev_inst *sdi) | |
178 | { | |
179 | struct dev_context *devc; | |
180 | struct sr_usb_dev_inst *usb; | |
181 | ||
182 | usb = sdi->conn; | |
183 | ||
184 | if (!usb->devhdl) | |
185 | return SR_ERR_BUG; | |
186 | ||
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 | ||
193 | libusb_release_interface(usb->devhdl, USB_INTERFACE); | |
194 | libusb_close(usb->devhdl); | |
195 | usb->devhdl = NULL; | |
196 | ||
197 | return SR_OK; | |
198 | } | |
199 | ||
200 | static int config_get(uint32_t key, GVariant **data, | |
201 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
202 | { | |
203 | struct dev_context *devc; | |
204 | const uint64_t *si; | |
205 | ||
206 | (void)cg; | |
207 | ||
208 | devc = sdi->priv; | |
209 | switch (key) { | |
210 | case SR_CONF_LIMIT_SAMPLES: | |
211 | *data = g_variant_new_uint64(devc->limit_samples); | |
212 | break; | |
213 | case SR_CONF_SAMPLE_INTERVAL: | |
214 | si = kecheng_kc_330b_sample_intervals[devc->sample_interval]; | |
215 | *data = std_gvar_tuple_u64(si[0], si[1]); | |
216 | break; | |
217 | case SR_CONF_DATALOG: | |
218 | /* There really isn't a way to be sure the device is logging. */ | |
219 | return SR_ERR_NA; | |
220 | case SR_CONF_SPL_WEIGHT_FREQ: | |
221 | if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A) | |
222 | *data = g_variant_new_string("A"); | |
223 | else | |
224 | *data = g_variant_new_string("C"); | |
225 | break; | |
226 | case SR_CONF_SPL_WEIGHT_TIME: | |
227 | if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F) | |
228 | *data = g_variant_new_string("F"); | |
229 | else | |
230 | *data = g_variant_new_string("S"); | |
231 | break; | |
232 | case SR_CONF_DATA_SOURCE: | |
233 | if (devc->data_source == DATA_SOURCE_LIVE) | |
234 | *data = g_variant_new_string("Live"); | |
235 | else | |
236 | *data = g_variant_new_string("Memory"); | |
237 | break; | |
238 | default: | |
239 | return SR_ERR_NA; | |
240 | } | |
241 | ||
242 | return SR_OK; | |
243 | } | |
244 | ||
245 | static int config_set(uint32_t key, GVariant *data, | |
246 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
247 | { | |
248 | struct dev_context *devc; | |
249 | int idx; | |
250 | ||
251 | (void)cg; | |
252 | ||
253 | devc = sdi->priv; | |
254 | switch (key) { | |
255 | case SR_CONF_LIMIT_SAMPLES: | |
256 | devc->limit_samples = g_variant_get_uint64(data); | |
257 | break; | |
258 | case SR_CONF_SAMPLE_INTERVAL: | |
259 | if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(kecheng_kc_330b_sample_intervals))) < 0) | |
260 | return SR_ERR_ARG; | |
261 | devc->sample_interval = idx; | |
262 | devc->config_dirty = TRUE; | |
263 | break; | |
264 | case SR_CONF_SPL_WEIGHT_FREQ: | |
265 | if ((idx = std_str_idx(data, ARRAY_AND_SIZE(weight_freq))) < 0) | |
266 | return SR_ERR_ARG; | |
267 | devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C); | |
268 | devc->mqflags |= (weight_freq[idx][0] == 'A') ? SR_MQFLAG_SPL_FREQ_WEIGHT_A : SR_MQFLAG_SPL_FREQ_WEIGHT_C; | |
269 | devc->config_dirty = TRUE; | |
270 | break; | |
271 | case SR_CONF_SPL_WEIGHT_TIME: | |
272 | if ((idx = std_str_idx(data, ARRAY_AND_SIZE(weight_time))) < 0) | |
273 | return SR_ERR_ARG; | |
274 | devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S); | |
275 | devc->mqflags |= (weight_time[idx][0] == 'F') ? SR_MQFLAG_SPL_TIME_WEIGHT_F : SR_MQFLAG_SPL_TIME_WEIGHT_S; | |
276 | devc->config_dirty = TRUE; | |
277 | break; | |
278 | case SR_CONF_DATA_SOURCE: | |
279 | if ((idx = std_str_idx(data, ARRAY_AND_SIZE(data_sources))) < 0) | |
280 | return SR_ERR_ARG; | |
281 | devc->data_source = idx; | |
282 | devc->config_dirty = TRUE; | |
283 | break; | |
284 | default: | |
285 | return SR_ERR_NA; | |
286 | } | |
287 | ||
288 | return SR_OK; | |
289 | } | |
290 | ||
291 | static int config_list(uint32_t key, GVariant **data, | |
292 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
293 | { | |
294 | switch (key) { | |
295 | case SR_CONF_DEVICE_OPTIONS: | |
296 | return STD_CONFIG_LIST(key, data, sdi, cg, NO_OPTS, drvopts, devopts); | |
297 | case SR_CONF_SAMPLE_INTERVAL: | |
298 | *data = std_gvar_tuple_array(ARRAY_AND_SIZE(kecheng_kc_330b_sample_intervals)); | |
299 | break; | |
300 | case SR_CONF_SPL_WEIGHT_FREQ: | |
301 | *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_freq)); | |
302 | break; | |
303 | case SR_CONF_SPL_WEIGHT_TIME: | |
304 | *data = g_variant_new_strv(ARRAY_AND_SIZE(weight_time)); | |
305 | break; | |
306 | case SR_CONF_DATA_SOURCE: | |
307 | *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources)); | |
308 | break; | |
309 | default: | |
310 | return SR_ERR_NA; | |
311 | } | |
312 | ||
313 | return SR_OK; | |
314 | } | |
315 | ||
316 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) | |
317 | { | |
318 | struct sr_dev_driver *di = sdi->driver; | |
319 | struct drv_context *drvc; | |
320 | struct dev_context *devc; | |
321 | struct sr_datafeed_packet packet; | |
322 | struct sr_datafeed_meta meta; | |
323 | struct sr_config *src; | |
324 | struct sr_usb_dev_inst *usb; | |
325 | GVariant *gvar; | |
326 | const uint64_t *si; | |
327 | int req_len, buf_len, len, ret; | |
328 | unsigned char buf[9]; | |
329 | ||
330 | drvc = di->context; | |
331 | devc = sdi->priv; | |
332 | usb = sdi->conn; | |
333 | ||
334 | devc->num_samples = 0; | |
335 | ||
336 | std_session_send_df_header(sdi); | |
337 | ||
338 | if (devc->data_source == DATA_SOURCE_LIVE) { | |
339 | /* Force configuration. */ | |
340 | kecheng_kc_330b_configure(sdi); | |
341 | ||
342 | if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK) | |
343 | return SR_ERR; | |
344 | if (ret != DEVICE_ACTIVE) { | |
345 | sr_err("Device is inactive"); | |
346 | /* Still continue though, since the device will | |
347 | * just return 30.0 until the user hits the button | |
348 | * on the device -- and then start feeding good | |
349 | * samples back. */ | |
350 | } | |
351 | } else { | |
352 | if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK) | |
353 | return SR_ERR; | |
354 | devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F; | |
355 | devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A; | |
356 | devc->stored_samples = (buf[7] << 8) | buf[8]; | |
357 | if (devc->stored_samples == 0) { | |
358 | /* Notify frontend of empty log by sending start/end packets. */ | |
359 | std_session_send_df_end(sdi); | |
360 | return SR_OK; | |
361 | } | |
362 | ||
363 | if (devc->limit_samples && devc->limit_samples < devc->stored_samples) | |
364 | devc->stored_samples = devc->limit_samples; | |
365 | ||
366 | si = kecheng_kc_330b_sample_intervals[buf[1]]; | |
367 | gvar = std_gvar_tuple_u64(si[0], si[1]); | |
368 | ||
369 | src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar); | |
370 | packet.type = SR_DF_META; | |
371 | packet.payload = &meta; | |
372 | meta.config = g_slist_append(NULL, src); | |
373 | sr_session_send(sdi, &packet); | |
374 | g_slist_free(meta.config); | |
375 | sr_config_free(src); | |
376 | } | |
377 | ||
378 | if (!(devc->xfer = libusb_alloc_transfer(0))) | |
379 | return SR_ERR; | |
380 | ||
381 | usb_source_add(sdi->session, drvc->sr_ctx, 10, | |
382 | kecheng_kc_330b_handle_events, (void *)sdi); | |
383 | ||
384 | if (devc->data_source == DATA_SOURCE_LIVE) { | |
385 | buf[0] = CMD_GET_LIVE_SPL; | |
386 | buf_len = 1; | |
387 | devc->state = LIVE_SPL_WAIT; | |
388 | devc->last_live_request = g_get_monotonic_time() / 1000; | |
389 | req_len = 3; | |
390 | } else { | |
391 | buf[0] = CMD_GET_LOG_DATA; | |
392 | buf[1] = 0; | |
393 | buf[2] = 0; | |
394 | buf_len = 4; | |
395 | devc->state = LOG_DATA_WAIT; | |
396 | if (devc->stored_samples < 63) | |
397 | buf[3] = devc->stored_samples; | |
398 | else | |
399 | buf[3] = 63; | |
400 | /* Command ack byte + 2 bytes per sample. */ | |
401 | req_len = 1 + buf[3] * 2; | |
402 | } | |
403 | ||
404 | ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5); | |
405 | if (ret != 0 || len != 1) { | |
406 | sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret)); | |
407 | libusb_free_transfer(devc->xfer); | |
408 | return SR_ERR; | |
409 | } | |
410 | ||
411 | libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf, | |
412 | req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15); | |
413 | if (libusb_submit_transfer(devc->xfer) != 0) { | |
414 | libusb_free_transfer(devc->xfer); | |
415 | return SR_ERR; | |
416 | } | |
417 | ||
418 | return SR_OK; | |
419 | } | |
420 | ||
421 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) | |
422 | { | |
423 | struct dev_context *devc; | |
424 | ||
425 | /* Signal USB transfer handler to clean up and stop. */ | |
426 | sdi->status = SR_ST_STOPPING; | |
427 | ||
428 | devc = sdi->priv; | |
429 | if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) { | |
430 | /* The protocol doesn't have a command to clear stored data; | |
431 | * it clears it whenever new configuration is set. That means | |
432 | * we can't just configure the device any time we want when | |
433 | * it's in DATA_SOURCE_MEMORY mode. The only safe time to do | |
434 | * it is now, when we're sure we've pulled in all the stored | |
435 | * data. */ | |
436 | kecheng_kc_330b_configure(sdi); | |
437 | } | |
438 | ||
439 | return SR_OK; | |
440 | } | |
441 | ||
442 | static struct sr_dev_driver kecheng_kc_330b_driver_info = { | |
443 | .name = "kecheng-kc-330b", | |
444 | .longname = "Kecheng KC-330B", | |
445 | .api_version = 1, | |
446 | .init = std_init, | |
447 | .cleanup = std_cleanup, | |
448 | .scan = scan, | |
449 | .dev_list = std_dev_list, | |
450 | .dev_clear = std_dev_clear, | |
451 | .config_get = config_get, | |
452 | .config_set = config_set, | |
453 | .config_list = config_list, | |
454 | .dev_open = dev_open, | |
455 | .dev_close = dev_close, | |
456 | .dev_acquisition_start = dev_acquisition_start, | |
457 | .dev_acquisition_stop = dev_acquisition_stop, | |
458 | .context = NULL, | |
459 | }; | |
460 | SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info); |