2 * Copyright (C) 2010 NXP Semiconductors
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * \file phFriNfc_MifareStdMap.h
19 * \brief NFC Ndef Mapping For Remote Devices.
23 * $Date: Tue May 19 10:30:01 2009 $
26 * $Aliases: NFC_FRI1.1_WK922_PREP1,NFC_FRI1.1_WK920_R25_1,NFC_FRI1.1_WK922_R26_1,NFC_FRI1.1_WK924_PREP1,NFC_FRI1.1_WK924_R27_1,NFC_FRI1.1_WK926_R28_1,NFC_FRI1.1_WK928_R29_1,NFC_FRI1.1_WK930_R30_1,NFC_FRI1.1_WK934_PREP_1,NFC_FRI1.1_WK934_R31_1,NFC_FRI1.1_WK941_PREP1,NFC_FRI1.1_WK941_PREP2,NFC_FRI1.1_WK941_1,NFC_FRI1.1_WK943_R32_1,NFC_FRI1.1_WK949_PREP1,NFC_FRI1.1_WK943_R32_10,NFC_FRI1.1_WK943_R32_13,NFC_FRI1.1_WK943_R32_14,NFC_FRI1.1_WK1007_R33_1,NFC_FRI1.1_WK1007_R33_4,NFC_FRI1.1_WK1017_PREP1,NFC_FRI1.1_WK1017_R34_1,NFC_FRI1.1_WK1017_R34_2,NFC_FRI1.1_WK1023_R35_1 $
30 #ifndef PHFRINFC_MIFARESTDMAP_H
31 #define PHFRINFC_MIFARESTDMAP_H
35 #include <phHal4Nfc.h>
39 /** Fix: [NFC-FRI * * * CCB * * * 0000429]:
40 phFriNfc_MifareMap : Error during compilation **/
41 #include <phNfcStatus.h>
42 #include <phFriNfc_OvrHal.h>
44 #ifndef PH_HAL4_ENABLE
45 #include <phFriNfc_OvrHalCmd.h>
48 #include <phNfcTypes.h>
49 #include <phFriNfc_NdefMap.h>
51 /*! \ingroup grp_file_attributes
54 * File: \ref phFriNfc_NdefMap.h
58 #define PH_FRINFC_MIFARESTDMAP_FILEREVISION "$Revision: 1.7 $"
59 #define PH_FRINFC_MIFARESTDMAP_FILEALIASES "$Aliases: NFC_FRI1.1_WK922_PREP1,NFC_FRI1.1_WK920_R25_1,NFC_FRI1.1_WK922_R26_1,NFC_FRI1.1_WK924_PREP1,NFC_FRI1.1_WK924_R27_1,NFC_FRI1.1_WK926_R28_1,NFC_FRI1.1_WK928_R29_1,NFC_FRI1.1_WK930_R30_1,NFC_FRI1.1_WK934_PREP_1,NFC_FRI1.1_WK934_R31_1,NFC_FRI1.1_WK941_PREP1,NFC_FRI1.1_WK941_PREP2,NFC_FRI1.1_WK941_1,NFC_FRI1.1_WK943_R32_1,NFC_FRI1.1_WK949_PREP1,NFC_FRI1.1_WK943_R32_10,NFC_FRI1.1_WK943_R32_13,NFC_FRI1.1_WK943_R32_14,NFC_FRI1.1_WK1007_R33_1,NFC_FRI1.1_WK1007_R33_4,NFC_FRI1.1_WK1017_PREP1,NFC_FRI1.1_WK1017_R34_1,NFC_FRI1.1_WK1017_R34_2,NFC_FRI1.1_WK1023_R35_1 $"
63 /*! \defgroup grp_fri_nfc_ndef_map NDEF Mapping for Remote Devices
65 * This component encapsulates Ndef Registration and Listening data and functionality.
70 * \name NDEF Mapping - states of the Finite State machine
74 #define PH_FRINFC_NDEFMAP_STATE_INIT 0 /*!< Init state. The start-up state */
75 #define PH_FRINFC_NDEFMAP_STATE_READ 1 /*!< Read State */
76 #define PH_FRINFC_NDEFMAP_STATE_WRITE 2 /*!< Write is going on*/
77 #define PH_FRINFC_NDEFMAP_STATE_AUTH 3 /*!< Authenticate is going on*/
78 #define PH_FRINFC_NDEFMAP_STATE_CHK_NDEF_COMP 4 /*!< Check Ndef is going on */
79 #define PH_FRINFC_NDEFMAP_STATE_RD_ACS_BIT 5 /*!< Read access bit is in progress */
80 #define PH_FRINFC_NDEFMAP_STATE_WR_NDEF_LEN 6 /*!< Write NDEF TLV LEngth*/
81 #define PH_FRINFC_NDEFMAP_STATE_RD_TO_WR_NDEF_LEN 7 /*!< read to write the Ndef TLV*/
82 #define PH_FRINFC_NDEFMAP_STATE_GET_ACT_CARDSIZE 8 /*!< Get the card size */
83 #define PH_FRINFC_NDEFMAP_STATE_RD_BEF_WR 9 /*!< Read the NDEF TLV block before starting write */
84 #define PH_FRINFC_NDEFMAP_STATE_WR_TLV 10 /*!< Read the NDEF TLV block before starting write */
85 #define PH_FRINFC_NDEFMAP_STATE_RD_TLV 11 /*!< Read the NDEF TLV block */
86 #define PH_FRINFC_NDEFMAP_STATE_TERM_TLV 12 /*!< Write terminator TLV block */
87 #define PH_FRINFC_NDEFMAP_STATE_POLL 13 /*!< Poll in progress */
88 #define PH_FRINFC_NDEFMAP_STATE_DISCONNECT 14 /*!< Disconnect in progress */
89 #define PH_FRINFC_NDEFMAP_STATE_CONNECT 15 /*!< Connect in progress */
96 * \name Mifare Standard - NDEF Compliant Flags
100 #define PH_FRINFC_MIFARESTD_NDEF_COMP 0 /*!< Sector is NDEF Compliant */
101 #define PH_FRINFC_MIFARESTD_NON_NDEF_COMP 1 /*!< Sector is not NDEF Compliant */
105 * \name Mifare Standard - NDEF Compliant Flags
109 #define PH_FRINFC_MIFARESTD_PROP_1ST_CONFIG 0 /*!< No proprietary forum sector found */
110 #define PH_FRINFC_MIFARESTD_PROP_2ND_CONFIG 1 /*!< Here the proprietary
111 forum sector exists after NFC forum
113 #define PH_FRINFC_MIFARESTD_PROP_3RD_CONFIG 2 /*!< Here the proprietary
114 forum sector exists before NFC forum
119 * \name Mifare Standard - NDEF Compliant Flags
123 #define PH_FRINFC_MIFARESTD_MADSECT_ACS_BYTE6 0x78 /*!< Access Bit for Byte 6 in
124 MAD sector trailer */
125 #define PH_FRINFC_MIFARESTD_MADSECT_ACS_BYTE7 0x77 /*!< Access Bit for Byte 7 in
126 MAD sector trailer */
127 #define PH_FRINFC_MIFARESTD_NFCSECT_ACS_BYTE6 0x7F /*!< Access Bit for Byte 6 in
128 NFC forum sector trailer */
129 #define PH_FRINFC_MIFARESTD_NFCSECT_ACS_BYTE7 0x07 /*!< Access Bit for Byte 7 in
130 NFC forum sector trailer */
131 #define PH_FRINFC_MIFARESTD_ACS_BYTE8 0x88 /*!< Access Bit for Byte 8 in
132 all sector trailer */
133 #define PH_FRINFC_MIFARESTD_NFCSECT_RDACS_BYTE6 0x07 /*!< Access Bit for Byte 6 in
134 NFC forum sector trailer for
136 #define PH_FRINFC_MIFARESTD_NFCSECT_RDACS_BYTE7 0x8F /*!< Access Bit for Byte 7 in
137 NFC forum sector trailer
139 #define PH_FRINFC_MIFARESTD_NFCSECT_RDACS_BYTE8 0x0F /*!< Access Bit for Byte 8 in
140 NFC forum sector trailer
145 * \name Mifare Standard - Mifare Standard constants
149 #define MIFARE_MAX_SEND_BUF_TO_READ 1 /*!< Send Length for Reading a Block */
150 #define MIFARE_MAX_SEND_BUF_TO_WRITE 17 /*!< Send Length for writing a Block */
151 #define MIFARE_AUTHENTICATE_CMD_LENGTH 7 /*!< Send Length for authenticating a Block */
155 * \name Mifare standard - Constants
159 #define PH_FRINFC_MIFARESTD_MAD_BLK0 0 /*!< Block number 0 */
160 #define PH_FRINFC_MIFARESTD_MAD_BLK1 1 /*!< Block number 1 */
161 #define PH_FRINFC_MIFARESTD_MAD_BLK2 2 /*!< Block number 2 */
162 #define PH_FRINFC_MIFARESTD_MAD_BLK3 3 /*!< Block number 3 */
163 #define PH_FRINFC_MIFARESTD_BLK4 4 /*!< Block number 4 */
164 #define PH_FRINFC_MIFARESTD_BLK5 5 /*!< Block number 5 */
165 #define PH_FRINFC_MIFARESTD_BLK6 6 /*!< Block number 6 */
166 #define PH_FRINFC_MIFARESTD_BLK7 7 /*!< Block number 7 */
167 #define PH_FRINFC_MIFARESTD_BLK8 8 /*!< Block number 8 */
168 #define PH_FRINFC_MIFARESTD_BLK9 9 /*!< Block number 9 */
169 #define PH_FRINFC_MIFARESTD_BLK10 10 /*!< Block number 10 */
170 #define PH_FRINFC_MIFARESTD_BLK11 11 /*!< Block number 11 */
171 #define PH_FRINFC_MIFARESTD_BLK12 12 /*!< Block number 12 */
172 #define PH_FRINFC_MIFARESTD_BLK13 13 /*!< Block number 13 */
173 #define PH_FRINFC_MIFARESTD_BLK14 14 /*!< Block number 14 */
174 #define PH_FRINFC_MIFARESTD_BLK15 15 /*!< Block number 15 */
175 #define PH_FRINFC_MIFARESTD_MAD_BLK16 16 /*!< Block number 16 */
176 #define PH_FRINFC_MIFARESTD_MAD_BLK63 63 /*!< Block number 63 */
177 #define PH_FRINFC_MIFARESTD_MAD_BLK64 64 /*!< Block number 64 */
178 #define PH_FRINFC_MIFARESTD_MAD_BLK65 65 /*!< Block number 65 */
179 #define PH_FRINFC_MIFARESTD_MAD_BLK66 66 /*!< Block number 66 */
180 #define PH_FRINFC_MIFARESTD_MAD_BLK67 67 /*!< Block number 67 */
181 #define PH_FRINFC_MIFARESTD4K_BLK128 128 /*!< Block number 128 for Mifare 4k */
182 #define PH_FRINFC_MIFARESTD_SECTOR_NO0 0 /*!< Sector 0 */
183 #define PH_FRINFC_MIFARESTD_SECTOR_NO1 1 /*!< Sector 1 */
184 #define PH_FRINFC_MIFARESTD_SECTOR_NO16 16 /*!< Sector 16 */
185 #define PH_FRINFC_MIFARESTD_SECTOR_NO39 39 /*!< Sector 39 */
186 #define PH_FRINFC_MIFARESTD_SECTOR_NO32 32 /*!< Sector 32 */
187 #define PH_FRINFC_MIFARESTD4K_TOTAL_SECTOR 40 /*!< Sector 40 */
188 #define PH_FRINFC_MIFARESTD1K_TOTAL_SECTOR 16 /*!< Sector 40 */
189 #define PH_FRINFC_MIFARESTD_BYTES_READ 16 /*!< Bytes read */
190 #define PH_FRINFC_MIFARESTD_BLOCK_BYTES 16 /*!< Bytes per block */
191 #define PH_FRINFC_MIFARESTD_WR_A_BLK 17 /*!< 17 bytes (including current block)
192 are given to transfer */
193 #define PH_FRINFC_MIFARESTD4K_MAX_BLOCKS 210 /*!< Maximum number of Mifare 4k Blocks
194 excluding sector trailer */
195 #define PH_FRINFC_MIFARESTD1K_MAX_BLK 63 /*!< Maximum number of Mifare 1k blocks
196 including the sector trailer*/
197 #define PH_FRINFC_MIFARESTD4K_MAX_BLK 254 /*!< Maximum number of Mifare 4k blocks
198 including the sector trailer*/
199 #define PH_FRINFC_MIFARESTD_FLAG1 1 /*!< Flag to set 1 */
200 #define PH_FRINFC_MIFARESTD_FLAG0 0 /*!< Flag to set 0 */
201 #define PH_FRINFC_MIFARESTD_INC_1 1 /*!< increment by 1 */
202 #define PH_FRINFC_MIFARESTD_INC_2 2 /*!< increment by 2 */
203 #define PH_FRINFC_MIFARESTD_INC_3 3 /*!< increment by 3 */
204 #define PH_FRINFC_MIFARESTD_INC_4 4 /*!< increment by 4 */
205 #define PH_FRINFC_MIFARESTD_VAL0 0 /*!< Value initialised to 0 */
206 #define PH_FRINFC_MIFARESTD_VAL1 1 /*!< Value initialised to 1 */
207 #define PH_FRINFC_MIFARESTD_VAL2 2 /*!< Value initialised to 2 */
208 #define PH_FRINFC_MIFARESTD_VAL3 3 /*!< Value initialised to 3 */
209 #define PH_FRINFC_MIFARESTD_VAL4 4 /*!< Value initialised to 4 */
210 #define PH_FRINFC_MIFARESTD_VAL5 5 /*!< Value initialised to 5 */
211 #define PH_FRINFC_MIFARESTD_VAL6 6 /*!< Value initialised to 6 */
212 #define PH_FRINFC_MIFARESTD_VAL7 7 /*!< Value initialised to 7 */
213 #define PH_FRINFC_MIFARESTD_VAL8 8 /*!< Value initialised to 8 */
214 #define PH_FRINFC_MIFARESTD_VAL9 9 /*!< Value initialised to 9 */
215 #define PH_FRINFC_MIFARESTD_VAL10 10 /*!< Value initialised to 10 */
216 #define PH_FRINFC_MIFARESTD_VAL11 11 /*!< Value initialised to 11 */
217 #define PH_FRINFC_MIFARESTD_VAL12 12 /*!< Value initialised to 12 */
218 #define PH_FRINFC_MIFARESTD_VAL13 13 /*!< Value initialised to 13 */
219 #define PH_FRINFC_MIFARESTD_VAL14 14 /*!< Value initialised to 14 */
220 #define PH_FRINFC_MIFARESTD_VAL15 15 /*!< Value initialised to 15 */
221 #define PH_FRINFC_MIFARESTD_VAL16 16 /*!< Value initialised to 16 */
222 #define PH_FRINFC_MIFARESTD_NDEFTLV_L 0xFF /*!< Length of the TLV */
223 #define PH_FRINFC_MIFARESTD_NDEFTLV_T 0x03 /*!< Length of the TLV */
224 #define PH_FRINFC_MIFARESTD_NDEFTLV_L0 0x00 /*!< Length of the TLV */
225 #define PH_FRINFC_MIFARESTD_NDEFTLV_LBYTES0 0 /*!< Number of bytes taken by length (L) of the TLV */
226 #define PH_FRINFC_MIFARESTD_NDEFTLV_LBYTES1 1 /*!< Number of bytes taken by length (L) of the TLV */
227 #define PH_FRINFC_MIFARESTD_NDEFTLV_LBYTES2 2 /*!< Number of bytes taken by length (L) of the TLV */
228 #define PH_FRINFC_MIFARESTD_NDEFTLV_LBYTES3 3 /*!< Number of bytes taken by length (L) of the TLV */
229 #define PH_FRINFC_MIFARESTD_PROPTLV_T 0xFD /*!< Type of Proprietary TLV */
230 #define PH_FRINFC_MIFARESTD_TERMTLV_T 0xFE /*!< Type of Terminator TLV */
231 #define PH_FRINFC_MIFARESTD_NULLTLV_T 0x00 /*!< Type of NULL TLV */
232 #define PH_FRINFC_MIFARESTD_LEFTSHIFT8 8 /*!< Left shift by 8 */
233 #define PH_FRINFC_MIFARESTD_RIGHTSHIFT8 8 /*!< Right shift by 8 */
234 #define PH_FRINFC_MIFARESTD_MASK_FF 0xFF /*!< Mask 0xFF */
235 #define PH_FRINFC_MIFARESTD_MASK_GPB_WR 0x03 /*!< Mask 0x03 for GPB byte */
236 #define PH_FRINFC_MIFARESTD_MASK_GPB_RD 0x0C /*!< Mask 0xOC for GPB byte */
237 #define PH_FRINFC_MIFARESTD_GPB_RD_WR_VAL 0x00 /*!< GPB Read Write value */
243 * \brief \copydoc page_reg Resets the component instance to the initial state and lets the component forget about
244 * the list of registered items. Moreover, the lower device is set.
246 * \param[in] NdefMap Pointer to a valid or uninitialised instance of \ref phFriNfc_NdefMap_t .
248 * \note This function has to be called at the beginning, after creating an instance of
249 * \ref phFriNfc_NdefMap_t . Use this function to reset the instance and/or switch
250 * to a different underlying device (different NFC device or device mode, or different
253 NFCSTATUS phFriNfc_MifareStdMap_H_Reset( phFriNfc_NdefMap_t *NdefMap);
258 * \brief \copydoc page_ovr Initiates Reading of NDEF information from the Remote Device.
260 * The function initiates the reading of NDEF information from a Remote Device.
261 * It performs a reset of the state and starts the action (state machine).
262 * A periodic call of the \ref phFriNfc_NdefMap_Process has to be done once the action
263 * has been triggered.
265 * \param[in] NdefMap Pointer to a valid instance of the \ref phFriNfc_NdefMap_t structure describing
266 * the component context.
268 * \param[in] PacketData Pointer to a location that receives the NDEF Packet.
270 * \param[in,out] PacketDataLength Pointer to a variable receiving the length of the NDEF packet.
272 * \param[in] Offset Indicates whether the read operation shall start from the begining of the
273 * file/card storage \b or continue from the last offset. The last Offset set is stored
274 * within a context variable (must not be modified by the integration).
275 * If the caller sets the value to \ref PH_FRINFC_NDEFMAP_SEEK_CUR, the component shall
276 * start reading from the last offset set (continue where it has stopped before).
277 * If set to \ref PH_FRINFC_NDEFMAP_SEEK_BEGIN, the component shall start reading
278 * from the begining of the card (restarted)
280 * \retval NFCSTATUS_PENDING The action has been successfully triggered.
281 * \retval NFCSTATUS_INVALID_DEVICE_REQUEST If Previous Operation is Write Ndef and Offset
282 * is Current then this error is displayed.
283 * \retval NFCSTATUS_EOF_NDEF_CONTAINER_REACHED No Space in the File to read.
284 * \retval NFCSTATUS_MORE_INFORMATION There are more bytes to read in the card.
285 * \retval NFCSTATUS_SUCCESS Last Byte of the card read.
286 * \retval NFCSTATUS_INVALID_DEVICE The device has not been opened or has been disconnected
288 * \retval NFCSTATUS_CMD_ABORTED The caller/driver has aborted the request.
289 * \retval NFCSTATUS_BUFFER_TOO_SMALL The buffer provided by the caller is too small.
290 * \retval NFCSTATUS_RF_TIMEOUT No data has been received within the TIMEOUT period.
293 NFCSTATUS phFriNfc_MifareStdMap_RdNdef( phFriNfc_NdefMap_t *NdefMap,
295 uint32_t *PacketDataLength,
300 * \brief \copydoc page_ovr Initiates Writing of NDEF information to the Remote Device.
302 * The function initiates the writing of NDEF information to a Remote Device.
303 * It performs a reset of the state and starts the action (state machine).
304 * A periodic call of the \ref phFriNfc_NdefMap_Process has to be done once the action
305 * has been triggered.
307 * \param[in] NdefMap Pointer to a valid instance of the \ref phFriNfc_NdefMap_t structure describing
308 * the component context.
310 * \param[in] PacketData Pointer to a location that holds the prepared NDEF Packet.
312 * \param[in,out] PacketDataLength Variable specifying the length of the prepared NDEF packet.
314 * \param[in] Offset Indicates whether the write operation shall start from the begining of the
315 * file/card storage \b or continue from the last offset. The last Offset set is stored
316 * within a context variable (must not be modified by the integration).
317 * If the caller sets the value to \ref PH_FRINFC_NDEFMAP_SEEK_CUR, the component shall
318 * start writing from the last offset set (continue where it has stopped before).
319 * If set to \ref PH_FRINFC_NDEFMAP_SEEK_BEGIN, the component shall start writing
320 * from the begining of the card (restarted)
322 * \retval NFCSTATUS_PENDING The action has been successfully triggered.
323 * \retval NFCSTATUS_INVALID_DEVICE_REQUEST If Previous Operation is Write Ndef and Offset
324 * is Current then this error is displayed.
325 * \retval NFCSTATUS_EOF_NDEF_CONTAINER_REACHED Last byte is written to the card after this
326 * no further writing is possible.
327 * \retval NFCSTATUS_SUCCESS Buffer provided by the user is completely written
329 * \retval NFCSTATUS_INVALID_DEVICE The device has not been opened or has been disconnected
331 * \retval NFCSTATUS_CMD_ABORTED The caller/driver has aborted the request.
332 * \retval NFCSTATUS_BUFFER_TOO_SMALL The buffer provided by the caller is too small.
333 * \retval NFCSTATUS_RF_TIMEOUT No data has been received within the TIMEOUT period.
337 NFCSTATUS phFriNfc_MifareStdMap_WrNdef( phFriNfc_NdefMap_t *NdefMap,
339 uint32_t *PacketDataLength,
344 * \brief \copydoc page_ovr Check whether a particulat Remote Device is NDEF compliant.
346 * The function checks whether the peer device is NDEF compliant.
348 * \param[in] NdefMap Pointer to a valid instance of the \ref phFriNfc_NdefMap_t structure describing
349 * the component context.
351 * \retval NFCSTATUS_PENDING The action has been successfully triggered.
352 * \retval NFCSTATUS_INVALID_PARAMETER At least one parameter of the function is invalid.
353 * \retval NFCSTATUS_INVALID_DEVICE The device has not been opened or has been disconnected
355 * \retval NFCSTATUS_CMD_ABORTED The caller/driver has aborted the request.
356 * \retval NFCSTATUS_BUFFER_TOO_SMALL The buffer provided by the caller is too small.
357 * \retval NFCSTATUS_RF_TIMEOUT No data has been received within the TIMEOUT period.
360 NFCSTATUS phFriNfc_MifareStdMap_ChkNdef(phFriNfc_NdefMap_t *NdefMap);
363 * \brief \copydoc page_cb Completion Routine, Processing function, needed to avoid long blocking.
365 * The function call scheme is according to \ref grp_interact. No State reset is performed during operation.
367 * \copydoc pphFriNfc_Cr_t
369 * \note The lower (Overlapped HAL) layer must register a pointer to this function as a Completion
370 * Routine in order to be able to notify the component that an I/O has finished and data are
371 * ready to be processed.
374 void phFriNfc_MifareStdMap_Process( void *Context,
377 #endif /* PHFRINFC_MIFARESTDMAP_H */