b200: skeleton documentation rst manual

1 files changed, 87 insertions, 0 deletions

diff --git a/host/docs/usrp_b200.rst b/host/docs/usrp_b200.rst
new file mode 100644
index 000000000..96bf9b5bc
--- /dev/null
+++ b/host/docs/usrp_b200.rst
@@ -0,0 +1,87 @@
+========================================================================
+UHD - USRP-B2X0 Series Application Notes
+========================================================================
+
+.. contents:: Table of Contents
+
+------------------------------------------------------------------------
+Comparative features list - B200
+------------------------------------------------------------------------
+
+* integrated RF frontend
+* 1 RX DDC chain in FPGA
+* 1 TX DUC chain in FPGA
+* Timed commands in FPGA
+* Timed sampling in FPGA
+* External PPS reference
+* External 10MHz reference
+* Configurable clock rate
+* Internal GPSDO option
+
+------------------------------------------------------------------------
+Comparative features list - B210
+------------------------------------------------------------------------
+
+* integrated MIMO frontend
+* 2 RX DDC chains in FPGA
+* 2 TX DUC chains in FPGA
+* Timed commands in FPGA
+* Timed sampling in FPGA
+* External PPS reference
+* External 10MHz reference
+* Configurable clock rate
+* Internal GPSDO option
+
+------------------------------------------------------------------------
+Specify a Non-standard Image
+------------------------------------------------------------------------
+UHD software will automatically select the USRP B2X0 images from the installed images package.
+The image selection can be overridden with the **--fpga=** and **--fw=** device address parameters.
+
+Example device address string representations to specify non-standard images:
+
+::
+
+    fpga=usrp_b200_fpga.bin
+
+    -- OR --
+
+    fw=usrp_b200_fw.hex
+
+------------------------------------------------------------------------
+Changing the Master Clock Rate
+------------------------------------------------------------------------
+The master clock rate feeds the RF frontends and the DSP chains.
+Users may select non-default clock rates to acheive integer decimations or interpolations in the DSP chains.
+The default master clock rate defaults to 32 MHz, but can be set to any rate between 220 kHz and 61.44 MHz.
+
+The user can set the master clock rate through the usrp API call set_master_clock_rate(),
+or the clock rate can be set through the device arguments, which many applications take:
+::
+
+    uhd_usrp_probe --args="master_clock_rate=52e6"
+
+------------------------------------------------------------------------
+RF Frontend Notes
+------------------------------------------------------------------------
+The B200 features and integrated RF frontend.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Frontend tuning
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The RF frontend has individually tunable receive and transmit chains.
+On the B200, there is one transmit and one receive RF frontend.
+On the B210, both transmit and receive can be used in a MIMO configuration.
+For the MIMO case, both receive frontends share the RX LO,
+and both transmit frontends share the TX LO.
+Each LO is tunable between 50 MHz and 6 GHz.
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Frontend gain
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+All frontends have individual analog gain controls.
+The receive frontends have 73 dB of available gain;
+and the transmit frontends have 89 dB of available gain.
+Gain settings are application specific,
+but its recommended that users consider using at least
+half of the available gain to get reasonable dynamic range.