]>
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, 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 <delay.h> | |
42 | #include <setupdat.h> | |
43 | #include <eputils.h> | |
44 | #include <gpif.h> | |
45 | #include <command.h> | |
46 | #include <fx2lafw.h> | |
47 | #include <gpif-acquisition.h> | |
48 | ||
49 | /* ... */ | |
50 | volatile __bit got_sud; | |
51 | BYTE vendor_command; | |
52 | ||
53 | static void setup_endpoints(void) | |
54 | { | |
55 | /* Setup EP2 (IN). */ | |
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 */ | |
62 | SYNCDELAY(); | |
63 | ||
64 | /* Disable all other EPs (EP1, EP4, EP6, and EP8). */ | |
65 | EP1INCFG &= ~bmVALID; | |
66 | SYNCDELAY(); | |
67 | EP1OUTCFG &= ~bmVALID; | |
68 | SYNCDELAY(); | |
69 | EP4CFG &= ~bmVALID; | |
70 | SYNCDELAY(); | |
71 | EP6CFG &= ~bmVALID; | |
72 | SYNCDELAY(); | |
73 | EP8CFG &= ~bmVALID; | |
74 | SYNCDELAY(); | |
75 | ||
76 | /* EP2: Reset the FIFOs. */ | |
77 | /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */ | |
78 | RESETFIFO(0x02) | |
79 | ||
80 | /* EP2: Enable AUTOIN mode. Set FIFO width to 8bits. */ | |
81 | EP2FIFOCFG = bmAUTOIN; | |
82 | SYNCDELAY(); | |
83 | ||
84 | /* EP2: Auto-commit 512 (0x200) byte packets (due to AUTOIN = 1). */ | |
85 | EP2AUTOINLENH = 0x02; | |
86 | SYNCDELAY(); | |
87 | EP2AUTOINLENL = 0x00; | |
88 | SYNCDELAY(); | |
89 | ||
90 | /* EP2: Set the GPIF flag to 'full'. */ | |
91 | EP2GPIFFLGSEL = (1 << 1) | (0 << 1); | |
92 | SYNCDELAY(); | |
93 | } | |
94 | ||
95 | static void send_fw_version(void) | |
96 | { | |
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; | |
101 | ||
102 | /* Send the message. */ | |
103 | EP0BCH = 0; | |
104 | EP0BCL = sizeof(struct version_info); | |
105 | } | |
106 | ||
107 | static void send_revid_version(void) | |
108 | { | |
109 | uint8_t *p; | |
110 | ||
111 | /* Populate the buffer. */ | |
112 | p = (uint8_t *)EP0BUF; | |
113 | *p = REVID; | |
114 | ||
115 | /* Send the message. */ | |
116 | EP0BCH = 0; | |
117 | EP0BCL = 1; | |
118 | } | |
119 | ||
120 | BOOL handle_vendorcommand(BYTE cmd) | |
121 | { | |
122 | /* Protocol implementation */ | |
123 | switch (cmd) { | |
124 | case CMD_START: | |
125 | vendor_command = cmd; | |
126 | EP0BCL = 0; | |
127 | return TRUE; | |
128 | break; | |
129 | case CMD_GET_FW_VERSION: | |
130 | send_fw_version(); | |
131 | return TRUE; | |
132 | break; | |
133 | case CMD_GET_REVID_VERSION: | |
134 | send_revid_version(); | |
135 | return TRUE; | |
136 | break; | |
137 | } | |
138 | ||
139 | return FALSE; | |
140 | } | |
141 | ||
142 | BOOL handle_get_interface(BYTE ifc, BYTE *alt_ifc) | |
143 | { | |
144 | /* We only support interface 0, alternate interface 0. */ | |
145 | if (ifc != 0) | |
146 | return FALSE; | |
147 | ||
148 | *alt_ifc = 0; | |
149 | return TRUE; | |
150 | } | |
151 | ||
152 | BOOL handle_set_interface(BYTE ifc, BYTE alt_ifc) | |
153 | { | |
154 | /* We only support interface 0, alternate interface 0. */ | |
155 | if (ifc != 0 || alt_ifc != 0) | |
156 | return FALSE; | |
157 | ||
158 | /* Perform procedure from TRM, section 2.3.7: */ | |
159 | ||
160 | /* (1) TODO. */ | |
161 | ||
162 | /* (2) Reset data toggles of the EPs in the interface. */ | |
163 | /* Note: RESETTOGGLE() gets the EP number WITH bit 7 set/cleared. */ | |
164 | RESETTOGGLE(0x82); | |
165 | ||
166 | /* (3) Restore EPs to their default conditions. */ | |
167 | /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */ | |
168 | RESETFIFO(0x02); | |
169 | /* TODO */ | |
170 | ||
171 | /* (4) Clear the HSNAK bit. Not needed, fx2lib does this. */ | |
172 | ||
173 | return TRUE; | |
174 | } | |
175 | ||
176 | BYTE handle_get_configuration(void) | |
177 | { | |
178 | /* We only support configuration 1. */ | |
179 | return 1; | |
180 | } | |
181 | ||
182 | BOOL handle_set_configuration(BYTE cfg) | |
183 | { | |
184 | /* We only support configuration 1. */ | |
185 | return (cfg == 1) ? TRUE : FALSE; | |
186 | } | |
187 | ||
188 | void sudav_isr(void) __interrupt SUDAV_ISR | |
189 | { | |
190 | got_sud = TRUE; | |
191 | CLEAR_SUDAV(); | |
192 | } | |
193 | ||
194 | void sof_isr(void) __interrupt SOF_ISR __using 1 | |
195 | { | |
196 | CLEAR_SOF(); | |
197 | } | |
198 | ||
199 | void usbreset_isr(void) __interrupt USBRESET_ISR | |
200 | { | |
201 | handle_hispeed(FALSE); | |
202 | CLEAR_USBRESET(); | |
203 | } | |
204 | ||
205 | void hispeed_isr(void) __interrupt HISPEED_ISR | |
206 | { | |
207 | handle_hispeed(TRUE); | |
208 | CLEAR_HISPEED(); | |
209 | } | |
210 | ||
211 | void fx2lafw_init(void) | |
212 | { | |
213 | /* Set DYN_OUT and ENH_PKT bits, as recommended by the TRM. */ | |
214 | REVCTL = bmNOAUTOARM | bmSKIPCOMMIT; | |
215 | ||
216 | got_sud = FALSE; | |
217 | vendor_command = 0; | |
218 | ||
219 | /* Renumerate. */ | |
220 | RENUMERATE_UNCOND(); | |
221 | ||
222 | SETCPUFREQ(CLK_48M); | |
223 | ||
224 | USE_USB_INTS(); | |
225 | ||
226 | /* TODO: Does the order of the following lines matter? */ | |
227 | ENABLE_SUDAV(); | |
228 | ENABLE_SOF(); | |
229 | ENABLE_HISPEED(); | |
230 | ENABLE_USBRESET(); | |
231 | ||
232 | /* Global (8051) interrupt enable. */ | |
233 | EA = 1; | |
234 | ||
235 | /* Setup the endpoints. */ | |
236 | setup_endpoints(); | |
237 | ||
238 | /* Put the FX2 into GPIF master mode and setup the GPIF. */ | |
239 | gpif_init_la(); | |
240 | } | |
241 | ||
242 | void fx2lafw_poll(void) | |
243 | { | |
244 | if (got_sud) { | |
245 | handle_setupdata(); | |
246 | got_sud = FALSE; | |
247 | } | |
248 | ||
249 | if (vendor_command) { | |
250 | switch (vendor_command) { | |
251 | case CMD_START: | |
252 | if ((EP0CS & bmEPBUSY) != 0) | |
253 | break; | |
254 | ||
255 | if (EP0BCL == sizeof(struct cmd_start_acquisition)) { | |
256 | gpif_acquisition_start( | |
257 | (const struct cmd_start_acquisition *)EP0BUF); | |
258 | } | |
259 | ||
260 | /* Acknowledge the vendor command. */ | |
261 | vendor_command = 0; | |
262 | break; | |
263 | default: | |
264 | /* Unimplemented command. */ | |
265 | vendor_command = 0; | |
266 | break; | |
267 | } | |
268 | } | |
269 | ||
270 | gpif_poll(); | |
271 | } | |
272 | ||
273 | void main(void) | |
274 | { | |
275 | fx2lafw_init(); | |
276 | while (1) | |
277 | fx2lafw_poll(); | |
278 | } |