Diff: targets/TARGET_NUVOTON/TARGET_M451/device/StdDriver/m451_sc.h

Revision:

149:156823d33999

diff -r 21d94c44109e -r 156823d33999 targets/TARGET_NUVOTON/TARGET_M451/device/StdDriver/m451_sc.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/targets/TARGET_NUVOTON/TARGET_M451/device/StdDriver/m451_sc.h	Fri Oct 28 11:17:30 2016 +0100
@@ -0,0 +1,269 @@
+/**************************************************************************//**
+ * @file     sc.h
+ * @version  V3.00
+ * $Revision: 13 $
+ * $Date: 15/08/11 10:26a $
+ * @brief    M451 series Smartcard (SC) driver header file
+ *
+ * @note
+ * Copyright (C) 2013~2015 Nuvoton Technology Corp. All rights reserved.
+ *****************************************************************************/
+#ifndef __SC_H__
+#define __SC_H__
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+
+/** @addtogroup Standard_Driver Standard Driver
+  @{
+*/
+
+/** @addtogroup SC_Driver SC Driver
+  @{
+*/
+
+/** @addtogroup SC_EXPORTED_CONSTANTS SC Exported Constants
+  @{
+*/
+#define SC_INTERFACE_NUM        1                /*!< Smartcard interface numbers */ /* M451 series has only one SC interface */
+#define SC_PIN_STATE_HIGH       1                /*!< Smartcard pin status high   */
+#define SC_PIN_STATE_LOW        0                /*!< Smartcard pin status low    */
+#define SC_PIN_STATE_IGNORE     0xFFFFFFFF       /*!< Ignore pin status           */
+#define SC_CLK_ON               1                /*!< Smartcard clock on          */
+#define SC_CLK_OFF              0                /*!< Smartcard clock off         */
+
+#define SC_TMR_MODE_0                   (0ul << SC_TMRCTL0_OPMODE_Pos)     /*!<Timer Operation Mode 0, down count                                                      */
+#define SC_TMR_MODE_1                   (1ul << SC_TMRCTL0_OPMODE_Pos)     /*!<Timer Operation Mode 1, down count, start after detect start bit                        */
+#define SC_TMR_MODE_2                   (2ul << SC_TMRCTL0_OPMODE_Pos)     /*!<Timer Operation Mode 2, down count, start after receive start bit                       */
+#define SC_TMR_MODE_3                   (3ul << SC_TMRCTL0_OPMODE_Pos)     /*!<Timer Operation Mode 3, down count, use for activation, only timer 0 support this mode  */
+#define SC_TMR_MODE_4                   (4ul << SC_TMRCTL0_OPMODE_Pos)     /*!<Timer Operation Mode 4, down count with reload after timeout                            */
+#define SC_TMR_MODE_5                   (5ul << SC_TMRCTL0_OPMODE_Pos)     /*!<Timer Operation Mode 5, down count, start after detect start bit, reload after timeout  */
+#define SC_TMR_MODE_6                   (6ul << SC_TMRCTL0_OPMODE_Pos)     /*!<Timer Operation Mode 6, down count, start after receive start bit, reload after timeout */
+#define SC_TMR_MODE_7                   (7ul << SC_TMRCTL0_OPMODE_Pos)     /*!<Timer Operation Mode 7, down count, start and reload after detect start bit             */
+#define SC_TMR_MODE_8                   (8ul << SC_TMRCTL0_OPMODE_Pos)     /*!<Timer Operation Mode 8, up count                                                        */
+#define SC_TMR_MODE_F                   (0xF << SC_TMRCTL0_OPMODE_Pos)     /*!<Timer Operation Mode 15, down count, reload after detect start bit                      */
+
+
+/*@}*/ /* end of group SC_EXPORTED_CONSTANTS */
+
+
+/** @addtogroup SC_EXPORTED_FUNCTIONS SC Exported Functions
+  @{
+*/
+
+/**
+  * @brief Enable smartcard interrupt.
+  * @param[in] sc The pointer of smartcard module.
+  * @param[in] u32Mask Interrupt mask to be enabled. A combination of
+  *             - \ref SC_INTEN_ACERRIEN_Msk
+  *             - \ref SC_INTEN_RXTOIF_Msk
+  *             - \ref SC_INTEN_INITIEN_Msk
+  *             - \ref SC_INTEN_CDIEN_Msk
+  *             - \ref SC_INTEN_BGTIEN_Msk
+  *             - \ref SC_INTEN_TMR2IEN_Msk
+  *             - \ref SC_INTEN_TMR1IEN_Msk
+  *             - \ref SC_INTEN_TMR0IEN_Msk
+  *             - \ref SC_INTEN_TERRIEN_Msk
+  *             - \ref SC_INTEN_TBEIEN_Msk
+  *             - \ref SC_INTEN_RDAIEN_Msk
+  * @return None
+  * @details The macro is used to enable Auto-convention error interrupt, Receiver buffer time-out interrupt, Initial end interrupt,
+  *          Card detect interrupt, Block guard time interrupt, Timer2 interrupt, Timer1 interrupt, Timer0 interrupt,
+  *          Transfer error interrupt, Transmit buffer empty interrupt or Receive data reach trigger level interrupt.
+  * \hideinitializer
+  */
+#define SC_ENABLE_INT(sc, u32Mask) ((sc)->INTEN |= (u32Mask))
+
+/**
+  * @brief Disable smartcard interrupt.
+  * @param[in] sc The pointer of smartcard module.
+  * @param[in] u32Mask Interrupt mask to be disabled. A combination of
+  *             - \ref SC_INTEN_ACERRIEN_Msk
+  *             - \ref SC_INTEN_RXTOIF_Msk
+  *             - \ref SC_INTEN_INITIEN_Msk
+  *             - \ref SC_INTEN_CDIEN_Msk
+  *             - \ref SC_INTEN_BGTIEN_Msk
+  *             - \ref SC_INTEN_TMR2IEN_Msk
+  *             - \ref SC_INTEN_TMR1IEN_Msk
+  *             - \ref SC_INTEN_TMR0IEN_Msk
+  *             - \ref SC_INTEN_TERRIEN_Msk
+  *             - \ref SC_INTEN_TBEIEN_Msk
+  *             - \ref SC_INTEN_RDAIEN_Msk
+  * @return None
+  * @details The macro is used to disable Auto-convention error interrupt, Receiver buffer time-out interrupt, Initial end interrupt,
+  *          Card detect interrupt, Block guard time interrupt, Timer2 interrupt, Timer1 interrupt, Timer0 interrupt,
+  *          Transfer error interrupt, Transmit buffer empty interrupt or Receive data reach trigger level interrupt.
+  * \hideinitializer
+  */
+#define SC_DISABLE_INT(sc, u32Mask) ((sc)->INTEN &= ~(u32Mask))
+
+/**
+  * @brief This macro set VCC pin state of smartcard interface.
+  * @param[in] sc The pointer of smartcard module.
+  * @param[in] u32State Pin state of VCC pin, valid parameters are:
+  *                 \ref SC_PIN_STATE_HIGH    :Smartcard pin status high.
+  *                 \ref SC_PIN_STATE_LOW     :Smartcard pin status low.
+  * @return None
+  * @details User can set PWREN (SC_PINCTL[0]) and PWRINV (SC_PINCTL[11])to decide SC_PWR pin is in high or low level.
+  * \hideinitializer
+  */
+#define SC_SET_VCC_PIN(sc, u32State) \
+    do {\
+            while((sc)->PINCTL & SC_PINCTL_SYNC_Msk);\
+            if(u32State)\
+                (sc)->PINCTL |= SC_PINCTL_PWREN_Msk;\
+            else\
+                (sc)->PINCTL &= ~SC_PINCTL_PWREN_Msk;\
+    }while(0)
+
+
+/**
+  * @brief Set CLK output status.
+  * @param[in] sc The pointer of smartcard module.
+  * @param[in] u32OnOff Clock on or off for selected smartcard module, valid values are:
+  *                 \ref SC_CLK_ON    :Smartcard clock on.
+  *                 \ref SC_CLK_OFF   :Smartcard clock off.
+  * @return None
+  * @details User can set CLKKEEP (SC_PINCTL[6]) to decide SC_CLK pin always keeps free running or not.
+  * \hideinitializer
+  */
+#define SC_SET_CLK_PIN(sc, u32OnOff)\
+    do {\
+            while((sc)->PINCTL & SC_PINCTL_SYNC_Msk);\
+            if(u32OnOff)\
+                (sc)->PINCTL |= SC_PINCTL_CLKKEEP_Msk;\
+            else\
+                (sc)->PINCTL &= ~(SC_PINCTL_CLKKEEP_Msk);\
+    }while(0)
+
+/**
+  * @brief Set I/O pin state.
+  * @param[in] sc The pointer of smartcard module.
+  * @param[in] u32State Pin state of I/O pin, valid parameters are:
+  *                 \ref SC_PIN_STATE_HIGH    :Smartcard pin status high.
+  *                 \ref SC_PIN_STATE_LOW     :Smartcard pin status low.
+  * @return None
+  * @details User can set SCDOUT(SC_PINCTL[9]) to decide SCDOUT pin to high or low.
+  * \hideinitializer
+  */
+#define SC_SET_IO_PIN(sc, u32State)\
+    do {\
+            while((sc)->PINCTL & SC_PINCTL_SYNC_Msk);\
+            if(u32State)\
+                (sc)->PINCTL |= SC_PINCTL_SCDOUT_Msk;\
+            else\
+                (sc)->PINCTL &= ~SC_PINCTL_SCDOUT_Msk;\
+    }while(0)
+
+/**
+  * @brief Set RST pin state.
+  * @param[in] sc The pointer of smartcard module.
+  * @param[in] u32State Pin state of RST pin, valid parameters are:
+  *                 \ref SC_PIN_STATE_HIGH    :Smartcard pin status high.
+  *                 \ref SC_PIN_STATE_LOW     :Smartcard pin status low.
+  * @return None
+  * @details User can set SCRST(SC_PINCTL[1]) to decide SCRST pin to high or low.
+  * \hideinitializer
+  */
+#define SC_SET_RST_PIN(sc, u32State)\
+    do {\
+            while((sc)->PINCTL & SC_PINCTL_SYNC_Msk);\
+            if(u32State)\
+                (sc)->PINCTL |= SC_PINCTL_SCRST_Msk;\
+            else\
+                (sc)->PINCTL &= ~SC_PINCTL_SCRST_Msk;\
+    }while(0)
+
+/**
+  * @brief Read one byte from smartcard module receive FIFO.
+  * @param[in] sc The pointer of smartcard module.
+  * @return One byte read from receive FIFO.
+  * @details By reading DAT register, the SC will return an 8-bit received data.
+  * \hideinitializer
+  */
+#define SC_READ(sc) ((char)((sc)->DAT))
+
+/**
+  * @brief Write one byte to smartcard module transmit FIFO.
+  * @param[in] sc The pointer of smartcard module.
+  * @param[in] u8Data Data to write to transmit FIFO.
+  * @return None
+  * @details By writing data to DAT register, the SC will send out an 8-bit data.
+  * \hideinitializer
+  */
+#define SC_WRITE(sc, u8Data) ((sc)->DAT = (u8Data))
+
+/**
+  * @brief This macro set smartcard stop bit length.
+  * @param[in] sc The pointer of smartcard module.
+  * @param[in] u32Len Stop bit length, ether 1 or 2.
+  * @return None
+  * @details Stop bit length must be 1 for T = 1 protocol and 2 for T = 0 protocol.
+  * \hideinitializer
+  */
+#define SC_SET_STOP_BIT_LEN(sc, u32Len) ((sc)->CTL = ((sc)->CTL & ~SC_CTL_NSB_Msk) | ((u32Len) == 1 ? SC_CTL_NSB_Msk : 0))
+
+/**
+  * @brief Enable/Disable Tx error retry, and set Tx error retry count.
+  * @param[in] sc The pointer of smartcard module.
+  * @param[in] u32Count The number of times of Tx error retry count, between 0~8. 0 means disable Tx error retry.
+  * @return None
+  * @details This macro enable/disable transmitter retry function when parity error has occurred, and set error retry count.
+  */
+__STATIC_INLINE void SC_SetTxRetry(SC_T *sc, uint32_t u32Count)
+{
+    while((sc)->CTL & SC_CTL_SYNC_Msk);
+    if(u32Count == 0) {       // disable Tx error retry
+        (sc)->CTL &= ~(SC_CTL_TXRTY_Msk | SC_CTL_TXRTYEN_Msk);
+    } else {
+        (sc)->CTL = ((sc)->CTL & ~SC_CTL_TXRTY_Msk) | ((u32Count - 1) << SC_CTL_TXRTY_Pos) | SC_CTL_TXRTYEN_Msk;
+    }
+}
+
+/**
+  * @brief Enable/Disable Rx error retry, and set Rx error retry count.
+  * @param[in] sc The pointer of smartcard module.
+  * @param[in] u32Count The number of times of Rx error retry count, between 0~8. 0 means disable Rx error retry.
+  * @return None
+  * @details This macro enable/disable receiver retry function when parity error has occurred, and set error retry count.
+  */
+__STATIC_INLINE void  SC_SetRxRetry(SC_T *sc, uint32_t u32Count)
+{
+    while((sc)->CTL & SC_CTL_SYNC_Msk);
+    if(u32Count == 0) {       // disable Rx error retry
+        (sc)->CTL &= ~(SC_CTL_RXRTY_Msk | SC_CTL_RXRTYEN_Msk);
+    } else {
+        (sc)->CTL = ((sc)->CTL & ~SC_CTL_RXRTY_Msk) | ((u32Count - 1) << SC_CTL_RXRTY_Pos) | SC_CTL_RXRTYEN_Msk;
+    }
+}
+
+
+uint32_t SC_IsCardInserted(SC_T *sc);
+void SC_ClearFIFO(SC_T *sc);
+void SC_Close(SC_T *sc);
+void SC_Open(SC_T *sc, uint32_t u32CardDet, uint32_t u32PWR);
+void SC_ResetReader(SC_T *sc);
+void SC_SetBlockGuardTime(SC_T *sc, uint32_t u32BGT);
+void SC_SetCharGuardTime(SC_T *sc, uint32_t u32CGT);
+void SC_StopAllTimer(SC_T *sc);
+void SC_StartTimer(SC_T *sc, uint32_t u32TimerNum, uint32_t u32Mode, uint32_t u32ETUCount);
+void SC_StopTimer(SC_T *sc, uint32_t u32TimerNum);
+
+
+/*@}*/ /* end of group SC_EXPORTED_FUNCTIONS */
+
+/*@}*/ /* end of group SC_Driver */
+
+/*@}*/ /* end of group Standard_Driver */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif //__SC_H__
+
+/*** (C) COPYRIGHT 2013~2015 Nuvoton Technology Corp. ***/
+