Commit graph

41 commits

Author SHA1 Message Date
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
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
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
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
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
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
Jon Szymaniak
3cdf642614 libbladeRF/doc: Overhauled API docs main page and added examples
The main landing page in the Doxygen is now filled out with
some general information.

Existing examples have been simplified and moved to
dedicated pages that are linked to from the main page and
relevant sections of the documentation elsewhere.
2015-06-06 17:01:19 -04:00
Jon Szymaniak
9a9e0586ed libbladeRF/doc: Automatically download logo 2015-06-06 16:48:34 -04:00
Jon Szymaniak
63df91bfd9 libbladeRF/doc: Updated Doxyfile for Doxygen 1.8.8
This addresses some warnings about deprecated features.
2015-03-05 12:14:14 -05:00
Jon Szymaniak
cddede8055 libbladeRF/doc: Fixed relpath to upstream MathJax.js 2015-03-05 11:49:17 -05:00
Jon Szymaniak
f7a4345257 libbladeRF: Added more complete examples for the synchronous interface
The existing bladerf_sync_rx() snippet in the libbladeRF API docs has
been replaced by a more complete snippet in libbladeRF/doc/examples.

From now on, major snippets and examples to be included in
Doxygen-generated documentation shall now be placed in the
libbladeRF/doc/examples directory, and must be buildable and testable.

The Doxygen "snippet" command to shall be used to include the relevant
code from the example program.

libbladeRF: [WIP] Use a simple delay to wait for TX samples in example
2014-10-21 08:01:28 -04:00
Jon Szymaniak
daaa2e92c8 libbladeRF: Re-implemented sync interface, updated API docs, renamed timeout function
The sync interface has been re-implemented atop the existing
asynchronous interface. This is currently opt-in and only enable when
pthreads support is enabled and available.

Some clarifications have been made in the API documentation,
specifically in the explanations of the various stream parameters.

The bladerf_set_transfer_timeout and bladerf_get_transfer_timeout have
been named more appropriately, as these control stream transfer
timeouts, as opposed to all transfers.
2014-03-08 19:55:21 -05:00
Jon Szymaniak
fabc0e89ac libbladeRF: Specified calling convention for Windows and removed unneeded externs
Misc. reformatting and a few doxygen touchups also included.
2013-12-05 23:51:48 -05:00
Jon Szymaniak
30997a9f61 libbladeRF, bladeRF-cli: Reworked cal data generation and misc cleanup
The function to create cal data now is a wrapper around
bladerf_alloc_image() which initializes the returned image with
calibration data.

The associated CLI command now allows this to be either written to a
file or to the device directly.

API header cleanup: Pushed the lower level functions to to the end of
the header, so the functions people will use more frequently will be at
the top of the generated documentation.

Also added a missing API_EXPORT and made the Doxygen color scheme a little
more blue. (Tired of grayscale ;) )

Windows cleanup: Added get_timestamp() implementation, cleaned up
warnings, address some portability issues.
2013-11-28 14:14:38 -05:00
Jon Szymaniak
ce2367c562 libbladeRF: Cleaned up a few minor Doxygen warnings 2013-09-14 17:39:43 -04:00
Jon Szymaniak
d3bee5645f libbladeRF: Fixed Doxygen paths 2013-08-29 21:15:22 -04:00
Jon Szymaniak
51595cf6a6 libbladeRF: Added doxygen generation to build if Doxygen is installed. 2013-08-29 21:09:41 -04:00
Jon Szymaniak
e5b8f42279 Fixed misc. (nonfunctional) typos 2013-08-26 20:06:46 -04:00
Jon Szymaniak
2212f6b219 libbladeRF: Updated doxygen main page with project links 2013-08-25 12:58:22 -04:00
Jon Szymaniak
6a76a4817e libbladeRF: Updated header file and documentation for async changes
Added check that # transfers <= # buffers in bladerf_stream(),
as this is noted in the interface documentation.
2013-08-22 22:28:06 -04:00
Jon Szymaniak
df05b174ec libbladeRF & bladeRF-CLI: Fixed build issues. Moved backend config info.
From henceforth, all backend selection should live in the
backend_config.h.in file, so backend.c or backend.h doesn't get muddied
with #ifdef's.
2013-08-13 23:44:42 -04:00