ntag_nwk.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * MODULE:      NFC
 *
 * COMPONENT:   ntag_nwk.h
 *
 * AUTHOR:      Martin Looker
 *
 * DESCRIPTION: NTAG Network NDEF reading and writing (interface)
 *
 * $HeadURL: https://www.collabnet.nxp.com/svn/lprf_sware/Projects/Components/NFC/Tags/+v1000/Include/ntag_nwk.h $
 *
 * $Revision: 83835 $
 *
 * $LastChangedBy: nxp29761 $
 *
 * $LastChangedDate: 2016-10-04 15:29:56 +0100 (Tue, 04 Oct 2016) $
 *
 * $Id: ntag_nwk.h 83835 2016-10-04 14:29:56Z nxp29761 $
 *
 ****************************************************************************
 *
 * This software is owned by NXP B.V. and/or its supplier and is protected
 * under applicable copyright laws. All rights are reserved. We grant You,
 * and any third parties, a license to use this software solely and
 * exclusively on NXP products [NXP Microcontrollers such as JN5168, JN5179].
 * You, and any third parties must reproduce the copyright and warranty notice
 * and any other legend of ownership on each copy or partial copy of the
 * software.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * Copyright NXP B.V. 2016. All rights reserved
 *
 ***************************************************************************/
#ifndef NTAG_NWK_H_
#define NTAG_NWK_H_

/****************************************************************************/
/***        Include Files                                                 ***/
/****************************************************************************/
#include <jendefs.h>
#include "nfc_nwk.h"

/****************************************************************************/
/***        Macro Definitions                                             ***/
/****************************************************************************/

/****************************************************************************/
/***        Type Definitions                                              ***/
/****************************************************************************/
typedef enum
{
    E_NTAG_NWK_IDLE,        
    E_NTAG_NWK_READING,     
    E_NTAG_NWK_READ_FAIL,   
    E_NTAG_NWK_READ_OK,     
    E_NTAG_NWK_WRITING,     
    E_NTAG_NWK_WRITE_FAIL,  
    E_NTAG_NWK_WRITE_OK 
} teNtagNwkStatus;

/****************************************************************************/
/***        Exported Functions                                            ***/
/****************************************************************************/
/****************************************************************************
 *
 *  NAME:  NTAG_NWK_eRead
 */
PUBLIC teNtagNwkStatus NTAG_NWK_eRead(
    uint32          *pu32ReadAddress,         
    tsNfcNwkPayload   *psNfcNwkPayloadStart   
    );

/****************************************************************************
 *
 *  NAME:  NTAG_NWK_eWrite
 */
PUBLIC teNtagNwkStatus NTAG_NWK_eWrite(
    uint32          *pu32WriteAddress,      
    tsNfcNwkPayload   *psNfcNwkPayloadStart 
    );

/****************************************************************************
 *
 *  NAME:  NTAG_NWK_eStop
 */
PUBLIC teNtagNwkStatus NTAG_NWK_eStop(void);

/****************************************************************************
 *
 *  NAME:  NTAG_NWK_eStatus
 */
PUBLIC teNtagNwkStatus NTAG_NWK_eStatus(void);

/****************************************************************************
 *
 *  NAME:  NTAG_NWK_eTick
 */
PUBLIC teNtagNwkStatus NTAG_NWK_eTick(
       uint32                 u32TickMs 
    );

/****************************************************************************/
/***        Exported Variables                                            ***/
/****************************************************************************/

#endif /* NTAG_NWK_H_ */
/****************************************************************************/
/***        END OF FILE                                                   ***/
/****************************************************************************/