User Guide - ifr

This user’s guide describes how to use ifr application.

Command line interface

ifr

Utility for generating and parsing IFR. Please note that IFR0 ROMCFG region is one-time-programmable only.

ifr [OPTIONS] COMMAND [ARGS]...

Options

-v, --verbose

Print more detailed information

-vv, --debug

Display more debugging information.

--version

Show the version and exit.

--help

Show this message and exit.

generate-binary

Generate binary data.

ifr generate-binary [OPTIONS]

Options

-f, --family <family>

Required Device to use

Options:

k32w1xx | kw45xx

-r, --revision <revision>

Chip revision; if not specified, most recent one will be used

-c, --config <config>

Required Path to the YAML/JSON configuration file.

-o, --output <output>

Save the output into a file instead of console

get-template

Generate user configuration template file.

ifr get-template [OPTIONS]

Options

-f, --family <family>

Required Device to use

Options:

k32w1xx | kw45xx

-r, --revision <revision>

Chip revision; if not specified, most recent one will be used

-o, --output <output>

Save the output into a file instead of console

--force

Force overwriting of existing files.

--full

Show full config, including computed values

parse-binary

Parse binary and extract configuration.

ifr parse-binary [OPTIONS]

Options

-f, --family <family>

Required Device to use

Options:

k32w1xx | kw45xx

-r, --revision <revision>

Chip revision; if not specified, most recent one will be used

-o, --output <output>

Save the output into a file instead of console

-b, --binary <binary>

Required Binary to parse

-d, --show-diff

Show differences comparing to defaults

read

Read IFR page from the device.

ifr read [OPTIONS]

Options

-p, --port <COM[,speed>

Serial port configuration. Default baud rate is 57600. Use ‘nxpdevscan’ utility to list devices on serial port.

-u, --usb <VID:PID|USB_PATH|DEV_NAME>

USB device identifier.

Following formats are supported: <vid>, <vid:pid> or <vid,pid>, device/instance path, device name.

<vid>: hex or dec string; e.g. 0x0AB12, 43794.

<vid/pid>: hex or dec string; e.g. 0x0AB12:0x123, 1:3451.

Use ‘nxpdevscan’ utility to list connected device names.

-l, --lpcusbsio <usb,VID:PID|USB_PATH|SER_NUM,]spi|i2c>

USB-SIO bridge interface.

Optional USB device filtering formats: [usb,vid:pid|usb_path|serial_number]

Following serial interfaces are supported:

spi[index][,port,pin,speed_kHz,polarity,phase]

- index … optional index of SPI peripheral. Example: “spi1” (default=0)

- port … bridge GPIO port used as SPI SSEL(default=0)

- pin … bridge GPIO pin used as SPI SSEL

default SSEL is set to 0.15 which works

for the LPCLink2 bridge. The MCULink OB

bridge ignores the SSEL value anyway.(default=15)

- speed_kHz … SPI clock in kHz (default 1000)

- polarity … SPI CPOL option (default=1)

- phase … SPI CPHA option (default=1)

i2c[index][,address,speed_kHz]

- index … optional index of I2C peripheral. Example: “i2c1” (default=0)

- address … I2C device address (default 0x10)

- speed_kHz … I2C clock in kHz (default 100)

-b, --buspal <spi[,speed,polarity,phase,lsb|msb] | i2c[,address,speed>

Buspal settings

--timeout <ms>

Sets timeout when waiting on data over a serial line. The default is 5000 milliseconds.

-f, --family <family>

Required Device to use

Options:

k32w1xx | kw45xx

-r, --revision <revision>

Chip revision; if not specified, most recent one will be used

-o, --output <output>

Store IFR data into a file. If not specified hexdump data into stdout.

-y, --yaml <yaml_output>

Parse data read from device into YAML config.

-d, --show-diff

(applicable for parsing) Show differences comparing to defaults

write

Write IFR page to the device.

ifr write [OPTIONS]

Options

-p, --port <COM[,speed>

Serial port configuration. Default baud rate is 57600. Use ‘nxpdevscan’ utility to list devices on serial port.

-u, --usb <VID:PID|USB_PATH|DEV_NAME>

USB device identifier.

Following formats are supported: <vid>, <vid:pid> or <vid,pid>, device/instance path, device name.

<vid>: hex or dec string; e.g. 0x0AB12, 43794.

<vid/pid>: hex or dec string; e.g. 0x0AB12:0x123, 1:3451.

Use ‘nxpdevscan’ utility to list connected device names.

-l, --lpcusbsio <usb,VID:PID|USB_PATH|SER_NUM,]spi|i2c>

USB-SIO bridge interface.

Optional USB device filtering formats: [usb,vid:pid|usb_path|serial_number]

Following serial interfaces are supported:

spi[index][,port,pin,speed_kHz,polarity,phase]

- index … optional index of SPI peripheral. Example: “spi1” (default=0)

- port … bridge GPIO port used as SPI SSEL(default=0)

- pin … bridge GPIO pin used as SPI SSEL

default SSEL is set to 0.15 which works

for the LPCLink2 bridge. The MCULink OB

bridge ignores the SSEL value anyway.(default=15)

- speed_kHz … SPI clock in kHz (default 1000)

- polarity … SPI CPOL option (default=1)

- phase … SPI CPHA option (default=1)

i2c[index][,address,speed_kHz]

- index … optional index of I2C peripheral. Example: “i2c1” (default=0)

- address … I2C device address (default 0x10)

- speed_kHz … I2C clock in kHz (default 100)

-b, --buspal <spi[,speed,polarity,phase,lsb|msb] | i2c[,address,speed>

Buspal settings

--timeout <ms>

Sets timeout when waiting on data over a serial line. The default is 5000 milliseconds.

-f, --family <family>

Required Device to use

Options:

k32w1xx | kw45xx

-r, --revision <revision>

Chip revision; if not specified, most recent one will be used

-b, --binary <binary>

Required Path to IFR data to write.