nfc-nxp-hal.h

/******************************************************************************
 *  NXP lib communication interface HAL (SPI related)
 *****************************************************************************/

phStatus_t phbalReg_Stub_GetPortList(phbalReg_Stub_DataParams_t * pDataParams,
                                     uint16_t wPortBufSize,
                                     uint8_t * pPortNames,
                                     uint16_t * pNumOfPorts);

phStatus_t phbalReg_Stub_SetPort(phbalReg_Stub_DataParams_t * pDataParams,
                                 uint8_t * pPortName);

phStatus_t phbalReg_Stub_OpenPort(phbalReg_Stub_DataParams_t * pDataParams);

phStatus_t phbalReg_Stub_ClosePort(phbalReg_Stub_DataParams_t * pDataParams);

phStatus_t phbalReg_Stub_Exchange(phbalReg_Stub_DataParams_t * pDataParams,
                                  uint16_t wOption,
                                  uint8_t * pTxBuffer,
                                  uint16_t wTxLength,
                                  uint16_t wRxBufSize,
                                  uint8_t * pRxBuffer,
                                  uint16_t * pRxLength);

phStatus_t phbalReg_Stub_SetConfig(phbalReg_Stub_DataParams_t * pDataParams,
                                   uint16_t wConfig,
                                   uint16_t wValue);

phStatus_t phbalReg_Stub_GetConfig(phbalReg_Stub_DataParams_t * pDataParams,
                                   uint16_t wConfig,
                                   uint16_t * pValue);


/******************************************************************************
 *  NXP lib OS AL (timers)
 *****************************************************************************/

/**
 * \defgroup phPlatform Component : Stub
 * \ingroup pn512
 * \brief These Components implement the Osal commands.
 * \{
 */

#define PLATFORM_MAX_TIMERS             3U         /**< Maximum number of timers available */
#define TIMER_USED                      1U         /**< Indicates that the timer is used */
#define TIMER_FREE                      0U         /**< Indicates that the timer is free */
#ifndef TIME_INTERVAL
#define TIME_INTERVAL                   (SystemFrequency/100 - 1)
#endif

/**
*
* \brief Timer callback interface which will be called once registered timer
* timeout expires.
* \param[in] TimerId  Timer Id for which callback is called.
* \retval  None
*/
typedef void (*ppCallBck_t)(void *pContext);

typedef struct Timer_Struct
{
    uint32_t       dwTimerId;                             /**< ID of the timer */
    uint8_t        bTimerFree;                            /**< Indicates whether the current timer is free or used */
    ppCallBck_t    pApplicationCallback;                  /**< The call back function for this timer */
    void          *pContext;                              /**< The argument to the call back function */
} Timer_Struct_t;

/**
* \brief OSAL parameter structure
*/
typedef struct
{
    uint16_t           wId;                               /**< ID of this component, do not modify */
    Timer_Struct_t     gTimers[PLATFORM_MAX_TIMERS];      /**< Timer structure */
} phPlatform_DataParams_t;

/**
* Initializes the Stub timer component
*
* \return status code
* \retval #PH_ERR_SUCCESS Operation successful.
*
*/
phStatus_t phPlatform_Init(phPlatform_DataParams_t  *pDataParams);    /**<[In] Data parameters representing this component */

/** \defgroup phOsal Operating System Abstraction Layer
* \brief These Components implement the Osal commands.
* @{
*/

#define PH_PLATFORM_TIMER_UNIT_US         0x00U                       /**< Indicates that the specified delay is in microseconds.*/
#define PH_PLATFORM_TIMER_UNIT_MS         0x01U                       /**< Indicates that the specified delay is in milliseconds. */
#define PH_PLATFORM_INVALID_TIMER_ID      0xFFFFFFFF                  /**< Invalid Timer Id. */

/**
 * \name Platform error codes
 *@{
 */

#define PH_PLATFORM_ERR_NO_FREE_TIMER     (PH_ERR_CUSTOM_BEGIN + 0)   /**< Error condition indicating that no timer is available for allocation. */
#define PH_PLATFORM_ERR_INVALID_TIMER     (PH_ERR_CUSTOM_BEGIN + 1)   /**< Indicates that the timer ID that was supplied was invalid. */

/** @} */

/* *****************************************************************************************************************
* Function Prototypes
* ***************************************************************************************************************** */
/**
* \brief Initialize platform timers.
*
* \return Status code
* \retval #PH_ERR_SUCCESS Operation successful.
* USED BY APP ONLY
*/
phStatus_t phPlatform_Timer_Init(phPlatform_DataParams_t  *pDataParams);                       /**< [In] Pointer to this layers parameter structure. */


/**
* \brief Allocates a free timer.
* Note:
*
* \return Status code
* \retval #PH_ERR_SUCCESS Operation successful.
* \retval #PH_PLATFORM_ERR_NO_FREE_TIMER No Free Timer available to create.
*/
phStatus_t phPlatform_Timer_Create(phPlatform_DataParams_t   *pDataParams,                     /**< [In] Pointer to this layers parameter structure. */
                                   uint32_t                  *timerId                          /**< [Out] Timer Id */
                                   );

