]>
Commit | Line | Data |
---|---|---|
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, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | */ | |
20 | ||
21 | /* | |
22 | * fx2lafw is an open-source firmware for Cypress FX2 based logic analyzers. | |
23 | * | |
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. | |
26 | * | |
27 | * Technical notes: | |
28 | * | |
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 | * or PB0-PB7 + PD0-PD7 for 16-channel sampling. | |
33 | * - Endpoint 2 (quad-buffered) is used for data transfers from FX2 to host. | |
34 | * | |
35 | * Documentation: | |
36 | * | |
37 | * - See http://sigrok.org/wiki/Fx2lafw | |
38 | */ | |
39 | ||
40 | #include <fx2regs.h> | |
41 | #include <fx2macros.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 | static void setup_endpoints(void) | |
55 | { | |
56 | /* Setup EP2 (IN). */ | |
57 | EP2CFG = (1 << 7) | /* EP is valid/activated */ | |
58 | (1 << 6) | /* EP direction: IN */ | |
59 | (1 << 5) | (0 << 4) | /* EP Type: bulk */ | |
60 | (1 << 3) | /* EP buffer size: 1024 */ | |
61 | (0 << 2) | /* Reserved. */ | |
62 | (0 << 1) | (0 << 0); /* EP buffering: quad buffering */ | |
63 | SYNCDELAY(); | |
64 | ||
65 | /* Disable all other EPs (EP1, EP4, EP6, and EP8). */ | |
66 | EP1INCFG &= ~bmVALID; | |
67 | SYNCDELAY(); | |
68 | EP1OUTCFG &= ~bmVALID; | |
69 | SYNCDELAY(); | |
70 | EP4CFG &= ~bmVALID; | |
71 | SYNCDELAY(); | |
72 | EP6CFG &= ~bmVALID; | |
73 | SYNCDELAY(); | |
74 | EP8CFG &= ~bmVALID; | |
75 | SYNCDELAY(); | |
76 | ||
77 | /* EP2: Reset the FIFOs. */ | |
78 | /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */ | |
79 | RESETFIFO(0x02) | |
80 | ||
81 | /* EP2: Enable AUTOIN mode. Set FIFO width to 8bits. */ | |
82 | EP2FIFOCFG = bmAUTOIN; | |
83 | SYNCDELAY(); | |
84 | ||
85 | /* EP2: Auto-commit 512 (0x200) byte packets (due to AUTOIN = 1). */ | |
86 | EP2AUTOINLENH = 0x02; | |
87 | SYNCDELAY(); | |
88 | EP2AUTOINLENL = 0x00; | |
89 | SYNCDELAY(); | |
90 | ||
91 | /* EP2: Set the GPIF flag to 'full'. */ | |
92 | EP2GPIFFLGSEL = (1 << 1) | (0 << 1); | |
93 | SYNCDELAY(); | |
94 | } | |
95 | ||
96 | static void send_fw_version(void) | |
97 | { | |
98 | /* Populate the buffer. */ | |
99 | struct version_info *const vi = (struct version_info *)EP0BUF; | |
100 | vi->major = FX2LAFW_VERSION_MAJOR; | |
101 | vi->minor = FX2LAFW_VERSION_MINOR; | |
102 | ||
103 | /* Send the message. */ | |
104 | EP0BCH = 0; | |
105 | EP0BCL = sizeof(struct version_info); | |
106 | } | |
107 | ||
108 | static void send_revid_version(void) | |
109 | { | |
110 | uint8_t *p; | |
111 | ||
112 | /* Populate the buffer. */ | |
113 | p = (uint8_t *)EP0BUF; | |
114 | *p = REVID; | |
115 | ||
116 | /* Send the message. */ | |
117 | EP0BCH = 0; | |
118 | EP0BCL = 1; | |
119 | } | |
120 | ||
121 | BOOL handle_vendorcommand(BYTE cmd) | |
122 | { | |
123 | /* Protocol implementation */ | |
124 | switch (cmd) { | |
125 | case CMD_START: | |
126 | vendor_command = cmd; | |
127 | EP0BCL = 0; | |
128 | return TRUE; | |
129 | break; | |
130 | case CMD_GET_FW_VERSION: | |
131 | send_fw_version(); | |
132 | return TRUE; | |
133 | break; | |
134 | case CMD_GET_REVID_VERSION: | |
135 | send_revid_version(); | |
136 | return TRUE; | |
137 | break; | |
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 | void sof_isr(void) __interrupt SOF_ISR __using 1 | |
196 | { | |
197 | CLEAR_SOF(); | |
198 | } | |
199 | ||
200 | void usbreset_isr(void) __interrupt USBRESET_ISR | |
201 | { | |
202 | handle_hispeed(FALSE); | |
203 | CLEAR_USBRESET(); | |
204 | } | |
205 | ||
206 | void hispeed_isr(void) __interrupt HISPEED_ISR | |
207 | { | |
208 | handle_hispeed(TRUE); | |
209 | CLEAR_HISPEED(); | |
210 | } | |
211 | ||
212 | void fx2lafw_init(void) | |
213 | { | |
214 | /* Set DYN_OUT and ENH_PKT bits, as recommended by the TRM. */ | |
215 | REVCTL = bmNOAUTOARM | bmSKIPCOMMIT; | |
216 | ||
217 | got_sud = FALSE; | |
218 | vendor_command = 0; | |
219 | ||
220 | /* Renumerate. */ | |
221 | RENUMERATE_UNCOND(); | |
222 | ||
223 | SETCPUFREQ(CLK_48M); | |
224 | ||
225 | USE_USB_INTS(); | |
226 | ||
227 | /* TODO: Does the order of the following lines matter? */ | |
228 | ENABLE_SUDAV(); | |
229 | ENABLE_SOF(); | |
230 | ENABLE_HISPEED(); | |
231 | ENABLE_USBRESET(); | |
232 | ||
233 | /* Global (8051) interrupt enable. */ | |
234 | EA = 1; | |
235 | ||
236 | /* Setup the endpoints. */ | |
237 | setup_endpoints(); | |
238 | ||
239 | /* Put the FX2 into GPIF master mode and setup the GPIF. */ | |
240 | gpif_init_la(); | |
241 | } | |
242 | ||
243 | void fx2lafw_poll(void) | |
244 | { | |
245 | if (got_sud) { | |
246 | handle_setupdata(); | |
247 | got_sud = FALSE; | |
248 | } | |
249 | ||
250 | if (vendor_command) { | |
251 | switch (vendor_command) { | |
252 | case CMD_START: | |
253 | if ((EP0CS & bmEPBUSY) != 0) | |
254 | break; | |
255 | ||
256 | if (EP0BCL == sizeof(struct cmd_start_acquisition)) { | |
257 | gpif_acquisition_start( | |
258 | (const struct cmd_start_acquisition *)EP0BUF); | |
259 | } | |
260 | ||
261 | /* Acknowledge the vendor command. */ | |
262 | vendor_command = 0; | |
263 | break; | |
264 | default: | |
265 | /* Unimplemented command. */ | |
266 | vendor_command = 0; | |
267 | break; | |
268 | } | |
269 | } | |
270 | ||
271 | gpif_poll(); | |
272 | } | |
273 | ||
274 | void main(void) | |
275 | { | |
276 | fx2lafw_init(); | |
277 | while (1) | |
278 | fx2lafw_poll(); | |
279 | } |