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

NFC ZigBee 3.0

previous page next page
NFC ZigBee 3.0 Modules and Libraries
NFC Commissioning using ZigBee Installation Codes
app_nci_icode.h
Go to the documentation of this file.
1 /*****************************************************************************
2  *
3  * MODULE: JN-AN-1217 Base Device application
4  *
5  * COMPONENT: app_nci_icode.h
6  *
7  * DESCRIPTION: Base Device - Application layer for NCI (Installation Code encryption)
8  *
9  ****************************************************************************
10  *
11  * This software is owned by NXP B.V. and/or its supplier and is protected
12  * under applicable copyright laws. All rights are reserved. We grant You,
13  * and any third parties, a license to use this software solely and
14  * exclusively on NXP products [NXP Microcontrollers such as JN5168, JN5179].
15  * You, and any third parties must reproduce the copyright and warranty notice
16  * and any other legend of ownership on each copy or partial copy of the
17  * software.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  * Copyright NXP B.V. 2017. All rights reserved
32  *
33  ***************************************************************************/
51 #ifndef APP_NCI_ICODE_H_
52 #define APP_NCI_ICODE_H_
53 
54 /****************************************************************************/
55 /*** Include Files ***/
56 /****************************************************************************/
57 #include <jendefs.h>
58 #include <nci.h>
59 
60 /****************************************************************************/
61 /*** Macro Definitions ***/
62 /****************************************************************************/
63 #define APP_NCI_ADDRESS 0xFFU
64 #define APP_NCI_I2C_LOCATION FALSE
65 #define APP_NCI_I2C_FREQUENCY_HZ 100000
66 #define APP_NCI_TICK_MS 5
67 #if (JENNIC_CHIP_FAMILY == JN517x)
68 #define APP_NCI_IRQ_PIN 18
69 #define APP_NCI_VEN_PIN 15
70 #else
71 #define APP_NCI_IRQ_PIN 17
72 #define APP_NCI_VEN_PIN 0
73 #endif
74 
75 /****************************************************************************/
76 /*** Type Definitions ***/
77 /****************************************************************************/
78 
79 /****************************************************************************/
80 /*** Exported Functions ***/
81 /****************************************************************************/
82 /****************************************************************************
83  *
84  * NAME: APP_vNciStart
85  */
95 PUBLIC void APP_vNciStart(
96  uint8 u8ApplicationEndpoint
97  );
98 
99 /****************************************************************************
100  *
101  * NAME: APP_vNciStop
102  */
109 PUBLIC void APP_vNciStop(void);
110 
111 /****************************************************************************
112  *
113  * NAME: APP_cbNciTimer
114  */
136 PUBLIC void APP_cbNciTimer(void *pvParams);
137 
138 /****************************************************************************
139  *
140  * NAME: APP_cbNciEvent()
141  */
154 PUBLIC void APP_cbNciEvent(
155  teNciEvent eNciEvent,
156  uint32 u32Address,
157  uint32 u32Length,
158  uint8 *pu8Data
159  );
160 
161 /****************************************************************************/
162 /*** Exported Variables ***/
163 /****************************************************************************/
164 
165 #endif /* APP_NCI_ICODE_H_ */
166 /****************************************************************************/
167 /*** END OF FILE ***/
168 /****************************************************************************/
APP_vNciStart
PUBLIC void APP_vNciStart(uint8 u8ApplicationEndpoint)
Starts NCI processing.
teNciEvent
teNciEvent
Definition: nci.h:161
nci.h
NCI driver for reading and writing data (interface)
APP_vNciStop
PUBLIC void APP_vNciStop(void)
Stops the NCI running.
APP_cbNciEvent
PUBLIC void APP_cbNciEvent(teNciEvent eNciEvent, uint32 u32Address, uint32 u32Length, uint8 *pu8Data)
NCI event callback function.
APP_cbNciTimer
PUBLIC void APP_cbNciTimer(void *pvParams)
ZTIMER callback function.
Generated by   doxygen 1.8.13
previous page start next page