bladeRF-cli: annotate print/set help with bladeRF1 specific parameters
This commit is contained in:
parent
fd4638c0ee
commit
93b2645228
3 changed files with 138 additions and 101 deletions
|
|
@ -27,7 +27,7 @@
|
|||
* Any manual modifications to this file will be overwritten!
|
||||
* To edit the content of help strings, please edit interactive-help.md
|
||||
*
|
||||
* Last generated: Tue May 9 18:22:31 PDT 2017 by vsergeev@vsergeev-laptop
|
||||
* Last generated: Tue May 9 18:51:08 PDT 2017 by vsergeev@vsergeev-laptop
|
||||
*/
|
||||
|
||||
#ifndef BLADERF_CLI_DOC_CMD_HELP_H__
|
||||
|
|
@ -489,26 +489,33 @@
|
|||
"Usage: print [parameter]\n" \
|
||||
"\n" \
|
||||
"The print command takes a parameter to print. Available parameters are\n" \
|
||||
"listed below. If no paremeter is specified, all parameters are\n" \
|
||||
"listed below. If no parameter is specified, all parameters are\n" \
|
||||
"printed.\n" \
|
||||
"\n" \
|
||||
"Common parameters:\n" \
|
||||
"\n" \
|
||||
" Parameter Description\n" \
|
||||
" -------------- --------------------------------------------------------\n" \
|
||||
" bandwidth Bandwidth settings\n" \
|
||||
" frequency Frequency settings\n" \
|
||||
" gpio FX3 <-> FPGA GPIO state\n" \
|
||||
" loopback Loopback settings\n" \
|
||||
" lnagain Gain setting of the RX LNA, in dB\n" \
|
||||
" rx_mux FPGA RX FIFO input mux setting\n" \
|
||||
" samplerate Samplerate settings\n" \
|
||||
" trimdac VCTCXO Trim DAC settings\n" \
|
||||
" vctcxo_tamer Current VCTCXO tamer mode.\n" \
|
||||
"\n" \
|
||||
"BladeRF1-only parameters:\n" \
|
||||
"\n" \
|
||||
" Parameter Description\n" \
|
||||
" -------------- --------------------------------------------------------\n" \
|
||||
" lnagain Gain setting of the RX LNA, in dB\n" \
|
||||
" rxvga1 Gain setting of RXVGA1, in dB\n" \
|
||||
" rxvga2 Gain setting of RXVGA2, in dB\n" \
|
||||
" txvga1 Gain setting of TXVGA1, in dB\n" \
|
||||
" txvga2 Gain setting of TXVGA2, in dB\n" \
|
||||
" sampling External or internal sampling mode\n" \
|
||||
" samplerate Samplerate settings\n" \
|
||||
" smb_mode SMB clock port mode of operation\n" \
|
||||
" trimdac VCTCXO Trim DAC settings\n" \
|
||||
" vctcxo_tamer Current VCTCXO tamer mode.\n" \
|
||||
" xb_gpio Expansion board GPIO values\n" \
|
||||
" xb_gpio_dir Expansion board GPIO direction (1=output, 0=input)\n" \
|
||||
"\n" \
|
||||
|
|
@ -809,7 +816,9 @@
|
|||
"Usage: set <parameter> <arguments>\n" \
|
||||
"\n" \
|
||||
"The set command takes a parameter and an arbitrary number of arguments\n" \
|
||||
"for that particular parameter. The parameter is one of:\n" \
|
||||
"for that particular parameter.\n" \
|
||||
"\n" \
|
||||
"Common parameters:\n" \
|
||||
"\n" \
|
||||
" -------------------------------------------------------------------------------------------\n" \
|
||||
" Parameter Description\n" \
|
||||
|
|
@ -820,38 +829,31 @@
|
|||
"\n" \
|
||||
" gpio FX3 <-> FPGA GPIO state\n" \
|
||||
"\n" \
|
||||
" loopback Loopback settings. Run 'set loopback' to list modes.\n" \
|
||||
"\n" \
|
||||
" lnagain Gain setting of the RX LNA, in dB. Values: 0, 3, 6\n" \
|
||||
"\n" \
|
||||
" rxvga1 Gain setting of RXVGA1, in dB. Range: [5, 30]\n" \
|
||||
"\n" \
|
||||
" rx_mux FPGA RX FIFO input mux mode. Options are: BASEBAND, 12BIT_COUNTER,\n" \
|
||||
" 32BIT_COUNTER, DIGITAL_LOOPBACK\n" \
|
||||
"\n" \
|
||||
" rxvga1 Gain setting of RXVGA1, in dB. Range: [5, 30]\n" \
|
||||
"\n" \
|
||||
" rxvga2 Gain setting of RXVGA2, in dB. Range: [0, 30]\n" \
|
||||
"\n" \
|
||||
" txvga1 Gain setting of TXVGA1, in dB. Range: [-35, -4]\n" \
|
||||
"\n" \
|
||||
" txvga2 Gain setting of TXVGA2, in dB. Range: [0, 25]\n" \
|
||||
"\n" \
|
||||
" sampling External or internal sampling mode\n" \
|
||||
"\n" \
|
||||
" samplerate Sample rate settings\n" \
|
||||
"\n" \
|
||||
" smb_mode SMB clock port mode of operation\n" \
|
||||
"\n" \
|
||||
" trimdac VCTCXO trim DAC settings\n" \
|
||||
"\n" \
|
||||
" vctcxo_tamer VCTCXO tamer mode. Options: Disabled, 1PPS, 10MHz\n" \
|
||||
"\n" \
|
||||
" xb_gpio Expansion board GPIO values\n" \
|
||||
"\n" \
|
||||
" xb_gpio_dir Expansion board GPIO direction (1=output, 0=input)\n" \
|
||||
" -------------------------------------------------------------------------------------------\n" \
|
||||
"\n" \
|
||||
"BladeRF1-only parameters:\n" \
|
||||
"\n" \
|
||||
" Parameter Description\n" \
|
||||
" -------------- --------------------------------------------------------\n" \
|
||||
" loopback Loopback settings. Run 'set loopback' to list modes.\n" \
|
||||
" lnagain Gain setting of the RX LNA, in dB. Values: 0, 3, 6\n" \
|
||||
" rxvga1 Gain setting of RXVGA1, in dB. Range: [5, 30]\n" \
|
||||
" rxvga2 Gain setting of RXVGA2, in dB. Range: [0, 30]\n" \
|
||||
" txvga1 Gain setting of TXVGA1, in dB. Range: [-35, -4]\n" \
|
||||
" txvga2 Gain setting of TXVGA2, in dB. Range: [0, 25]\n" \
|
||||
" sampling External or internal sampling mode\n" \
|
||||
" smb_mode SMB clock port mode of operation\n" \
|
||||
" xb_gpio Expansion board GPIO values\n" \
|
||||
" xb_gpio_dir Expansion board GPIO direction (1=output, 0=input)\n" \
|
||||
"\n" \
|
||||
|
||||
|
||||
#define CLI_CMD_HELPTEXT_version \
|
||||
|
|
|
|||
|
|
@ -632,7 +632,9 @@ Usage: \f[C]print\ [parameter]\f[]
|
|||
.PP
|
||||
The print command takes a parameter to print.
|
||||
Available parameters are listed below.
|
||||
If no paremeter is specified, all parameters are printed.
|
||||
If no parameter is specified, all parameters are printed.
|
||||
.PP
|
||||
Common parameters:
|
||||
.PP
|
||||
.TS
|
||||
tab(@);
|
||||
|
|
@ -664,16 +666,44 @@ T}@T{
|
|||
Loopback settings
|
||||
T}
|
||||
T{
|
||||
\f[C]lnagain\f[]
|
||||
T}@T{
|
||||
Gain setting of the RX LNA, in dB
|
||||
T}
|
||||
T{
|
||||
\f[C]rx_mux\f[]
|
||||
T}@T{
|
||||
FPGA RX FIFO input mux setting
|
||||
T}
|
||||
T{
|
||||
\f[C]samplerate\f[]
|
||||
T}@T{
|
||||
Samplerate settings
|
||||
T}
|
||||
T{
|
||||
\f[C]trimdac\f[]
|
||||
T}@T{
|
||||
VCTCXO Trim DAC settings
|
||||
T}
|
||||
T{
|
||||
\f[C]vctcxo_tamer\f[]
|
||||
T}@T{
|
||||
Current VCTCXO tamer mode.
|
||||
T}
|
||||
.TE
|
||||
.PP
|
||||
BladeRF1\-only parameters:
|
||||
.PP
|
||||
.TS
|
||||
tab(@);
|
||||
rw(13.6n) lw(54.4n).
|
||||
T{
|
||||
Parameter
|
||||
T}@T{
|
||||
Description
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\f[C]lnagain\f[]
|
||||
T}@T{
|
||||
Gain setting of the RX LNA, in dB
|
||||
T}
|
||||
T{
|
||||
\f[C]rxvga1\f[]
|
||||
T}@T{
|
||||
Gain setting of RXVGA1, in dB
|
||||
|
|
@ -699,26 +729,11 @@ T}@T{
|
|||
External or internal sampling mode
|
||||
T}
|
||||
T{
|
||||
\f[C]samplerate\f[]
|
||||
T}@T{
|
||||
Samplerate settings
|
||||
T}
|
||||
T{
|
||||
\f[C]smb_mode\f[]
|
||||
T}@T{
|
||||
SMB clock port mode of operation
|
||||
T}
|
||||
T{
|
||||
\f[C]trimdac\f[]
|
||||
T}@T{
|
||||
VCTCXO Trim DAC settings
|
||||
T}
|
||||
T{
|
||||
\f[C]vctcxo_tamer\f[]
|
||||
T}@T{
|
||||
Current VCTCXO tamer mode.
|
||||
T}
|
||||
T{
|
||||
\f[C]xb_gpio\f[]
|
||||
T}@T{
|
||||
Expansion board GPIO values
|
||||
|
|
@ -1200,7 +1215,8 @@ Usage: \f[C]set\ <parameter>\ <arguments>\f[]
|
|||
.PP
|
||||
The set command takes a parameter and an arbitrary number of arguments
|
||||
for that particular parameter.
|
||||
The parameter is one of:
|
||||
.PP
|
||||
Common parameters:
|
||||
.PP
|
||||
.TS
|
||||
tab(@);
|
||||
|
|
@ -1227,6 +1243,41 @@ T}@T{
|
|||
FX3 <\-> FPGA GPIO state
|
||||
T}
|
||||
T{
|
||||
\f[C]rx_mux\f[]
|
||||
T}@T{
|
||||
FPGA RX FIFO input mux mode.
|
||||
Options are: BASEBAND, 12BIT_COUNTER, 32BIT_COUNTER, DIGITAL_LOOPBACK
|
||||
T}
|
||||
T{
|
||||
\f[C]samplerate\f[]
|
||||
T}@T{
|
||||
Sample rate settings
|
||||
T}
|
||||
T{
|
||||
\f[C]trimdac\f[]
|
||||
T}@T{
|
||||
VCTCXO trim DAC settings
|
||||
T}
|
||||
T{
|
||||
\f[C]vctcxo_tamer\f[]
|
||||
T}@T{
|
||||
VCTCXO tamer mode.
|
||||
Options: Disabled, 1PPS, 10MHz
|
||||
T}
|
||||
.TE
|
||||
.PP
|
||||
BladeRF1\-only parameters:
|
||||
.PP
|
||||
.TS
|
||||
tab(@);
|
||||
rw(13.6n) lw(54.4n).
|
||||
T{
|
||||
Parameter
|
||||
T}@T{
|
||||
Description
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\f[C]loopback\f[]
|
||||
T}@T{
|
||||
Loopback settings.
|
||||
|
|
@ -1245,18 +1296,6 @@ Gain setting of RXVGA1, in dB.
|
|||
Range: [5, 30]
|
||||
T}
|
||||
T{
|
||||
\f[C]rx_mux\f[]
|
||||
T}@T{
|
||||
FPGA RX FIFO input mux mode.
|
||||
Options are: BASEBAND, 12BIT_COUNTER, 32BIT_COUNTER, DIGITAL_LOOPBACK
|
||||
T}
|
||||
T{
|
||||
\f[C]rxvga1\f[]
|
||||
T}@T{
|
||||
Gain setting of RXVGA1, in dB.
|
||||
Range: [5, 30]
|
||||
T}
|
||||
T{
|
||||
\f[C]rxvga2\f[]
|
||||
T}@T{
|
||||
Gain setting of RXVGA2, in dB.
|
||||
|
|
@ -1280,27 +1319,11 @@ T}@T{
|
|||
External or internal sampling mode
|
||||
T}
|
||||
T{
|
||||
\f[C]samplerate\f[]
|
||||
T}@T{
|
||||
Sample rate settings
|
||||
T}
|
||||
T{
|
||||
\f[C]smb_mode\f[]
|
||||
T}@T{
|
||||
SMB clock port mode of operation
|
||||
T}
|
||||
T{
|
||||
\f[C]trimdac\f[]
|
||||
T}@T{
|
||||
VCTCXO trim DAC settings
|
||||
T}
|
||||
T{
|
||||
\f[C]vctcxo_tamer\f[]
|
||||
T}@T{
|
||||
VCTCXO tamer mode.
|
||||
Options: Disabled, 1PPS, 10MHz
|
||||
T}
|
||||
T{
|
||||
\f[C]xb_gpio\f[]
|
||||
T}@T{
|
||||
Expansion board GPIO values
|
||||
|
|
|
|||
|
|
@ -474,7 +474,9 @@ print
|
|||
Usage: `print [parameter]`
|
||||
|
||||
The print command takes a parameter to print. Available parameters are listed
|
||||
below. If no paremeter is specified, all parameters are printed.
|
||||
below. If no parameter is specified, all parameters are printed.
|
||||
|
||||
Common parameters:
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Parameter Description
|
||||
|
|
@ -487,10 +489,22 @@ below. If no paremeter is specified, all parameters are printed.
|
|||
|
||||
`loopback` Loopback settings
|
||||
|
||||
`lnagain` Gain setting of the RX LNA, in dB
|
||||
|
||||
`rx_mux` FPGA RX FIFO input mux setting
|
||||
|
||||
`samplerate` Samplerate settings
|
||||
|
||||
`trimdac` VCTCXO Trim DAC settings
|
||||
|
||||
`vctcxo_tamer` Current VCTCXO tamer mode.
|
||||
----------------------------------------------------------------------
|
||||
|
||||
BladeRF1-only parameters:
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Parameter Description
|
||||
------------- --------------------------------------------------------
|
||||
`lnagain` Gain setting of the RX LNA, in dB
|
||||
|
||||
`rxvga1` Gain setting of RXVGA1, in dB
|
||||
|
||||
`rxvga2` Gain setting of RXVGA2, in dB
|
||||
|
|
@ -501,20 +515,13 @@ below. If no paremeter is specified, all parameters are printed.
|
|||
|
||||
`sampling` External or internal sampling mode
|
||||
|
||||
`samplerate` Samplerate settings
|
||||
|
||||
`smb_mode` SMB clock port mode of operation
|
||||
|
||||
`trimdac` VCTCXO Trim DAC settings
|
||||
|
||||
`vctcxo_tamer` Current VCTCXO tamer mode.
|
||||
|
||||
`xb_gpio` Expansion board GPIO values
|
||||
|
||||
`xb_gpio_dir` Expansion board GPIO direction (1=output, 0=input)
|
||||
----------------------------------------------------------------------
|
||||
|
||||
|
||||
probe
|
||||
-----
|
||||
|
||||
|
|
@ -824,7 +831,9 @@ set
|
|||
Usage: `set <parameter> <arguments>`
|
||||
|
||||
The set command takes a parameter and an arbitrary number of arguments for
|
||||
that particular parameter. The parameter is one of:
|
||||
that particular parameter.
|
||||
|
||||
Common parameters:
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Parameter Description
|
||||
|
|
@ -835,18 +844,28 @@ that particular parameter. The parameter is one of:
|
|||
|
||||
`gpio` FX3 <-> FPGA GPIO state
|
||||
|
||||
`rx_mux` FPGA RX FIFO input mux mode. Options are:
|
||||
BASEBAND, 12BIT_COUNTER, 32BIT_COUNTER,
|
||||
DIGITAL_LOOPBACK
|
||||
|
||||
`samplerate` Sample rate settings
|
||||
|
||||
`trimdac` VCTCXO trim DAC settings
|
||||
|
||||
`vctcxo_tamer` VCTCXO tamer mode. Options: Disabled, 1PPS, 10MHz
|
||||
----------------------------------------------------------------------
|
||||
|
||||
BladeRF1-only parameters:
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Parameter Description
|
||||
------------- --------------------------------------------------------
|
||||
`loopback` Loopback settings. Run 'set loopback' to list modes.
|
||||
|
||||
`lnagain` Gain setting of the RX LNA, in dB. Values: 0, 3, 6
|
||||
|
||||
`rxvga1` Gain setting of RXVGA1, in dB. Range: [5, 30]
|
||||
|
||||
`rx_mux` FPGA RX FIFO input mux mode. Options are:
|
||||
BASEBAND, 12BIT_COUNTER,
|
||||
32BIT_COUNTER, DIGITAL_LOOPBACK
|
||||
|
||||
`rxvga1` Gain setting of RXVGA1, in dB. Range: [5, 30]
|
||||
|
||||
`rxvga2` Gain setting of RXVGA2, in dB. Range: [0, 30]
|
||||
|
||||
`txvga1` Gain setting of TXVGA1, in dB. Range: [-35, -4]
|
||||
|
|
@ -855,20 +874,13 @@ that particular parameter. The parameter is one of:
|
|||
|
||||
`sampling` External or internal sampling mode
|
||||
|
||||
`samplerate` Sample rate settings
|
||||
|
||||
`smb_mode` SMB clock port mode of operation
|
||||
|
||||
`trimdac` VCTCXO trim DAC settings
|
||||
|
||||
`vctcxo_tamer` VCTCXO tamer mode. Options: Disabled, 1PPS, 10MHz
|
||||
|
||||
`xb_gpio` Expansion board GPIO values
|
||||
|
||||
`xb_gpio_dir` Expansion board GPIO direction (1=output, 0=input)
|
||||
----------------------------------------------------------------------
|
||||
|
||||
|
||||
version
|
||||
-------
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue