a8d7b92701b7c7980ffa10aa8dd2f14b8a15692e
[debian/gnuradio] / usrp2 / firmware / apps / app_common_v2.c
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007,2008 Free Software Foundation, Inc.
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #ifdef HAVE_CONFIG_H
20 #include "config.h"
21 #endif
22
23 #include "app_common_v2.h"
24 #include "buffer_pool.h"
25 #include "memcpy_wa.h"
26 #include "ethernet.h"
27 #include "nonstdio.h"
28 #include "print_rmon_regs.h"
29 #include "db.h"
30 #include "db_base.h"
31 #include "clocks.h"
32 #include "u2_init.h"
33 #include <string.h>
34
35 volatile bool link_is_up = false;       // eth handler sets this
36 int cpu_tx_buf_dest_port = PORT_ETH;
37
38 // If this is non-zero, this dbsm could be writing to the ethernet
39 dbsm_t *ac_could_be_sending_to_eth;
40
41 static unsigned char exp_seqno __attribute__((unused)) = 0;
42
43
44 static bool
45 burn_mac_addr(const op_burn_mac_addr_t *p)
46 {
47   return ethernet_set_mac_addr(&p->addr);
48 }
49
50 static bool
51 config_mimo_cmd(const op_config_mimo_t *p)
52 {
53   clocks_mimo_config(p->flags);
54   return true;
55 }
56
57 void
58 set_reply_hdr(u2_eth_packet_t *reply_pkt, u2_eth_packet_t const *cmd_pkt)
59 {
60   reply_pkt->ehdr.dst = cmd_pkt->ehdr.src;
61   reply_pkt->ehdr.ethertype = U2_ETHERTYPE;
62   reply_pkt->thdr.flags = 0;
63   reply_pkt->thdr.fifo_status = 0;      // written by protocol engine
64   reply_pkt->thdr.seqno = 0;            // written by protocol engine
65   reply_pkt->thdr.ack = 0;              // written by protocol engine
66   u2p_set_word0(&reply_pkt->fixed, 0, CONTROL_CHAN);
67   reply_pkt->fixed.timestamp = timer_regs->time;
68 }
69
70 static void
71 send_reply(unsigned char *reply, size_t reply_len)
72 {
73   if (reply_len < 64)
74     reply_len = 64;
75
76   // wait for buffer to become idle
77   hal_set_leds(0x4, 0x4);
78   while((buffer_pool_status->status & BPS_IDLE(CPU_TX_BUF)) == 0)
79     ;
80   hal_set_leds(0x0, 0x4);
81
82   // copy reply into CPU_TX_BUF
83   memcpy_wa(buffer_ram(CPU_TX_BUF), reply, reply_len);
84
85   // wait until nobody else is sending to the ethernet
86   if (ac_could_be_sending_to_eth){
87     hal_set_leds(0x8, 0x8);
88     dbsm_wait_for_opening(ac_could_be_sending_to_eth);
89     hal_set_leds(0x0, 0x8);
90   }
91
92   if (0){
93     printf("sending_reply to port %d, len = %d\n", cpu_tx_buf_dest_port, reply_len);
94     print_buffer(buffer_ram(CPU_TX_BUF), reply_len/4);
95   }
96
97   // fire it off
98   bp_send_from_buf(CPU_TX_BUF, cpu_tx_buf_dest_port, 1, 0, reply_len/4);
99
100   // wait for it to complete (not long, it's a small pkt)
101   while((buffer_pool_status->status & (BPS_DONE(CPU_TX_BUF) | BPS_ERROR(CPU_TX_BUF))) == 0)
102     ;
103
104   bp_clear_buf(CPU_TX_BUF);
105 }
106
107
108 static size_t
109 op_id_cmd(const op_generic_t *p,
110           void *reply_payload, size_t reply_payload_space)
111 {
112   op_id_reply_t *r = (op_id_reply_t *) reply_payload;
113   if (reply_payload_space < sizeof(*r)) // no room
114     return 0;
115
116   // Build reply subpacket
117
118   r->opcode = OP_ID_REPLY;
119   r->len = sizeof(op_id_reply_t);
120   r->rid = p->rid;
121   r->addr = *ethernet_mac_addr();
122   r->hw_rev = (u2_hw_rev_major << 8) | u2_hw_rev_minor;
123   // r->fpga_md5sum = ; // FIXME
124   // r->sw_md5sum = ;   // FIXME
125
126   return r->len;
127 }
128
129
130 static size_t
131 config_tx_v2_cmd(const op_config_tx_v2_t *p,
132                  void *reply_payload, size_t reply_payload_space)
133 {
134   op_config_tx_reply_v2_t *r = (op_config_tx_reply_v2_t *) reply_payload;
135   if (reply_payload_space < sizeof(*r))
136     return 0;                                   // no room
137
138   struct tune_result    tune_result;
139   memset(&tune_result, 0, sizeof(tune_result));
140
141   bool ok = true;
142   
143   if (p->valid & CFGV_GAIN){
144     ok &= db_set_gain(tx_dboard, p->gain);
145   }
146
147   if (p->valid & CFGV_FREQ){
148     u2_fxpt_freq_t f = u2_fxpt_freq_from_hilo(p->freq_hi, p->freq_lo);
149     bool tune_ok = db_tune(tx_dboard, f, &tune_result);
150     ok &= tune_ok;
151     print_tune_result("Tx", tune_ok, f, &tune_result);
152   }
153
154   if (p->valid & CFGV_INTERP_DECIM){
155     int interp = p->interp;
156     int hb1 = 0;
157     int hb2 = 0;
158
159     if (!(interp & 1)){
160       hb2 = 1;
161       interp = interp >> 1;
162     }
163
164     if (!(interp & 1)){
165       hb1 = 1;
166       interp = interp >> 1;
167     }
168     
169     if (p->interp < MIN_INTERP || p->interp > MAX_INTERP)
170       ok = false;
171     else {
172       dsp_tx_regs->interp_rate = (hb1<<9) | (hb2<<8) | interp;
173       // printf("Interp: %d, register %d\n", p->interp, (hb1<<9) | (hb2<<8) | interp);
174     }
175   }
176
177   if (p->valid & CFGV_SCALE_IQ){
178     dsp_tx_regs->scale_iq = p->scale_iq;
179   }
180
181   // Build reply subpacket
182
183   r->opcode = OP_CONFIG_TX_REPLY_V2;
184   r->len = sizeof(*r);
185   r->rid = p->rid;
186   r->ok = ok;
187   r->inverted = tune_result.inverted;
188   r->baseband_freq_hi = u2_fxpt_freq_hi(tune_result.baseband_freq);
189   r->baseband_freq_lo = u2_fxpt_freq_lo(tune_result.baseband_freq);
190   r->duc_freq_hi = u2_fxpt_freq_hi(tune_result.dxc_freq);
191   r->duc_freq_lo = u2_fxpt_freq_lo(tune_result.dxc_freq);
192   r->residual_freq_hi = u2_fxpt_freq_hi(tune_result.residual_freq);
193   r->residual_freq_lo = u2_fxpt_freq_lo(tune_result.residual_freq);
194   return r->len;
195 }
196
197 static size_t
198 config_rx_v2_cmd(const op_config_rx_v2_t *p, 
199                  void *reply_payload, size_t reply_payload_space)
200 {
201   op_config_rx_reply_v2_t *r = (op_config_rx_reply_v2_t *) reply_payload;
202   if (reply_payload_space < sizeof(*r))
203     return 0;                           // no room
204
205   struct tune_result    tune_result;
206   memset(&tune_result, 0, sizeof(tune_result));
207
208   bool ok = true;
209   
210   if (p->valid & CFGV_GAIN){
211     ok &= db_set_gain(rx_dboard, p->gain);
212   }
213
214   if (p->valid & CFGV_FREQ){
215     u2_fxpt_freq_t f = u2_fxpt_freq_from_hilo(p->freq_hi, p->freq_lo);
216     bool tune_ok = db_tune(rx_dboard, f, &tune_result);
217     ok &= tune_ok;
218     print_tune_result("Rx", tune_ok, f, &tune_result);
219   }
220
221   if (p->valid & CFGV_INTERP_DECIM){
222     int decim = p->decim;
223     int hb1 = 0;
224     int hb2 = 0;
225     
226     if(!(decim & 1)) {
227       hb2 = 1;
228       decim = decim >> 1;
229     }
230     
231     if(!(decim & 1)) {
232       hb1 = 1;
233       decim = decim >> 1;
234     }
235     
236     if (decim < MIN_DECIM || decim > MAX_DECIM)
237       ok = false;
238     else {
239       dsp_rx_regs->decim_rate = (hb1<<9) | (hb2<<8) | decim;
240       // printf("Decim: %d, register %d\n", p->decim, (hb1<<9) | (hb2<<8) | decim);
241     }
242   }
243
244   if (p->valid & CFGV_SCALE_IQ){
245     dsp_rx_regs->scale_iq = p->scale_iq;
246   }
247
248   // Build reply subpacket
249
250   r->opcode = OP_CONFIG_RX_REPLY_V2;
251   r->len = sizeof(*r);
252   r->rid = p->rid;
253   r->ok = ok;
254   r->inverted = tune_result.inverted;
255   r->baseband_freq_hi = u2_fxpt_freq_hi(tune_result.baseband_freq);
256   r->baseband_freq_lo = u2_fxpt_freq_lo(tune_result.baseband_freq);
257   r->ddc_freq_hi = u2_fxpt_freq_hi(tune_result.dxc_freq);
258   r->ddc_freq_lo = u2_fxpt_freq_lo(tune_result.dxc_freq);
259   r->residual_freq_hi = u2_fxpt_freq_hi(tune_result.residual_freq);
260   r->residual_freq_lo = u2_fxpt_freq_lo(tune_result.residual_freq);
261
262   return r->len;
263 }
264
265 static size_t
266 read_time_cmd(const op_generic_t *p,
267               void *reply_payload, size_t reply_payload_space)
268 {
269   op_read_time_reply_t *r = (op_read_time_reply_t *) reply_payload;
270   if (reply_payload_space < sizeof(*r))         
271     return 0;                                   // no room
272
273   r->opcode = OP_READ_TIME_REPLY;
274   r->len = sizeof(*r);
275   r->rid = p->rid;
276   r->time = timer_regs->time;
277
278   return r->len;
279 }
280
281 static void
282 fill_db_info(u2_db_info_t *p, const struct db_base *db)
283 {
284   p->dbid = db->dbid;
285   p->freq_min_hi = u2_fxpt_freq_hi(db->freq_min);
286   p->freq_min_lo = u2_fxpt_freq_lo(db->freq_min);
287   p->freq_max_hi = u2_fxpt_freq_hi(db->freq_max);
288   p->freq_max_lo = u2_fxpt_freq_lo(db->freq_max);
289   p->gain_min = db->gain_min;
290   p->gain_max = db->gain_max;
291   p->gain_step_size = db->gain_step_size;
292 }
293
294 static size_t
295 dboard_info_cmd(const op_generic_t *p,
296                 void *reply_payload, size_t reply_payload_space)
297 {
298   op_dboard_info_reply_t *r = (op_dboard_info_reply_t *) reply_payload;
299   if (reply_payload_space < sizeof(*r))         
300     return 0;                                   // no room
301
302   r->opcode = OP_DBOARD_INFO_REPLY;
303   r->len = sizeof(*r);
304   r->rid = p->rid;
305   r->ok = true;
306
307   fill_db_info(&r->tx_db_info, tx_dboard);
308   fill_db_info(&r->rx_db_info, rx_dboard);
309
310   return r->len;
311 }
312
313 static size_t
314 generic_reply(const op_generic_t *p,
315               void *reply_payload, size_t reply_payload_space,
316               bool ok)
317 {
318   op_generic_t *r = (op_generic_t *) reply_payload;
319   if (reply_payload_space < sizeof(*r))         
320     return 0;                                   // no room
321
322   r->opcode = p->opcode | OP_REPLY_BIT;
323   r->len = sizeof(*r);
324   r->rid = p->rid;
325   r->ok = ok;
326
327   return r->len;
328 }
329
330 static size_t
331 add_eop(void *reply_payload, size_t reply_payload_space)
332 {
333   op_generic_t *r = (op_generic_t *) reply_payload;
334   if (reply_payload_space < sizeof(*r))         
335     return 0;                                   // no room
336
337   r->opcode = OP_EOP;
338   r->len = sizeof(*r);
339   r->rid = 0;
340   r->ok =  0;
341
342   return r->len;
343 }
344
345 void
346 handle_control_chan_frame(u2_eth_packet_t *pkt, size_t len)
347 {
348   unsigned char reply[sizeof(u2_eth_packet_t) + 4 * sizeof(u2_subpkt_t)] _AL4;
349   unsigned char *reply_payload = &reply[sizeof(u2_eth_packet_t)];
350   int reply_payload_space = sizeof(reply) - sizeof(u2_eth_packet_t);
351
352   // initialize reply
353   memset(reply, 0, sizeof(reply));
354   set_reply_hdr((u2_eth_packet_t *) reply, pkt);
355
356   // point to beginning of payload (subpackets)
357   unsigned char *payload = ((unsigned char *) pkt) + sizeof(u2_eth_packet_t);
358   int payload_len = len - sizeof(u2_eth_packet_t);
359
360   size_t subpktlen = 0;
361
362   while (payload_len >= sizeof(op_generic_t)){
363     const op_generic_t *gp = (const op_generic_t *) payload;
364     subpktlen = 0;
365
366     switch(gp->opcode){
367     case OP_EOP:                // end of subpackets
368       goto end_of_subpackets;
369
370     case OP_ID:
371       subpktlen = op_id_cmd(gp, reply_payload, reply_payload_space);
372       break;
373     
374     case OP_CONFIG_TX_V2:
375       subpktlen = config_tx_v2_cmd((op_config_tx_v2_t *) payload,
376                                    reply_payload, reply_payload_space);
377       break;
378
379     case OP_CONFIG_RX_V2:
380       subpktlen = config_rx_v2_cmd((op_config_rx_v2_t *) payload,
381                                    reply_payload, reply_payload_space);
382       break;
383
384     case OP_START_RX_STREAMING:
385       start_rx_streaming_cmd(&pkt->ehdr.src, (op_start_rx_streaming_t *) payload);
386       subpktlen = generic_reply(gp, reply_payload, reply_payload_space, true);
387       break;
388     
389     case OP_STOP_RX:
390       stop_rx_cmd();
391       subpktlen = generic_reply(gp, reply_payload, reply_payload_space, true);
392       break;
393     
394     case OP_BURN_MAC_ADDR:
395       subpktlen = generic_reply(gp, reply_payload, reply_payload_space,
396                                 burn_mac_addr((op_burn_mac_addr_t *) payload));
397       break;
398
399     case OP_CONFIG_MIMO:
400       subpktlen = generic_reply(gp, reply_payload, reply_payload_space,
401                                 config_mimo_cmd((op_config_mimo_t *) payload));
402       break;
403
404     case OP_READ_TIME:
405       subpktlen = read_time_cmd(gp, reply_payload, reply_payload_space);
406       break;
407
408     case OP_DBOARD_INFO:
409       subpktlen = dboard_info_cmd(gp, reply_payload, reply_payload_space);
410       break;
411
412     default:
413       printf("app_common_v2: unhandled opcode = %d\n", gp->opcode);
414       break;
415     }
416
417     int t = (gp->len + 3) & ~3;         // bump to a multiple of 4
418     payload += t;
419     payload_len -= t;
420
421     subpktlen = (subpktlen + 3) & ~3;   // bump to a multiple of 4
422     reply_payload += subpktlen;
423     reply_payload_space -= subpktlen;
424   }
425
426  end_of_subpackets:
427
428   // add the EOP marker
429   subpktlen = add_eop(reply_payload, reply_payload_space);
430   subpktlen = (subpktlen + 3) & ~3;     // bump to a multiple of 4
431   reply_payload += subpktlen;
432   reply_payload_space -= subpktlen;
433
434   send_reply(reply, reply_payload - reply);
435 }
436
437
438 /*
439  * Called when an ethernet packet is received.
440  * Return true if we handled it here, otherwise
441  * it'll be passed on to the DSP Tx pipe
442  */
443 bool
444 eth_pkt_inspector(dbsm_t *sm, int bufno)
445 {
446   u2_eth_packet_t *pkt = (u2_eth_packet_t *) buffer_ram(bufno);
447   size_t byte_len = (buffer_pool_status->last_line[bufno] - 3) * 4;
448
449   //static size_t last_len = 0;
450
451   // hal_toggle_leds(0x1);
452
453   // inspect rcvd frame and figure out what do do.
454
455   if (pkt->ehdr.ethertype != U2_ETHERTYPE)
456     return true;        // ignore, probably bogus PAUSE frame from MAC
457
458   int chan = u2p_chan(&pkt->fixed);
459
460   switch (chan){
461   case CONTROL_CHAN:
462     handle_control_chan_frame(pkt, byte_len);
463     return true;        // we handled the packet
464     break;
465
466   case 0:
467   default:
468 #if 0
469     if (last_len != 0){
470       if (byte_len != last_len){
471         printf("Len: %d last: %d\n", byte_len, last_len);
472       }
473     }
474     last_len = byte_len;
475
476     if((pkt->thdr.seqno) == exp_seqno){
477       exp_seqno++;
478       //putchar('.');
479     }
480     else {
481       // putchar('S');
482       //printf("S%d %d ",exp_seqno,pkt->thdr.seqno);
483       exp_seqno = pkt->thdr.seqno + 1;
484     }
485 #endif
486     return false;       // pass it on to Tx DSP
487     break;
488   }
489 }
490
491 /*
492  * Called when eth phy state changes (w/ interrupts disabled)
493  */
494 void
495 link_changed_callback(int speed)
496 {
497   link_is_up = speed != 0;
498   hal_set_leds(link_is_up ? 0x20 : 0x0, 0x20);
499   printf("\neth link changed: speed = %d\n", speed);
500 }
501
502
503 void
504 print_tune_result(char *msg, bool tune_ok,
505                   u2_fxpt_freq_t target_freq, struct tune_result *r)
506 {
507 #if 0
508   printf("db_tune %s %s\n", msg, tune_ok ? "true" : "false");
509   putstr("  target_freq   "); print_fxpt_freq(target_freq); newline();
510   putstr("  baseband_freq "); print_fxpt_freq(r->baseband_freq); newline();
511   putstr("  dxc_freq      "); print_fxpt_freq(r->dxc_freq); newline();
512   putstr("  residual_freq "); print_fxpt_freq(r->residual_freq); newline();
513   printf("  inverted      %s\n", r->inverted ? "true" : "false");
514 #endif
515 }