Diego Ostuni
Fork of the GitHub
Diff: rfal_nfcf.h
- Revision:
- 0:75fc82583a41
diff -r 000000000000 -r 75fc82583a41 rfal_nfcf.h
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/rfal_nfcf.h Thu Nov 14 14:34:50 2019 +0000
@@ -0,0 +1,287 @@
+
+/******************************************************************************
+ * @attention
+ *
+ * <h2><center>© COPYRIGHT 2016 STMicroelectronics</center></h2>
+ *
+ * Licensed under ST MYLIBERTY SOFTWARE LICENSE AGREEMENT (the "License");
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.st.com/myliberty
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+ * AND SPECIFICALLY DISCLAIMING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+******************************************************************************/
+
+/*
+ * PROJECT: ST25R391x firmware
+ * $Revision: $
+ * LANGUAGE: ISO C99
+ */
+
+/*! \file rfal_nfcf.h
+ *
+ * \author Gustavo Patricio
+ *
+ * \brief Implementation of NFC-F Poller (FeliCa PCD) device
+ *
+ * The definitions and helpers methods provided by this module are
+ * aligned with NFC-F (FeliCa - JIS X6319-4)
+ *
+ *
+ * @addtogroup RFAL
+ * @{
+ *
+ * @addtogroup RFAL-AL
+ * @brief RFAL Abstraction Layer
+ * @{
+ *
+ * @addtogroup NFC-F
+ * @brief RFAL NFC-F Module
+ * @{
+ *
+ */
+
+
+#ifndef RFAL_NFCF_H
+#define RFAL_NFCF_H
+
+/*
+ ******************************************************************************
+ * INCLUDES
+ ******************************************************************************
+ */
+#include "platform1.h"
+#include "st_errno.h"
+#include "rfal_rf.h"
+
+/*
+ ******************************************************************************
+ * GLOBAL DEFINES
+ ******************************************************************************
+ */
+
+#define RFAL_NFCF_NFCID2_LEN 8 /*!< NFCID2 (FeliCa IDm) length */
+#define RFAL_NFCF_SENSF_RES_LEN_MIN 16 /*!< SENSF_RES minimum length */
+#define RFAL_NFCF_SENSF_RES_LEN_MAX 18 /*!< SENSF_RES maximum length */
+#define RFAL_NFCF_SENSF_RES_PAD0_LEN 2 /*!< SENSF_RES PAD0 length */
+#define RFAL_NFCF_SENSF_RES_PAD1_LEN 2 /*!< SENSF_RES PAD1 length */
+#define RFAL_NFCF_SENSF_RES_RD_LEN 2 /*!< SENSF_RES Request Data length */
+#define RFAL_NFCF_SENSF_RES_BYTE1 1 /*!< SENSF_RES first byte value */
+#define RFAL_NFCF_SENSF_SC_LEN 2 /*!< Felica SENSF_REQ System Code length */
+#define RFAL_NFCF_SENSF_PARAMS_SC1_POS 0 /*!< System Code byte1 position in the SENSF_REQ */
+#define RFAL_NFCF_SENSF_PARAMS_SC2_POS 1 /*!< System Code byte2 position in the SENSF_REQ */
+#define RFAL_NFCF_SENSF_PARAMS_RC_POS 2 /*!< Request Code position in the SENSF_REQ */
+#define RFAL_NFCF_SENSF_PARAMS_TSN_POS 3 /*!< Time Slot Number position in the SENSF_REQ */
+#define RFAL_NFCF_POLL_MAXCARDS 16 /*!< Max number slots/cards 16 */
+
+
+#define RFAL_NFCF_CMD_LEN 1 /*!< Command/Responce code length */
+#define RFAL_NFCF_LENGTH_LEN 1 /*!< LEN field length */
+#define RFAL_NFCF_HEADER_LEN (RFAL_NFCF_LENGTH_LEN + RFAL_NFCF_CMD_LEN) /*!< Header length*/
+
+
+#define RFAL_NFCF_SENSF_NFCID2_BYTE1_POS 0 /*!< NFCID2 byte1 position */
+#define RFAL_NFCF_SENSF_NFCID2_BYTE2_POS 1 /*!< NFCID2 byte2 position */
+
+#define RFAL_NFCF_SENSF_NFCID2_PROT_TYPE_LEN 2 /*!< NFCID2 length for byte 1 and byte 2 indicating NFC-DEP or T3T support */
+#define RFAL_NFCF_SENSF_NFCID2_BYTE1_NFCDEP 0x01 /*!< NFCID2 byte1 NFC-DEP support Digital 1.0 Table 44*/
+#define RFAL_NFCF_SENSF_NFCID2_BYTE2_NFCDEP 0xFE /*!< NFCID2 byte2 NFC-DEP support Digital 1.0 Table 44*/
+
+#define RFAL_NFCF_SYSTEMCODE 0xFFFF /*!< SENSF_RES Default System Code Digital 1.0 6.6.1.1 */
+
+
+/*! NFC-F Felica command set JIS X6319-4 9.1 */
+enum
+{
+ RFAL_NFCF_CMD_POLLING = 0x00, /*!< SENSF_REQ (Felica Poll/REQC command to identify a card ) */
+ RFAL_NFCF_CMD_POLLING_RES = 0x01, /*!< SENSF_RES (Felica Poll/REQC command response ) */
+ RFAL_NFCF_CMD_REQUEST_SERVICE = 0x02, /*!< verify the existence of Area and Service */
+ RFAL_NFCF_CMD_REQUEST_RESPONSE = 0x04, /*!< verify the existence of a card */
+ RFAL_NFCF_CMD_READ_WITHOUT_ENCRYPTION = 0x06, /*!< read Block Data from a Service that requires no authentication */
+ RFAL_NFCF_CMD_WRITE_WITHOUT_ENCRYPTION = 0x08, /*!< write Block Data to a Service that requires no authentication */
+ RFAL_NFCF_CMD_REQUEST_SYSTEM_CODE = 0x0c, /*!< acquire the System Code registered to a card */
+ RFAL_NFCF_CMD_AUTHENTICATION1 = 0x10, /*!< authenticate a card */
+ RFAL_NFCF_CMD_AUTHENTICATION2 = 0x12, /*!< allow a card to authenticate a Reader/Writer */
+ RFAL_NFCF_CMD_READ = 0x14, /*!< read Block Data from a Service that requires authentication */
+ RFAL_NFCF_CMD_WRITE = 0x16, /*!< write Block Data to a Service that requires authentication */
+};
+
+/*
+ ******************************************************************************
+ * GLOBAL MACROS
+ ******************************************************************************
+ */
+
+/*! Checks if the given NFC-F device indicates NFC-DEP support */
+#define rfalNfcfIsNfcDepSupported( dev ) ( (((rfalNfcfListenDevice*)(dev))->sensfRes.NFCID2[RFAL_NFCF_SENSF_NFCID2_BYTE1_POS] == RFAL_NFCF_SENSF_NFCID2_BYTE1_NFCDEP) && \
+ (((rfalNfcfListenDevice*)(dev))->sensfRes.NFCID2[RFAL_NFCF_SENSF_NFCID2_BYTE2_POS] == RFAL_NFCF_SENSF_NFCID2_BYTE2_NFCDEP) )
+
+
+/*
+******************************************************************************
+* GLOBAL TYPES
+******************************************************************************
+*/
+
+
+/*! NFC-F SENSF_RES format Digital 1.1 8.6.2 */
+typedef struct
+{
+ uint8_t CMD; /*!< Command Code: 01h */
+ uint8_t NFCID2[RFAL_NFCF_NFCID2_LEN]; /*!< NFCID2 */
+ uint8_t PAD0[RFAL_NFCF_SENSF_RES_PAD0_LEN]; /*!< PAD0 */
+ uint8_t PAD1[RFAL_NFCF_SENSF_RES_PAD1_LEN]; /*!< PAD1 */
+ uint8_t MRTIcheck; /*!< MRTIcheck */
+ uint8_t MRTIupdate; /*!< MRTIupdate */
+ uint8_t PAD2; /*!< PAD2 */
+ uint8_t RD[RFAL_NFCF_SENSF_RES_RD_LEN]; /*!< Request Data */
+} rfalNfcfSensfRes;
+
+
+/*! NFC-F poller device (PCD) struct */
+typedef struct
+{
+ uint8_t NFCID2[RFAL_NFCF_NFCID2_LEN]; /*!< NFCID2 */
+} rfalNfcfPollDevice;
+
+/*! NFC-F listener device (PICC) struct */
+typedef struct
+{
+ uint8_t sensfResLen; /*!< SENF_RES length */
+ rfalNfcfSensfRes sensfRes; /*!< SENF_RES */
+} rfalNfcfListenDevice;
+
+
+/*
+******************************************************************************
+* GLOBAL FUNCTION PROTOTYPES
+******************************************************************************
+*/
+
+/*!
+ *****************************************************************************
+ * \brief Initialize NFC-F Poller mode
+ *
+ * This methods configures RFAL RF layer to perform as a
+ * NFC-F Poller/RW (FeliCa PCD) including all default timings
+ *
+ * \param[in] bitRate : NFC-F bitrate to be initialize (212 or 424)
+ *
+ * \return ERR_WRONG_STATE : RFAL not initialized or mode not set
+ * \return ERR_PARAM : Incorrect bitrate
+ * \return ERR_NONE : No error
+ *****************************************************************************
+ */
+ReturnCode rfalNfcfPollerInitialize( rfalBitRate bitRate, 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 );
+
+
+/*!
+ *****************************************************************************
+ * \brief NFC-F Poller Check Presence
+ *
+ * This function sends a Poll/SENSF command according to NFC Activity spec
+ * It detects if a NCF-F device is within range
+ *
+ * \return ERR_WRONG_STATE : RFAL not initialized or incorrect mode
+ * \return ERR_PARAM : Invalid parameters
+ * \return ERR_IO : Generic internal error
+ * \return ERR_CRC : CRC error detected
+ * \return ERR_FRAMING : Framing error detected
+ * \return ERR_PROTO : Protocol error detected
+ * \return ERR_TIMEOUT : Timeout error, no listener device detected
+ * \return ERR_NONE : No error and some NFC-F device was detected
+ *
+ *****************************************************************************
+ */
+ReturnCode rfalNfcfPollerCheckPresence( 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 );
+
+
+/*!
+ *****************************************************************************
+ * \brief NFC-F Poller Poll
+ *
+ * This function sends to all PICCs in field the POLL command with the given
+ * number of slots.
+ *
+ * \param[in] slots : the number of slots to be performed
+ * \param[in] sysCode : as given in FeliCa poll command
+ * \param[in] reqCode : FeliCa communication parameters
+ * \param[out] cardList : Parameter of type rfalFeliCaPollRes which will hold the cards found
+ * \param[out] devCnt : actual number of cards found
+ * \param[out] collisions : number of collisions encountered
+ *
+ * \warning the list cardList has to be as big as the number of slots for the Poll
+ *
+ * \return ERR_WRONG_STATE : RFAL not initialized or incorrect mode
+ * \return ERR_PARAM : Invalid parameters
+ * \return ERR_IO : Generic internal error
+ * \return ERR_CRC : CRC error detected
+ * \return ERR_FRAMING : Framing error detected
+ * \return ERR_PROTO : Protocol error detected
+ * \return ERR_TIMEOUT : Timeout error, no listener device detected
+ * \return ERR_NONE : No error and some NFC-F device was detected
+ *
+ *****************************************************************************
+ */
+ReturnCode rfalNfcfPollerPoll( rfalFeliCaPollSlots slots, uint16_t sysCode, uint8_t reqCode, rfalFeliCaPollRes *cardList, uint8_t *devCnt, uint8_t *collisions, 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 );
+
+
+/*!
+ *****************************************************************************
+ * \brief NFC-F Poller Full Collision Resolution
+ *
+ * Performs a full Collision resolution as defined in Activity 1.1 9.3.4
+ *
+ * \param[in] compMode : compliance mode to be performed
+ * \param[in] devLimit : device limit value, and size nfcaDevList
+ * \param[out] nfcfDevList : NFC-F listener devices list
+ * \param[out] devCnt : Devices found counter
+ *
+ * \return ERR_WRONG_STATE : RFAL not initialized or mode not set
+ * \return ERR_PARAM : Invalid parameters
+ * \return ERR_IO : Generic internal error
+ * \return ERR_NONE : No error
+ *****************************************************************************
+ */
+ReturnCode rfalNfcfPollerCollisionResolution( rfalComplianceMode compMode, uint8_t devLimit, rfalNfcfListenDevice *nfcfDevList, uint8_t *devCnt,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 );
+
+
+/*!
+ *****************************************************************************
+ * \brief NFC-F Listener is T3T Request
+ *
+ * This method checks if the given data is a valid T3T command (Read or Write)
+ * and in case a valid request has been received it may output the request's NFCID2
+ *
+ * \param[in] buf : buffer holding Initiator's received command
+ * \param[in] bufLen : length of received command in bytes
+ * \param[out] nfcid2 : pointer to where the NFCID2 may be outputed,
+ * nfcid2 has NFCF_SENSF_NFCID2_LEN as length
+ * Pass NULL if output parameter not desired
+ *
+ * \return true : Valid T3T command (Read or Write) received
+ * \return false : Invalid protocol request
+ *
+ *****************************************************************************
+ */
+bool rfalNfcfListenerIsT3TReq( uint8_t* buf, uint16_t bufLen, uint8_t* nfcid2 );
+
+
+#endif /* RFAL_NFCF_H */
+
+/**
+ * @}
+ *
+ * @}
+ *
+ * @}
+ */
+