aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
Commit message (Collapse)AuthorAgeFilesLines
* 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
* python: Replace Boost.Python with PyBind11Martin Braun2019-02-221-10/+22
| | | | | | This does not change the Python API itself, but it is still a significant change. Most importantly, it removes the dependency on Boost.Python.
* docs: Add note on manually disabling NEON extensionsMartin Braun2019-02-151-0/+11
|
* docs: fix broken link in DPDKBrent Stapleton2019-02-121-1/+1
| | | | The link to the MPM page in the DPDK docs was incorrectly named. This change links to the correct page name.
* docs: n3xx: fix Salt formattingBrent Stapleton2019-02-121-1/+2
| | | | Fixes issue where Doxygen doesn't recognize a block within N3XX's Salt subsection as code.
* docs: N3xx page shell formatting and bb imageMarcus Müller2019-02-111-2/+5
|
* Docs: Update DPDK dep commandnatetemple2019-02-061-1/+1
|
* docs: Document FPGA functional verification test for N320Alex Williams2019-01-311-0/+101
|
* docs: Add information about what dpdk_zero_copy is doingAlex Williams2019-01-291-2/+9
| | | | | | This adds some info about what is happening in the dpdk_zero_copy transport, especially the fact that there are threads spun off that take over CPUs.
* docs: Adding manual page for DPDKBrent Stapleton2019-01-293-1/+151
| | | | Co-authored-by: Alex Williams <alex.williams@ni.com>
* docs: Add manual page for the N320/N321Martin Braun2019-01-217-10/+187
| | | | | | | Since the N32* is part of the N3XX family, it shares a page with N300/N310. Co-authored-by: Mark Meserve <mark.meserve@ni.com>
* docs: Add comments for TwinRX and MCRMartin Braun2019-01-152-0/+25
| | | | | | The TwinRX dboards only support a master clock rate of 200 MHz, which is now emphasized in the manual. In addition, the meaning of tick rate, sampling rate, and master clock rate in the TwinRX context is explained.
* docs: Add manual page on compat numbersMartin Braun2019-01-022-0/+191
|
* docs: python: add documentation on GIL releaseBrent Stapleton2018-11-291-0/+23
| | | | | Adding documentation explaining where the Python API releases the Python GIL, and what that means for users.