mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_UBRIDGE/TOOLCHAIN_GCC_ARM/fsl_smartcard_phy_ncn8025.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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