ntag.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * MODULE:      NFC
 *
 * COMPONENT:   ntag.h
 *
 * AUTHOR:      Martin Looker
 *
 * DESCRIPTION: NTAG driver for reading and writing data (interface)
 *
 * $HeadURL: https://www.collabnet.nxp.com/svn/lprf_sware/Projects/Components/NFC/Tags/+v1000/Include/ntag.h $
 *
 * $Revision: 83835 $
 *
 * $LastChangedBy: nxp29761 $
 *
 * $LastChangedDate: 2016-10-04 15:29:56 +0100 (Tue, 04 Oct 2016) $
 *
 * $Id: ntag.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_H_
#define NTAG_H_

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

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

/****************************************************************************/
/***        Type Definitions                                              ***/
/****************************************************************************/
typedef enum
{
    E_NTAG_EVENT_ABSENT,            
    E_NTAG_EVENT_PRESENT,           
    E_NTAG_EVENT_READ_FAIL,         
    E_NTAG_EVENT_READ_OK,           
    E_NTAG_EVENT_WRITE_FAIL,        
    E_NTAG_EVENT_WRITE_OK,          
    E_NTAG_EVENT_READ_REG_FAIL,     
    E_NTAG_EVENT_READ_REG_OK,       
    E_NTAG_EVENT_WRITE_REG_FAIL,    
    E_NTAG_EVENT_WRITE_REG_OK 
} teNtagEvent;

typedef void (*tprNtagCbEvent)(         /* Called when an event takes place */
        teNtagEvent eNtagEvent,         /* Event raised */
        uint32      u32Address,
        uint32      u32Length,
        uint8       *pu8Data);          /* Event data (NULL if no data) */

/****************************************************************************/
/***        Exported Functions (called by application)                    ***/
/****************************************************************************/
/****************************************************************************
 *
 *  NAME:  NTAG_vInitialise
 */
PUBLIC void NTAG_vInitialise(
       uint8    u8Address,     
       bool_t    bLocation,    
       uint32  u32FrequencyHz, 
       uint8    u8InputFd      
       );

/****************************************************************************
 *
 *  NAME:  NTAG_vRegCbEvent
 */
PUBLIC void NTAG_vRegCbEvent(
       tprNtagCbEvent prRegCbEvent 
       );

/****************************************************************************
 *
 *  NAME:  NTAG_vTick
 */
PUBLIC void NTAG_vTick(
       uint32  u32TickMs 
       );

/****************************************************************************
 *
 *  NAME:  NTAG_bRead
 */
PUBLIC  bool_t NTAG_bRead(
        uint32    u32ReadAddress, 
        uint32    u32ReadLength,  
        uint8    *pu8ReadData     
        );

/****************************************************************************
 *
 *  NAME:  NTAG_bReadVersion
 */
PUBLIC  bool_t NTAG_bReadVersion(
        uint32    u32ReadLength, 
        uint8    *pu8ReadData    
        );

/****************************************************************************
 *
 *  NAME:  NTAG_bWrite
 */
PUBLIC  bool_t NTAG_bWrite(
        uint32    u32WriteAddress,  
        uint32    u32WriteLength,   
        uint8    *pu8WriteData      
        );

/****************************************************************************
 *
 *  NAME:  NTAG_bReadReg
 */
PUBLIC  bool_t NTAG_bReadReg(
        uint32    u32ReadAddress, /*<! Byte address of read */
        uint32    u32ReadLength,  /*<! Number of bytes to read (minimum 1) */
        uint8    *pu8ReadData     /*<! Buffer to read data into */
        );

/****************************************************************************
 *
 *  NAME:  NTAG_bWriteReg
 */
PUBLIC  bool_t NTAG_bWriteReg(
        uint32    u32WriteAddress, 
        uint32    u32WriteLength,  
        uint8    *pu8WriteData     
        );

/****************************************************************************
 *
 *  NAME:  NTAG_u32Ntag
 */
PUBLIC  uint32 NTAG_u32Ntag(void);

/****************************************************************************
 *
 *  NAME:  NTAG_u32Config
 */
PUBLIC  uint32 NTAG_u32Config(void);

/****************************************************************************
 *
 *  NAME:        NTAG_u32Session
 */
PUBLIC  uint32 NTAG_u32Session(void);

/****************************************************************************
 *
 *  NAME:        NTAG_u32Sram
 */
PUBLIC  uint32 NTAG_u32Sram(void);

/****************************************************************************
 *
 *  NAME:        NTAG_pu8Header
 */
PUBLIC  uint8 *NTAG_pu8Header(void);

/****************************************************************************
 *
 *  NAME:        NTAG_pu8Version
 */
PUBLIC  uint8 *NTAG_pu8Version(void);

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

#endif /* NTAG_H_ */
/****************************************************************************/
/***        END OF FILE                                                   ***/
/****************************************************************************/