Rebase on master, cleanup for merge
[debian/gnuradio] / usrp2 / firmware / apps / app_common_v2.c
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007,2008,2009 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 static inline bool
44 sync_to_pps(const op_generic_t *p)
45 {
46   timesync_regs->sync_on_next_pps = 1;
47   //putstr("SYNC to PPS\n");
48   return true;
49 }
50
51 static bool
52 sync_every_pps(const op_generic_t *p)
53 {
54   if (p->ok)
55     timesync_regs->tick_control |= TSC_TRIGGER_EVERYPPS;
56   else
57     timesync_regs->tick_control &= ~TSC_TRIGGER_EVERYPPS;
58
59   return true;
60 }
61
62 static inline bool
63 config_mimo_cmd(const op_config_mimo_t *p)
64 {
65   clocks_mimo_config(p->flags);
66   return true;
67 }
68
69 void
70 set_reply_hdr(u2_eth_packet_t *reply_pkt, u2_eth_packet_t const *cmd_pkt)
71 {
72   reply_pkt->ehdr.dst = cmd_pkt->ehdr.src;
73   reply_pkt->ehdr.src = *ethernet_mac_addr();
74   reply_pkt->ehdr.ethertype = U2_ETHERTYPE;
75   reply_pkt->thdr.flags = 0;
76   reply_pkt->thdr.fifo_status = 0;      // written by protocol engine
77   reply_pkt->thdr.seqno = 0;            // written by protocol engine
78   reply_pkt->thdr.ack = 0;              // written by protocol engine
79   u2p_set_word0(&reply_pkt->fixed, 0, CONTROL_CHAN);
80   reply_pkt->fixed.timestamp = timer_regs->time;
81 }
82
83 static void
84 send_reply(unsigned char *reply, size_t reply_len)
85 {
86   if (reply_len < 64)
87     reply_len = 64;
88
89   // wait for buffer to become idle
90   hal_set_leds(0x4, 0x4);
91   while((buffer_pool_status->status & BPS_IDLE(CPU_TX_BUF)) == 0)
92     ;
93   hal_set_leds(0x0, 0x4);
94
95   // copy reply into CPU_TX_BUF
96   memcpy_wa(buffer_ram(CPU_TX_BUF), reply, reply_len);
97
98   // wait until nobody else is sending to the ethernet
99   if (ac_could_be_sending_to_eth){
100     hal_set_leds(0x8, 0x8);
101     dbsm_wait_for_opening(ac_could_be_sending_to_eth);
102     hal_set_leds(0x0, 0x8);
103   }
104
105   if (0){
106     printf("sending_reply to port %d, len = %d\n", cpu_tx_buf_dest_port, (int)reply_len);
107     print_buffer(buffer_ram(CPU_TX_BUF), reply_len/4);
108   }
109
110   // fire it off
111   bp_send_from_buf(CPU_TX_BUF, cpu_tx_buf_dest_port, 1, 0, reply_len/4);
112
113   // wait for it to complete (not long, it's a small pkt)
114   while((buffer_pool_status->status & (BPS_DONE(CPU_TX_BUF) | BPS_ERROR(CPU_TX_BUF))) == 0)
115     ;
116
117   bp_clear_buf(CPU_TX_BUF);
118 }
119
120
121 static size_t
122 op_id_cmd(const op_generic_t *p,
123           void *reply_payload, size_t reply_payload_space)
124 {
125   op_id_reply_t *r = (op_id_reply_t *) reply_payload;
126   if (reply_payload_space < sizeof(*r)) // no room
127     return 0;
128
129   // Build reply subpacket
130
131   r->opcode = OP_ID_REPLY;
132   r->len = sizeof(op_id_reply_t);
133   r->rid = p->rid;
134   r->addr = *ethernet_mac_addr();
135   r->hw_rev = (u2_hw_rev_major << 8) | u2_hw_rev_minor;
136   // r->fpga_md5sum = ; // FIXME
137   // r->sw_md5sum = ;   // FIXME
138
139   return r->len;
140 }
141
142
143 static size_t
144 config_tx_v2_cmd(const op_config_tx_v2_t *p,
145                  void *reply_payload, size_t reply_payload_space)
146 {
147   op_config_tx_reply_v2_t *r = (op_config_tx_reply_v2_t *) reply_payload;
148   if (reply_payload_space < sizeof(*r))
149     return 0;                                   // no room
150
151   struct tune_result    tune_result;
152   memset(&tune_result, 0, sizeof(tune_result));
153
154   bool ok = true;
155
156   if (p->valid & CFGV_GAIN){
157     ok &= db_set_gain(tx_dboard, p->gain);
158   }
159
160   if (p->valid & CFGV_FREQ){
161     bool was_streaming = is_streaming();
162     if (was_streaming)
163       stop_rx_cmd();
164
165     u2_fxpt_freq_t f = u2_fxpt_freq_from_hilo(p->freq_hi, p->freq_lo);
166     bool tune_ok = db_tune(tx_dboard, f, &tune_result);
167     ok &= tune_ok;
168     print_tune_result("Tx", tune_ok, f, &tune_result);
169
170     if (was_streaming)
171       restart_streaming();
172   }
173
174   if (p->valid & CFGV_INTERP_DECIM){
175     int interp = p->interp;
176     int hb1 = 0;
177     int hb2 = 0;
178
179     if (!(interp & 1)){
180       hb2 = 1;
181       interp = interp >> 1;
182     }
183
184     if (!(interp & 1)){
185       hb1 = 1;
186       interp = interp >> 1;
187     }
188
189     if (interp < MIN_CIC_INTERP || interp > MAX_CIC_INTERP)
190       ok = false;
191     else {
192       dsp_tx_regs->interp_rate = (hb1<<9) | (hb2<<8) | interp;
193       // printf("Interp: %d, register %d\n", p->interp, (hb1<<9) | (hb2<<8) | interp);
194     }
195   }
196
197   if (p->valid & CFGV_SCALE_IQ){
198     dsp_tx_regs->scale_iq = p->scale_iq;
199   }
200
201   // Build reply subpacket
202
203   r->opcode = OP_CONFIG_TX_REPLY_V2;
204   r->len = sizeof(*r);
205   r->rid = p->rid;
206   r->ok = ok;
207   r->inverted = tune_result.inverted;
208   r->baseband_freq_hi = u2_fxpt_freq_hi(tune_result.baseband_freq);
209   r->baseband_freq_lo = u2_fxpt_freq_lo(tune_result.baseband_freq);
210   r->duc_freq_hi = u2_fxpt_freq_hi(tune_result.dxc_freq);
211   r->duc_freq_lo = u2_fxpt_freq_lo(tune_result.dxc_freq);
212   r->residual_freq_hi = u2_fxpt_freq_hi(tune_result.residual_freq);
213   r->residual_freq_lo = u2_fxpt_freq_lo(tune_result.residual_freq);
214   return r->len;
215 }
216
217 static size_t
218 config_rx_v2_cmd(const op_config_rx_v2_t *p,
219                  void *reply_payload, size_t reply_payload_space)
220 {
221   op_config_rx_reply_v2_t *r = (op_config_rx_reply_v2_t *) reply_payload;
222   if (reply_payload_space < sizeof(*r))
223     return 0;                           // no room
224
225   struct tune_result    tune_result;
226   memset(&tune_result, 0, sizeof(tune_result));
227
228   bool ok = true;
229
230   if (p->valid & CFGV_GAIN){
231     ok &= db_set_gain(rx_dboard, p->gain);
232   }
233
234   if (p->valid & CFGV_FREQ){
235     bool was_streaming = is_streaming();
236     if (was_streaming)
237       stop_rx_cmd();
238
239     u2_fxpt_freq_t f = u2_fxpt_freq_from_hilo(p->freq_hi, p->freq_lo);
240     bool tune_ok = db_tune(rx_dboard, f, &tune_result);
241     ok &= tune_ok;
242     print_tune_result("Rx", tune_ok, f, &tune_result);
243
244     if (was_streaming)
245       restart_streaming();
246   }
247
248   if (p->valid & CFGV_INTERP_DECIM){
249     int decim = p->decim;
250     int hb1 = 0;
251     int hb2 = 0;
252
253     if(!(decim & 1)) {
254       hb2 = 1;
255       decim = decim >> 1;
256     }
257
258     if(!(decim & 1)) {
259       hb1 = 1;
260       decim = decim >> 1;
261     }
262
263     if (decim < MIN_CIC_DECIM || decim > MAX_CIC_DECIM)
264       ok = false;
265     else {
266       dsp_rx_regs->decim_rate = (hb1<<9) | (hb2<<8) | decim;
267       // printf("Decim: %d, register %d\n", p->decim, (hb1<<9) | (hb2<<8) | decim);
268     }
269   }
270
271   if (p->valid & CFGV_SCALE_IQ){
272     dsp_rx_regs->scale_iq = p->scale_iq;
273   }
274
275   // Build reply subpacket
276
277   r->opcode = OP_CONFIG_RX_REPLY_V2;
278   r->len = sizeof(*r);
279   r->rid = p->rid;
280   r->ok = ok;
281   r->inverted = tune_result.inverted;
282   r->baseband_freq_hi = u2_fxpt_freq_hi(tune_result.baseband_freq);
283   r->baseband_freq_lo = u2_fxpt_freq_lo(tune_result.baseband_freq);
284   r->ddc_freq_hi = u2_fxpt_freq_hi(tune_result.dxc_freq);
285   r->ddc_freq_lo = u2_fxpt_freq_lo(tune_result.dxc_freq);
286   r->residual_freq_hi = u2_fxpt_freq_hi(tune_result.residual_freq);
287   r->residual_freq_lo = u2_fxpt_freq_lo(tune_result.residual_freq);
288
289   return r->len;
290 }
291
292 static size_t
293 read_time_cmd(const op_generic_t *p,
294               void *reply_payload, size_t reply_payload_space)
295 {
296   op_read_time_reply_t *r = (op_read_time_reply_t *) reply_payload;
297   if (reply_payload_space < sizeof(*r))
298     return 0;                                   // no room
299
300   r->opcode = OP_READ_TIME_REPLY;
301   r->len = sizeof(*r);
302   r->rid = p->rid;
303   r->time = timer_regs->time;
304
305   return r->len;
306 }
307
308 static void
309 fill_db_info(u2_db_info_t *p, const struct db_base *db)
310 {
311   p->dbid = db->dbid;
312   p->freq_min_hi = u2_fxpt_freq_hi(db->freq_min);
313   p->freq_min_lo = u2_fxpt_freq_lo(db->freq_min);
314   p->freq_max_hi = u2_fxpt_freq_hi(db->freq_max);
315   p->freq_max_lo = u2_fxpt_freq_lo(db->freq_max);
316   p->gain_min = db->gain_min;
317   p->gain_max = db->gain_max;
318   p->gain_step_size = db->gain_step_size;
319 }
320
321 static size_t
322 dboard_info_cmd(const op_generic_t *p,
323                 void *reply_payload, size_t reply_payload_space)
324 {
325   op_dboard_info_reply_t *r = (op_dboard_info_reply_t *) reply_payload;
326   if (reply_payload_space < sizeof(*r))
327     return 0;                                   // no room
328
329   r->opcode = OP_DBOARD_INFO_REPLY;
330   r->len = sizeof(*r);
331   r->rid = p->rid;
332   r->ok = true;
333
334   fill_db_info(&r->tx_db_info, tx_dboard);
335   fill_db_info(&r->rx_db_info, rx_dboard);
336
337   return r->len;
338 }
339
340 static size_t
341 peek_cmd(const op_peek_t *p,
342          void *reply_payload, size_t reply_payload_space)
343 {
344   op_generic_t *r = (op_generic_t *) reply_payload;
345
346   //putstr("peek: addr="); puthex32(p->addr);
347   //printf(" bytes=%u\n", p->bytes);
348
349   if ((reply_payload_space < (sizeof(*r) + p->bytes)) ||
350       p->bytes > MAX_SUBPKT_LEN - sizeof(op_generic_t)) {
351     putstr("peek: insufficient reply packet space\n");
352     return 0;                   // FIXME do partial read?
353   }
354
355   r->opcode = OP_PEEK_REPLY;
356   r->len = sizeof(*r)+p->bytes;
357   r->rid = p->rid;
358   r->ok = true;
359
360   memcpy_wa(reply_payload+sizeof(*r), (void *)p->addr, p->bytes);
361
362   return r->len;
363 }
364
365 static bool
366 poke_cmd(const op_poke_t *p)
367 {
368   int bytes = p->len - sizeof(*p);
369   //putstr("poke: addr="); puthex32(p->addr);
370   //printf(" bytes=%u\n", bytes);
371
372   uint8_t *src = (uint8_t *)p + sizeof(*p);
373   memcpy_wa((void *)p->addr, src, bytes);
374
375   return true;
376 }
377
378 static bool
379 set_lo_offset_cmd(const op_freq_t *p)
380 {
381   u2_fxpt_freq_t f = u2_fxpt_freq_from_hilo(p->freq_hi, p->freq_lo);
382   if (p->opcode == OP_SET_TX_LO_OFFSET)
383     return db_set_lo_offset(tx_dboard, f);
384   else
385     return db_set_lo_offset(rx_dboard, f);
386 }
387
388 static size_t
389 gpio_read_cmd(const op_gpio_t *p,
390               void *reply_payload, size_t reply_payload_space)
391 {
392   op_gpio_read_reply_t *r = (op_gpio_read_reply_t *) reply_payload;
393   if (reply_payload_space < sizeof(*r)) // no room
394     return 0;
395
396  // Build reply subpacket
397
398   r->opcode = OP_GPIO_READ_REPLY;
399   r->len = sizeof(op_gpio_read_reply_t);
400   r->rid = p->rid;
401   r->ok = true;
402   r->mbz = 0;
403   r->value = hal_gpio_read(p->bank);
404
405   return r->len;
406 }
407
408 static size_t
409 generic_reply(const op_generic_t *p,
410               void *reply_payload, size_t reply_payload_space,
411               bool ok)
412 {
413   op_generic_t *r = (op_generic_t *) reply_payload;
414   if (reply_payload_space < sizeof(*r))
415     return 0;                                   // no room
416
417   r->opcode = p->opcode | OP_REPLY_BIT;
418   r->len = sizeof(*r);
419   r->rid = p->rid;
420   r->ok = ok;
421
422   return r->len;
423 }
424
425 static size_t
426 add_eop(void *reply_payload, size_t reply_payload_space)
427 {
428   op_generic_t *r = (op_generic_t *) reply_payload;
429   if (reply_payload_space < sizeof(*r))
430     return 0;                                   // no room
431
432   r->opcode = OP_EOP;
433   r->len = sizeof(*r);
434   r->rid = 0;
435   r->ok =  0;
436
437   return r->len;
438 }
439
440 void
441 handle_control_chan_frame(u2_eth_packet_t *pkt, size_t len)
442 {
443   unsigned char reply[sizeof(u2_eth_packet_t) + 4 * sizeof(u2_subpkt_t)] _AL4;
444   unsigned char *reply_payload = &reply[sizeof(u2_eth_packet_t)];
445   int reply_payload_space = sizeof(reply) - sizeof(u2_eth_packet_t);
446
447   // initialize reply
448   memset(reply, 0, sizeof(reply));
449   set_reply_hdr((u2_eth_packet_t *) reply, pkt);
450
451   // point to beginning of payload (subpackets)
452   unsigned char *payload = ((unsigned char *) pkt) + sizeof(u2_eth_packet_t);
453   int payload_len = len - sizeof(u2_eth_packet_t);
454
455   size_t subpktlen = 0;
456   bool ok = false;
457
458   while (payload_len >= sizeof(op_generic_t)){
459     const op_generic_t *gp = (const op_generic_t *) payload;
460     subpktlen = 0;
461
462     // printf("\nopcode = %d\n", gp->opcode);
463
464     switch(gp->opcode){
465     case OP_EOP:                // end of subpackets
466       goto end_of_subpackets;
467
468     case OP_ID:
469       subpktlen = op_id_cmd(gp, reply_payload, reply_payload_space);
470       break;
471
472     case OP_CONFIG_TX_V2:
473       subpktlen = config_tx_v2_cmd((op_config_tx_v2_t *) payload, reply_payload, reply_payload_space);
474       break;
475
476     case OP_CONFIG_RX_V2:
477       subpktlen = config_rx_v2_cmd((op_config_rx_v2_t *) payload, reply_payload, reply_payload_space);
478       break;
479
480     case OP_START_RX_STREAMING:
481       if (pkt->fixed.timestamp == -1) // Start now (default)
482         start_rx_streaming_cmd(&pkt->ehdr.src, (op_start_rx_streaming_t *) payload);
483       else
484         start_rx_streaming_at_cmd(&pkt->ehdr.src, (op_start_rx_streaming_t *)payload, pkt->fixed.timestamp);
485       ok = true;
486       goto generic_reply;
487
488     case OP_STOP_RX:
489       stop_rx_cmd();
490       ok = true;
491       goto generic_reply;
492
493     case OP_BURN_MAC_ADDR:
494       ok = ethernet_set_mac_addr(&((op_burn_mac_addr_t *)payload)->addr);
495       goto generic_reply;
496
497     case OP_CONFIG_MIMO:
498       ok = config_mimo_cmd((op_config_mimo_t *) payload);
499       goto generic_reply;
500
501     case OP_READ_TIME:
502       subpktlen = read_time_cmd(gp, reply_payload, reply_payload_space);
503       break;
504
505     case OP_DBOARD_INFO:
506       subpktlen = dboard_info_cmd(gp, reply_payload, reply_payload_space);
507       break;
508
509     case OP_SYNC_TO_PPS:
510       sync_to_pps((op_generic_t *) payload);
511       ok = true;
512       goto generic_reply;
513
514     case OP_PEEK:
515       subpktlen = peek_cmd((op_peek_t *)payload, reply_payload, reply_payload_space);
516       break;
517
518     case OP_POKE:
519       ok = poke_cmd((op_poke_t *)payload);
520       goto generic_reply;
521
522     case OP_SET_TX_LO_OFFSET:
523     case OP_SET_RX_LO_OFFSET:
524       ok = set_lo_offset_cmd((op_freq_t *)payload);
525       goto generic_reply;
526
527     case OP_RESET_DB:
528       db_init();
529       ok = true;
530       goto generic_reply;
531
532     case OP_SYNC_EVERY_PPS:
533       ok = sync_every_pps((op_generic_t *) payload);
534       goto generic_reply;
535
536     case OP_GPIO_SET_DDR:
537       ok = true;
538       hal_gpio_set_ddr(((op_gpio_t *)payload)->bank,
539                        ((op_gpio_t *)payload)->value,
540                        ((op_gpio_t *)payload)->mask);
541       goto generic_reply;
542
543     case OP_GPIO_SET_SELS:
544       ok = true;
545       hal_gpio_set_sels(((op_gpio_set_sels_t *)payload)->bank,
546                         (char *)(&((op_gpio_set_sels_t *)payload)->sels));
547       goto generic_reply;
548
549     case OP_GPIO_READ:
550       subpktlen = gpio_read_cmd((op_gpio_t *) payload, reply_payload, reply_payload_space);
551       break;
552
553     case OP_GPIO_WRITE:
554       ok = true;
555       hal_gpio_write(((op_gpio_t *)payload)->bank,
556                      ((op_gpio_t *)payload)->value,
557                      ((op_gpio_t *)payload)->mask);
558       goto generic_reply;
559
560     case OP_GPIO_STREAM:
561       ok = true;
562       dsp_rx_regs->gpio_stream_enable = (uint32_t)((op_gpio_t *)payload)->value;
563       goto generic_reply;
564
565     // Add new opcode handlers here
566
567     generic_reply:
568       subpktlen = generic_reply(gp, reply_payload, reply_payload_space, ok);
569       break;
570
571     default:
572       printf("app_common_v2: unhandled opcode = %d\n", gp->opcode);
573       break;
574     }
575
576     int t = (gp->len + 3) & ~3;         // bump to a multiple of 4
577     payload += t;
578     payload_len -= t;
579
580     subpktlen = (subpktlen + 3) & ~3;   // bump to a multiple of 4
581     reply_payload += subpktlen;
582     reply_payload_space -= subpktlen;
583   }
584
585  end_of_subpackets:
586
587   // add the EOP marker
588   subpktlen = add_eop(reply_payload, reply_payload_space);
589   subpktlen = (subpktlen + 3) & ~3;     // bump to a multiple of 4
590   reply_payload += subpktlen;
591   reply_payload_space -= subpktlen;
592
593   send_reply(reply, reply_payload - reply);
594 }
595
596
597 /*
598  * Called when an ethernet packet is received.
599  * Return true if we handled it here, otherwise
600  * it'll be passed on to the DSP Tx pipe
601  */
602 bool
603 eth_pkt_inspector(dbsm_t *sm, int bufno)
604 {
605   u2_eth_packet_t *pkt = (u2_eth_packet_t *) buffer_ram(bufno);
606   size_t byte_len = (buffer_pool_status->last_line[bufno] - 1) * 4;
607
608   //static size_t last_len = 0;
609
610   // hal_toggle_leds(0x1);
611
612   // inspect rcvd frame and figure out what do do.
613
614   if (pkt->ehdr.ethertype != U2_ETHERTYPE)
615     return true;        // ignore, probably bogus PAUSE frame from MAC
616
617   int chan = u2p_chan(&pkt->fixed);
618
619   switch (chan){
620   case CONTROL_CHAN:
621     handle_control_chan_frame(pkt, byte_len);
622     return true;        // we handled the packet
623     break;
624
625   case 0:
626   default:
627 #if 0
628     if (last_len != 0){
629       if (byte_len != last_len){
630         printf("Len: %d last: %d\n", byte_len, last_len);
631       }
632     }
633     last_len = byte_len;
634
635     if((pkt->thdr.seqno) == exp_seqno){
636       exp_seqno++;
637       //putchar('.');
638     }
639     else {
640       // putchar('S');
641       //printf("S%d %d ",exp_seqno,pkt->thdr.seqno);
642       exp_seqno = pkt->thdr.seqno + 1;
643     }
644 #endif
645     return false;       // pass it on to Tx DSP
646     break;
647   }
648 }
649
650 /*
651  * Called when eth phy state changes (w/ interrupts disabled)
652  */
653 void
654 link_changed_callback(int speed)
655 {
656   link_is_up = speed != 0;
657   hal_set_leds(link_is_up ? LED_RJ45 : 0x0, LED_RJ45);
658   printf("\neth link changed: speed = %d\n", speed);
659 }
660
661
662 void
663 print_tune_result(char *msg, bool tune_ok,
664                   u2_fxpt_freq_t target_freq, struct tune_result *r)
665 {
666 #if 0
667   printf("db_tune %s %s\n", msg, tune_ok ? "true" : "false");
668   putstr("  target_freq   "); print_fxpt_freq(target_freq); newline();
669   putstr("  baseband_freq "); print_fxpt_freq(r->baseband_freq); newline();
670   putstr("  dxc_freq      "); print_fxpt_freq(r->dxc_freq); newline();
671   putstr("  residual_freq "); print_fxpt_freq(r->residual_freq); newline();
672   printf("  inverted      %s\n", r->inverted ? "true" : "false");
673 #endif
674 }