2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Daniel Glöckner <daniel-gl@gmx.net>
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/>.
25 static const uint32_t scanopts[] = {
29 static const uint32_t drvopts[] = {
33 static const uint32_t devopts[] = {
34 SR_CONF_CONN | SR_CONF_GET,
35 SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
37 SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
38 SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_CONF_BUFFERSIZE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
42 static const uint32_t cgopts[] = {
43 SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
44 SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
45 SR_CONF_PROBE_FACTOR | SR_CONF_GET | SR_CONF_SET,
48 static const uint64_t samplerates[] = {
49 SR_MHZ(100), SR_MHZ(50), SR_MHZ(25), SR_MHZ(20),
50 SR_MHZ(10), SR_MHZ(5), SR_KHZ(2500), SR_MHZ(2),
51 SR_MHZ(1), SR_KHZ(500), SR_KHZ(250), SR_KHZ(200),
52 SR_KHZ(100), SR_KHZ(50), SR_KHZ(25), SR_KHZ(20),
53 SR_KHZ(10), SR_KHZ(5), SR_HZ(2500), SR_KHZ(2),
54 SR_KHZ(1), SR_HZ(500), SR_HZ(250), SR_HZ(200),
55 SR_HZ(100), SR_HZ(50), SR_HZ(25), SR_HZ(20)
58 /* must be in sync with readout_steps[] in protocol.c */
59 static const uint64_t buffersizes[] = {
60 2 * 500, 3 * 500, 4 * 500, 5 * 500,
61 6 * 500, 7 * 500, 8 * 500, 9 * 500, 10 * 500,
62 12 * 500 - 2, 14 * 500 - 2, 16 * 500 - 2,
63 18 * 500 - 2, 20 * 500 - 2, 10240 - 2
66 static const uint64_t vdivs[][2] = {
78 /* Bits 4 and 5 enable relays that add /10 filters to the chain
79 * Bits 0 and 1 select an output from a resistor array */
80 static const uint8_t vdivs_map[] = {
81 0x01, 0x02, 0x03, 0x21, 0x22, 0x23, 0x31, 0x32, 0x33
85 static const char *trigger_sources[] = {
89 static const uint8_t trigger_sources_map[] = {
93 static const char *trigger_slopes[] = {
97 static const char *coupling[] = {
101 static const uint8_t coupling_map[] = {
105 static GSList *scan_port(GSList *devices, struct parport *port)
107 struct sr_dev_inst *sdi;
108 struct sr_channel *ch;
109 struct sr_channel_group *cg;
110 struct dev_context *devc;
113 if (ieee1284_open(port, 0, &i) != E1284_OK) {
114 sr_err("Can't open parallel port %s", port->name);
118 if ((i & (CAP1284_RAW | CAP1284_BYTE)) != (CAP1284_RAW | CAP1284_BYTE)) {
119 sr_err("Parallel port %s does not provide low-level bidirection access",
124 if (ieee1284_claim(port) != E1284_OK) {
125 sr_err("Parallel port %s already in use", port->name);
129 if (!hung_chang_dso_2100_check_id(port))
132 sdi = g_malloc0(sizeof(struct sr_dev_inst));
133 sdi->status = SR_ST_INACTIVE;
134 sdi->vendor = g_strdup("Hung-Chang");
135 sdi->model = g_strdup("DSO-2100");
136 sdi->inst_type = 0; /* FIXME */
140 for (i = 0; i < NUM_CHANNELS; i++) {
141 cg = g_malloc0(sizeof(struct sr_channel_group));
142 cg->name = g_strdup(trigger_sources[i]);
143 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, FALSE, trigger_sources[i]);
144 cg->channels = g_slist_append(cg->channels, ch);
145 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
148 devc = g_malloc0(sizeof(struct dev_context));
149 devc->enabled_channel = g_slist_append(NULL, NULL);
154 devc->cctl[0] = 0x31; /* 1V/div, DC coupling, trigger on channel A*/
155 devc->cctl[1] = 0x31; /* 1V/div, DC coupling, no tv sync trigger */
160 devc->offset[0] = 0x80;
161 devc->offset[1] = 0x80;
162 devc->gain[0] = 0x80;
163 devc->gain[1] = 0x80;
164 devc->frame_limit = 0;
165 devc->last_step = 0; /* buffersize = 1000 */
168 devices = g_slist_append(devices, sdi);
171 ieee1284_release(port);
173 ieee1284_close(port);
178 static GSList *scan(struct sr_dev_driver *di, GSList *options)
180 struct parport_list ports;
181 struct sr_config *src;
182 const char *conn = NULL;
183 GSList *devices, *option;
188 for (option = options; option; option = option->next) {
190 if (src->key == SR_CONF_CONN) {
191 conn = g_variant_get_string(src->data, NULL);
199 if (ieee1284_find_ports(&ports, 0) != E1284_OK)
204 for (i = 0; i < ports.portc; i++)
205 if (!strcmp(ports.portv[i]->name, conn)) {
207 devices = scan_port(devices, ports.portv[i]);
211 sr_err("Parallel port %s not found. Valid names are:", conn);
212 for (i = 0; i < ports.portc; i++)
213 sr_err("\t%s", ports.portv[i]->name);
216 ieee1284_free_ports(&ports);
218 return std_scan_complete(di, devices);
221 static void clear_private(void *priv)
223 struct dev_context *devc = priv;
225 g_slist_free(devc->enabled_channel);
228 static int dev_clear(const struct sr_dev_driver *di)
230 struct drv_context *drvc = di->context;
231 struct sr_dev_inst *sdi;
235 for (l = drvc->instances; l; l = l->next) {
237 ieee1284_unref(sdi->conn);
241 return std_dev_clear(di, clear_private);
244 static int dev_open(struct sr_dev_inst *sdi)
246 struct dev_context *devc = sdi->priv;
249 if (sdi->status != SR_ST_INACTIVE)
252 if (ieee1284_open(sdi->conn, 0, &i) != E1284_OK)
255 if (ieee1284_claim(sdi->conn) != E1284_OK)
258 if (ieee1284_data_dir(sdi->conn, 1) != E1284_OK)
261 if (hung_chang_dso_2100_move_to(sdi, 1))
264 devc->samples = g_try_malloc(1000 * sizeof(*devc->samples));
268 sdi->status = SR_ST_ACTIVE;
273 hung_chang_dso_2100_reset_port(sdi->conn);
274 ieee1284_release(sdi->conn);
276 ieee1284_close(sdi->conn);
281 static int dev_close(struct sr_dev_inst *sdi)
283 struct dev_context *devc = sdi->priv;
285 if (sdi->status != SR_ST_ACTIVE)
288 g_free(devc->samples);
289 hung_chang_dso_2100_reset_port(sdi->conn);
290 ieee1284_release(sdi->conn);
291 ieee1284_close(sdi->conn);
292 sdi->status = SR_ST_INACTIVE;
297 static int find_in_array(GVariant *data, const GVariantType *type,
298 const void *arr, int n)
300 const char * const *sarr;
302 const uint64_t *u64arr;
303 const uint8_t *u8arr;
308 if (!g_variant_is_of_type(data, type))
311 switch (g_variant_classify(data)) {
312 case G_VARIANT_CLASS_STRING:
313 s = g_variant_get_string(data, NULL);
316 for (i = 0; i < n; i++)
317 if (!strcmp(s, sarr[i]))
320 case G_VARIANT_CLASS_UINT64:
321 u64 = g_variant_get_uint64(data);
324 for (i = 0; i < n; i++)
325 if (u64 == u64arr[i])
328 case G_VARIANT_CLASS_BYTE:
329 u8 = g_variant_get_byte(data);
332 for (i = 0; i < n; i++)
342 static int reverse_map(uint8_t u, const uint8_t *arr, int n)
344 GVariant *v = g_variant_new_byte(u);
345 int i = find_in_array(v, G_VARIANT_TYPE_BYTE, arr, n);
350 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
351 const struct sr_channel_group *cg)
353 struct dev_context *devc = sdi->priv;
354 struct parport *port;
357 if (cg) /* sr_config_get will validate cg using config_list */
358 ch = ((struct sr_channel *)cg->channels->data)->index;
364 *data = g_variant_new_string(port->name);
366 case SR_CONF_LIMIT_FRAMES:
367 *data = g_variant_new_uint64(devc->frame_limit);
369 case SR_CONF_SAMPLERATE:
370 *data = g_variant_new_uint64(samplerates[devc->rate]);
372 case SR_CONF_TRIGGER_SOURCE:
373 i = reverse_map(devc->cctl[0] & 0xC0, trigger_sources_map,
374 ARRAY_SIZE(trigger_sources_map));
378 *data = g_variant_new_string(trigger_sources[i]);
380 case SR_CONF_TRIGGER_SLOPE:
381 if (devc->edge >= ARRAY_SIZE(trigger_slopes))
384 *data = g_variant_new_string(trigger_slopes[devc->edge]);
386 case SR_CONF_BUFFERSIZE:
387 *data = g_variant_new_uint64(buffersizes[devc->last_step]);
391 ret = SR_ERR_CHANNEL_GROUP;
393 i = reverse_map(devc->cctl[ch] & 0x33, vdivs_map,
394 ARRAY_SIZE(vdivs_map));
398 *data = g_variant_new("(tt)", vdivs[i][0],
402 case SR_CONF_COUPLING:
404 ret = SR_ERR_CHANNEL_GROUP;
406 i = reverse_map(devc->cctl[ch] & 0x0C, coupling_map,
407 ARRAY_SIZE(coupling_map));
411 *data = g_variant_new_string(coupling[i]);
414 case SR_CONF_PROBE_FACTOR:
416 ret = SR_ERR_CHANNEL_GROUP;
418 *data = g_variant_new_uint64(devc->probe[ch]);
427 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
428 const struct sr_channel_group *cg)
430 struct dev_context *devc = sdi->priv;
434 if (cg) /* sr_config_set will validate cg using config_list */
435 ch = ((struct sr_channel *)cg->channels->data)->index;
437 if (sdi->status != SR_ST_ACTIVE)
438 return SR_ERR_DEV_CLOSED;
442 case SR_CONF_LIMIT_FRAMES:
443 devc->frame_limit = g_variant_get_uint64(data);
445 case SR_CONF_SAMPLERATE:
446 i = find_in_array(data, G_VARIANT_TYPE_UINT64,
447 samplerates, ARRAY_SIZE(samplerates));
453 case SR_CONF_TRIGGER_SOURCE:
454 i = find_in_array(data, G_VARIANT_TYPE_STRING,
455 trigger_sources, ARRAY_SIZE(trigger_sources));
459 devc->cctl[0] = (devc->cctl[0] & 0x3F)
460 | trigger_sources_map[i];
462 case SR_CONF_TRIGGER_SLOPE:
463 i = find_in_array(data, G_VARIANT_TYPE_STRING,
464 trigger_slopes, ARRAY_SIZE(trigger_slopes));
470 case SR_CONF_BUFFERSIZE:
471 i = find_in_array(data, G_VARIANT_TYPE_UINT64,
472 buffersizes, ARRAY_SIZE(buffersizes));
480 ret = SR_ERR_CHANNEL_GROUP;
481 } else if (!g_variant_is_of_type(data, G_VARIANT_TYPE("(tt)"))) {
484 g_variant_get(data, "(tt)", &u, &v);
485 for (i = 0; i < (int)ARRAY_SIZE(vdivs); i++)
486 if (vdivs[i][0] == u && vdivs[i][1] == v)
488 if (i == ARRAY_SIZE(vdivs))
491 devc->cctl[ch] = (devc->cctl[ch] & 0xCC)
495 case SR_CONF_COUPLING:
497 ret = SR_ERR_CHANNEL_GROUP;
499 i = find_in_array(data, G_VARIANT_TYPE_STRING,
500 coupling, ARRAY_SIZE(coupling));
504 devc->cctl[ch] = (devc->cctl[ch] & 0xF3)
508 case SR_CONF_PROBE_FACTOR:
510 ret = SR_ERR_CHANNEL_GROUP;
512 u = g_variant_get_uint64(data);
526 static int config_channel_set(const struct sr_dev_inst *sdi,
527 struct sr_channel *ch,
528 unsigned int changes)
530 struct dev_context *devc = sdi->priv;
533 if (changes & SR_CHANNEL_SET_ENABLED) {
535 v = devc->channel | (1 << ch->index);
539 devc->enabled_channel->data = ch;
541 devc->channel &= ~(1 << ch->index);
547 static int config_commit(const struct sr_dev_inst *sdi)
549 uint8_t state = hung_chang_dso_2100_read_mbox(sdi->conn, 0.02);
552 if (sdi->status != SR_ST_ACTIVE)
553 return SR_ERR_DEV_CLOSED;
559 /* we will travel the complete config path on our way to state 1 */
564 ret = hung_chang_dso_2100_move_to(sdi, 1);
568 hung_chang_dso_2100_write_mbox(sdi->conn, 4);
570 ret = hung_chang_dso_2100_move_to(sdi, 1);
573 return hung_chang_dso_2100_move_to(sdi, state);
576 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
577 const struct sr_channel_group *cg)
580 GVariant *gvar, *rational[2];
585 case SR_CONF_SCAN_OPTIONS:
586 case SR_CONF_DEVICE_OPTIONS:
588 case SR_CONF_SAMPLERATE:
589 case SR_CONF_TRIGGER_SOURCE:
590 case SR_CONF_TRIGGER_SLOPE:
591 case SR_CONF_BUFFERSIZE:
596 case SR_CONF_COUPLING:
600 return SR_ERR_CHANNEL_GROUP;
601 l = g_slist_find(sdi->channel_groups, cg);
610 case SR_CONF_SCAN_OPTIONS:
611 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
612 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
614 case SR_CONF_DEVICE_OPTIONS:
616 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
617 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
619 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
620 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
622 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
623 cgopts, ARRAY_SIZE(cgopts), sizeof(uint32_t));
625 case SR_CONF_SAMPLERATE:
626 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
627 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
628 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
629 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
630 *data = g_variant_builder_end(&gvb);
632 case SR_CONF_TRIGGER_SOURCE:
633 *data = g_variant_new_strv(trigger_sources, ARRAY_SIZE(trigger_sources));
635 case SR_CONF_TRIGGER_SLOPE:
636 *data = g_variant_new_strv(trigger_slopes, ARRAY_SIZE(trigger_slopes));
638 case SR_CONF_BUFFERSIZE:
639 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
640 buffersizes, ARRAY_SIZE(buffersizes), sizeof(uint64_t));
643 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
644 for (i = 0; i < (int)ARRAY_SIZE(vdivs); i++) {
645 rational[0] = g_variant_new_uint64(vdivs[i][0]);
646 rational[1] = g_variant_new_uint64(vdivs[i][1]);
647 gvar = g_variant_new_tuple(rational, 2);
648 g_variant_builder_add_value(&gvb, gvar);
650 *data = g_variant_builder_end(&gvb);
652 case SR_CONF_COUPLING:
653 *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
660 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
662 struct dev_context *devc = sdi->priv;
665 if (sdi->status != SR_ST_ACTIVE)
666 return SR_ERR_DEV_CLOSED;
669 static const float res_array[] = {0.5, 1, 2, 5};
670 static const uint8_t relays[] = {100, 10, 10, 1};
671 devc->factor = devc->probe[devc->channel - 1] / 32.0;
672 devc->factor *= res_array[devc->cctl[devc->channel - 1] & 0x03];
673 devc->factor /= relays[(devc->cctl[devc->channel - 1] >> 4) & 0x03];
676 devc->state_known = TRUE;
679 devc->retries = MAX_RETRIES;
681 ret = hung_chang_dso_2100_move_to(sdi, 0x21);
685 std_session_send_df_header(sdi, LOG_PREFIX);
687 sr_session_source_add(sdi->session, -1, 0, 8,
688 hung_chang_dso_2100_poll, (void *)sdi);
693 SR_PRIV int hung_chang_dso_2100_dev_acquisition_stop(const struct sr_dev_inst *sdi)
695 if (sdi->status != SR_ST_ACTIVE)
696 return SR_ERR_DEV_CLOSED;
698 std_session_send_df_end(sdi, LOG_PREFIX);
699 sr_session_source_remove(sdi->session, -1);
700 hung_chang_dso_2100_move_to(sdi, 1);
705 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
707 return hung_chang_dso_2100_dev_acquisition_stop(sdi);
710 static struct sr_dev_driver hung_chang_dso_2100_driver_info = {
711 .name = "hung-chang-dso-2100",
712 .longname = "Hung-Chang DSO-2100",
715 .cleanup = std_cleanup,
717 .dev_list = std_dev_list,
718 .dev_clear = dev_clear,
719 .config_get = config_get,
720 .config_set = config_set,
721 .config_channel_set = config_channel_set,
722 .config_commit = config_commit,
723 .config_list = config_list,
724 .dev_open = dev_open,
725 .dev_close = dev_close,
726 .dev_acquisition_start = dev_acquisition_start,
727 .dev_acquisition_stop = dev_acquisition_stop,
730 SR_REGISTER_DEV_DRIVER(hung_chang_dso_2100_driver_info);