ST Expansion SW Team / RFAL

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-os-nfc05a1

Embed: (wiki syntax)

« Back to documentation index

Chip
Functions

Chip
[RFAL-HAL]

RFAL RF Chip Module. More...

Functions

ReturnCode rfalChipWriteReg (uint16_t reg, uint8_t *values, uint8_t len, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Writes a register on the RF Chip.
ReturnCode rfalChipReadReg (uint16_t reg, uint8_t *values, uint8_t len, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Reads a register on the RF Chip.
ReturnCode rfalChipChangeRegBits (uint16_t reg, uint8_t valueMask, uint8_t value, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Change a register on the RF Chip.
ReturnCode rfalChipWriteTestReg (uint16_t reg, uint8_t value, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Writes a Test register on the RF Chip.
ReturnCode rfalChipReadTestReg (uint16_t reg, uint8_t *value)
 Reads a Test register on the RF Chip.
ReturnCode rfalChipChangeTestRegBits (uint16_t reg, uint8_t valueMask, uint8_t value, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Change a Test register on the RF Chip.
ReturnCode rfalChipExecCmd (uint16_t cmd, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Execute command on the RF Chip.

Detailed Description

RFAL RF Chip Module.

Function Documentation

ReturnCode rfalChipChangeRegBits ( uint16_t  reg,
uint8_t  valueMask,
uint8_t  value,
SPI *  mspiChannel,
ST25R3911 *  mST25,
DigitalOut *  gpio_cs,
InterruptIn *  IRQ,
DigitalOut *  fieldLED_01,
DigitalOut *  fieldLED_02,
DigitalOut *  fieldLED_03,
DigitalOut *  fieldLED_04,
DigitalOut *  fieldLED_05,
DigitalOut *  fieldLED_06 
)

Change a register on the RF Chip.

Change the value of the register bits on the RF Chip Test set in the valueMask.

Parameters:
[in]reg,:register address to be modified
[in]valueMask,:mask value of the register bits to be changed
[in]value,:register value to be set
Returns:
ERR_PARAM Invalid register or bad request
ERR_OK Change done with no error

Definition at line 3511 of file rfal_rf.cpp.

ReturnCode rfalChipChangeTestRegBits ( uint16_t  reg,
uint8_t  valueMask,
uint8_t  value,
SPI *  mspiChannel,
ST25R3911 *  mST25,
DigitalOut *  gpio_cs,
InterruptIn *  IRQ,
DigitalOut *  fieldLED_01,
DigitalOut *  fieldLED_02,
DigitalOut *  fieldLED_03,
DigitalOut *  fieldLED_04,
DigitalOut *  fieldLED_05,
DigitalOut *  fieldLED_06 
)

Change a Test register on the RF Chip.

Change the value of the register bits on the RF Chip Test set in the valueMask.

Parameters:
[in]reg,:test register address to be modified
[in]valueMask,:mask value of the register bits to be changed
[in]value,:register value to be set
Returns:
ERR_PARAM Invalid register or bad request
ERR_OK Change done with no error

Definition at line 3519 of file rfal_rf.cpp.

ReturnCode rfalChipExecCmd ( uint16_t  cmd,
SPI *  mspiChannel,
ST25R3911 *  mST25,
DigitalOut *  gpio_cs,
InterruptIn *  IRQ,
DigitalOut *  fieldLED_01,
DigitalOut *  fieldLED_02,
DigitalOut *  fieldLED_03,
DigitalOut *  fieldLED_04,
DigitalOut *  fieldLED_05,
DigitalOut *  fieldLED_06 
)

Execute command on the RF Chip.

Checks if the given command is valid and if so, executes it on the RF Chip

Parameters:
[in]cmd,:direct command to be executed
Returns:
ERR_PARAM Invalid command or bad request
ERR_NONE Direct command executed with no error

Definition at line 3485 of file rfal_rf.cpp.

ReturnCode rfalChipReadReg ( uint16_t  reg,
uint8_t *  values,
uint8_t  len,
SPI *  mspiChannel,
ST25R3911 *  mST25,
DigitalOut *  gpio_cs,
InterruptIn *  IRQ,
DigitalOut *  fieldLED_01,
DigitalOut *  fieldLED_02,
DigitalOut *  fieldLED_03,
DigitalOut *  fieldLED_04,
DigitalOut *  fieldLED_05,
DigitalOut *  fieldLED_06 
)

Reads a register on the RF Chip.

Checks if the given register is valid and if so, reads the value(s) of the RF Chip register(s)

Parameters:
[in]reg,:register address to be read, or the first if len > 1
[out]values,:pointer where the register(s) read content will be placed
[in]len,:number of consecutive registers to be read
Returns:
ERR_PARAM Invalid register or bad request
ERR_NONE Read done with no error

Definition at line 3473 of file rfal_rf.cpp.

ReturnCode rfalChipReadTestReg ( uint16_t  reg,
uint8_t *  value 
)

Reads a Test register on the RF Chip.

Reads the value of the RF Chip Test register

Parameters:
[in]reg,:register address to be read
[out]value,:pointer where the register content will be placed
Returns:
ERR_PARAM Invalid register or bad request
ERR_NONE Read done with no error
ReturnCode rfalChipWriteReg ( uint16_t  reg,
uint8_t *  values,
uint8_t  len,
SPI *  mspiChannel,
ST25R3911 *  mST25,
DigitalOut *  gpio_cs,
InterruptIn *  IRQ,
DigitalOut *  fieldLED_01,
DigitalOut *  fieldLED_02,
DigitalOut *  fieldLED_03,
DigitalOut *  fieldLED_04,
DigitalOut *  fieldLED_05,
DigitalOut *  fieldLED_06 
)

Writes a register on the RF Chip.

Checks if the given register is valid and if so, writes the value(s) on the RF Chip register

Parameters:
[in]reg,:register address to be written, or the first if len > 1
[in]values,:pointer with content to be written on the register(s)
[in]len,:number of consecutive registers to be written
Returns:
ERR_PARAM Invalid register or bad request
ERR_NONE Write done with no error

Definition at line 3461 of file rfal_rf.cpp.

ReturnCode rfalChipWriteTestReg ( uint16_t  reg,
uint8_t  value,
DigitalOut *  fieldLED_01,
DigitalOut *  fieldLED_02,
DigitalOut *  fieldLED_03,
DigitalOut *  fieldLED_04,
DigitalOut *  fieldLED_05,
DigitalOut *  fieldLED_06 
)

Writes a Test register on the RF Chip.

Writes the value on the RF Chip Test register

Parameters:
[in]reg,:register address to be written
[in]value,:value to be written on the register
Returns:
ERR_PARAM Invalid register or bad request
ERR_NONE Write done with no error
Generated on Sat Jul 16 2022 13:00:53 by  doxygen 1.7.2