Skip to content

Commit

Permalink
doc: updated default tuning mode to host
Browse files Browse the repository at this point in the history
  • Loading branch information
rthomp10 committed Apr 2, 2024
1 parent 1f58803 commit 262723b
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions host/libraries/libbladeRF/include/libbladeRF.h
Original file line number Diff line number Diff line change
Expand Up @@ -3590,19 +3590,15 @@ int CALL_CONV bladerf_trim_dac_read(struct bladerf *dev, uint16_t *val);
/**
* Frequency tuning modes
*
* ::BLADERF_TUNING_MODE_HOST is the default if either of the following
* conditions are true:
* - libbladeRF < v1.3.0
* - FPGA < v0.2.0
* The default tuning mode, `BLADERF_TUNING_MODE_HOST`, can be overridden by
* setting a BLADERF_DEFAULT_TUNING_MODE environment variable to `host` or `fpga`.
*
* ::BLADERF_TUNING_MODE_FPGA is the default if both of the following
* conditions are true:
* ::BLADERF_TUNING_MODE_HOST is the default tuning mode.
*
* ::BLADERF_TUNING_MODE_FPGA requirements:
* - libbladeRF >= v1.3.0
* - FPGA >= v0.2.0
*
* The default mode can be overridden by setting a BLADERF_DEFAULT_TUNING_MODE
* environment variable to `host` or `fpga`.
*
* @note Overriding this value with a mode not supported by the FPGA will result
* in failures or unexpected behavior.
*/
Expand Down

0 comments on commit 262723b

Please sign in to comment.