Command reference

Every command available at the drivshell> prompt on Trident 3. Each page also shows the command’s built-in help, as printed by help <command>.

Shell commands

Command	Summary	Notes
?	Display list of commands
??	Print this list OR usage for a specific command	alias of help
ADC	Show MAX127 A/D Conversions
AGE	Set ESW hardware age timer
ALPM	ALPM trouble shooting
ASF	ASF (cut-through) Mode
ASSert	Assert
Attach	Attach SOC device(s)
Auth	Port-based network access control
BackGround	Execute a command in the background.
BaseBoard	Configure baseboard system parameters.
BCMSAI	SAI BCM shell commands
BFD	Manage BFD endpoints
BIST	Run on-chip memory built-in self tests
BKPmon	Monitor incoming BKP Discard Messages	hidden
BPDU	Manage BPDU addresses
break	place to hang a breakpoint
BroadSync	Manage Time API BroadSync endpoints
bsv	Broadcom SAI Version: show the SAI, OCP SAI, SDK and Cancun versions
BTiMeout	Set BIST operation timeout in microseconds
BUFfer	MMU config
CABLEdiag	Run Cable Diagnotics
CACHE	Turn on/off software caching of tables
CanCun	Cancun file and status operations
CASE	Execute command based on string match
CD	Change current working directory
CFAPINIT	Init MMU cell free address table	hidden
CHecK	Check a sorted memory table
cint	Enter the C interpreter
CLEAR	Clear a memory table or counters
ClearScreen	Clear terminal output
CLOCKS	Set core clock frequency.
COLOR	Manage packet color
COMBO	Control combination copper/fiber ports
CONFig	Configure Management interface
CONSole	Control console options
CoPy	Copy a file
COS	Manage classes of service
CounTeR	Enable/disable counter collection
CustomSTAT	Enable/disable counter collection
DAC	Set DAC register
DATE	Set or display current date
DDRMemRead	Indirect reads to DDR
DDRMemWrite	Indirect writes to DDR
DDRPhyRead	Read DDR40 phy registers
DDRPhyTune	Tune DDR40 phy registers
DDRPhyWrite	Write DDR40 phy registers
DeBug	Enable/Disable debug output
DELAY	Put CLI task in a busy-wait loop for some amount of time
DELete	Delete entry by key from a sorted table
DETach	Detach SOC device(s)
DEVice	Device add/remove
DIR	List current directory	alias of ls
DISPatch	BCM Dispatch control.
DMA	DMA Facilities Interface
DmaRomTest	Simple test of the SOC DMA ROM API
DMIRror	Manage directed port mirroring
DPLL	DPLL operations on SPI bus
DSCP	Map Diffserv Code Points
DTAG	Double Tagging
Dump	Dump an address space or registers
Echo	Echo command line
EditReg	Edit each field of SOC internal register
EDK	Start EDK-Host console
EGRess	Manage source-based egress enabling
EthernetAV	Set/Display the Ethernet AV characteristics
EXIT	Exit the current shell (and possibly reset)
EXPR	Evaluate infix expression
EXTernalTuning	External memory automatic tuning
EXTernalTuning2	External memory automatic tuning 2
EXTernalTuningSum	External memory automatic tuning (summary)
FieldProcessor	Manage Field Processor
FLASHINIT	Initialize on board flash as a file system
FLASHSYNC	Sync up on board flash with file system
FLEXport	Flexport
FlowDb	Flow Database for flexible tables
FlowTracker	Flowtracker commands
FlowTrackerMON	FlowtracketMon
FlowTrackerRemoteMON	Monitor ports for packets
FOR	Execute a series of commands in a loop
Getreg	Get register
GPORT	Get a GPORT id
H2HIGIG	Convert hex words to higig info
H2HIGIG2	Convert hex words to higig2 info
HAL	Display current HAL resource usage
HASH	Get or set hardware hash modes
HashDestination	Display Hash Destination
HClksel	Set I2C HClk (MUX for clock-chip-selects)
HeaderMode	Get or set packet tx header mode
Help	Print this list OR usage for a specific command
HISTory	List command history
HSP	MMU HSP hierarchy
I2C	Inter-Integrated Circuit (I2C) Bus commands
IbodSync	Enable/Disable IBOD sync process
IF	Conditionally execute commands
INIT	Initialize SOC and S/W
Insert	Insert into a sorted table
INTR	Enable, disable, show interrupts
IPFIX	IPFIX
IPG	Set default IPG values for ports
IPMC	Manage IPMC (IP Multicast) addresses
IPROCRead	Read from IPROC Area
IPROCWrite	Write to IPROC Area
JOBS	List current background jobs
KILL	Terminate a background job
KNETctrl	Manage kernel network functions
KNETSYNC	KnetSync Diag commands
L2	Manage L2 (MAC) addresses
L2LEARN	Control Learn Thread Execution
L2MODE	Change ARL handling mode
L3	Manage L3 (IP) addresses
LATency	Switch Latency Bypass Diagnostics
LCDMSG	Print message on Matrix Orbital LCD display (via I2C)
LED	Control/Load LED processor
LINKscan	Configure/Display link scanning
LISTmem	List the entry format for a given table
Listreg	List register fields
LLS	MMU LLS hierarchy
LOCal	Create/Delete a variable in the local scope
LOG	Enable/Disable logging and set log file
LOOKup	Look up a table entry
LOOP	Execute a series of commands in a loop
LS	List current directory
M0	M0 commands for led/linkscan fw
MCAST	Manage multicast table
MCSCmd	Execute cmd on uC
MCSDump	Create MCS dumpfile
MCSLoad	Load hexfile to MCS memory
MCSMsg	Start/stop messaging with MCs
MCSStatus	Show MCS fault status
MCSTimeStamp	Print MCS timestamp data
MemFirst	Displays first valid memory
MemNext	Displays next valid memory
MemSCAN	Turn on/off software memory error scanning
MemWatch	Turn on/off memory snooping
MIM	Manage XGS4 Mac-in-MAC
MIRror	Manage port mirroring
MKDIR	Make a directory
MmuDeBuG	Place SOC MMU in debug mode	hidden
MODE	Set shell mode
MODify	Modify table entry by field names
ModMap	MODID Remapping
Modreg	Read/modify/write register
MORe	Copy a file to the console
MoVe	Rename a file on a file system
MPLS	Manage XGS4 MPLS
MSPI	MasterSPI Read / Write
MTiMeout	Set MIIM operation timeout in usec
MultiCast	Manage multicast operation
MUXsel	Set I2C LPT state (MUX for clock-chip-selects)
NOEcho	Ignore command line
NVram	Manipulate Nonvolatile memory
OAM	Manage OAM groups and endpoints
ONESYNC	OneSync Diag commands
PacketWatcher	Monitor ports for packets
Pause	Pause command processing and wait for input
PBMP	Convert port bitmap string to hex
PCIE	R/W PCIE core registers
PCIEPHY	PCIe PHY speicific utilities
PHY	Set/Display phy characteristics
PKTIO	Set/Display TX/PacketWatcher with streamlined pktio driver type
POE	Configure PowerOverEthernet controllers.
POESel	Set I2C POE (MUX for poe-chip-selects)
POP	Pop an entry from a FIFO
PORT	Set/Display port characteristics
PortMod	Portmod Diagnostics
PortRate	Set/Display port rate metering characteristics
PortSAMp	Set/Display sflow port sampling characteristics
PortSampRate	Set/Display sflow port sampling rate
PortStat	Display port status in table
PPDclk	Show PPD clock delay
PRINTENV	Display current variable list
PROBE	Probe for available SOC units
PSCAN	Control uKernel port scanning.
PTP	PTP stack configuration
PUSH	Push an entry onto a FIFO
PUTREG	Set register	alias of setreg
PVlan	Port VLAN settings
PWD	Print platform dependent working directory
Qcm	QCM commands
QUIT	Exit the current shell (and possibly reset)	alias of exit
RATE	Manage packet rate controls
RateBw	Set/Display port bandwidth rate metering characteristics
RCCache	Save contents of an rc file in memory
RCLoad	Load commands from a file
REBOOT	Reboot the processor
RegCMp	Test a register value
RegWatch	Turn on/off register snooping
REMove	Delete entry by index from a sorted table
REName	Rename a file on a file system	alias of move
RESET	Reboot the processor	alias of reboot
ResTest	Tests for resource manager
RM	Remove a file from a file system
RMDIR	Remove a directory
RX	Receive some number of packets	hidden
RXCfg	Configure RX settings
RXInit	Call bcm_rx_init
RXMon	Register an RX handler to dump received packets
SalProfile	Displays current SAL resource usage
SAVE	Write data to a file
SCHan	Send raw S-Channel message, get response
SEArch	Search a table for a byte pattern
SER	Performs operations related to Soft Error Recovery
SET	Set various configuration options
SETENV	Create/Delete a variable in the global scope
Setreg	Set register
SHell	Invoke a system dependent shell
SHOW	Show information on a subsystem
SHUTDOWN	Tell plisim to shutdown
SLeep	Suspend the CLI task for specified amount of time
SOC	Print internal Driver control information
SOCRES	SOC reset (SCP channel)	hidden
SPI	SPI speicific utilities
SRAM	External DDR2_SRAM test control
SramSCAN	Turn on/off software SRAM error scanning
STACKMode	Set/get the stack mode
StackPortGet	Get stacking characteristics of a port
StackPortSet	Set stacking characteristics of a port
StartSim	Tell plisim to activate
STG	Manage spanning tree groups
STiMeout	Set S-Channel timeout in microseconds
STKMode	Hardware Stacking Mode Control
SW_AN	Enable/Disable SW AN Thread
SwitchControl	General switch control
SYnth	Show synthesizer frequency
SystemSnake	Cycle packets through selected system
TCAM	TCAM control
TDPLL	T-DPLL configuration and management
TeCHSupport	Collects information required to debug a given feature or subfeature
TEMPerature	Show environmental conditions
TestClear	Clear run statisistics for a test
TestList	List loaded tests and status
TestMode	Set global test run modes
TestParameters	Set test Parameters
TestRun	Run a specific or selected tests
TestSelect	Select tests for running
TIME	Time the execution of one or more commands
TMCheck	TM config check
TMDumpMem	TM dump memories
TMShow	TM config show
TRUNK	Manage port aggregation
TX	Transmit one or more packets
TXBeacon	txbeacon tests
TXCount	Print current TX statistics
TXEN	Enable packet transmission
TXSTArt	Transmit one or more packets in background
TXSTOp	Terminate a previous “txstart” command
Version	Print version and build information
VLAN	Manage virtual LANs
WARMBOOT	Optionally boot warm
WLAN	Manage XGS4 WLAN
Write	Write entry(s) into a table
XAUI	Run XAUI BERT on specified port pair
XClocks	Configure clocks for PCI, SDRAM, Core clock
xmem	xmem r addr: read 4 bytes from address xmem w addr data: write 4 bytes data to address
XPoe	Communication with PD63000 PowerOverEthernet MCU.

