aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
Commit message (Collapse)AuthorAgeFilesLines
* fixup! docs: e320: Add documentation for gpio and eeprom-flagsJoerg Hofrichter2020-01-221-2/+2
|
* docs: n3xx: document eeprom flagsJoerg Hofrichter2020-01-221-0/+34
| | | | | | | | Add a subsection to both N310- and N320 specific features to document the EEPROM flags simliar to as it is done in the E320 documentation. Signed-off-by: Joerg Hofrichter <joerg.hofrichter@ni.com>
* docs: fixing typos in gpio API example in manualsteviez2020-01-101-10/+7
|
* tools: R&D testing prodecure updated for E3xxSugandha Gupta2020-01-101-25/+42
| | | | | | -Adds embedded mode tests for E310 and E320 to the R&D testing procedure. -Modifies increased rates for 1Gige testing on E320
* dpdk: Add new DPDK stack to integrate with I/O servicesAlex Williams2019-12-201-9/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | docs: Update DPDK docs with new parameters: Parameter names have had their hyphens changed to underscores, and the I/O CPU argument is now named after the lcores and reflects the naming used by DPDK. transport: Add new udp_dpdk_link, based atop the new APIs: This link is tightly coupled with the DPDK I/O service. The link class carries all the address information to communicate with the other host, and it can send packets directly through the DPDK NIC ports. However, for receiving packets, the I/O service must pull the packets from the DMA queue and attach them to the appropriate link object. The link object merely formats the frame_buff object underneath, which is embedded in the rte_mbuf container. For get_recv_buff, the link will pull buffers only from its internal queue (the one filled by the I/O service). transport: Add DPDK-specific I/O service: The I/O service is split into two parts, the user threads and the I/O worker threads. The user threads submit requests through various appropriate queues, and the I/O threads perform all the I/O on their behalf. This includes routing UDP packets to the correct receiver and getting the MAC address of a destination (by performing the ARP request and handling the ARP replies). The DPDK context stores I/O services. The context spawns all I/O services on init(), and I/O services can be fetched from the dpdk_ctx object by using a port ID. I/O service clients: The clients have two lockless ring buffers. One is to get a buffer from the I/O service; the other is to release a buffer back to the I/O service. Threads sleeping on buffer I/O are kept in a separate list from the service queue and are processed in the course of doing RX or TX. The list nodes are embedded in the dpdk_io_if, and the head of the list is on the dpdk_io_service. The I/O service will transfer the embedded wait_req to the list if it cannot acquire the mutex to complete the condition for waking. Co-authored-by: Martin Braun <martin.braun@ettus.com> Co-authored-by: Ciro Nishiguchi <ciro.nishiguchi@ni.com> Co-authored-by: Brent Stapleton <brent.stapleton@ettus.com>
* X310: update UBX/SBX gain settings for phase alignment testingerickshepherdNI2019-12-131-3/+3
| | | | | Update UBX and SBX gain settings in the manual for phase alignment testing.
* docs: Add note about DPDK needing to be built as shared librariesAaron Rossetto2019-12-131-1/+10
|
* docs: fixing doxygen errors reported during makesteviez2019-12-031-9/+9
|
* docs: Change DPDK version to 18.11 and make args use underscoresAlex Williams2019-11-261-27/+27
| | | | | Swap out hyphens for underscores in the DPDK args. Also update list of distributions with the correct DPDK version in the repos.
* Remove proto-RFNoC filesMartin Braun2019-11-264-27/+1
| | | | | | | This commit removes all files and parts of files that are used by proto-RFNoC only. uhd: Fix include CMakeLists.txt, add missing files
* utils: Add RFNoC-specific features to uhd_usrp_probeMartin Braun2019-11-261-0/+6
| | | | | | - --interactive-reg-shell $BLOCKID will let you peek and poke registers in an RFNoC block - Blocks and static connections are printed
* x300/mpmd: Port all RFNoC devices to the new RFNoC frameworkMartin Braun2019-11-261-2/+0
| | | | | | | Co-Authored-By: Alex Williams <alex.williams@ni.com> Co-Authored-By: Sugandha Gupta <sugandha.gupta@ettus.com> Co-Authored-By: Brent Stapleton <brent.stapleton@ettus.com> Co-Authored-By: Ciro Nishiguchi <ciro.nishiguchi@ni.com>
* uhd: Remove support for N230Martin Braun2019-11-261-1/+1
| | | | Note: N230 is still supported on the 3.15 LTS branch
* cmake: Bump dependency versions for UHD 4.0.0.0Martin Braun2019-11-262-9/+2
| | | | | | | | | | | | - Boost >= 1.58 - CMake >= 3.5.1 - gcc >= 5.4.0 - Clang >= 3.8, AppleClang >= 600 - Python >= 3.5 (Py2k no longer supported) - Numpy >= 1.11 - C++14 for lib, include may now use C++11 constructs. - Because there is no more code requiring C++03 syntax, we remove the include-specific clang-format file
* docs: clarifying which devices support DPDKsteviez2019-11-221-3/+6
|
* docs: fixed links where original URL was not accessible anymoreJoerg Hofrichter2019-11-222-2/+2
| | | | Signed-off-by: Joerg Hofrichter <joerg.hofrichter@ni.com>
* docs: added N320/N321 to FPGAmattprost2019-11-071-11/+14
| | | | | Added appropriate references to N321 in the R&D testing doc for the FPGA Functional Verification section.
* docs: Add info on FPGA flavours for E320 and N3xxMartin Braun2019-11-072-1/+50
| | | | This explains what the various FPGA flavours (XG, HG, 1G) are.
* Docs: Adjust FPGA functional verification testsmichael-west2019-10-151-21/+21
| | | | | | | - Reduce long tests from 3600 seconds to 600 seconds. - Remove 2xRX@153.6e6 test for N310 10 GbE (not practical). Signed-off-by: michael-west <michael.west@ettus.com>
* Docs: Fix MPM cmake command for E320michael-west2019-10-151-1/+1
| | | | | | | Add -DMPM_DEVICE=e320 to the command so the E320 version is built and not the N3xx version. Signed-off-by: michael-west <michael.west@ettus.com>
* docs: Fix wrong anchor for PCIe transport paramsMartin Braun2019-10-151-1/+1
|
* docs: Fix more Doxygen warnings due to spurious backslashesMartin Braun2019-10-151-5/+5
|
* docs: Improve man page compression code in CMakeMartin Braun2019-10-141-24/+11
| | | | | | | | | The existing code would fail on the second CMake run when gzip wasn't actually installed, as well as on the first build. The behaviour is modified as follows: - ENABLE_MAN_PAGE_COMPRESSION is made a variable, instead of an option - Its default value is derived from ${GZIP_FOUND}
* N3xx: Remove close-in noise on TXMichael West2019-10-111-0/+3
| | | | | | | | | | | Some close-in noise was observed on TX when using external references. This change reduces the noise by changing U19 to select the GPSDO when references are set to external. Also included is a change to properly read and apply settings from the configuration file. This allows the user to further quiet the transmission by adding 'enable_gps=False' to the configuration file in order to power off the GPSDO. Signed-off-by: Michael West <michael.west@ettus.com>
* n3xx: Disable gpsdo reference source when enable_gps=0Martin Braun2019-10-111-1/+8
| | | | | | | | | | | | | | | When using enable_gps=0, the power to the LTE-Lite GPS chip is turned off, and neither the reference sources (time/clock) nor the location/time data (via gpsd) can be used. This commit disables the gpsdo options for the set_time_source, set_clock_source, and set_sync_source when enable_gps=0 is used, and adds logging to inform the user about this. This behaviour is consistent with X310, where `gpsdo` is only a valid reference if the GPSDO module is plugged in. The manual was also updated accordingly.
* docs: twinrx: Reduce res of TwinRX Block diagram and remove artefactsMartin Braun2019-10-101-0/+0
|
* cmake: make manpage compression an optionMichael Dickens2019-10-091-23/+64
| | | | | | If gzip can't be found, compression is turned off, unless the user requested ENABLE_MAN_PAGE_COMPRESSION in which case an error is returned.
* docs: Add a section on the PCIe NI-RIO transportMartin Braun2019-08-221-0/+25
|
* docs: Improve language on threading for recv() and send()Martin Braun2019-08-221-6/+12
|
* docs: Fix Doxygen warning due to spurious <>Martin Braun2019-08-131-1/+1
|
* docs: Fix Doxygen warnings due to spurious backslashesMartin Braun2019-08-131-1/+1
|
* docs: x300: update docs for multiple timed commandsSame-Writer2019-08-071-0/+5
| | | | | Adding advisory in the X300 manual page regarding issuing multiple timed commands causing device lockups.
* docs: e320/n3xx: Add a section on the BISTMartin Braun2019-07-102-0/+55
|
* docs: ubx: Add documentation for temp_comp_modeMartin Braun2019-06-121-0/+12
|
* cmake: Remove ENABLE_PYTHON3 flag and simplify Python detectionMartin Braun2019-05-242-8/+6
| | | | | | - Makes use of more modern find_package(Python2/3) if available - Moves almost all Python-related code to UHDPython.cmake - ENABLE_PYTHON3 is no longer necessary
* docs: e320: Add documentation for gpio and eeprom-flagsSugandha Gupta2019-05-172-0/+48
|
* docs: n3xx: Add link to README for building custom filesystemsSugandha Gupta2019-05-171-37/+1
|
* docs: e31x: e320: Update docs for E310 MPM versionSugandha Gupta2019-05-176-1080/+649
| | | | - Also updated device args and subdev spec
* docs: Auto-generate build page with min deps versionsMartin Braun2019-04-242-6/+11
| | | | | | The build guide manual page now takes the min versions for the dependencies straight from CMake. This avoids having to update the manual whenever we bump depdendencies.
* cmake: Bump dependency min versionsMartin Braun2019-04-241-5/+4
| | | | | | | | | | - gcc >= 4.8 (same as before) - Clang >= 3.8 - CMake >= 3.5.1 - Boost >= 1.58 Note: This also removes version-specific hacks for older CMake versions. Now that we require 3.5.1 they are no longer necessary.
* docs: Improved Windows-related build instructionsAbdo-Gaber2019-04-221-13/+65
| | | | | | | | | | | - In general, some comments to clarify the dependencies installation and building process for windows users. - Add a comment to the required packages for MSCV. - Provide instructions to install Python requirements. - Add the instructions of NSIS installation. - Add comments to the version match between different installers. - Clarify the instructions of building process using Cmake - Add a subsection to show how a binary UHD installer can be obtained. - Correct the URL of Doxygen.
* docs: Add mention of DPDK support to X3x0Alex Williams2019-04-102-1/+9
|
* docs: Fix various typosf380cedric2019-03-281-12/+12
| | | | | - Missing <br> - Missing spaces between units and values (e.g. 10MHz -> 10 MHz)
* docs: n320: Add note on LO input levelsMartin Braun2019-03-261-0/+3
| | | | FYI, the nominal LO input level on N320 is +5 dBm.
* docs: Fix typo for dpdk-num-mbufs and add config file locationAlex Williams2019-03-251-3/+7
|
* docs: Add comment on chmod+x for SDKs if necessaryMartin Braun2019-03-142-6/+19
| | | | | There are cases where downloading the SDK does not preserve the 'x' bits for the SDK .sh file. This explains how to circumvent that problem.
* uhd: mpm: update all license header w/ "-or-later"Brent Stapleton2019-03-081-1/+1
| | | | Updating all SPDX license identifiers to include "-or-later"
* docs: n310: Add table to explain module and PCB revisionsMartin Braun2019-03-051-0/+20
|
* docs: x300: Add notes on external reference frequenciesMartin Braun2019-02-282-2/+12
|
* doc: n3xx: fixed typo in image name (SD card build)Jörg Hofrichter2019-02-271-1/+1
| | | | | Image name to be provided to bitbake command are named 'developer-image' and 'deployment-image' i.e. with dash, not with underscore