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

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