libbladeRF  1.1.0
Nuand bladeRF library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Data Structures | Macros | Functions
Low-level development and testing routines

Data Structures

struct  bladerf_lms_dc_cals
 

Macros

#define BLADERF_GPIO_LMS_RX_ENABLE   (1 << 1)
 
#define BLADERF_GPIO_LMS_TX_ENABLE   (1 << 2)
 
#define BLADERF_GPIO_TX_LB_ENABLE   (2 << 3)
 
#define BLADERF_GPIO_TX_HB_ENABLE   (1 << 3)
 
#define BLADERF_GPIO_COUNTER_ENABLE   (1 << 9)
 
#define BLADERF_GPIO_RX_LB_ENABLE   (2 << 5)
 
#define BLADERF_GPIO_RX_HB_ENABLE   (1 << 5)
 
#define BLADERF_GPIO_FEATURE_SMALL_DMA_XFER   (1 << 7)
 
#define BLADERF_GPIO_TIMESTAMP   (1 << 16)
 
#define BLADERF_GPIO_TIMESTAMP_DIV2   (1 << 17)
 

Functions

API_EXPORT int CALL_CONV bladerf_si5338_read (struct bladerf *dev, uint8_t address, uint8_t *val)
 
API_EXPORT int CALL_CONV bladerf_si5338_write (struct bladerf *dev, uint8_t address, uint8_t val)
 
API_EXPORT int CALL_CONV bladerf_si5338_set_tx_freq (struct bladerf *dev, unsigned freq)
 
API_EXPORT int CALL_CONV bladerf_si5338_set_rx_freq (struct bladerf *dev, unsigned freq)
 
API_EXPORT int CALL_CONV bladerf_lms_read (struct bladerf *dev, uint8_t address, uint8_t *val)
 
API_EXPORT int CALL_CONV bladerf_lms_write (struct bladerf *dev, uint8_t address, uint8_t val)
 
API_EXPORT int CALL_CONV bladerf_lms_set_dc_cals (struct bladerf *dev, const struct bladerf_lms_dc_cals *dc_cals)
 
API_EXPORT int CALL_CONV bladerf_lms_get_dc_cals (struct bladerf *dev, struct bladerf_lms_dc_cals *dc_cals)
 
API_EXPORT int CALL_CONV bladerf_config_gpio_read (struct bladerf *dev, uint32_t *val)
 
API_EXPORT int CALL_CONV bladerf_config_gpio_write (struct bladerf *dev, uint32_t val)
 
API_EXPORT int CALL_CONV bladerf_expansion_gpio_read (struct bladerf *dev, uint32_t *val)
 
API_EXPORT int CALL_CONV bladerf_expansion_gpio_write (struct bladerf *dev, uint32_t val)
 
API_EXPORT int CALL_CONV bladerf_expansion_gpio_dir_read (struct bladerf *dev, uint32_t *val)
 
API_EXPORT int CALL_CONV bladerf_expansion_gpio_dir_write (struct bladerf *dev, uint32_t val)
 
API_EXPORT int CALL_CONV bladerf_get_timestamp (struct bladerf *dev, bladerf_module mod, uint64_t *value)
 
API_EXPORT int CALL_CONV bladerf_dac_write (struct bladerf *dev, uint16_t val)
 
API_EXPORT int CALL_CONV bladerf_xb_spi_write (struct bladerf *dev, uint32_t val)
 
API_EXPORT int CALL_CONV bladerf_calibrate_dc (struct bladerf *dev, bladerf_cal_module module)
 

Detailed Description

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.

Macro Definition Documentation

#define BLADERF_GPIO_COUNTER_ENABLE   (1 << 9)

Counter mode enable

Setting this bit to 1 instructs the FPGA to replace the (I, Q) pair in sample data with an incrementing, little-endian, 32-bit counter value. A 0 in bit specifies that sample data should be sent (as normally done).

This feature is useful when debugging issues involving dropped samples.

Definition at line 2480 of file libbladeRF.h.

#define BLADERF_GPIO_FEATURE_SMALL_DMA_XFER   (1 << 7)

This GPIO bit configures the FPGA to use smaller DMA transfers (256 cycles instead of 512). This is required when the device is not connected at Super Speed (i.e., when it is connected at High Speed).

However, the caller need not set this in gpio_set() calls. The library will set this as needed; callers generally do not need to be concerned with setting/clearing this bit.

Definition at line 2506 of file libbladeRF.h.

#define BLADERF_GPIO_LMS_RX_ENABLE   (1 << 1)

Enable LMS receive

Note
This bit is set/cleared by bladerf_enable_module()

Definition at line 2448 of file libbladeRF.h.

#define BLADERF_GPIO_LMS_TX_ENABLE   (1 << 2)

Enable LMS transmit

Note
This bit is set/cleared by bladerf_enable_module()

Definition at line 2455 of file libbladeRF.h.

#define BLADERF_GPIO_RX_HB_ENABLE   (1 << 5)

Switch to use RX high band (1.5GHz - 3.8GHz)

Note
This is set using bladerf_set_frequency().

Definition at line 2494 of file libbladeRF.h.

#define BLADERF_GPIO_RX_LB_ENABLE   (2 << 5)

Switch to use RX low band (300M - 1.5GHz)

Note
This is set using bladerf_set_frequency().

Definition at line 2487 of file libbladeRF.h.

