diff --git a/host/libraries/libbladeRF/include/libbladeRF.h b/host/libraries/libbladeRF/include/libbladeRF.h index 8641e042..75fc53a2 100644 --- a/host/libraries/libbladeRF/include/libbladeRF.h +++ b/host/libraries/libbladeRF/include/libbladeRF.h @@ -2775,6 +2775,70 @@ int CALL_CONV bladerf_image_read(struct bladerf_image *image, const char *file); * @{ */ +/** + * @defgroup FN_VCTCXO_TAMER VCTCXO Tamer Mode + * + * This group provides routines for controlling the VTCTXO tamer. These + * functions are thread-safe. + * + * @{ + */ + +/** + * VCTCXO Tamer mode selection + * + * These values control the use of header J71 pin 1 for taming the + * on-board VCTCXO to improve or sustain frequency accuracy. + * + * When supplying input into the VCTCXO tamer, a 1.8V signal must be provided. + * + * + * IMPORTANT: Exceeding 1.8V on J71-1 can damage the associated FPGA I/O bank. + * Ensure that you provide only a 1.8V signal! + * + */ +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. */ + BLADERF_VCTCXO_TAMER_1_PPS = 1, + + /** Use a 10 MHz input source to tame the VCTCXO. */ + BLADERF_VCTCXO_TAMER_10_MHZ = 2 +} bladerf_vctcxo_tamer_mode; + +/** + * Set the VCTCXO tamer mode. + * + * @param dev Device handle + * @param[in] mode VCTCXO taming mode + * + * @return 0 on success, value from \ref RETCODES list on failure + */ +API_EXPORT +int CALL_CONV bladerf_set_vctcxo_tamer_mode(struct bladerf *dev, + bladerf_vctcxo_tamer_mode mode); + +/** + * Get the current VCTCXO tamer mode + * + * @param dev Device handle + * @param[out] mode Current VCTCXO taming mode or + * BLADERF_VCTCXO_TAMER_INVALID if a failure + * occurs. + * + * @return 0 on success, value from \ref RETCODES list on failure + */ +API_EXPORT +int CALL_CONV bladerf_get_vctcxo_tamer_mode(struct bladerf *dev, + bladerf_vctcxo_tamer_mode *mode); + +/** @} (End of FN_VCTCXO_TAMER) */ + /** * @defgroup FN_VCTCXO_TRIM_DAC VCTCXO Trim DAC * @@ -3450,70 +3514,6 @@ int CALL_CONV bladerf_get_correction(struct bladerf *dev, bladerf_channel ch, /** @} (End of FN_BLADERF1_CORR) */ -/** - * @defgroup FN_BLADERF1_VCTCXO VCTCXO Tamer Mode - * - * This group provides routines for controlling the VTCTXO tamer. These - * functions are thread-safe. - * - * @{ - */ - -/** - * VCTCXO Tamer mode selection - * - * These values control the use of header J71 pin 1 for taming the - * on-board VCTCXO to improve or sustain frequency accuracy. - * - * When supplying input into the VCTCXO tamer, a 1.8V signal must be provided. - * - * - * IMPORTANT: Exceeding 1.8V on J71-1 can damage the associated FPGA I/O bank. - * Ensure that you provide only a 1.8V signal! - * - */ -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. */ - BLADERF_VCTCXO_TAMER_1_PPS = 1, - - /** Use a 10 MHz input source to tame the VCTCXO. */ - BLADERF_VCTCXO_TAMER_10_MHZ = 2 -} bladerf_vctcxo_tamer_mode; - -/** - * Set the VCTCXO tamer mode. - * - * @param dev Device handle - * @param[in] mode VCTCXO taming mode - * - * @return 0 on success, value from \ref RETCODES list on failure - */ -API_EXPORT -int CALL_CONV bladerf_set_vctcxo_tamer_mode(struct bladerf *dev, - bladerf_vctcxo_tamer_mode mode); - -/** - * Get the current VCTCXO tamer mode - * - * @param dev Device handle - * @param[out] mode Current VCTCXO taming mode or - * BLADERF_VCTCXO_TAMER_INVALID if a failure - * occurs. - * - * @return 0 on success, value from \ref RETCODES list on failure - */ -API_EXPORT -int CALL_CONV bladerf_get_vctcxo_tamer_mode(struct bladerf *dev, - bladerf_vctcxo_tamer_mode *mode); - -/** @} (End of FN_BLADERF1_VCTCXO) */ - /** * @defgroup FN_BLADERF1_LPF_BYPASS LPF Bypass * diff --git a/host/libraries/libbladeRF/src/bladerf.c b/host/libraries/libbladeRF/src/bladerf.c index e4877f86..fe2d25f0 100644 --- a/host/libraries/libbladeRF/src/bladerf.c +++ b/host/libraries/libbladeRF/src/bladerf.c @@ -1156,6 +1156,34 @@ int bladerf_get_rx_mux(struct bladerf *dev, bladerf_rx_mux *mux) return status; } +/******************************************************************************/ +/* Low-level VCTCXO Tamer Mode */ +/******************************************************************************/ + +int bladerf_set_vctcxo_tamer_mode(struct bladerf *dev, + bladerf_vctcxo_tamer_mode mode) +{ + int status; + MUTEX_LOCK(&dev->lock); + + status = dev->board->set_vctcxo_tamer_mode(dev, mode); + + MUTEX_UNLOCK(&dev->lock); + return status; +} + +int bladerf_get_vctcxo_tamer_mode(struct bladerf *dev, + bladerf_vctcxo_tamer_mode *mode) +{ + int status; + MUTEX_LOCK(&dev->lock); + + status = dev->board->get_vctcxo_tamer_mode(dev, mode); + + MUTEX_UNLOCK(&dev->lock); + return status; +} + /******************************************************************************/ /* Low-level VCTCXO Trim DAC access */ /******************************************************************************/ diff --git a/host/libraries/libbladeRF/src/board/bladerf1/bladerf1.c b/host/libraries/libbladeRF/src/board/bladerf1/bladerf1.c index 010c1cc7..2305b016 100644 --- a/host/libraries/libbladeRF/src/board/bladerf1/bladerf1.c +++ b/host/libraries/libbladeRF/src/board/bladerf1/bladerf1.c @@ -2492,6 +2492,42 @@ static int bladerf1_get_rx_mux(struct bladerf *dev, bladerf_rx_mux *mode) return status; } +/******************************************************************************/ +/* Low-level VCTCXO Tamer Mode */ +/******************************************************************************/ + +static int bladerf1_set_vctcxo_tamer_mode(struct bladerf *dev, + bladerf_vctcxo_tamer_mode mode) +{ + struct bladerf1_board_data *board_data = dev->board_data; + + CHECK_BOARD_STATE(STATE_INITIALIZED); + + if (!have_cap(board_data->capabilities, BLADERF_CAP_VCTCXO_TAMING_MODE)) { + log_debug("FPGA %s does not support VCTCXO taming via an input source\n", + board_data->fpga_version.describe); + return BLADERF_ERR_UNSUPPORTED; + } + + return dev->backend->set_vctcxo_tamer_mode(dev, mode); +} + +static int bladerf1_get_vctcxo_tamer_mode(struct bladerf *dev, + bladerf_vctcxo_tamer_mode *mode) +{ + struct bladerf1_board_data *board_data = dev->board_data; + + CHECK_BOARD_STATE(STATE_INITIALIZED); + + if (!have_cap(board_data->capabilities, BLADERF_CAP_VCTCXO_TAMING_MODE)) { + log_debug("FPGA %s does not support VCTCXO taming via an input source\n", + board_data->fpga_version.describe); + return BLADERF_ERR_UNSUPPORTED; + } + + return dev->backend->get_vctcxo_tamer_mode(dev, mode); +} + /******************************************************************************/ /* Low-level VCTCXO Trim DAC access */ /******************************************************************************/ @@ -2783,6 +2819,8 @@ const struct board_fns bladerf1_board_fns = { FIELD_INIT(.get_loopback, bladerf1_get_loopback), FIELD_INIT(.get_rx_mux, bladerf1_get_rx_mux), FIELD_INIT(.set_rx_mux, bladerf1_set_rx_mux), + FIELD_INIT(.get_vctcxo_tamer_mode, bladerf1_get_vctcxo_tamer_mode), + FIELD_INIT(.set_vctcxo_tamer_mode, bladerf1_set_vctcxo_tamer_mode), FIELD_INIT(.trim_dac_read, bladerf1_trim_dac_read), FIELD_INIT(.trim_dac_write, bladerf1_trim_dac_write), FIELD_INIT(.read_trigger, bladerf1_read_trigger), @@ -2991,64 +3029,6 @@ int bladerf_get_rxvga2(struct bladerf *dev, int *gain) return status; } -/******************************************************************************/ -/* VCTCXO Control */ -/******************************************************************************/ - -int bladerf_set_vctcxo_tamer_mode(struct bladerf *dev, - bladerf_vctcxo_tamer_mode mode) -{ - struct bladerf1_board_data *board_data = dev->board_data; - int status; - - if (dev->board != &bladerf1_board_fns) - return BLADERF_ERR_UNSUPPORTED; - - MUTEX_LOCK(&dev->lock); - - CHECK_BOARD_STATE_LOCKED(STATE_INITIALIZED); - - if (!have_cap(board_data->capabilities, BLADERF_CAP_VCTCXO_TAMING_MODE)) { - log_debug("FPGA %s does not support VCTCXO taming via an input source\n", - board_data->fpga_version.describe); - status = BLADERF_ERR_UNSUPPORTED; - goto exit; - } - - status = dev->backend->set_vctcxo_tamer_mode(dev, mode); - -exit: - MUTEX_UNLOCK(&dev->lock); - return status; -} - -int bladerf_get_vctcxo_tamer_mode(struct bladerf *dev, - bladerf_vctcxo_tamer_mode *mode) -{ - struct bladerf1_board_data *board_data = dev->board_data; - int status; - - if (dev->board != &bladerf1_board_fns) - return BLADERF_ERR_UNSUPPORTED; - - MUTEX_LOCK(&dev->lock); - - CHECK_BOARD_STATE_LOCKED(STATE_INITIALIZED); - - if (!have_cap(board_data->capabilities, BLADERF_CAP_VCTCXO_TAMING_MODE)) { - log_debug("FPGA %s does not support VCTCXO taming via an input source\n", - board_data->fpga_version.describe); - status = BLADERF_ERR_UNSUPPORTED; - goto exit; - } - - status = dev->backend->get_vctcxo_tamer_mode(dev, mode); - -exit: - MUTEX_UNLOCK(&dev->lock); - return status; -} - /******************************************************************************/ /* LPF Bypass */ /******************************************************************************/ diff --git a/host/libraries/libbladeRF/src/board/bladerf2/bladerf2.c b/host/libraries/libbladeRF/src/board/bladerf2/bladerf2.c index 1579e675..88cc109a 100644 --- a/host/libraries/libbladeRF/src/board/bladerf2/bladerf2.c +++ b/host/libraries/libbladeRF/src/board/bladerf2/bladerf2.c @@ -1731,6 +1731,22 @@ static int bladerf2_get_rx_mux(struct bladerf *dev, bladerf_rx_mux *mode) return status; } +/******************************************************************************/ +/* Low-level VCTCXO Tamer Mode */ +/******************************************************************************/ + +static int bladerf2_set_vctcxo_tamer_mode(struct bladerf *dev, + bladerf_vctcxo_tamer_mode mode) +{ + return BLADERF_ERR_UNSUPPORTED; +} + +static int bladerf2_get_vctcxo_tamer_mode(struct bladerf *dev, + bladerf_vctcxo_tamer_mode *mode) +{ + return BLADERF_ERR_UNSUPPORTED; +} + /******************************************************************************/ /* Low-level VCTCXO Trim DAC access */ /******************************************************************************/ @@ -1897,6 +1913,8 @@ const struct board_fns bladerf2_board_fns = { FIELD_INIT(.get_loopback, bladerf2_get_loopback), FIELD_INIT(.get_rx_mux, bladerf2_get_rx_mux), FIELD_INIT(.set_rx_mux, bladerf2_set_rx_mux), + FIELD_INIT(.get_vctcxo_tamer_mode, bladerf2_get_vctcxo_tamer_mode), + FIELD_INIT(.set_vctcxo_tamer_mode, bladerf2_set_vctcxo_tamer_mode), FIELD_INIT(.trim_dac_read, bladerf2_trim_dac_read), FIELD_INIT(.trim_dac_write, bladerf2_trim_dac_write), FIELD_INIT(.read_trigger, bladerf2_read_trigger), diff --git a/host/libraries/libbladeRF/src/board/board.h b/host/libraries/libbladeRF/src/board/board.h index e8d8d4e1..8478642d 100644 --- a/host/libraries/libbladeRF/src/board/board.h +++ b/host/libraries/libbladeRF/src/board/board.h @@ -152,6 +152,10 @@ struct board_fns { int (*get_rx_mux)(struct bladerf *dev, bladerf_rx_mux *mode); int (*set_rx_mux)(struct bladerf *dev, bladerf_rx_mux mode); + /* Low-level VCTCXO Tamer Mode */ + int (*set_vctcxo_tamer_mode)(struct bladerf *dev, bladerf_vctcxo_tamer_mode mode); + int (*get_vctcxo_tamer_mode)(struct bladerf *dev, bladerf_vctcxo_tamer_mode *mode); + /* Low-level VCTCXO Trim DAC access */ int (*trim_dac_read)(struct bladerf *dev, uint16_t *trim); int (*trim_dac_write)(struct bladerf *dev, uint16_t trim);