bladeRF/linux/apps/src/cli/TODO
Jon Szymaniak ec54e4e409 cli: Added FX3/ FPGA loading support and filled in misc. cmd stubs.
The CLI now supports flashing the FX3 and loading the FPGA from the
command line and through the interactive console.

To flash the firmware from the command line:
  ./bin/bladerf -b -f ./path/to/img -d /dev/bladerf1

To load the firmware from the command line:
  ./bin/bladerf -b -l ./path/to/rbf -d /dev/bladerf1

To flash/load interactively either run with -d /dev/bladerf1, or
use the open command to attach to a device:
  bladeRF> open /dev/bladerf1

To flash the firmware interactively:
  bladeRF> load fx3 ./path/to/img

To load the FPGA interactively:
  bladeRF> load fpga ./path/to/rbf

Note that a power-on-reset is currently required in between
flashing firmware and loading the FPGA.

Various commands have been stubbed out for the time being. A TODO
list has been created to keep track of desired functionality.

The simple_load and upgrade_firmware programs have been removed,
as they are no longer needed.
2013-06-17 00:12:19 -04:00

71 lines
1.4 KiB
Text

################
# CLI Commands #
################
= Low level commands =
peek <lms|dac|si> <address>
poke <lms|dac|si> <address> <data>
= Higher level commands =
set <value> <options>+
frequency <rx,tx> <value>
rxvga1 <value>
rxvga2 <value>
txvga1 <value>
txvga2 <value>
pa <1,2,both> <on,off>
loopback <bb,rf>
bandwidth <tx,rx> <bw>
samplerate <tx,rx,both> <freq in Hz>
samplerate <tx,rx,both> <integer in Hz> <num> <denom>
trimdac <value: 0 to 65535>
mimo <master|slave>
refclk <enable|disable> <frequency if enable only>
pps <enable|disable>
print
config <-- basically an overview of everything
frequency
rxvga1
rxvga2
txvga1
txvga2
pa
loopback
bandwidth
samplerate
trimdac
lmsdump
mimo
refclk
pps
load <fpga|fx3> <filename>
version
fx3: <version from header>
fpga: <version register>
bladerf: <serial #, revision #>
tx <filename> [--repeat]
rx <filename> <# samples>
################
# Misc #
################
Add "Notes:" section to help text to explain items in more detail.
Programming FX3/FPGA should not require -d if there's only one
device. Implicity used any attached device if there's just one.
Otherwise, require -d and complain, exit.
################
# Programming #
################
Add a --all option to allow us to flash all attached devices with specified
firmware?