mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_K82F/TOOLCHAIN_IAR/fsl_smartcard_phy_emvsim.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*
AnnaBridge 189:f392fc9709a3 2 * Copyright (c) 2015-2016, Freescale Semiconductor, Inc.
AnnaBridge 189:f392fc9709a3 3 * All rights reserved.
AnnaBridge 189:f392fc9709a3 4 *
AnnaBridge 189:f392fc9709a3 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 6 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 7 *
AnnaBridge 189:f392fc9709a3 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 189:f392fc9709a3 9 * of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 189:f392fc9709a3 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 189:f392fc9709a3 13 * other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 14 *
AnnaBridge 189:f392fc9709a3 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 189:f392fc9709a3 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 189:f392fc9709a3 17 * software without specific prior written permission.
AnnaBridge 189:f392fc9709a3 18 *
AnnaBridge 189:f392fc9709a3 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 189:f392fc9709a3 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 189:f392fc9709a3 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 189:f392fc9709a3 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 189:f392fc9709a3 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 189:f392fc9709a3 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 189:f392fc9709a3 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 189:f392fc9709a3 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 189:f392fc9709a3 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 29 */
AnnaBridge 189:f392fc9709a3 30
AnnaBridge 189:f392fc9709a3 31 #ifndef _FSL_SMARTCARD_PHY_EMVSIM_H_
AnnaBridge 189:f392fc9709a3 32 #define _FSL_SMARTCARD_PHY_EMVSIM_H_
AnnaBridge 189:f392fc9709a3 33
AnnaBridge 189:f392fc9709a3 34 #include "fsl_smartcard.h"
AnnaBridge 189:f392fc9709a3 35
AnnaBridge 189:f392fc9709a3 36 /*!
AnnaBridge 189:f392fc9709a3 37 * @addtogroup smartcard_phy_emvsim_driver
AnnaBridge 189:f392fc9709a3 38 * @{
AnnaBridge 189:f392fc9709a3 39 */
AnnaBridge 189:f392fc9709a3 40
AnnaBridge 189:f392fc9709a3 41
AnnaBridge 189:f392fc9709a3 42 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 43 * Definitions
AnnaBridge 189:f392fc9709a3 44 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 45
AnnaBridge 189:f392fc9709a3 46 /*! @brief Smart card define which specifies the adjustment number of clock cycles during which an ATR string has to be received.
AnnaBridge 189:f392fc9709a3 47 */
AnnaBridge 189:f392fc9709a3 48 #define SMARTCARD_ATR_DURATION_ADJUSTMENT (360u)
AnnaBridge 189:f392fc9709a3 49
AnnaBridge 189:f392fc9709a3 50 /*! @brief Smart card define which specifies the adjustment number of clock cycles until an initial 'TS' character has to be
AnnaBridge 189:f392fc9709a3 51 * received. */
AnnaBridge 189:f392fc9709a3 52 #define SMARTCARD_INIT_DELAY_CLOCK_CYCLES_ADJUSTMENT (4200u)
AnnaBridge 189:f392fc9709a3 53
AnnaBridge 189:f392fc9709a3 54 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 55 * API
AnnaBridge 189:f392fc9709a3 56 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 57
AnnaBridge 189:f392fc9709a3 58 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 59 extern "C" {
AnnaBridge 189:f392fc9709a3 60 #endif
AnnaBridge 189:f392fc9709a3 61
AnnaBridge 189:f392fc9709a3 62 /*!
AnnaBridge 189:f392fc9709a3 63 * @brief Fills in the smartcardInterfaceConfig structure with default values.
AnnaBridge 189:f392fc9709a3 64 *
AnnaBridge 189:f392fc9709a3 65 * @param config The user configuration structure of type smartcard_interface_config_t.
AnnaBridge 189:f392fc9709a3 66 * Function fill in members:
AnnaBridge 189:f392fc9709a3 67 * clockToResetDelay = 42000,
AnnaBridge 189:f392fc9709a3 68 * vcc = kSmartcardVoltageClassB3_3V,
AnnaBridge 189:f392fc9709a3 69 * with default values.
AnnaBridge 189:f392fc9709a3 70 */
AnnaBridge 189:f392fc9709a3 71 void SMARTCARD_PHY_EMVSIM_GetDefaultConfig(smartcard_interface_config_t *config);
AnnaBridge 189:f392fc9709a3 72
AnnaBridge 189:f392fc9709a3 73 /*!
AnnaBridge 189:f392fc9709a3 74 * @brief Configures a Smart card interface.
AnnaBridge 189:f392fc9709a3 75 *
AnnaBridge 189:f392fc9709a3 76 * @param base The Smart card peripheral module base address.
AnnaBridge 189:f392fc9709a3 77 * @param config The user configuration structure of type smartcard_interface_config_t. The user
AnnaBridge 189:f392fc9709a3 78 * is responsible to fill out the members of this structure and to pass the pointer of this structure
AnnaBridge 189:f392fc9709a3 79 * into this function or call SMARTCARD_PHY_EMVSIMInitUserConfigDefault to fill out structure with default values.
AnnaBridge 189:f392fc9709a3 80 * @param srcClock_Hz Smart card clock generation module source clock.
AnnaBridge 189:f392fc9709a3 81 *
AnnaBridge 189:f392fc9709a3 82 * @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError for an error.
AnnaBridge 189:f392fc9709a3 83 */
AnnaBridge 189:f392fc9709a3 84 status_t SMARTCARD_PHY_EMVSIM_Init(EMVSIM_Type *base, const smartcard_interface_config_t *config, uint32_t srcClock_Hz);
AnnaBridge 189:f392fc9709a3 85
AnnaBridge 189:f392fc9709a3 86 /*!
AnnaBridge 189:f392fc9709a3 87 * @brief De-initializes a Smart card interface, stops the Smart card clock, and disables the VCC.
AnnaBridge 189:f392fc9709a3 88 *
AnnaBridge 189:f392fc9709a3 89 * @param base Smart card peripheral module base address.
AnnaBridge 189:f392fc9709a3 90 * @param config Smart card configuration structure.
AnnaBridge 189:f392fc9709a3 91 */
AnnaBridge 189:f392fc9709a3 92 void SMARTCARD_PHY_EMVSIM_Deinit(EMVSIM_Type *base, const smartcard_interface_config_t *config);
AnnaBridge 189:f392fc9709a3 93
AnnaBridge 189:f392fc9709a3 94 /*!
AnnaBridge 189:f392fc9709a3 95 * @brief Activates the Smart card IC.
AnnaBridge 189:f392fc9709a3 96 *
AnnaBridge 189:f392fc9709a3 97 * @param base The EMVSIM peripheral base address.
AnnaBridge 189:f392fc9709a3 98 * @param context A pointer to a Smart card driver context structure.
AnnaBridge 189:f392fc9709a3 99 * @param resetType type of reset to be performed, possible values
AnnaBridge 189:f392fc9709a3 100 * = kSmartcardColdReset, kSmartcardWarmReset
AnnaBridge 189:f392fc9709a3 101 *
AnnaBridge 189:f392fc9709a3 102 * @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError for an error.
AnnaBridge 189:f392fc9709a3 103 */
AnnaBridge 189:f392fc9709a3 104 status_t SMARTCARD_PHY_EMVSIM_Activate(EMVSIM_Type *base,
AnnaBridge 189:f392fc9709a3 105 smartcard_context_t *context,
AnnaBridge 189:f392fc9709a3 106 smartcard_reset_type_t resetType);
AnnaBridge 189:f392fc9709a3 107
AnnaBridge 189:f392fc9709a3 108 /*!
AnnaBridge 189:f392fc9709a3 109 * @brief De-activates the Smart card IC.
AnnaBridge 189:f392fc9709a3 110 *
AnnaBridge 189:f392fc9709a3 111 * @param base The EMVSIM peripheral base address.
AnnaBridge 189:f392fc9709a3 112 * @param context A pointer to a Smart card driver context structure.
AnnaBridge 189:f392fc9709a3 113 *
AnnaBridge 189:f392fc9709a3 114 * @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError for an error.
AnnaBridge 189:f392fc9709a3 115 */
AnnaBridge 189:f392fc9709a3 116 status_t SMARTCARD_PHY_EMVSIM_Deactivate(EMVSIM_Type *base, smartcard_context_t *context);
AnnaBridge 189:f392fc9709a3 117
AnnaBridge 189:f392fc9709a3 118 /*!
AnnaBridge 189:f392fc9709a3 119 * @brief Controls the Smart card interface IC.
AnnaBridge 189:f392fc9709a3 120 *
AnnaBridge 189:f392fc9709a3 121 * @param base The EMVSIM peripheral base address.
AnnaBridge 189:f392fc9709a3 122 * @param context A pointer to a Smart card driver context structure.
AnnaBridge 189:f392fc9709a3 123 * @param control A interface command type.
AnnaBridge 189:f392fc9709a3 124 * @param param Integer value specific to control type
AnnaBridge 189:f392fc9709a3 125 *
AnnaBridge 189:f392fc9709a3 126 * @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError for an error.
AnnaBridge 189:f392fc9709a3 127 */
AnnaBridge 189:f392fc9709a3 128 status_t SMARTCARD_PHY_EMVSIM_Control(EMVSIM_Type *base,
AnnaBridge 189:f392fc9709a3 129 smartcard_context_t *context,
AnnaBridge 189:f392fc9709a3 130 smartcard_interface_control_t control,
AnnaBridge 189:f392fc9709a3 131 uint32_t param);
AnnaBridge 189:f392fc9709a3 132 /*@}*/
AnnaBridge 189:f392fc9709a3 133
AnnaBridge 189:f392fc9709a3 134 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 135 }
AnnaBridge 189:f392fc9709a3 136 #endif
AnnaBridge 189:f392fc9709a3 137
AnnaBridge 189:f392fc9709a3 138 /*! @}*/
AnnaBridge 189:f392fc9709a3 139
AnnaBridge 189:f392fc9709a3 140 #endif /* _FSL_SMARTCARD_PHY_EMVSIM_H_*/