/**
* \brief Start the timer.
* Note: Valid Timer ID should be provided. Timer ID is provided by calling \ref phPlatform_Timer_Create function.
*
* \return Status code
* \retval #PH_ERR_SUCCESS Operation successful.
* \retval #PH_ERR_INVALID_PARAMETER Invalid input parameter.
* \retval #PH_PLATFORM_ERR_INVALID_TIMER Provided Timer ID is not created.
*/
phStatus_t phPlatform_Timer_Start(phPlatform_DataParams_t   *pDataParams,                      /**< [In] Pointer to this layers parameter structure. */
                                  uint32_t                   dwTimerId,                        /**< [In] Timer Id */
                                  uint32_t                   dwRegTimeCnt,                     /**< [In] Time delay count */
                                  uint16_t                   wOption,                          /**< [In] Option parameter to mention delay in Units
                                                                                                         (either #PH_PLATFORM_TIMER_UNIT_US or #PH_PLATFORM_TIMER_UNIT_MS). */
                                  ppCallBck_t                pApplication_callback,            /**< [In] Callback to be called on time out */
                                  void                      *pContext                          /**< [In] Callback function context */
                                  );

/**
* \brief Get Elapsed Delay from timer which is created and started before calling this API.
*
* \return Status code
* \retval #PH_ERR_SUCCESS Operation successful.
* \retval #PH_ERR_INVALID_PARAMETER Invalid input parameter.
* \retval #PH_PLATFORM_ERR_INVALID_TIMER Provided Timer ID is not created.
* NOT USED
*/
phStatus_t phPlatform_Timer_GetElapsedDelay(phPlatform_DataParams_t  *pDataParams,              /**< [In] Pointer to this layers parameter structure. */
                                            uint32_t                  dwTimerId,                /**< [In] Timer Id */
                                            uint16_t                  wOption,                  /**< [In] Option parameter to mention delay in Units
                                                                                                          (either #PH_PLATFORM_TIMER_UNIT_US or #PH_PLATFORM_TIMER_UNIT_MS). */
                                            uint32_t                  *dwGetElapsedDelay        /**< [Out] Measured Delay after Timer Start in milli/micro seconds based on input option. */
                                            );
/**
* \brief Stop the timer.
*
* \return Status code
* \retval #PH_ERR_SUCCESS Operation successful.
* \retval Other Depending on implementation and underlying component.
*/
phStatus_t phPlatform_Timer_Stop(phPlatform_DataParams_t   *pDataParams,                       /**< [In] Pointer to this layers parameter structure. */
                                 uint32_t                   dwTimerId                          /**< [In] Timer Id */
                                 );

/**
* \brief Timer wait function.
*
* \return Status code
* \retval #PH_ERR_SUCCESS Operation successful.
* \retval #PH_PLATFORM_ERR_NO_FREE_TIMER No Free Timer available to create.
* NOT USED
*/
phStatus_t phPlatform_Timer_Wait(phPlatform_DataParams_t   *pDataParams,                       /**< [In] Pointer to this layers parameter structure. */
                                 uint8_t                    bTimerDelayUnit,                   /**< [In] Delay value unit could be in microseconds or milliseconds */
                                 uint16_t                   wDelay                             /**< [In] Time Delay */
                                 );

/**
* \brief Resets the timer allocated to the application which is created by \ref phPlatform_Timer_Create.
*
* \return Status code
* \retval #PH_ERR_SUCCESS Operation successful.
* \retval #PH_PLATFORM_ERR_INVALID_TIMER Provided Timer ID is not created.
*/
phStatus_t phPlatform_Timer_Reset(phPlatform_DataParams_t   *pDataParams,                      /**< [In] Pointer to this layers parameter structure. */
                                  uint32_t                   dwtimerId                         /**< [In] Timer Id */
                                  );


/**
* \brief Delete or Deallocate the timer.
*
* \return Status code
* \retval #PH_ERR_SUCCESS Operation successful.
* \retval #PH_PLATFORM_ERR_INVALID_TIMER Provided Timer ID is not created.
*/
phStatus_t phPlatform_Timer_Delete(phPlatform_DataParams_t   *pDataParams,                     /**< [In] Pointer to this layers parameter structure. */
                                   uint32_t                   dwTimerId                        /**< [In] Timer Id */
                                   );

/**
* \brief Execute the Callback registered to the timer.
*
* \return Status code
* \retval #PH_ERR_SUCCESS Operation successful.
* \retval Other Depending on implementation and underlying component.
* NOT USED
*/
phStatus_t phPlatform_Timer_ExecCallback(phPlatform_DataParams_t   *pDataParams,               /**< [In] Pointer to this layers parameter structure. */
                                         uint32_t                   dwTimerId                  /**< [In] Timer Id */
                                         );
/** \} */

/** \} */