Update bladerf_rf_switch_config struct to use "rfic" instead of "ad9361" for genericness and consistency. Also clean up missing/incorrect documentation in various places. Fix bladeRF-cli to use proper struct member names for bladerf_rf_switch_config.
323 lines
9.8 KiB
C
323 lines
9.8 KiB
C
/**
|
|
* @file bladeRF2.h
|
|
*
|
|
* @brief bladeRF2-specific API
|
|
*
|
|
* Copyright (C) 2013-2017 Nuand LLC
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
#ifndef BLADERF2_H_
|
|
#define BLADERF2_H_
|
|
|
|
/**
|
|
* @defgroup BLADERF2 bladeRF2-specific API
|
|
*
|
|
* These functions are thread-safe.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @defgroup FN_BLADERF2_BIAS_TEE Bias Tee Control
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Get current bias tee state
|
|
*
|
|
* @param dev Device handle
|
|
* @param[in] ch Channel
|
|
* @param[out] enable True if bias tee active, false otherwise
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_get_bias_tee(struct bladerf *dev,
|
|
bladerf_channel ch,
|
|
bool *enable);
|
|
|
|
/**
|
|
* Get current bias tee state
|
|
*
|
|
* @param dev Device handle
|
|
* @param[in] ch Channel
|
|
* @param[in] enable True to activate bias tee, false to deactivate
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_set_bias_tee(struct bladerf *dev,
|
|
bladerf_channel ch,
|
|
bool enable);
|
|
|
|
/** @} (End of FN_BLADERF2_BIAS_TEE) */
|
|
|
|
/**
|
|
* @defgroup FN_BLADERF2_LOW_LEVEL Low-level accessors
|
|
*
|
|
* In a most cases, higher-level routines should be used. These routines are
|
|
* only intended to support development and testing.
|
|
*
|
|
* Use these routines with great care, and be sure to reference the relevant
|
|
* schematics, data sheets, and source code (i.e., firmware and hdl).
|
|
*
|
|
* Be careful when mixing these calls with higher-level routines that manipulate
|
|
* the same registers/settings.
|
|
*
|
|
* These functions are thread-safe.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @defgroup FN_BLADERF2_LOW_LEVEL_AD9361 AD9361 RFIC
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Read an AD9361 register
|
|
*
|
|
* @param dev Device handle
|
|
* @param[in] address AD9361 register address
|
|
* @param[out] val Register value
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_ad9361_read(struct bladerf *dev,
|
|
uint16_t address,
|
|
uint8_t *val);
|
|
/**
|
|
* Write an AD9361 register
|
|
*
|
|
* @param dev Device handle
|
|
* @param[in] address AD9361 register address
|
|
* @param[in] val Value to write to register
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_ad9361_write(struct bladerf *dev,
|
|
uint16_t address,
|
|
uint8_t val);
|
|
|
|
/**
|
|
* Read the temperature from the AD9361 RFIC
|
|
*
|
|
* @param dev Device handle
|
|
* @param[out] val Temperature in degrees C
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_ad9361_temperature(struct bladerf *dev, float *val);
|
|
|
|
/** @} (End of FN_BLADERF2_LOW_LEVEL_AD9361) */
|
|
|
|
/**
|
|
* @defgroup FN_BLADERF2_LOW_LEVEL_ADF4002 ADF4002 Phase Detector/Freq. Synth
|
|
*
|
|
* Reference:
|
|
* http://www.analog.com/media/en/technical-documentation/data-sheets/ADF4002.pdf
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Fetch the lock state of the ADF4002 Phase Detector/Frequency Synthesizer
|
|
*
|
|
* @param dev Device handle
|
|
* @param[out] locked True if locked, False otherwise
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_adf4002_get_locked(struct bladerf *dev, bool *locked);
|
|
|
|
/**
|
|
* Fetch the state of the ADF4002 Phase Detector/Frequency Synthesizer
|
|
*
|
|
* @param dev Device handle
|
|
* @param[out] enabled True if enabled, False otherwise
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_adf4002_get_enable(struct bladerf *dev, bool *enabled);
|
|
|
|
/**
|
|
* Enable the ADF4002 Phase Detector/Frequency Synthesizer
|
|
*
|
|
* Enabling this disables the AD5621 VCTCXO trimmer DAC, and vice versa.
|
|
*
|
|
* @param dev Device handle
|
|
* @param[in] enable True to enable, False otherwise
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_adf4002_set_enable(struct bladerf *dev, bool enable);
|
|
|
|
/**
|
|
* Configure the ADF4002 Phase Detector/Frequency Synthesizer
|
|
*
|
|
* Use \ref bladerf_adf4002_calculate_ratio to compute the R and N from given
|
|
* reference and system clock frequencies.
|
|
*
|
|
* @param dev Device handle
|
|
* @param[in] R Reference counter divide ratio (1...16383)
|
|
* @param[in] N N counter divide ratio (1...8191)
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_adf4002_configure(struct bladerf *dev,
|
|
uint16_t R,
|
|
uint16_t N);
|
|
|
|
/**
|
|
* Calculate valid R and N values for given reference and system clock
|
|
* frequencies.
|
|
*
|
|
* @param[in] ref_freq Reference clock frequency, in Hz
|
|
* @param[in] clock_freq System clock frequency, in Hz
|
|
* @param[out] R Reference counter divide ratio (1...16383)
|
|
* @param[out] N N counter divide ratio (1...8191)
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_adf4002_calculate_ratio(uint64_t ref_freq,
|
|
uint64_t clock_freq,
|
|
uint16_t *R,
|
|
uint16_t *N);
|
|
|
|
/**
|
|
* Read value from ADF4002 Phase Detector/Frequency Synthesizer
|
|
*
|
|
* The `address` is interpreted as the control bits (DB1 and DB0) used to write
|
|
* to a specific latch.
|
|
*
|
|
* @param dev Device handle
|
|
* @param[in] address ADF4002 latch address
|
|
* @param[out] val Value to read from ADF4002
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_adf4002_read(struct bladerf *dev,
|
|
uint8_t address,
|
|
uint32_t *val);
|
|
|
|
/**
|
|
* Write value to ADF4002 Phase Detector/Frequency Synthesizer
|
|
*
|
|
* The `address` is interpreted as the control bits (DB1 and DB0) used to write
|
|
* to a specific latch. These bits are masked out in `val`
|
|
*
|
|
* @param dev Device handle
|
|
* @param[in] address ADF4002 latch address
|
|
* @param[in] val Value to write to ADF4002
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_adf4002_write(struct bladerf *dev,
|
|
uint8_t address,
|
|
uint32_t val);
|
|
|
|
/** @} (End of FN_BLADERF2_LOW_LEVEL_ADF4002) */
|
|
|
|
/**
|
|
* @defgroup FN_BLADERF2_LOW_LEVEL_INA219 INA219 Current/Power Monitor
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Register identifiers for INA219
|
|
*/
|
|
typedef enum {
|
|
BLADERF_INA219_CONFIGURATION, /**< Configuration register (uint16_t) */
|
|
BLADERF_INA219_VOLTAGE_SHUNT, /**< Shunt voltage (float) */
|
|
BLADERF_INA219_VOLTAGE_BUS, /**< Bus voltage (float) */
|
|
BLADERF_INA219_POWER, /**< Load power (float) */
|
|
BLADERF_INA219_CURRENT, /**< Load current (float) */
|
|
BLADERF_INA219_CALIBRATION, /**< Calibration (uint16_t) */
|
|
} bladerf_ina219_register;
|
|
|
|
/**
|
|
* Read value from INA219 Current/Power Monitor
|
|
*
|
|
* Reference: http://www.ti.com/product/INA219
|
|
*
|
|
* @param dev Device handle
|
|
* @param[in] reg Register to read from
|
|
* @param[out] val Value read from INA219
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_ina219_read(struct bladerf *dev,
|
|
bladerf_ina219_register reg,
|
|
void *val);
|
|
|
|
/** @} (End of FN_BLADERF2_LOW_LEVEL_INA219) */
|
|
|
|
/**
|
|
* @defgroup FN_BLADERF2_LOW_LEVEL_RF_SWITCHING RF Switching Control
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* RF switch configuration structure
|
|
*/
|
|
typedef struct {
|
|
uint32_t tx1_rfic_port; /**< Active TX1 output from RFIC */
|
|
uint32_t tx1_spdt_port; /**< RF switch configuration for the TX1 path */
|
|
uint32_t tx2_rfic_port; /**< Active TX2 output from RFIC */
|
|
uint32_t tx2_spdt_port; /**< RF switch configuration for the TX2 path */
|
|
uint32_t rx1_rfic_port; /**< Active RX1 input to RFIC */
|
|
uint32_t rx1_spdt_port; /**< RF switch configuration for the RX1 path */
|
|
uint32_t rx2_rfic_port; /**< Active RX2 input to RFIC */
|
|
uint32_t rx2_spdt_port; /**< RF switch configuration for the RX2 path */
|
|
} bladerf_rf_switch_config;
|
|
|
|
/**
|
|
* Read the current RF switching configuration from the bladeRF hardware.
|
|
*
|
|
* Queries both the RFIC and the RF switch and passes back a
|
|
* bladerf_rf_switch_config stucture.
|
|
*
|
|
* @param dev Device handle
|
|
* @param[out] config Switch configuration struct
|
|
*
|
|
* @return 0 on success, value from \ref RETCODES list on failure
|
|
*/
|
|
API_EXPORT
|
|
int CALL_CONV bladerf_get_rf_switch_config(struct bladerf *dev,
|
|
bladerf_rf_switch_config *config);
|
|
|
|
/** @} (End of FN_BLADERF2_LOW_LEVEL_RF_SWITCHING) */
|
|
|
|
/** @} (End of FN_BLADERF2_LOW_LEVEL) */
|
|
|
|
/** @} (End of BLADERF2) */
|
|
|
|
#endif /* BLADERF2_H_ */
|