Commands for other chip families

The same library also contains the shell commands for newer switch chips that use logical tables instead of registers. They cannot be used on Trident 3 and are listed only for completeness.

Logical-table switch mode

Command	Summary
ALPM	ALPM info
ASF	ASF (cut-through) Mode
BcmltSHell	Run bcm LT shell
BFD	BFD endpoint info
CLEAR	Clear a memory table or counters
CLM	Cable length measurement
COS	Manage classes of service
CounTeR	Enable/disable counter collection
CustomSTAT	Enable/disable debug counter collection
DebugSHell	Run SDKLT debug shell
DETach	Detach SOC device(s)
Dump	Dump information
EventSTAT	Display drop/trace event counters
FFB	Fast fast boot
FieldProcessor	Display Field Processor information.
FlexCTR	Manage flex counter
FlexDigest	Manage Flex Digest
FLEXport	Flexport
FlowDb	FlowDB info
FlowTracker	Flowtracker sw state
HA	HA memory usage and associate information.
HeaderMode	Get or set packet tx header mode
INIT	Initialize SOC and S/W
IPMC	Manage IPMC (IP Multicast) addresses
L2	Manage L2 (MAC) addresses
L3	Manage L3 (IP) addresses
LINKscan	Configure/Display link scanning
MemSCAN	Turn on/off software memory error scanning
MIRror	Manage port mirroring
MOD	Display mirror on drop information
MonEvent	Display monitor event
MPLS	Manage MPLS
MultiCast	Manage multicast operation
PacketWatcher	Monitor ports for packets
PBMP	Convert port bitmap string to hex
PERQ	Per Port/Per Queue counter utility
Policer	Display Policer information.
PORT	Set/Display port characteristics
PortControl	Set/Display port control
PortStat	Display port status in table
PVlan	Port VLAN settings
RANGE	Display range module information.
RATE	Manage packet rate controls
RATEBW	Set/Display port bandwidth rate metering characteristics
SER	Performs operations related to Soft Error Recovery
SHOW	Show information on a subsystem
SramSCAN	Turn on/off software SRAM error scanning
StackPortGet	Get stacking characteristics of a port
StackPortSet	Set stacking characteristics of a port
STG	Manage spanning tree groups
STKMode	Hardware Stacking Mode Control
SwitchControl	General switch control
TaBLe	Get table information
TOD	Set/Get TOD
TRUNK	Manage port aggregation
TX	Transmit one or more packets
UDF	Display UDF information
VLAN	Manage VLAN usage
WARMBOOT	Optionally boot warm

