sainsmart_dds120.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() PA7 = 1
  28
  29 #define SET_COUPLING(x) set_coupling(x)
  30
  31 #define SET_CALIBRATION_PULSE(x) set_calibration_pulse(x)
  32
  33 /* Toggle the 1kHz calibration pin, only accurate up to ca. 8MHz. */
  34 /* Note: There's no PE2 as IOE is not bit-addressable (see TRM 15.2). */
  35 #define TOGGLE_CALIBRATION_PIN() IOE = IOE ^ 0x04
  36
  37 #define LED_CLEAR() NOP
  38 #define LED_GREEN() NOP
  39 #define LED_RED()   NOP
  40
  41 /* CTLx pin index (IFCLK, ADC clock input). */
  42 #define CTL_BIT 2
  43
  44 #define OUT0 ((1 << CTL_BIT) << 4) /* OEx = 1, CTLx = 0 */
  45 #define OE_CTL (((1 << CTL_BIT) << 4) | (1 << CTL_BIT)) /* OEx = CTLx = 1 */
  46
  47 /* Change to support as many interfaces as you need. */
  48 static BYTE altiface = 0;
  49
  50 static volatile WORD ledcounter = 0;
  51
  52 static volatile __bit dosud = FALSE;
  53 static volatile __bit dosuspend = FALSE;
  54
  55 extern __code BYTE highspd_dscr;
  56 extern __code BYTE fullspd_dscr;
  57
  58 void resume_isr(void) __interrupt RESUME_ISR
  59 {
  60         CLEAR_RESUME();
  61 }
  62
  63 void sudav_isr(void) __interrupt SUDAV_ISR
  64 {
  65         dosud = TRUE;
  66         CLEAR_SUDAV();
  67 }
  68
  69 void usbreset_isr(void) __interrupt USBRESET_ISR
  70 {
  71         handle_hispeed(FALSE);
  72         CLEAR_USBRESET();
  73 }
  74
  75 void hispeed_isr(void) __interrupt HISPEED_ISR
  76 {
  77         handle_hispeed(TRUE);
  78         CLEAR_HISPEED();
  79 }
  80
  81 void suspend_isr(void) __interrupt SUSPEND_ISR
  82 {
  83         dosuspend = TRUE;
  84         CLEAR_SUSPEND();
  85 }
  86
  87 void timer2_isr(void) __interrupt TF2_ISR
  88 {
  89         TOGGLE_CALIBRATION_PIN();
  90
  91         if (ledcounter && (--ledcounter == 0))
  92                 LED_CLEAR();
  93
  94         TF2 = 0;
  95 }
  96
  97 /**
  98  * The gain stage is 2 stage approach. -6dB and -20dB on the first stage
  99  * (attentuator). The second stage is then doing the gain by 3 different
 100  * resistor values switched into the feedback loop.
 101  *
 102  * #Channel 0:
 103  * PC1=1; PC2=0; PC3= 0 -> Gain x0.1 = -20dB
 104  * PC1=1; PC2=0; PC3= 1 -> Gain x0.2 = -14dB
 105  * PC1=1; PC2=1; PC3= 0 -> Gain x0.4 =  -8dB
 106  * PC1=0; PC2=0; PC3= 0 -> Gain x0.5 =  -6dB
 107  * PC1=0; PC2=0; PC3= 1 -> Gain x1   =   0dB
 108  * PC1=0; PC2=1; PC3= 0 -> Gain x2   =  +6dB
 109  *
 110  * #Channel 1:
 111  * PE1=1; PC4=0; PC5= 0 -> Gain x0.1 = -20dB
 112  * PE1=1; PC4=0; PC5= 1 -> Gain x0.2 = -14dB
 113  * PE1=1; PC4=1; PC5= 0 -> Gain x0.4 =  -8dB
 114  * PE1=0; PC4=0; PC5= 0 -> Gain x0.5 =  -6dB
 115  * PE1=0; PC4=0; PC5= 1 -> Gain x1   =   0dB
 116  * PE1=0; PC4=1; PC5= 0 -> Gain x2   =  +6dB
 117  */
 118 static BOOL set_voltage(BYTE channel, BYTE val)
 119 {
 120         BYTE bits_C, bit_E, mask_C, mask_E;
 121
 122         if (channel == 0) {
 123                 mask_C = 0x0E;
 124                 mask_E = 0x00;
 125                 bit_E = 0;
 126                 switch (val) {
 127                 case 1:
 128                         bits_C = 0x02;
 129                         break;
 130                 case 2:
 131                         bits_C = 0x06;
 132                         break;
 133                 case 5:
 134                         bits_C = 0x00;
 135                         break;
 136                 case 10:
 137                         bits_C = 0x04;
 138                         break;
 139                 case 20:
 140                         bits_C = 0x08;
 141                         break;
 142                 default:
 143                         return FALSE;
 144                 }
 145         } else if (channel == 1) {
 146                 mask_C = 0x30;
 147                 mask_E = 0x02;
 148                 switch (val) {
 149                 case 1:
 150                         bits_C = 0x00;
 151                         bit_E = 0x02;
 152                         break;
 153                 case 2:
 154                         bits_C = 0x10;
 155                         bit_E = 0x02;
 156                         break;
 157                 case 5:
 158                         bits_C = 0x00;
 159                         bit_E = 0x00;
 160                         break;
 161                 case 10:
 162                         bits_C = 0x10;
 163                         bit_E = 0x00;
 164                         break;
 165                 case 20:
 166                         bits_C = 0x20;
 167                         bit_E = 0x00;
 168                         break;
 169                 default:
 170                         return FALSE;
 171                 }
 172         } else {
 173                 return FALSE;
 174         }
 175         IOC = (IOC & ~mask_C) | (bits_C & mask_C);
 176         IOE = (IOE & ~mask_E) | (bit_E & mask_E);
 177
 178         return TRUE;
 179 }
 180
 181 /**
 182  * Each LSB in the nibble of the byte controls the coupling per channel.
 183  *
 184  * Setting PE3 disables AC coupling capacitor on CH0.
 185  * Setting PE0 disables AC coupling capacitor on CH1.
 186  */
 187 static void set_coupling(BYTE coupling_cfg)
 188 {
 189         if (coupling_cfg & 0x01)
 190                 IOE |= 0x08;
 191         else
 192                 IOE &= ~0x08;
 193
 194         if (coupling_cfg & 0x10)
 195                 IOE |= 0x01;
 196         else
 197                 IOE &= ~0x01;
 198 }
 199
 200 static BOOL set_numchannels(BYTE numchannels)
 201 {
 202         if (numchannels == 1 || numchannels == 2) {
 203                 BYTE fifocfg = 7 + numchannels;
 204                 EP2FIFOCFG = fifocfg;
 205                 EP6FIFOCFG = fifocfg;
 206                 return TRUE;
 207         }
 208
 209         return FALSE;
 210 }
 211
 212 static void clear_fifo(void)
 213 {
 214         GPIFABORT = 0xff;
 215         SYNCDELAY3;
 216         FIFORESET = 0x80;
 217         SYNCDELAY3;
 218         FIFORESET = 0x82;
 219         SYNCDELAY3;
 220         FIFORESET = 0x86;
 221         SYNCDELAY3;
 222         FIFORESET = 0;
 223 }
 224
 225 static void stop_sampling(void)
 226 {
 227         GPIFABORT = 0xff;
 228         SYNCDELAY3;
 229         INPKTEND = (altiface == 0) ? 6 : 2;
 230 }
 231
 232 static void start_sampling(void)
 233 {
 234         int i;
 235
 236         SET_ANALOG_MODE();
 237
 238         clear_fifo();
 239
 240         for (i = 0; i < 1000; i++);
 241
 242         while (!(GPIFTRIG & 0x80))
 243                 ;
 244
 245         SYNCDELAY3;
 246         GPIFTCB1 = 0x28;
 247         SYNCDELAY3;
 248         GPIFTCB0 = 0;
 249         GPIFTRIG = (altiface == 0) ? 6 : 4;
 250
 251         /* Set green LED, don't clear LED afterwards (ledcounter = 0). */
 252         LED_GREEN();
 253         ledcounter = 0;
 254 }
 255
 256 static void select_interface(BYTE alt)
 257 {
 258         const BYTE *pPacketSize = \
 259                 ((USBCS & bmHSM) ? &highspd_dscr : &fullspd_dscr)
 260                 + (9 + (16 * alt) + 9 + 4);
 261
 262         altiface = alt;
 263
 264         if (alt == 0) {
 265                 /* Bulk on EP6. */
 266                 EP2CFG = 0x00;
 267                 EP6CFG = 0xe0;
 268                 EP6GPIFFLGSEL = 1;
 269                 EP6AUTOINLENL = pPacketSize[0];
 270                 EP6AUTOINLENH = pPacketSize[1];
 271         } else {
 272                 /* Iso on EP2. */
 273                 EP2CFG = 0xd8;
 274                 EP6CFG = 0x00;
 275                 EP2GPIFFLGSEL = 1;
 276                 EP2AUTOINLENL = pPacketSize[0];
 277                 EP2AUTOINLENH = pPacketSize[1] & 0x7;
 278                 EP2ISOINPKTS = (pPacketSize[1] >> 3) + 1;
 279         }
 280 }
 281
 282 static const struct samplerate_info {
 283         BYTE rate;
 284         BYTE wait0;
 285         BYTE wait1;
 286         BYTE opc0;
 287         BYTE opc1;
 288         BYTE out0;
 289         BYTE ifcfg;
 290 } samplerates[] = {
 291         { 48, 0x80,   0, 3, 0, 0x00, 0xea },
 292         { 30, 0x80,   0, 3, 0, 0x00, 0xaa },
 293         { 24,    1,   0, 2, 1, OUT0, 0xea },
 294         { 16,    1,   1, 2, 0, OUT0, 0xea },
 295         { 15,    1,   0, 2, 1, OUT0, 0xaa },
 296         { 12,    2,   1, 2, 0, OUT0, 0xea },
 297         { 11,    1,   1, 2, 0, OUT0, 0xaa },
 298         {  8,    3,   2, 2, 0, OUT0, 0xea },
 299         {  6,    2,   2, 2, 0, OUT0, 0xaa },
 300         {  5,    3,   2, 2, 0, OUT0, 0xaa },
 301         {  4,    6,   5, 2, 0, OUT0, 0xea },
 302         {  3,    5,   4, 2, 0, OUT0, 0xaa },
 303         {  2,   12,  11, 2, 0, OUT0, 0xea },
 304         {  1,   24,  23, 2, 0, OUT0, 0xea },
 305         { 50,   48,  47, 2, 0, OUT0, 0xea },
 306         { 20,  120, 119, 2, 0, OUT0, 0xea },
 307         { 10,  240, 239, 2, 0, OUT0, 0xea },
 308 };
 309
 310 static BOOL set_samplerate(BYTE rate)
 311 {
 312         BYTE i = 0;
 313
 314         while (samplerates[i].rate != rate) {
 315                 i++;
 316                 if (i == sizeof(samplerates) / sizeof(samplerates[0]))
 317                         return FALSE;
 318         }
 319
 320         IFCONFIG = samplerates[i].ifcfg;
 321
 322         AUTOPTRSETUP = 7;
 323         AUTOPTRH2 = 0xE4; /* 0xE400: GPIF waveform descriptor 0. */
 324         AUTOPTRL2 = 0x00;
 325
 326         /*
 327          * The program for low-speed, e.g. 1 MHz, is:
 328          * wait 24, CTLx=0, FIFO
 329          * wait 23, CTLx=1
 330          * jump 0, CTLx=1
 331          *
 332          * The program for 24 MHz is:
 333          * wait 1, CTLx=0, FIFO
 334          * jump 0, CTLx=1
 335          *
 336          * The program for 30/48 MHz is:
 337          * jump 0, CTLx=Z, FIFO, LOOP
 338          *
 339          * (CTLx is device-dependent, could be e.g. CTL0 or CTL2.)
 340          */
 341
 342         /* LENGTH / BRANCH 0-7 */
 343         EXTAUTODAT2 = samplerates[i].wait0;
 344         EXTAUTODAT2 = samplerates[i].wait1;
 345         EXTAUTODAT2 = 1;
 346         EXTAUTODAT2 = 0;
 347         EXTAUTODAT2 = 0;
 348         EXTAUTODAT2 = 0;
 349         EXTAUTODAT2 = 0;
 350         EXTAUTODAT2 = 0;
 351
 352         /* OPCODE 0-7 */
 353         EXTAUTODAT2 = samplerates[i].opc0;
 354         EXTAUTODAT2 = samplerates[i].opc1;
 355         EXTAUTODAT2 = 1; /* DATA=0 DP=1 */
 356         EXTAUTODAT2 = 0;
 357         EXTAUTODAT2 = 0;
 358         EXTAUTODAT2 = 0;
 359         EXTAUTODAT2 = 0;
 360         EXTAUTODAT2 = 0;
 361
 362         /* OUTPUT 0-7 */
 363         EXTAUTODAT2 = samplerates[i].out0;
 364         EXTAUTODAT2 = OE_CTL;
 365         EXTAUTODAT2 = OE_CTL;
 366         EXTAUTODAT2 = 0;
 367         EXTAUTODAT2 = 0;
 368         EXTAUTODAT2 = 0;
 369         EXTAUTODAT2 = 0;
 370         EXTAUTODAT2 = 0;
 371
 372         /* LOGIC FUNCTION 0-7 */
 373         EXTAUTODAT2 = 0;
 374         EXTAUTODAT2 = 0;
 375         EXTAUTODAT2 = 0;
 376         EXTAUTODAT2 = 0;
 377         EXTAUTODAT2 = 0;
 378         EXTAUTODAT2 = 0;
 379         EXTAUTODAT2 = 0;
 380         EXTAUTODAT2 = 0;
 381
 382         for (i = 0; i < 96; i++)
 383                 EXTAUTODAT2 = 0;
 384
 385         return TRUE;
 386 }
 387
 388 static BOOL set_calibration_pulse(BYTE fs)
 389 {
 390         switch (fs) {
 391         case 0:         // 100Hz
 392                 RCAP2L = -10000 & 0xff;
 393                 RCAP2H = (-10000 & 0xff00) >> 8;
 394                 return TRUE;
 395         case 1:         // 1kHz
 396                 RCAP2L = -1000 & 0xff;
 397                 RCAP2H = (-1000 & 0xff00) >> 8;
 398                 return TRUE;
 399         case 10:        // 1kHz
 400                 RCAP2L = (BYTE)(-100 & 0xff);
 401                 RCAP2H = 0xff;
 402                 return TRUE;
 403         case 50:        // 50kHz
 404                 RCAP2L = (BYTE)(-20 & 0xff);
 405                 RCAP2H = 0xff;
 406                 return TRUE;
 407         default:
 408                 return FALSE;
 409         }
 410 }
 411
 412 /* Set *alt_ifc to the current alt interface for ifc. */
 413 BOOL handle_get_interface(BYTE ifc, BYTE *alt_ifc)
 414 {
 415         (void)ifc;
 416
 417         *alt_ifc = altiface;
 418
 419         return TRUE;
 420 }
 421
 422 /*
 423  * Return TRUE if you set the interface requested.
 424  *
 425  * Note: This function should reconfigure and reset the endpoints
 426  * according to the interface descriptors you provided.
 427  */
 428 BOOL handle_set_interface(BYTE ifc,BYTE alt_ifc)
 429 {
 430         if (ifc == 0)
 431                 select_interface(alt_ifc);
 432
 433         return TRUE;
 434 }
 435
 436 BYTE handle_get_configuration(void)
 437 {
 438         /* We only support configuration 0. */
 439         return 0;
 440 }
 441
 442 BOOL handle_set_configuration(BYTE cfg)
 443 {
 444         /* We only support configuration 0. */
 445         (void)cfg;
 446
 447         return TRUE;
 448 }
 449
 450 BOOL handle_vendorcommand(BYTE cmd)
 451 {
 452         stop_sampling();
 453
 454         /* Set red LED, clear after timeout. */
 455         LED_RED();
 456         ledcounter = 1000;
 457
 458         /* Clear EP0BCH/L for each valid command. */
 459         if (cmd >= 0xe0 && cmd <= 0xe6) {
 460                 EP0BCH = 0;
 461                 EP0BCL = 0;
 462                 while (EP0CS & bmEPBUSY);
 463         }
 464
 465         switch (cmd) {
 466         case 0xe0:
 467         case 0xe1:
 468                 set_voltage(cmd - 0xe0, EP0BUF[0]);
 469                 return TRUE;
 470         case 0xe2:
 471                 set_samplerate(EP0BUF[0]);
 472                 return TRUE;
 473         case 0xe3:
 474                 if (EP0BUF[0] == 1)
 475                         start_sampling();
 476                 return TRUE;
 477         case 0xe4:
 478                 set_numchannels(EP0BUF[0]);
 479                 return TRUE;
 480         case 0xe5:
 481                 SET_COUPLING(EP0BUF[0]);
 482                 return TRUE;
 483         case 0xe6:
 484                 SET_CALIBRATION_PULSE(EP0BUF[0]);
 485                 return TRUE;
 486         }
 487
 488         return FALSE; /* Not handled by handlers. */
 489 }
 490
 491 static void init(void)
 492 {
 493         EP4CFG = 0;
 494         EP8CFG = 0;
 495
 496         SET_ANALOG_MODE();
 497
 498         /* In idle mode tristate all outputs. */
 499         GPIFIDLECTL = 0x00; /* Don't enable CTL0-5 outputs. */
 500         GPIFCTLCFG = 0x80; /* TRICTL=1. CTL0-2: CMOS outputs, tri-statable. */
 501         GPIFWFSELECT = 0x00;
 502         GPIFREADYSTAT = 0x00;
 503
 504         stop_sampling();
 505
 506         set_voltage(0, 1);
 507         set_voltage(1, 1);
 508         set_samplerate(1);
 509         set_numchannels(2);
 510         select_interface(0);
 511 }
 512
 513 static void main(void)
 514 {
 515         /* Save energy. */
 516         SETCPUFREQ(CLK_12M);
 517
 518         init();
 519
 520         /* Set up interrupts. */
 521         USE_USB_INTS();
 522
 523         ENABLE_SUDAV();
 524         ENABLE_USBRESET();
 525         ENABLE_HISPEED();
 526         ENABLE_SUSPEND();
 527         ENABLE_RESUME();
 528
 529         /* Global (8051) interrupt enable. */
 530         EA = 1;
 531
 532         /* Init timer2. */
 533         RCAP2L = -1000 & 0xff;
 534         RCAP2H = (-1000 & 0xff00) >> 8;
 535         T2CON = 0;
 536         ET2 = 1;
 537         TR2 = 1;
 538
 539         RENUMERATE_UNCOND();
 540
 541         PORTECFG = 0;
 542         PORTCCFG = 0;
 543         PORTACFG = 0;
 544         OEE = 0xff;
 545         OEC = 0xff;
 546         OEA = 0xff;
 547
 548         SET_ANALOG_MODE();
 549
 550         while (TRUE) {
 551                 if (dosud) {
 552                         dosud = FALSE;
 553                         handle_setupdata();
 554                 }
 555
 556                 if (dosuspend) {
 557                         dosuspend = FALSE;
 558                         do {
 559                                 /* Make sure ext wakeups are cleared. */
 560                                 WAKEUPCS |= bmWU | bmWU2;
 561                                 SUSPEND = 1;
 562                                 PCON |= 1;
 563                                 __asm
 564                                 nop
 565                                 nop
 566                                 nop
 567                                 nop
 568                                 nop
 569                                 nop
 570                                 nop
 571                                 __endasm;
 572                         } while (!remote_wakeup_allowed && REMOTE_WAKEUP());
 573
 574                         /* Resume (TRM 6.4). */
 575                         if (REMOTE_WAKEUP()) {
 576                                 delay(5);
 577                                 USBCS |= bmSIGRESUME;
 578                                 delay(15);
 579                                 USBCS &= ~bmSIGRESUME;
 580                         }
 581                 }
 582         }
 583 }