hantek-dso: fix 100MS/s
[libsigrok.git] / src / hardware / hantek-dso / protocol.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
5  * With protocol information from the hantekdso project,
6  * Copyright (C) 2008 Oleg Khudyakov <prcoder@gmail.com>
7  *
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.
12  *
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.
17  *
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/>.
20  */
21
22 #include <config.h>
23 #include <string.h>
24 #include <glib.h>
25 #include <libusb.h>
26 #include <libsigrok/libsigrok.h>
27 #include "libsigrok-internal.h"
28 #include "protocol.h"
29
30 static int send_begin(const struct sr_dev_inst *sdi)
31 {
32         struct sr_usb_dev_inst *usb;
33         int ret;
34         unsigned char buffer[] = {0x0f, 0x03, 0x03, 0x03, 0x68, 0xac, 0xfe,
35         0x00, 0x01, 0x00};
36
37         sr_dbg("Sending CTRL_BEGINCOMMAND.");
38
39         usb = sdi->conn;
40         if ((ret = libusb_control_transfer(usb->devhdl,
41                         LIBUSB_REQUEST_TYPE_VENDOR, CTRL_BEGINCOMMAND,
42                         0, 0, buffer, sizeof(buffer), 200)) != sizeof(buffer)) {
43                 sr_err("Failed to send begincommand: %s.",
44                        libusb_error_name(ret));
45                 return SR_ERR;
46         }
47
48         return SR_OK;
49 }
50
51 static int send_bulkcmd(const struct sr_dev_inst *sdi, uint8_t *cmdstring, int cmdlen)
52 {
53         struct sr_usb_dev_inst *usb;
54         int ret, tmp;
55
56         usb = sdi->conn;
57
58         if (send_begin(sdi) != SR_OK)
59                 return SR_ERR;
60
61         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT, cmdstring,
62                         cmdlen, &tmp, 200)) != 0)
63                 return SR_ERR;
64
65         return SR_OK;
66 }
67
68 static int dso_getmps(libusb_device *dev)
69 {
70         struct libusb_device_descriptor des;
71         struct libusb_config_descriptor *conf_dsc;
72         const struct libusb_interface_descriptor *intf_dsc;
73         int mps;
74
75         libusb_get_device_descriptor(dev, &des);
76
77         if (des.bNumConfigurations != 1)
78                 return 0;
79
80         if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
81                 return 0;
82
83         mps = 0;
84         intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
85         if (intf_dsc->bNumEndpoints != 2)
86                 goto err;
87
88         if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
89             (2 | LIBUSB_ENDPOINT_OUT))
90                 /* The first endpoint should be 2 (outbound). */
91                 goto err;
92
93         if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
94             (6 | LIBUSB_ENDPOINT_IN))
95                 /* The second endpoint should be 6 (inbound). */
96                 goto err;
97
98         mps = intf_dsc->endpoint[1].wMaxPacketSize;
99
100 err:
101         if (conf_dsc)
102                 libusb_free_config_descriptor(conf_dsc);
103
104         return mps;
105 }
106
107 SR_PRIV int dso_open(struct sr_dev_inst *sdi)
108 {
109         struct dev_context *devc;
110         struct drv_context *drvc = sdi->driver->context;
111         struct sr_usb_dev_inst *usb;
112         struct libusb_device_descriptor des;
113         libusb_device **devlist;
114         int err, i;
115         char connection_id[64];
116
117         devc = sdi->priv;
118         usb = sdi->conn;
119
120         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
121         for (i = 0; devlist[i]; i++) {
122                 libusb_get_device_descriptor(devlist[i], &des);
123
124                 if (des.idVendor != devc->profile->fw_vid
125                     || des.idProduct != devc->profile->fw_pid)
126                         continue;
127
128                 if ((sdi->status == SR_ST_INITIALIZING) ||
129                                 (sdi->status == SR_ST_INACTIVE)) {
130                         /*
131                          * Check device by its physical USB bus/port address.
132                          */
133                         if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
134                                 continue;
135
136                         if (strcmp(sdi->connection_id, connection_id))
137                                 /* This is not the one. */
138                                 continue;
139                 }
140
141                 if (!(err = libusb_open(devlist[i], &usb->devhdl))) {
142                         if (usb->address == 0xff)
143                                 /*
144                                  * first time we touch this device after firmware upload,
145                                  * so we don't know the address yet.
146                                  */
147                                 usb->address = libusb_get_device_address(devlist[i]);
148
149                         if (!(devc->epin_maxpacketsize = dso_getmps(devlist[i])))
150                                 sr_err("Wrong endpoint profile.");
151                         else {
152                                 sdi->status = SR_ST_ACTIVE;
153                                 sr_info("Opened device on %d.%d (logical) / "
154                                                 "%s (physical) interface %d.",
155                                         usb->bus, usb->address,
156                                         sdi->connection_id, USB_INTERFACE);
157                         }
158                 } else {
159                         sr_err("Failed to open device: %s.",
160                                libusb_error_name(err));
161                 }
162
163                 /* If we made it here, we handled the device (somehow). */
164                 break;
165         }
166         libusb_free_device_list(devlist, 1);
167
168         if (sdi->status != SR_ST_ACTIVE)
169                 return SR_ERR;
170
171         return SR_OK;
172 }
173
174 SR_PRIV void dso_close(struct sr_dev_inst *sdi)
175 {
176         struct sr_usb_dev_inst *usb;
177
178         usb = sdi->conn;
179
180         if (!usb->devhdl)
181                 return;
182
183         sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
184                         usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
185         libusb_release_interface(usb->devhdl, USB_INTERFACE);
186         libusb_close(usb->devhdl);
187         usb->devhdl = NULL;
188         sdi->status = SR_ST_INACTIVE;
189 }
190
191 static int get_channel_offsets(const struct sr_dev_inst *sdi)
192 {
193         struct dev_context *devc;
194         struct sr_usb_dev_inst *usb;
195         GString *gs;
196         int chan, v, ret;
197
198         sr_dbg("Getting channel offsets.");
199
200         devc = sdi->priv;
201         usb = sdi->conn;
202
203         ret = libusb_control_transfer(usb->devhdl,
204                         LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR,
205                         CTRL_READ_EEPROM, EEPROM_CHANNEL_OFFSETS, 0,
206                         (unsigned char *)&devc->channel_levels,
207                         sizeof(devc->channel_levels), 200);
208         if (ret != sizeof(devc->channel_levels)) {
209                 sr_err("Failed to get channel offsets: %s.",
210                        libusb_error_name(ret));
211                 return SR_ERR;
212         }
213
214         /* Comes in as 16-bit numbers with the second byte always 0 on
215          * the DSO-2090. Guessing this is supposed to be big-endian,
216          * since that's how voltage offsets are submitted back to the DSO.
217          * Convert to host order now, so we can use them natively.
218          */
219         for (chan = 0; chan < NUM_CHANNELS; chan++) {
220                 for (v = 0; v < 9; v++) {
221                         devc->channel_levels[chan][v][0] =
222                                 g_ntohs(devc->channel_levels[chan][v][0]);
223                         devc->channel_levels[chan][v][1] =
224                                 g_ntohs(devc->channel_levels[chan][v][1]);
225                 }
226         }
227
228         if (sr_log_loglevel_get() >= SR_LOG_DBG) {
229                 gs = g_string_sized_new(128);
230                 for (chan = 0; chan < NUM_CHANNELS; chan++) {
231                         g_string_printf(gs, "CH%d:", chan + 1);
232                         for (v = 0; v < 9; v++) {
233                                 g_string_append_printf(gs, " %.4x-%.4x",
234                                         devc->channel_levels[chan][v][0],
235                                         devc->channel_levels[chan][v][1]);
236                         }
237                         sr_dbg("%s", gs->str);
238                 }
239                 g_string_free(gs, TRUE);
240         }
241
242         return SR_OK;
243 }
244
245 static void dso2250_set_triggerpos(int value, int long_buffer, uint8_t dest[], int offset)
246 {
247         uint32_t min, max;
248         uint32_t tmp, diff;
249
250         min = long_buffer ? 0 : 0x7d7ff;
251         max = 0x7ffff;
252
253         diff = max - min;
254         tmp = min + diff * value / 100;
255         sr_dbg("2250 trigger pos: %3d%% * [0x%x,0x%x] == 0x%x", value, min, max, tmp);
256
257         dest[offset + 0] = tmp & 0xff;
258         dest[offset + 1] = (tmp >> 8) & 0xff;
259         dest[offset + 2] = (tmp >> 16) & 0x7;
260 }
261
262 /* See http://openhantek.sourceforge.net/doc/namespaceHantek.html#ac1cd181814cf3da74771c29800b39028 */
263 static int dso2250_set_trigger_samplerate(const struct sr_dev_inst *sdi)
264 {
265         struct dev_context *devc;
266         struct sr_usb_dev_inst *usb;
267         int ret, tmp;
268         uint64_t base;
269         uint8_t cmdstring[12];
270         int trig;
271
272         devc = sdi->priv;
273         usb = sdi->conn;
274
275         memset(cmdstring, 0, sizeof(cmdstring));
276         /* Command */
277         cmdstring[0] = CMD_2250_SET_TRIGGERSOURCE;
278         sr_dbg("Trigger source %s.", devc->triggersource);
279         if (!strcmp("CH2", devc->triggersource))
280                 tmp = 3;
281         else if (!strcmp("CH1", devc->triggersource))
282                 tmp = 2;
283         else if (!strcmp("EXT", devc->triggersource))
284                 tmp = 0;
285         else {
286                 sr_err("Invalid trigger source: '%s'.", devc->triggersource);
287                 return SR_ERR_ARG;
288         }
289         cmdstring[2] = tmp;
290
291         sr_dbg("Trigger slope: %d.", devc->triggerslope);
292         cmdstring[2] |= (devc->triggerslope == SLOPE_NEGATIVE ? 1 : 0) << 3;
293
294         if (send_begin(sdi) != SR_OK)
295                 return SR_ERR;
296
297         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
298                         cmdstring, 8, &tmp, 100)) != 0) {
299                 sr_err("Failed to set trigger/samplerate: %s.",
300                        libusb_error_name(ret));
301                 return SR_ERR;
302         }
303
304         /* Frame size */
305         sr_dbg("Frame size: %d.", devc->framesize);
306         cmdstring[0] = CMD_2250_SET_RECORD_LENGTH;
307         cmdstring[2] = (devc->framesize == FRAMESIZE_SMALL) ? 0x01 : 0x02;
308
309         if (send_begin(sdi) != SR_OK)
310                 return SR_ERR;
311
312         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
313                         cmdstring, 4, &tmp, 100)) != 0) {
314                 sr_err("Failed to set record length: %s.",
315                        libusb_error_name(ret));
316                 return SR_ERR;
317         }
318
319         memset(cmdstring, 0, sizeof(cmdstring));
320         cmdstring[0] = CMD_2250_SET_SAMPLERATE;
321         base = 100e6;
322         if (devc->samplerate > base) {
323                 /* Timebase fast */
324                 sr_err("Sample rate > 100MHz not yet supported.");
325                 return SR_ERR_ARG;
326         }
327
328         tmp = base / devc->samplerate;
329         /* Downsample only if really necessary */
330         if (tmp > 1) {
331                 /* Downsampling on */
332                 cmdstring[2] |= 2;
333                 /* Downsampler = 1comp((Base / Samplerate) - 2)
334                  *  Base == 100Msa resp. 200MSa
335                  *
336                  * Example for 500kSa/s:
337                  *  100e6 / 500e3 => 200
338                  *  200 - 2 => 198
339                  *  1comp(198) => ff39 */
340                 tmp -= 2;
341                 tmp = ~tmp;
342                 sr_dbg("Down sampler value: 0x%x.", tmp & 0xffff);
343                 cmdstring[4] = (tmp >> 0) & 0xff;
344                 cmdstring[5] = (tmp >> 8) & 0xff;
345         }
346
347         if (send_begin(sdi) != SR_OK)
348                 return SR_ERR;
349
350         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
351                         cmdstring, 8, &tmp, 100)) != 0) {
352                 sr_err("Failed to set sample rate: %s.",
353                        libusb_error_name(ret));
354                 return SR_ERR;
355         }
356         sr_dbg("Sent CMD_2250_SET_SAMPLERATE.");
357
358         /* Enabled channels: 00=CH1, 01=CH2, 10=both. */
359         memset(cmdstring, 0, sizeof(cmdstring));
360         cmdstring[0] = CMD_2250_SET_CHANNELS;
361         sr_dbg("Channels: CH1=%d, CH2=%d.", devc->ch_enabled[0], devc->ch_enabled[1]);
362         cmdstring[2] = (devc->ch_enabled[0] ? 0 : 1) + (devc->ch_enabled[1] ? 2 : 0);
363
364         if (send_begin(sdi) != SR_OK)
365                 return SR_ERR;
366
367         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
368                         cmdstring, 4, &tmp, 100)) != 0) {
369                 sr_err("Failed to set channels: %s.",
370                        libusb_error_name(ret));
371                 return SR_ERR;
372         }
373         sr_dbg("Sent CMD_2250_SET_CHANNELS.");
374
375         /* Trigger slope: 0=positive, 1=negative. */
376         memset(cmdstring, 0, sizeof(cmdstring));
377         cmdstring[0] = CMD_2250_SET_TRIGGERPOS_AND_BUFFER;
378
379         sr_dbg("Capture ratio: %" PRIu64 ".", devc->capture_ratio);
380         trig = devc->capture_ratio;
381         dso2250_set_triggerpos(trig,
382                         devc->framesize != FRAMESIZE_SMALL, cmdstring, 2);
383         dso2250_set_triggerpos(100 - trig,
384                         devc->framesize != FRAMESIZE_SMALL, cmdstring, 6);
385
386         if (send_begin(sdi) != SR_OK)
387                 return SR_ERR;
388
389         /* TODO: 12 bytes according to documentation? */
390         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
391                         cmdstring, 10, &tmp, 100)) != 0) {
392                 sr_err("Failed to set trigger position: %s.",
393                        libusb_error_name(ret));
394                 return SR_ERR;
395         }
396
397         return SR_OK;
398 }
399
400 SR_PRIV int dso_set_trigger_samplerate(const struct sr_dev_inst *sdi)
401 {
402         struct dev_context *devc;
403         struct sr_usb_dev_inst *usb;
404         int ret, tmp;
405         uint8_t cmdstring[12];
406         uint16_t timebase_small[] = { 0xffff, 0xfffc, 0xfff7, 0xffe8, 0xffce,
407                 0xff9c, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79, 0xd8f1 };
408         uint16_t timebase_large[] = { 0xffff, 0x0000, 0xfffc, 0xfff7, 0xffe8,
409                 0xffce, 0xff9d, 0xff07, 0xfe0d, 0xfc19, 0xf63d, 0xec79 };
410
411         devc = sdi->priv;
412         if (devc->profile->fw_pid == 0x2250)
413                 return dso2250_set_trigger_samplerate(sdi);
414
415         sr_dbg("Preparing CMD_SET_TRIGGER_SAMPLERATE.");
416
417         usb = sdi->conn;
418
419         memset(cmdstring, 0, sizeof(cmdstring));
420         /* Command */
421         cmdstring[0] = CMD_SET_TRIGGER_SAMPLERATE;
422
423         /* Trigger source */
424         sr_dbg("Trigger source %s.", devc->triggersource);
425         if (!strcmp("CH2", devc->triggersource))
426                 tmp = 0;
427         else if (!strcmp("CH1", devc->triggersource))
428                 tmp = 1;
429         else if (!strcmp("EXT", devc->triggersource))
430                 tmp = 2;
431         else {
432                 sr_err("Invalid trigger source: '%s'.", devc->triggersource);
433                 return SR_ERR_ARG;
434         }
435         cmdstring[2] = tmp;
436
437         /* Frame size */
438         sr_dbg("Frame size: %d.", devc->framesize);
439         cmdstring[2] |= (devc->framesize == FRAMESIZE_SMALL ? 0x01 : 0x02) << 2;
440
441         /* Timebase fast */
442         sr_dbg("Time base index: %d.", devc->timebase);
443         if (devc->framesize == FRAMESIZE_SMALL) {
444                 if (devc->timebase < TIME_20us)
445                         tmp = 0;
446                 else if (devc->timebase == TIME_20us)
447                         tmp = 1;
448                 else if (devc->timebase == TIME_40us)
449                         tmp = 2;
450                 else if (devc->timebase == TIME_100us)
451                         tmp = 3;
452                 else if (devc->timebase >= TIME_200us)
453                         tmp = 4;
454         } else {
455                 if (devc->timebase < TIME_40us) {
456                         sr_err("Timebase < 40us only supported with 10K buffer.");
457                         return SR_ERR_ARG;
458                 }
459                 else if (devc->timebase == TIME_40us)
460                         tmp = 0;
461                 else if (devc->timebase == TIME_100us)
462                         tmp = 2;
463                 else if (devc->timebase == TIME_200us)
464                         tmp = 3;
465                 else if (devc->timebase >= TIME_400us)
466                         tmp = 4;
467         }
468         cmdstring[2] |= (tmp & 0x07) << 5;
469
470         /* Enabled channels: 00=CH1 01=CH2 10=both */
471         sr_dbg("Channels CH1=%d CH2=%d", devc->ch_enabled[0], devc->ch_enabled[1]);
472         tmp = (((devc->ch_enabled[1] ? 1 : 0) << 1) + (devc->ch_enabled[0] ? 1 : 0)) - 1;
473         cmdstring[3] = tmp;
474
475         /* Fast rates channel */
476         /* TODO: Is this right? */
477         tmp = devc->timebase < TIME_10us ? 1 : 0;
478         cmdstring[3] |= tmp << 2;
479
480         /* Trigger slope: 0=positive 1=negative */
481         /* TODO: Does this work? */
482         sr_dbg("Trigger slope: %d.", devc->triggerslope);
483         cmdstring[3] |= (devc->triggerslope == SLOPE_NEGATIVE ? 1 : 0) << 3;
484
485         /* Timebase slow */
486         if (devc->timebase < TIME_100us)
487                 tmp = 0;
488         else if (devc->timebase > TIME_400ms)
489                 tmp = 0xffed;
490         else {
491                 if (devc->framesize == FRAMESIZE_SMALL)
492                         tmp = timebase_small[devc->timebase - 3];
493                 else
494                         tmp = timebase_large[devc->timebase - 3];
495         }
496         cmdstring[4] = tmp & 0xff;
497         cmdstring[5] = (tmp >> 8) & 0xff;
498
499         /* Horizontal trigger position */
500         sr_dbg("Capture ratio: %" PRIu64 ".", devc->capture_ratio);
501         tmp = 0x77fff + 0x8000 * devc->capture_ratio / 100;
502         cmdstring[6] = tmp & 0xff;
503         cmdstring[7] = (tmp >> 8) & 0xff;
504         cmdstring[10] = (tmp >> 16) & 0xff;
505
506         if (send_begin(sdi) != SR_OK)
507                 return SR_ERR;
508
509         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
510                         cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
511                 sr_err("Failed to set trigger/samplerate: %s.",
512                        libusb_error_name(ret));
513                 return SR_ERR;
514         }
515         sr_dbg("Sent CMD_SET_TRIGGER_SAMPLERATE.");
516
517         return SR_OK;
518 }
519
520 static int dso_set_filters(const struct sr_dev_inst *sdi)
521 {
522         struct dev_context *devc;
523         struct sr_usb_dev_inst *usb;
524         int ret, tmp;
525         uint8_t cmdstring[8];
526
527         sr_dbg("Preparing CMD_SET_FILTERS.");
528
529         devc = sdi->priv;
530         usb = sdi->conn;
531
532         memset(cmdstring, 0, sizeof(cmdstring));
533         cmdstring[0] = CMD_SET_FILTERS;
534         cmdstring[1] = 0x0f;
535         if (devc->filter[0]) {
536                 sr_dbg("Turning on CH1 filter.");
537                 cmdstring[2] |= 0x80;
538         }
539         if (devc->filter[1]) {
540                 sr_dbg("Turning on CH2 filter.");
541                 cmdstring[2] |= 0x40;
542         }
543         /*
544          * Not supported: filtering on the trigger
545          * cmdstring[2] |= 0x20;
546          */
547
548         if (send_begin(sdi) != SR_OK)
549                 return SR_ERR;
550
551         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
552                         cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
553                 sr_err("Failed to set filters: %s.", libusb_error_name(ret));
554                 return SR_ERR;
555         }
556         sr_dbg("Sent CMD_SET_FILTERS.");
557
558         return SR_OK;
559 }
560
561 static int dso_set_voltage(const struct sr_dev_inst *sdi)
562 {
563         struct dev_context *devc;
564         struct sr_usb_dev_inst *usb;
565         int ret, tmp;
566         uint8_t cmdstring[8];
567
568         sr_dbg("Preparing CMD_SET_VOLTAGE.");
569
570         devc = sdi->priv;
571         usb = sdi->conn;
572
573         memset(cmdstring, 0, sizeof(cmdstring));
574         cmdstring[0] = CMD_SET_VOLTAGE;
575
576         if (devc->profile->fw_pid == 0x2250) {
577                 cmdstring[1] = 0x00;
578                 cmdstring[2] = 0x08;
579         } else {
580                 cmdstring[1] = 0x0f;
581                 cmdstring[2] = 0x30;
582         }
583
584         /* CH1 volts/div is encoded in bits 0-1. */
585         sr_dbg("CH1 vdiv index: %d.", devc->voltage[0]);
586         switch (devc->voltage[0]) {
587         case VDIV_1V:
588         case VDIV_100MV:
589         case VDIV_10MV:
590                 cmdstring[2] |= 0x00;
591                 break;
592         case VDIV_2V:
593         case VDIV_200MV:
594         case VDIV_20MV:
595                 cmdstring[2] |= 0x01;
596                 break;
597         case VDIV_5V:
598         case VDIV_500MV:
599         case VDIV_50MV:
600                 cmdstring[2] |= 0x02;
601                 break;
602         }
603
604         /* CH2 volts/div is encoded in bits 2-3. */
605         sr_dbg("CH2 vdiv index: %d.", devc->voltage[1]);
606         switch (devc->voltage[1]) {
607         case VDIV_1V:
608         case VDIV_100MV:
609         case VDIV_10MV:
610                 cmdstring[2] |= 0x00;
611                 break;
612         case VDIV_2V:
613         case VDIV_200MV:
614         case VDIV_20MV:
615                 cmdstring[2] |= 0x04;
616                 break;
617         case VDIV_5V:
618         case VDIV_500MV:
619         case VDIV_50MV:
620                 cmdstring[2] |= 0x08;
621                 break;
622         }
623
624         if (send_begin(sdi) != SR_OK)
625                 return SR_ERR;
626
627         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
628                         cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
629                 sr_err("Failed to set voltage: %s.", libusb_error_name(ret));
630                 return SR_ERR;
631         }
632         sr_dbg("Sent CMD_SET_VOLTAGE.");
633
634         return SR_OK;
635 }
636
637 static int dso_set_relays(const struct sr_dev_inst *sdi)
638 {
639         struct dev_context *devc;
640         struct sr_usb_dev_inst *usb;
641         GString *gs;
642         int ret, i;
643         uint8_t relays[17] = { 0x00, 0x04, 0x08, 0x02, 0x20, 0x40, 0x10, 0x01,
644                         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
645
646         sr_dbg("Preparing CTRL_SETRELAYS.");
647
648         devc = sdi->priv;
649         usb = sdi->conn;
650
651         if (devc->voltage[0] < VDIV_1V)
652                 relays[1] = ~relays[1];
653
654         if (devc->voltage[0] < VDIV_100MV)
655                 relays[2] = ~relays[2];
656
657         sr_dbg("CH1 coupling: %d.", devc->coupling[0]);
658         if (devc->coupling[0] != COUPLING_AC)
659                 relays[3] = ~relays[3];
660
661         if (devc->voltage[1] < VDIV_1V)
662                 relays[4] = ~relays[4];
663
664         if (devc->voltage[1] < VDIV_100MV)
665                 relays[5] = ~relays[5];
666
667         sr_dbg("CH2 coupling: %d.", devc->coupling[1]);
668         if (devc->coupling[1] != COUPLING_AC)
669                 relays[6] = ~relays[6];
670
671         if (!strcmp(devc->triggersource, "EXT"))
672                 relays[7] = ~relays[7];
673
674         if (sr_log_loglevel_get() >= SR_LOG_DBG) {
675                 gs = g_string_sized_new(128);
676                 g_string_printf(gs, "Relays:");
677                 for (i = 0; i < 17; i++)
678                         g_string_append_printf(gs, " %.2x", relays[i]);
679                 sr_dbg("%s", gs->str);
680                 g_string_free(gs, TRUE);
681         }
682
683         if ((ret = libusb_control_transfer(usb->devhdl,
684                         LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETRELAYS,
685                         0, 0, relays, 17, 100)) != sizeof(relays)) {
686                 sr_err("Failed to set relays: %s.", libusb_error_name(ret));
687                 return SR_ERR;
688         }
689         sr_dbg("Sent CTRL_SETRELAYS.");
690
691         return SR_OK;
692 }
693
694 SR_PRIV int dso_set_voffsets(const struct sr_dev_inst *sdi)
695 {
696         struct dev_context *devc;
697         struct sr_usb_dev_inst *usb;
698         int offset, ret;
699         uint16_t *ch_levels;
700         uint8_t offsets[17];
701
702         sr_dbg("Preparing CTRL_SETOFFSET.");
703
704         devc = sdi->priv;
705         usb = sdi->conn;
706
707         memset(offsets, 0, sizeof(offsets));
708         /* Channel 1 */
709         ch_levels = devc->channel_levels[0][devc->voltage[0]];
710         offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch1 + ch_levels[0];
711         offsets[0] = (offset >> 8) | 0x20;
712         offsets[1] = offset & 0xff;
713         sr_dbg("CH1 offset: %3.2f (%.2x%.2x).", devc->voffset_ch1,
714                offsets[0], offsets[1]);
715
716         /* Channel 2 */
717         ch_levels = devc->channel_levels[1][devc->voltage[1]];
718         offset = (ch_levels[1] - ch_levels[0]) * devc->voffset_ch2 + ch_levels[0];
719         offsets[2] = (offset >> 8) | 0x20;
720         offsets[3] = offset & 0xff;
721         sr_dbg("CH2 offset: %3.2f (%.2x%.2x).", devc->voffset_ch2,
722                offsets[2], offsets[3]);
723
724         /* Trigger */
725         offset = MAX_VERT_TRIGGER * devc->voffset_trigger;
726         offsets[4] = (offset >> 8) | 0x20;
727         offsets[5] = offset & 0xff;
728         sr_dbg("Trigger offset: %3.2f (%.2x%.2x).", devc->voffset_trigger,
729                         offsets[4], offsets[5]);
730
731         if ((ret = libusb_control_transfer(usb->devhdl,
732                         LIBUSB_REQUEST_TYPE_VENDOR, CTRL_SETOFFSET,
733                         0, 0, offsets, sizeof(offsets), 100)) != sizeof(offsets)) {
734                 sr_err("Failed to set offsets: %s.", libusb_error_name(ret));
735                 return SR_ERR;
736         }
737         sr_dbg("Sent CTRL_SETOFFSET.");
738
739         return SR_OK;
740 }
741
742 SR_PRIV int dso_enable_trigger(const struct sr_dev_inst *sdi)
743 {
744         struct sr_usb_dev_inst *usb;
745         int ret, tmp;
746         uint8_t cmdstring[2];
747
748         sr_dbg("Sending CMD_ENABLE_TRIGGER.");
749
750         usb = sdi->conn;
751
752         memset(cmdstring, 0, sizeof(cmdstring));
753         cmdstring[0] = CMD_ENABLE_TRIGGER;
754         cmdstring[1] = 0x00;
755
756         if (send_begin(sdi) != SR_OK)
757                 return SR_ERR;
758
759         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
760                         cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
761                 sr_err("Failed to enable trigger: %s.", libusb_error_name(ret));
762                 return SR_ERR;
763         }
764
765         return SR_OK;
766 }
767
768 SR_PRIV int dso_force_trigger(const struct sr_dev_inst *sdi)
769 {
770         struct sr_usb_dev_inst *usb;
771         int ret, tmp;
772         uint8_t cmdstring[2];
773
774         sr_dbg("Sending CMD_FORCE_TRIGGER.");
775
776         usb = sdi->conn;
777
778         memset(cmdstring, 0, sizeof(cmdstring));
779         cmdstring[0] = CMD_FORCE_TRIGGER;
780         cmdstring[1] = 0x00;
781
782         if (send_begin(sdi) != SR_OK)
783                 return SR_ERR;
784
785         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_OUT,
786                         cmdstring, sizeof(cmdstring), &tmp, 100)) != 0) {
787                 sr_err("Failed to force trigger: %s.", libusb_error_name(ret));
788                 return SR_ERR;
789         }
790
791         return SR_OK;
792 }
793
794 SR_PRIV int dso_init(const struct sr_dev_inst *sdi)
795 {
796         sr_dbg("Initializing DSO.");
797
798         if (get_channel_offsets(sdi) != SR_OK)
799                 return SR_ERR;
800
801         if (dso_set_trigger_samplerate(sdi) != SR_OK)
802                 return SR_ERR;
803
804         if (dso_set_filters(sdi) != SR_OK)
805                 return SR_ERR;
806
807         if (dso_set_voltage(sdi) != SR_OK)
808                 return SR_ERR;
809
810         if (dso_set_relays(sdi) != SR_OK)
811                 return SR_ERR;
812
813         if (dso_set_voffsets(sdi) != SR_OK)
814                 return SR_ERR;
815
816         if (dso_enable_trigger(sdi) != SR_OK)
817                 return SR_ERR;
818
819         return SR_OK;
820 }
821
822 SR_PRIV int dso_get_capturestate(const struct sr_dev_inst *sdi,
823                 uint8_t *capturestate, uint32_t *trigger_offset)
824 {
825         struct sr_usb_dev_inst *usb;
826         int ret, tmp, i;
827         unsigned int bitvalue, toff;
828         uint8_t cmdstring[2], inbuf[512];
829
830         sr_dbg("Sending CMD_GET_CAPTURESTATE.");
831
832         usb = sdi->conn;
833
834         cmdstring[0] = CMD_GET_CAPTURESTATE;
835         cmdstring[1] = 0;
836
837         if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
838                 sr_dbg("Failed to send get_capturestate command: %s.",
839                        libusb_error_name(ret));
840                 return SR_ERR;
841         }
842
843         if ((ret = libusb_bulk_transfer(usb->devhdl, DSO_EP_IN,
844                         inbuf, 512, &tmp, 100)) != 0) {
845                 sr_dbg("Failed to get capturestate: %s.",
846                        libusb_error_name(ret));
847                 return SR_ERR;
848         }
849         *capturestate = inbuf[0];
850         toff = (inbuf[1] << 16) | (inbuf[3] << 8) | inbuf[2];
851
852         /*
853          * This conversion comes from the openhantek project.
854          * Each set bit in the 24-bit value inverts all bits with a lower
855          * value. No idea why the device reports the trigger point this way.
856          */
857         bitvalue = 1;
858         for (i = 0; i < 24; i++) {
859                 /* Each set bit inverts all bits with a lower value. */
860                 if (toff & bitvalue)
861                         toff ^= bitvalue - 1;
862                 bitvalue <<= 1;
863         }
864         *trigger_offset = toff;
865
866         return SR_OK;
867 }
868
869 SR_PRIV int dso_capture_start(const struct sr_dev_inst *sdi)
870 {
871         int ret;
872         uint8_t cmdstring[2];
873
874         sr_dbg("Sending CMD_CAPTURE_START.");
875
876         cmdstring[0] = CMD_CAPTURE_START;
877         cmdstring[1] = 0;
878
879         if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
880                 sr_err("Failed to send capture_start command: %s.",
881                        libusb_error_name(ret));
882                 return SR_ERR;
883         }
884
885         return SR_OK;
886 }
887
888 SR_PRIV int dso_get_channeldata(const struct sr_dev_inst *sdi,
889                 libusb_transfer_cb_fn cb)
890 {
891         struct dev_context *devc;
892         struct sr_usb_dev_inst *usb;
893         struct libusb_transfer *transfer;
894         int num_transfers, ret, i;
895         uint8_t cmdstring[2];
896         unsigned char *buf;
897
898         sr_dbg("Sending CMD_GET_CHANNELDATA.");
899
900         devc = sdi->priv;
901         usb = sdi->conn;
902
903         cmdstring[0] = CMD_GET_CHANNELDATA;
904         cmdstring[1] = 0;
905
906         if ((ret = send_bulkcmd(sdi, cmdstring, sizeof(cmdstring))) != SR_OK) {
907                 sr_err("Failed to get channel data: %s.",
908                        libusb_error_name(ret));
909                 return SR_ERR;
910         }
911
912         /* TODO: DSO-2xxx only. */
913         num_transfers = devc->framesize *
914                         sizeof(unsigned short) / devc->epin_maxpacketsize;
915         sr_dbg("Queueing up %d transfers.", num_transfers);
916         for (i = 0; i < num_transfers; i++) {
917                 if (!(buf = g_try_malloc(devc->epin_maxpacketsize))) {
918                         sr_err("Failed to malloc USB endpoint buffer.");
919                         return SR_ERR_MALLOC;
920                 }
921                 transfer = libusb_alloc_transfer(0);
922                 libusb_fill_bulk_transfer(transfer, usb->devhdl, DSO_EP_IN, buf,
923                                 devc->epin_maxpacketsize, cb, (void *)sdi, 40);
924                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
925                         sr_err("Failed to submit transfer: %s.",
926                                libusb_error_name(ret));
927                         /* TODO: Free them all. */
928                         libusb_free_transfer(transfer);
929                         g_free(buf);
930                         return SR_ERR;
931                 }
932         }
933
934         return SR_OK;
935 }