bcma command line

A separate interpreter, entered with BcmltSHell or DebugSHell on logical-table devices only.

Command	Summary
?	Show available commands.
ALPM	Debug command for ALPM. Use this tool only when PTRM-ALPM is idle, meaning there is no commits to ALPM LTs in parallel.
bb	Base board control user interface.
bcmdrd	Show build configuration for BCMDRD component.
bdctl	Base driver control.
case	Execute command based on string match.
cd	Change current working directory.
cmis	CMIS management user interface.
ConFiG	List device configuration.
CounTeR	Show/Clear the counter logical table entries.
DebugSHell	Debug shell.
delay	Put CLI task in a busy-wait loop for some amount of time.
delete	Delete chip hash table entry.
delete	Delete chip hash table entry.
di	Device Init (DI) information and control operations.
DMA	DMA facilities interface.
DOP	Command for Debug Observation Point (DOP) logical tables.
each	Execute a series of commands in a loop.
echo	Echo command line.
edk	EDK subsystem management.
EVentDeBuG	Event debug manager.
Exit	Quit shell.
expr	Evaluate infix expression.
FFB	FFB apply and information
fifodma	FIFODMA operations.
file	Redirect the CLI command output to the specified file.
FlowTracker	FlowTracker debug command.
for	Execute a series of commands in a loop.
fwm	Firmware Management command.
gdpll	Generic DPLL commands.
Get	Get chip register/memory contents.
Get	Get chip register/memory contents.
geti	Get chip register/memory contents (raw).
geti	Get chip register/memory contents (raw).
GLB	GLB debug command.
grep	Execute system-provided grep command.
HA	HA memory usage and associate information.
hal	HAL debug access.
hal	HAL debug access.
HealthCHecK	Check health of device.
HealthMONitor	Show system health.
Help	Show help.
history	Display command history.
hla	Hardware License Authentication control.
hlax	Hardware License Authentication control.
i2c	I2C control user interface.
IDI	IDI debug command.
if	Conditionally execute commands.
imctrl	Interface module management user interface.
insert	Insert chip hash table entry.
insert	Insert chip hash table entry.
INTR	interrupt debug command.
ISSU	ISSU structure registration analysis.
knet	KNET access.
LibPm	FlowTracker debug command.
List	List symbols for a chip.
List	List symbols for a chip.
LMM	Memory usage statistics from Local Memory Manager.
local	Show/clear/set local environment variables.
lookup	Lookup chip hash/tcam table entry.
lookup	Lookup chip hash/TCAM table entry.
loop	Execute a series of commands in a loop.
ls	List current directory.
lt	Logical table access.
LtCAPture	Capture of logical table operations.
LTM	Debug command for LTM.
mcs	Microcontroller subsystem management.
mkdir	Create a directory.
onesync	ONESYNC access.
pbmp	Convert a port list string into a port bitmap.
PCIEphy	PCIe diagnostics.
PHY	PHY based commands.
PHYDiag	PHY based diagnostics commands.
pid	Show how input identifier is parsed.
pid	Show how input identifier is parsed.
pipe	Display switch pipe information.
pktdev	Manage packet device.
pkttest	Packet IO performance test.
pkttrace	Inject a trace packet and get trace data.
pmddecode	Metadata decode.
pmdencode	Metadata encode.
pop	POP an entry from a FIFO.
pop	Pop an entry from a FIFO.
PortControl	PC HA state recover.
PortStatus	Display port status.
printenv	Show all environment variables.
pt	Physical table access.
PTM	Debug command for PTM.
push	Push an entry into a FIFO.
pwd	Display current working directory.
QSPI	QSPI debug command.
Quit	Quit shell.
rand	Pseudo-random number generator.
RCCache	Save contents of an rc file in memory.
RCLoad	Load commands from a file.
ReSourRCe	Device resource manager interface.
rmdir	Delete a directory.
rx	Packet RX debug operations.
SBR	Debug command for SBR.
sbusdma	SBUSDMA operations.
schan	Perform raw S-channel operation.
schan	Perform raw S-channel operation.
SER	Debug command for SER.
Set	Modify chip register/memory contents.
Set	Modify chip register/memory contents.
setenv	Show/clear/set global environment variables.
seti	Modify chip register/memory contents (raw).
seti	Modify chip register/memory contents (raw).
shell	Launch system shell.
sleep	Suspend the CLI task for specified amount of time.
socket	Manage SOCKET.
sort	Execute system-provided sort command.
SPI	SPI debug command.
symtbl	Transform data based on symbol table information.
tdmfw	Diag utility for tdmfw.
TEChSUPport	Collect diagnostics and debug information.
test	Test operation.
TestList	List or Display loaded tests and status.
TestRun	Run a specific or selected tests.
time	Measure the execution time for one or more CLI commands.
TimeSyncFIFO	TSFIFO command.
TimeSyncGPIO	TimeSyncGPIO command.
TRM	Display TRM statistics.
TS	TimeSync driver control.
tx	Transmit packets.
unit	List device-specific information.
version	Show version information.