2 * This file is part of the sigrok-firmware-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, see <http://www.gnu.org/licenses/>.
21 * fx2lafw is an open-source firmware for Cypress FX2 based logic analyzers.
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.
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.
36 * - See http://sigrok.org/wiki/Fx2lafw
40 #include <fx2macros.h>
47 #include <gpif-acquisition.h>
50 volatile __bit got_sud;
53 static void setup_endpoints(void)
56 EP2CFG = (1 << 7) | /* EP is valid/activated */
57 (1 << 6) | /* EP direction: IN */
58 (1 << 5) | (0 << 4) | /* EP Type: bulk */
59 (1 << 3) | /* EP buffer size: 1024 */
60 (0 << 2) | /* Reserved. */
61 (0 << 1) | (0 << 0); /* EP buffering: quad buffering */
64 /* Disable all other EPs (EP1, EP4, EP6, and EP8). */
67 EP1OUTCFG &= ~bmVALID;
76 /* EP2: Reset the FIFOs. */
77 /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */
80 /* EP2: Enable AUTOIN mode. Set FIFO width to 8bits. */
81 EP2FIFOCFG = bmAUTOIN;
84 /* EP2: Auto-commit 512 (0x200) byte packets (due to AUTOIN = 1). */
90 /* EP2: Set the GPIF flag to 'full'. */
91 EP2GPIFFLGSEL = (1 << 1) | (0 << 1);
95 static void send_fw_version(void)
97 /* Populate the buffer. */
98 struct version_info *const vi = (struct version_info *)EP0BUF;
99 vi->major = FX2LAFW_VERSION_MAJOR;
100 vi->minor = FX2LAFW_VERSION_MINOR;
102 /* Send the message. */
104 EP0BCL = sizeof(struct version_info);
107 static void send_revid_version(void)
111 /* Populate the buffer. */
112 p = (uint8_t *)EP0BUF;
115 /* Send the message. */
120 BOOL handle_vendorcommand(BYTE cmd)
122 /* Protocol implementation */
125 vendor_command = cmd;
129 case CMD_GET_FW_VERSION:
133 case CMD_GET_REVID_VERSION:
134 send_revid_version();
142 BOOL handle_get_interface(BYTE ifc, BYTE *alt_ifc)
144 /* We only support interface 0, alternate interface 0. */
152 BOOL handle_set_interface(BYTE ifc, BYTE alt_ifc)
154 /* We only support interface 0, alternate interface 0. */
155 if (ifc != 0 || alt_ifc != 0)
158 /* Perform procedure from TRM, section 2.3.7: */
162 /* (2) Reset data toggles of the EPs in the interface. */
163 /* Note: RESETTOGGLE() gets the EP number WITH bit 7 set/cleared. */
166 /* (3) Restore EPs to their default conditions. */
167 /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */
171 /* (4) Clear the HSNAK bit. Not needed, fx2lib does this. */
176 BYTE handle_get_configuration(void)
178 /* We only support configuration 1. */
182 BOOL handle_set_configuration(BYTE cfg)
184 /* We only support configuration 1. */
185 return (cfg == 1) ? TRUE : FALSE;
188 void sudav_isr(void) __interrupt SUDAV_ISR
194 void sof_isr(void) __interrupt SOF_ISR __using 1
199 void usbreset_isr(void) __interrupt USBRESET_ISR
201 handle_hispeed(FALSE);
205 void hispeed_isr(void) __interrupt HISPEED_ISR
207 handle_hispeed(TRUE);
211 void fx2lafw_init(void)
213 /* Set DYN_OUT and ENH_PKT bits, as recommended by the TRM. */
214 REVCTL = bmNOAUTOARM | bmSKIPCOMMIT;
226 /* TODO: Does the order of the following lines matter? */
232 /* Global (8051) interrupt enable. */
235 /* Setup the endpoints. */
238 /* Put the FX2 into GPIF master mode and setup the GPIF. */
242 void fx2lafw_poll(void)
249 if (vendor_command) {
250 switch (vendor_command) {
252 if ((EP0CS & bmEPBUSY) != 0)
255 if (EP0BCL == sizeof(struct cmd_start_acquisition)) {
256 gpif_acquisition_start(
257 (const struct cmd_start_acquisition *)EP0BUF);
260 /* Acknowledge the vendor command. */
264 /* Unimplemented command. */