]> sigrok.org Git - sigrok-firmware-fx2lafw.git/blob - gpif-acquisition.c
dbf740366f1a31d7003984ba2adaae653eb2983a
[sigrok-firmware-fx2lafw.git] / gpif-acquisition.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  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
20  */
21
22 #include <eputils.h>
23 #include <fx2regs.h>
24 #include <fx2macros.h>
25 #include <delay.h>
26 #include <gpif.h>
27 #include <fx2lafw.h>
28 #include <gpif-acquisition.h>
29
30 __bit gpif_acquiring;
31
32 static void gpif_reset_waveforms(void)
33 {
34         int i;
35
36         /* Reset WAVEDATA. */
37         AUTOPTRSETUP = 0x03;
38         AUTOPTRH1 = 0xe4;
39         AUTOPTRL1 = 0x00;
40         for (i = 0; i < 128; i++)
41                 EXTAUTODAT1 = 0;
42 }
43
44 static void gpif_setup_registers(void)
45 {
46         /* TODO. Value probably irrelevant, as we don't use RDY* signals? */
47         GPIFREADYCFG = 0;
48
49         /*
50          * Set TRICTL = 0, thus CTL0-CTL5 are CMOS outputs.
51          * TODO: Probably irrelevant, as we don't use CTL0-CTL5?
52          */
53         GPIFCTLCFG = 0;
54
55         /* When GPIF is idle, tri-state the data bus. */
56         /* Bit 7: DONE, bit 0: IDLEDRV. TODO: Set/clear DONE bit? */
57         GPIFIDLECS = (0 << 0);
58
59         /* When GPIF is idle, set CTL0-CTL5 to 0. */
60         GPIFIDLECTL = 0;
61
62         /*
63          * Map index 0 in WAVEDATA to FIFORD. The rest is assigned too,
64          * but not used by us.
65          *
66          * GPIFWFSELECT: [7:6] = SINGLEWR index, [5:4] = SINGLERD index,
67          *               [3:2] = FIFOWR index, [1:0] = FIFORD index
68          */
69         GPIFWFSELECT = (0x3 << 6) | (0x2 << 4) | (0x1 << 2) | (0x0 << 0);
70
71         /* Contains RDY* pin values. Read-only according to TRM. */
72         GPIFREADYSTAT = 0;
73
74         /* Make GPIF stop on transaction count not flag. */
75         EP2GPIFPFSTOP = (0 << 0);
76 }
77
78 static void gpif_init_addr_pins(void)
79 {
80         /*
81          * Configure the 9 GPIF address pins (GPIFADR[8:0], which consist of
82          * PORTC[7:0] and PORTE[7]), and output an initial address (zero).
83          * TODO: Probably irrelevant, the 56pin FX2 has no ports C and E.
84          */
85         PORTCCFG = 0xff;    /* Set PORTC[7:0] as alt. func. (GPIFADR[7:0]). */
86         OEC = 0xff;         /* Configure PORTC[7:0] as outputs. */
87         PORTECFG |= 0x80;   /* Set PORTE[7] as alt. func. (GPIFADR[8]). */
88         OEE |= 0x80;        /* Configure PORTE[7] as output. */
89         SYNCDELAY();
90         GPIFADRL = 0x00;    /* Clear GPIFADR[7:0]. */
91         SYNCDELAY();
92         GPIFADRH = 0x00;    /* Clear GPIFADR[8]. */
93 }
94
95 static void gpif_init_flowstates(void)
96 {
97         /* Clear all flowstate registers, we don't use this functionality. */
98         FLOWSTATE = 0;
99         FLOWLOGIC = 0;
100         FLOWEQ0CTL = 0;
101         FLOWEQ1CTL = 0;
102         FLOWHOLDOFF = 0;
103         FLOWSTB = 0;
104         FLOWSTBEDGE = 0;
105         FLOWSTBHPERIOD = 0;
106 }
107
108 void gpif_init_la(void)
109 {
110         /*
111          * Setup the FX2 in GPIF master mode, using the internal clock
112          * (non-inverted) at 48MHz, and using async sampling.
113          */
114         IFCONFIG = 0xee;
115
116         /* Abort currently executing GPIF waveform (if any). */
117         GPIFABORT = 0xff;
118
119         /* Setup the GPIF registers. */
120         gpif_setup_registers();
121
122         /* Reset WAVEDATA. */
123         gpif_reset_waveforms();
124
125         /* Initialize GPIF address pins, output initial values. */
126         gpif_init_addr_pins();
127
128         /* Initialize flowstate registers (not used by us). */
129         gpif_init_flowstates();
130
131         /* Reset the status. */
132         gpif_acquiring = FALSE;
133 }
134
135 static void gpif_make_delay_state(volatile BYTE *pSTATE, uint8_t delay, uint8_t output)
136 {
137         /*
138          * DELAY
139          * Delay cmd->sample_delay clocks.
140          */
141         pSTATE[0] = delay;
142
143         /*
144          * OPCODE
145          * SGL=0, GIN=0, INCAD=0, NEXT=0, DATA=0, DP=0
146          */
147         pSTATE[8] = 0;
148
149         /*
150          * OUTPUT
151          * CTL[0:5]=output
152          */
153         pSTATE[16] = output;
154
155         /*
156          * LOGIC FUNCTION
157          * Not used.
158          */
159         pSTATE[24] = 0x00;
160 }
161
162 static void gpif_make_data_dp_state(volatile BYTE *pSTATE)
163 {
164         /*
165          * BRANCH
166          * Branch to IDLE if condition is true, back to S0 otherwise.
167          */
168         pSTATE[0] = (7 << 3) | (0 << 0);
169
170         /*
171          * OPCODE
172          * SGL=0, GIN=0, INCAD=0, NEXT=0, DATA=1, DP=1
173          */
174         pSTATE[8] = (1 << 1) | (1 << 0);
175
176         /*
177          * OUTPUT
178          * CTL[0:5]=0
179          */
180         pSTATE[16] = 0x00;
181
182         /*
183          * LOGIC FUNCTION
184          * Evaluate if the FIFO full flag is set.
185          * LFUNC=0 (AND), TERMA=6 (FIFO Flag), TERMB=6 (FIFO Flag)
186          */
187         pSTATE[24] = (6 << 3) | (6 << 0);
188 }
189
190 bool gpif_acquisition_start(const struct cmd_start_acquisition *cmd)
191 {
192         int i;
193         volatile BYTE *pSTATE = &GPIF_WAVE_DATA;
194
195         /* Ensure GPIF is idle before reconfiguration. */
196         while (!(GPIFTRIG & 0x80));
197
198         /* Configure the EP2 FIFO. */
199         if (cmd->flags & CMD_START_FLAGS_SAMPLE_16BIT) {
200                 EP2FIFOCFG = bmAUTOIN | bmWORDWIDE;
201         } else {
202                 EP2FIFOCFG = bmAUTOIN;
203         }
204         SYNCDELAY();
205
206         /* Set IFCONFIG to the correct clock source. */
207         if (cmd->flags & CMD_START_FLAGS_CLK_48MHZ) {
208                 IFCONFIG = bmIFCLKSRC | bm3048MHZ | bmIFCLKOE | bmASYNC |
209                            bmGSTATE | bmIFGPIF;
210         } else {
211                 IFCONFIG = bmIFCLKSRC | bmIFCLKOE | bmASYNC |
212                            bmGSTATE | bmIFGPIF;
213         }
214
215         /* Populate delay states */
216         if ((cmd->sample_delay_h == 0 && cmd->sample_delay_l == 0) ||
217             cmd->sample_delay_h >= 6)
218                 return false;
219
220         if (cmd->flags & CMD_START_FLAGS_CLK_CTL2) {
221                 uint8_t delay_1, delay_2 = cmd->sample_delay_l;
222
223                 /* We need a pulse where the CTL1 and CTL2 pins
224                  * alternate states */
225                 if (cmd->sample_delay_h) {
226                         for (i = 0; i < cmd->sample_delay_h; i++)
227                                 gpif_make_delay_state(pSTATE++, 0, 0x06);
228                 } else {
229                         delay_1 = delay_2 / 2;
230                         delay_2 -= delay_1;
231                         gpif_make_delay_state(pSTATE++, delay_1, 0x06);
232                 }
233
234                 /* cmd->sample_delay_l is always non-zero for the
235                  * supported rates */
236                 gpif_make_delay_state(pSTATE++, delay_2, 0x00);
237         } else {
238                 for (i = 0; i < cmd->sample_delay_h; i++)
239                         gpif_make_delay_state(pSTATE++, 0, 0x00);
240
241                 if (cmd->sample_delay_l != 0)
242                         gpif_make_delay_state(pSTATE++, cmd->sample_delay_l, 0x00);
243         }
244
245         /* Populate S1 - the decision point. */
246         gpif_make_data_dp_state(pSTATE++);
247
248         /* Execute the whole GPIF waveform once. */
249         gpif_set_tc16(1);
250
251         /* Perform the initial GPIF read. */
252         gpif_fifo_read(GPIF_EP2);
253
254         /* Update the status. */
255         gpif_acquiring = TRUE;
256
257         return true;
258 }
259
260 void gpif_poll(void)
261 {
262         /* Detect if acquisition has completed. */
263         if (gpif_acquiring && (GPIFTRIG & 0x80)) {
264                 /* Activate NAK-ALL to avoid race conditions. */
265                 FIFORESET = 0x80;
266                 SYNCDELAY();
267
268                 /* Switch to manual mode. */
269                 EP2FIFOCFG = 0;
270                 SYNCDELAY();
271
272                 /* Reset EP2. */
273                 FIFORESET = 0x02;
274                 SYNCDELAY();
275
276                 /* Return to auto mode. */
277                 EP2FIFOCFG = bmAUTOIN;
278                 SYNCDELAY();
279
280                 /* Release NAK-ALL. */
281                 FIFORESET = 0x00;
282                 SYNCDELAY();
283
284                 gpif_acquiring = FALSE;
285         }
286 }