PN532 NFC library for Seeed Studio's NFC Shield
Fork of PN532 by
PN532.h@1:b8cab5222fd0, 2013-10-17 (annotated)
- Committer:
- yihui
- Date:
- Thu Oct 17 06:37:26 2013 +0000
- Revision:
- 1:b8cab5222fd0
- Parent:
- 0:9c6b9280c0e1
- Child:
- 2:f618fb2169c4
format code
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
yihui | 1:b8cab5222fd0 | 1 | /**************************************************************************/ |
yihui | 1:b8cab5222fd0 | 2 | /*! |
yihui | 1:b8cab5222fd0 | 3 | @file PN532.h |
yihui | 1:b8cab5222fd0 | 4 | @author Adafruit Industries |
yihui | 1:b8cab5222fd0 | 5 | @license BSD (see license.txt) |
yihui | 1:b8cab5222fd0 | 6 | |
yihui | 1:b8cab5222fd0 | 7 | This is a library for the Adafruit PN532 NFC/RFID shield |
yihui | 1:b8cab5222fd0 | 8 | This library works with the Adafruit NFC breakout |
yihui | 1:b8cab5222fd0 | 9 | ----> https://www.adafruit.com/products/364 |
yihui | 1:b8cab5222fd0 | 10 | |
yihui | 1:b8cab5222fd0 | 11 | Check out the links above for our tutorials and wiring diagrams |
yihui | 1:b8cab5222fd0 | 12 | These chips use I2C to communicate |
yihui | 1:b8cab5222fd0 | 13 | |
yihui | 1:b8cab5222fd0 | 14 | Adafruit invests time and resources providing this open source code, |
yihui | 1:b8cab5222fd0 | 15 | please support Adafruit and open-source hardware by purchasing |
yihui | 1:b8cab5222fd0 | 16 | products from Adafruit! |
yihui | 1:b8cab5222fd0 | 17 | |
yihui | 1:b8cab5222fd0 | 18 | @section HISTORY |
yihui | 1:b8cab5222fd0 | 19 | |
yihui | 1:b8cab5222fd0 | 20 | v1.3 - Modified to work with I2C |
yihui | 1:b8cab5222fd0 | 21 | |
yihui | 1:b8cab5222fd0 | 22 | v1.1 - Added full command list |
yihui | 1:b8cab5222fd0 | 23 | - Added 'verbose' mode flag to constructor to toggle debug output |
yihui | 1:b8cab5222fd0 | 24 | - Changed readPassiveTargetID() to return variable length values |
yihui | 1:b8cab5222fd0 | 25 | |
yihui | 1:b8cab5222fd0 | 26 | */ |
yihui | 1:b8cab5222fd0 | 27 | /**************************************************************************/ |
yihui | 0:9c6b9280c0e1 | 28 | |
yihui | 0:9c6b9280c0e1 | 29 | #ifndef PN532_h |
yihui | 0:9c6b9280c0e1 | 30 | #define PN532_h |
yihui | 0:9c6b9280c0e1 | 31 | |
yihui | 0:9c6b9280c0e1 | 32 | #include <stdint.h> |
yihui | 0:9c6b9280c0e1 | 33 | #include "mbed.h" |
yihui | 0:9c6b9280c0e1 | 34 | #include "PN532Interface.h" |
yihui | 0:9c6b9280c0e1 | 35 | |
yihui | 0:9c6b9280c0e1 | 36 | #define PN532_PREAMBLE (0x00) |
yihui | 0:9c6b9280c0e1 | 37 | #define PN532_STARTCODE1 (0x00) |
yihui | 0:9c6b9280c0e1 | 38 | #define PN532_STARTCODE2 (0xFF) |
yihui | 0:9c6b9280c0e1 | 39 | #define PN532_POSTAMBLE (0x00) |
yihui | 0:9c6b9280c0e1 | 40 | |
yihui | 0:9c6b9280c0e1 | 41 | #define PN532_HOSTTOPN532 (0xD4) |
yihui | 0:9c6b9280c0e1 | 42 | #define PN532_PN532TOHOST (0xD5) |
yihui | 0:9c6b9280c0e1 | 43 | |
yihui | 0:9c6b9280c0e1 | 44 | // PN532 Commands |
yihui | 0:9c6b9280c0e1 | 45 | #define PN532_COMMAND_DIAGNOSE (0x00) |
yihui | 0:9c6b9280c0e1 | 46 | #define PN532_COMMAND_GETFIRMWAREVERSION (0x02) |
yihui | 0:9c6b9280c0e1 | 47 | #define PN532_COMMAND_GETGENERALSTATUS (0x04) |
yihui | 0:9c6b9280c0e1 | 48 | #define PN532_COMMAND_READREGISTER (0x06) |
yihui | 0:9c6b9280c0e1 | 49 | #define PN532_COMMAND_WRITEREGISTER (0x08) |
yihui | 0:9c6b9280c0e1 | 50 | #define PN532_COMMAND_READGPIO (0x0C) |
yihui | 0:9c6b9280c0e1 | 51 | #define PN532_COMMAND_WRITEGPIO (0x0E) |
yihui | 0:9c6b9280c0e1 | 52 | #define PN532_COMMAND_SETSERIALBAUDRATE (0x10) |
yihui | 0:9c6b9280c0e1 | 53 | #define PN532_COMMAND_SETPARAMETERS (0x12) |
yihui | 0:9c6b9280c0e1 | 54 | #define PN532_COMMAND_SAMCONFIGURATION (0x14) |
yihui | 0:9c6b9280c0e1 | 55 | #define PN532_COMMAND_POWERDOWN (0x16) |
yihui | 0:9c6b9280c0e1 | 56 | #define PN532_COMMAND_RFCONFIGURATION (0x32) |
yihui | 0:9c6b9280c0e1 | 57 | #define PN532_COMMAND_RFREGULATIONTEST (0x58) |
yihui | 0:9c6b9280c0e1 | 58 | #define PN532_COMMAND_INJUMPFORDEP (0x56) |
yihui | 0:9c6b9280c0e1 | 59 | #define PN532_COMMAND_INJUMPFORPSL (0x46) |
yihui | 0:9c6b9280c0e1 | 60 | #define PN532_COMMAND_INLISTPASSIVETARGET (0x4A) |
yihui | 0:9c6b9280c0e1 | 61 | #define PN532_COMMAND_INATR (0x50) |
yihui | 0:9c6b9280c0e1 | 62 | #define PN532_COMMAND_INPSL (0x4E) |
yihui | 0:9c6b9280c0e1 | 63 | #define PN532_COMMAND_INDATAEXCHANGE (0x40) |
yihui | 0:9c6b9280c0e1 | 64 | #define PN532_COMMAND_INCOMMUNICATETHRU (0x42) |
yihui | 0:9c6b9280c0e1 | 65 | #define PN532_COMMAND_INDESELECT (0x44) |
yihui | 0:9c6b9280c0e1 | 66 | #define PN532_COMMAND_INRELEASE (0x52) |
yihui | 0:9c6b9280c0e1 | 67 | #define PN532_COMMAND_INSELECT (0x54) |
yihui | 0:9c6b9280c0e1 | 68 | #define PN532_COMMAND_INAUTOPOLL (0x60) |
yihui | 0:9c6b9280c0e1 | 69 | #define PN532_COMMAND_TGINITASTARGET (0x8C) |
yihui | 0:9c6b9280c0e1 | 70 | #define PN532_COMMAND_TGSETGENERALBYTES (0x92) |
yihui | 0:9c6b9280c0e1 | 71 | #define PN532_COMMAND_TGGETDATA (0x86) |
yihui | 0:9c6b9280c0e1 | 72 | #define PN532_COMMAND_TGSETDATA (0x8E) |
yihui | 0:9c6b9280c0e1 | 73 | #define PN532_COMMAND_TGSETMETADATA (0x94) |
yihui | 0:9c6b9280c0e1 | 74 | #define PN532_COMMAND_TGGETINITIATORCOMMAND (0x88) |
yihui | 0:9c6b9280c0e1 | 75 | #define PN532_COMMAND_TGRESPONSETOINITIATOR (0x90) |
yihui | 0:9c6b9280c0e1 | 76 | #define PN532_COMMAND_TGGETTARGETSTATUS (0x8A) |
yihui | 0:9c6b9280c0e1 | 77 | |
yihui | 0:9c6b9280c0e1 | 78 | #define PN532_RESPONSE_INDATAEXCHANGE (0x41) |
yihui | 0:9c6b9280c0e1 | 79 | #define PN532_RESPONSE_INLISTPASSIVETARGET (0x4B) |
yihui | 0:9c6b9280c0e1 | 80 | |
yihui | 0:9c6b9280c0e1 | 81 | |
yihui | 0:9c6b9280c0e1 | 82 | #define PN532_WAKEUP (0x55) |
yihui | 0:9c6b9280c0e1 | 83 | |
yihui | 0:9c6b9280c0e1 | 84 | #define PN532_I2C_ADDRESS (0x48 >> 1) |
yihui | 0:9c6b9280c0e1 | 85 | #define PN532_I2C_READBIT (0x01) |
yihui | 0:9c6b9280c0e1 | 86 | #define PN532_I2C_BUSY (0x00) |
yihui | 0:9c6b9280c0e1 | 87 | #define PN532_I2C_READY (0x01) |
yihui | 0:9c6b9280c0e1 | 88 | #define PN532_I2C_READYTIMEOUT (20) |
yihui | 0:9c6b9280c0e1 | 89 | |
yihui | 0:9c6b9280c0e1 | 90 | #define PN532_MIFARE_ISO14443A (0x00) |
yihui | 0:9c6b9280c0e1 | 91 | |
yihui | 0:9c6b9280c0e1 | 92 | // Mifare Commands |
yihui | 0:9c6b9280c0e1 | 93 | #define MIFARE_CMD_AUTH_A (0x60) |
yihui | 0:9c6b9280c0e1 | 94 | #define MIFARE_CMD_AUTH_B (0x61) |
yihui | 0:9c6b9280c0e1 | 95 | #define MIFARE_CMD_READ (0x30) |
yihui | 0:9c6b9280c0e1 | 96 | #define MIFARE_CMD_WRITE (0xA0) |
yihui | 0:9c6b9280c0e1 | 97 | #define MIFARE_CMD_TRANSFER (0xB0) |
yihui | 0:9c6b9280c0e1 | 98 | #define MIFARE_CMD_DECREMENT (0xC0) |
yihui | 0:9c6b9280c0e1 | 99 | #define MIFARE_CMD_INCREMENT (0xC1) |
yihui | 0:9c6b9280c0e1 | 100 | #define MIFARE_CMD_STORE (0xC2) |
yihui | 0:9c6b9280c0e1 | 101 | |
yihui | 0:9c6b9280c0e1 | 102 | // Prefixes for NDEF Records (to identify record type) |
yihui | 0:9c6b9280c0e1 | 103 | #define NDEF_URIPREFIX_NONE (0x00) |
yihui | 0:9c6b9280c0e1 | 104 | #define NDEF_URIPREFIX_HTTP_WWWDOT (0x01) |
yihui | 0:9c6b9280c0e1 | 105 | #define NDEF_URIPREFIX_HTTPS_WWWDOT (0x02) |
yihui | 0:9c6b9280c0e1 | 106 | #define NDEF_URIPREFIX_HTTP (0x03) |
yihui | 0:9c6b9280c0e1 | 107 | #define NDEF_URIPREFIX_HTTPS (0x04) |
yihui | 0:9c6b9280c0e1 | 108 | #define NDEF_URIPREFIX_TEL (0x05) |
yihui | 0:9c6b9280c0e1 | 109 | #define NDEF_URIPREFIX_MAILTO (0x06) |
yihui | 0:9c6b9280c0e1 | 110 | #define NDEF_URIPREFIX_FTP_ANONAT (0x07) |
yihui | 0:9c6b9280c0e1 | 111 | #define NDEF_URIPREFIX_FTP_FTPDOT (0x08) |
yihui | 0:9c6b9280c0e1 | 112 | #define NDEF_URIPREFIX_FTPS (0x09) |
yihui | 0:9c6b9280c0e1 | 113 | #define NDEF_URIPREFIX_SFTP (0x0A) |
yihui | 0:9c6b9280c0e1 | 114 | #define NDEF_URIPREFIX_SMB (0x0B) |
yihui | 0:9c6b9280c0e1 | 115 | #define NDEF_URIPREFIX_NFS (0x0C) |
yihui | 0:9c6b9280c0e1 | 116 | #define NDEF_URIPREFIX_FTP (0x0D) |
yihui | 0:9c6b9280c0e1 | 117 | #define NDEF_URIPREFIX_DAV (0x0E) |
yihui | 0:9c6b9280c0e1 | 118 | #define NDEF_URIPREFIX_NEWS (0x0F) |
yihui | 0:9c6b9280c0e1 | 119 | #define NDEF_URIPREFIX_TELNET (0x10) |
yihui | 0:9c6b9280c0e1 | 120 | #define NDEF_URIPREFIX_IMAP (0x11) |
yihui | 0:9c6b9280c0e1 | 121 | #define NDEF_URIPREFIX_RTSP (0x12) |
yihui | 0:9c6b9280c0e1 | 122 | #define NDEF_URIPREFIX_URN (0x13) |
yihui | 0:9c6b9280c0e1 | 123 | #define NDEF_URIPREFIX_POP (0x14) |
yihui | 0:9c6b9280c0e1 | 124 | #define NDEF_URIPREFIX_SIP (0x15) |
yihui | 0:9c6b9280c0e1 | 125 | #define NDEF_URIPREFIX_SIPS (0x16) |
yihui | 0:9c6b9280c0e1 | 126 | #define NDEF_URIPREFIX_TFTP (0x17) |
yihui | 0:9c6b9280c0e1 | 127 | #define NDEF_URIPREFIX_BTSPP (0x18) |
yihui | 0:9c6b9280c0e1 | 128 | #define NDEF_URIPREFIX_BTL2CAP (0x19) |
yihui | 0:9c6b9280c0e1 | 129 | #define NDEF_URIPREFIX_BTGOEP (0x1A) |
yihui | 0:9c6b9280c0e1 | 130 | #define NDEF_URIPREFIX_TCPOBEX (0x1B) |
yihui | 0:9c6b9280c0e1 | 131 | #define NDEF_URIPREFIX_IRDAOBEX (0x1C) |
yihui | 0:9c6b9280c0e1 | 132 | #define NDEF_URIPREFIX_FILE (0x1D) |
yihui | 0:9c6b9280c0e1 | 133 | #define NDEF_URIPREFIX_URN_EPC_ID (0x1E) |
yihui | 0:9c6b9280c0e1 | 134 | #define NDEF_URIPREFIX_URN_EPC_TAG (0x1F) |
yihui | 0:9c6b9280c0e1 | 135 | #define NDEF_URIPREFIX_URN_EPC_PAT (0x20) |
yihui | 0:9c6b9280c0e1 | 136 | #define NDEF_URIPREFIX_URN_EPC_RAW (0x21) |
yihui | 0:9c6b9280c0e1 | 137 | #define NDEF_URIPREFIX_URN_EPC (0x22) |
yihui | 0:9c6b9280c0e1 | 138 | #define NDEF_URIPREFIX_URN_NFC (0x23) |
yihui | 0:9c6b9280c0e1 | 139 | |
yihui | 0:9c6b9280c0e1 | 140 | #define PN532_GPIO_VALIDATIONBIT (0x80) |
yihui | 0:9c6b9280c0e1 | 141 | #define PN532_GPIO_P30 (0) |
yihui | 0:9c6b9280c0e1 | 142 | #define PN532_GPIO_P31 (1) |
yihui | 0:9c6b9280c0e1 | 143 | #define PN532_GPIO_P32 (2) |
yihui | 0:9c6b9280c0e1 | 144 | #define PN532_GPIO_P33 (3) |
yihui | 0:9c6b9280c0e1 | 145 | #define PN532_GPIO_P34 (4) |
yihui | 0:9c6b9280c0e1 | 146 | #define PN532_GPIO_P35 (5) |
yihui | 0:9c6b9280c0e1 | 147 | |
yihui | 0:9c6b9280c0e1 | 148 | //#define PN532DEBUG |
yihui | 0:9c6b9280c0e1 | 149 | |
yihui | 1:b8cab5222fd0 | 150 | class PN532 |
yihui | 1:b8cab5222fd0 | 151 | { |
yihui | 0:9c6b9280c0e1 | 152 | public: |
yihui | 1:b8cab5222fd0 | 153 | PN532(PN532Interface &interface); |
yihui | 0:9c6b9280c0e1 | 154 | PN532(PinName mosi, PinName miso, PinName sclk, PinName cs); |
yihui | 0:9c6b9280c0e1 | 155 | |
yihui | 0:9c6b9280c0e1 | 156 | ~PN532(); |
yihui | 1:b8cab5222fd0 | 157 | |
yihui | 1:b8cab5222fd0 | 158 | void begin(void); |
yihui | 1:b8cab5222fd0 | 159 | |
yihui | 1:b8cab5222fd0 | 160 | // Generic PN532 functions |
yihui | 1:b8cab5222fd0 | 161 | bool SAMConfig(void); |
yihui | 1:b8cab5222fd0 | 162 | uint32_t getFirmwareVersion(void); |
yihui | 1:b8cab5222fd0 | 163 | bool writeGPIO(uint8_t pinstate); |
yihui | 1:b8cab5222fd0 | 164 | uint8_t readGPIO(void); |
yihui | 1:b8cab5222fd0 | 165 | bool setPassiveActivationRetries(uint8_t maxRetries); |
yihui | 1:b8cab5222fd0 | 166 | |
yihui | 1:b8cab5222fd0 | 167 | int8_t tgInitAsTarget(); |
yihui | 1:b8cab5222fd0 | 168 | int16_t tgGetData(uint8_t *buf, uint16_t len); |
yihui | 1:b8cab5222fd0 | 169 | bool tgSetData(const uint8_t *buf, uint16_t len); |
yihui | 1:b8cab5222fd0 | 170 | |
yihui | 1:b8cab5222fd0 | 171 | // ISO14443A functions |
yihui | 1:b8cab5222fd0 | 172 | bool inListPassiveTarget(); |
yihui | 1:b8cab5222fd0 | 173 | bool readPassiveTargetID(uint8_t cardbaudrate, uint8_t *uid, uint8_t *uidLength); |
yihui | 1:b8cab5222fd0 | 174 | bool inDataExchange(uint8_t *send, uint8_t sendLength, uint8_t *response, uint8_t *responseLength); |
yihui | 0:9c6b9280c0e1 | 175 | |
yihui | 1:b8cab5222fd0 | 176 | // Mifare Classic functions |
yihui | 1:b8cab5222fd0 | 177 | bool mifareclassic_IsFirstBlock (uint32_t uiBlock); |
yihui | 1:b8cab5222fd0 | 178 | bool mifareclassic_IsTrailerBlock (uint32_t uiBlock); |
yihui | 1:b8cab5222fd0 | 179 | uint8_t mifareclassic_AuthenticateBlock (uint8_t *uid, uint8_t uidLen, uint32_t blockNumber, uint8_t keyNumber, uint8_t *keyData); |
yihui | 1:b8cab5222fd0 | 180 | uint8_t mifareclassic_ReadDataBlock (uint8_t blockNumber, uint8_t *data); |
yihui | 1:b8cab5222fd0 | 181 | uint8_t mifareclassic_WriteDataBlock (uint8_t blockNumber, uint8_t *data); |
yihui | 1:b8cab5222fd0 | 182 | uint8_t mifareclassic_FormatNDEF (void); |
yihui | 1:b8cab5222fd0 | 183 | uint8_t mifareclassic_WriteNDEFURI (uint8_t sectorNumber, uint8_t uriIdentifier, const char *url); |
yihui | 1:b8cab5222fd0 | 184 | |
yihui | 1:b8cab5222fd0 | 185 | // Mifare Ultralight functions |
yihui | 1:b8cab5222fd0 | 186 | uint8_t mifareultralight_ReadPage (uint8_t page, uint8_t *buffer); |
yihui | 1:b8cab5222fd0 | 187 | |
yihui | 1:b8cab5222fd0 | 188 | // Help functions to display formatted text |
yihui | 1:b8cab5222fd0 | 189 | static void PrintHex(const uint8_t *data, const uint32_t numBytes); |
yihui | 1:b8cab5222fd0 | 190 | static void PrintHexChar(const uint8_t *pbtData, const uint32_t numBytes); |
yihui | 1:b8cab5222fd0 | 191 | |
yihui | 1:b8cab5222fd0 | 192 | private: |
yihui | 1:b8cab5222fd0 | 193 | uint8_t _uid[7]; // ISO14443A uid |
yihui | 1:b8cab5222fd0 | 194 | uint8_t _uidLen; // uid len |
yihui | 1:b8cab5222fd0 | 195 | uint8_t _key[6]; // Mifare Classic key |
yihui | 1:b8cab5222fd0 | 196 | uint8_t inListedTag; // Tg number of inlisted tag. |
yihui | 1:b8cab5222fd0 | 197 | |
yihui | 1:b8cab5222fd0 | 198 | PN532Interface *_interface; |
yihui | 1:b8cab5222fd0 | 199 | SPI *_spi; |
yihui | 0:9c6b9280c0e1 | 200 | }; |
yihui | 0:9c6b9280c0e1 | 201 | |
yihui | 0:9c6b9280c0e1 | 202 | #endif |