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

NFC ZigBee 3.0

previous page next page
NFC ZigBee 3.0 Modules and Libraries
NFC Commissioning using ZigBee Installation Codes
nci_nwk.h
Go to the documentation of this file.
1 /*****************************************************************************
2  *
3  * MODULE: NFC
4  *
5  * COMPONENT: nci_nwk.h
6  *
7  * AUTHOR: Martin Looker
8  *
9  * DESCRIPTION: NCI Network NDEF reading and writing (interface)
10  *
11  * $HeadURL: https://www.collabnet.nxp.com/svn/lprf_sware/Projects/Components/NFC/Tags/+v1000/Include/nci_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: nci_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  ***************************************************************************/
145 #ifndef NCI_NWK_H_
146 #define NCI_NWK_H_
147 
148 /****************************************************************************/
149 /*** Include Files ***/
150 /****************************************************************************/
151 #include <jendefs.h>
152 #include "nfc_nwk.h"
153 
154 /****************************************************************************/
155 /*** Macro Definitions ***/
156 /****************************************************************************/
157 
158 /****************************************************************************/
159 /*** Type Definitions ***/
160 /****************************************************************************/
162 typedef enum
163 {
164  E_NCI_NWK_IDLE,
165  E_NCI_NWK_READING,
166  E_NCI_NWK_READ_FAIL,
167  E_NCI_NWK_READ_OK,
168  E_NCI_NWK_WRITING,
169  E_NCI_NWK_WRITE_FAIL,
170  E_NCI_NWK_WRITE_OK
171 } teNciNwkStatus;
172 
173 /****************************************************************************/
174 /*** Exported Functions ***/
175 /****************************************************************************/
176 /****************************************************************************
177  *
178  * NAME: NCI_NWK_eRead
179  */
198 PUBLIC teNciNwkStatus NCI_NWK_eRead(
199  uint32 *pu32ReadAddress,
200  tsNfcNwkPayload *psNfcNwkPayloadStart
201  );
202 
203 /****************************************************************************
204  *
205  * NAME: NCI_NWK_eWrite
206  */
225 PUBLIC teNciNwkStatus NCI_NWK_eWrite(
226  uint32 *pu32WriteAddress,
227  tsNfcNwkPayload *psNfcNwkPayloadStart
228  );
229 
230 /****************************************************************************
231  *
232  * NAME: NCI_NWK_eStop
233  */
243 PUBLIC teNciNwkStatus NCI_NWK_eStop(void);
244 
245 /****************************************************************************
246  *
247  * NAME: NCI_NWK_eStatus
248  */
254 PUBLIC teNciNwkStatus NCI_NWK_eStatus(void);
255 
256 /****************************************************************************
257  *
258  * NAME: NCI_NWK_eTick
259  */
271 PUBLIC teNciNwkStatus NCI_NWK_eTick(
272  uint32 u32TickMs
273  );
274 
275 /****************************************************************************/
276 /*** Exported Variables ***/
277 /****************************************************************************/
278 
279 #endif /* NCI_NWK_H_ */
280 /****************************************************************************/
281 /*** END OF FILE ***/
282 /****************************************************************************/
NCI_NWK_eWrite
PUBLIC teNciNwkStatus NCI_NWK_eWrite(uint32 *pu32WriteAddress, tsNfcNwkPayload *psNfcNwkPayloadStart)
Requests write of NWK NDEF data to an NTAG in the reader&#39;s field.
E_NCI_NWK_WRITE_FAIL
Definition: nci_nwk.h:169
NCI_NWK_eTick
PUBLIC teNciNwkStatus NCI_NWK_eTick(uint32 u32TickMs)
Timer function to drive NCI NWK NDEF processing.
NCI_NWK_eStatus
PUBLIC teNciNwkStatus NCI_NWK_eStatus(void)
Returns the status of the NCI NWK NDEF processing.
teNciNwkStatus
teNciNwkStatus
Definition: nci_nwk.h:162
E_NCI_NWK_READ_FAIL
Definition: nci_nwk.h:166
NCI_NWK_eRead
PUBLIC teNciNwkStatus NCI_NWK_eRead(uint32 *pu32ReadAddress, tsNfcNwkPayload *psNfcNwkPayloadStart)
Requests read of NWK NDEF data from an NTAG in the reader&#39;s field.
E_NCI_NWK_READ_OK
Definition: nci_nwk.h:167
nfc_nwk.h
Common macros used by all NFC NWK NDEF processing.
E_NCI_NWK_IDLE
Definition: nci_nwk.h:164
tsNfcNwkPayload
Definition: nfc_nwk.h:115
NCI_NWK_eStop
PUBLIC teNciNwkStatus NCI_NWK_eStop(void)
Stops processing of NCI NWK NDEF data.
E_NCI_NWK_READING
Definition: nci_nwk.h:165
E_NCI_NWK_WRITING
Definition: nci_nwk.h:168
E_NCI_NWK_WRITE_OK
Definition: nci_nwk.h:170
Generated by   doxygen 1.8.13
previous page start next page