MCUXpresso SDK Documentation

“parameter” - CS parameters

“parameter” - CS parameters#

The CS parameters menu lists and allows modification of CS configuration. The options displayed here are explained in the table below.

-----------commands-------------
ch_list | Channel list commands (test mode only)
ch_map [<bitmask> [<repeat>]] | Set/show channel map as 10 hexa octets (79 bits used)
cs_algo [<0|1> [<0|1>] [<2...8>]] | Set/show channel selection algo type (0=3b, 1=3c), and for #3c: shape (0=hat, 1=X) and jump
main_mode_nb [<1...160> <1...160> <0...3>] | Set/show numbers of HADM main mode steps (min, max, repetition)
mode0_nb [<1...3>] | Set/show number of HADM mode0 steps
mode_type [<1...3> [<1...3>]] | Set/show main mode and sub-mode types
role [<initiator,reflector>] | Set/show HADM role
rtt_phy [<0|1>] | Set/show RTT phy rate (0=1Mbps, 1=2Mbps)
tx_pwr [<-12...MAX>] | Set/show TX power in dBm of CS measurement. Range is -12dBm to max chip capability
debug [<0-255>] | Set/show debug options (REPORT_DBG_INFO<2>, IQ_AVERAGE_DISABLE<1>, IQ_DETAILS<0>)
ant_cfg [<0|7> [<0...23|255>]] | Set/show antenna config index and (test mode only) permutation index
ant_type [<0-5> ] | Set/show antenna board type: 0:none, 1:X-FR-ANTDIV SMA, 2:X-FR-ANTDIV printed, 3:LOC SMA, 4:LOC printed, 5:LOC printed SMA1 dummy
pn_seq [<AA initiator> [<AA reflector>]] | Set/show PN sequences (must be a hex number, test mode only)
tone_ext [<0...4>] | Set/show TP tone extension (test mode only)
timings | Timings commands
-------------end----------------

Table: Wireless ranging CS parameters commands

Command

Default

Description

ch_list

-

Used to define the CS channel list in test mode

ch_map

All ones

Used to define the CS channel map in connected mode
Use “param ch_map 0x1FFFFFFFFFFFFC7FFFFC” to mask advertising channels

cs_algo

0

Used to define channel selection algorithm type (0=3b, 1=3c), and for #3c: shape (0=hat, 1=X) and jump

main_mode_nb

4, 4, 0

Numbers of CS main mode steps (min, max, repetition)

mode0_nb

2

Set/show numbers of CS mode 0 steps

mode_type

2,1

Set/show main mode and submode types as defined by CS
Note that the step mode 3 is only supported on KW47 family platforms.

role

Initiator

Set/show CS role

rtt_phy

0

Set/show RTT PHY rate (0=1 Mbit/s, 1=2 Mbit/s)

tx_pwr

0

TX power in dBm used during the CS measurement;
[-12…10] dBm

pn_seq

-

Set/show the PN sequences to be used in test mode

tone_ext

-

Set/show the tone extension behavior in test mode

timings

-

Timings submenu (see below); Only for test mode

debug

0

For internal debug purpose

ant_cfg

0, 0

Antenna configuration index as defined in CS specs
(0:1x1, 7:2x2) followed by a permutation index
(0-23 for fixed permutation index and
255 for rolling over all permutation indexes)

ant_type

0

Antenna diversity board to be used
(0:None,
1: X-FR-ANTDIV SMA connectors,
2: X-FR-ANTDIV printed antennas,
3: LOC SMA,
4: LOC printed,
5: LOC printed + SMA1 for dummy antenna)

“ch_list” parameter#

The “ch_list” command parameter defines the CS channel list. It only applies in test mode. See for example, the code below:

set [<0...78>,..,<0...78> [<repeat>]] | Set/show channel list
generate <0...78> <0...78> [rand] | Generate channel list from first and last CS channels

Two modes can be used:

  • The “set” mode to input a CS channel list that is input to the firmware.

    parameter ch_list set 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16
    

    This mode defines a CS sequence of 17 steps on CS channels in the given order.

  • The “generate” mode makes the firmware generate the channel list based on a start and stop frequency.

    parameter ch_list generate 0 78
    

    This mode defines a CS sequence of 79 steps on CS channels 0 to 78 (linear sweep). This is the default behavior of the firmware.

There is also a possibility to randomize the generated frequency list.

parameter ch_list generate 0 78 rand

It defines a CS sequence of 79 steps on CS channels 0 to 78 in a pseudo-randomized order.

Parent topic:”parameter” - CS parameters

“timings” – CS timings configuration#

-----------commands-------------
intervals <150|80|50> <145|80|40> [<145|80|40> ] | Set/show HADM interval timings T_FCS, T_IP1, T_IP2 (us)
t_pm <20|40> | Set/show HADM T_PM timing (us)
t_sw <2|4|10> | Set/show HADM T_SW timing (us)
-------------end----------------

Table: Wireless ranging CS timings commands

Command

Default

Description

intervals

150, 145, 145 (test mode)
50, 40, 40 (connected)

Set T_FCS, T_IP1 and T_IP2 interval in µs, as defined by CS. Allowed values are: 150 µs, 80 µs, and 50 µs for T_FCS and 145 µs, 80 µs, and 40 µs for T_IP1 and T_IP2.

t_pm

20

Set T_PM, duration in µs, as defined by CS Allowed values are: 20 µs and 40 µs

t_sw

0

When antenna diversity is used, this command controls the antenna switch time which can be set to 2 µs, 4 µs, or 10 µs. Otherwise 0 is used.

Note: The ‘Timings’ input is relevant for test mode only. In connected mode, the BLE controller chooses timings based on CS capability exchanged between the two devices. NXP controller implementation chooses the fastest timings supported by the two devices.

Parent topic:”parameter” - CS parameters

Parent topic:Main menu