From a74919c2a89a6b1ae40b526c4ceadf1108bfd186 Mon Sep 17 00:00:00 2001
From: Martin Braun <martin.braun@ettus.com>
Date: Sun, 23 Mar 2014 15:11:26 +0100
Subject: docs: Moved manual to Doxygen

---
 host/docs/calibration.dox | 70 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 host/docs/calibration.dox

(limited to 'host/docs/calibration.dox')

diff --git a/host/docs/calibration.dox b/host/docs/calibration.dox
new file mode 100644
index 000000000..494cfca49
--- /dev/null
+++ b/host/docs/calibration.dox
@@ -0,0 +1,70 @@
+/*! \page page_calibration Calibration Application Notes
+
+\tableofcontents
+
+\section calibration_self Self-Calibration
+
+UHD software comes with several self-calibration utilities for
+minimizing IQ imbalance and DC offset. These utilities perform
+calibration sweeps using transmit leakage into the receive path (special
+equipment is not required). The results from a calibration are written
+to a CSV file in the user's home directory. UHD software will
+automatically apply corrections at runtime when the user re-tunes the
+daughterboard LO. Calibration results are specific to an individual RF
+board.
+
+<b>Note:</b> When a calibration table is present, and the user wishes to
+override the calibration settings through the API: the user should
+re-apply the desired setting every time the LO is re-tuned.
+
+UHD software comes with the following calibration utilities:
+
+-   **uhd_cal_rx_iq_balance:** - mimimizes RX IQ imbalance vs. LO
+    frequency
+-   **uhd_cal_tx_dc_offset:** - mimimizes TX DC offset vs. LO
+    frequency
+-   **uhd_cal_tx_iq_balance:** - mimimizes TX IQ imbalance vs. LO
+    frequency
+
+The following RF frontends are supported by the self-calibration
+utilities:
+
+-   RFX Series transceiver boards
+-   WBX Series transceiver boards
+-   SBX Series transceiver boards
+-   CBX Series transceiver boards
+
+\subsection calibration_self_utils Calibration Utilities
+
+UHD software installs the calibration utilities into
+`<install-path>/bin`. **Disconnect** any external hardware from the
+RF antenna ports, and run the following from the command line. Each
+utility will take several minutes to complete. :
+
+    uhd_cal_rx_iq_balance --verbose --args=<optional device args>
+    uhd_cal_tx_iq_balance --verbose --args=<optional device args>
+    uhd_cal_tx_dc_offset --verbose --args=<optional device args>
+
+See the output given by --help for more advanced options, such as:
+manually choosing the frequency range and step size for the sweeps.
+
+<b>Note:</b> Your daughterboard needs a serial number to run a calibration
+utility. Some older daughterboards may not have a serial number. If this
+is the case, run the following command to burn a serial number into the
+daughterboard's EEPROM: :
+
+    <install dir>/lib/uhd/utils/usrp_burn_db_eeprom --ser=<desired serial> --args=<optional device args>
+
+\subsection calibration_ Calibration Data
+
+Calibration files are stored in the user's home/application directory.
+They can easily be moved from machine to another by copying the "cal"
+directory. Re-running a calibration utility will replace the existing
+calibration file. The old calibration file will be renamed so it may be
+recovered by the user.
+
+-   **Linux:** `${HOME}/.uhd/cal/`
+-   **Windows:** `%APPDATA%\.uhd\cal\`
+
+*/
+// vim:ft=doxygen:
-- 
cgit v1.2.3