libbladeRF  2.2.0-git
Nuand bladeRF library
libbladeRF.h
Go to the documentation of this file.
1 
22 #ifndef LIBBLADERF_H_
23 #define LIBBLADERF_H_
24 
25 #include <inttypes.h>
26 #include <stdint.h>
27 #include <stdlib.h>
28 
54 #define LIBBLADERF_API_VERSION (0x02020000)
55 
56 #ifdef __cplusplus
57 extern "C" {
58 #else
59 
67 #include <stdbool.h>
68 #endif
69 
70 // clang-format off
71 #if defined _WIN32 || defined __CYGWIN__
72 # include <windows.h>
73 # define CALL_CONV __cdecl
74 # ifdef __GNUC__
75 # define API_EXPORT __attribute__ ((dllexport))
76 # else
77 # define API_EXPORT __declspec(dllexport)
78 # endif
79 #elif defined _DOXYGEN_ONLY_ || defined MATLAB_LINUX_THUNK_BUILD_
80 
82 # define API_EXPORT
83 
85 # define CALL_CONV
86 #else
87 # define API_EXPORT __attribute__ ((visibility ("default")))
88 # define CALL_CONV
89 #endif
90 // clang-format on
91 
107 struct bladerf;
108 
112 typedef enum {
120 
122 #define BLADERF_DESCRIPTION_LENGTH 33
123 
125 #define BLADERF_SERIAL_LENGTH 33
126 
134  uint8_t usb_bus;
135  uint8_t usb_addr;
136  unsigned int instance;
141 };
142 
201 int CALL_CONV bladerf_open(struct bladerf **device,
202  const char *device_identifier);
203 
215 void CALL_CONV bladerf_close(struct bladerf *device);
216 
239 int CALL_CONV bladerf_open_with_devinfo(struct bladerf **device,
240  struct bladerf_devinfo *devinfo);
241 
252 
260 
271 
283 int CALL_CONV bladerf_get_devinfo(struct bladerf *dev,
284  struct bladerf_devinfo *info);
285 
299 int CALL_CONV bladerf_get_devinfo_from_str(const char *devstr,
300  struct bladerf_devinfo *info);
301 
311  const struct bladerf_devinfo *b);
312 
324 bool CALL_CONV bladerf_devstr_matches(const char *dev_str,
325  struct bladerf_devinfo *info);
326 
335 const char *CALL_CONV bladerf_backend_str(bladerf_backend backend);
336 
351 void CALL_CONV bladerf_set_usb_reset_on_open(bool enabled);
352 
370  int64_t min;
371  int64_t max;
372  int64_t step;
373  float scale;
374 };
375 
381 };
382 
387  uint16_t major;
388  uint16_t minor;
389  uint16_t patch;
390  const char *describe;
395 };
396 
400 typedef enum {
407 
412 typedef enum {
413  BLADERF_DEVICE_SPEED_UNKNOWN,
414  BLADERF_DEVICE_SPEED_HIGH,
415  BLADERF_DEVICE_SPEED_SUPER
417 
424 typedef enum {
429 
445 int CALL_CONV bladerf_get_serial(struct bladerf *dev, char *serial);
446 
470 int CALL_CONV bladerf_get_serial_struct(struct bladerf *dev,
471  struct bladerf_serial *serial);
472 
483 int CALL_CONV bladerf_get_fpga_size(struct bladerf *dev,
484  bladerf_fpga_size *size);
485 
496 int CALL_CONV bladerf_get_fpga_bytes(struct bladerf *dev, size_t *size);
497 
512 int CALL_CONV bladerf_get_flash_size(struct bladerf *dev,
513  uint32_t *size,
514  bool *is_guess);
515 
526 int CALL_CONV bladerf_fw_version(struct bladerf *dev,
527  struct bladerf_version *version);
528 
538 int CALL_CONV bladerf_is_fpga_configured(struct bladerf *dev);
539 
549 int CALL_CONV bladerf_fpga_version(struct bladerf *dev,
550  struct bladerf_version *version);
551 
567 int CALL_CONV bladerf_get_fpga_source(struct bladerf *dev,
568  bladerf_fpga_source *source);
569 
579 
589 const char *CALL_CONV bladerf_get_board_name(struct bladerf *dev);
590 
624 typedef int bladerf_channel;
625 
639 #define BLADERF_CHANNEL_RX(ch) (bladerf_channel)(((ch) << 1) | 0x0)
640 
654 #define BLADERF_CHANNEL_TX(ch) (bladerf_channel)(((ch) << 1) | 0x1)
655 
659 #define BLADERF_CHANNEL_INVALID (bladerf_channel)(-1)
660 
662 #define BLADERF_DIRECTION_MASK (0x1)
663 
666 /* Backwards compatible mapping to `bladerf_module`. */
667 typedef bladerf_channel bladerf_module;
668 #define BLADERF_MODULE_INVALID BLADERF_CHANNEL_INVALID
669 #define BLADERF_MODULE_RX BLADERF_CHANNEL_RX(0)
670 #define BLADERF_MODULE_TX BLADERF_CHANNEL_TX(0)
671 
676 #define BLADERF_CHANNEL_IS_TX(ch) (ch & BLADERF_TX)
677 
681 typedef enum {
685 
689 typedef enum {
695 
705 size_t CALL_CONV bladerf_get_channel_count(struct bladerf *dev,
706  bladerf_direction dir);
707 
723 typedef int bladerf_gain;
724 
735 typedef enum {
745 
751 
758 
765 
773 
775 #define BLADERF_GAIN_AUTOMATIC BLADERF_GAIN_DEFAULT
776 
777 #define BLADERF_GAIN_MANUAL BLADERF_GAIN_MGC
778 
783  const char *name;
785 };
786 
813 int CALL_CONV bladerf_set_gain(struct bladerf *dev,
814  bladerf_channel ch,
815  bladerf_gain gain);
816 
827 int CALL_CONV bladerf_get_gain(struct bladerf *dev,
828  bladerf_channel ch,
829  bladerf_gain *gain);
830 
850 int CALL_CONV bladerf_set_gain_mode(struct bladerf *dev,
851  bladerf_channel ch,
852  bladerf_gain_mode mode);
853 
868 int CALL_CONV bladerf_get_gain_mode(struct bladerf *dev,
869  bladerf_channel ch,
870  bladerf_gain_mode *mode);
871 
891 int CALL_CONV bladerf_get_gain_modes(struct bladerf *dev,
892  bladerf_channel ch,
893  const struct bladerf_gain_modes **modes);
894 
908 int CALL_CONV bladerf_get_gain_range(struct bladerf *dev,
909  bladerf_channel ch,
910  const struct bladerf_range **range);
911 
925 int CALL_CONV bladerf_set_gain_stage(struct bladerf *dev,
926  bladerf_channel ch,
927  const char *stage,
928  bladerf_gain gain);
929 
943 int CALL_CONV bladerf_get_gain_stage(struct bladerf *dev,
944  bladerf_channel ch,
945  const char *stage,
946  bladerf_gain *gain);
947 
965 int CALL_CONV bladerf_get_gain_stage_range(struct bladerf *dev,
966  bladerf_channel ch,
967  const char *stage,
968  const struct bladerf_range **range);
969 
985 int CALL_CONV bladerf_get_gain_stages(struct bladerf *dev,
986  bladerf_channel ch,
987  const char **stages,
988  size_t count);
989 
1006 typedef unsigned int bladerf_sample_rate;
1007 
1017  uint64_t integer;
1018  uint64_t num;
1019  uint64_t den;
1021 };
1022 
1040 API_EXPORT
1041 int CALL_CONV bladerf_set_sample_rate(struct bladerf *dev,
1042  bladerf_channel ch,
1043  bladerf_sample_rate rate,
1044  bladerf_sample_rate *actual);
1045 
1060 API_EXPORT
1061 int CALL_CONV
1062  bladerf_set_rational_sample_rate(struct bladerf *dev,
1063  bladerf_channel ch,
1064  struct bladerf_rational_rate *rate,
1065  struct bladerf_rational_rate *actual);
1075 API_EXPORT
1076 int CALL_CONV bladerf_get_sample_rate(struct bladerf *dev,
1077  bladerf_channel ch,
1078  bladerf_sample_rate *rate);
1079 
1089 API_EXPORT
1090 int CALL_CONV bladerf_get_sample_rate_range(struct bladerf *dev,
1091  bladerf_channel ch,
1092  const struct bladerf_range **range);
1093 
1103 API_EXPORT
1104 int CALL_CONV
1105  bladerf_get_rational_sample_rate(struct bladerf *dev,
1106  bladerf_channel ch,
1107  struct bladerf_rational_rate *rate);
1108 
1126 typedef unsigned int bladerf_bandwidth;
1127 
1146 API_EXPORT
1147 int CALL_CONV bladerf_set_bandwidth(struct bladerf *dev,
1148  bladerf_channel ch,
1149  bladerf_bandwidth bandwidth,
1150  bladerf_bandwidth *actual);
1151 
1161 API_EXPORT
1162 int CALL_CONV bladerf_get_bandwidth(struct bladerf *dev,
1163  bladerf_channel ch,
1164  bladerf_bandwidth *bandwidth);
1165 
1175 API_EXPORT
1176 int CALL_CONV bladerf_get_bandwidth_range(struct bladerf *dev,
1177  bladerf_channel ch,
1178  const struct bladerf_range **range);
1179 
1204 typedef uint64_t bladerf_frequency;
1205 
1207 #define BLADERF_PRIuFREQ PRIu64
1208 
1209 #define BLADERF_PRIxFREQ PRIx64
1210 
1211 #define BLADERF_SCNuFREQ SCNu64
1212 
1213 #define BLADERF_SCNxFREQ SCNx64
1214 
1233 API_EXPORT
1234 int CALL_CONV bladerf_select_band(struct bladerf *dev,
1235  bladerf_channel ch,
1236  bladerf_frequency frequency);
1237 
1261 API_EXPORT
1262 int CALL_CONV bladerf_set_frequency(struct bladerf *dev,
1263  bladerf_channel ch,
1264  bladerf_frequency frequency);
1274 API_EXPORT
1275 int CALL_CONV bladerf_get_frequency(struct bladerf *dev,
1276  bladerf_channel ch,
1277  bladerf_frequency *frequency);
1278 
1288 API_EXPORT
1289 int CALL_CONV bladerf_get_frequency_range(struct bladerf *dev,
1290  bladerf_channel ch,
1291  const struct bladerf_range **range);
1292 
1313 typedef enum {
1316 
1319 
1322 
1325 
1328 
1331 
1337 
1343 
1349 
1353 
1358  const char *name;
1360 };
1361 
1377 API_EXPORT
1379  struct bladerf *dev, const struct bladerf_loopback_modes **modes);
1380 
1390  struct bladerf *dev, bladerf_loopback mode);
1391 
1405 API_EXPORT
1406 int CALL_CONV bladerf_set_loopback(struct bladerf *dev, bladerf_loopback lb);
1407 
1416 API_EXPORT
1417 int CALL_CONV bladerf_get_loopback(struct bladerf *dev, bladerf_loopback *lb);
1418 
1542 typedef enum {
1545 
1551 
1557 
1565 
1581 typedef enum {
1596 
1608  uint64_t options;
1610 };
1611 
1627 API_EXPORT
1628 int CALL_CONV bladerf_trigger_init(struct bladerf *dev,
1629  bladerf_channel ch,
1630  bladerf_trigger_signal signal,
1631  struct bladerf_trigger *trigger);
1632 
1653 API_EXPORT
1654 int CALL_CONV bladerf_trigger_arm(struct bladerf *dev,
1655  const struct bladerf_trigger *trigger,
1656  bool arm,
1657  uint64_t resv1,
1658  uint64_t resv2);
1659 
1671 API_EXPORT
1672 int CALL_CONV bladerf_trigger_fire(struct bladerf *dev,
1673  const struct bladerf_trigger *trigger);
1674 
1694 API_EXPORT
1695 int CALL_CONV bladerf_trigger_state(struct bladerf *dev,
1696  const struct bladerf_trigger *trigger,
1697  bool *is_armed,
1698  bool *has_fired,
1699  bool *fire_requested,
1700  uint64_t *resv1,
1701  uint64_t *resv2);
1702 
1719 typedef enum {
1722 
1725 
1732 
1739 
1740  /* RX_MUX setting 0x3 is reserved for future use */
1741 
1744 } bladerf_rx_mux;
1745 
1747 /* Backwards compatible mapping for `bladerf_rx_mux`. */
1748 #define BLADERF_RX_MUX_BASEBAND_LMS BLADERF_RX_MUX_BASEBAND
1749 
1759 API_EXPORT
1760 int CALL_CONV bladerf_set_rx_mux(struct bladerf *dev, bladerf_rx_mux mux);
1761 
1770 API_EXPORT
1771 int CALL_CONV bladerf_get_rx_mux(struct bladerf *dev, bladerf_rx_mux *mode);
1772 
1793 typedef uint64_t bladerf_timestamp;
1794 
1799 #define BLADERF_RETUNE_NOW (bladerf_timestamp)0
1800 
1811  union {
1812  /* bladeRF1 quick tune parameters */
1813  struct {
1814  uint8_t freqsel;
1815  uint8_t vcocap;
1816  uint16_t nint;
1817  uint32_t nfrac;
1818  uint8_t flags;
1819  };
1820  /* bladeRF2 quick tune parameters */
1821  struct {
1822  uint16_t nios_profile;
1823  uint8_t rffe_profile;
1824  uint8_t port;
1825  uint8_t spdt;
1826  };
1827  };
1828 };
1829 
1859 API_EXPORT
1860 int CALL_CONV bladerf_schedule_retune(struct bladerf *dev,
1861  bladerf_channel ch,
1862  bladerf_timestamp timestamp,
1863  bladerf_frequency frequency,
1864  struct bladerf_quick_tune *quick_tune);
1865 
1878 API_EXPORT
1879 int CALL_CONV bladerf_cancel_scheduled_retunes(struct bladerf *dev,
1880  bladerf_channel ch);
1881 
1902 API_EXPORT
1903 int CALL_CONV bladerf_get_quick_tune(struct bladerf *dev,
1904  bladerf_channel ch,
1905  struct bladerf_quick_tune *quick_tune);
1906 
1928 
1938 typedef enum {
1944 
1950 
1956 
1963 
1965 /* Backwards compatible mapping to `bladerf_correction`. */
1966 #define BLADERF_CORR_LMS_DCOFF_I BLADERF_CORR_DCOFF_I
1967 #define BLADERF_CORR_LMS_DCOFF_Q BLADERF_CORR_DCOFF_Q
1968 #define BLADERF_CORR_FPGA_PHASE BLADERF_CORR_PHASE
1969 #define BLADERF_CORR_FPGA_GAIN BLADERF_CORR_GAIN
1970 
1985 API_EXPORT
1986 int CALL_CONV bladerf_set_correction(struct bladerf *dev,
1987  bladerf_channel ch,
1988  bladerf_correction corr,
1989  bladerf_correction_value value);
1990 
2001 API_EXPORT
2002 int CALL_CONV bladerf_get_correction(struct bladerf *dev,
2003  bladerf_channel ch,
2004  bladerf_correction corr,
2005  bladerf_correction_value *value);
2006 
2020 #define BLADERF_PRIuTS PRIu64
2021 
2022 #define BLADERF_PRIxTS PRIx64
2023 
2024 #define BLADERF_SCNuTS SCNu64
2025 
2026 #define BLADERF_SCNxTS SCNx64
2027 
2039 typedef enum {
2096 
2132 } bladerf_format;
2133 
2140 /*
2141  * Metadata status bits
2142  *
2143  * These are used in conjunction with the bladerf_metadata structure's `status`
2144  * field.
2145  */
2146 
2153 #define BLADERF_META_STATUS_OVERRUN (1 << 0)
2154 
2163 #define BLADERF_META_STATUS_UNDERRUN (1 << 1)
2164 
2165 /*
2166  * Metadata flags
2167  *
2168  * These are used in conjunction with the bladerf_metadata structure's `flags`
2169  * field.
2170  */
2171 
2186 #define BLADERF_META_FLAG_TX_BURST_START (1 << 0)
2187 
2214 #define BLADERF_META_FLAG_TX_BURST_END (1 << 1)
2215 
2224 #define BLADERF_META_FLAG_TX_NOW (1 << 2)
2225 
2244 #define BLADERF_META_FLAG_TX_UPDATE_TIMESTAMP (1 << 3)
2245 
2251 #define BLADERF_META_FLAG_RX_NOW (1 << 31)
2252 
2257 #define BLADERF_META_FLAG_RX_HW_UNDERFLOW (1 << 0)
2258 
2263 #define BLADERF_META_FLAG_RX_HW_MINIEXP1 (1 << 16)
2264 
2269 #define BLADERF_META_FLAG_RX_HW_MINIEXP2 (1 << 17)
2270 
2284 
2297  uint32_t flags;
2298 
2306  uint32_t status;
2307 
2321  unsigned int actual_count;
2322 
2327  uint8_t reserved[32];
2328 };
2329 
2376 API_EXPORT
2378  bladerf_format format,
2379  unsigned int buffer_size,
2380  void *samples);
2381 
2404 API_EXPORT
2406  bladerf_format format,
2407  unsigned int buffer_size,
2408  void *samples);
2409 
2432 API_EXPORT
2433 int CALL_CONV bladerf_enable_module(struct bladerf *dev,
2434  bladerf_channel ch,
2435  bool enable);
2436 
2478 API_EXPORT
2479 int CALL_CONV bladerf_get_timestamp(struct bladerf *dev,
2480  bladerf_direction dir,
2481  bladerf_timestamp *timestamp);
2482 
2552 API_EXPORT
2553 int CALL_CONV bladerf_sync_config(struct bladerf *dev,
2554  bladerf_channel_layout layout,
2555  bladerf_format format,
2556  unsigned int num_buffers,
2557  unsigned int buffer_size,
2558  unsigned int num_transfers,
2559  unsigned int stream_timeout);
2560 
2594 API_EXPORT
2595 int CALL_CONV bladerf_sync_tx(struct bladerf *dev,
2596  const void *samples,
2597  unsigned int num_samples,
2598  struct bladerf_metadata *metadata,
2599  unsigned int timeout_ms);
2600 
2634 API_EXPORT
2635 int CALL_CONV bladerf_sync_rx(struct bladerf *dev,
2636  void *samples,
2637  unsigned int num_samples,
2638  struct bladerf_metadata *metadata,
2639  unsigned int timeout_ms);
2640 
2641 
2664 #define BLADERF_STREAM_SHUTDOWN (NULL)
2665 
2671 #define BLADERF_STREAM_NO_DATA ((void *)(-1))
2672 
2674 struct bladerf_stream;
2675 
2723 typedef void *(*bladerf_stream_cb)(struct bladerf *dev,
2724  struct bladerf_stream *stream,
2725  struct bladerf_metadata *meta,
2726  void *samples,
2727  size_t num_samples,
2728  void *user_data);
2729 
2792 API_EXPORT
2793 int CALL_CONV bladerf_init_stream(struct bladerf_stream **stream,
2794  struct bladerf *dev,
2795  bladerf_stream_cb callback,
2796  void ***buffers,
2797  size_t num_buffers,
2798  bladerf_format format,
2799  size_t samples_per_buffer,
2800  size_t num_transfers,
2801  void *user_data);
2802 
2823 API_EXPORT
2824 int CALL_CONV bladerf_stream(struct bladerf_stream *stream,
2825  bladerf_channel_layout layout);
2826 
2854 API_EXPORT
2856  void *buffer,
2857  unsigned int timeout_ms);
2858 
2876 API_EXPORT
2878  void *buffer);
2879 
2880 
2892 API_EXPORT
2893 void CALL_CONV bladerf_deinit_stream(struct bladerf_stream *stream);
2894 
2904 API_EXPORT
2905 int CALL_CONV bladerf_set_stream_timeout(struct bladerf *dev,
2906  bladerf_direction dir,
2907  unsigned int timeout);
2908 
2919 API_EXPORT
2920 int CALL_CONV bladerf_get_stream_timeout(struct bladerf *dev,
2921  bladerf_direction dir,
2922  unsigned int *timeout);
2923 
2953 API_EXPORT
2954 int CALL_CONV bladerf_flash_firmware(struct bladerf *dev, const char *firmware);
2955 
2966 API_EXPORT
2967 int CALL_CONV bladerf_load_fpga(struct bladerf *dev, const char *fpga);
2968 
2979 API_EXPORT
2980 int CALL_CONV bladerf_flash_fpga(struct bladerf *dev, const char *fpga_image);
2981 
2989 API_EXPORT
2990 int CALL_CONV bladerf_erase_stored_fpga(struct bladerf *dev);
2991 
2999 API_EXPORT
3000 int CALL_CONV bladerf_device_reset(struct bladerf *dev);
3001 
3011 API_EXPORT
3012 int CALL_CONV bladerf_get_fw_log(struct bladerf *dev, const char *filename);
3013 
3024 API_EXPORT
3025 int CALL_CONV bladerf_jump_to_bootloader(struct bladerf *dev);
3026 
3042 API_EXPORT
3044 
3068 API_EXPORT
3069 int CALL_CONV bladerf_load_fw_from_bootloader(const char *device_identifier,
3070  bladerf_backend backend,
3071  uint8_t bus,
3072  uint8_t addr,
3073  const char *file);
3074 
3089 typedef enum {
3101 
3103 #define BLADERF_IMAGE_MAGIC_LEN 7
3104 
3106 #define BLADERF_IMAGE_CHECKSUM_LEN 32
3107 
3109 #define BLADERF_IMAGE_RESERVED_LEN 128
3110 
3131 
3137 
3144 
3146  uint64_t timestamp;
3147 
3157 
3162 
3167 
3172  uint32_t address;
3173 
3175  uint32_t length;
3176 
3178  uint8_t *data;
3179 };
3180 
3204 API_EXPORT
3205 struct bladerf_image *CALL_CONV bladerf_alloc_image(struct bladerf *dev,
3207  uint32_t address,
3208  uint32_t length);
3209 
3223 API_EXPORT
3225  struct bladerf *dev, bladerf_fpga_size fpga_size, uint16_t vctcxo_trim);
3226 
3234 API_EXPORT
3235 void CALL_CONV bladerf_free_image(struct bladerf_image *image);
3236 
3252 API_EXPORT
3253 int CALL_CONV bladerf_image_write(struct bladerf *dev,
3254  struct bladerf_image *image,
3255  const char *file);
3256 
3278 API_EXPORT
3279 int CALL_CONV bladerf_image_read(struct bladerf_image *image, const char *file);
3280 
3312 typedef enum {
3315 
3318 
3321 
3325 
3334 API_EXPORT
3335 int CALL_CONV bladerf_set_vctcxo_tamer_mode(struct bladerf *dev,
3337 
3348 API_EXPORT
3349 int CALL_CONV bladerf_get_vctcxo_tamer_mode(struct bladerf *dev,
3351 
3372 API_EXPORT
3373 int CALL_CONV bladerf_get_vctcxo_trim(struct bladerf *dev, uint16_t *trim);
3374 
3385 API_EXPORT
3386 int CALL_CONV bladerf_trim_dac_write(struct bladerf *dev, uint16_t val);
3387 
3402 API_EXPORT
3403 int CALL_CONV bladerf_trim_dac_read(struct bladerf *dev, uint16_t *val);
3404 
3436 typedef enum {
3439 
3445 
3449 
3459 API_EXPORT
3460 int CALL_CONV bladerf_set_tuning_mode(struct bladerf *dev,
3461  bladerf_tuning_mode mode);
3462 
3471 API_EXPORT
3472 int CALL_CONV bladerf_get_tuning_mode(struct bladerf *dev,
3473  bladerf_tuning_mode *mode);
3474 
3497 #define BLADERF_TRIGGER_REG_ARM ((uint8_t)(1 << 0))
3498 
3508 #define BLADERF_TRIGGER_REG_FIRE ((uint8_t)(1 << 1))
3509 
3518 #define BLADERF_TRIGGER_REG_MASTER ((uint8_t)(1 << 2))
3519 
3526 #define BLADERF_TRIGGER_REG_LINE ((uint8_t)(1 << 3))
3527 
3540 API_EXPORT
3541 int CALL_CONV bladerf_read_trigger(struct bladerf *dev,
3542  bladerf_channel ch,
3543  bladerf_trigger_signal signal,
3544  uint8_t *val);
3545 
3557 API_EXPORT
3558 int CALL_CONV bladerf_write_trigger(struct bladerf *dev,
3559  bladerf_channel ch,
3560  bladerf_trigger_signal signal,
3561  uint8_t val);
3562 
3584 API_EXPORT
3585 int CALL_CONV bladerf_config_gpio_read(struct bladerf *dev, uint32_t *val);
3586 
3599 API_EXPORT
3600 int CALL_CONV bladerf_config_gpio_write(struct bladerf *dev, uint32_t val);
3601 
3637 API_EXPORT
3638 int CALL_CONV bladerf_erase_flash(struct bladerf *dev,
3639  uint32_t erase_block,
3640  uint32_t count);
3641 
3655 API_EXPORT
3656 int CALL_CONV bladerf_erase_flash_bytes(struct bladerf *dev,
3657  uint32_t address,
3658  uint32_t length);
3659 
3679 API_EXPORT
3680 int CALL_CONV bladerf_read_flash(struct bladerf *dev,
3681  uint8_t *buf,
3682  uint32_t page,
3683  uint32_t count);
3684 
3700 API_EXPORT
3701 int CALL_CONV bladerf_read_flash_bytes(struct bladerf *dev,
3702  uint8_t *buf,
3703  uint32_t address,
3704  uint32_t bytes);
3705 
3724 API_EXPORT
3725 int CALL_CONV bladerf_write_flash(struct bladerf *dev,
3726  const uint8_t *buf,
3727  uint32_t page,
3728  uint32_t count);
3729 
3744 API_EXPORT
3745 int CALL_CONV bladerf_write_flash_bytes(struct bladerf *dev,
3746  const uint8_t *buf,
3747  uint32_t address,
3748  uint32_t length);
3749 
3772 API_EXPORT
3773 int CALL_CONV bladerf_set_rf_port(struct bladerf *dev,
3774  bladerf_channel ch,
3775  const char *port);
3776 
3786 API_EXPORT
3787 int CALL_CONV bladerf_get_rf_port(struct bladerf *dev,
3788  bladerf_channel ch,
3789  const char **port);
3790 
3805 API_EXPORT
3806 int CALL_CONV bladerf_get_rf_ports(struct bladerf *dev,
3807  bladerf_channel ch,
3808  const char **ports,
3809  unsigned int count);
3810 
3836 typedef enum {
3844 } bladerf_xb;
3845 
3854 API_EXPORT
3855 int CALL_CONV bladerf_expansion_attach(struct bladerf *dev, bladerf_xb xb);
3856 
3865 API_EXPORT
3866 int CALL_CONV bladerf_expansion_get_attached(struct bladerf *dev,
3867  bladerf_xb *xb);
3868 
3885 typedef enum {
3894 
3903 API_EXPORT
3905 
3919 API_EXPORT
3921 
3940 // clang-format off
3941 #define BLADERF_ERR_UNEXPECTED (-1)
3942 #define BLADERF_ERR_RANGE (-2)
3943 #define BLADERF_ERR_INVAL (-3)
3944 #define BLADERF_ERR_MEM (-4)
3945 #define BLADERF_ERR_IO (-5)
3946 #define BLADERF_ERR_TIMEOUT (-6)
3947 #define BLADERF_ERR_NODEV (-7)
3948 #define BLADERF_ERR_UNSUPPORTED (-8)
3949 #define BLADERF_ERR_MISALIGNED (-9)
3950 #define BLADERF_ERR_CHECKSUM (-10)
3951 #define BLADERF_ERR_NO_FILE (-11)
3952 #define BLADERF_ERR_UPDATE_FPGA (-12)
3953 #define BLADERF_ERR_UPDATE_FW (-13)
3954 #define BLADERF_ERR_TIME_PAST (-14)
3955 #define BLADERF_ERR_QUEUE_FULL (-15)
3957 #define BLADERF_ERR_FPGA_OP (-16)
3958 #define BLADERF_ERR_PERMISSION (-17)
3960 #define BLADERF_ERR_WOULD_BLOCK (-18)
3965 #define BLADERF_ERR_NOT_INIT (-19)
3967 // clang-format on
3968 
3976 API_EXPORT
3977 const char *CALL_CONV bladerf_strerror(int error);
3978 
3981 #include <bladeRF1.h>
3982 #include <bladeRF2.h>
3983 
3984 #ifdef __cplusplus
3985 }
3986 #endif
3987 
3988 #endif /* LIBBLADERF_H_ */
uint8_t * data
Definition: libbladeRF.h:3178
API_EXPORT int CALL_CONV bladerf_set_rx_mux(struct bladerf *dev, bladerf_rx_mux mux)
API_EXPORT const char *CALL_CONV bladerf_backend_str(bladerf_backend backend)
API_EXPORT int CALL_CONV bladerf_image_read(struct bladerf_image *image, const char *file)
API_EXPORT int CALL_CONV bladerf_get_correction(struct bladerf *dev, bladerf_channel ch, bladerf_correction corr, bladerf_correction_value *value)
bladerf_gain_mode
Definition: libbladeRF.h:735
API_EXPORT int CALL_CONV bladerf_get_gain_mode(struct bladerf *dev, bladerf_channel ch, bladerf_gain_mode *mode)
API_EXPORT int CALL_CONV bladerf_get_fpga_size(struct bladerf *dev, bladerf_fpga_size *size)
API_EXPORT int CALL_CONV bladerf_get_rx_mux(struct bladerf *dev, bladerf_rx_mux *mode)
bladerf_channel channel
Definition: libbladeRF.h:1605
API_EXPORT bool CALL_CONV bladerf_devinfo_matches(const struct bladerf_devinfo *a, const struct bladerf_devinfo *b)
unsigned int instance
Definition: libbladeRF.h:136
API_EXPORT int CALL_CONV bladerf_get_tuning_mode(struct bladerf *dev, bladerf_tuning_mode *mode)
API_EXPORT int CALL_CONV bladerf_load_fpga(struct bladerf *dev, const char *fpga)
uint16_t minor
Definition: libbladeRF.h:388
API_EXPORT void CALL_CONV bladerf_log_set_verbosity(bladerf_log_level level)
API_EXPORT void CALL_CONV bladerf_deinit_stream(struct bladerf_stream *stream)
char magic[BLADERF_IMAGE_MAGIC_LEN+1]
Definition: libbladeRF.h:3130
char reserved[BLADERF_IMAGE_RESERVED_LEN]
Definition: libbladeRF.h:3161
API_EXPORT void CALL_CONV bladerf_set_usb_reset_on_open(bool enabled)
API_EXPORT void CALL_CONV bladerf_version(struct bladerf_version *version)
API_EXPORT int CALL_CONV bladerf_get_gain_stage_range(struct bladerf *dev, bladerf_channel ch, const char *stage, const struct bladerf_range **range)
bladerf_loopback
Definition: libbladeRF.h:1313
char serial[BLADERF_SERIAL_LENGTH+1]
Definition: libbladeRF.h:3156
API_EXPORT int CALL_CONV bladerf_erase_flash(struct bladerf *dev, uint32_t erase_block, uint32_t count)
API_EXPORT int CALL_CONV bladerf_interleave_stream_buffer(bladerf_channel_layout layout, bladerf_format format, unsigned int buffer_size, void *samples)
int bladerf_channel
Definition: libbladeRF.h:624
API_EXPORT int CALL_CONV bladerf_get_rf_ports(struct bladerf *dev, bladerf_channel ch, const char **ports, unsigned int count)
API_EXPORT int CALL_CONV bladerf_get_stream_timeout(struct bladerf *dev, bladerf_direction dir, unsigned int *timeout)
bladerf_trigger_signal signal
Definition: libbladeRF.h:1607
API_EXPORT int CALL_CONV bladerf_set_rational_sample_rate(struct bladerf *dev, bladerf_channel ch, struct bladerf_rational_rate *rate, struct bladerf_rational_rate *actual)
bladerf_rx_mux
Definition: libbladeRF.h:1719
API_EXPORT bool CALL_CONV bladerf_is_loopback_mode_supported(struct bladerf *dev, bladerf_loopback mode)
bladerf_tuning_mode
Definition: libbladeRF.h:3436
uint16_t major
Definition: libbladeRF.h:387
API_EXPORT bool CALL_CONV bladerf_devstr_matches(const char *dev_str, struct bladerf_devinfo *info)
API_EXPORT int CALL_CONV bladerf_get_loopback_modes(struct bladerf *dev, const struct bladerf_loopback_modes **modes)
bladerf_fpga_source
Definition: libbladeRF.h:424
API_EXPORT int CALL_CONV bladerf_is_fpga_configured(struct bladerf *dev)
uint64_t bladerf_timestamp
Definition: libbladeRF.h:1793
bladerf_loopback mode
Definition: libbladeRF.h:1359
uint16_t nios_profile
Definition: libbladeRF.h:1822
API_EXPORT int CALL_CONV bladerf_get_devinfo_from_str(const char *devstr, struct bladerf_devinfo *info)
uint64_t timestamp
Definition: libbladeRF.h:3146
API_EXPORT int CALL_CONV bladerf_trigger_arm(struct bladerf *dev, const struct bladerf_trigger *trigger, bool arm, uint64_t resv1, uint64_t resv2)
API_EXPORT int CALL_CONV bladerf_get_sample_rate_range(struct bladerf *dev, bladerf_channel ch, const struct bladerf_range **range)
API_EXPORT int CALL_CONV bladerf_get_rf_port(struct bladerf *dev, bladerf_channel ch, const char **port)
API_EXPORT bladerf_dev_speed CALL_CONV bladerf_device_speed(struct bladerf *dev)
API_EXPORT int CALL_CONV bladerf_get_device_list(struct bladerf_devinfo **devices)
void *(* bladerf_stream_cb)(struct bladerf *dev, struct bladerf_stream *stream, struct bladerf_metadata *meta, void *samples, size_t num_samples, void *user_data)
Definition: libbladeRF.h:2723
#define BLADERF_DESCRIPTION_LENGTH
Definition: libbladeRF.h:122
API_EXPORT int CALL_CONV bladerf_get_flash_size(struct bladerf *dev, uint32_t *size, bool *is_guess)
API_EXPORT int CALL_CONV bladerf_set_sample_rate(struct bladerf *dev, bladerf_channel ch, bladerf_sample_rate rate, bladerf_sample_rate *actual)
API_EXPORT const char *CALL_CONV bladerf_strerror(int error)
API_EXPORT int CALL_CONV bladerf_trigger_init(struct bladerf *dev, bladerf_channel ch, bladerf_trigger_signal signal, struct bladerf_trigger *trigger)
API_EXPORT int CALL_CONV bladerf_fpga_version(struct bladerf *dev, struct bladerf_version *version)
bladerf_xb
Definition: libbladeRF.h:3836
char manufacturer[BLADERF_DESCRIPTION_LENGTH]
Definition: libbladeRF.h:139
API_EXPORT int CALL_CONV bladerf_get_quick_tune(struct bladerf *dev, bladerf_channel ch, struct bladerf_quick_tune *quick_tune)
char serial[BLADERF_SERIAL_LENGTH]
Definition: libbladeRF.h:380
uint8_t usb_bus
Definition: libbladeRF.h:134
uint16_t patch
Definition: libbladeRF.h:389
bladerf_vctcxo_tamer_mode
Definition: libbladeRF.h:3312
uint64_t options
Definition: libbladeRF.h:1608
API_EXPORT int CALL_CONV bladerf_get_rational_sample_rate(struct bladerf *dev, bladerf_channel ch, struct bladerf_rational_rate *rate)
API_EXPORT int CALL_CONV bladerf_cancel_scheduled_retunes(struct bladerf *dev, bladerf_channel ch)
API_EXPORT int CALL_CONV bladerf_set_frequency(struct bladerf *dev, bladerf_channel ch, bladerf_frequency frequency)
API_EXPORT int CALL_CONV bladerf_sync_tx(struct bladerf *dev, const void *samples, unsigned int num_samples, struct bladerf_metadata *metadata, unsigned int timeout_ms)
API_EXPORT int CALL_CONV bladerf_erase_flash_bytes(struct bladerf *dev, uint32_t address, uint32_t length)
bladerf_direction
Definition: libbladeRF.h:681
unsigned int bladerf_sample_rate
Definition: libbladeRF.h:1006
API_EXPORT int CALL_CONV bladerf_config_gpio_write(struct bladerf *dev, uint32_t val)
API_EXPORT int CALL_CONV bladerf_get_bandwidth_range(struct bladerf *dev, bladerf_channel ch, const struct bladerf_range **range)
API_EXPORT int CALL_CONV bladerf_get_fpga_source(struct bladerf *dev, bladerf_fpga_source *source)
API_EXPORT int CALL_CONV bladerf_set_bandwidth(struct bladerf *dev, bladerf_channel ch, bladerf_bandwidth bandwidth, bladerf_bandwidth *actual)
API_EXPORT int CALL_CONV bladerf_read_flash(struct bladerf *dev, uint8_t *buf, uint32_t page, uint32_t count)
bladerf_image_type
Definition: libbladeRF.h:3089
API_EXPORT int CALL_CONV bladerf_image_write(struct bladerf *dev, struct bladerf_image *image, const char *file)
API_EXPORT int CALL_CONV bladerf_read_trigger(struct bladerf *dev, bladerf_channel ch, bladerf_trigger_signal signal, uint8_t *val)
API_EXPORT int CALL_CONV bladerf_trigger_fire(struct bladerf *dev, const struct bladerf_trigger *trigger)
API_EXPORT int CALL_CONV bladerf_jump_to_bootloader(struct bladerf *dev)
API_EXPORT int CALL_CONV bladerf_get_vctcxo_tamer_mode(struct bladerf *dev, bladerf_vctcxo_tamer_mode *mode)
API_EXPORT int CALL_CONV bladerf_read_flash_bytes(struct bladerf *dev, uint8_t *buf, uint32_t address, uint32_t bytes)
bladerf_fpga_size
Definition: libbladeRF.h:400
API_EXPORT int CALL_CONV bladerf_flash_firmware(struct bladerf *dev, const char *firmware)
API_EXPORT int CALL_CONV bladerf_set_gain_mode(struct bladerf *dev, bladerf_channel ch, bladerf_gain_mode mode)
uint64_t bladerf_frequency
Definition: libbladeRF.h:1204
API_EXPORT int CALL_CONV bladerf_flash_fpga(struct bladerf *dev, const char *fpga_image)
API_EXPORT int CALL_CONV bladerf_get_bootloader_list(struct bladerf_devinfo **list)
API_EXPORT int CALL_CONV bladerf_schedule_retune(struct bladerf *dev, bladerf_channel ch, bladerf_timestamp timestamp, bladerf_frequency frequency, struct bladerf_quick_tune *quick_tune)
bladerf_format
Definition: libbladeRF.h:2039
uint8_t usb_addr
Definition: libbladeRF.h:135
bladerf_backend
Definition: libbladeRF.h:112
API_EXPORT struct bladerf_image *CALL_CONV bladerf_alloc_cal_image(struct bladerf *dev, bladerf_fpga_size fpga_size, uint16_t vctcxo_trim)
unsigned int bladerf_bandwidth
Definition: libbladeRF.h:1126
API_EXPORT int CALL_CONV bladerf_set_loopback(struct bladerf *dev, bladerf_loopback lb)
API_EXPORT int CALL_CONV bladerf_set_gain(struct bladerf *dev, bladerf_channel ch, bladerf_gain gain)
API_EXPORT const char *CALL_CONV bladerf_get_board_name(struct bladerf *dev)
#define BLADERF_IMAGE_CHECKSUM_LEN
Definition: libbladeRF.h:3106
API_EXPORT int CALL_CONV bladerf_set_gain_stage(struct bladerf *dev, bladerf_channel ch, const char *stage, bladerf_gain gain)
API_EXPORT int CALL_CONV bladerf_device_reset(struct bladerf *dev)
API_EXPORT size_t CALL_CONV bladerf_get_channel_count(struct bladerf *dev, bladerf_direction dir)
API_EXPORT int CALL_CONV bladerf_set_vctcxo_tamer_mode(struct bladerf *dev, bladerf_vctcxo_tamer_mode mode)
API_EXPORT int CALL_CONV bladerf_submit_stream_buffer_nb(struct bladerf_stream *stream, void *buffer)
bladerf_log_level
Definition: libbladeRF.h:3885
API_EXPORT int CALL_CONV bladerf_get_gain_range(struct bladerf *dev, bladerf_channel ch, const struct bladerf_range **range)
API_EXPORT int CALL_CONV bladerf_open(struct bladerf **device, const char *device_identifier)
char product[BLADERF_DESCRIPTION_LENGTH]
Definition: libbladeRF.h:140
API_EXPORT int CALL_CONV bladerf_expansion_get_attached(struct bladerf *dev, bladerf_xb *xb)
API_EXPORT int CALL_CONV bladerf_init_stream(struct bladerf_stream **stream, struct bladerf *dev, bladerf_stream_cb callback, void ***buffers, size_t num_buffers, bladerf_format format, size_t samples_per_buffer, size_t num_transfers, void *user_data)
uint8_t checksum[BLADERF_IMAGE_CHECKSUM_LEN]
Definition: libbladeRF.h:3136
API_EXPORT int CALL_CONV bladerf_get_devinfo(struct bladerf *dev, struct bladerf_devinfo *info)
API_EXPORT void CALL_CONV bladerf_free_image(struct bladerf_image *image)
#define BLADERF_IMAGE_RESERVED_LEN
Definition: libbladeRF.h:3109
int16_t bladerf_correction_value
Definition: libbladeRF.h:1927
API_EXPORT int CALL_CONV bladerf_get_frequency_range(struct bladerf *dev, bladerf_channel ch, const struct bladerf_range **range)
API_EXPORT int CALL_CONV bladerf_stream(struct bladerf_stream *stream, bladerf_channel_layout layout)
API_EXPORT int CALL_CONV bladerf_fw_version(struct bladerf *dev, struct bladerf_version *version)
bladerf_trigger_signal
Definition: libbladeRF.h:1581
#define CALL_CONV
Definition: libbladeRF.h:85
API_EXPORT int CALL_CONV bladerf_write_trigger(struct bladerf *dev, bladerf_channel ch, bladerf_trigger_signal signal, uint8_t val)
API_EXPORT void CALL_CONV bladerf_init_devinfo(struct bladerf_devinfo *info)
API_EXPORT int CALL_CONV bladerf_get_vctcxo_trim(struct bladerf *dev, uint16_t *trim)
API_EXPORT int CALL_CONV bladerf_sync_config(struct bladerf *dev, bladerf_channel_layout layout, bladerf_format format, unsigned int num_buffers, unsigned int buffer_size, unsigned int num_transfers, unsigned int stream_timeout)
API_EXPORT int CALL_CONV bladerf_get_serial(struct bladerf *dev, char *serial)
API_EXPORT int CALL_CONV bladerf_erase_stored_fpga(struct bladerf *dev)
API_EXPORT int CALL_CONV bladerf_get_gain_stages(struct bladerf *dev, bladerf_channel ch, const char **stages, size_t count)
API_EXPORT int CALL_CONV bladerf_write_flash_bytes(struct bladerf *dev, const uint8_t *buf, uint32_t address, uint32_t length)
bladeRF2-specific API
API_EXPORT int CALL_CONV bladerf_get_gain(struct bladerf *dev, bladerf_channel ch, bladerf_gain *gain)
API_EXPORT int CALL_CONV bladerf_write_flash(struct bladerf *dev, const uint8_t *buf, uint32_t page, uint32_t count)
bladerf_backend backend
Definition: libbladeRF.h:131
unsigned int actual_count
Definition: libbladeRF.h:2321
API_EXPORT int CALL_CONV bladerf_trim_dac_read(struct bladerf *dev, uint16_t *val)
API_EXPORT int CALL_CONV bladerf_get_timestamp(struct bladerf *dev, bladerf_direction dir, bladerf_timestamp *timestamp)
API_EXPORT int CALL_CONV bladerf_select_band(struct bladerf *dev, bladerf_channel ch, bladerf_frequency frequency)
uint32_t address
Definition: libbladeRF.h:3172
API_EXPORT void CALL_CONV bladerf_free_device_list(struct bladerf_devinfo *devices)
bladeRF1-specific API
bladerf_gain_mode mode
Definition: libbladeRF.h:784
#define API_EXPORT
Definition: libbladeRF.h:82
const char * describe
Definition: libbladeRF.h:390
bladerf_timestamp timestamp
Definition: libbladeRF.h:2283
API_EXPORT struct bladerf_image *CALL_CONV bladerf_alloc_image(struct bladerf *dev, bladerf_image_type type, uint32_t address, uint32_t length)
uint8_t reserved[32]
Definition: libbladeRF.h:2327
API_EXPORT int CALL_CONV bladerf_get_gain_modes(struct bladerf *dev, bladerf_channel ch, const struct bladerf_gain_modes **modes)
API_EXPORT int CALL_CONV bladerf_get_sample_rate(struct bladerf *dev, bladerf_channel ch, bladerf_sample_rate *rate)
bladerf_trigger_role role
Definition: libbladeRF.h:1606
API_EXPORT int CALL_CONV bladerf_deinterleave_stream_buffer(bladerf_channel_layout layout, bladerf_format format, unsigned int buffer_size, void *samples)
API_EXPORT int CALL_CONV bladerf_get_fpga_bytes(struct bladerf *dev, size_t *size)
API_EXPORT int CALL_CONV bladerf_get_frequency(struct bladerf *dev, bladerf_channel ch, bladerf_frequency *frequency)
#define BLADERF_SERIAL_LENGTH
Definition: libbladeRF.h:125
API_EXPORT int CALL_CONV bladerf_config_gpio_read(struct bladerf *dev, uint32_t *val)
API_EXPORT int CALL_CONV bladerf_set_stream_timeout(struct bladerf *dev, bladerf_direction dir, unsigned int timeout)
int64_t min
Definition: libbladeRF.h:370
API_EXPORT int CALL_CONV bladerf_open_with_devinfo(struct bladerf **device, struct bladerf_devinfo *devinfo)
int64_t max
Definition: libbladeRF.h:371
const char * name
Definition: libbladeRF.h:783
API_EXPORT int CALL_CONV bladerf_enable_module(struct bladerf *dev, bladerf_channel ch, bool enable)
API_EXPORT int CALL_CONV bladerf_set_tuning_mode(struct bladerf *dev, bladerf_tuning_mode mode)
API_EXPORT int CALL_CONV bladerf_get_bandwidth(struct bladerf *dev, bladerf_channel ch, bladerf_bandwidth *bandwidth)
bladerf_dev_speed
Definition: libbladeRF.h:412
bladerf_trigger_role
Definition: libbladeRF.h:1542
API_EXPORT void CALL_CONV bladerf_close(struct bladerf *device)
struct bladerf_version version
Definition: libbladeRF.h:3143
API_EXPORT int CALL_CONV bladerf_get_loopback(struct bladerf *dev, bladerf_loopback *lb)
API_EXPORT int CALL_CONV bladerf_trigger_state(struct bladerf *dev, const struct bladerf_trigger *trigger, bool *is_armed, bool *has_fired, bool *fire_requested, uint64_t *resv1, uint64_t *resv2)
bladerf_correction
Definition: libbladeRF.h:1938
bladerf_image_type type
Definition: libbladeRF.h:3166
API_EXPORT int CALL_CONV bladerf_load_fw_from_bootloader(const char *device_identifier, bladerf_backend backend, uint8_t bus, uint8_t addr, const char *file)
int64_t step
Definition: libbladeRF.h:372
API_EXPORT int CALL_CONV bladerf_submit_stream_buffer(struct bladerf_stream *stream, void *buffer, unsigned int timeout_ms)
bladerf_channel_layout
Definition: libbladeRF.h:689
char serial[BLADERF_SERIAL_LENGTH]
Definition: libbladeRF.h:133
API_EXPORT int CALL_CONV bladerf_set_correction(struct bladerf *dev, bladerf_channel ch, bladerf_correction corr, bladerf_correction_value value)
API_EXPORT int CALL_CONV bladerf_set_rf_port(struct bladerf *dev, bladerf_channel ch, const char *port)
uint32_t length
Definition: libbladeRF.h:3175
API_EXPORT int CALL_CONV bladerf_sync_rx(struct bladerf *dev, void *samples, unsigned int num_samples, struct bladerf_metadata *metadata, unsigned int timeout_ms)
int bladerf_gain
Definition: libbladeRF.h:723
API_EXPORT int CALL_CONV bladerf_trim_dac_write(struct bladerf *dev, uint16_t val)
API_EXPORT int CALL_CONV bladerf_expansion_attach(struct bladerf *dev, bladerf_xb xb)
API_EXPORT int CALL_CONV bladerf_get_gain_stage(struct bladerf *dev, bladerf_channel ch, const char *stage, bladerf_gain *gain)
API_EXPORT int CALL_CONV bladerf_get_fw_log(struct bladerf *dev, const char *filename)
#define BLADERF_IMAGE_MAGIC_LEN
Definition: libbladeRF.h:3103
API_EXPORT int CALL_CONV bladerf_get_serial_struct(struct bladerf *dev, struct bladerf_serial *serial)