/* * Copyright (C) 2012-2014 NXP Semiconductors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * \addtogroup spi_libese * \brief ESE Lib layer interface to application * @{ */ #ifndef _PHNXPSPILIB_API_H_ #define _PHNXPSPILIB_API_H_ #include #include /** * \ingroup spi_libese * \brief Ese data buffer * */ typedef struct phNxpEse_data { uint32_t len; /*!< length of the buffer */ uint8_t *p_data; /*!< pointer to a buffer */ } phNxpEse_data; typedef enum jcop_dwnld_state{ JCP_DWNLD_IDLE, /* jcop dwnld is not ongoing*/ JCP_DWNLD_INIT, /* jcop dwonload init state*/ JCP_DWNLD_START, /* download started */ JCP_SPI_DWNLD_COMPLETE, /* jcop download complete in spi interface*/ JCP_DWP_DWNLD_COMPLETE, /* jcop download complete */ } phNxpEse_JcopDwnldState; /** * \ingroup spi_libese * \brief Ese Channel mode * */ typedef enum { ESE_MODE_NORMAL = 0, /*!< All wired transaction other OSU */ ESE_MODE_OSU /*!< Jcop Os update mode */ } phNxpEse_initMode; /** * \ingroup spi_libese * \brief Ese logical interface i.e. MediaType * */ typedef enum { ESE_PROTOCOL_MEDIA_SPI = 0x08, /*!< Secure SPI i.e. Trusted SE */ ESE_PROTOCOL_MEDIA_SPI_APDU_GATE =0xD0 /*!< REE */ } phNxpEse_mediaType; /** * \ingroup spi_libese * \brief Ese library init parameters to be set while calling phNxpEse_init * */ typedef struct phNxpEse_initParams { phNxpEse_initMode initMode; /*!< Ese communication mode */ phNxpEse_mediaType mediaType; /*!< Logical channel for Ese communication */ } phNxpEse_initParams; /*! * \brief SEAccess kit MW Android version */ #define NXP_ANDROID_VER (9U) /*! * \brief SEAccess kit MW Major version */ #define ESELIB_MW_VERSION_MAJ (0x0U) /*! * \brief SEAccess kit MW Minor version */ #define ESELIB_MW_VERSION_MIN (0x04) /****************************************************************************** * \ingroup spi_libese * * \brief This function is called by Jni/phNxpEse_open during the * initialization of the ESE. It initializes protocol stack instance variables * * \retval This function return ESESTATUS_SUCCES (0) in case of success * In case of failure returns other failure value. * ******************************************************************************/ ESESTATUS phNxpEse_init(phNxpEse_initParams initParams); /** * \ingroup spi_libese * \brief This function prepares the C-APDU, send to ESE and then receives the response from ESE, * decode it and returns data. * * \param[in] phNxpEse_data: Command to ESE * \param[out] phNxpEse_data: Response from ESE (Returned data to be freed after copying) * * \retval ESESTATUS_SUCCESS On Success ESESTATUS_SUCCESS else proper error code * */ ESESTATUS phNxpEse_Transceive(phNxpEse_data *pCmd, phNxpEse_data *pRsp); /****************************************************************************** * \ingroup spi_libese * * \brief This function is called by Jni/phNxpEse_close during the * de-initialization of the ESE. It de-initializes protocol stack instance variables * * \retval This function return ESESTATUS_SUCCES (0) in case of success * In case of failure returns other failure value. * ******************************************************************************/ ESESTATUS phNxpEse_deInit(void); /** * \ingroup spi_libese * \brief This function is used to set IFSC size * * \param[in] uint16_t IFSC_Size * * \retval ESESTATUS_SUCCESS Always return ESESTATUS_SUCCESS (0). * */ ESESTATUS phNxpEse_setIfs(uint16_t IFS_Size); ESESTATUS phNxpEse_setIfsc(uint16_t IFSC_Size); /** * \ingroup spi_libese * \brief This function suspends execution of the calling thread for * (at least) usec microseconds * * \param[in] void * * \retval ESESTATUS_SUCCESS Always return ESESTATUS_SUCCESS (0). * */ ESESTATUS phNxpEse_Sleep(uint32_t usec); /** * \ingroup spi_libese * \brief This function updates destination buffer with val * data in len size * * \param[in] buff - Array to be udpated * \param[in] val - value to be updated * \param[in] len - length of array to be updated * * \retval void * */ void* phNxpEse_memset(void *buff, int val, size_t len); /** * \ingroup spi_libese * \brief This function copies source buffer to destination buffer * data in len size * * \param[in] dest - Destination array to be updated * \param[in] src - Source array to be updated * \param[in] len - length of array to be updated * * \retval void * */ void* phNxpEse_memcpy(void *dest, const void *src, size_t len); /** * \ingroup spi_libese * \brief This function suspends allocate memory * * \param[in] uint32_t size * * \retval allocated memory. * */ void *phNxpEse_memalloc(uint32_t size); /** * \ingroup spi_libese * \brief This is utility function for freeeing heap memory allocated * * \param[in] ptr - Address pointer to previous allocation * * \retval void * */ void phNxpEse_free(void* ptr); /** @} */ #endif /* _PHNXPSPILIB_API_H_ */