Commit graph

71 commits

Author SHA1 Message Date
Ryan Thompson
234fcfeebf doc: added Doxygen support for light and dark modes 2025-04-09 23:17:40 -07:00
Ryan Thompson
0e2a978554 doc: Doxygen config update v1.8.8 > v1.9.8
└> doxygen -u Doxyfile.in
warning: Tag 'TCL_SUBST' at line 247 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1059 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'HTML_TIMESTAMP' at line 1194 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'FORMULA_TRANSPARENT' at line 1475 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'LATEX_SOURCE_CODE' at line 1749 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 1911 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'PERL_PATH' at line 2090 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'CLASS_DIAGRAMS' at line 2103 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'MSCGEN_PATH' at line 2112 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'DOT_FONTNAME' at line 2154 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'DOT_FONTSIZE' at line 2161 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Tag 'DOT_TRANSPARENT' at line 2372 of file 'Doxyfile.in' has become obsolete.
         This tag has been removed.
warning: Changing CLASS_GRAPH option to TEXT because obsolete option CLASS_DIAGRAM was found and set to NO.
2025-04-09 23:17:40 -07:00
Ryan Thompson
a0937cc50c doc: updated buf size limit in examples and tests 2025-04-09 23:17:40 -07:00
Ryan Thompson
73e78639aa doc: fix API sections menu item with Doxygen 1.9.8
The API sections aren't stored as modules anymore. They're topics.
Error likely introduced at doxygen commit: 6d80fc7e5
2025-04-09 23:17:40 -07:00
Ryan Thompson
452af25b50 libbladeRF: examples: frequency range sweep 2024-08-06 18:47:44 -05:00
Ryan Thompson
a91b51974d libbladeRF: added bladerf_print_quick_tune()
Outputs the current quick retune parameters of a bladeRF
device to standard output. It is useful for debugging and verifying the
configuration of quick tune settings.
2024-08-06 18:47:44 -05:00
Ryan Thompson
f046180604 host: CMake minimum version bump to 3.5
Accommodates the following warning issued by CMake v3.27.1.

CMake Deprecation Warning:
  Compatibility with CMake < 3.5 will be removed from a 
  future version of CMake.
2023-10-31 10:28:21 -05:00
Ryan Thompson
2274d380a0 libbladeRF: sync_rx_meta: --buflen argument added
Buffer size can now be assigned through an argument.
2023-07-07 15:44:14 -05:00
Ryan Thompson
d609034851 libbladeRF: sync_rx_meta: --numsamples argument added
Number of samples can now be assigned through an argument.
2023-07-07 15:44:14 -05:00
Ryan Thompson
9faea357d0 libbladeRF: rx_count option added 2023-07-07 15:43:10 -05:00
Ryan Thompson
aa29cda96c libbladeRF: sync_rx_meta: MIMO option functional 2023-06-27 13:22:40 -05:00
Ryan Thompson
f6172a265a libbladeRF: sync_rx_meta: MIMO option added 2023-06-27 13:22:40 -05:00
Ryan Thompson
3f18c4de33 libbladeRF: sync_rx_meta format and rx_count printout 2023-03-31 17:18:01 -05:00
Ryan Thompson
5d3f69271e libbladeRF: rx_count option added 2023-03-31 17:18:01 -05:00
Ryan Thompson
f04d3a8eed libbladeRF: sync_rx_meta logging 2023-03-31 17:18:01 -05:00
Ryan Thompson
cd0e18769d libbladeRF: example options revamped and bitmode sel added 2023-03-31 17:18:01 -05:00
Ryan Thompson
77f079ae7b libbladeRF: example RX meta assigns format through init parameter 2023-03-31 17:18:01 -05:00
Ryan Thompson
04cc3df992 doxygen: recursive search enabled 2023-03-31 17:18:01 -05:00
Robert Ghilduta
7e26f5a5b6 doxygen: provide more clarity for config file search paths 2023-02-28 04:49:41 -08:00
Ryan Thompson
15b7d9c3b6 host: squashed cmake warnings
updated cmake requirement from 2.8 to 2.8.12
2023-02-13 03:28:19 -08:00
Martin Herren (HB9FXX)
5fbcefcbad [ConfigFile] Update doc for new keywords 2022-04-03 19:35:56 -07:00
Rey Tucker
3211d25f4e libbladeRF: configfile.c: fixup biastee options
Rename configuration keys to "biastee_tx" and "biastee_rx"

