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_helper(struct dev_context *devc)
223 g_slist_free(devc->enabled_channel);
226 static int dev_clear(const struct sr_dev_driver *di)
228 struct drv_context *drvc = di->context;
229 struct sr_dev_inst *sdi;
233 for (l = drvc->instances; l; l = l->next) {
235 ieee1284_unref(sdi->conn);
239 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
242 static int dev_open(struct sr_dev_inst *sdi)
244 struct dev_context *devc = sdi->priv;
247 if (ieee1284_open(sdi->conn, 0, &i) != E1284_OK)
250 if (ieee1284_claim(sdi->conn) != E1284_OK)
253 if (ieee1284_data_dir(sdi->conn, 1) != E1284_OK)
256 if (hung_chang_dso_2100_move_to(sdi, 1))
259 devc->samples = g_try_malloc(1000 * sizeof(*devc->samples));
266 hung_chang_dso_2100_reset_port(sdi->conn);
267 ieee1284_release(sdi->conn);
269 ieee1284_close(sdi->conn);
274 static int dev_close(struct sr_dev_inst *sdi)
276 struct dev_context *devc = sdi->priv;
278 g_free(devc->samples);
279 hung_chang_dso_2100_reset_port(sdi->conn);
280 ieee1284_release(sdi->conn);
281 ieee1284_close(sdi->conn);
286 static int find_in_array(GVariant *data, const GVariantType *type,
287 const void *arr, int n)
289 const char * const *sarr;
291 const uint64_t *u64arr;
292 const uint8_t *u8arr;
297 if (!g_variant_is_of_type(data, type))
300 switch (g_variant_classify(data)) {
301 case G_VARIANT_CLASS_STRING:
302 s = g_variant_get_string(data, NULL);
305 for (i = 0; i < n; i++)
306 if (!strcmp(s, sarr[i]))
309 case G_VARIANT_CLASS_UINT64:
310 u64 = g_variant_get_uint64(data);
313 for (i = 0; i < n; i++)
314 if (u64 == u64arr[i])
317 case G_VARIANT_CLASS_BYTE:
318 u8 = g_variant_get_byte(data);
321 for (i = 0; i < n; i++)
331 static int reverse_map(uint8_t u, const uint8_t *arr, int n)
333 GVariant *v = g_variant_new_byte(u);
334 int i = find_in_array(v, G_VARIANT_TYPE_BYTE, arr, n);
339 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
340 const struct sr_channel_group *cg)
342 struct dev_context *devc = sdi->priv;
343 struct parport *port;
346 if (cg) /* sr_config_get will validate cg using config_list */
347 ch = ((struct sr_channel *)cg->channels->data)->index;
353 *data = g_variant_new_string(port->name);
355 case SR_CONF_LIMIT_FRAMES:
356 *data = g_variant_new_uint64(devc->frame_limit);
358 case SR_CONF_SAMPLERATE:
359 *data = g_variant_new_uint64(samplerates[devc->rate]);
361 case SR_CONF_TRIGGER_SOURCE:
362 i = reverse_map(devc->cctl[0] & 0xC0, trigger_sources_map,
363 ARRAY_SIZE(trigger_sources_map));
367 *data = g_variant_new_string(trigger_sources[i]);
369 case SR_CONF_TRIGGER_SLOPE:
370 if (devc->edge >= ARRAY_SIZE(trigger_slopes))
373 *data = g_variant_new_string(trigger_slopes[devc->edge]);
375 case SR_CONF_BUFFERSIZE:
376 *data = g_variant_new_uint64(buffersizes[devc->last_step]);
380 ret = SR_ERR_CHANNEL_GROUP;
382 i = reverse_map(devc->cctl[ch] & 0x33, vdivs_map,
383 ARRAY_SIZE(vdivs_map));
387 *data = g_variant_new("(tt)", vdivs[i][0],
391 case SR_CONF_COUPLING:
393 ret = SR_ERR_CHANNEL_GROUP;
395 i = reverse_map(devc->cctl[ch] & 0x0C, coupling_map,
396 ARRAY_SIZE(coupling_map));
400 *data = g_variant_new_string(coupling[i]);
403 case SR_CONF_PROBE_FACTOR:
405 ret = SR_ERR_CHANNEL_GROUP;
407 *data = g_variant_new_uint64(devc->probe[ch]);
416 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
417 const struct sr_channel_group *cg)
419 struct dev_context *devc = sdi->priv;
423 if (cg) /* sr_config_set will validate cg using config_list */
424 ch = ((struct sr_channel *)cg->channels->data)->index;
428 case SR_CONF_LIMIT_FRAMES:
429 devc->frame_limit = g_variant_get_uint64(data);
431 case SR_CONF_SAMPLERATE:
432 i = find_in_array(data, G_VARIANT_TYPE_UINT64,
433 samplerates, ARRAY_SIZE(samplerates));
439 case SR_CONF_TRIGGER_SOURCE:
440 i = find_in_array(data, G_VARIANT_TYPE_STRING,
441 trigger_sources, ARRAY_SIZE(trigger_sources));
445 devc->cctl[0] = (devc->cctl[0] & 0x3F)
446 | trigger_sources_map[i];
448 case SR_CONF_TRIGGER_SLOPE:
449 i = find_in_array(data, G_VARIANT_TYPE_STRING,
450 trigger_slopes, ARRAY_SIZE(trigger_slopes));
456 case SR_CONF_BUFFERSIZE:
457 i = find_in_array(data, G_VARIANT_TYPE_UINT64,
458 buffersizes, ARRAY_SIZE(buffersizes));
466 ret = SR_ERR_CHANNEL_GROUP;
467 } else if (!g_variant_is_of_type(data, G_VARIANT_TYPE("(tt)"))) {
470 g_variant_get(data, "(tt)", &u, &v);
471 for (i = 0; i < (int)ARRAY_SIZE(vdivs); i++)
472 if (vdivs[i][0] == u && vdivs[i][1] == v)
474 if (i == ARRAY_SIZE(vdivs))
477 devc->cctl[ch] = (devc->cctl[ch] & 0xCC)
481 case SR_CONF_COUPLING:
483 ret = SR_ERR_CHANNEL_GROUP;
485 i = find_in_array(data, G_VARIANT_TYPE_STRING,
486 coupling, ARRAY_SIZE(coupling));
490 devc->cctl[ch] = (devc->cctl[ch] & 0xF3)
494 case SR_CONF_PROBE_FACTOR:
496 ret = SR_ERR_CHANNEL_GROUP;
498 u = g_variant_get_uint64(data);
512 static int config_channel_set(const struct sr_dev_inst *sdi,
513 struct sr_channel *ch,
514 unsigned int changes)
516 struct dev_context *devc = sdi->priv;
519 if (changes & SR_CHANNEL_SET_ENABLED) {
521 v = devc->channel | (1 << ch->index);
525 devc->enabled_channel->data = ch;
527 devc->channel &= ~(1 << ch->index);
533 static int config_commit(const struct sr_dev_inst *sdi)
535 uint8_t state = hung_chang_dso_2100_read_mbox(sdi->conn, 0.02);
542 /* we will travel the complete config path on our way to state 1 */
548 ret = hung_chang_dso_2100_move_to(sdi, 1);
553 hung_chang_dso_2100_write_mbox(sdi->conn, 4);
555 ret = hung_chang_dso_2100_move_to(sdi, 1);
558 return hung_chang_dso_2100_move_to(sdi, state);
561 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
562 const struct sr_channel_group *cg)
565 GVariant *gvar, *rational[2];
570 case SR_CONF_SCAN_OPTIONS:
571 case SR_CONF_DEVICE_OPTIONS:
573 case SR_CONF_SAMPLERATE:
574 case SR_CONF_TRIGGER_SOURCE:
575 case SR_CONF_TRIGGER_SLOPE:
576 case SR_CONF_BUFFERSIZE:
581 case SR_CONF_COUPLING:
585 return SR_ERR_CHANNEL_GROUP;
586 l = g_slist_find(sdi->channel_groups, cg);
595 case SR_CONF_SCAN_OPTIONS:
596 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
597 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
599 case SR_CONF_DEVICE_OPTIONS:
601 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
602 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
604 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
605 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
607 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
608 cgopts, ARRAY_SIZE(cgopts), sizeof(uint32_t));
610 case SR_CONF_SAMPLERATE:
611 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
612 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
613 samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t));
614 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
615 *data = g_variant_builder_end(&gvb);
617 case SR_CONF_TRIGGER_SOURCE:
618 *data = g_variant_new_strv(trigger_sources, ARRAY_SIZE(trigger_sources));
620 case SR_CONF_TRIGGER_SLOPE:
621 *data = g_variant_new_strv(trigger_slopes, ARRAY_SIZE(trigger_slopes));
623 case SR_CONF_BUFFERSIZE:
624 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64,
625 buffersizes, ARRAY_SIZE(buffersizes), sizeof(uint64_t));
628 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
629 for (i = 0; i < (int)ARRAY_SIZE(vdivs); i++) {
630 rational[0] = g_variant_new_uint64(vdivs[i][0]);
631 rational[1] = g_variant_new_uint64(vdivs[i][1]);
632 gvar = g_variant_new_tuple(rational, 2);
633 g_variant_builder_add_value(&gvb, gvar);
635 *data = g_variant_builder_end(&gvb);
637 case SR_CONF_COUPLING:
638 *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
645 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
647 struct dev_context *devc = sdi->priv;
651 static const float res_array[] = {0.5, 1, 2, 5};
652 static const uint8_t relays[] = {100, 10, 10, 1};
653 devc->factor = devc->probe[devc->channel - 1] / 32.0;
654 devc->factor *= res_array[devc->cctl[devc->channel - 1] & 0x03];
655 devc->factor /= relays[(devc->cctl[devc->channel - 1] >> 4) & 0x03];
658 devc->state_known = TRUE;
661 devc->retries = MAX_RETRIES;
663 ret = hung_chang_dso_2100_move_to(sdi, 0x21);
667 std_session_send_df_header(sdi);
669 sr_session_source_add(sdi->session, -1, 0, 8,
670 hung_chang_dso_2100_poll, (void *)sdi);
675 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
677 std_session_send_df_end(sdi);
678 sr_session_source_remove(sdi->session, -1);
679 hung_chang_dso_2100_move_to(sdi, 1);
684 static struct sr_dev_driver hung_chang_dso_2100_driver_info = {
685 .name = "hung-chang-dso-2100",
686 .longname = "Hung-Chang DSO-2100",
689 .cleanup = std_cleanup,
691 .dev_list = std_dev_list,
692 .dev_clear = dev_clear,
693 .config_get = config_get,
694 .config_set = config_set,
695 .config_channel_set = config_channel_set,
696 .config_commit = config_commit,
697 .config_list = config_list,
698 .dev_open = dev_open,
699 .dev_close = dev_close,
700 .dev_acquisition_start = dev_acquisition_start,
701 .dev_acquisition_stop = dev_acquisition_stop,
704 SR_REGISTER_DEV_DRIVER(hung_chang_dso_2100_driver_info);