1 /* 2 * Copyright (C) 2015 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 /* 18 * NFC Ndef Mapping For Remote Devices. 19 */ 20 21 #ifndef PHFRINFC_MIFARESTDMAP_H 22 #define PHFRINFC_MIFARESTDMAP_H 23 24 #include <phFriNfc.h> 25 #include <phNfcStatus.h> 26 #include <phNfcTypes.h> 27 #include <phFriNfc_NdefMap.h> 28 29 /* NFC Device Major and Minor Version numbers */ 30 /* !!CAUTION!! these needs to be updated periodically.Major and Minor version numbers 31 should be compatible to the version number of currently implemented mapping document. 32 Example : NFC Device version Number : 1.0 , specifies 33 Major VNo is 1, 34 Minor VNo is 0 */ 35 #define PH_NFCFRI_NDEFMAP_NFCDEV_MAJOR_VER_NUM 0x01 36 #define PH_NFCFRI_NDEFMAP_NFCDEV_MINOR_VER_NUM 0x00 37 #define PH_NFCFRI_MFSTDMAP_NFCDEV_MAJOR_VER_NUM 0x40 38 #define PH_NFCFRI_MFSTDMAP_NFCDEV_MINOR_VER_NUM 0x00 39 40 /* Macros to find major and minor TAG : Ex:Type1/Type2/Type3/Type4 version numbers */ 41 #define PH_NFCFRI_MFSTDMAP_GET_MAJOR_TAG_VERNO(a) ((a) & (0x40)) /* must be 0xC0 */ 42 #define PH_NFCFRI_MFSTDMAP_GET_MINOR_TAG_VERNO(a) ((a) & (0x30)) 43 44 /* Macros to find major and minor TAG : Ex:Type1/Type2/Type3/Type4 version numbers */ 45 #define PH_NFCFRI_NDEFMAP_GET_MAJOR_TAG_VERNO(a) (((a) & (0xf0))>>(4)) 46 #define PH_NFCFRI_NDEFMAP_GET_MINOR_TAG_VERNO(a) ((a) & (0x0f)) 47 48 /* NDEF Mapping - states of the Finite State machine */ 49 #define PH_FRINFC_NDEFMAP_STATE_INIT 0 /* Init state. The start-up state */ 50 #define PH_FRINFC_NDEFMAP_STATE_READ 1 /* Read State */ 51 #define PH_FRINFC_NDEFMAP_STATE_WRITE 2 /* Write is going on*/ 52 #define PH_FRINFC_NDEFMAP_STATE_AUTH 3 /* Authenticate is going on*/ 53 #define PH_FRINFC_NDEFMAP_STATE_CHK_NDEF_COMP 4 /* Check Ndef is going on */ 54 #define PH_FRINFC_NDEFMAP_STATE_RD_ACS_BIT 5 /* Read access bit is in progress */ 55 #define PH_FRINFC_NDEFMAP_STATE_WR_NDEF_LEN 6 /* Write NDEF TLV LEngth*/ 56 #define PH_FRINFC_NDEFMAP_STATE_RD_TO_WR_NDEF_LEN 7 /* read to write the Ndef TLV*/ 57 #define PH_FRINFC_NDEFMAP_STATE_GET_ACT_CARDSIZE 8 /* Get the card size */ 58 #define PH_FRINFC_NDEFMAP_STATE_RD_BEF_WR 9 /* Read the NDEF TLV block before starting write */ 59 #define PH_FRINFC_NDEFMAP_STATE_WR_TLV 10 /* Read the NDEF TLV block before starting write */ 60 #define PH_FRINFC_NDEFMAP_STATE_RD_TLV 11 /* Read the NDEF TLV block */ 61 #define PH_FRINFC_NDEFMAP_STATE_TERM_TLV 12 /* Write terminator TLV block */ 62 #define PH_FRINFC_NDEFMAP_STATE_POLL 13 /* Poll in progress */ 63 #define PH_FRINFC_NDEFMAP_STATE_DISCONNECT 14 /* Disconnect in progress */ 64 #define PH_FRINFC_NDEFMAP_STATE_CONNECT 15 /* Connect in progress */ 65 66 #define PH_FRINFC_NDEFMAP_STATE_RD_SEC_ACS_BIT 16 /* Convert to ReadOnly in progress */ 67 #define PH_FRINFC_NDEFMAP_STATE_WRITE_SEC 17 /* Convert to ReadOnly in progress */ 68 69 70 /* Mifare Standard - NDEF Compliant Flags */ 71 #define PH_FRINFC_MIFARESTD_NDEF_COMP 0 /* Sector is NDEF Compliant */ 72 #define PH_FRINFC_MIFARESTD_NON_NDEF_COMP 1 /* Sector is not NDEF Compliant */ 73 74 /* Mifare Standard - NDEF Compliant Flag */ 75 #define PH_FRINFC_MIFARESTD_PROP_1ST_CONFIG 0 /* No proprietary forum sector found */ 76 #define PH_FRINFC_MIFARESTD_PROP_2ND_CONFIG 1 /* Here the proprietary 77 forum sector exists after NFC forum 78 sector */ 79 #define PH_FRINFC_MIFARESTD_PROP_3RD_CONFIG 2 /* Here the proprietary forum sector exists before 80 NFC forum sector */ 81 82 /* Mifare Standard - NDEF Compliant Flags */ 83 #define PH_FRINFC_MIFARESTD_MADSECT_ACS_BYTE6 0x78 /* Access Bit for Byte 6 in 84 MAD sector trailer */ 85 #define PH_FRINFC_MIFARESTD_MADSECT_ACS_BYTE7 0x77 /* Access Bit for Byte 7 in 86 MAD sector trailer */ 87 #define PH_FRINFC_MIFARESTD_NFCSECT_ACS_BYTE6 0x7F /* Access Bit for Byte 6 in 88 NFC forum sector trailer */ 89 #define PH_FRINFC_MIFARESTD_NFCSECT_ACS_BYTE7 0x07 /* Access Bit for Byte 7 in 90 NFC forum sector trailer */ 91 #define PH_FRINFC_MIFARESTD_ACS_BYTE8 0x88 /* Access Bit for Byte 8 in 92 all sector trailer */ 93 #define PH_FRINFC_MIFARESTD_NFCSECT_RDACS_BYTE6 0x0F /* Access Bit for Byte 6 in 94 NFC forum sector trailer for 95 Read Only State */ 96 #define PH_FRINFC_MIFARESTD_NFCSECT_RDACS_BYTE7 0x07 /* Access Bit for Byte 7 in 97 NFC forum sector trailer 98 Read Only State */ 99 #define PH_FRINFC_MIFARESTD_NFCSECT_RDACS_BYTE8 0x8F /* Access Bit for Byte 8 in 100 NFC forum sector trailer 101 Read Only State */ 102 /* Mifare Standard constants */ 103 #define MIFARE_MAX_SEND_BUF_TO_READ 1 /* Send Length for Reading a Block */ 104 #define MIFARE_MAX_SEND_BUF_TO_WRITE 17 /* Send Length for writing a Block */ 105 #define MIFARE_AUTHENTICATE_CMD_LENGTH 7 /* Send Length for authenticating a Block */ 106 107 /* Mifare standard - Constants */ 108 #define PH_FRINFC_MIFARESTD_MAD_BLK0 0 /* Block number 0 */ 109 #define PH_FRINFC_MIFARESTD_MAD_BLK1 1 /* Block number 1 */ 110 #define PH_FRINFC_MIFARESTD_MAD_BLK2 2 /* Block number 2 */ 111 #define PH_FRINFC_MIFARESTD_MAD_BLK3 3 /* Block number 3 */ 112 #define PH_FRINFC_MIFARESTD_BLK4 4 /* Block number 4 */ 113 #define PH_FRINFC_MIFARESTD_BLK5 5 /* Block number 5 */ 114 #define PH_FRINFC_MIFARESTD_BLK6 6 /* Block number 6 */ 115 #define PH_FRINFC_MIFARESTD_BLK7 7 /* Block number 7 */ 116 #define PH_FRINFC_MIFARESTD_BLK8 8 /* Block number 8 */ 117 #define PH_FRINFC_MIFARESTD_BLK9 9 /* Block number 9 */ 118 #define PH_FRINFC_MIFARESTD_BLK10 10 /* Block number 10 */ 119 #define PH_FRINFC_MIFARESTD_BLK11 11 /* Block number 11 */ 120 #define PH_FRINFC_MIFARESTD_BLK12 12 /* Block number 12 */ 121 #define PH_FRINFC_MIFARESTD_BLK13 13 /* Block number 13 */ 122 #define PH_FRINFC_MIFARESTD_BLK14 14 /* Block number 14 */ 123 #define PH_FRINFC_MIFARESTD_BLK15 15 /* Block number 15 */ 124 #define PH_FRINFC_MIFARESTD_MAD_BLK16 16 /* Block number 16 */ 125 #define PH_FRINFC_MIFARESTD_MAD_BLK63 63 /* Block number 63 */ 126 #define PH_FRINFC_MIFARESTD_MAD_BLK64 64 /* Block number 64 */ 127 #define PH_FRINFC_MIFARESTD_MAD_BLK65 65 /* Block number 65 */ 128 #define PH_FRINFC_MIFARESTD_MAD_BLK66 66 /* Block number 66 */ 129 #define PH_FRINFC_MIFARESTD_MAD_BLK67 67 /* Block number 67 */ 130 #define PH_FRINFC_MIFARESTD4K_BLK128 128 /* Block number 128 for Mifare 4k */ 131 #define PH_FRINFC_MIFARESTD_SECTOR_NO0 0 /* Sector 0 */ 132 #define PH_FRINFC_MIFARESTD_SECTOR_NO1 1 /* Sector 1 */ 133 #define PH_FRINFC_MIFARESTD_SECTOR_NO16 16 /* Sector 16 */ 134 #define PH_FRINFC_MIFARESTD_SECTOR_NO31 31 /* Sector 31 */ 135 #define PH_FRINFC_MIFARESTD_SECTOR_NO39 39 /* Sector 39 */ 136 #define PH_FRINFC_MIFARESTD_SECTOR_NO32 32 /* Sector 32 */ 137 #define PH_FRINFC_MIFARESTD4K_TOTAL_SECTOR 40 /* Sector 40 */ 138 #define PH_FRINFC_MIFARESTD1K_TOTAL_SECTOR 16 /* Sector 16 */ 139 #define PH_FRINFC_MIFARESTD2K_TOTAL_SECTOR 32 /* Sector 32 */ 140 #define PH_FRINFC_MIFARESTD_BYTES_READ 16 /* Bytes read */ 141 #define PH_FRINFC_MIFARESTD_BLOCK_BYTES 16 /* Bytes per block */ 142 #define PH_FRINFC_MIFARESTD_SECTOR_BLOCKS 16 /* Blocks per sector */ 143 #define PH_FRINFC_MIFARESTD_WR_A_BLK 17 /* 17 bytes (including current block) 144 are given to transfer */ 145 #define PH_FRINFC_MIFARESTD4K_MAX_BLOCKS 210 /* Maximum number of Mifare 4k Blocks 146 excluding sector trailer */ 147 #define PH_FRINFC_MIFARESTD1K_MAX_BLK 63 /* Maximum number of Mifare 1k blocks 148 including the sector trailer*/ 149 #define PH_FRINFC_MIFARESTD2K_MAX_BLK 127 /* Maximum number of Mifare 2k blocks 150 including the sector trailer*/ 151 #define PH_FRINFC_MIFARESTD4K_MAX_BLK 254 /* Maximum number of Mifare 4k blocks 152 including the sector trailer*/ 153 #define PH_FRINFC_MIFARESTD_FLAG1 1 /* Flag to set 1 */ 154 #define PH_FRINFC_MIFARESTD_FLAG0 0 /* Flag to set 0 */ 155 #define PH_FRINFC_MIFARESTD_INC_1 1 /* increment by 1 */ 156 #define PH_FRINFC_MIFARESTD_INC_2 2 /* increment by 2 */ 157 #define PH_FRINFC_MIFARESTD_INC_3 3 /* increment by 3 */ 158 #define PH_FRINFC_MIFARESTD_INC_4 4 /* increment by 4 */ 159 #define PH_FRINFC_MIFARESTD_VAL0 0 /* Value initialised to 0 */ 160 #define PH_FRINFC_MIFARESTD_VAL1 1 /* Value initialised to 1 */ 161 #define PH_FRINFC_MIFARESTD_VAL2 2 /* Value initialised to 2 */ 162 #define PH_FRINFC_MIFARESTD_VAL3 3 /* Value initialised to 3 */ 163 #define PH_FRINFC_MIFARESTD_VAL4 4 /* Value initialised to 4 */ 164 #define PH_FRINFC_MIFARESTD_VAL5 5 /* Value initialised to 5 */ 165 #define PH_FRINFC_MIFARESTD_VAL6 6 /* Value initialised to 6 */ 166 #define PH_FRINFC_MIFARESTD_VAL7 7 /* Value initialised to 7 */ 167 #define PH_FRINFC_MIFARESTD_VAL8 8 /* Value initialised to 8 */ 168 #define PH_FRINFC_MIFARESTD_VAL9 9 /* Value initialised to 9 */ 169 #define PH_FRINFC_MIFARESTD_VAL10 10 /* Value initialised to 10 */ 170 #define PH_FRINFC_MIFARESTD_VAL11 11 /* Value initialised to 11 */ 171 #define PH_FRINFC_MIFARESTD_VAL12 12 /* Value initialised to 12 */ 172 #define PH_FRINFC_MIFARESTD_VAL13 13 /* Value initialised to 13 */ 173 #define PH_FRINFC_MIFARESTD_VAL14 14 /* Value initialised to 14 */ 174 #define PH_FRINFC_MIFARESTD_VAL15 15 /* Value initialised to 15 */ 175 #define PH_FRINFC_MIFARESTD_VAL16 16 /* Value initialised to 16 */ 176 #define PH_FRINFC_MIFARESTD_VAL31 31 /* Value initialised to 31 */ 177 #define PH_FRINFC_MIFARESTD_VAL32 32 /* Value initialised to 32 */ 178 #define PH_FRINFC_MIFARESTD_NDEFTLV_L 0xFF /* Length of the TLV */ 179 #define PH_FRINFC_MIFARESTD_NDEFTLV_T 0x03 /* Length of the TLV */ 180 #define PH_FRINFC_MIFARESTD_NDEFTLV_L0 0x00 /* Length of the TLV */ 181 #define PH_FRINFC_MIFARESTD_NDEFTLV_LBYTES0 0 /* Number of bytes taken by length (L) of the TLV */ 182 #define PH_FRINFC_MIFARESTD_NDEFTLV_LBYTES1 1 /* Number of bytes taken by length (L) of the TLV */ 183 #define PH_FRINFC_MIFARESTD_NDEFTLV_LBYTES2 2 /* Number of bytes taken by length (L) of the TLV */ 184 #define PH_FRINFC_MIFARESTD_NDEFTLV_LBYTES3 3 /* Number of bytes taken by length (L) of the TLV */ 185 #define PH_FRINFC_MIFARESTD_PROPTLV_T 0xFD /* Type of Proprietary TLV */ 186 #define PH_FRINFC_MIFARESTD_TERMTLV_T 0xFE /* Type of Terminator TLV */ 187 #define PH_FRINFC_MIFARESTD_NULLTLV_T 0x00 /* Type of NULL TLV */ 188 #define PH_FRINFC_MIFARESTD_LEFTSHIFT8 8 /* Left shift by 8 */ 189 #define PH_FRINFC_MIFARESTD_RIGHTSHIFT8 8 /* Right shift by 8 */ 190 #define PH_FRINFC_MIFARESTD_MASK_FF 0xFF /* Mask 0xFF */ 191 #define PH_FRINFC_MIFARESTD_MASK_GPB_WR 0x03 /* Mask 0x03 for GPB byte */ 192 #define PH_FRINFC_MIFARESTD_MASK_GPB_RD 0x0C /* Mask 0xOC for GPB byte */ 193 #define PH_FRINFC_MIFARESTD_GPB_RD_WR_VAL 0x00 /* GPB Read Write value */ 194 #define PH_FRINFC_MIFARESTD_KEY_LEN 0x06 /* MIFARE Std key length */ 195 #define PH_FRINFC_MIFARESTD_DEFAULT_KEY 0xFF /* MIFARE Std Default Key */ 196 197 198 NFCSTATUS phFriNfc_MifareStdMap_H_Reset( phFriNfc_NdefMap_t *NdefMap); 199 NFCSTATUS phFriNfc_MifareStdMap_RdNdef( phFriNfc_NdefMap_t *NdefMap, 200 uint8_t *PacketData, 201 uint32_t *PacketDataLength, 202 uint8_t Offset); 203 NFCSTATUS phFriNfc_MifareStdMap_WrNdef( phFriNfc_NdefMap_t *NdefMap, 204 uint8_t *PacketData, 205 uint32_t *PacketDataLength, 206 uint8_t Offset); 207 NFCSTATUS phFriNfc_MifareStdMap_ChkNdef(phFriNfc_NdefMap_t *NdefMap); 208 209 void phFriNfc_MifareStdMap_Process( void *Context, 210 NFCSTATUS Status); 211 extern 212 NFCSTATUS phFrinfc_MifareClassic_GetContainerSize(const phFriNfc_NdefMap_t *NdefMap, 213 uint32_t *maxSize, uint32_t *actualSize); 214 215 NFCSTATUS 216 phFriNfc_MifareStdMap_ConvertToReadOnly (phFriNfc_NdefMap_t *NdefMap, const uint8_t *ScrtKeyB); 217 218 #endif /* PHFRINFC_MIFARESTDMAP_H */ 219