nfc-nxp.h

Go to the documentation of this file.

#ifndef DRIVER_NFC_NXP_H
#define DRIVER_NFC_NXP_H
/**********************************************************************/
/**
 * @file
 * @brief Driver for NFC in EVE.
 *
 * @author DT, SE, Jetro AS
 ***********************************************************************/

#include <sys/etimer.h>
#include <dev/spi.h>
#include <core/rtos.h>

#include <nfc_t2t_lib.h>

#include "ph_NxpBuild_App.h"
#include "ph_NxpBuild.h"

#include <ph_Status.h>
#include <ph_RefDefs.h>
#include <phbalReg.h>

/* Reader Library Headers */
#include <ph_Status.h>
#include <phOsal.h>
#include <phbalReg.h>
/* PAL Headers */
#include <phpalI14443p3a.h>
#include <phpalI14443p4.h>
#include <phpalFelica.h>
#include <phpalI14443p3b.h>
#include <phpalI14443p4a.h>
#include <phpalI18092mPI.h>
#include <phpalMifare.h>
#include <phpalI14443p4mC.h>
#include <phpalSli15693.h>
#include <phpalI18000p3m3.h>
#include <phalI18000p3m3.h>
/* AL Headers */
#include <phalT1T.h>
#include <phceT4T.h>
#include <phalFelica.h>
/* Discovery Loop Headers */
#include <phacDiscLoop.h>


/**
 * \defgroup pn512 pn512 NFC chip driver
 * \ingroup extdrv
 * \{
 *
 * This NFC driver supports pn512 NFC chip connected with EVE SPI driver.
 */

/******************************************************************************
 *  NXP lib defines
 *****************************************************************************/

#ifdef   NXPBUILD__PH_DEBUG
#include <stdio.h>
#define  DEBUG_PRINTF(...) printf(__VA_ARGS__)
#else
#define  DEBUG_PRINTF(...)
#endif

/* prints if error is detected */
#define CHECK_STATUS(x)                                      \
    if ((x) != PH_ERR_SUCCESS)                               \
{                                                            \
    DEBUG_PRINTF("%s: %d   Error - (0x%04X) has occurred : 0xCCEE CC-Component ID, EE-Error code. Refer ph_Status.h\n", \
        __FILE__, __LINE__, (x));    \
}

/* if error is detected - prints and returns status */
#define CHECK_SUCCESS(x)              \
    if ((x) != PH_ERR_SUCCESS)        \
{                                     \
    DEBUG_PRINTF("%s: %d   Error - (0x%04X) has occurred : 0xCCEE CC-Component ID, EE-Error code. Refer ph_Status.h\n ", \
        __FILE__, __LINE__, (x)); \
    return (x);                       \
}

/* if error is detected - prints and returns false */
#define ASSERT_STATUS(x)              \
    if ((x) != PH_ERR_SUCCESS)        \
{                                     \
    DEBUG_PRINTF("%s: %d   Error - (0x%04X) has occurred : 0xCCEE CC-Component ID, EE-Error code. Refer ph_Status.h\n ", \
        __FILE__, __LINE__, (x)); \
    return (false);                       \
}

/* Set this to 1 for running ISO 10373-6 PICC test bench. When set to 1, code
 * for creating WTX (for TEST_COMMAND3) in ISO test bench will be enabled. */
#define ISO_10373_6_PICC_TEST_BENCH 0

/* Use application callback for processing UPDATE BINARY and proprietary commands */
#define USE_APP_CALLBACK 1

/* Get content length from CC file. Initial content length is 0. */
#define GET_CCFILE_CONTENT_LEN(x) ((((uint16_t)(x[0]) << 8) & 0xFF00) | (x[1]))

/* Get content length specified in file (first 2 bytes of file) for NDEF and proprietary files */
#define GET_FILE_CONTENT_LEN(x) ((((((uint16_t)(x[0]) << 8) & 0xFF00) | (x[1])) > 0)?   \
                                 (((((uint16_t)(x[0]) << 8) & 0xFF00) | (x[1])) + 2) : 0)

#ifdef NXPBUILD__PH_DEBUG
    #define DEBUG_ERROR_PRINT CHECK_STATUS
    #define PRINT_INFO(...) DEBUG_PRINTF(__VA_ARGS__)
#else /* NXPBUILD__PH_DEBUG */
    #define DEBUG_ERROR_PRINT(x)
    #define PRINT_INFO(...)
#endif /* NXPBUILD__PH_DEBUG */

#define SoftReset_reader_device(pHal)    phhalHw_Rc523_Cmd_SoftReset(pHal)

/******************************************************************************
 *  NFC driver public types
 *****************************************************************************/

struct nfc_nxp_t;

/**
 * @brief The callback is called on interrupt from pn512
 * @param Nfc       NFC driver descriptor
 */
