hantek_6022be.c

   1 /*
   2  * This file is part of the sigrok-firmware-fx2lafw project.
   3  *
   4  * Copyright (C) 2009 Ubixum, Inc.
   5  * Copyright (C) 2015 Jochen Hoenicke
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <fx2macros.h>
  22 #include <fx2ints.h>
  23 #include <autovector.h>
  24 #include <delay.h>
  25 #include <setupdat.h>
  26
  27 #define SET_ANALOG_MODE()
  28
  29 /* Toggle the 1kHz calibration pin, only accurate up to ca. 8MHz. */
  30 #define TOGGLE_CALIBRATION_PIN() PA7 = !PA7
  31
  32 #define LED_CLEAR() PC0 = 1; PC1 = 1;
  33 #define LED_GREEN() PC0 = 1; PC1 = 0;
  34 #define LED_RED()   PC0 = 0; PC1 = 1;
  35
  36 /* CTLx pin index (IFCLK, ADC clock input). */
  37 #define CTL_BIT 2
  38
  39 #define OUT0 ((1 << CTL_BIT) << 4) /* OEx = 1, CTLx = 0 */
  40 #define OE_CTL (((1 << CTL_BIT) << 4) | (1 << CTL_BIT)) /* OEx = CTLx = 1 */
  41
  42 /* Change to support as many interfaces as you need. */
  43 static BYTE altiface = 0;
  44
  45 static volatile WORD ledcounter = 0;
  46
  47 static volatile __bit dosud = FALSE;
  48 static volatile __bit dosuspend = FALSE;
  49
  50 extern __code BYTE highspd_dscr;
  51 extern __code BYTE fullspd_dscr;
  52
  53 void resume_isr(void) __interrupt RESUME_ISR
  54 {
  55         CLEAR_RESUME();
  56 }
  57
  58 void sudav_isr(void) __interrupt SUDAV_ISR
  59 {
  60         dosud = TRUE;
  61         CLEAR_SUDAV();
  62 }
  63
  64 void usbreset_isr(void) __interrupt USBRESET_ISR
  65 {
  66         handle_hispeed(FALSE);
  67         CLEAR_USBRESET();
  68 }
  69
  70 void hispeed_isr(void) __interrupt HISPEED_ISR
  71 {
  72         handle_hispeed(TRUE);
  73         CLEAR_HISPEED();
  74 }
  75
  76 void suspend_isr(void) __interrupt SUSPEND_ISR
  77 {
  78         dosuspend = TRUE;
  79         CLEAR_SUSPEND();
  80 }
  81
  82 void timer2_isr(void) __interrupt TF2_ISR
  83 {
  84         TOGGLE_CALIBRATION_PIN();
  85
  86         if (ledcounter && (--ledcounter == 0))
  87                 LED_CLEAR();
  88
  89         TF2 = 0;
  90 }
  91
  92 /*
  93  * This sets three bits for each channel, one channel at a time.
  94  * For channel 0 we want to set bits 5, 6 & 7
  95  * For channel 1 we want to set bits 2, 3 & 4
  96  *
  97  * We convert the input values that are strange due to original
  98  * firmware code into the value of the three bits as follows:
  99  *
 100  * val -> bits
 101  * 1  -> 010b
 102  * 2  -> 001b
 103  * 5  -> 000b
 104  * 10 -> 011b
 105  *
 106  * The third bit is always zero since there are only four outputs connected
 107  * in the serial selector chip.
 108  *
 109  * The multiplication of the converted value by 0x24 sets the relevant bits in
 110  * both channels and then we mask it out to only affect the channel currently
 111  * requested.
 112  */
 113 static BOOL set_voltage(BYTE channel, BYTE val)
 114 {
 115         BYTE bits, mask;
 116
 117         switch (val) {
 118         case 1:
 119                 bits = 0x24 * 2;
 120                 break;
 121         case 2:
 122                 bits = 0x24 * 1;
 123                 break;
 124         case 5:
 125                 bits = 0x24 * 0;
 126                 break;
 127         case 10:
 128                 bits = 0x24 * 3;
 129                 break;
 130         default:
 131                 return FALSE;
 132         }
 133
 134         mask = (channel) ? 0xe0 : 0x1c;
 135         IOC = (IOC & ~mask) | (bits & mask);
 136
 137         return TRUE;
 138 }
 139
 140 static BOOL set_numchannels(BYTE numchannels)
 141 {
 142         if (numchannels == 1 || numchannels == 2) {
 143                 BYTE fifocfg = 7 + numchannels;
 144                 EP2FIFOCFG = fifocfg;
 145                 EP6FIFOCFG = fifocfg;
 146                 return TRUE;
 147         }
 148
 149         return FALSE;
 150 }
 151
 152 static void clear_fifo(void)
 153 {
 154         GPIFABORT = 0xff;
 155         SYNCDELAY3;
 156         FIFORESET = 0x80;
 157         SYNCDELAY3;
 158         FIFORESET = 0x82;
 159         SYNCDELAY3;
 160         FIFORESET = 0x86;
 161         SYNCDELAY3;
 162         FIFORESET = 0;
 163 }
 164
 165 static void stop_sampling(void)
 166 {
 167         GPIFABORT = 0xff;
 168         SYNCDELAY3;
 169         INPKTEND = (altiface == 0) ? 6 : 2;
 170 }
 171
 172 static void start_sampling(void)
 173 {
 174         int i;
 175
 176         SET_ANALOG_MODE();
 177
 178         clear_fifo();
 179
 180         for (i = 0; i < 1000; i++);
 181
 182         while (!(GPIFTRIG & 0x80))
 183                 ;
 184
 185         SYNCDELAY3;
 186         GPIFTCB1 = 0x28;
 187         SYNCDELAY3;
 188         GPIFTCB0 = 0;
 189         GPIFTRIG = (altiface == 0) ? 6 : 4;
 190
 191         /* Set green LED, don't clear LED afterwards (ledcounter = 0). */
 192         LED_GREEN();
 193         ledcounter = 0;
 194 }
 195
 196 static void select_interface(BYTE alt)
 197 {
 198         const BYTE *pPacketSize = \
 199                 ((USBCS & bmHSM) ? &highspd_dscr : &fullspd_dscr)
 200                 + (9 + (16 * alt) + 9 + 4);
 201
 202         altiface = alt;
 203
 204         if (alt == 0) {
 205                 /* Bulk on EP6. */
 206                 EP2CFG = 0x00;
 207                 EP6CFG = 0xe0;
 208                 EP6GPIFFLGSEL = 1;
 209                 EP6AUTOINLENL = pPacketSize[0];
 210                 EP6AUTOINLENH = pPacketSize[1];
 211         } else {
 212                 /* Iso on EP2. */
 213                 EP2CFG = 0xd8;
 214                 EP6CFG = 0x00;
 215                 EP2GPIFFLGSEL = 1;
 216                 EP2AUTOINLENL = pPacketSize[0];
 217                 EP2AUTOINLENH = pPacketSize[1] & 0x7;
 218                 EP2ISOINPKTS = (pPacketSize[1] >> 3) + 1;
 219         }
 220 }
 221
 222 static const struct samplerate_info {
 223         BYTE rate;
 224         BYTE wait0;
 225         BYTE wait1;
 226         BYTE opc0;
 227         BYTE opc1;
 228         BYTE out0;
 229         BYTE ifcfg;
 230 } samplerates[] = {
 231         { 48, 0x80,   0, 3, 0, 0x00, 0xea },
 232         { 30, 0x80,   0, 3, 0, 0x00, 0xaa },
 233         { 24,    1,   0, 2, 1, OUT0, 0xca },
 234         { 16,    1,   1, 2, 0, OUT0, 0xca },
 235         { 12,    2,   1, 2, 0, OUT0, 0xca },
 236         {  8,    3,   2, 2, 0, OUT0, 0xca },
 237         {  4,    6,   5, 2, 0, OUT0, 0xca },
 238         {  2,   12,  11, 2, 0, OUT0, 0xca },
 239         {  1,   24,  23, 2, 0, OUT0, 0xca },
 240         { 50,   48,  47, 2, 0, OUT0, 0xca },
 241         { 20,  120, 119, 2, 0, OUT0, 0xca },
 242         { 10,  240, 239, 2, 0, OUT0, 0xca },
 243 };
 244
 245 static BOOL set_samplerate(BYTE rate)
 246 {
 247         BYTE i = 0;
 248
 249         while (samplerates[i].rate != rate) {
 250                 i++;
 251                 if (i == sizeof(samplerates) / sizeof(samplerates[0]))
 252                         return FALSE;
 253         }
 254
 255         IFCONFIG = samplerates[i].ifcfg;
 256
 257         AUTOPTRSETUP = 7;
 258         AUTOPTRH2 = 0xE4; /* 0xE400: GPIF waveform descriptor 0. */
 259         AUTOPTRL2 = 0x00;
 260
 261         /*
 262          * The program for low-speed, e.g. 1 MHz, is:
 263          * wait 24, CTLx=0, FIFO
 264          * wait 23, CTLx=1
 265          * jump 0, CTLx=1
 266          *
 267          * The program for 24 MHz is:
 268          * wait 1, CTLx=0, FIFO
 269          * jump 0, CTLx=1
 270          *
 271          * The program for 30/48 MHz is:
 272          * jump 0, CTLx=Z, FIFO, LOOP
 273          *
 274          * (CTLx is device-dependent, could be e.g. CTL0 or CTL2.)
 275          */
 276
 277         /* LENGTH / BRANCH 0-7 */
 278         EXTAUTODAT2 = samplerates[i].wait0;
 279         EXTAUTODAT2 = samplerates[i].wait1;
 280         EXTAUTODAT2 = 1;
 281         EXTAUTODAT2 = 0;
 282         EXTAUTODAT2 = 0;
 283         EXTAUTODAT2 = 0;
 284         EXTAUTODAT2 = 0;
 285         EXTAUTODAT2 = 0;
 286
 287         /* OPCODE 0-7 */
 288         EXTAUTODAT2 = samplerates[i].opc0;
 289         EXTAUTODAT2 = samplerates[i].opc1;
 290         EXTAUTODAT2 = 1; /* DATA=0 DP=1 */
 291         EXTAUTODAT2 = 0;
 292         EXTAUTODAT2 = 0;
 293         EXTAUTODAT2 = 0;
 294         EXTAUTODAT2 = 0;
 295         EXTAUTODAT2 = 0;
 296
 297         /* OUTPUT 0-7 */
 298         EXTAUTODAT2 = samplerates[i].out0;
 299         EXTAUTODAT2 = OE_CTL;
 300         EXTAUTODAT2 = OE_CTL;
 301         EXTAUTODAT2 = 0;
 302         EXTAUTODAT2 = 0;
 303         EXTAUTODAT2 = 0;
 304         EXTAUTODAT2 = 0;
 305         EXTAUTODAT2 = 0;
 306
 307         /* LOGIC FUNCTION 0-7 */
 308         EXTAUTODAT2 = 0;
 309         EXTAUTODAT2 = 0;
 310         EXTAUTODAT2 = 0;
 311         EXTAUTODAT2 = 0;
 312         EXTAUTODAT2 = 0;
 313         EXTAUTODAT2 = 0;
 314         EXTAUTODAT2 = 0;
 315         EXTAUTODAT2 = 0;
 316
 317         for (i = 0; i < 96; i++)
 318                 EXTAUTODAT2 = 0;
 319
 320         return TRUE;
 321 }
 322
 323 /* Set *alt_ifc to the current alt interface for ifc. */
 324 BOOL handle_get_interface(BYTE ifc, BYTE *alt_ifc)
 325 {
 326         (void)ifc;
 327
 328         *alt_ifc = altiface;
 329
 330         return TRUE;
 331 }
 332
 333 /*
 334  * Return TRUE if you set the interface requested.
 335  *
 336  * Note: This function should reconfigure and reset the endpoints
 337  * according to the interface descriptors you provided.
 338  */
 339 BOOL handle_set_interface(BYTE ifc,BYTE alt_ifc)
 340 {
 341         if (ifc == 0)
 342                 select_interface(alt_ifc);
 343
 344         return TRUE;
 345 }
 346
 347 BYTE handle_get_configuration(void)
 348 {
 349         /* We only support configuration 0. */
 350         return 0;
 351 }
 352
 353 BOOL handle_set_configuration(BYTE cfg)
 354 {
 355         /* We only support configuration 0. */
 356         (void)cfg;
 357
 358         return TRUE;
 359 }
 360
 361 BOOL handle_vendorcommand(BYTE cmd)
 362 {
 363         stop_sampling();
 364
 365         /* Set red LED, clear after timeout. */
 366         LED_RED();
 367         ledcounter = 1000;
 368
 369         /* Clear EP0BCH/L for each valid command. */
 370         if (cmd >= 0xe0 && cmd <= 0xe4) {
 371                 EP0BCH = 0;
 372                 EP0BCL = 0;
 373                 while (EP0CS & bmEPBUSY);
 374         }
 375
 376         switch (cmd) {
 377         case 0xe0:
 378         case 0xe1:
 379                 set_voltage(cmd - 0xe0, EP0BUF[0]);
 380                 return TRUE;
 381         case 0xe2:
 382                 set_samplerate(EP0BUF[0]);
 383                 return TRUE;
 384         case 0xe3:
 385                 if (EP0BUF[0] == 1)
 386                         start_sampling();
 387                 return TRUE;
 388         case 0xe4:
 389                 set_numchannels(EP0BUF[0]);
 390                 return TRUE;
 391         }
 392
 393         return FALSE; /* Not handled by handlers. */
 394 }
 395
 396 static void init(void)
 397 {
 398         EP4CFG = 0;
 399         EP8CFG = 0;
 400
 401         SET_ANALOG_MODE();
 402
 403         /* In idle mode tristate all outputs. */
 404         GPIFIDLECTL = 0x00; /* Don't enable CTL0-5 outputs. */
 405         GPIFCTLCFG = 0x80; /* TRICTL=1. CTL0-2: CMOS outputs, tri-statable. */
 406         GPIFWFSELECT = 0x00;
 407         GPIFREADYSTAT = 0x00;
 408
 409         stop_sampling();
 410
 411         set_voltage(0, 1);
 412         set_voltage(1, 1);
 413         set_samplerate(1);
 414         set_numchannels(2);
 415         select_interface(0);
 416 }
 417
 418 static void main(void)
 419 {
 420         /* Save energy. */
 421         SETCPUFREQ(CLK_12M);
 422
 423         init();
 424
 425         /* Set up interrupts. */
 426         USE_USB_INTS();
 427
 428         ENABLE_SUDAV();
 429         ENABLE_USBRESET();
 430         ENABLE_HISPEED();
 431         ENABLE_SUSPEND();
 432         ENABLE_RESUME();
 433
 434         /* Global (8051) interrupt enable. */
 435         EA = 1;
 436
 437         /* Init timer2. */
 438         RCAP2L = -500 & 0xff;
 439         RCAP2H = (-500 & 0xff00) >> 8;
 440         T2CON = 0;
 441         ET2 = 1;
 442         TR2 = 1;
 443
 444         RENUMERATE_UNCOND();
 445
 446         PORTECFG = 0;
 447         PORTCCFG = 0;
 448         PORTACFG = 0;
 449         OEE = 0xff;
 450         OEC = 0xff;
 451         OEA = 0xff;
 452
 453         while (TRUE) {
 454                 if (dosud) {
 455                         dosud = FALSE;
 456                         handle_setupdata();
 457                 }
 458
 459                 if (dosuspend) {
 460                         dosuspend = FALSE;
 461                         do {
 462                                 /* Make sure ext wakeups are cleared. */
 463                                 WAKEUPCS |= bmWU | bmWU2;
 464                                 SUSPEND = 1;
 465                                 PCON |= 1;
 466                                 __asm
 467                                 nop
 468                                 nop
 469                                 nop
 470                                 nop
 471                                 nop
 472                                 nop
 473                                 nop
 474                                 __endasm;
 475                         } while (!remote_wakeup_allowed && REMOTE_WAKEUP());
 476
 477                         /* Resume (TRM 6.4). */
 478                         if (REMOTE_WAKEUP()) {
 479                                 delay(5);
 480                                 USBCS |= bmSIGRESUME;
 481                                 delay(15);
 482                                 USBCS &= ~bmSIGRESUME;
 483                         }
 484                 }
 485         }
 486 }