M480 BSP V3.05.006
The Board Support Package for M480 Series
Data Structures | Macros | Functions
sclib.h File Reference

Smartcard library header file. More...

#include "NuMicro.h"

Go to the source code of this file.

Data Structures

struct  SCLIB_CARD_INFO_T
 A structure holds smartcard information. More...
 

Macros

#define SCLIB_MAX_ATR_LEN
 
#define SCLIB_MIN_ATR_LEN
 
#define SCLIB_PROTOCOL_UNDEFINED
 
#define SCLIB_PROTOCOL_T0
 
#define SCLIB_PROTOCOL_T1
 
#define SCLIB_SUCCESS
 
#define SCLIB_ERR_CARD_REMOVED
 
#define SCLIB_ERR_OVER_RUN
 
#define SCLIB_ERR_PARITY_ERROR
 
#define SCLIB_ERR_NO_STOP
 
#define SCLIB_ERR_SILENT_BYTE
 
#define SCLIB_ERR_READ
 
#define SCLIB_ERR_WRITE
 
#define SCLIB_ERR_TIME0OUT
 
#define SCLIB_ERR_TIME1OUT
 
#define SCLIB_ERR_TIME2OUT
 
#define SCLIB_ERR_AUTOCONVENTION
 
#define SCLIB_ERR_CLOCK
 
#define SCLIB_ERR_ATR_UNRECOGNIZED
 
#define SCLIB_ERR_ATR_INVALID_PARAM
 
#define SCLIB_ERR_ATR_INVALID_TCK
 
#define SCLIB_ERR_PPS
 
#define SCLIB_ERR_T1_PROTOCOL
 
#define SCLIB_ERR_T1_ABORT_RECEIVED
 
#define SCLIB_ERR_T1_RESYNCH_RECEIVED
 
#define SCLIB_ERR_T1_VPP_ERROR_RECEIVED
 
#define SCLIB_ERR_T1_WTXRES_RECEIVED
 
#define SCLIB_ERR_T1_IFSRES_RECEIVED
 
#define SCLIB_ERR_T1_ABORTRES_RECEIVED
 
#define SCLIB_ERR_T1_CHECKSUM
 
#define SCLIB_ERR_T0_PROTOCOL
 
#define SCLIB_ERR_DEACTIVE
 
#define SCLIB_ERR_CARDBUSY
 

Functions

int32_t SCLIB_Activate (uint32_t num, uint32_t u32EMVCheck)
 Activate a smartcard. More...
 
int32_t SCLIB_ActivateDelay (uint32_t num, uint32_t u32EMVCheck, uint32_t u32Delay)
 Activate a smartcard with large delay between set VCC high and start CLK output. More...
 
int32_t SCLIB_ColdReset (uint32_t num)
 Cold reset a smartcard. More...
 
int32_t SCLIB_WarmReset (uint32_t num)
 Warm reset a smartcard. More...
 
void SCLIB_Deactivate (uint32_t num)
 Deactivate a smartcard. More...
 
int32_t SCLIB_GetCardInfo (uint32_t num, SCLIB_CARD_INFO_T *s_info)
 Get the card information (e.g., protocol selected, ATR...) after activation success. More...
 
int32_t SCLIB_StartTransmission (uint32_t num, uint8_t *cmdBuf, uint32_t cmdLen, uint8_t *rspBuf, uint32_t *rspLen)
 Start a smartcard transmission. More...
 
int32_t SCLIB_SetIFSD (uint32_t num, uint8_t size)
 Set interface device max information field size (IFSD) More...
 
__weak void SCLIB_RequestTimeExtension (uint32_t u32Protocol)
 A callback called by library while smartcard request for a time extension. More...
 
uint32_t SCLIB_CheckCDEvent (uint32_t num)
 Process card detect event in IRQ handler. More...
 
uint32_t SCLIB_CheckTimeOutEvent (uint32_t num)
 Process time out event in IRQ handler. More...
 
uint32_t SCLIB_CheckTxRxEvent (uint32_t num)
 Process card transmission event in IRQ handler. More...
 
uint32_t SCLIB_CheckErrorEvent (uint32_t num)
 Process error event in IRQ handler. More...
 
int32_t SCLIB_ResetAnyway (uint32_t num)
 Activate a smartcard without historical bytes check, this function can be called if SCLIB_Activate or SCLIB_ActivateDelay return an error. More...
 
int32_t SCLIB_SetSpecificAtrBR (uint32_t num, uint32_t br)
 Set a specific baud rate to catch ATR for a card which is not compatible with ISO-7816, this function should be called before SCLIB_Activate or SCLIB_ActivateDelay. More...
 

Detailed Description

Smartcard library header file.

Version
V1.00

SPDX-License-Identifier: Apache-2.0

Definition in file sclib.h.