aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: Remove reference to Python sixMartin Braun2021-01-081-1/+0
| | | | | six is no longer in use within UHD, this is a stray reference in the build documentation.
* python: multi_usrp: Add get_mpm_client() API callMartin Braun2020-12-041-0/+22
| | | | | | | | | | | This is a new API call, only available on Python, and only available for MPM devices (it is added dynamically). It returns an object that allows calling RPC calls in a Pythonic manner. Example: >>> rpcc = usrp.get_mpm_client() >>> print(rpcc.get_device_info()) # Will print device info, as returned # by uhd_find_devices
* docs: mpm: correct ? notation to display helpJoerg Hofrichter2020-12-041-2/+2
| | | | | For displaying the docstring of a command, the ? character needs to be prepended to the command, not appended.
* Docs: Update Python3 dependenciesmichael-west2020-10-061-9/+12
| | | | Signed-off-by: michael-west <michael.west@ettus.com>
* docs: Fix sensor names for N3xx boardsMartin Braun2020-10-061-1/+2
|
* docs: Add new CHDR format to transportsWade Fife2020-09-111-9/+21
|
* docs: Updated register maps for UHD 4.0Wade Fife2020-09-112-35/+28
| | | | | | | | | Updates e3xx and n3xx register map documentation. - Add new RFNoC registers - Remove depreicated RFNoC registers - Add other missing registers - Correct formatting
* docs: New mender commands for Zeus filesystemsmattprost2020-09-092-6/+6
| | | | Signed-off-by: mattprost <matt.prost@ni.com>
* doc: add section about network mode on E3xx devicesRobertWalstab2020-09-091-0/+16
|
* docs: Add DPDK link detection sectionAaron Rossetto2020-09-031-1/+17
|
* docs: Add Windows-specific UHD Python module notesAaron Rossetto2020-09-031-0/+30
|
* docs: Add note about compiling on Ubuntu 20.04Aaron Rossetto2020-09-031-0/+31
|
* docs: Fix daughterboard page formattingMartin Braun2020-07-241-3/+3
|
* docs: Update PCIe xport instructions for NI ReposSteven Koo2020-07-201-46/+100
| | | | | This is an update to the documentation for installing the RIO PCIe transport infrastructure using the NI Linux Device Driver repository.
* docs: n3xx: Include WX in table of N320 imagesSteve Czabaniuk2020-07-091-8/+8
|
* docs: Add comments on mpm.confMartin Braun2020-07-092-2/+65
| | | | | This adds some more details on mpm.conf, what it does, how it works, and which keys it accepts.
* cal: change default extension of calibration filesLars Amsel2020-06-231-2/+2
| | | | | | | | | Flatbuffers offers an option to set the default extension for binary files. Our calibration files have the extension .cal. Set the extension in all schema files to ease conversion between binary and text representation of calibration files. Updated documentation accordingly.
* cal: Add switch documentationLars Amsel2020-06-151-2/+24
| | | | | | | | | Add chapter to explain usage of supported switch classes which handle connection of DUT and measurement devices. Documentation is done for ManualSwitch (default) and NI switch for devices that can be used by the niswitch Python package. Co-authored-by: Martin Braun <martin.braun@ettus.com>
* x300: Enable power reference APIMartin Braun2020-06-102-0/+37
| | | | | | | | | This enables the power calbration API for X300 and X310. The uhd_power_cal.py script will be able to create calibration files for X300 series USRPs. The multi_usrp calls *_power_reference will be functional, assuming there is calibration data available for the given system.
* b200: Enable power calibration APIMartin Braun2020-06-031-0/+9
| | | | | | This lets the B200 transmit and/or receive at given reference power levels. Requirement is that the devices have been separately calibrated with an external calibration device.
* utils/python: Add uhd_power_cal scriptMartin Braun2020-05-281-0/+117
| | | | This is a tool for running power calibration.
* fixup! cal: Add doxygen section to explain conversion from and to JSONLars Amsel2020-05-271-5/+5
|
* cal: Add doxygen section to explain conversion from and to JSONLars Amsel2020-05-271-0/+25
|
* tests: updated devtest runner to use standard device argsMatthew Crymble2020-05-271-1/+1
| | | | | This will allow run_testsuite.py to be called for specific devices instead of all devices for a certain type.
* docs: Fix some Doxygen warningsMartin Braun2020-05-201-2/+2
| | | | | Disables CLANG_ASSISTED_PARSING and CLANG_OPTIONS, which are not available in all Doxygen version, and are unused.
* docs: build: Improve build and git instructionsMartin Braun2020-05-201-15/+16
| | | | | | - Change the git URL to https (from git protocol) - Remove references to fpga-src - Update branch information (removed references to maint)
* docs: x300: Fix fpga pathMartin Braun2020-05-201-1/+1
| | | | | When the FPGA repo was merged back into the UHD repository, this line was forgotten.
* docs: Remove six from Windows build instructionsMartin Braun2020-05-121-2/+1
| | | | | Recent commits have removed all usage of the 'six' Python module from UHD, thus removing the necessity to install it.
* Docs: Update TwinRX documentationMichael West2020-05-121-13/+23
| | | | | | Revise tick rate and sample rate information for recent changes. Signed-off-by: Michael West <michael.west@ettus.com>
* uhd: doc: Fix Doxygen warnings on 1.8.13Aaron Rossetto2020-05-051-22/+77
|
* uhd: doc: fixed nested comment warningLars Amsel2020-05-041-2/+1
| | | | Fixed nested comment warning by escaping /* sequence in file path.
* uhd: doc: fixed doxygen deprecation warningsLars Amsel2020-05-041-952/+1604
| | | | | removed doxgen deprecation warnings by running `doxygen -u` against Doxygen.in
* uhd: Add reference power level API to multi_usrp and radio_controlMartin Braun2020-04-172-0/+155
| | | | | | | | | | | | | | | | | | This adds the following API calls: - multi_usrp::has_{rx,tx}_power_reference() - multi_usrp::set_{rx,tx}_power_reference() - multi_usrp::get_{rx,tx}_power_reference() - radio_control::has_{rx,tx}_power_reference() - radio_control::set_{rx,tx}_power_reference() - radio_control::get_{rx,tx}_power_reference() It also adds a manual page explaining the philosophy of the API. Note that this does not actually add this feature to any device implementation. Calling the new API calls will thus result in `uhd::not_implemented_error` exceptions being thrown. This commit is to lock down the API and ABI.
* docs: Add stream and transport args documentationAaron Rossetto2020-04-132-6/+210
| | | | | | Add some additional documentation to the Configuration Devices and Streamers and Transport Notes pages regarding stream arguments and their use.
* fixup! docs: Update Basic/LF dboard references to use new operating modeMartin Braun2020-04-071-6/+6
|
* uhd: paths: Harmonize around XDG Base Directory specificationMartin Braun2020-04-022-12/+12
| | | | | | | | | | | | | | | | | | | | | | Up until now, we completely ignore the XDG specification. This commit does the following to change that: - It uses XDG_DATA_HOME and XDG_CONFIG_HOME for cal and config data, respectively. - If config data is in ~/.uhd/uhd.conf, that is still accepted, but if it conflicts with $XDG_CONFIG_HOME/uhd.conf, it is ignored and a warning is displayed - The default location for cal data is thus ${HOME}/.local/share/uhd/cal on Unix, and %LOCALAPPDATA%\uhd\cal on Windows. This is a change in location! - The UHD_CONFIG_DIR environment variable was confusingly named and is now removed. It provided an alternative location than the home directory. The same purpose is now much better served by XDG_DATA_HOME and XDG_CONFIG_HOME. The specification can be found here: specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
* utils: Add convert_cal_data utilityMartin Braun2020-04-021-0/+2
| | | | | | | | | This will convert cal data files based on CSV to the new binary format. In most cases, running ./convert_cal_data.py is sufficient.
* uhd: cal: Use usrp::cal::database instead of CSV filesMartin Braun2020-04-021-6/+18
| | | | | | | | | Now that we have cal::iq_cal and cal::database, there's no need to manually wrangle CSV files for calibration data. This commit replaces all CSV operations with cal::database calls and uses cal::iq_cal as a container. CSV files can still be read, but are considered deprecated.
* uhd: cal: Add iq_cal calibration data container classMartin Braun2020-04-021-1/+1
| | | | | | | | This class can be used to store calibration coefficients for the X300 DC offset and IQ imbalance calibration. Note: This also modifies Doxyfile.in to not document files generated by flatc.
* docs: Update Basic/LF dboard references to use new operating modemattprost2020-03-312-21/+31
| | | | | | | | | | | | | | | On the new RFNoC with UHD 4.0 architecture, Basic/LF dboards use a new operating paradigm. The streaming mode (real mode or complex) is determined by setting the antennas (to A/B or AB/BA respectively). Basic/LF RX dboards also support 2 frontends (0 and 1), and Basic/LF TX dboards support 1 frontend (0). This new behavior only applies to applicable RFNoC devices (currently X300/X310). All pre-RFNoC devices (i.e. USRP2/N200 and earlier) maintain legacy behavior. RFNoC with UHD 3.xx branches also maintains old behavior. Signed-off-by: mattprost <matt.prost@ni.com>
* docs: n3xx/x3xx: Fix links to DPDK pagesteviez2020-02-272-2/+2
| | | | | | | The n3xx and x3xx device pages both link to the DPDK page. However, the link was setup as type "subpage" instead of "ref". The result was that both device pages thought they owned the DPDK page which caused non-intuitive behavior when clicking through links in the manual
* cmake/doxygen: Fix FPGA manual post-FPGA-mergeMartin Braun2020-02-062-24/+7
| | | | | | | While merging the FPGA code into the UHD codebase, the manual building process was not modified, resulting in either a link to the website instead of building the FPGA manual as part of the rest, or by using a residual submodule.
* docs: e3xx/n3xx: Add sections on FP-GPIOs and how to drive themMartin Braun2020-01-232-0/+109
| | | | This gives examples of how to use the set_gpio_src() API and friends.
* 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
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-30 21:33:07 +0000