summaryrefslogtreecommitdiffstats
path: root/host/docs/usrp_e1xx.rst
blob: fb5848bad9eef4f9099e2ffb36721818733f9ad7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
========================================================================
UHD - USRP-E1XX Series Application Notes
========================================================================

.. contents:: Table of Contents

------------------------------------------------------------------------
Specify a non-standard image
------------------------------------------------------------------------
The UHD will automatically select the USRP embedded FPGA image from the installed images package.
The FPGA image selection can be overridden with the "fpga" device address parameter.

Example device address string representations to specify non-standard FPGA image:

::

    fpga=usrp_e100_custom.bin

------------------------------------------------------------------------
Changing the master clock rate
------------------------------------------------------------------------
The master clock rate of the USRP embedded feeds both the FPGA DSP and the codec chip.
UHD can dynamically reconfigure the clock rate though the set_master_clock_rate() API call.
Hundreds of rates between 32MHz and 64MHz are available.
A few notable rates are:

* 64MHz - maximum rate of the codec chip
* 61.44MHz - good for UMTS/WCDMA applications
* 52Mhz - good for GSM applications

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Set 61.44MHz - uses external VCXO
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To use the 61.44MHz clock rate, the USRP embedded will require two jumpers to be moved.

* J16 is a two pin header, remove the jumper (or leave it on pin1 only)
* J15 is a three pin header, move the jumper to (pin1, pin2)

For the correct clock settings, call usrp->set_master_clock_rate(61.44e6)
before any other parameters are set in your application.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Set other rates - uses internal VCO
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To use other clock rates, the jumpers will need to be in the default position.

* J16 is a two pin header, move the jumper to (pin1, pin2)
* J15 is a three pin header, move the jumper to (pin2, pin3)

For the correct clock settings, call usrp->set_master_clock_rate(rate)
before any other parameters are set in your application.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Clock rate recovery - unbricking
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
It is possible to set a clock rate such that the UHD can no longer communicate with the FPGA.
When this occurs, it is necessary to use the usrp-e-utility to recover the clock generator.
The recovery utility works by loading a special pass-through FPGA image so the computer
can talk directly to the clock generator over a SPI interface.

Run the following commands to restore the clock generator to a usable state:
::

    cd <install-path>/share/uhd/usrp_e_utilities
    ./usrp-e-utility --fpga=../images/usrp_e100_pt_fpga.bin --reclk