Fork of the GitHub
RFAL ST25R3911 Communication. More...
Functions | |
| void | st25r3911ClrRegisterBits (uint8_t reg, uint8_t clr_mask, 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) |
| DOXYGEN_SUPRESS. | |
| void | st25r3911SetRegisterBits (uint8_t reg, uint8_t set_mask, 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) |
| Set bits on Register. | |
| void | st25r3911ChangeRegisterBits (uint8_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) |
| Changes the given bits on a ST25R3911 register. | |
| void | st25r3911ReadTestRegister (uint8_t reg, uint8_t *val, ST25R3911 *mST25, SPI *mspiChannel, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06) |
| Read a test register within the ST25R3911. | |
| void | st25r3911WriteTestRegister (uint8_t reg, uint8_t val, ST25R3911 *mST25, SPI *mspiChannel, 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 given value to a test register within the ST25R3911. | |
| void | st25r3911ModifyRegister (uint8_t reg, uint8_t clr_mask, uint8_t set_mask, 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) |
| Modifies a value within a ST25R3911 register. | |
| void | st25r3911ChangeTestRegisterBits (uint8_t reg, uint8_t valueMask, uint8_t value, ST25R3911 *mST25, SPI *mspiChannel, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06) |
| Changes the given bits on a ST25R3911 Test register. | |
| bool | st25r3911IsRegValid (uint8_t reg) |
| Check if register ID is valid. | |
Detailed Description
RFAL ST25R3911 Communication.
Function Documentation
| void st25r3911ChangeRegisterBits | ( | uint8_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 | ||
| ) |
Changes the given bits on a ST25R3911 register.
This function is used if only a particular bits should be changed within an ST25R3911 register.
- Warning:
- This method does not guarantee consistency of register content when called from multiple contexts (task, ISR, thread)
- Parameters:
-
[in] reg,: Address of the register to write. [in] valueMask,: bitmask of bits to be changed [in] value,: the bits to be written on the enabled valueMask bits
Definition at line 104 of file st25r3911_com.cpp.
| void st25r3911ChangeTestRegisterBits | ( | uint8_t | reg, |
| uint8_t | valueMask, | ||
| uint8_t | value, | ||
| ST25R3911 * | mST25, | ||
| SPI * | mspiChannel, | ||
| DigitalOut * | gpio_cs, | ||
| InterruptIn * | IRQ, | ||
| DigitalOut * | fieldLED_01, | ||
| DigitalOut * | fieldLED_02, | ||
| DigitalOut * | fieldLED_03, | ||
| DigitalOut * | fieldLED_04, | ||
| DigitalOut * | fieldLED_05, | ||
| DigitalOut * | fieldLED_06 | ||
| ) |
Changes the given bits on a ST25R3911 Test register.
This function is used if only a particular bits should be changed within an ST25R3916 register.
- Parameters:
-
[in] reg,: Address of the Test register to change. [in] valueMask,: bitmask of bits to be changed [in] value,: the bits to be written on the enabled valueMask bits
- Warning:
- This method does not guarantee consistency of register content when called from multiple contexts (task, ISR, thread)
- Returns:
- ERR_NONE : Operation successful
- ERR_PARAM : Invalid parameter
- ERR_SEND : Transmission error or acknowledge not received
Definition at line 124 of file st25r3911_com.cpp.
| void st25r3911ClrRegisterBits | ( | uint8_t | reg, |
| uint8_t | clr_mask, | ||
| 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 | ||
| ) |
DOXYGEN_SUPRESS.
Register bit definitions
Returns the content of a register within the ST25R3911
This function is used to read out the content of ST25R3911 registers.
- Parameters:
-
[in] reg,: Address of register to read. [out] val,: Returned value.
Writes a given value to a register within the ST25R3911
This function is used to write val to address reg within the ST25R3911.
- Parameters:
-
[in] reg,: Address of the register to write. [in] val,: Value to be written.
Cleart bits on Register
This function clears the given bitmask on the register
- Warning:
- This method does not guarantee consistency of register content when called from multiple contexts (task, ISR, thread)
- Parameters:
-
[in] reg,: Address of the register clear [in] clr_mask,: Bitmask of bit to be cleared
Definition at line 81 of file st25r3911_com.cpp.
| bool st25r3911IsRegValid | ( | uint8_t | reg ) |
Check if register ID is valid.
Checks if the given register ID a valid ST25R3911 register
- Parameters:
-
[in] reg,: Address of register to check
- Returns:
- true if is a valid register ID
- false otherwise
Definition at line 144 of file st25r3911_com.cpp.
| void st25r3911ModifyRegister | ( | uint8_t | reg, |
| uint8_t | clr_mask, | ||
| uint8_t | set_mask, | ||
| 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 | ||
| ) |
Modifies a value within a ST25R3911 register.
This function is used if only a particular bits should be changed within an ST25R3911 register.
- Warning:
- This method does not guarantee consistency of register content when called from multiple contexts (task, ISR, thread)
- Parameters:
-
[in] reg,: Address of the register to write. [in] clr_mask,: bitmask of bits to be cleared to 0. [in] set_mask,: bitmask of bits to be set to 1.
Definition at line 109 of file st25r3911_com.cpp.
| void st25r3911ReadTestRegister | ( | uint8_t | reg, |
| uint8_t * | val, | ||
| ST25R3911 * | mST25, | ||
| SPI * | mspiChannel, | ||
| DigitalOut * | gpio_cs, | ||
| InterruptIn * | IRQ, | ||
| DigitalOut * | fieldLED_01, | ||
| DigitalOut * | fieldLED_02, | ||
| DigitalOut * | fieldLED_03, | ||
| DigitalOut * | fieldLED_04, | ||
| DigitalOut * | fieldLED_05, | ||
| DigitalOut * | fieldLED_06 | ||
| ) |
Read a test register within the ST25R3911.
This function is used to read the content of test address reg within the ST25R3911.
- Parameters:
-
[in] reg,: Address of the register to read. [out] val,: Returned read.
Definition at line 56 of file st25r3911_com.cpp.
| void st25r3911SetRegisterBits | ( | uint8_t | reg, |
| uint8_t | set_mask, | ||
| 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 | ||
| ) |
Set bits on Register.
This function sets the given bitmask on the register
- Warning:
- This method does not guarantee consistency of register content when called from multiple contexts (task, ISR, thread)
- Parameters:
-
[in] reg,: Address of the register clear [in] set_mask,: Bitmask of bit to be cleared
Definition at line 93 of file st25r3911_com.cpp.
| void st25r3911WriteTestRegister | ( | uint8_t | reg, |
| uint8_t | val, | ||
| ST25R3911 * | mST25, | ||
| SPI * | mspiChannel, | ||
| 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 given value to a test register within the ST25R3911.
This function is used to write val to test address reg within the ST25R3911.
- Parameters:
-
[in] reg,: Address of the register to write. [in] val,: Value to be written.
Definition at line 69 of file st25r3911_com.cpp.
Generated on Tue Jul 12 2022 18:07:56 by
1.7.2