typedef void (*nfc_irq_callback_t)(const struct nfc_nxp_t* Nfc);
//bool NfcNxpLibInit(const struct nfc_nxp_t* Nfc_p);


/**
 * @brief NFC driver descriptor: static structure for configuration of driver instance.
 */
struct nfc_nxp_t
{
  const struct nfc_ndef_changed_cb_table_t* NdefChangedCbTable; //!< table of interrupt handlers for supported NFC message types
  struct nfc_nxp_state_t* State;     //!< Pointer to the NFC state

  const struct spi_t* Spi;       //!< Pointer to the SPI interface instance
  const struct spi_cs_t SpiCs;   //!< SPI CS settings
  uint32_t SpiBaudrate;          //!< SPI speed

  const struct adc_channel_t *AdcIcc; //!< ADC channel used for ICC measurement

  nfc_irq_callback_t NfcIrqCb;   //!< interrupt handler

  uint8_t IrqPin;                //!< IRQn pin
  uint8_t ResetPin;              //!< RSTPDn pin
  uint8_t DetectPin;             //!< Card detect sense enable pin

  /* Parameters for L3 activation during Autocoll */
  uint8_t sens_res_def[2];        //!< ATQ bytes - needed for anti-collision
  uint8_t nfc_id1_def[3];         //!< user defined bytes of the UID (one is hardcoded) - needed for anti-collision
  uint8_t sel_res_def;            //!< SAK (ISO18092mT or ISO14443P4 Card) - needed for anti-collision
  uint8_t nfc_id3_def;            //!< NFC3 byte - required for anti-collision
  uint8_t poll_res_def[18];
  uint8_t aAtsRes_def[5];         //!< ATS Response send for RATS: |TL|T0|TA|TB|TC|
  uint8_t GI_def[13];             //!< General information bytes to be sent with ATR */

};

/**
 * @brief holds current NFC instance state variables.
 */
struct nfc_nxp_state_t
{

  bool Enabled;                  //!< The chip is enabled

  phbalReg_Stub_DataParams_t         sBalReader;                 //!< BAL component holder
  phhalHw_Nfc_Ic_DataParams_t        sHal_Nfc_Ic;                //!< HAL component holder for Nfc Ic's
  uint8_t                            bHalBufferTx[256];          //!< HAL TX buffer. Size 256 - Based on maximum FSL
  uint8_t                            bHalBufferRx[256];          //!< HAL RX buffer. Size 256 - Based on maximum FSL
  void*                              pHal;                       //!< HAL pointer
  phpalI14443p3a_Sw_DataParams_t     spalI14443p3a;              //!< PAL ISO I14443-A component
  phpalI14443p4a_Sw_DataParams_t     spalI14443p4a;              //!< PAL ISO I14443-4A component
  phpalI14443p3b_Sw_DataParams_t     spalI14443p3b;              //!< PAL ISO I14443-B component
  phpalI14443p4_Sw_DataParams_t      spalI14443p4;               //!< PAL ISO I14443-4 component
  phpalI14443p4mC_Sw_DataParams_t    sPalI14443p4mC;
  phpalFelica_Sw_DataParams_t      spalFelica;                 //!< PAL Felica component
  phpalI18092mPI_Sw_DataParams_t     spalI18092mPI;              //!< PAL ISO 18092 Initiator component
  phpalMifare_Sw_DataParams_t      spalMifare;                 //!< PAL Mifare component
  phacDiscLoop_Sw_DataParams_t       sDiscLoop;                  //!< Discovery loop component
  phalT1T_Sw_DataParams_t            alT1T;                      //!< AL T1T component
  phceT4T_Sw_DataParams_t            sCeT4T;
  uint8_t                            aData[50];                  //!< ATR response holder
  uint8_t                            aAppBuffer[256];
  uint8_t                            aCcFile[23];                //!< Mandatory Capability Container (CC) file. It's set using phceT4T_SetElementaryFile.
  uint8_t*                           aNdefFile;                  //!< Mandatory NDEF file. It's set using phceT4T_SetElementaryFile.
  uint16_t                           aNdefFileSize;              //!< Mandatory NDEF file size.
  uint8_t                            aAtsRes[5];                 // ATS Response send for RATS: |TL|T0|TA|TB|TC|
  uint16_t wAtsLength;                                           // ATS length
  uint8_t sens_res[2];        //!< ATQ bytes - needed for anti-collision
  uint8_t nfc_id1[3];         //!< user defined bytes of the UID (one is hardcoded) - needed for anti-collision
  uint8_t sel_res;            //!< SAK (ISO18092mT or ISO14443P4 Card) - needed for anti-collision
  uint8_t nfc_id3;            //!< NFC3 byte - required for anti-collision
  uint8_t poll_res[18];
  uint8_t GI[13];             //!< General information bytes to be sent with ATR */

