Console Application - Console Application - UG1614

XRF4 RF Accessory Kit User Guide (UG1614)

Document ID
UG1614
Release Date
2025-12-02
Revision
1.3 English

A Python based Linux console application (xrf4-console) is integrated into the PetaLinux build image loaded on the XRF4 SD card. This application is meant for debug purposes and can be used to directly control the XRF4 slices/RFBB from the UART console.

To run this application, the user shall connect to XRF4 terminal over serial (USB) and open the relevant COM port with 115200 baud. Once in the Linux terminal, login using PetaLinux as user and plnx as the password:

xrf4-console [options]

A list of options available with this application can be viewed by running the command listed above with –help or -h option.

The following table describes the available options in this application.

Table 1. XRF4 Console Application Usage
Options Option Type Sub-Options Arguments Usage
--help (-h) Global Print help information.
--vers (-v) Global Print SW version for XRF4 Python API layer.
--slicedet (-d) Global Re-initiate slice detection and identification
--rfbb (-b) Global --readf (-r)

Read RFBB EEPROM

xrf4-console -b -r > jsonread.json
--writef (-w)

--file (-f)

EEPROM file name

Write RFBB EEPROM by providing compressed json file

xrf4-console -b -w -f slicejsonwrite.json
--fbsw (-k) FB switch value

Write FB MUX switch value (eight bits). Used with the XRF4-RFBB global option. Control the FB RF switch from the XRF4 or ZCU system. Eight bit value is defined as:

Bit 7: ZCU switch enable

Bit 6: 1'b0

Bit 5:3: channel 0 input to FB slice

Bit 2:0: channel 1 input to FB slice

--psumon (-p)

Global - -

This option is to read SOM power rails

xrf4-console -p
--somcfg (-j) Global -

This option is used to read SOM configuration

xrf4-console -j
--slice (-s) Global

--readf (-r)

--writef (-w)

--chnum (-c)

--psumon (-p)

--ldoen (-n)

--gpio (-g)

--dsa (-a)

--temp (-t)

This option is used to access the slice functions with the sub-options. Example : Write slice 5 DSA value to 21 dB on channel 0 ->

xrf4-console -s 5 -a 21 -c 0
--readf (-r) Sub option Optionally use ‘>’ operand to direct read output to a file

Read EEPROM flash contents from the XRF4-RFBB/slice into specified file name. Example:

xrf4-console -s 5 -r
xrf4-console -s 5 -r > slicejsonread.json
--writef (-w) Sub option

--file (-f)

EEPROM file name

Write EEPROM flash contents to the XRF4-RFBB/slice from specified file name. Example:

xrf4-console -s 5 -w -f slicejsonread.json

--psumon (-p) Sub option

Read PSU voltage/current values for SOM/slices. Displays measured voltage/current and for each LDO (VDD, 3.3 V, 5.0 V). Example:

Show PSU monitor for slice 5:

xrf4-console -s 5 -p
--ldoen (-n) Sub option LDO enable values as decimal

Enable/disable VDD/3.3V/5.0V LDO on slice. This is a 3-bit value and defined as:

Bit 2: VDD enable

Bit 1: 3.3V enable

Bit 0: 5.0V enable

Example:

Enable VDD and 3.3V LDO for slice 5

xrf4-console -s 5 -n 6
--dsa (-a) Sub option Attenuation value

Set slice attenuation value. Attenuation value at reset is 31.5 dB and can be decreased in steps on 0.25 dB. Example:

Set slice 5 channel 1 attenuation to 21.5

xrf4-console -s 5 -c 1 -a 21
--chnum (-c) Sub option Slice channel number

DSA value to be set on slice channel (0/1).

Channel number can be 0 or 1. By default, channel 0 is selected. Example:

Set slice 5 channel 0 attenuation to 10.5

xrf4-console -s 5 -c 0 -a 10.5
--temp (-t) Sub option

Read slice temperature sensor on TX slices. Example:

xrf4-console -s 5 -t
--gpio (-g) Sub option 6-bit value in decimal

Set GPIO value for slice. Example:

xrf4-console -s 5 -g 63
--rdsa (-e) Sub option

Read slice DSA values for a particular channel.

Example: Read slice 5 channel 0 DSA value

xrf4-console -s 5 -c 0 -e