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