Skip to content

Commit

Permalink
Add fmcomms5 phase sync feature including doc and test
Browse files Browse the repository at this point in the history
Signed-off-by: Travis Collins <travis.collins@analog.com>
  • Loading branch information
tfcollins authored and commodo committed Jan 14, 2019
1 parent 8343e53 commit 780b21a
Show file tree
Hide file tree
Showing 5 changed files with 908 additions and 0 deletions.
1 change: 1 addition & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ add_library(ad9361 ad9361_multichip_sync.c
ad9361_baseband_auto_rate.c
ad9361_design_taps.c
ad9361_calculate_rf_clock_chain.c
ad9361_fmcomms5_phase_sync.c
${FD_SRC_FILES}
${LIBAD9361_HEADERS})
enable_testing()
Expand Down
19 changes: 19 additions & 0 deletions ad9361.h
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,25 @@ __api int ad9361_set_bb_rate_custom_filter_manual(struct iio_device *dev,
unsigned long Fstop, unsigned long wnom_tx,
unsigned long wnom_rx);

/** @brief FMComms5 phase synchronize all TX and RX channels together
* @param ctx A pointer to an iio_context structure
* @param lo Frequency in hertz of LO for TX and RX
* @return On success, 0 is returned
* @return On error, a negative errno code is returned. If -2 is returned calibration failed
*
* <b>NOTES:</b> To perform calibration the following side effects occur:
* - RF bandwidths of both TX and RX are expanded to the current sample rate. It can be changed after calibration without effecting phase synchronization.
* - DDSs are enabled and left on after synchronization. Changing these DDSs or switching to DMA sources will not effect phase synchronization.
* - TX and RX LOs are set to the same frequency based on the input provided. LO changes can invalidate phase synchronization.
* - AGCs are set to manual mode at predetermined hardware gains for TX and RX. Gain changes can invalidate phase synchronization.
*
* Phase synchronization is valid until the LOs are retuned or sample rates change or gains are modified.
*
* <b>External Links:</b>
* - <a href="https://wiki.analog.com/resources/eval/user-guides/ad-fmcomms5-ebz/multi-chip-sync">Detailed information on synchronization process</a>
* - <a href="https://wiki.analog.com/resources/eval/user-guides/ad-fmcomms5-ebz/hardware">Phase synchronization performance can depend on revision of hardware</a>*/
__api int ad9361_fmcomms5_phase_sync(struct iio_context *ctx, long long lo);

/** @} */

#ifdef __cplusplus
Expand Down
Loading

0 comments on commit 780b21a

Please sign in to comment.