ST / Mbed 2 deprecated NFC01A1_Demos

This application provides a set of demos with X-NUCLEO-NFC01A1 expansion board.

Dependencies:   NDefLib X_NUCLEO_NFC01A1 mbed

Fork of X-MBED-NFC1 by Giovanni Visentini

This application provides a set of demos with X-NUCLEO-NFC01A1 expansion board.

The available demos are:

  • SAMPLE_WRITE_URL: write a tag with the ST home page URL
  • SAMPLE_COUNT_CLICK: create a custom tag to count and report the user button clicks.
  • SAMPLE_WRITE_AND_CHANGE_ALL: write a tag with all the supported records and update the tag contents when the user button is pressed.
  • SAMPLE_LOCK_TAG_CONTENT: use the M24SR component API to set the NFC tag as read-only.

To enable the different demos comment/uncomment the SAMPLE_* macros provided in main.cpp .

Common/nfc.h@0:674813bd5ec9, 2015-11-19 (annotated)

Committer:
giovannivisentini
Date:
Thu Nov 19 08:50:18 2015 +0000
Revision:
0:674813bd5ec9
Child:
1:6d202b62ed68
first commit,

Who changed what in which revision?

UserRevisionLine numberNew contents of line
giovannivisentini 0:674813bd5ec9 1 /**
giovannivisentini 0:674813bd5ec9 2 ******************************************************************************
giovannivisentini 0:674813bd5ec9 3 * @file nfc.h
giovannivisentini 0:674813bd5ec9 4 * @author ST Central Labs
giovannivisentini 0:674813bd5ec9 5 * @version V1.0.0
giovannivisentini 0:674813bd5ec9 6 * @date 14-October-2015
giovannivisentini 0:674813bd5ec9 7 * @brief This header file contains the functions prototypes for the
giovannivisentini 0:674813bd5ec9 8 * NFC device driver.
giovannivisentini 0:674813bd5ec9 9 ******************************************************************************
giovannivisentini 0:674813bd5ec9 10 * @attention
giovannivisentini 0:674813bd5ec9 11 *
giovannivisentini 0:674813bd5ec9 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
giovannivisentini 0:674813bd5ec9 13 *
giovannivisentini 0:674813bd5ec9 14 * Redistribution and use in source and binary forms, with or without modification,
giovannivisentini 0:674813bd5ec9 15 * are permitted provided that the following conditions are met:
giovannivisentini 0:674813bd5ec9 16 * 1. Redistributions of source code must retain the above copyright notice,
giovannivisentini 0:674813bd5ec9 17 * this list of conditions and the following disclaimer.
giovannivisentini 0:674813bd5ec9 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
giovannivisentini 0:674813bd5ec9 19 * this list of conditions and the following disclaimer in the documentation
giovannivisentini 0:674813bd5ec9 20 * and/or other materials provided with the distribution.
giovannivisentini 0:674813bd5ec9 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
giovannivisentini 0:674813bd5ec9 22 * may be used to endorse or promote products derived from this software
giovannivisentini 0:674813bd5ec9 23 * without specific prior written permission.
giovannivisentini 0:674813bd5ec9 24 *
giovannivisentini 0:674813bd5ec9 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
giovannivisentini 0:674813bd5ec9 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
giovannivisentini 0:674813bd5ec9 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
giovannivisentini 0:674813bd5ec9 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
giovannivisentini 0:674813bd5ec9 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
giovannivisentini 0:674813bd5ec9 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
giovannivisentini 0:674813bd5ec9 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
giovannivisentini 0:674813bd5ec9 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
giovannivisentini 0:674813bd5ec9 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
giovannivisentini 0:674813bd5ec9 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
giovannivisentini 0:674813bd5ec9 35 *
giovannivisentini 0:674813bd5ec9 36 ******************************************************************************
giovannivisentini 0:674813bd5ec9 37 */
giovannivisentini 0:674813bd5ec9 38 #ifndef __NFC_H_
giovannivisentini 0:674813bd5ec9 39 #define __NFC_H_
giovannivisentini 0:674813bd5ec9 40
giovannivisentini 0:674813bd5ec9 41 #ifdef __cplusplus
giovannivisentini 0:674813bd5ec9 42 extern "C" {
giovannivisentini 0:674813bd5ec9 43 #endif
giovannivisentini 0:674813bd5ec9 44
giovannivisentini 0:674813bd5ec9 45 /* Includes ------------------------------------------------------------------*/
giovannivisentini 0:674813bd5ec9 46 #include <stdint.h>
giovannivisentini 0:674813bd5ec9 47 #include "component.h"
giovannivisentini 0:674813bd5ec9 48 /** @addtogroup BSP
giovannivisentini 0:674813bd5ec9 49 * @{
giovannivisentini 0:674813bd5ec9 50 */
giovannivisentini 0:674813bd5ec9 51
giovannivisentini 0:674813bd5ec9 52 /** @addtogroup Components
giovannivisentini 0:674813bd5ec9 53 * @{
giovannivisentini 0:674813bd5ec9 54 */
giovannivisentini 0:674813bd5ec9 55
giovannivisentini 0:674813bd5ec9 56 /** @addtogroup NFC
giovannivisentini 0:674813bd5ec9 57 * @{
giovannivisentini 0:674813bd5ec9 58 */
giovannivisentini 0:674813bd5ec9 59
giovannivisentini 0:674813bd5ec9 60 /** @defgroup NFC_Exported_Types
giovannivisentini 0:674813bd5ec9 61 * @{
giovannivisentini 0:674813bd5ec9 62 */
giovannivisentini 0:674813bd5ec9 63
giovannivisentini 0:674813bd5ec9 64 /**
giovannivisentini 0:674813bd5ec9 65 * @brief NFC init structure definition
giovannivisentini 0:674813bd5ec9 66 */
giovannivisentini 0:674813bd5ec9 67 typedef void* NFC_InitTypeDef;
giovannivisentini 0:674813bd5ec9 68 /**
giovannivisentini 0:674813bd5ec9 69 * @brief Humidity and temperature status enumerator definition
giovannivisentini 0:674813bd5ec9 70 */
giovannivisentini 0:674813bd5ec9 71 typedef enum {
giovannivisentini 0:674813bd5ec9 72 NFC_OK = 0x9000,
giovannivisentini 0:674813bd5ec9 73 NFC_ERROR=0x6F00,
giovannivisentini 0:674813bd5ec9 74 NFC_FILE_OVERFLOW_LE = 0x6280,
giovannivisentini 0:674813bd5ec9 75 NFC_EOF = 0x6282,
giovannivisentini 0:674813bd5ec9 76 NFC_PASSWORD_REQUIRED = 0x6300,
giovannivisentini 0:674813bd5ec9 77 NFC_PASSWORD_INCORRECT = 0x63C0,
giovannivisentini 0:674813bd5ec9 78 NFC_PASSWORD_INCORRECT1RETRY = 0x63C1,
giovannivisentini 0:674813bd5ec9 79 NFC_PASSWORD_INCORRECT2RETRY = 0x63C2,
giovannivisentini 0:674813bd5ec9 80 NFC_WRONG_LENGHT = 0x6700,
giovannivisentini 0:674813bd5ec9 81 NFC_UNSUCESSFUL_UPDATING = 0x6581,
giovannivisentini 0:674813bd5ec9 82 NFC_INCOPATIBLE_COMMAND= 0x6981,
giovannivisentini 0:674813bd5ec9 83 NFC_SECURITY_UNSATISFIED = 0x6982,
giovannivisentini 0:674813bd5ec9 84 NFC_REFERENCE_DATA_NOT_USABLE = 0x6984,
giovannivisentini 0:674813bd5ec9 85
giovannivisentini 0:674813bd5ec9 86 NFC_INCORRECT_PARAMETER = 0x6a80,
giovannivisentini 0:674813bd5ec9 87 NFC_FILE_NOT_FOUND=0x6a82,
giovannivisentini 0:674813bd5ec9 88 NFC_FILE_OVERFLOW_LC = 0x6A84, //TODO difference with Le??
giovannivisentini 0:674813bd5ec9 89
giovannivisentini 0:674813bd5ec9 90 NFC_INCORRECT_P1_OR_P2 = 0x6A86, //TODO better name?
giovannivisentini 0:674813bd5ec9 91 NFC_RF_SESSION_KILLED=0x6500,
giovannivisentini 0:674813bd5ec9 92 NFC_INS_NOT_SUPPORTED=0x6D00,
giovannivisentini 0:674813bd5ec9 93 NFC_CLASS_NOT_SUPPORTED=0x6E00,
giovannivisentini 0:674813bd5ec9 94
giovannivisentini 0:674813bd5ec9 95 //IOError
giovannivisentini 0:674813bd5ec9 96 NFC_IO_SUCCESS=0x0000,
giovannivisentini 0:674813bd5ec9 97 NFC_IO_ERROR_DEFAULT=0x0010,
giovannivisentini 0:674813bd5ec9 98 NFC_IO_ERROR_I2CTIMEOUT=0x0011,
giovannivisentini 0:674813bd5ec9 99 NFC_IO_ERROR_CRC=0x0012,
giovannivisentini 0:674813bd5ec9 100 NFC_IO_ERROR_NACK=0x0013,
giovannivisentini 0:674813bd5ec9 101 NFC_IO_ERROR_PARAMETER=0x0014,
giovannivisentini 0:674813bd5ec9 102 NFC_IO_ERROR_NBATEMPT=0x0015,
giovannivisentini 0:674813bd5ec9 103 NFC_IO_NOACKNOWLEDGE=0x0016
giovannivisentini 0:674813bd5ec9 104 } NFC_StatusTypeDef;
giovannivisentini 0:674813bd5ec9 105
giovannivisentini 0:674813bd5ec9 106 /**
giovannivisentini 0:674813bd5ec9 107 * @brief NFC component identifier enumerator definition.
giovannivisentini 0:674813bd5ec9 108 */
giovannivisentini 0:674813bd5ec9 109 typedef enum
giovannivisentini 0:674813bd5ec9 110 {
giovannivisentini 0:674813bd5ec9 111 NFC_NONE_COMPONENT = 0,
giovannivisentini 0:674813bd5ec9 112 NFC_M24SR_COMPONENT = 1
giovannivisentini 0:674813bd5ec9 113 } NFC_ComponentTypeDef;
giovannivisentini 0:674813bd5ec9 114
giovannivisentini 0:674813bd5ec9 115
giovannivisentini 0:674813bd5ec9 116 /**
giovannivisentini 0:674813bd5ec9 117 * @brief NFC driver structure definition
giovannivisentini 0:674813bd5ec9 118 */
giovannivisentini 0:674813bd5ec9 119 typedef struct {
giovannivisentini 0:674813bd5ec9 120 /* Generic */
giovannivisentini 0:674813bd5ec9 121 NFC_StatusTypeDef (*Init) (void *handle, NFC_InitTypeDef *init);
giovannivisentini 0:674813bd5ec9 122 NFC_StatusTypeDef (*ReadID) (void *handle, uint8_t *id);
giovannivisentini 0:674813bd5ec9 123
giovannivisentini 0:674813bd5ec9 124 /* Interrupts */
giovannivisentini 0:674813bd5ec9 125 NFC_StatusTypeDef (*SendInterrupt)(void *handle);
giovannivisentini 0:674813bd5ec9 126
giovannivisentini 0:674813bd5ec9 127 /* Specific */
giovannivisentini 0:674813bd5ec9 128 //I2C session Commands:
giovannivisentini 0:674813bd5ec9 129 NFC_StatusTypeDef (*GetSession)(void *handle);
giovannivisentini 0:674813bd5ec9 130 NFC_StatusTypeDef (*KillSession)(void *handle);
giovannivisentini 0:674813bd5ec9 131 NFC_StatusTypeDef (*Deselect)(void *handle);
giovannivisentini 0:674813bd5ec9 132
giovannivisentini 0:674813bd5ec9 133 //NFC forum type 4 commands:
giovannivisentini 0:674813bd5ec9 134 NFC_StatusTypeDef (*SelectApplication)(void *handle);
giovannivisentini 0:674813bd5ec9 135 NFC_StatusTypeDef (*SelectCCfile)(void *handle);
giovannivisentini 0:674813bd5ec9 136 NFC_StatusTypeDef (*SelectNDEFfile)(void *handle, uint16_t NDEFfileId);
giovannivisentini 0:674813bd5ec9 137 NFC_StatusTypeDef (*SelectSystemfile)(void *handle);
giovannivisentini 0:674813bd5ec9 138 NFC_StatusTypeDef (*ReadBinary)(void *handle, uint16_t Offset, uint8_t NbByteToRead, uint8_t *pBufferRead);
giovannivisentini 0:674813bd5ec9 139 NFC_StatusTypeDef (*UpdateBinary)(void *handle, uint16_t Offset, uint8_t NbByteToWrite, uint8_t *pDataToWrite);
giovannivisentini 0:674813bd5ec9 140
giovannivisentini 0:674813bd5ec9 141 //ISO/IEC 7816-4 commands:
giovannivisentini 0:674813bd5ec9 142 NFC_StatusTypeDef (*Verify)(void *handle, uint16_t uPwdId, uint8_t NbPwdByte, uint8_t *pPwd);
giovannivisentini 0:674813bd5ec9 143 NFC_StatusTypeDef (*ChangeReferenceData)(void *handle, uint16_t uPwdId, uint8_t *pPwd);
giovannivisentini 0:674813bd5ec9 144 NFC_StatusTypeDef (*EnableVerificationRequirement)(void *handle, uint16_t uReadOrWrite);
giovannivisentini 0:674813bd5ec9 145 NFC_StatusTypeDef (*DisableVerificationRequirement)(void *handle, uint16_t uReadOrWrite);
giovannivisentini 0:674813bd5ec9 146
giovannivisentini 0:674813bd5ec9 147 //ST Specific
giovannivisentini 0:674813bd5ec9 148 NFC_StatusTypeDef (*STReadBinary)(void *handle, uint16_t Offset, uint8_t NbByteToRead, uint8_t *pBufferRead);
giovannivisentini 0:674813bd5ec9 149 NFC_StatusTypeDef (*EnablePermanentState)(void *handle, uint16_t uReadOrWrite);
giovannivisentini 0:674813bd5ec9 150 NFC_StatusTypeDef (*DisablePermanentState)(void *handle, uint16_t uReadOrWrite);
giovannivisentini 0:674813bd5ec9 151
giovannivisentini 0:674813bd5ec9 152 //??
giovannivisentini 0:674813bd5ec9 153
giovannivisentini 0:674813bd5ec9 154 NFC_StatusTypeDef (*StateControl)(void *handle, uint8_t uSetOrReset);
giovannivisentini 0:674813bd5ec9 155 NFC_StatusTypeDef (*ManageI2CGPO)(void *handle, uint8_t GPO_I2Cconfig);
giovannivisentini 0:674813bd5ec9 156 NFC_StatusTypeDef (*ManageRFGPO)(void *handle, uint8_t GPO_RFconfig);
giovannivisentini 0:674813bd5ec9 157 NFC_StatusTypeDef (*RFConfig)(void *handle, uint8_t OnOffChoice);
giovannivisentini 0:674813bd5ec9 158
giovannivisentini 0:674813bd5ec9 159 } NFC_DrvVTableTypeDef;
giovannivisentini 0:674813bd5ec9 160
giovannivisentini 0:674813bd5ec9 161 /**
giovannivisentini 0:674813bd5ec9 162 * @}
giovannivisentini 0:674813bd5ec9 163 */
giovannivisentini 0:674813bd5ec9 164
giovannivisentini 0:674813bd5ec9 165 /**
giovannivisentini 0:674813bd5ec9 166 * @}
giovannivisentini 0:674813bd5ec9 167 */
giovannivisentini 0:674813bd5ec9 168
giovannivisentini 0:674813bd5ec9 169 /**
giovannivisentini 0:674813bd5ec9 170 * @}
giovannivisentini 0:674813bd5ec9 171 */
giovannivisentini 0:674813bd5ec9 172
giovannivisentini 0:674813bd5ec9 173 /**
giovannivisentini 0:674813bd5ec9 174 * @}
giovannivisentini 0:674813bd5ec9 175 */
giovannivisentini 0:674813bd5ec9 176
giovannivisentini 0:674813bd5ec9 177 #ifdef __cplusplus
giovannivisentini 0:674813bd5ec9 178 }
giovannivisentini 0:674813bd5ec9 179 #endif
giovannivisentini 0:674813bd5ec9 180
giovannivisentini 0:674813bd5ec9 181 #endif /* __NFC_H_ */
giovannivisentini 0:674813bd5ec9 182
giovannivisentini 0:674813bd5ec9 183 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
giovannivisentini 0:674813bd5ec9 184