Introduces 8bit SC8_Q11 mode, and overclocking mode changes for bladeRF 2.0 micro.
This commits also fixes several bugs, including a locking bug in libbladeRF.
Help menus and abbreviation support expanded in bladeRF-cli.
This adds a bladerf_get_fpga_bytes() function, which returns the
expected length of the FPGA image.
This is a dynamic replacement for BLADERF_FLASH_BYTE_LEN_FPGA,
which has been removed.
In particular, this is used in spi_flash_write_fpga_bitstream() and
spi_flash_erase_fpga() to determine the number of blocks to erase
during FPGA flashing operations.
This fixes an issue where xA9 boards were not being adequately
erased before writing.
API change:
- bladerf_image_write(): new parameter: bladeRF device handle
Change is inspired by the pending removal of BLADERF_FLASH_EB_SIZE
macro. This macro really shouldn't be exposed to the world, nor
should it be constant as it may change depending on the flash
used on the board.
API new function:
- bladerf_erase_flash_bytes(): new function
Similar to the existing bladerf_erase_flash() function, but
handles the conversion from bytes to flash erase block pages
internally. This function is recommended for new designs because
the erase block size may change depending on the board. This
function also checks for proper alignment along erase block
boundaries.
General changes:
Although the macro still exists (for now), all uses of
BLADERF_FLASH_EB_SIZE have been replaced with equivalent
dev->flash_arch->ebsize_bytes because the value may change depending
on the flash used on the board.
New API functions:
- bladerf_read_flash_bytes()
This function is nearly identical to the existing
bladerf_read_flash() function, but takes the address and length in
units of bytes instead of flash pages. The function performs the
necessary conversions from bytes to pages internally based on the
specific flash architecture in use.
- bladerf_write_flash_bytes()
Same as above, for writes.
New code is advised to use these byte-unit functions instead of the
older page-unit functions because the page size may not be guaranteed to
be 256 bytes in future bladeRF platforms.
API changes:
- bladerf_alloc_image(): new parameter - bladeRF device handle
- bladerf_alloc_cal_image(): new parameter - bladeRF device handle
General changes:
Although the macro still exists (for now), all uses of the
BLADERF_FLASH_TOTAL_SIZE macro have been replaced with equivalent
dev->flash_arch->tsize_bytes because the value may change depending on
teh flash used on the board.
During this process, some function prototypes were modified so the
device handle could be passed in, thus allowing flash architecture
data to be extracted.
- calibration.c: dc_cal_tbl_image_load()
- image.c: is_valid_addr_len()
A few changes to the bladerf_quick_tune structure:
- rename 'profile' to 'rffe_profile' for clarity
- delete 'data[16]' not needed anymore and preserves ABI compatibility
- add 'nios_profile' for indexing the profile stored in the BBP
- add 'port' for storing the RFFE port settings
- add 'spdt' for storing the external RF switch settings
Improvements to bladerf2_get_quick_tune():
- Send rffe_fastlock_save packet to instruct Nios to save a copy of
the RFFE fast lock profile to itself. This means the fast lock
profile data (16 bytes) no longer needs to be transmitted to/from
the Nios and the host machine (retune speedup).
- Save the RFFE port setting to the quick tune structure so it may be
sent down to the Nios when scheduling a retune.
Saving the 16-bytes of fast lock profile data to the host is no longer
necessary because it is stored on the Nios itself. This has two
additional benefits: quicker retunes (the profile data does not need to
be shuffled across USB), and it preserves ABI compatibility because the
size of the bladerf_quick_tune struct does not increase compared to
previous versions of libbladeRF.
Update bladerf_quick_tune structure for bladeRF2 data. It now contains:
- profile (profile number, integer)
- data (profile data, 16 bytes)
Fill in the bladerf2_get_quick_tune() function. The bladeRF2's RFIC uses
the concept of fast lock profiles, of which there are 8 for TX and 8 for
RX. These profiles store the VCO information needed to quickly change
frequencies. To use more than 8 profiles, the profiles may be stored
off-chip, which is what we're doing here.
1. It is assumed the RFIC has been tuned to a particular frequency.
2. The profile is created using ad9361_fastlock_store().
3. The profile is read back and stored in host memory using
ad9361_fastlock_save().
Adds a new API call, bladerf_get_fpga_source(), which queries
the firmware for the source of the most recent FPGA programming.
This requires firmware v2.3.1 or later. Using an older firmware
will result in BLADERF_ERR_UNSUPPORTED.
This adds two new values for the bladerf_trigger_signal enum,
BLADERF_TRIGGER_J51_1 and BLADERF_TRIGGER_MINI_EXP_1, as well
as the necessary backend processing to make them work.
It turns out that it doesn't actually matter which one is chosen;
they all behave identically and interchangeably once they're passed
to the Nios interface functions.
The reason for this change is to reduce confusion, as the bladeRF
x40/x115 use J71-4 for mini_exp[1] and the bladeRF xA4/xA9 use
J51-1.
bladerf_open() will retrieve the SPI flash ID information from
the FX3 and decode it to get the flash density, page size, and other
architectural information required for flash interaction.
If the FX3 firmware does not support flash ID readback, assumptions will
be made based on the FPGA size. If FPGA size is not available, sane
defaults will be used. This should be sufficient to read calibration and
other important data from flash for board operation. Flashing an FPGA,
however, may not work depending on the device specifics.
Adds a bladerf_get_serial_struct function, which is similar
in functionality to bladerf_get_serial, but instead of requiring
a user-supplied buffer of at least BLADERF_SERIAL_LENGTH bytes,
it expects a pointer to a struct bladerf_serial which itself has
a buffer of BLADERF_SERIAL_LENGTH bytes as a member.
This turns BLADERF_SERIAL_LENGTH into an API-internal value,
instead of something that API users have to be intently aware of.
Fixes#382
Adds 'manufacturer' and 'product' members to the
bladerf_devinfo struct, and ensures they are properly
initialized and populated during enumeration.
These contain the human-readable manufacturer and
product names from the USB device descriptor.
Adds new format macros for displaying bladerf_frequency and
bladerf_timestamp values to libbladeRF.h.
Transitions bladerf1.c and bladerf2.c to use these new macros,
and also cleans up a few more places where the typedefs aren't
currently used.
Also fixes a doxygen warning for undocumented #defines in
bladeRF2.h.
Fixes#577Fixes#618Fixes#620
* Revert "bladeRF-cli: ensure device is initialized after deferred open"
This reverts commit 5ed03a3b01.
* Revert "bladeRF-cli: print product string where relevant"
This reverts commit 2ccd6e3d5e.
* Revert "libbladeRF: add 'product' string to devinfo"
This reverts commit 11a71d835a.
* Revert "bladeRF-cli: update print/sets to use typedefs"
This reverts commit a4b176c516.
* Revert "libbladeRF: add format macros for frequency, timestamp"
This reverts commit 1cf6a7871c.
Adds a 'product' member to the bladerf_devinfo struct, and
populates it during device enumeration.
This will contain a human-readable description of the found
device, built from the USB Manufacturer and Product strings.
Adds new format macros for displaying bladerf_frequency and
bladerf_timestamp values to libbladeRF.h.
Transitions bladerf1.c and bladerf2.c to use these new macros,
and also cleans up a few more places where the typedefs aren't
currently used.
These settings generally don't need to be manually adjusted,
because higher-level functions (e.g. bladerf_set_frequency)
handle the setup in coordination with the rest of the RF
hardware (e.g. via bladerf_get_rf_switch_config).
This version of libbladeRF is intended for use with:
FX3 Firmware v2.2.0
FPGA v0.7.3
There are no functional changes since v2.0.1, although there are changes to
the API documentation and the cmake build scripts.
Changes:
* Improve bladerf_gain_mode documentation (#595)
* Don't warn about libusb version on FreeBSD (#594)
Discuss what the gain modes mean in better detail, and also
indicate that the BLADERF_GAIN_*_AGC options are advanced and
require additional implementation work to use effectively.
v2.0.1 (2018-08-24)
--------------------------------
This version of libbladeRF is intended for use with:
FX3 Firmware v2.2.0
FPGA v0.7.3
This release contains minor fixes since v2.0.0.
Note to bladeRF2 users: If you are using bladerf_{get,set}_clock_select(),
please note that the enum for bladerf_clock_select has changed.
CLOCK_SELECT_VCTCXO has been replaced with CLOCK_SELECT_ONBOARD.
Changes:
* FreeBSD build fixes (#561)
* 32-bit architecture fixes (#573)
* Detect and handle a bladeRF Micro that is running old firmware to allow
re-flashing without recovery mode (#578)
* bladeRF1: bladerf_set_gain_mode returning BLADERF_ERR_UNSUPPORTED is no
longer fatal (#542)
* bladeRF1: only check AGC DC LUT setting when enabling AGC
* bladeRF1: typo fix in set_tx_gain (#580)
* xb200: check for null xb_data before dereferencing it (#575)
* bladeRF2: cache factory trimdac value at initialization; preserve trimdac
disable state on bladerf2_trim_dac_write (#582)
* bladeRF2: bladerf_clock_select: replace CLOCK_SELECT_VCTCXO with
CLOCK_SELECT_ONBOARD for clarity (#585)
* Improvements to the release notes (#583)
* bladeRF-cli: Add 200 ms delay before probing PLL lock status (#587)
* Windows: add a nanosleep() shim (#589)
Updates the release notes for v2.0 to include more useful information, less useless information, and fewer typos. More consistent and readable, hopefully.
Also fixes one error in the documentation in libbladeRF.h.
* host: libbladeRF/doxygen: improve 2.0.0 relnotes
Some wording/formatting cleanup here and there.
Add \remarks for most sections to suggest some "do not" and "do" items.
Add some quick documentation on the bias tees, PLL, power status, etc.
* host: libbladeRF: fix doc for bladerf_get_timestamp
* host: libbladeRF/doxygen: more relnotes work
Adding a "What is a channel?" section to describe channels
* libbladeRF: 2.0.0 relnotes: soften wording, misc cleanup
* libbladeRF: relnotes: new section on gain ranges, fixup sectioning for Further Info
* libbladeRF: relnotes: more fixes, cleanup
* libbladeRF: relnotes: more tweaks, getting close
* libbladeRF: relnotes: final changes, honest
* libbladeRF: docs: relnotes 2.0.0 -> relnotes 2.0
This is actually more sensible given the versioning.
* libbladeRF: relnotes: fix typos/spelling
* libbladeRF: relnotes: hand-merge ac6b182c
Update wording
I have a tendency to put 'const' in the middle of the type, e.g. struct bladerf_range const **range
I can argue that it is superior to do it that way, but I don't want to, as it makes no difference and just looks weird :)
* libbladeRF.h: put const at start of type
* board.h: move const to the start of types
* libbladeRF: brf_get_*_range expect bladerf_range**
Previously, the bladerf_get_*_range family of functions expected a
struct bladerf_range *
The gain-related functions turned out to require a double ptr to work
properly. For consistency, this commit changes libbladeRF to use a
double ptr on all the range functions, instead of just the gain ones.
* bladeRF-cli: update get-range function calls
* libbladeRF: add typedefs for common parameter types
This adds typedefs for, and changes libbladeRF.h to use said typedefs
for, the following:
bladerf_gain -> int
bladerf_sample_rate -> unsigned int
bladerf_bandwidth -> unsigned int
bladerf_frequency -> uint64_t
bladerf_timestamp -> uint64_t
bladerf_correction_value -> int16_t