diff options
| -rw-r--r-- | host/docs/gpsdo.rst | 26 | ||||
| -rw-r--r-- | host/docs/usrp2.rst | 38 | ||||
| -rw-r--r-- | host/docs/usrp_b1xx.rst | 12 | ||||
| -rw-r--r-- | host/docs/usrp_e1xx.rst | 22 |
4 files changed, 53 insertions, 45 deletions
diff --git a/host/docs/gpsdo.rst b/host/docs/gpsdo.rst index 5680e0699..e84af8500 100644 --- a/host/docs/gpsdo.rst +++ b/host/docs/gpsdo.rst @@ -23,29 +23,35 @@ Specifications * **1kHz:** -145dBc/Hz * **10kHz:** <-145dBc/Hz ------------------------------------------------------------------------- -Installation ------------------------------------------------------------------------- -See the documentation for your device for specifics on installing the GPSDO. +**Antenna Types:** + +The GPSDO is capable of supplying a 3V for active GPS antennas or supporting passive antennas ------------------------------------------------------------------------ -Configuring the USRP to use the GPSDO +Installation instructions ------------------------------------------------------------------------ +Installation instructions can be found here: +`www.ettus.com/downloads/gpsdo-kit.pdf <http://www.ettus.com/downloads/gpsdo-kit.pdf>`_ + +******************************************** +Post installation task (N-Series only) +******************************************** This is necessary if you require absolute GPS time in your application, or need to communicate with the GPSDO to obtain location, satellite info, etc. If you only require 10MHz and PPS signals for reference or MIMO use, -(see the Synchronization application note), it is not necessary to perform -this step. +(see the `Synchronization Application Notes <./sync.html>`_), +it is not necessary to perform this step. To configure the USRP to communicate with the GPSDO, use the usrp_burn_mb_eeprom utility: :: - $ cd <install-path>/share/uhd/utils - $ ./usrp_burn_mb_eeprom --key=gpsdo --val=internal + cd <install-path>/share/uhd/utils + ./usrp_burn_mb_eeprom --args=<optional device args> --key=gpsdo --val=internal -This will configure the driver to communicate with the GPSDO on startup. + -- restore original setting -- + ./usrp_burn_mb_eeprom --args=<optional device args> --key=gpsdo --val=none ------------------------------------------------------------------------ Using the GPSDO in your application diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst index b3238d801..d0b1c9a87 100644 --- a/host/docs/usrp2.rst +++ b/host/docs/usrp2.rst @@ -335,39 +335,8 @@ Test the PPS input with the following app: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Internal GPSDO ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Please see the GPSDO application note for information on configuring and -using the internal GPSDO. - -**Installation instructions:** - -1. Remove the daughterboard. -2. Move J510 jumper on the motherboard from 1-2 to 2-3 in order to switch from external 10 MHz Ref Clock to GPSDO’s 10 MHz Ref Clock -3. Screw the GPSDO module in place with the screws provided. The screws are treated to avoid loosening with vibration. -4. Connect the GPSDO power cable to J509 on the motherboard, and then to connector D on the GPSDO module -5. Connect an SMB to SMA cable between connectors B and J506 (PPS2) -6. Connect an SMB to SMA cable between connectors C and J507 (CLK REF2) -7. Connect the serial cable between connectors A and J312 (RS232-3) on the motherboard. If J312 on your USRP isn’t a keyed connector, please ensure to connect pin1 (TX) of connector A to pin3 (RX) on J312. -8. Remove the washer and nut from the MMCX to SMA-Bulkhead cable. Connect it to connector E and then insert SMA-Bulkhead connector through the hole in the rear panel. Tighten nut to fasten in place. -9. Replace the daughterboard pushing all the cables underneath. - -Then run the following commands: -:: - - cd <install-path>/share/uhd/utils - ./usrp_burn_mb_eeprom --args=<optional device args> --key=gpsdo --val=internal - -**Removal instructions:** - -Restore the jumper setting, disconnect the cables, and unscrew the GPSDO unit. -Then run the following commands: -:: - - cd <install-path>/share/uhd/utils - ./usrp_burn_mb_eeprom --args=<optional device args> --key=gpsdo --val=none - -**Antenna Types:** - -The GPSDO is capable of supplying a 3V for active GPS antennas or supporting passive antennas +Please see the `Internal GPSDO Application Notes <./gpsdo.html>`_ +for information on configuring and using the internal GPSDO. ------------------------------------------------------------------------ Miscellaneous @@ -381,8 +350,7 @@ they can be queried through the API. * mimo_locked - clock reference locked over the MIMO cable * ref_locked - clock reference locked (internal/external) -* gps_time - GPS epoch seconds (available when GPSDO installed) -* gps_locked - GPS lock status +* other sensors are added when the GPSDO is enabled ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Multiple RX channels diff --git a/host/docs/usrp_b1xx.rst b/host/docs/usrp_b1xx.rst index 7c535ec0a..564fb89be 100644 --- a/host/docs/usrp_b1xx.rst +++ b/host/docs/usrp_b1xx.rst @@ -73,3 +73,15 @@ The LEDs reveal the following about the state of the device: * **LED D:** fpga loaded * **LED E:** reference lock * **LED F:** board power + +------------------------------------------------------------------------ +Miscellaneous +------------------------------------------------------------------------ + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Available Sensors +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The following sensors are available; +they can be queried through the API. + +* ref_locked - clock reference locked (internal/external) diff --git a/host/docs/usrp_e1xx.rst b/host/docs/usrp_e1xx.rst index b76752327..258820d76 100644 --- a/host/docs/usrp_e1xx.rst +++ b/host/docs/usrp_e1xx.rst @@ -90,6 +90,15 @@ Test the PPS input with the following app: cd <install-path>/share/uhd/examples ./test_pps_input --args=<args> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Internal GPSDO +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Please see the `Internal GPSDO Application Notes <./gpsdo.html>`_ +for information on configuring and using the internal GPSDO. + +UHD will always try to detect an installed GPSDO at runtime. +There is not a special EEPROM value to burn for GPSDO detection. + ------------------------------------------------------------------------ Hardware setup notes ------------------------------------------------------------------------ @@ -106,3 +115,16 @@ The LEDs reveal the following about the state of the device: * **LED D:** fpga loaded * **LED E:** reference lock * **LED F:** board power + +------------------------------------------------------------------------ +Miscellaneous +------------------------------------------------------------------------ + +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Available Sensors +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The following sensors are available; +they can be queried through the API. + +* ref_locked - clock reference locked (internal/external) +* other sensors are added when the GPSDO is enabled |