
RFSoC Data Converter Evaluation Tool User Guide
62
UG1287 (v2018.2) October 1, 2018
Appendix A
Reference Design Protocol Specification
Commands
lists the commands used in the evaluation tool design.
Table A-1:
Command List
Command
Arguments
Return
Purpose/Comments
Basic Commands
RFdcVersion
None
Version Number(s)
RFdc API Version, for example,
"v3_1"
Version
None
Version Number(s)
Protocol Version, for example,
"v1_0"
TermMode
mode
None
Switch between UI mode
(mode=0) and Interactive mode
(mode=1). Interactive mode
prints more status info to the
terminal, and should not be used
with the Evaluation Tool GUI.
GetLog
None
Logged Strings
Uses metal_log to return any
error, warning, or informational
messages returned from the API
or command interface.
iic_write
iic instance, slave
address, register offset,
size, data
Success/Fail
Write number of bytes to IIC slave
iic_read
iic instance, slave
address, size
Success/Fail
Read number of bytes from IIC
slave
RFdc API Commands
SetMixerSettings
Type, Tile, Block,
MixerSettings
None
Where MixerSettings is 1:1 with
the API:
Freq, PhaseOffset, EventSource,
FineMixerMode,
CoarseMixerFreq, FineMixerScale
GetMixerSettings
Type, Tile, Block
Type, Tile, Block,
MixerSettings
Get mixer settings for the
requested type, tile, and block.