git.gag.com Git - debian/gnuradio/blob - usrp2/firmware/lib/db_init.c

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 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
  20 #include <memory_map.h>
  21 #include <i2c.h>
  22 #include <usrp2_i2c_addr.h>
  23 #include <string.h>
  24 #include <stdio.h>
  25 #include <db.h>
  26 #include <db_base.h>
  27 #include <hal_io.h>
  28 #include <nonstdio.h>
  29
  30
  31 struct db_base *tx_dboard;      // the tx daughterboard that's installed
  32 struct db_base *rx_dboard;      // the rx daughterboard that's installed
  33
  34 extern struct db_base db_basic_tx;
  35 extern struct db_base db_basic_rx;
  36 extern struct db_base db_lf_tx;
  37 extern struct db_base db_lf_rx;
  38 extern struct db_base db_rfx_400_tx;
  39 extern struct db_base db_rfx_400_rx;
  40 extern struct db_base db_rfx_900_tx;
  41 extern struct db_base db_rfx_900_rx;
  42 extern struct db_base db_rfx_1200_tx;
  43 extern struct db_base db_rfx_1200_rx;
  44 extern struct db_base db_rfx_1800_tx;
  45 extern struct db_base db_rfx_1800_rx;
  46 extern struct db_base db_rfx_2400_tx;
  47 extern struct db_base db_rfx_2400_rx;
  48 extern struct db_base db_tvrx1;
  49 extern struct db_base db_tvrx2;
  50 extern struct db_base db_tvrx3;
  51 extern struct db_base db_dbsrx;
  52
  53 extern struct db_base db_xcvr2450_tx;
  54 extern struct db_base db_xcvr2450_rx;
  55
  56 struct db_base *all_dboards[] = {
  57   &db_basic_tx,
  58   &db_basic_rx,
  59   &db_lf_tx,
  60   &db_lf_rx,
  61   &db_rfx_400_tx,
  62   &db_rfx_400_rx,
  63   &db_rfx_900_tx,
  64   &db_rfx_900_rx,
  65   &db_rfx_1200_tx,
  66   &db_rfx_1200_rx,
  67   &db_rfx_1800_tx,
  68   &db_rfx_1800_rx,
  69   &db_rfx_2400_tx,
  70   &db_rfx_2400_rx,
  71   &db_tvrx1,
  72   &db_tvrx2,
  73   &db_tvrx3,
  74   &db_dbsrx,
  75   &db_xcvr2450_tx,
  76   &db_xcvr2450_rx,
  77   0
  78 };
  79
  80
  81 typedef enum { UDBE_OK, UDBE_NO_EEPROM, UDBE_INVALID_EEPROM } usrp_dbeeprom_status_t;
  82
  83 static usrp_dbeeprom_status_t
  84 read_raw_dboard_eeprom (unsigned char *buf, int i2c_addr)
  85 {
  86   if (!eeprom_read (i2c_addr, 0, buf, DB_EEPROM_CLEN))
  87     return UDBE_NO_EEPROM;
  88
  89   if (buf[DB_EEPROM_MAGIC] != DB_EEPROM_MAGIC_VALUE)
  90     return UDBE_INVALID_EEPROM;
  91
  92   int sum = 0;
  93   unsigned int i;
  94   for (i = 0; i < DB_EEPROM_CLEN; i++)
  95     sum += buf[i];
  96
  97   if ((sum & 0xff) != 0)
  98     return UDBE_INVALID_EEPROM;
  99
 100   return UDBE_OK;
 101 }
 102
 103
 104 /*
 105  * Return DBID, -1 <none> or -2 <invalid eeprom contents>
 106  */
 107 int
 108 read_dboard_eeprom(int i2c_addr)
 109 {
 110   unsigned char buf[DB_EEPROM_CLEN];
 111
 112   usrp_dbeeprom_status_t s = read_raw_dboard_eeprom (buf, i2c_addr);
 113
 114   //printf("\nread_raw_dboard_eeprom: %d\n", s);
 115
 116   switch (s){
 117   case UDBE_OK:
 118     return (buf[DB_EEPROM_ID_MSB] << 8) | buf[DB_EEPROM_ID_LSB];
 119
 120   case UDBE_NO_EEPROM:
 121   default:
 122     return -1;
 123
 124   case UDBE_INVALID_EEPROM:
 125     return -2;
 126   }
 127 }
 128
 129
 130 static struct db_base *
 131 lookup_dbid(int dbid)
 132 {
 133   if (dbid < 0)
 134     return 0;
 135
 136   int i;
 137   for (i = 0; all_dboards[i]; i++)
 138     if (all_dboards[i]->dbid == dbid)
 139       return all_dboards[i];
 140
 141   return 0;
 142 }
 143
 144 static struct db_base *
 145 lookup_dboard(int i2c_addr, struct db_base *default_db, char *msg)
 146 {
 147   struct db_base *db;
 148   int dbid = read_dboard_eeprom(i2c_addr);
 149
 150   // FIXME removing this printf has the system hang if there are two d'boards
 151   // installed.  (I think the problem is in i2c_read/write or the way
 152   // I kludge the zero-byte write to set the read address in eeprom_read.)
 153   printf("%s dbid: 0x%x\n", msg, dbid);
 154
 155   if (dbid < 0){        // there was some kind of problem.  Treat as Basic Tx
 156     return default_db;
 157   }
 158   else if ((db = lookup_dbid(dbid)) == 0){
 159     printf("No daugherboard code for dbid = 0x%x\n", dbid);
 160     return default_db;
 161   }
 162   return db;
 163 }
 164
 165 void
 166 set_atr_regs(int bank, struct db_base *db)
 167 {
 168   uint32_t      val[4];
 169   int           shift;
 170   int           mask;
 171   int           i;
 172
 173   val[ATR_IDLE] = db->atr_rxval;
 174   val[ATR_RX]   = db->atr_rxval;
 175   val[ATR_TX]   = db->atr_txval;
 176   val[ATR_FULL] = db->atr_txval;
 177
 178   if (bank == GPIO_TX_BANK){
 179     mask = 0xffff0000;
 180     shift = 16;
 181   }
 182   else {
 183     mask = 0x0000ffff;
 184     shift = 0;
 185   }
 186
 187   for (i = 0; i < 4; i++){
 188     int t = (atr_regs->v[i] & ~mask) | ((val[i] << shift) & mask);
 189     //printf("atr_regs[%d] = 0x%x\n", i, t);
 190     atr_regs->v[i] = t;
 191   }
 192 }
 193
 194 static void
 195 set_gpio_mode(int bank, struct db_base *db)
 196 {
 197   int   i;
 198
 199   hal_gpio_set_ddr(bank, db->output_enables, 0xffff);
 200   set_atr_regs(bank, db);
 201
 202   for (i = 0; i < 16; i++){
 203     if (db->used_pins & (1 << i)){
 204       // set to either GPIO_SEL_SW or GPIO_SEL_ATR
 205       hal_gpio_set_sel(bank, i, (db->atr_mask & (1 << i)) ? 'a' : 's');
 206     }
 207   }
 208 }
 209
 210 static int __attribute__((unused))
 211 determine_tx_mux_value(struct db_base *db)
 212 {
 213   if (db->i_and_q_swapped)
 214     return 0x01;
 215   else
 216     return 0x10;
 217 }
 218
 219 static int
 220 determine_rx_mux_value(struct db_base *db)
 221 {
 222 #define ADC0 0x0
 223 #define ADC1 0x1
 224 #define ZERO 0x2
 225
 226   static int truth_table[8] = {
 227     /* swap_iq, uses */
 228     /* 0, 0x0 */    (ZERO << 2) | ZERO,         // N/A
 229     /* 0, 0x1 */    (ZERO << 2) | ADC0,
 230     /* 0, 0x2 */    (ZERO << 2) | ADC1,
 231     /* 0, 0x3 */    (ADC1 << 2) | ADC0,
 232     /* 1, 0x0 */    (ZERO << 2) | ZERO,         // N/A
 233     /* 1, 0x1 */    (ZERO << 2) | ADC0,
 234     /* 1, 0x2 */    (ZERO << 2) | ADC1,
 235     /* 1, 0x3 */    (ADC0 << 2) | ADC1,
 236   };
 237
 238   int   subdev0_uses;
 239   int   subdev1_uses;
 240   int   uses;
 241
 242   if (db->is_quadrature)
 243     subdev0_uses = 0x3;         // uses A/D 0 and 1
 244   else
 245     subdev0_uses = 0x1;         // uses A/D 0 only
 246
 247   // FIXME second subdev on Basic Rx, LF RX
 248   // if subdev2 exists
 249   // subdev1_uses = 0x2;
 250   subdev1_uses = 0;
 251
 252   uses = subdev0_uses;
 253
 254   int swap_iq = db->i_and_q_swapped & 0x1;
 255   int index = (swap_iq << 2) | uses;
 256
 257   return truth_table[index];
 258 }
 259
 260
 261 void
 262 db_init(void)
 263 {
 264   int   m;
 265
 266   tx_dboard = lookup_dboard(I2C_ADDR_TX_A, &db_basic_tx, "Tx");
 267   //printf("db_init: tx dbid = 0x%x\n", tx_dboard->dbid);
 268   set_gpio_mode(GPIO_TX_BANK, tx_dboard);
 269   tx_dboard->init(tx_dboard);
 270   m = determine_tx_mux_value(tx_dboard);
 271   dsp_tx_regs->tx_mux = m;
 272   //printf("tx_mux = 0x%x\n", m);
 273   tx_dboard->current_lo_offset = tx_dboard->default_lo_offset;
 274
 275   rx_dboard = lookup_dboard(I2C_ADDR_RX_A, &db_basic_rx, "Rx");
 276   //printf("db_init: rx dbid = 0x%x\n", rx_dboard->dbid);
 277   set_gpio_mode(GPIO_RX_BANK, rx_dboard);
 278   rx_dboard->init(rx_dboard);
 279   m = determine_rx_mux_value(rx_dboard);
 280   dsp_rx_regs->rx_mux = m;
 281   //printf("rx_mux = 0x%x\n", m);
 282   rx_dboard->current_lo_offset = rx_dboard->default_lo_offset;
 283 }
 284
 285 /*!
 286  *  Calculate the frequency to use for setting the digital down converter.
 287  *
 288  *  \param[in] target_freq   desired RF frequency (Hz)
 289  *  \param[in] baseband_freq the RF frequency that corresponds to DC in the IF.
 290  *
 291  *  \param[out] dxc_freq is the value for the ddc
 292  *  \param[out] inverted is true if we're operating in an inverted Nyquist zone.
 293 */
 294 void
 295 calc_dxc_freq(u2_fxpt_freq_t target_freq, u2_fxpt_freq_t baseband_freq,
 296               u2_fxpt_freq_t *dxc_freq, bool *inverted)
 297 {
 298   u2_fxpt_freq_t fs = U2_DOUBLE_TO_FXPT_FREQ(100e6);    // converter sample rate
 299   u2_fxpt_freq_t delta = target_freq - baseband_freq;
 300
 301 #if 0
 302   printf("calc_dxc_freq\n");
 303   printf("  fs       = "); print_fxpt_freq(fs); newline();
 304   printf("  target   = "); print_fxpt_freq(target_freq); newline();
 305   printf("  baseband = "); print_fxpt_freq(baseband_freq); newline();
 306   printf("  delta    = "); print_fxpt_freq(delta); newline();
 307 #endif
 308
 309   if (delta >= 0){
 310     while (delta > fs)
 311       delta -= fs;
 312     if (delta <= fs/2){         // non-inverted region
 313       *dxc_freq = -delta;
 314       *inverted = false;
 315     }
 316     else {                      // inverted region
 317       *dxc_freq = delta - fs;
 318       *inverted = true;
 319     }
 320   }
 321   else {
 322     while (delta < -fs)
 323       delta += fs;
 324     if (delta >= -fs/2){        // non-inverted region
 325       *dxc_freq = -delta;
 326       *inverted = false;
 327     }
 328     else {                      // inverted region
 329       *dxc_freq = delta + fs;
 330       *inverted = true;
 331     }
 332   }
 333 }
 334
 335 bool
 336 db_set_lo_offset(struct db_base *db, u2_fxpt_freq_t offset)
 337 {
 338   db->current_lo_offset = offset;
 339   return true;
 340 }
 341
 342 bool
 343 db_tune(struct db_base *db, u2_fxpt_freq_t target_freq, struct tune_result *result)
 344 {
 345   memset(result, 0, sizeof(*result));
 346   bool inverted = false;
 347   u2_fxpt_freq_t dxc_freq;
 348   u2_fxpt_freq_t actual_dxc_freq;
 349
 350   // Ask the d'board to tune as closely as it can to target_freq+lo_offset
 351   bool ok = db->set_freq(db, target_freq+db->current_lo_offset, &result->baseband_freq);
 352
 353   // Calculate the DDC setting that will downconvert the baseband from the
 354   // daughterboard to our target frequency.
 355   calc_dxc_freq(target_freq, result->baseband_freq, &dxc_freq, &inverted);
 356
 357   // If the spectrum is inverted, and the daughterboard doesn't do
 358   // quadrature downconversion, we can fix the inversion by flipping the
 359   // sign of the dxc_freq...  (This only happens using the basic_rx board)
 360
 361   if (db->spectrum_inverted)
 362     inverted = !inverted;
 363
 364   if (inverted && !db->is_quadrature){
 365     dxc_freq = -dxc_freq;
 366     inverted = !inverted;
 367   }
 368
 369   if (db->is_tx){
 370     dxc_freq = -dxc_freq;       // down conversion versus up conversion
 371     ok &= db_set_duc_freq(dxc_freq, &actual_dxc_freq);
 372   }
 373   else {
 374     ok &= db_set_ddc_freq(dxc_freq, &actual_dxc_freq);
 375   }
 376
 377   result->dxc_freq = dxc_freq;
 378   result->residual_freq = dxc_freq - actual_dxc_freq;
 379   result->inverted = inverted;
 380   return ok;
 381 }
 382
 383 static int32_t
 384 compute_freq_control_word(u2_fxpt_freq_t target_freq, u2_fxpt_freq_t *actual_freq)
 385 {
 386   // If we were using floating point, we'd calculate
 387   //   master = 100e6;
 388   //   v = (int) rint(target_freq / master_freq) * pow(2.0, 32.0);
 389
 390   //printf("compute_freq_control_word\n");
 391   //printf("  target_freq = "); print_fxpt_freq(target_freq); newline();
 392
 393   int32_t master_freq = 100000000;      // 100M
 394
 395   int32_t v = ((target_freq << 12)) / master_freq;
 396   //printf("  fcw = %d\n", v);
 397
 398   *actual_freq = (v * (int64_t) master_freq) >> 12;
 399
 400   //printf("  actual = "); print_fxpt_freq(*actual_freq); newline();
 401
 402   return v;
 403 }
 404
 405
 406 bool
 407 db_set_ddc_freq(u2_fxpt_freq_t dxc_freq, u2_fxpt_freq_t *actual_dxc_freq)
 408 {
 409   int32_t v = compute_freq_control_word(dxc_freq, actual_dxc_freq);
 410   dsp_rx_regs->freq = v;
 411   return true;
 412 }
 413
 414 bool
 415 db_set_duc_freq(u2_fxpt_freq_t dxc_freq, u2_fxpt_freq_t *actual_dxc_freq)
 416 {
 417   int32_t v = compute_freq_control_word(dxc_freq, actual_dxc_freq);
 418   dsp_tx_regs->freq = v;
 419   return true;
 420 }
 421
 422 bool
 423 db_set_gain(struct db_base *db, u2_fxpt_gain_t gain)
 424 {
 425   return db->set_gain(db, gain);
 426 }