2 * This file is part of the fx2lafw project.
4 * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
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.
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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * fx2lafw is an open-source firmware for Cypress FX2 based logic analyzers.
24 * It is written in C, using fx2lib as helper library, and sdcc as compiler.
25 * The code is licensed under the terms of the GNU GPL, version 2 or later.
29 * - We use the FX2 in GPIF mode to sample the data (asynchronously).
30 * - We use the internal 48MHz clock for GPIF.
31 * - The 8 channels/pins we sample (the GPIF data bus) are PB0-PB7.
32 * Support for 16 channels is not yet included, but might be added later.
33 * - Endpoint 2 is used for data transfers from FX2 to host.
34 * - The endpoint is quad-buffered.
38 * - See http://sigrok.org/wiki/Fx2lafw
42 #include <fx2macros.h>
49 #include <gpif-acquisition.h>
51 /* Protocol commands */
52 #define CMD_START 0xb0
54 #define CMD_GET_FW_VERSION 0xb2
59 static void setup_endpoints(void)
62 EP2CFG = (1 << 7) | /* EP is valid/activated */
63 (1 << 6) | /* EP direction: IN */
64 (1 << 5) | (0 << 4) | /* EP Type: bulk */
65 (0 << 3) | /* EP buffer size: 512 */
66 (0 << 2) | /* Reserved. */
67 (0 << 1) | (0 << 0); /* EP buffering: quad buffering */
70 /* Setup EP6 (IN) in the debug build. */
72 EP6CFG = (1 << 7) | /* EP is valid/activated */
73 (1 << 6) | /* EP direction: IN */
74 (1 << 5) | (0 << 4) | /* EP Type: bulk */
75 (0 << 3) | /* EP buffer size: 512 */
76 (0 << 2) | /* Reserved */
77 (1 << 1) | (0 << 0); /* EP buffering: double buffering */
83 /* Disable all other EPs (EP1, EP4, and EP8). */
86 EP1OUTCFG &= ~bmVALID;
93 /* EP2: Reset the FIFOs. */
94 /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */
97 /* Reset the FIFOs of EP6 when in debug mode. */
101 /* EP2: Enable AUTOIN mode. Set FIFO width to 8bits. */
102 EP2FIFOCFG = bmAUTOIN | ~bmWORDWIDE;
105 /* EP2: Auto-commit 512 (0x200) byte packets (due to AUTOIN = 1). */
106 EP2AUTOINLENH = 0x02;
108 EP2AUTOINLENL = 0x00;
111 /* EP2: Set the GPIF flag to 'full'. */
112 EP2GPIFFLGSEL = (1 << 1) | (0 << 1);
116 BOOL handle_vendorcommand(BYTE cmd)
118 /* Protocol implementation */
122 gpif_acquisition_start();
129 case CMD_GET_FW_VERSION:
133 /* Unimplemented command. */
140 BOOL handle_get_interface(BYTE ifc, BYTE *alt_ifc)
142 /* We only support interface 0, alternate interface 0. */
150 BOOL handle_set_interface(BYTE ifc, BYTE alt_ifc)
152 /* We only support interface 0, alternate interface 0. */
153 if (ifc != 0 || alt_ifc != 0)
156 /* Perform procedure from TRM, section 2.3.7: */
160 /* (2) Reset data toggles of the EPs in the interface. */
161 /* Note: RESETTOGGLE() gets the EP number WITH bit 7 set/cleared. */
167 /* (3) Restore EPs to their default conditions. */
168 /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */
175 /* (4) Clear the HSNAK bit. Not needed, fx2lib does this. */
180 BYTE handle_get_configuration(void)
182 /* We only support configuration 1. */
186 BOOL handle_set_configuration(BYTE cfg)
188 /* We only support configuration 1. */
189 return (cfg == 1) ? TRUE : FALSE;
192 void sudav_isr(void) interrupt SUDAV_ISR
198 void sof_isr(void) interrupt SOF_ISR using 1
203 void usbreset_isr(void) interrupt USBRESET_ISR
205 handle_hispeed(FALSE);
209 void hispeed_isr(void) interrupt HISPEED_ISR
211 handle_hispeed(TRUE);
215 void fx2lafw_init(void)
217 /* Set DYN_OUT and ENH_PKT bits, as recommended by the TRM. */
218 REVCTL = bmNOAUTOARM | bmSKIPCOMMIT;
229 /* TODO: Does the order of the following lines matter? */
235 /* Global (8051) interrupt enable. */
238 /* Setup the endpoints. */
241 /* Put the FX2 into GPIF master mode and setup the GPIF. */
245 void fx2lafw_run(void)