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_ncn8025.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, 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_NCN8025_H_
AnnaBridge 189:f392fc9709a3 32 #define _FSL_SMARTCARD_PHY_NCN8025_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_ncn8025_driver
AnnaBridge 189:f392fc9709a3 38 * @{
AnnaBridge 189:f392fc9709a3 39 */
AnnaBridge 189:f392fc9709a3 40
AnnaBridge 189:f392fc9709a3 41 /*! @file */
AnnaBridge 189:f392fc9709a3 42
AnnaBridge 189:f392fc9709a3 43 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 44 * Definitions
AnnaBridge 189:f392fc9709a3 45 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 46
AnnaBridge 189:f392fc9709a3 47 /*! @brief SMARTCARD define which specify adjustment number of clock cycles during which ATR string has to be received
AnnaBridge 189:f392fc9709a3 48 */
AnnaBridge 189:f392fc9709a3 49 #define SMARTCARD_ATR_DURATION_ADJUSTMENT (360u)
AnnaBridge 189:f392fc9709a3 50
AnnaBridge 189:f392fc9709a3 51 /*! @brief SMARTCARD define which specify adjustment number of clock cycles until initial 'TS' character has to be
AnnaBridge 189:f392fc9709a3 52 * received */
AnnaBridge 189:f392fc9709a3 53 #define SMARTCARD_INIT_DELAY_CLOCK_CYCLES_ADJUSTMENT (4200u)
AnnaBridge 189:f392fc9709a3 54
AnnaBridge 189:f392fc9709a3 55 /*! @brief Masks for NCN8025 status register */
AnnaBridge 189:f392fc9709a3 56 #define SMARTCARD_NCN8025_STATUS_PRES (0x01u) /*!< SMARTCARD phy NCN8025 smartcard present status */
AnnaBridge 189:f392fc9709a3 57 #define SMARTCARD_NCN8025_STATUS_ACTIVE (0x02u) /*!< SMARTCARD phy NCN8025 smartcard active status */
AnnaBridge 189:f392fc9709a3 58 #define SMARTCARD_NCN8025_STATUS_FAULTY (0x04u) /*!< SMARTCARD phy NCN8025 smartcard faulty status */
AnnaBridge 189:f392fc9709a3 59 #define SMARTCARD_NCN8025_STATUS_CARD_REMOVED (0x08u) /*!< SMARTCARD phy NCN8025 smartcard removed status */
AnnaBridge 189:f392fc9709a3 60 #define SMARTCARD_NCN8025_STATUS_CARD_DEACTIVATED (0x10u) /*!< SMARTCARD phy NCN8025 smartcard deactivated status */
AnnaBridge 189:f392fc9709a3 61
AnnaBridge 189:f392fc9709a3 62 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 63 * API
AnnaBridge 189:f392fc9709a3 64 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 65
AnnaBridge 189:f392fc9709a3 66 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 67 extern "C" {
AnnaBridge 189:f392fc9709a3 68 #endif
AnnaBridge 189:f392fc9709a3 69
AnnaBridge 189:f392fc9709a3 70 /*!
AnnaBridge 189:f392fc9709a3 71 * @brief Fill in config structure with default values.
AnnaBridge 189:f392fc9709a3 72 *
AnnaBridge 189:f392fc9709a3 73 * @param config The smartcard user configuration structure which contains configuration structure of type
AnnaBridge 189:f392fc9709a3 74 * smartcard_interface_config_t.
AnnaBridge 189:f392fc9709a3 75 * Function fill in members:
AnnaBridge 189:f392fc9709a3 76 * clockToResetDelay = 42000,
AnnaBridge 189:f392fc9709a3 77 * vcc = kSmartcardVoltageClassB3_3V,
AnnaBridge 189:f392fc9709a3 78 * with default values.
AnnaBridge 189:f392fc9709a3 79 */
AnnaBridge 189:f392fc9709a3 80 void SMARTCARD_PHY_NCN8025_GetDefaultConfig(smartcard_interface_config_t *config);
AnnaBridge 189:f392fc9709a3 81
AnnaBridge 189:f392fc9709a3 82 /*!
AnnaBridge 189:f392fc9709a3 83 * @brief Initializes an SMARTCARD interface instance for operation.
AnnaBridge 189:f392fc9709a3 84 *
AnnaBridge 189:f392fc9709a3 85 * @param base The SMARTCARD peripheral base address.
AnnaBridge 189:f392fc9709a3 86 * @param config The user configuration structure of type smartcard_interface_config_t. The user
AnnaBridge 189:f392fc9709a3 87 * can call to fill out configuration structure function SMARTCARD_PHY_NCN8025_GetDefaultConfig().
AnnaBridge 189:f392fc9709a3 88 * @param srcClock_Hz Smartcard clock generation module source clock.
AnnaBridge 189:f392fc9709a3 89 *
AnnaBridge 189:f392fc9709a3 90 * @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError in case of error.
AnnaBridge 189:f392fc9709a3 91 */
AnnaBridge 189:f392fc9709a3 92 status_t SMARTCARD_PHY_NCN8025_Init(void *base, smartcard_interface_config_t const *config, uint32_t srcClock_Hz);
AnnaBridge 189:f392fc9709a3 93
AnnaBridge 189:f392fc9709a3 94 /*!
AnnaBridge 189:f392fc9709a3 95 * @brief De-initializes an SMARTCARD interface. Stops smartcard clock and disable VCC.
AnnaBridge 189:f392fc9709a3 96 *
AnnaBridge 189:f392fc9709a3 97 * @param base The SMARTCARD peripheral module base address.
AnnaBridge 189:f392fc9709a3 98 * @param config The user configuration structure of type smartcard_interface_config_t.
AnnaBridge 189:f392fc9709a3 99 */
AnnaBridge 189:f392fc9709a3 100 void SMARTCARD_PHY_NCN8025_Deinit(void *base, smartcard_interface_config_t *config);
AnnaBridge 189:f392fc9709a3 101
AnnaBridge 189:f392fc9709a3 102 /*!
AnnaBridge 189:f392fc9709a3 103 * @brief Activates the smart card IC.
AnnaBridge 189:f392fc9709a3 104 *
AnnaBridge 189:f392fc9709a3 105 * @param base The SMARTCARD peripheral module base address.
AnnaBridge 189:f392fc9709a3 106 * @param context A pointer to a smartcard driver context structure.
AnnaBridge 189:f392fc9709a3 107 * @param resetType type of reset to be performed, possible values
AnnaBridge 189:f392fc9709a3 108 * = kSmartcardColdReset, kSmartcardWarmReset
AnnaBridge 189:f392fc9709a3 109 *
AnnaBridge 189:f392fc9709a3 110 * @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError in case of error.
AnnaBridge 189:f392fc9709a3 111 */
AnnaBridge 189:f392fc9709a3 112 status_t SMARTCARD_PHY_NCN8025_Activate(void *base, smartcard_context_t *context, smartcard_reset_type_t resetType);
AnnaBridge 189:f392fc9709a3 113
AnnaBridge 189:f392fc9709a3 114 /*!
AnnaBridge 189:f392fc9709a3 115 * @brief De-activates the smart card IC.
AnnaBridge 189:f392fc9709a3 116 *
AnnaBridge 189:f392fc9709a3 117 * @param base The SMARTCARD peripheral module base address.
AnnaBridge 189:f392fc9709a3 118 * @param context A pointer to a smartcard driver context structure.
AnnaBridge 189:f392fc9709a3 119 *
AnnaBridge 189:f392fc9709a3 120 * @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError in case of error.
AnnaBridge 189:f392fc9709a3 121 */
AnnaBridge 189:f392fc9709a3 122 status_t SMARTCARD_PHY_NCN8025_Deactivate(void *base, smartcard_context_t *context);
AnnaBridge 189:f392fc9709a3 123
AnnaBridge 189:f392fc9709a3 124 /*!
AnnaBridge 189:f392fc9709a3 125 * @brief Controls SMARTCARD interface IC.
AnnaBridge 189:f392fc9709a3 126 *
AnnaBridge 189:f392fc9709a3 127 * @param base The SMARTCARD peripheral module base address.
AnnaBridge 189:f392fc9709a3 128 * @param context A pointer to a smartcard driver context structure.
AnnaBridge 189:f392fc9709a3 129 * @param control A interface command type.
AnnaBridge 189:f392fc9709a3 130 * @param param Integer value specific to control type
AnnaBridge 189:f392fc9709a3 131 *
AnnaBridge 189:f392fc9709a3 132 * @retval kStatus_SMARTCARD_Success or kStatus_SMARTCARD_OtherError in case of error.
AnnaBridge 189:f392fc9709a3 133 */
AnnaBridge 189:f392fc9709a3 134 status_t SMARTCARD_PHY_NCN8025_Control(void *base,
AnnaBridge 189:f392fc9709a3 135 smartcard_context_t *context,
AnnaBridge 189:f392fc9709a3 136 smartcard_interface_control_t control,
AnnaBridge 189:f392fc9709a3 137 uint32_t param);
AnnaBridge 189:f392fc9709a3 138
AnnaBridge 189:f392fc9709a3 139 /*!
AnnaBridge 189:f392fc9709a3 140 * @brief SMARTCARD interface IC IRQ ISR.
AnnaBridge 189:f392fc9709a3 141 *
AnnaBridge 189:f392fc9709a3 142 * @param base The SMARTCARD peripheral module base address.
AnnaBridge 189:f392fc9709a3 143 * @param context The smartcard context pointer.
AnnaBridge 189:f392fc9709a3 144 */
AnnaBridge 189:f392fc9709a3 145 void SMARTCARD_PHY_NCN8025_IRQHandler(void *base, smartcard_context_t *context);
AnnaBridge 189:f392fc9709a3 146 /*@}*/
AnnaBridge 189:f392fc9709a3 147
AnnaBridge 189:f392fc9709a3 148 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 149 }
AnnaBridge 189:f392fc9709a3 150 #endif
AnnaBridge 189:f392fc9709a3 151
AnnaBridge 189:f392fc9709a3 152 /*! @}*/
AnnaBridge 189:f392fc9709a3 153
AnnaBridge 189:f392fc9709a3 154 #endif /* _FSL_SMARTCARD_NCN8025_H_*/