aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
Commit message (Collapse)AuthorAgeFilesLines
* doc: Fix generation of man pagesZlika2022-07-201-1/+1
| | | | Reviewed-by: Steven Koo <steven.koo@ni.com>
* doc: Remove ZBX phase sync documentationLars Amsel2022-07-201-16/+0
| | | | | | The current ZBX documents how to use the phase sync feature. Because phase sync is not working yet, the documentation should be removed as well.
* docs: DPDK Linux kernel underruns solutionmattprost2022-07-201-5/+21
| | | | | | | | | Previously we had documented a known issue involving the Linux kernel, which was causing a streaming performance regression. This resulted in periodic underruns. We now know what is causing the regression. Document the procedure to restore the original behavior. Signed-off-by: mattprost <matt.prost@ni.com>
* docs: Update section on radio transport protocolsMartin Braun2022-06-101-16/+14
|
* docs: n310: Add Filter API sectionmattprost2022-04-071-0/+91
| | | | | Co-authored-by: bpadalino <bpadalino@gmail.com> Signed-off-by: mattprost <matt.prost@ni.com>
* rfnoc: Modify prop. propagation algorithm (back-edge resolution)Martin Braun2022-04-071-11/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously, the property propagation algorithm would first forward and resolve properties only along forward edges. Then, we would check that properties also align across back-edges. The assumption is that graphs are always structured in a way such that back-edges would align when the resolution is done. However, for the following graph, this would fail: Radio ---> Replay ^ | +---------+ The reason is that the radio block and the replay block both have an "atomic_item_size" property, which needs to be resolved both ways. If the default atomic_item_size is 4 for the radio, and 8 for the replay block, then the input atomic_item_size on the radio will never be aligned with the output atomic_item_size of the replay block, and there is no other mechanism to align those. The solution is to run the edge property propagation and resolution twice, first for the forward edges, then for the back-edges. For graphs that would previously work, this makes no difference: The additional step of propagation properties across the back-edges will not dirty any properties. However, for graphs like the one above, it will provide an additional resolution path for properties that are otherwise not connected.
* multi_usrp_rfnoc: Add TX buffering using Replaymichael-west2022-04-072-0/+16
| | | | | | | | | | | Enabled with the "tx_replay_buffer" device argument. Buffers TX data in DRAM using the Replay block (version 1.1 or higher required), allowing more buffering of data on the device. May reduce underruns for certain applications. The Replay block is currently limited to 32 play commands, so fewer calls to send() with larger buffers will perform better than more calls with smaller buffers. Signed-off-by: michael-west <michael.west@ettus.com>
* docs: e31x: Update information on GPIO pin headerMartin Braun2022-04-062-8/+18
| | | | | - Note on drawing power from the 3.3V rail - Clarified purpose of Pins 2 and 4 (peripheral I2C bus)
* dpdk: Add support for DPDK 18.11 APImattprost2022-04-011-1/+2
| | | | | | | | Substituting old values to restore API breakage from DPDK 18.11 to DPDK 19. It is recommended at this point that users upgrade to more recent DPDK LTS versions, but the DPDK 18.11 API is functional with UHD. Signed-off-by: mattprost <matt.prost@ni.com>
* docs: add 100GigE documentationVirendra Kakade2022-04-013-9/+39
| | | | | Signed-off-by: Virendra Kakade <virendra.kakade@ni.com> Co-authored-by: Wade Fife <wade.fife@ettus.com>
* docs: Move X4x0 GPIO API to be subpageLane Kolbly2022-03-301-1/+1
|
* docs: Update E320 docsMartin Braun2022-03-281-1/+15
| | | | | - Clarify purpose of 'enclosure' flag - Add section on clock and time sync, which the E31x section already has
* docs: x4xx: Remove redundant GPIO sectionLane Kolbly2022-03-251-4/+0
|
* tools: Add general purpose tool for USRP configurationLars Amsel2022-03-2314-10/+185
| | | | | | | | Over the years the UHD code base got a whole bunch of tools to control and configure devices. This is an attempt to unify these tools into one. Co-authored-by: Alexander Weber <alexander.weber@ni.com>
* docs: Improve table on 'identification'Martin Braun2022-03-231-8/+8
|
* fixup! docs: Update instructions for changing hostnameWade Fife2022-03-231-2/+2
|
* docs: Update instructions for changing hostnameWade Fife2022-03-233-12/+12
|
* docs: Update sfp port config locationWade Fife2022-03-232-4/+4
|
* docs: Update manual for new X410 default targetsWade Fife2022-03-141-0/+14
|
* docs: Fix Doxygen warningsMartin Braun2022-03-142-18/+5
| | | | | | - Removed variables that have been deprecated in newer Doxygen versions - Replaced <speedgrade> with $speedgrade in E310 manual; Doxygen thinks it's an HTML tag.
* docs: Fix reference to RFNoC documentationMartin Braun2022-03-141-1/+7
| | | | This fixes links to RFNoC docs in the "Coding to the API" section.
* docs: rdtesting: Remove invalid rate configurationMartin Braun2022-03-141-1/+0
| | | | | Removes an invalid rate configuration for N310 functional FPGA verification tests.
* docs: n3xx: Add info on customizable band edges and gain profilesMartin Braun2022-03-091-0/+45
|
* docs: x4xx: Add new FPGA image descriptionsWade Fife2022-03-041-20/+44
|
* docs: Remove superfluous stylesheetMartin Braun2022-02-241-102/+0
| | | | | This was left over from when the manual was ported to Doxygen in a74919c2. It is not used by Doxygen.
* cmake: doxygen: Make MATHJAX_RELPATH configurable via CMakeMartin Braun2022-02-242-1/+5
| | | | | | | | | | | | | | | | | This is a Doxygen setting where to find MathJax. The default might not be suitable for everyone, and in particular, if people already have MJ installed on their local system, they might prefer using that instead of an online one. Example usage: Assume you have MathJax installed locally, e.g., through the mathjax package on Fedora, or the libjs-mathjax package on Debian/Ubuntu. Then you could build UHD as such: cmake -DMATHJAX_RELPATH=/usr/share/javascript/mathjax This will now use the local version. Note that locally generated HTML documentation can now no longer be copied to other machines, unless they also have MathJax installed to the same path.
* docs: x310: Remove reference to ORCMartin Braun2022-02-211-1/+1
| | | | UHD no longer depends on ORC since 41812aa2f (merged 2015).
* docs: Update n3xx tuning notesSteven Koo2022-02-161-4/+8
| | | | | | | n32x is specced to 3 Mhz. Added a note about performance below specced frequency minimums Signed-off-by: Steven Koo <steven.koo@ni.com>
* docs: Remove full path names from Doxygen generationMartin Braun2022-02-111-1/+1
| | | | | The full path names can cause non-reproducible builds, because they include the build directory.
* docs: Add shim Sphinx config for readthedocsMartin Braun2022-02-015-0/+223
| | | | | | | | | This adds a faux Sphinx project under host/docs. When invoking sphinx, it will in fact forward the generator request to Doxygen. This is useful for generating the UHD manual, e.g., on readthedocs. To enable the latter service, .readthedocs.yaml and environment.yml files were added as well.
* fpga: x400: Add GPIO control via ATR and DB stateJavier Valenzuela2022-01-252-4/+32
|
* host: fix build with DPDK v21.11 LTSLuca Boccassi2022-01-201-6/+6
| | | | | | | | | | | | | Some APIs were changed with the latest DPDK LTS release, add some ifdefs to fix the build. Fixes https://github.com/EttusResearch/uhd/issues/547 Updated CMake file to reflect updated DPDK version. Fixed mbuf size to take ethernet headers into account. Updated documentation. Co-authored-by: Martin Anderseck <martin.anderseck@ni.com>
* docs: Improve page on RFNoC block propertiesMartin Braun2022-01-141-13/+19
| | | | | | - Fix some minor formatting - Add emphases where appropriate - Minor clarifications
* SPI: Implement SPI engine for x410Martin Anderseck2022-01-131-0/+63
| | | | | Add SPI Core host implementation for x410 and a discoverable feature to make it accessible.
* rfnoc: Add atomic item size property for RFNoC blocksLars Amsel2022-01-101-0/+10
| | | | | | | | | | | | | | | An RFNoC block (like the radio) might require a minimal number of items in each clock cycle, e.g. the radio has to process SPC (samples per cycle). Because data in RFNoC is transmitted and processed in packets, we have to make sure the items inside these packets are a multiple of the items processed in each cycle. This commit adds an atomic item size properties which is set by the radio and adapted by the streamers. The streamers adapt the SPP property of the radio block controller depending on the MTU value. This might lead to an SPP value which does not align with the SPC value of the radio block, hence we add a property resolver for the atomic item size.
* e31x/e320: Amend LO-locked sensor namesMartin Braun2022-01-101-14/+17
| | | | | | | | | In UHD 3, we had two sensors names for LO lock on these devices: lo_lock, and lo_locked. The latter is the more standard, and is checked in examples like rx_samples_to_file. In UHD 4, the latter was removed without comment. This adds the sensor back again and also updates the documentation accordingly.
* host: docs: Fix incorrect usage in GPIO docsLane Kolbly2022-01-051-4/+4
|
* docs: Fix page on GPIOMartin Braun2022-01-052-52/+21
| | | | | | | | | - Referred to E310 as E3x0, but that's wrong. E320 has a different GPIO bank naming scheme. - Fails to mention N3x0. This change makes the page mostly device-agnostic (X410 GPIO control is still elsewhere). - The first example had a typo (wrong pin was selected in ATR example). - The second example added nothing, and was removed for clarity.
* docs: Fix MathJax formulae renderingAaron Rossetto2021-12-161-1/+1
| | | | | | | | | | When a webpage is accessed via secure HTTP, and that webpage attempts to address active content via a non-secure URI, most modern browsers will block the loading of that content as a security precaution. In this case, the URI to the MathJax JavaScript rendering library was specified in the Doxygen configuration with an HTTP (i.e., non-encrypted) URI, thus preventing the browser from loading it and rendering formulae correctly.
* docs: Amend page on RFNoC propertiesMartin Braun2021-12-161-2/+12
| | | | Add an additional paragraph on back-edges, and when *not* to declare them.
* docs: remove bmaptool instructions for writing filesystemsMatthew Crymble2021-12-141-3/+3
| | | | | | Due to a change in Mender, bmaptool is no longer supported for writing filesystem images. Currently, the only recommended method for writing a filesystem to an SD card is to use dd. The filesystem can still be updated in place using mender.
* docs: Remove obsolete man pagesMartin Braun2021-12-083-112/+0
| | | | | | The man pages for usrp_x3xx_fpga_burner and octoclock_firmware_burner are obsolete; the corresponding utilities were replaced by uhd_image_loader many UHD versions ago.
* docs: Update DPDK documentationAndrew Lynch2021-12-061-13/+37
|
* docs: Improve documentation for properties and -propagationMartin Braun2021-12-034-1/+466
|
* docs: Several minor manual improvementsMartin Braun2021-11-166-10/+49
| | | | | | | - Remove documentation of skip_dram, skip_ddc, skip_duc, which are all obsolete since UHD 4 - Properly document serialize_init - Add a table of valid args for X310 as with other devices
* doc: x4xx: Document configuring eth0 static IPLane Kolbly2021-11-091-1/+28
|
* docs: x410: Document GPIO API and capabilitiesLane Kolbly2021-11-054-0/+251
|
* docs: Collect all RFNoC block controllers in a module in the manualMartin Braun2021-11-051-0/+12
| | | | | | This lets Doxygen create a page in the UHD manual that lists all RFNoC block controllers. It will be accessible under Manual -> Modules -> RFNoC -> RFNoC Blocks shipped with UHD.
* docs: Align dependencies and bump deb package versionsMartin Anderseck2021-11-022-4/+7
| | | | | | Aligning dependencies between KB entries and documentation for Ubuntu 20.04 and bumping version numbers in the installation documentation to latest available versions in Ubuntu and PPA.
* docs: Fix GPIO documentation exampleLane Kolbly2021-10-201-5/+5
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-26 19:21:42 +0000