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