libbladeRF: Noted VCTCXO tamer input on J71 pin 1 in API header

Nuand · Dec 14, 2015 · f6c0d28 · f6c0d28
1 parent 35ff2e5
commit f6c0d28
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/host/libraries/libbladeRF/include/libbladeRF.h b/host/libraries/libbladeRF/include/libbladeRF.h
@@ -767,18 +767,24 @@ typedef enum {
     BLADERF_CORR_FPGA_GAIN
 } bladerf_correction;
 
-/** VCTCXO Tamer mode selection */
+/**
+ * VCTCXO Tamer mode selection
+ *
+ * These values control the use of header J71 pin 1 for taming the
+ * on-board VCTCXO. When supplying input ito the VCTCXO tamer, a 1.8V signal
+ * must be provided.
+ */
 typedef enum {
     /** Denotes an invalid selection or state */
     BLADERF_VCTCXO_TAMER_INVALID = -1,
 
     /** Do not attempt to tame the VCTCXO with an input source. */
     BLADERF_VCTCXO_TAMER_DISABLED = 0,
 
-    /** Use a 1 pps input source to tame the VCTCXO */
+    /** Use a 1 pps input source to tame the VCTCXO. */
     BLADERF_VCTCXO_TAMER_1_PPS = 1,
 
-    /** Use a 10 MHz input source to tame the VCTCXO */
+    /** Use a 10 MHz input source to tame the VCTCXO. */
     BLADERF_VCTCXO_TAMER_10_MHZ = 2
 } bladerf_vctcxo_tamer_mode;