nfc_st25r3.h

Go to the documentation of this file.

/*
 * nfc_st25r3.h
 *
 *  Created on: 27. 12. 2025
 *      Author: Milan
 *
 *  NFC 4 tag click,  ST25R3916.pdf  https://download.mikroe.com/documents/datasheets/ST25R3916%20Datasheet.pdf
 *  nfc - write and read via EEPROM, via mail box it doesn't work, so for now it makes no sense to activate via INT to avoid unnecessary consumption
 *  password default is 8x 0h
 *
 *  EEPROM works....
 *
 *
 *  but MailBox doesn't work - I can't read and write to MailBox.
 *  I tried it via ChatGPT and Gemini, but couldn't transfer data, so it probably makes no sense. RF is static anyway
 *
 *  It's not entirely clear yet how it will work
 *
 */
 
#if KOKOT
 
#ifndef INC_NFC_ST25R3_H_
#define INC_NFC_ST25R3_H_
 
#include "stm32wlxx_hal.h"
 
 
/**
 * @brief Check whether an RF field is currently active (phone/reader present).
 *        Reads the EH_CTRL_DYN register and tests the FIELD_ON bit (bit 2).
 *        Use this before calling nfc_st25r3_WriteEEPROM() if the caller needs
 *        to know upfront whether RF activity is in progress.
 * @param hi2c Pointer to I2C handle.
 * @retval 1 – RF field detected (busy), 0 – no RF field or NFC not available.
 */
int8_t nfc_st25r3_IsRFBusy(I2C_HandleTypeDef *hi2c);
 
/**
 * @brief - check if nfc4 tag sensor is present
 * @param tryInit - in case sensor is not yet initialized, 1 - attempt to initialize again, 0 - no
 * @retval 1 - is present, 0 - is not
 */
int8_t nfc_st25r3_Is(I2C_HandleTypeDef *hi2c, int8_t tryInit);
 
/**
 * @brief initializacia nfc
 */
HAL_StatusTypeDef nfc_st25r3_Init(I2C_HandleTypeDef *hi2c);
 
/**
 * @brief Reset the entire EEPROM by writing 0xFF to all bytes up to len.
 * @param hi2c Pointer to I2C handle.
 * @param len  Number of bytes to reset (typically the full EEPROM size).
 */
void nfc_st25r3_ResetEEPROM(I2C_HandleTypeDef *hi2c, uint16_t len);
 
/**
 * @brief Write to address
 */
HAL_StatusTypeDef nfc_st25r3_WriteEEPROM(I2C_HandleTypeDef *hi2c, uint16_t addr, uint8_t *pData, uint16_t len);
 
/**
 * @brief Read from EEPROM
 */
HAL_StatusTypeDef nfc_st25r3_ReadEEPROM(I2C_HandleTypeDef *hi2c, uint16_t addr, uint8_t *pData, uint16_t len);
 
/**
 * @brief get state
 */
HAL_StatusTypeDef nfc_st25r3_IsOn(I2C_HandleTypeDef *hi2c, uint8_t *onOff);
 
/**
 * @brief Turn on sensor for sending INT that NFC was activated. Increases consumption. Not necessary, reads via EEPROM anyway
 * I don't see why this would make sense
 */
HAL_StatusTypeDef nfc_st25r3_On(I2C_HandleTypeDef *hi2c);
 
/**
 * @brief turn off GPO_EN
 */
HAL_StatusTypeDef nfc_st25r3_Off(I2C_HandleTypeDef *hi2c);
 
 
/*
 * MailBox doesn't work.... so giving up on these....
 */
 
HAL_StatusTypeDef nfc_st25r3_ProcessMailBox(I2C_HandleTypeDef *hi2c);
HAL_StatusTypeDef nfc_st25r3_WriteMailBoxNDEF(I2C_HandleTypeDef *hi2c, char *text);
HAL_StatusTypeDef nfc_st25r3_SetRFMgmt(I2C_HandleTypeDef *hi2c, uint8_t enable);
 
// Weak callback for main.c
__weak void nfc_st25r3_OnMailboxData(uint8_t *data, uint16_t len);
 
 
 
#endif /* INC_NFC_ST25R3_H_ */
#endif