PN532 Driver library This library provides an abstract API to drive the pn532 nfc chip, with I2C/HSU/SPI interface. Its based on the Seeed Studio's Arduino version.
PN532/PN532.h@0:db8030e71f55, 2016-09-13 (annotated)
- Committer:
- dotnfc
- Date:
- Tue Sep 13 06:01:19 2016 +0000
- Revision:
- 0:db8030e71f55
first commit
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
dotnfc | 0:db8030e71f55 | 1 | /**************************************************************************/ |
dotnfc | 0:db8030e71f55 | 2 | /*! |
dotnfc | 0:db8030e71f55 | 3 | @file PN532.h |
dotnfc | 0:db8030e71f55 | 4 | @author Adafruit Industries & Seeed Studio |
dotnfc | 0:db8030e71f55 | 5 | @license BSD |
dotnfc | 0:db8030e71f55 | 6 | */ |
dotnfc | 0:db8030e71f55 | 7 | /**************************************************************************/ |
dotnfc | 0:db8030e71f55 | 8 | |
dotnfc | 0:db8030e71f55 | 9 | #ifndef __PN532_H__ |
dotnfc | 0:db8030e71f55 | 10 | #define __PN532_H__ |
dotnfc | 0:db8030e71f55 | 11 | |
dotnfc | 0:db8030e71f55 | 12 | #include <stdint.h> |
dotnfc | 0:db8030e71f55 | 13 | #include "PN532Interface.h" |
dotnfc | 0:db8030e71f55 | 14 | |
dotnfc | 0:db8030e71f55 | 15 | // PN532 Commands |
dotnfc | 0:db8030e71f55 | 16 | #define PN532_COMMAND_DIAGNOSE (0x00) |
dotnfc | 0:db8030e71f55 | 17 | #define PN532_COMMAND_GETFIRMWAREVERSION (0x02) |
dotnfc | 0:db8030e71f55 | 18 | #define PN532_COMMAND_GETGENERALSTATUS (0x04) |
dotnfc | 0:db8030e71f55 | 19 | #define PN532_COMMAND_READREGISTER (0x06) |
dotnfc | 0:db8030e71f55 | 20 | #define PN532_COMMAND_WRITEREGISTER (0x08) |
dotnfc | 0:db8030e71f55 | 21 | #define PN532_COMMAND_READGPIO (0x0C) |
dotnfc | 0:db8030e71f55 | 22 | #define PN532_COMMAND_WRITEGPIO (0x0E) |
dotnfc | 0:db8030e71f55 | 23 | #define PN532_COMMAND_SETSERIALBAUDRATE (0x10) |
dotnfc | 0:db8030e71f55 | 24 | #define PN532_COMMAND_SETPARAMETERS (0x12) |
dotnfc | 0:db8030e71f55 | 25 | #define PN532_COMMAND_SAMCONFIGURATION (0x14) |
dotnfc | 0:db8030e71f55 | 26 | #define PN532_COMMAND_POWERDOWN (0x16) |
dotnfc | 0:db8030e71f55 | 27 | #define PN532_COMMAND_RFCONFIGURATION (0x32) |
dotnfc | 0:db8030e71f55 | 28 | #define PN532_COMMAND_RFREGULATIONTEST (0x58) |
dotnfc | 0:db8030e71f55 | 29 | #define PN532_COMMAND_INJUMPFORDEP (0x56) |
dotnfc | 0:db8030e71f55 | 30 | #define PN532_COMMAND_INJUMPFORPSL (0x46) |
dotnfc | 0:db8030e71f55 | 31 | #define PN532_COMMAND_INLISTPASSIVETARGET (0x4A) |
dotnfc | 0:db8030e71f55 | 32 | #define PN532_COMMAND_INATR (0x50) |
dotnfc | 0:db8030e71f55 | 33 | #define PN532_COMMAND_INPSL (0x4E) |
dotnfc | 0:db8030e71f55 | 34 | #define PN532_COMMAND_INDATAEXCHANGE (0x40) |
dotnfc | 0:db8030e71f55 | 35 | #define PN532_COMMAND_INCOMMUNICATETHRU (0x42) |
dotnfc | 0:db8030e71f55 | 36 | #define PN532_COMMAND_INDESELECT (0x44) |
dotnfc | 0:db8030e71f55 | 37 | #define PN532_COMMAND_INRELEASE (0x52) |
dotnfc | 0:db8030e71f55 | 38 | #define PN532_COMMAND_INSELECT (0x54) |
dotnfc | 0:db8030e71f55 | 39 | #define PN532_COMMAND_INAUTOPOLL (0x60) |
dotnfc | 0:db8030e71f55 | 40 | #define PN532_COMMAND_TGINITASTARGET (0x8C) |
dotnfc | 0:db8030e71f55 | 41 | #define PN532_COMMAND_TGSETGENERALBYTES (0x92) |
dotnfc | 0:db8030e71f55 | 42 | #define PN532_COMMAND_TGGETDATA (0x86) |
dotnfc | 0:db8030e71f55 | 43 | #define PN532_COMMAND_TGSETDATA (0x8E) |
dotnfc | 0:db8030e71f55 | 44 | #define PN532_COMMAND_TGSETMETADATA (0x94) |
dotnfc | 0:db8030e71f55 | 45 | #define PN532_COMMAND_TGGETINITIATORCOMMAND (0x88) |
dotnfc | 0:db8030e71f55 | 46 | #define PN532_COMMAND_TGRESPONSETOINITIATOR (0x90) |
dotnfc | 0:db8030e71f55 | 47 | #define PN532_COMMAND_TGGETTARGETSTATUS (0x8A) |
dotnfc | 0:db8030e71f55 | 48 | |
dotnfc | 0:db8030e71f55 | 49 | #define PN532_RESPONSE_INDATAEXCHANGE (0x41) |
dotnfc | 0:db8030e71f55 | 50 | #define PN532_RESPONSE_INLISTPASSIVETARGET (0x4B) |
dotnfc | 0:db8030e71f55 | 51 | |
dotnfc | 0:db8030e71f55 | 52 | |
dotnfc | 0:db8030e71f55 | 53 | #define PN532_MIFARE_ISO14443A (0x00) |
dotnfc | 0:db8030e71f55 | 54 | |
dotnfc | 0:db8030e71f55 | 55 | // Mifare Commands |
dotnfc | 0:db8030e71f55 | 56 | #define MIFARE_CMD_AUTH_A (0x60) |
dotnfc | 0:db8030e71f55 | 57 | #define MIFARE_CMD_AUTH_B (0x61) |
dotnfc | 0:db8030e71f55 | 58 | #define MIFARE_CMD_READ (0x30) |
dotnfc | 0:db8030e71f55 | 59 | #define MIFARE_CMD_WRITE (0xA0) |
dotnfc | 0:db8030e71f55 | 60 | #define MIFARE_CMD_WRITE_ULTRALIGHT (0xA2) |
dotnfc | 0:db8030e71f55 | 61 | #define MIFARE_CMD_TRANSFER (0xB0) |
dotnfc | 0:db8030e71f55 | 62 | #define MIFARE_CMD_DECREMENT (0xC0) |
dotnfc | 0:db8030e71f55 | 63 | #define MIFARE_CMD_INCREMENT (0xC1) |
dotnfc | 0:db8030e71f55 | 64 | #define MIFARE_CMD_STORE (0xC2) |
dotnfc | 0:db8030e71f55 | 65 | |
dotnfc | 0:db8030e71f55 | 66 | // Prefixes for NDEF Records (to identify record type) |
dotnfc | 0:db8030e71f55 | 67 | #define NDEF_URIPREFIX_NONE (0x00) |
dotnfc | 0:db8030e71f55 | 68 | #define NDEF_URIPREFIX_HTTP_WWWDOT (0x01) |
dotnfc | 0:db8030e71f55 | 69 | #define NDEF_URIPREFIX_HTTPS_WWWDOT (0x02) |
dotnfc | 0:db8030e71f55 | 70 | #define NDEF_URIPREFIX_HTTP (0x03) |
dotnfc | 0:db8030e71f55 | 71 | #define NDEF_URIPREFIX_HTTPS (0x04) |
dotnfc | 0:db8030e71f55 | 72 | #define NDEF_URIPREFIX_TEL (0x05) |
dotnfc | 0:db8030e71f55 | 73 | #define NDEF_URIPREFIX_MAILTO (0x06) |
dotnfc | 0:db8030e71f55 | 74 | #define NDEF_URIPREFIX_FTP_ANONAT (0x07) |
dotnfc | 0:db8030e71f55 | 75 | #define NDEF_URIPREFIX_FTP_FTPDOT (0x08) |
dotnfc | 0:db8030e71f55 | 76 | #define NDEF_URIPREFIX_FTPS (0x09) |
dotnfc | 0:db8030e71f55 | 77 | #define NDEF_URIPREFIX_SFTP (0x0A) |
dotnfc | 0:db8030e71f55 | 78 | #define NDEF_URIPREFIX_SMB (0x0B) |
dotnfc | 0:db8030e71f55 | 79 | #define NDEF_URIPREFIX_NFS (0x0C) |
dotnfc | 0:db8030e71f55 | 80 | #define NDEF_URIPREFIX_FTP (0x0D) |
dotnfc | 0:db8030e71f55 | 81 | #define NDEF_URIPREFIX_DAV (0x0E) |
dotnfc | 0:db8030e71f55 | 82 | #define NDEF_URIPREFIX_NEWS (0x0F) |
dotnfc | 0:db8030e71f55 | 83 | #define NDEF_URIPREFIX_TELNET (0x10) |
dotnfc | 0:db8030e71f55 | 84 | #define NDEF_URIPREFIX_IMAP (0x11) |
dotnfc | 0:db8030e71f55 | 85 | #define NDEF_URIPREFIX_RTSP (0x12) |
dotnfc | 0:db8030e71f55 | 86 | #define NDEF_URIPREFIX_URN (0x13) |
dotnfc | 0:db8030e71f55 | 87 | #define NDEF_URIPREFIX_POP (0x14) |
dotnfc | 0:db8030e71f55 | 88 | #define NDEF_URIPREFIX_SIP (0x15) |
dotnfc | 0:db8030e71f55 | 89 | #define NDEF_URIPREFIX_SIPS (0x16) |
dotnfc | 0:db8030e71f55 | 90 | #define NDEF_URIPREFIX_TFTP (0x17) |
dotnfc | 0:db8030e71f55 | 91 | #define NDEF_URIPREFIX_BTSPP (0x18) |
dotnfc | 0:db8030e71f55 | 92 | #define NDEF_URIPREFIX_BTL2CAP (0x19) |
dotnfc | 0:db8030e71f55 | 93 | #define NDEF_URIPREFIX_BTGOEP (0x1A) |
dotnfc | 0:db8030e71f55 | 94 | #define NDEF_URIPREFIX_TCPOBEX (0x1B) |
dotnfc | 0:db8030e71f55 | 95 | #define NDEF_URIPREFIX_IRDAOBEX (0x1C) |
dotnfc | 0:db8030e71f55 | 96 | #define NDEF_URIPREFIX_FILE (0x1D) |
dotnfc | 0:db8030e71f55 | 97 | #define NDEF_URIPREFIX_URN_EPC_ID (0x1E) |
dotnfc | 0:db8030e71f55 | 98 | #define NDEF_URIPREFIX_URN_EPC_TAG (0x1F) |
dotnfc | 0:db8030e71f55 | 99 | #define NDEF_URIPREFIX_URN_EPC_PAT (0x20) |
dotnfc | 0:db8030e71f55 | 100 | #define NDEF_URIPREFIX_URN_EPC_RAW (0x21) |
dotnfc | 0:db8030e71f55 | 101 | #define NDEF_URIPREFIX_URN_EPC (0x22) |
dotnfc | 0:db8030e71f55 | 102 | #define NDEF_URIPREFIX_URN_NFC (0x23) |
dotnfc | 0:db8030e71f55 | 103 | |
dotnfc | 0:db8030e71f55 | 104 | #define PN532_GPIO_VALIDATIONBIT (0x80) |
dotnfc | 0:db8030e71f55 | 105 | #define PN532_GPIO_P30 (0) |
dotnfc | 0:db8030e71f55 | 106 | #define PN532_GPIO_P31 (1) |
dotnfc | 0:db8030e71f55 | 107 | #define PN532_GPIO_P32 (2) |
dotnfc | 0:db8030e71f55 | 108 | #define PN532_GPIO_P33 (3) |
dotnfc | 0:db8030e71f55 | 109 | #define PN532_GPIO_P34 (4) |
dotnfc | 0:db8030e71f55 | 110 | #define PN532_GPIO_P35 (5) |
dotnfc | 0:db8030e71f55 | 111 | |
dotnfc | 0:db8030e71f55 | 112 | class PN532 |
dotnfc | 0:db8030e71f55 | 113 | { |
dotnfc | 0:db8030e71f55 | 114 | public: |
dotnfc | 0:db8030e71f55 | 115 | PN532(PN532Interface &interface); |
dotnfc | 0:db8030e71f55 | 116 | |
dotnfc | 0:db8030e71f55 | 117 | void begin(void); |
dotnfc | 0:db8030e71f55 | 118 | |
dotnfc | 0:db8030e71f55 | 119 | // Generic PN532 functions |
dotnfc | 0:db8030e71f55 | 120 | bool SAMConfig(void); |
dotnfc | 0:db8030e71f55 | 121 | uint32_t getFirmwareVersion(void); |
dotnfc | 0:db8030e71f55 | 122 | bool writeGPIO(uint8_t pinstate); |
dotnfc | 0:db8030e71f55 | 123 | uint8_t readGPIO(void); |
dotnfc | 0:db8030e71f55 | 124 | bool setPassiveActivationRetries(uint8_t maxRetries); |
dotnfc | 0:db8030e71f55 | 125 | |
dotnfc | 0:db8030e71f55 | 126 | /** |
dotnfc | 0:db8030e71f55 | 127 | * @brief Init PN532 as a target |
dotnfc | 0:db8030e71f55 | 128 | * @param timeout max time to wait, 0 means no timeout |
dotnfc | 0:db8030e71f55 | 129 | * @return > 0 success |
dotnfc | 0:db8030e71f55 | 130 | * = 0 timeout |
dotnfc | 0:db8030e71f55 | 131 | * < 0 failed |
dotnfc | 0:db8030e71f55 | 132 | */ |
dotnfc | 0:db8030e71f55 | 133 | int8_t tgInitAsTarget(uint16_t timeout = 0); |
dotnfc | 0:db8030e71f55 | 134 | int8_t tgInitAsTarget(const uint8_t* command, const uint8_t len, const uint16_t timeout = 0); |
dotnfc | 0:db8030e71f55 | 135 | |
dotnfc | 0:db8030e71f55 | 136 | int16_t tgGetData(uint8_t *buf, uint8_t len); |
dotnfc | 0:db8030e71f55 | 137 | bool tgSetData(const uint8_t *header, uint8_t hlen, const uint8_t *body = 0, uint8_t blen = 0); |
dotnfc | 0:db8030e71f55 | 138 | |
dotnfc | 0:db8030e71f55 | 139 | int16_t inRelease(const uint8_t relevantTarget = 0); |
dotnfc | 0:db8030e71f55 | 140 | |
dotnfc | 0:db8030e71f55 | 141 | // ISO14443A functions |
dotnfc | 0:db8030e71f55 | 142 | bool inListPassiveTarget(); |
dotnfc | 0:db8030e71f55 | 143 | bool readPassiveTargetID(uint8_t cardbaudrate, uint8_t *uid, uint8_t *uidLength, uint16_t timeout = 1000, bool inlist = false); |
dotnfc | 0:db8030e71f55 | 144 | bool inDataExchange(uint8_t *send, uint8_t sendLength, uint8_t *response, uint8_t *responseLength); |
dotnfc | 0:db8030e71f55 | 145 | |
dotnfc | 0:db8030e71f55 | 146 | // Mifare Classic functions |
dotnfc | 0:db8030e71f55 | 147 | bool mifareclassic_IsFirstBlock (uint32_t uiBlock); |
dotnfc | 0:db8030e71f55 | 148 | bool mifareclassic_IsTrailerBlock (uint32_t uiBlock); |
dotnfc | 0:db8030e71f55 | 149 | uint8_t mifareclassic_AuthenticateBlock (uint8_t *uid, uint8_t uidLen, uint32_t blockNumber, uint8_t keyNumber, uint8_t *keyData); |
dotnfc | 0:db8030e71f55 | 150 | uint8_t mifareclassic_ReadDataBlock (uint8_t blockNumber, uint8_t *data); |
dotnfc | 0:db8030e71f55 | 151 | uint8_t mifareclassic_WriteDataBlock (uint8_t blockNumber, uint8_t *data); |
dotnfc | 0:db8030e71f55 | 152 | uint8_t mifareclassic_FormatNDEF (void); |
dotnfc | 0:db8030e71f55 | 153 | uint8_t mifareclassic_WriteNDEFURI (uint8_t sectorNumber, uint8_t uriIdentifier, const char *url); |
dotnfc | 0:db8030e71f55 | 154 | |
dotnfc | 0:db8030e71f55 | 155 | // Mifare Ultralight functions |
dotnfc | 0:db8030e71f55 | 156 | uint8_t mifareultralight_ReadPage (uint8_t page, uint8_t *buffer); |
dotnfc | 0:db8030e71f55 | 157 | uint8_t mifareultralight_WritePage (uint8_t page, uint8_t *buffer); |
dotnfc | 0:db8030e71f55 | 158 | |
dotnfc | 0:db8030e71f55 | 159 | // Help functions to display formatted text |
dotnfc | 0:db8030e71f55 | 160 | static void PrintHex(const uint8_t *data, const uint32_t numBytes); |
dotnfc | 0:db8030e71f55 | 161 | static void PrintHexChar(const uint8_t *pbtData, const uint32_t numBytes); |
dotnfc | 0:db8030e71f55 | 162 | |
dotnfc | 0:db8030e71f55 | 163 | uint8_t *getBuffer(uint8_t *len) { |
dotnfc | 0:db8030e71f55 | 164 | *len = sizeof(pn532_packetbuffer) - 4; |
dotnfc | 0:db8030e71f55 | 165 | return pn532_packetbuffer; |
dotnfc | 0:db8030e71f55 | 166 | }; |
dotnfc | 0:db8030e71f55 | 167 | |
dotnfc | 0:db8030e71f55 | 168 | private: |
dotnfc | 0:db8030e71f55 | 169 | uint8_t _uid[7]; // ISO14443A uid |
dotnfc | 0:db8030e71f55 | 170 | uint8_t _uidLen; // uid len |
dotnfc | 0:db8030e71f55 | 171 | uint8_t _key[6]; // Mifare Classic key |
dotnfc | 0:db8030e71f55 | 172 | uint8_t inListedTag; // Tg number of inlisted tag. |
dotnfc | 0:db8030e71f55 | 173 | |
dotnfc | 0:db8030e71f55 | 174 | uint8_t pn532_packetbuffer[64]; |
dotnfc | 0:db8030e71f55 | 175 | |
dotnfc | 0:db8030e71f55 | 176 | PN532Interface *_interface; |
dotnfc | 0:db8030e71f55 | 177 | }; |
dotnfc | 0:db8030e71f55 | 178 | |
dotnfc | 0:db8030e71f55 | 179 | #endif |