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