Use str2bool for consistency

clang-format

Add documentation
2018-11-12 18:35:04 -05:00
Rey Tucker
d73d4648df
libbladeRF: polished release notes for v2.0 (#583)
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
2018-08-24 12:04:39 -04:00
Rey Tucker
75b47007b0 Revert "Cleanup some minor things in relnotes 2.0.0"
This reverts commit ac6b182c95.

This is a temporary revert to allow PR #583 to land.
2018-08-24 12:03:25 -04:00
Robert Ghilduta
ac6b182c95 Cleanup some minor things in relnotes 2.0.0 2018-08-24 06:18:13 -05:00
Rey Tucker
85fd6da22a
host: fix builds on 32-bit platforms (#573)
Builds were failing in various ways on 32-bit platforms, due to various assumptions (and the fact that pretty much everything is 64-bit nowadays). This PR should fix all of them so that it builds clean.

* host: libbladeRF/thirdparty/adi: fix build error on 32-bit systems

sizeof(void*) is not necessarily equal to sizeof(uint64_t)

* host: libbladeRF/doc: fix 32-bit build failure on doc example

sizeof(size_t) does not always equal sizeof(uint64_t)

* host: docker: remove centos-7-i386 build

it doesn't work, and this is an edgy-enough case that i think we'll be
okay with the ubuntu i386 builds

* host: libbladeRF/bladerf2: explicitly note constant types

On non-64-bit platforms, these integer constants can be ambiguous, which
throws compiler warnings.

* host: libbladeRF_test: explicitly note constant types

On non-64-bit platforms, these integer constants can be ambiguous, which
throws compiler warnings.
2018-08-16 18:57:52 -04:00
Rey Tucker
2c950ad246 host: libbladeRF: clang-format doc examples (#56) 2018-05-30 15:27:07 -04:00
Rey Tucker
a0d498e723
host: typedef common parameter types (#51)
* 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
2018-05-25 11:45:38 -04:00
Rey Tucker
c74c6282ad
host: improve platform-independence of bladerf_{set,get}_gain (#48)
The bladerf_{set,get}_gain functions are now reasonably hardware-independent.

On TX channels, setting a gain of 60 dB should result in a CW TX power of roughly 0 dBm.

On RX channels, 60 dB is the maximum gain level.

The ranges returned by bladerf_get_gain_range are adjusted to reflect this.
2018-05-25 10:53:58 -04:00
Rey Tucker
8ebd48ce05
host: Release notes for libbladeRF 2 (#46) 2018-05-23 12:15:20 -04:00
Rey Tucker
5023f0cb03
host: fix build errors and clang-scan warnings (#47)
* devinfo: fix strncpy error

Fix two build errors on Arch:

/root/bladeRF/host/libraries/libbladeRF/src/devinfo.c:308:5:
error: ‘strncpy’ destination unchanged after copying no bytes
[-Werror=stringop-truncation]
/root/bladeRF/host/libraries/libbladeRF/src/devinfo.c:308:5:
error: ‘strncpy’ output truncated before terminating nul copying as many
bytes from a string as its length [-Werror=stringop-truncation]

* bladerf2/params: fix implicit conversion error

/root/bladeRF/host/libraries/libbladeRF/src/board/bladerf2/params.c:437:7:
error: implicit conversion from 'int' to 'int16_t' (aka 'short') changes
value from 32768 to -32768 [-Werror,-Wconstant-conversion]
      32768,      0,      0,      0,      0,      0,      0,      0,
      ^~~~~

* Doxyfile: fix CLANG_ASSISTED_PARSING warning

fixes:

warning: Tag `CLANG_ASSISTED_PARSING' at line 1033 of file
`/root/bladeRF/build/host/libraries/libbladeRF/doc/doxygen/Doxyfile'
belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your
configuration file or upgrade it using "doxygen -u", or recompile
doxygen with this feature enabled.
warning: Tag `CLANG_OPTIONS' at line 1041 of file
`/root/bladeRF/build/host/libraries/libbladeRF/doc/doxygen/Doxyfile'
belongs to an option that was not enabled at compile time.
         To avoid this warning please remove this line from your
configuration file or upgrade it using "doxygen -u", or recompile
doxygen with this feature enabled.

* libbladeRF: fix doxygen build error

fixes:
/home/rtucker/dev/privatebladeRF/host/libraries/libbladeRF/include/libbladeRF.h:2284:
warning: unable to resolve link to `sync_tx_meta.html' for \link command

* bladeRF-fsk: fix clangscan warning

/root/bladeRF/host/utilities/bladeRF-fsk/c/src/correlator.c:261:59:
warning: The left operand of '/' is a garbage value
        corr->ins1->real = corr->ins2->real = samples[i].i/2048.0f;
                                              ~~~~~~~~~~~~^
1 warning generated.

* fpga_common/lms.c: fix clangscan warning

/root/bladeRF/fpga_common/src/lms.c:2329:14: warning: 3rd function call
argument is an uninitialized value
    status = write_vcocap(dev, base, f->vcocap, vcocap_reg_state);
             ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 warning generated.

* test_repeated_stream: fix clangscan warning

/root/bladeRF/host/libraries/libbladeRF_test/test_repeated_stream/src/main.c:284:9:
warning: 1st function call argument is an uninitialized value
        pthread_join(rx_thread, NULL);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 warning generated.

* test_interleaver: fix clangscan warning

/root/bladeRF/host/libraries/libbladeRF_test/test_interleaver/src/main.c:119:17:
warning: 4th function call argument is an uninitialized value
                snprintf((rowstr + rowidx), rowsize - rowidx, "%02x",
*u8buf++);
                ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 warning generated.

* test_tx_gmsk_bursts: fix clangscan warning

/root/bladeRF/host/libraries/libbladeRF_test/test_timestamps/src/test_tx_gmsk_bursts.c:69:5:
warning: 2nd function call argument is an uninitialized value
    printf("  Frequency: %u\n", s->frequency);
    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 warning generated.

* ad9361_api.c: fix clangscan warning

/root/bladeRF/host/libraries/libbladeRF/src/driver/thirdparty/adi/ad9361_api.c:445:3: warning: Value stored to 'ret' is never read
                ret = -ENODEV;
                ^     ~~~~~~~
1 warning generated.

* correlator: another attempt to fix clangscan warning

* Revert "fpga_common/lms.c: fix clangscan warning"

This reverts commit 8cbb5f03f0d0927befa5053e9564df06d13ede72.

* test_interleaver: fixup clang-scan warning

some sloppy init, some messy iteration, the usual :)

/root/bladeRF/host/libraries/libbladeRF_test/test_interleaver/src/main.c:124:17:
warning: 4th function call argument is an uninitialized value

* Revert "ad9361_api.c: fix clangscan warning"

This reverts commit 14a7f8f53f84aeff721a752259ca9596a13e3a2a.

* bladeRF-fsk: fixup clang-scan warning fix
2018-05-23 12:14:26 -04:00
Rey Tucker
9b18caca94
host: doxygen: enable Files tab, ensure rebuild on layout change (#27) 2018-04-06 15:28:51 -04:00
Rey Tucker
d23e2c8bf3
host: libbladeRF: bladerf.c formatting/cleanup and updates (#20)
* host: libbladeRF: clang-format of bladerf.c

* host: libbladeRF: update apply_config_options

Update apply_config_options to use new semantics for channel specifiers
and range min/max determination

Also fix a couple typos

* host: libbladeRF/doc: fixup old channel references
2018-04-03 18:16:21 -04:00
Rey Tucker
9761a90ec2 host: libbladeRF: Add documentation and test program for config file handling (#539)
* host: libbladeRF: fix typo of "bandwidth" cfg file key

* host: libbladeRF: add documentation for config files

* host: libbladeRF: config.c: minor typo fix

* host: libbladeRF_test: add test case for config file parsing

Creates a surrogate config file with a few different scope restrictions,
then makes sure the configuration is applied appropriately in the end.
2018-03-30 14:01:32 -04:00
Vanya A. Sergeev
64a69f569b libbladeRF: update docs and examples with new API 2017-12-21 12:55:04 -05:00
Vanya A. Sergeev
4527d92e89 libbladeRF: split bladerf 1 & 2 specific APIs into their own header files 2017-12-21 12:55:03 -05:00
Vanya A. Sergeev
18c199a358 libbladeRF/doc: move macros after typedefs and enums in doxygen rendering 2017-12-21 12:54:58 -05:00
Rey Tucker
6116d09049 libbladeRF: add compilation hint to boilerplate.c
h/t owen on IRC
2017-08-09 10:58:08 -04:00
Jon Szymaniak
4f2022e8f5 libbladeRF: doc: Place section descriptions at the top of pages 2016-05-28 17:08:53 -04:00
Jon Szymaniak
dfd4255f66 libbladeRF: doc: Simplified API doc layout, main page cleanup
- Hit redundant "Related Pages". This just lists what we have on the
    main page.

- Renamed "Modules" to "API Sections"

- Removed "Data Structures". This just provided a redundant information
    in an awkward manner.

- Removed "Files". This provided little value over just looking at
    libbladeRF.h directly.
2016-05-22 19:20:28 -04:00
Jon Szymaniak
79e263f8d3 libbladeRF: Doxygen typo fix 2016-04-07 15:11:56 -04:00
Jon Szymaniak
97fdeff93d libbladeRF: Check exact sizes when loading/flashing FPGA bitstream
Prevent users from loading/flashing the incorrect FPGA image by checking
against the device's reported FPGA size. This was previously only
done (roughly) when writing the FPGA to flash.

Nuand's official bitstreams to not use compression; the FPGA sizes
are known to be specific sizes.

Those making customizations (e.g., enabling compression) may
use the BLADERF_SKIP_FPGA_SIZE_CHECK environment variable.
2016-04-07 15:08:21 -04:00
Jon Szymaniak
1be8b76b35 libbladeRF/doc: Fixed link to forums 2016-01-12 13:50:46 -05:00
Jon Szymaniak
ef797fd412 libbladeRF/doc: Fixed typos and touched up timestamp calculations
- The calculation for advancing 150 ms was incorrect
- Compute timestamp increment constants to be more clear
2015-12-23 23:14:31 -05:00
Jon Szymaniak
c262e84bf4 libbladeRF/doc/examples: Report "have tx data" in sync_rxtx example
This flag needs to be asserted true in the dummy do_work()
implementation to allow this to function as an example that works "out
of the box."
2015-11-24 10:48:13 -05:00
Jon Szymaniak
da8b05a116 libbladeRF/doc: Removed zero-padding mention
Removed this to avoid confusion, as it's no longer required
(as of libbladeRF v1.3.0).
2015-07-25 15:30:19 -04:00
Jon Szymaniak
2b7bb2a8f0 libbladeRF/doc: Clarified use of zero-sample in example 2015-07-25 15:30:19 -04:00
Jon Szymaniak
0ce918f4c0 libbladeRF/doc: Updated tune timing results for new SPI controller 2015-06-18 20:20:58 -04:00
Jon Szymaniak
2ffec7f041 libbladeRF/doc: Added description of BLADERF_FORCE_LEGACY_NIOS_PKT 2015-06-18 20:20:58 -04:00
Jon Szymaniak
3dc14852af libbladeRF: Added documentation for new tuning functionality 2015-06-18 18:34:30 -04:00