#define BLADERF_GPIO_TIMESTAMP   (1 << 16)

Enable-bit for timestamp counter in the FPGA

Definition at line 2511 of file libbladeRF.h.

#define BLADERF_GPIO_TIMESTAMP_DIV2   (1 << 17)

Timestamp 2x divider control

By default (value = 0), the sample counter is incremented with I and Q, yielding two counts per sample.

Set this bit to 1 to enable a 2x timestamp divider, effectively achieving 1 timestamp count per sample.

Definition at line 2522 of file libbladeRF.h.

#define BLADERF_GPIO_TX_HB_ENABLE   (1 << 3)

Switch to use TX high band (1.5GHz - 3.8GHz)

Note
This is set using bladerf_set_frequency().

Definition at line 2469 of file libbladeRF.h.

#define BLADERF_GPIO_TX_LB_ENABLE   (2 << 3)

Switch to use TX low band (300MHz - 1.5GHz)

Note
This is set using bladerf_set_frequency().

Definition at line 2462 of file libbladeRF.h.

Function Documentation

API_EXPORT int CALL_CONV bladerf_calibrate_dc ( struct bladerf *  dev,
bladerf_cal_module  module 
)

Perform DC calibration

Parameters
devDevice handle
moduleModule to calibrate
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_config_gpio_read ( struct bladerf *  dev,
uint32_t *  val 
)

Read a configuration GPIO register

Parameters
devDevice handle
valPointer to variable the data should be read into
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_config_gpio_write ( struct bladerf *  dev,
uint32_t  val 
)

Write a configuration GPIO register. Callers should be sure to perform a read-modify-write sequence to avoid accidentally clearing other GPIO bits that may be set by the library internally.

Parameters
devDevice handle
valData to write to GPIO register
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_dac_write ( struct bladerf *  dev,
uint16_t  val 
)

Write value to VCTCXO DAC

Parameters
devDevice handle
valData to write to DAC register
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_expansion_gpio_dir_read ( struct bladerf *  dev,
uint32_t *  val 
)

Read a expansion GPIO direction register

Parameters
devDevice handle
valPointer to variable the data should be read into
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_expansion_gpio_dir_write ( struct bladerf *  dev,
uint32_t  val 
)

Write a expansion GPIO direction register. Callers should be sure to perform a read-modify-write sequence to avoid accidentally clearing other GPIO bits that may be set by the library internally.

Parameters
devDevice handle
valData to write to GPIO register
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_expansion_gpio_read ( struct bladerf *  dev,
uint32_t *  val 
)

Read a expansion GPIO register

Parameters
devDevice handle
valPointer to variable the data should be read into
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_expansion_gpio_write ( struct bladerf *  dev,
uint32_t  val 
)

Write a expansion GPIO register. Callers should be sure to perform a read-modify-write sequence to avoid accidentally clearing other GPIO bits that may be set by the library internally.

Parameters
devDevice handle
valData to write to GPIO register
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_get_timestamp ( struct bladerf *  dev,
bladerf_module  mod,
uint64_t *  value 
)

Retrieve the current timestamp counter value from the FPGA

Parameters
devDevice handle
modModule to perform streaming with
valuePointer to variable the data should be read into
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_lms_get_dc_cals ( struct bladerf *  dev,
struct bladerf_lms_dc_cals dc_cals 
)

Retrieve the current DC calibration values from the LMS6002

Parameters
[in]devDevice handle
[out]dc_calsPopulated with current values
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_lms_read ( struct bladerf *  dev,
uint8_t  address,
uint8_t *  val 
)

Read a LMS register

Parameters
devDevice handle
addressLMS register offset
valPointer to variable the data should be read into
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_lms_set_dc_cals ( struct bladerf *  dev,
const struct bladerf_lms_dc_cals dc_cals 
)

Manually load values into LMS6002 DC calibration registers.

This is generally intended for applying a set of known values resulting from a previous run of the LMS autocalibrations.

Parameters
devDevice handle
dc_calsCalibration values to load. Values set to <0 will not be applied.
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_lms_write ( struct bladerf *  dev,
uint8_t  address,
uint8_t  val 
)

Write a LMS register

Parameters
devDevice handle
addressLMS register offset
valData to write to register
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_si5338_read ( struct bladerf *  dev,
uint8_t  address,
uint8_t *  val 
)

Read a Si5338 register

Parameters
devDevice handle
addressSi5338 register offset
valPointer to variable the data should be read into
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_si5338_set_rx_freq ( struct bladerf *  dev,
unsigned  freq 
)

Set frequency for RX clocks

Parameters
devDevice handle
freqDesired RX frequency in Hz
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_si5338_set_tx_freq ( struct bladerf *  dev,
unsigned  freq 
)

Set frequency for TX clocks

Parameters
devDevice handle
freqDesired TX frequency in Hz
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_si5338_write ( struct bladerf *  dev,
uint8_t  address,
uint8_t  val 
)

Write a Si5338 register

Parameters
devDevice handle
addressSi5338 register offset
valData to write to register
Returns
0 on success, value from Error codes list on failure
API_EXPORT int CALL_CONV bladerf_xb_spi_write ( struct bladerf *  dev,
uint32_t  val 
)

Write value to secondary XB SPI

Parameters
devDevice handle
valData to write to XB SPI
Returns
0 on success, value from Error codes list on failure