diff options
| author |   Grant Meyerhoff <grant.meyerhoff@ni.com> | 2023-07-31 17:14:48 -0500 |
|---|---|---|
| committer |   michael-west <michael.west@ettus.com> | 2023-08-04 19:42:57 -0500 |
| commit | 183c38bcb87c4a8d496c40678b2600c680a872e9 (patch) | |
| tree | 0908ba6a24861a287b80f5c46abc85733ef5246f | |
| parent | usrpctl: add reset command (diff) | |
| download | uhd-183c38bcb87c4a8d496c40678b2600c680a872e9.tar.xz uhd-183c38bcb87c4a8d496c40678b2600c680a872e9.zip | |
docs: update docs for reset command
| -rw-r--r-- | host/docs/usrpctl.1 | 15 | ||||
| -rw-r--r-- | host/docs/usrpctl.dox | 13 |
2 files changed, 25 insertions, 3 deletions
diff --git a/host/docs/usrpctl.1 b/host/docs/usrpctl.1 index 1cf0f01eb..a140f0e09 100644 --- a/host/docs/usrpctl.1 +++ b/host/docs/usrpctl.1 @@ -32,7 +32,7 @@ devices repeat the command for every device. - probe: reads extended information about the USRP - Multi device commands: - update: Update binaries (e.g., FPGA image) - - reset: Reset the device or parts thereof (e.g., only reset MPM) + - reset: Reset the specified subcomponent(s) of the USRP - find: finds all available USRPs in this network .SH OPTIONS @@ -54,12 +54,20 @@ ID identifies exactly one device. Without arguments it displays detailed information about the device such as name, serial, revision numbers, firmware version sensor information on attached motherboard and daughterboards. +.SH reset command +.IP "Reset MPM:" +-mpm +.TP +The reset command resets specified subcomponents of a device. If ID is not +given, it scans the system for available, supported devices and resets the +specified subcomponent of all discovered devices. + .SH EXAMPLES .TP \w'usrpctl\ 'u .BI usrpctl\ find find all supported devices .TP -.BI usrpctl\ type=x300,product=X310 find +.BI usrpctl\ type=x300,product=X310\ find find all x310 devices .TP .BI usrpctl\ name=my_usrp\ find @@ -74,6 +82,9 @@ display device information for USRP with the given ID .BI usprctl\ name=my_usrp\ probe\ \-tree display property tree of device with the name my_usrp .TP +.BI usrpctl\ addr=192.168.10.2\ reset\ \-mpm +Resets MPM on the device with the given IP. +.TP .SH SEE ALSO UHD documentation: diff --git a/host/docs/usrpctl.dox b/host/docs/usrpctl.dox index 431f2ee66..3ee5ee1aa 100644 --- a/host/docs/usrpctl.dox +++ b/host/docs/usrpctl.dox @@ -31,7 +31,7 @@ devices repeat the command for every device. - `probe`: reads extended information about the USRP - Multi device commands: - `update`: Update binaries (e.g., FPGA image) - - `reset`: Reset the device or parts thereof (e.g., only reset MPM) + - `reset`: Reset the specified subcomponent(s) of the USRP - `find`: finds all available USRPs in this network \section usrpctl_options $OPTIONS @@ -68,5 +68,16 @@ Examples: - `usrpctl addr=192.168.10.2 probe` display device information for USRP with the given ID - `usprctl name=my_usrp probe -tree` display property tree of device with the name my_usrp +\subsection usrpctl_probe reset +Arguments: +-`-mpm`: reset MPM of USRP device + +The reset command resets specified subcomponents of a device. If `$ID` is not +given, it scans the system for available, supported devices and resets the +specified subcomponent of all discovered devices. + +Examples: +- `usrpctl addr=192.168.10.2 -mpm` reset MPM for USRP with the given ID + */ // vim:ft=doxygen: |