  #ifdef NXPBUILD__PHCE_T4T_PROPRIETARY
  uint8_t                            aProprietaryFile[100];      //!< Optional proprietary file. It's set using phceT4T_SetElementaryFile.
  #endif // NXPBUILD__PHCE_T4T_PROPRIETARY

  /// Semaphores for synchronization between application thread and reader library thread.
  phOsal_SemaphoreHandle_t           appstart;                   //!< Used to synchronize start of one cycle of application processing
  phOsal_SemaphoreHandle_t           appexit;                    //!< Used to synchronize end of one cycle of application processing
  #if ISO_10373_6_PICC_TEST_BENCH
  phOsal_SemaphoreHandle_t           timerwtx;                   //!< Used in PICC ISO 10373-6 test bench to create WTX
  #endif // ISO_10373_6_PICC_TEST_BENCH

  EventGroupHandle_t gphOsal_EventGroup; // Global Status of ISR Event Register Status to Receive Events from ISR
  volatile phOsal_EventSource_t gphOsal_EvtLastSource; // Source of Events
  volatile phOsal_EventDestination_t gphOsal_EvtLastDest; // Destination of Events
  volatile phOsal_EventDetail_t gphOsal_EvtDetail; // Event Detail

};

/******************************************************************************
 *  NFC driver globals
 *****************************************************************************/
extern const struct nfc_nxp_t* NfcNxp_ptr;

/******************************************************************************
 *  NFC driver public functions
 *****************************************************************************/

/**
 * @brief Initialises NFC instance structure, connects it to SPI.\n
 *        Powers up pn512 if supported
 * @param Nfc       NFC driver descriptor
 */
bool NfcNxpLibInit(const struct nfc_nxp_t* Nfc);

/**
 * @brief Disables interrupts from pn512 and releases SPI.\n
 * Powers down pn512 if supported by product HW.
 * @param Nfc       NFC driver descriptor
 */
bool NfcNxpLibDisable(const struct nfc_nxp_t* Nfc);

/**
 * @brief Performs pn512 HW reset. pn512 switches to configuration mode after reset.\n
 * NB! It should be verified that pn512 is in configuration mode with
 * NfcNxpGetMode() function after reset before any subsequent operation.
 * @param Nfc       NFC driver descriptor
 */
void NfcNxpResetReader(const struct nfc_nxp_t* Nfc);

/**
 * @brief Sets up pn512 registers according to preconfigured parameters.\n
 * NB! pn512 should be in configuration mode.
 * @param Nfc       NFC driver descriptor
 */
bool NfcNxpSetup(const struct nfc_nxp_t* Nfc);

/**
 * @brief Starts cards detection phase.
 * During execution NFC lib is in the reader mode.\n
 * NFC lib loops through all the available (configured) RF technologies.
 * @param Nfc       NFC driver descriptor
 * @param Continue  true: start technologies discovery loop and discover cards in the first available technology.
 *                  false: discover cards in the next available technology.
 * @return uint8_t  Number of cards detected for the first available technology (Continue==false),
 *                  or the next available technology ((Continue==true).
 *                  Return value of 0 means there is no next technology.
 */
uint8_t NfcNxpDiscovery(const struct nfc_nxp_t* Nfc, bool Continue);

/**
* @brief Returns UID of one of detected tags
* \param [in]   Nfc        NFC driver descriptor
* \param [in]   TagIndex   Index of the card in the array of detected cards to read.
* \param [out]  Uid        UID of the requested card
* \param [out]  UidLen     Length of the UID returned
*/
void NfcNxpGetUid(const struct nfc_nxp_t* Nfc, uint8_t TagIndex, uint8_t** Uid, uint8_t* UidLen);

/**
 * @brief Sets a memory buffer as an NDEF file for subsequent
 * NfcNrfCardEmulation function call.
 * @param Nfc           NFC driver descriptor
 * @param NdefFile      Pointer to the buffer to set.
 * @param NdefFileSize  Full buffer length (not current data length!)
 */
void NfcNxpSetNdefFile(const struct nfc_nxp_t* Nfc,
                       uint8_t* NdefFile, uint16_t NdefFileSize);

/**
 * @brief Starts external RF detection phase
 * During execution NFC lib is in the card emulation mode.\n
 * @param Nfc         NFC driver descriptor
 * param TypeName    NDEF record type name - NULL terminated ASCII string
 * param Data        NDEF record data
 * param DataLen     NDEF record data length
 */
void NfcNxpCardEmulation(const struct nfc_nxp_t* Nfc/*, const char* TypeName,
                      uint8_t* Data, uint32_t DataLen*/);

/**
 * @brief Driver's HW interrupt callback to be exposed to EVE config
 * @param Nfc       Pointer to NFC instance structure
 */
void NfcNxpInterruptCb(const struct nfc_nxp_t* Nfc);


/** \} pn512 */


#endif // DRIVER_NFC_NXP_H