2 * This file is part of the libsigrok project.
4 * Copyright (C) 2016 Andreas Zschunke <andreas.zschunke@gmx.net>
5 * Copyright (C) 2017 Andrej Valek <andy@skyrain.eu>
6 * Copyright (C) 2017 Uwe Hermann <uwe@hermann-uwe.de>
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #define USB_INTERFACE 0
26 #define NUM_CHANNELS 32
28 static const uint32_t scanopts[] = {
32 static const uint32_t drvopts[] = {
33 SR_CONF_LOGIC_ANALYZER,
36 static const uint32_t devopts[] = {
37 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
38 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
39 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
40 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
41 SR_CONF_CONN | SR_CONF_GET,
42 SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_SET | SR_CONF_LIST,
45 static const int32_t trigger_matches[] = {
53 static const uint64_t samplerates[] = {
89 static const uint64_t samplerates_hw[] = {
128 SR_PRIV struct sr_dev_driver hantek_4032l_driver_info;
130 static GSList *scan(struct sr_dev_driver *di, GSList *options)
132 struct drv_context *drvc = di->context;
133 GSList *l, *devices, *conn_devices;
134 libusb_device **devlist;
135 struct libusb_device_descriptor des;
138 char connection_id[64];
139 struct sr_channel_group *cg;
140 struct sr_dev_inst *sdi;
141 struct sr_channel *ch;
145 drvc->instances = NULL;
148 for (l = options; l; l = l->next) {
149 struct sr_config *src = l->data;
150 if (src->key == SR_CONF_CONN) {
151 conn = g_variant_get_string(src->data, NULL);
157 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
161 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
162 for (i = 0; devlist[i]; i++) {
164 struct sr_usb_dev_inst *usb = NULL;
165 for (l = conn_devices; l; l = l->next) {
167 if (usb->bus == libusb_get_bus_number(devlist[i]) &&
168 usb->address == libusb_get_device_address(devlist[i]))
172 /* This device matched none of the ones that
173 * matched the conn specification. */
177 libusb_get_device_descriptor(devlist[i], &des);
179 if (des.idVendor != H4032L_USB_VENDOR ||
180 des.idProduct != H4032L_USB_PRODUCT)
183 if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
186 sdi = g_malloc0(sizeof(struct sr_dev_inst));
187 sdi->driver = &hantek_4032l_driver_info;
188 sdi->vendor = g_strdup("Hantek");
189 sdi->model = g_strdup("4032L");
190 sdi->connection_id = g_strdup(connection_id);
192 struct sr_channel_group *channel_groups[2];
193 for (int j = 0; j < 2; j++) {
194 cg = g_malloc0(sizeof(struct sr_channel_group));
195 cg->name = g_strdup_printf("%c", 'A' + j);
196 channel_groups[j] = cg;
197 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
200 /* Assemble channel list and add channel to channel groups. */
201 for (int j = 0; j < NUM_CHANNELS; j++) {
202 char channel_name[4];
203 sprintf(channel_name, "%c%d", 'A' + (j & 1), j / 2);
204 ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE, channel_name);
205 cg = channel_groups[j & 1];
206 cg->channels = g_slist_append(cg->channels, ch);
209 struct dev_context *devc = g_malloc0(sizeof(struct dev_context));
211 /* Initialize command packet. */
212 devc->cmd_pkt.magic = H4032L_CMD_PKT_MAGIC;
213 devc->cmd_pkt.pwm_a = h4032l_voltage2pwm(2.5);
214 devc->cmd_pkt.pwm_b = h4032l_voltage2pwm(2.5);
215 devc->cmd_pkt.sample_size = 16384;
216 devc->cmd_pkt.pre_trigger_size = 1024;
218 devc->status = H4032L_STATUS_IDLE;
220 devc->capture_ratio = 5;
222 devc->usb_transfer = libusb_alloc_transfer(0);
225 devices = g_slist_append(devices, sdi);
227 sdi->status = SR_ST_INACTIVE;
228 sdi->inst_type = SR_INST_USB;
229 sdi->conn = sr_usb_dev_inst_new(
230 libusb_get_bus_number(devlist[i]),
231 libusb_get_device_address(devlist[i]), NULL);
234 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
235 libusb_free_device_list(devlist, 1);
237 return std_scan_complete(di, devices);
240 static int dev_open(struct sr_dev_inst *sdi)
242 struct sr_usb_dev_inst *usb = sdi->conn;
245 ret = h4032l_dev_open(sdi);
247 sr_err("Unable to open device.");
251 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
254 case LIBUSB_ERROR_BUSY:
255 sr_err("Unable to claim USB interface. Another "
256 "program or driver has already claimed it.");
258 case LIBUSB_ERROR_NO_DEVICE:
259 sr_err("Device has been disconnected.");
262 sr_err("Unable to claim interface: %s.",
263 libusb_error_name(ret));
270 /* Get FPGA version. */
271 if ((ret = h4032l_get_fpga_version(sdi)) != SR_OK)
277 static int dev_close(struct sr_dev_inst *sdi)
279 struct sr_usb_dev_inst *usb;
286 sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
287 usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
288 libusb_release_interface(usb->devhdl, USB_INTERFACE);
289 libusb_close(usb->devhdl);
295 static int config_get(uint32_t key, GVariant **data,
296 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
298 struct dev_context *devc = sdi->priv;
299 struct sr_usb_dev_inst *usb;
304 case SR_CONF_SAMPLERATE:
305 *data = g_variant_new_uint64(samplerates_hw[devc->cmd_pkt.sample_rate]);
307 case SR_CONF_CAPTURE_RATIO:
308 *data = g_variant_new_uint64(devc->capture_ratio);
310 case SR_CONF_LIMIT_SAMPLES:
311 *data = g_variant_new_uint64(devc->cmd_pkt.sample_size);
314 if (!sdi || !(usb = sdi->conn))
316 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
325 static int config_set(uint32_t key, GVariant *data,
326 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
328 struct dev_context *devc = sdi->priv;
329 struct h4032l_cmd_pkt *cmd_pkt = &devc->cmd_pkt;
334 case SR_CONF_SAMPLERATE: {
335 uint64_t sample_rate = g_variant_get_uint64(data);
337 while (i < ARRAY_SIZE(samplerates_hw) && samplerates_hw[i] != sample_rate)
340 if (i == ARRAY_SIZE(samplerates_hw) || sample_rate == 0) {
341 sr_err("Invalid sample rate.");
342 return SR_ERR_SAMPLERATE;
344 cmd_pkt->sample_rate = i;
347 case SR_CONF_CAPTURE_RATIO:
348 devc->capture_ratio = g_variant_get_uint64(data);
350 case SR_CONF_LIMIT_SAMPLES: {
351 uint64_t number_samples = g_variant_get_uint64(data);
352 number_samples += 511;
353 number_samples &= 0xfffffe00;
354 if (number_samples < 2048 ||
355 number_samples > 64 * 1024 * 1024) {
356 sr_err("Invalid sample range 2k...64M: %"
357 PRIu64 ".", number_samples);
360 cmd_pkt->sample_size = number_samples;
363 case SR_CONF_VOLTAGE_THRESHOLD: {
365 g_variant_get(data, "(dd)", &d1, &d2);
366 devc->cmd_pkt.pwm_a = h4032l_voltage2pwm(d1);
367 devc->cmd_pkt.pwm_b = h4032l_voltage2pwm(d2);
377 static int config_list(uint32_t key, GVariant **data,
378 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
381 case SR_CONF_SCAN_OPTIONS:
382 case SR_CONF_DEVICE_OPTIONS:
383 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
384 case SR_CONF_SAMPLERATE:
385 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
387 case SR_CONF_TRIGGER_MATCH:
388 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
390 case SR_CONF_VOLTAGE_THRESHOLD:
391 *data = std_gvar_tuple_double(2.5, 2.5);
400 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
402 struct sr_dev_driver *di = sdi->driver;
403 struct drv_context *drvc = di->context;
404 struct dev_context *devc = sdi->priv;
405 struct sr_trigger *trigger = sr_session_trigger_get(sdi->session);
406 struct h4032l_cmd_pkt *cmd_pkt = &devc->cmd_pkt;
408 /* Initialize variables. */
409 devc->acq_aborted = FALSE;
411 /* Calculate packet ratio. */
412 cmd_pkt->pre_trigger_size = (cmd_pkt->sample_size * devc->capture_ratio) / 100;
414 cmd_pkt->trig_flags.enable_trigger1 = 0;
415 cmd_pkt->trig_flags.enable_trigger2 = 0;
416 cmd_pkt->trig_flags.trigger_and_logic = 0;
418 if (trigger && trigger->stages) {
419 GSList *stages = trigger->stages;
420 struct sr_trigger_stage *stage1 = stages->data;
422 sr_err("Only one trigger stage supported for now.");
425 cmd_pkt->trig_flags.enable_trigger1 = 1;
426 cmd_pkt->trigger[0].flags.edge_type = H4032L_TRIGGER_EDGE_TYPE_DISABLED;
427 cmd_pkt->trigger[0].flags.data_range_enabled = 0;
428 cmd_pkt->trigger[0].flags.time_range_enabled = 0;
429 cmd_pkt->trigger[0].flags.combined_enabled = 0;
430 cmd_pkt->trigger[0].flags.data_range_type = H4032L_TRIGGER_DATA_RANGE_TYPE_MAX;
431 cmd_pkt->trigger[0].data_range_mask = 0;
432 cmd_pkt->trigger[0].data_range_max = 0;
434 /* Initialize range mask values. */
435 uint32_t range_mask = 0;
436 uint32_t range_value = 0;
438 GSList *channel = stage1->matches;
440 struct sr_trigger_match *match = channel->data;
442 switch (match->match) {
443 case SR_TRIGGER_ZERO:
444 range_mask |= (1 << match->channel->index);
447 range_mask |= (1 << match->channel->index);
448 range_value |= (1 << match->channel->index);
450 case SR_TRIGGER_RISING:
451 if (cmd_pkt->trigger[0].flags.edge_type != H4032L_TRIGGER_EDGE_TYPE_DISABLED) {
452 sr_err("Only one trigger signal with fall/rising/edge allowed.");
455 cmd_pkt->trigger[0].flags.edge_type = H4032L_TRIGGER_EDGE_TYPE_RISE;
456 cmd_pkt->trigger[0].flags.edge_signal = match->channel->index;
458 case SR_TRIGGER_FALLING:
459 if (cmd_pkt->trigger[0].flags.edge_type != H4032L_TRIGGER_EDGE_TYPE_DISABLED) {
460 sr_err("Only one trigger signal with fall/rising/edge allowed.");
463 cmd_pkt->trigger[0].flags.edge_type = H4032L_TRIGGER_EDGE_TYPE_FALL;
464 cmd_pkt->trigger[0].flags.edge_signal = match->channel->index;
466 case SR_TRIGGER_EDGE:
467 if (cmd_pkt->trigger[0].flags.edge_type != H4032L_TRIGGER_EDGE_TYPE_DISABLED) {
468 sr_err("Only one trigger signal with fall/rising/edge allowed.");
471 cmd_pkt->trigger[0].flags.edge_type = H4032L_TRIGGER_EDGE_TYPE_TOGGLE;
472 cmd_pkt->trigger[0].flags.edge_signal = match->channel->index;
475 sr_err("Unknown trigger value.");
479 channel = channel->next;
482 /* Compress range mask value and apply range settings. */
484 cmd_pkt->trigger[0].flags.data_range_enabled = 1;
485 cmd_pkt->trigger[0].data_range_mask |= (range_mask);
487 uint32_t new_range_value = 0;
488 uint32_t bit_mask = 1;
490 if ((range_mask & 1) != 0) {
491 new_range_value <<= 1;
492 if ((range_value & 1) != 0)
493 new_range_value |= bit_mask;
499 cmd_pkt->trigger[0].data_range_max |= range_value;
503 usb_source_add(sdi->session, drvc->sr_ctx, 1000,
504 h4032l_receive_data, sdi->driver->context);
506 /* Start capturing. */
507 return h4032l_start(sdi);
510 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
512 struct dev_context *devc = sdi->priv;
514 devc->acq_aborted = TRUE;
515 if (devc->usb_transfer)
516 libusb_cancel_transfer(devc->usb_transfer);
518 devc->status = H4032L_STATUS_IDLE;
523 SR_PRIV struct sr_dev_driver hantek_4032l_driver_info = {
524 .name = "hantek-4032l",
525 .longname = "Hantek 4032L",
528 .cleanup = std_cleanup,
530 .dev_list = std_dev_list,
531 .dev_clear = std_dev_clear,
532 .config_get = config_get,
533 .config_set = config_set,
534 .config_list = config_list,
535 .dev_open = dev_open,
536 .dev_close = dev_close,
537 .dev_acquisition_start = dev_acquisition_start,
538 .dev_acquisition_stop = dev_acquisition_stop,
541 SR_REGISTER_DEV_DRIVER(hantek_4032l_driver_info);