e2c162113e97e266d72228d8bb3e7e7de5025aeb
[debian/gnuradio] / usrp2 / firmware / apps / txrx.c
1 /*
2  * Copyright 2007,2008 Free Software Foundation, Inc.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 #ifdef HAVE_CONFIG_H
19 #include "config.h"
20 #endif
21
22 #include "u2_init.h"
23 #include "memory_map.h"
24 #include "spi.h"
25 #include "hal_io.h"
26 #include "buffer_pool.h"
27 #include "pic.h"
28 #include "bool.h"
29 #include "ethernet.h"
30 #include "nonstdio.h"
31 #include "usrp2_eth_packet.h"
32 #include "dbsm.h"
33 #include "app_common_v2.h"
34 #include "memcpy_wa.h"
35 #include <stddef.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include "clocks.h"
39
40 #define FW_SETS_SEQNO   1       // define to 0 or 1 (FIXME must be 1 for now)
41
42 #if (FW_SETS_SEQNO)
43 static int fw_seqno;    // used when f/w is filling in sequence numbers
44 #endif
45
46
47 /*
48  * Full duplex Tx and Rx between ethernet and DSP pipelines
49  *
50  * Buffer 1 is used by the cpu to send frames to the host.
51  * Buffers 2 and 3 are used to double-buffer the DSP Rx to eth flow
52  * Buffers 4 and 5 are used to double-buffer the eth to DSP Tx  eth flow
53  */
54 //#define CPU_RX_BUF    0       // eth -> cpu
55
56 #define DSP_RX_BUF_0    2       // dsp rx -> eth (double buffer)
57 #define DSP_RX_BUF_1    3       // dsp rx -> eth
58 #define DSP_TX_BUF_0    4       // eth -> dsp tx (double buffer)
59 #define DSP_TX_BUF_1    5       // eth -> dsp tx
60
61 /*
62  * ================================================================
63  *   configure DSP TX double buffering state machine (eth -> dsp)
64  * ================================================================
65  */
66
67 // 4 lines of ethernet hdr + 1 line transport hdr + 2 lines (word0 + timestamp)
68 // DSP Tx reads word0 (flags) + timestamp followed by samples
69
70 #define DSP_TX_FIRST_LINE ((sizeof(u2_eth_hdr_t) + sizeof(u2_transport_hdr_t))/4)
71
72 // Receive from ethernet
73 buf_cmd_args_t dsp_tx_recv_args = {
74   PORT_ETH,
75   0,
76   BP_LAST_LINE
77 };
78
79 // send to DSP Tx
80 buf_cmd_args_t dsp_tx_send_args = {
81   PORT_DSP,
82   DSP_TX_FIRST_LINE,    // starts just past transport header
83   0                     // filled in from last_line register
84 };
85
86 dbsm_t dsp_tx_sm;       // the state machine
87
88 /*
89  * ================================================================
90  *   configure DSP RX double buffering state machine (dsp -> eth)
91  * ================================================================
92  */
93
94 // 4 lines of ethernet hdr + 1 line transport hdr + 1 line (word0)
95 // DSP Rx writes timestamp followed by nlines_per_frame of samples
96 #define DSP_RX_FIRST_LINE ((sizeof(u2_eth_hdr_t) + sizeof(u2_transport_hdr_t))/4 + 1)
97
98 // receive from DSP
99 buf_cmd_args_t dsp_rx_recv_args = {
100   PORT_DSP,
101   DSP_RX_FIRST_LINE,
102   BP_LAST_LINE
103 };
104
105 // send to ETH
106 buf_cmd_args_t dsp_rx_send_args = {
107   PORT_ETH,
108   0,            // starts with ethernet header in line 0
109   0,            // filled in from list_line register
110 };
111
112 dbsm_t dsp_rx_sm;       // the state machine
113
114
115 // The mac address of the host we're sending to.
116 u2_mac_addr_t host_mac_addr;
117
118
119 // variables for streaming mode
120
121 static bool         streaming_p = false;
122 static unsigned int streaming_items_per_frame = 0;
123 static int          streaming_frame_count = 0;
124 #define FRAMES_PER_CMD  1000
125
126
127 // ----------------------------------------------------------------
128
129
130 static void
131 restart_streaming(void)
132 {
133   // setup RX DSP regs
134   dsp_rx_regs->clear_state = 1;                 // reset
135
136   streaming_p = true;
137   streaming_frame_count = FRAMES_PER_CMD;
138
139   dsp_rx_regs->rx_command =
140     MK_RX_CMD(FRAMES_PER_CMD * streaming_items_per_frame,
141               streaming_items_per_frame,
142               1, 1);                    // set "chain" bit
143
144   // kick off the state machine
145   dbsm_start(&dsp_rx_sm);
146
147   dsp_rx_regs->rx_time = 0;             // enqueue first of two commands
148
149   // make sure this one and the rest have the "now" and "chain" bits set.
150   dsp_rx_regs->rx_command =
151     MK_RX_CMD(FRAMES_PER_CMD * streaming_items_per_frame,
152               streaming_items_per_frame,
153               1, 1);                            
154
155   dsp_rx_regs->rx_time = 0;             // enqueue second command
156 }
157
158 void
159 start_rx_streaming_cmd(const u2_mac_addr_t *host, op_start_rx_streaming_t *p)
160 {
161   host_mac_addr = *host;        // remember who we're sending to
162
163   /*
164    * Construct  ethernet header and word0 and preload into two buffers
165    */
166   u2_eth_packet_t       pkt;
167   memset(&pkt, 0, sizeof(pkt));
168   pkt.ehdr.dst = *host;
169   pkt.ehdr.ethertype = U2_ETHERTYPE;
170   u2p_set_word0(&pkt.fixed, 0, 0);
171   // DSP RX will fill in timestamp
172
173   memcpy_wa(buffer_ram(DSP_RX_BUF_0), &pkt, sizeof(pkt));
174   memcpy_wa(buffer_ram(DSP_RX_BUF_1), &pkt, sizeof(pkt));
175
176
177   if (FW_SETS_SEQNO)
178     fw_seqno = 0;
179
180   streaming_items_per_frame = p->items_per_frame;
181   restart_streaming();
182 }
183
184
185 void
186 stop_rx_cmd(void)
187 {
188   streaming_p = false;
189   dsp_rx_regs->clear_state = 1; // flush cmd queue
190   bp_clear_buf(DSP_RX_BUF_0);
191   bp_clear_buf(DSP_RX_BUF_1);
192 }
193
194
195 static void
196 setup_tx()
197 {
198   dsp_tx_regs->clear_state = 1;
199   bp_clear_buf(DSP_TX_BUF_0);
200   bp_clear_buf(DSP_TX_BUF_1);
201
202   int tx_scale = 256;
203   int interp = 32;
204
205   // setup some defaults
206
207   dsp_tx_regs->freq = 0;
208   dsp_tx_regs->scale_iq = (tx_scale << 16) | tx_scale;
209   dsp_tx_regs->interp_rate = interp;
210 }
211
212
213 #if (FW_SETS_SEQNO)
214 /*
215  * Debugging ONLY.  This will be handled by the tx_protocol_engine.
216  *
217  * This is called when the DSP Rx chain has filled in a packet.
218  * We set and increment the seqno, then return false, indicating
219  * that we didn't handle the packet.  A bit of a kludge
220  * but it should work.
221  */
222 bool 
223 fw_sets_seqno_inspector(dbsm_t *sm, int buf_this)       // returns false
224 {
225   uint32_t *p = buffer_ram(buf_this);
226   uint32_t seqno = fw_seqno++;
227
228   // KLUDGE all kinds of nasty magic numbers and embedded knowledge
229   uint32_t t = p[4];
230   t = (t & 0xffff00ff) | ((seqno & 0xff) << 8);
231   p[4] = t;
232
233   // queue up another rx command when required
234   if (streaming_p && --streaming_frame_count == 0){
235     streaming_frame_count = FRAMES_PER_CMD;
236     dsp_rx_regs->rx_time = 0;
237   }
238
239   return false;         // we didn't handle the packet
240 }
241 #endif
242
243
244 inline static void
245 buffer_irq_handler(unsigned irq)
246 {
247   uint32_t  status = buffer_pool_status->status;
248
249   dbsm_process_status(&dsp_tx_sm, status);
250   dbsm_process_status(&dsp_rx_sm, status);
251 }
252
253 int
254 main(void)
255 {
256   u2_init();
257
258   putstr("\nTxRx\n");
259   print_mac_addr(ethernet_mac_addr()->addr);
260   newline();
261
262   ethernet_register_link_changed_callback(link_changed_callback);
263   ethernet_init();
264
265
266 #if 0
267   // make bit 15 of Tx gpio's be a s/w output
268   hal_gpio_set_sel(GPIO_TX_BANK, 15, 's');
269   hal_gpio_set_ddr(GPIO_TX_BANK, 0x8000, 0x8000);
270 #endif
271
272   output_regs->debug_mux_ctrl = 1;
273 #if 0
274   hal_gpio_set_sels(GPIO_TX_BANK, "1111111111111111");
275   hal_gpio_set_sels(GPIO_RX_BANK, "1111111111111111");
276   hal_gpio_set_ddr(GPIO_TX_BANK, 0xffff, 0xffff);
277   hal_gpio_set_ddr(GPIO_RX_BANK, 0xffff, 0xffff);
278 #endif
279
280
281   // initialize double buffering state machine for ethernet -> DSP Tx
282
283   dbsm_init(&dsp_tx_sm, DSP_TX_BUF_0,
284             &dsp_tx_recv_args, &dsp_tx_send_args,
285             eth_pkt_inspector);
286
287
288   // initialize double buffering state machine for DSP RX -> Ethernet
289
290   if (FW_SETS_SEQNO){
291     dbsm_init(&dsp_rx_sm, DSP_RX_BUF_0,
292               &dsp_rx_recv_args, &dsp_rx_send_args,
293               fw_sets_seqno_inspector);
294   }
295   else {
296     dbsm_init(&dsp_rx_sm, DSP_RX_BUF_0,
297               &dsp_rx_recv_args, &dsp_rx_send_args,
298               dbsm_nop_inspector);
299   }
300
301   // tell app_common that this dbsm could be sending to the ethernet
302   ac_could_be_sending_to_eth = &dsp_rx_sm;
303
304
305   // program tx registers
306   setup_tx();
307
308   // kick off the state machine
309   dbsm_start(&dsp_tx_sm);
310
311   //int which = 0;
312
313   while(1){
314     // hal_gpio_write(GPIO_TX_BANK, which, 0x8000);
315     // which ^= 0x8000;
316
317     buffer_irq_handler(0);
318
319     int pending = pic_regs->pending;            // poll for under or overrun
320
321     if (pending & PIC_UNDERRUN_INT){
322       dbsm_handle_tx_underrun(&dsp_tx_sm);
323       pic_regs->pending = PIC_UNDERRUN_INT;     // clear interrupt
324       putchar('U');
325     }
326
327     if (pending & PIC_OVERRUN_INT){
328       dbsm_handle_rx_overrun(&dsp_rx_sm);
329       pic_regs->pending = PIC_OVERRUN_INT;      // clear pending interrupt
330
331       // FIXME Figure out how to handle this robustly.
332       // Any buffers that are emptying should be allowed to drain...
333
334       if (streaming_p){
335         // restart_streaming();
336         // FIXME report error
337       }
338       else {
339         // FIXME report error
340       }
341       putchar('O');
342     }
343   }
344 }