NFC ZigBee 3.0 Modules and Libraries: ntag_nwk.h Source File

NFC ZigBee 3.0

NFC ZigBee 3.0 Modules and Libraries
NFC Commissioning using ZigBee Installation Codes
ntag_nwk.h
Go to the documentation of this file.
1 /*****************************************************************************
2  *
3  * MODULE: NFC
4  *
5  * COMPONENT: ntag_nwk.h
6  *
7  * AUTHOR: Martin Looker
8  *
9  * DESCRIPTION: NTAG Network NDEF reading and writing (interface)
10  *
11  * $HeadURL: https://www.collabnet.nxp.com/svn/lprf_sware/Projects/Components/NFC/Tags/+v1000/Include/ntag_nwk.h $
12  *
13  * $Revision: 83835 $
14  *
15  * $LastChangedBy: nxp29761 $
16  *
17  * $LastChangedDate: 2016-10-04 15:29:56 +0100 (Tue, 04 Oct 2016) $
18  *
19  * $Id: ntag_nwk.h 83835 2016-10-04 14:29:56Z nxp29761 $
20  *
21  ****************************************************************************
22  *
23  * This software is owned by NXP B.V. and/or its supplier and is protected
24  * under applicable copyright laws. All rights are reserved. We grant You,
25  * and any third parties, a license to use this software solely and
26  * exclusively on NXP products [NXP Microcontrollers such as JN5168, JN5179].
27  * You, and any third parties must reproduce the copyright and warranty notice
28  * and any other legend of ownership on each copy or partial copy of the
29  * software.
30  *
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
32  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
33  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
35  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
39  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGE.
42  *
43  * Copyright NXP B.V. 2016. All rights reserved
44  *
45  ***************************************************************************/
132 #ifndef NTAG_NWK_H_
133 #define NTAG_NWK_H_
134 
135 /****************************************************************************/
136 /*** Include Files ***/
137 /****************************************************************************/
138 #include <jendefs.h>
139 #include "nfc_nwk.h"
140 
141 /****************************************************************************/
142 /*** Macro Definitions ***/
143 /****************************************************************************/
144 
145 /****************************************************************************/
146 /*** Type Definitions ***/
147 /****************************************************************************/
149 typedef enum
150 {
159 
160 /****************************************************************************/
161 /*** Exported Functions ***/
162 /****************************************************************************/
163 /****************************************************************************
164  *
165  * NAME: NTAG_NWK_eRead
166  */
186  uint32 *pu32ReadAddress,
187  tsNfcNwkPayload *psNfcNwkPayloadStart
188  );
189 
190 /****************************************************************************
191  *
192  * NAME: NTAG_NWK_eWrite
193  */
213  uint32 *pu32WriteAddress,
214  tsNfcNwkPayload *psNfcNwkPayloadStart
215  );
216 
217 /****************************************************************************
218  *
219  * NAME: NTAG_NWK_eStop
220  */
230 PUBLIC teNtagNwkStatus NTAG_NWK_eStop(void);
231 
232 /****************************************************************************
233  *
234  * NAME: NTAG_NWK_eStatus
235  */
241 PUBLIC teNtagNwkStatus NTAG_NWK_eStatus(void);
242 
243 /****************************************************************************
244  *
245  * NAME: NTAG_NWK_eTick
246  */
259  uint32 u32TickMs
260  );
261 
262 /****************************************************************************/
263 /*** Exported Variables ***/
264 /****************************************************************************/
265 
266 #endif /* NTAG_NWK_H_ */
267 /****************************************************************************/
268 /*** END OF FILE ***/
269 /****************************************************************************/
PUBLIC teNtagNwkStatus NTAG_NWK_eRead(uint32 *pu32ReadAddress, tsNfcNwkPayload *psNfcNwkPayloadStart)
Requests read of NTAG NWK NDEF data.
Definition: ntag_nwk.h:155
Definition: ntag_nwk.h:157
Definition: ntag_nwk.h:156
Definition: ntag_nwk.h:153
teNtagNwkStatus
Definition: ntag_nwk.h:149
Definition: ntag_nwk.h:154
Definition: ntag_nwk.h:151
Common macros used by all NFC NWK NDEF processing.
Definition: nfc_nwk.h:115
PUBLIC teNtagNwkStatus NTAG_NWK_eTick(uint32 u32TickMs)
Timer function to drive NTAG NWK NDEF processing.
PUBLIC teNtagNwkStatus NTAG_NWK_eWrite(uint32 *pu32WriteAddress, tsNfcNwkPayload *psNfcNwkPayloadStart)
Requests write of NTAG NWK NDEF data.
Definition: ntag_nwk.h:152
PUBLIC teNtagNwkStatus NTAG_NWK_eStatus(void)
Returns the status of the NTAG NWK NDEF processing.
PUBLIC teNtagNwkStatus NTAG_NWK_eStop(void)
Stops processing of NTAG NWK NDEF data.
Generated by   doxygen 1.8.13