fx2lafw.c

   1 /*
   2  * This file is part of the sigrok-firmware-fx2lafw project.
   3  *
   4  * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   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 2 of the License, or
   9  * (at your option) any later version.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 /*
  21  * fx2lafw is an open-source firmware for Cypress FX2 based logic analyzers.
  22  *
  23  * It is written in C, using fx2lib as helper library, and sdcc as compiler.
  24  * The code is licensed under the terms of the GNU GPL, version 2 or later.
  25  *
  26  * Technical notes:
  27  *
  28  *  - We use the FX2 in GPIF mode to sample the data (asynchronously).
  29  *  - We use the internal 48MHz clock for GPIF.
  30  *  - The 8 channels/pins we sample (the GPIF data bus) are PB0-PB7,
  31  *    or PB0-PB7 + PD0-PD7 for 16-channel sampling.
  32  *  - Endpoint 2 (quad-buffered) is used for data transfers from FX2 to host.
  33  *
  34  * Documentation:
  35  *
  36  *  - See http://sigrok.org/wiki/Fx2lafw
  37  */
  38
  39 #include <fx2regs.h>
  40 #include <fx2macros.h>
  41 #include <fx2ints.h>
  42 #include <delay.h>
  43 #include <setupdat.h>
  44 #include <eputils.h>
  45 #include <gpif.h>
  46 #include <command.h>
  47 #include <fx2lafw.h>
  48 #include <gpif-acquisition.h>
  49
  50 /* ... */
  51 volatile __bit got_sud;
  52 BYTE vendor_command;
  53
  54 volatile WORD ledcounter = 0;
  55
  56 static void setup_endpoints(void)
  57 {
  58         /* Setup EP2 (IN). */
  59         EP2CFG = (1 << 7) |               /* EP is valid/activated */
  60                  (1 << 6) |               /* EP direction: IN */
  61                  (1 << 5) | (0 << 4) |    /* EP Type: bulk */
  62                  (1 << 3) |               /* EP buffer size: 1024 */
  63                  (0 << 2) |               /* Reserved. */
  64                  (0 << 1) | (0 << 0);     /* EP buffering: quad buffering */
  65         SYNCDELAY();
  66
  67         /* Disable all other EPs (EP1, EP4, EP6, and EP8). */
  68         EP1INCFG &= ~bmVALID;
  69         SYNCDELAY();
  70         EP1OUTCFG &= ~bmVALID;
  71         SYNCDELAY();
  72         EP4CFG &= ~bmVALID;
  73         SYNCDELAY();
  74         EP6CFG &= ~bmVALID;
  75         SYNCDELAY();
  76         EP8CFG &= ~bmVALID;
  77         SYNCDELAY();
  78
  79         /* EP2: Reset the FIFOs. */
  80         /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */
  81         RESETFIFO(0x02)
  82
  83         /* EP2: Enable AUTOIN mode. Set FIFO width to 8bits. */
  84         EP2FIFOCFG = bmAUTOIN;
  85         SYNCDELAY();
  86
  87         /* EP2: Auto-commit 512 (0x200) byte packets (due to AUTOIN = 1). */
  88         EP2AUTOINLENH = 0x02;
  89         SYNCDELAY();
  90         EP2AUTOINLENL = 0x00;
  91         SYNCDELAY();
  92
  93         /* EP2: Set the GPIF flag to 'full'. */
  94         EP2GPIFFLGSEL = (1 << 1) | (0 << 1);
  95         SYNCDELAY();
  96 }
  97
  98 static void send_fw_version(void)
  99 {
 100         /* Populate the buffer. */
 101         struct version_info *const vi = (struct version_info *)EP0BUF;
 102         vi->major = FX2LAFW_VERSION_MAJOR;
 103         vi->minor = FX2LAFW_VERSION_MINOR;
 104
 105         /* Send the message. */
 106         EP0BCH = 0;
 107         EP0BCL = sizeof(struct version_info);
 108 }
 109
 110 static void send_revid_version(void)
 111 {
 112         uint8_t *p;
 113
 114         /* Populate the buffer. */
 115         p = (uint8_t *)EP0BUF;
 116         *p = REVID;
 117
 118         /* Send the message. */
 119         EP0BCH = 0;
 120         EP0BCL = 1;
 121 }
 122
 123 BOOL handle_vendorcommand(BYTE cmd)
 124 {
 125         /* Protocol implementation */
 126         switch (cmd) {
 127         case CMD_START:
 128                 /* Tell hardware we are ready to receive data. */
 129                 vendor_command = cmd;
 130                 EP0BCL = 0;
 131                 return TRUE;
 132         case CMD_GET_FW_VERSION:
 133                 send_fw_version();
 134                 return TRUE;
 135         case CMD_GET_REVID_VERSION:
 136                 send_revid_version();
 137                 return TRUE;
 138         }
 139
 140         return FALSE;
 141 }
 142
 143 BOOL handle_get_interface(BYTE ifc, BYTE *alt_ifc)
 144 {
 145         /* We only support interface 0, alternate interface 0. */
 146         if (ifc != 0)
 147                 return FALSE;
 148
 149         *alt_ifc = 0;
 150         return TRUE;
 151 }
 152
 153 BOOL handle_set_interface(BYTE ifc, BYTE alt_ifc)
 154 {
 155         /* We only support interface 0, alternate interface 0. */
 156         if (ifc != 0 || alt_ifc != 0)
 157                 return FALSE;
 158
 159         /* Perform procedure from TRM, section 2.3.7: */
 160
 161         /* (1) TODO. */
 162
 163         /* (2) Reset data toggles of the EPs in the interface. */
 164         /* Note: RESETTOGGLE() gets the EP number WITH bit 7 set/cleared. */
 165         RESETTOGGLE(0x82);
 166
 167         /* (3) Restore EPs to their default conditions. */
 168         /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */
 169         RESETFIFO(0x02);
 170         /* TODO */
 171
 172         /* (4) Clear the HSNAK bit. Not needed, fx2lib does this. */
 173
 174         return TRUE;
 175 }
 176
 177 BYTE handle_get_configuration(void)
 178 {
 179         /* We only support configuration 1. */
 180         return 1;
 181 }
 182
 183 BOOL handle_set_configuration(BYTE cfg)
 184 {
 185         /* We only support configuration 1. */
 186         return (cfg == 1) ? TRUE : FALSE;
 187 }
 188
 189 void sudav_isr(void) __interrupt SUDAV_ISR
 190 {
 191         got_sud = TRUE;
 192         CLEAR_SUDAV();
 193 }
 194
 195 /* IN BULK NAK - the host started requesting data. */
 196 void ibn_isr(void) __interrupt IBN_ISR
 197 {
 198         /*
 199          * If the IBN interrupt is not disabled, clearing
 200          * does not work. See AN78446, 6.2.
 201          */
 202         BYTE ibnsave = IBNIE;
 203         IBNIE = 0;
 204         CLEAR_USBINT();
 205
 206         /*
 207          * If the host sent the START command, start the GPIF
 208          * engine. The host will repeat the BULK IN in the next
 209          * microframe.
 210          */
 211         if ((IBNIRQ & bmEP2IBN) && (gpif_acquiring == PREPARED)) {
 212                 ledcounter = 1;
 213                 PA1 = 0;
 214                 gpif_acquisition_start();
 215         }
 216
 217         /* Clear IBN flags for all EPs. */
 218         IBNIRQ = 0xff;
 219
 220         NAKIRQ = bmIBN;
 221         SYNCDELAY();
 222
 223         IBNIE = ibnsave;
 224         SYNCDELAY();
 225 }
 226
 227 void usbreset_isr(void) __interrupt USBRESET_ISR
 228 {
 229         handle_hispeed(FALSE);
 230         CLEAR_USBRESET();
 231 }
 232
 233 void hispeed_isr(void) __interrupt HISPEED_ISR
 234 {
 235         handle_hispeed(TRUE);
 236         CLEAR_HISPEED();
 237 }
 238
 239 void timer2_isr(void) __interrupt TF2_ISR
 240 {
 241         /* Blink LED during acquisition, keep it on otherwise. */
 242         if (gpif_acquiring == RUNNING) {
 243                 if (--ledcounter == 0) {
 244                         PA1 = !PA1;
 245                         ledcounter = 1000;
 246                 }
 247         } else if (gpif_acquiring == STOPPED) {
 248                 PA1 = 1; /* LED on. */
 249         }
 250         TF2 = 0;
 251 }
 252
 253 void fx2lafw_init(void)
 254 {
 255         /* Set DYN_OUT and ENH_PKT bits, as recommended by the TRM. */
 256         REVCTL = bmNOAUTOARM | bmSKIPCOMMIT;
 257
 258         got_sud = FALSE;
 259         vendor_command = 0;
 260
 261         /* Renumerate. */
 262         RENUMERATE_UNCOND();
 263
 264         SETCPUFREQ(CLK_48M);
 265
 266         USE_USB_INTS();
 267
 268         /* TODO: Does the order of the following lines matter? */
 269         ENABLE_SUDAV();
 270         ENABLE_EP2IBN();
 271         ENABLE_HISPEED();
 272         ENABLE_USBRESET();
 273
 274         /* PA1 (LED) is an output. */
 275         PORTACFG = 0;
 276         OEA = (1 << 1);
 277         PA1 = 1; /* LED on. */
 278
 279         /* Init timer2. */
 280         RCAP2L = -500 & 0xff;
 281         RCAP2H = (-500 & 0xff00) >> 8;
 282         T2CON = 0;
 283         ET2 = 1;
 284         TR2 = 1;
 285
 286         /* Global (8051) interrupt enable. */
 287         EA = 1;
 288
 289         /* Setup the endpoints. */
 290         setup_endpoints();
 291
 292         /* Put the FX2 into GPIF master mode and setup the GPIF. */
 293         gpif_init_la();
 294 }
 295
 296 void fx2lafw_poll(void)
 297 {
 298         if (got_sud) {
 299                 handle_setupdata();
 300                 got_sud = FALSE;
 301         }
 302
 303         if (vendor_command) {
 304                 switch (vendor_command) {
 305                 case CMD_START:
 306                         if ((EP0CS & bmEPBUSY) != 0)
 307                                 break;
 308
 309                         if (EP0BCL == sizeof(struct cmd_start_acquisition)) {
 310                                 gpif_acquisition_prepare(
 311                                  (const struct cmd_start_acquisition *)EP0BUF);
 312                         }
 313
 314                         /* Acknowledge the vendor command. */
 315                         vendor_command = 0;
 316                         break;
 317                 default:
 318                         /* Unimplemented command. */
 319                         vendor_command = 0;
 320                         break;
 321                 }
 322         }
 323
 324         gpif_poll();
 325 }
 326
 327 void main(void)
 328 {
 329         fx2lafw_init();
 330         while (1)
 331                 fx2lafw_poll();
 332 }