ifdhandler.h

Go to the documentation of this file.

/*
 * MUSCLE SmartCard Development ( https://pcsclite.apdu.fr/ )
 *
 * Copyright (C) 1999-2004
 *  David Corcoran <corcoran@musclecard.com>
 * Copyright (C) 2003-2004
 *  Damien Sauveron <damien.sauveron@labri.fr>
 * Copyright (C) 2002-2024
 *  Ludovic Rousseau <ludovic.rousseau@free.fr>
 *
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
 
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
   derived from this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef _ifd_handler_h_
#define _ifd_handler_h_
 
#include <pcsclite.h>
 
    /*
     * List of data structures available to ifdhandler
     */
    typedef struct _DEVICE_CAPABILITIES
    {
        LPSTR Vendor_Name;      
        LPSTR IFD_Type;         
        DWORD IFD_Version;      
        LPSTR IFD_Serial;       
        DWORD IFD_Channel_ID;   
        DWORD Asynch_Supported; 
        DWORD Default_Clock;    
        DWORD Max_Clock;        
        DWORD Default_Data_Rate;    
        DWORD Max_Data_Rate;    
        DWORD Max_IFSD;         
        DWORD Synch_Supported;  
        DWORD Power_Mgmt;       
        DWORD Card_Auth_Devices;    
        DWORD User_Auth_Device; 
        DWORD Mechanics_Supported;  
        DWORD Vendor_Features;  
    }
    DEVICE_CAPABILITIES, *PDEVICE_CAPABILITIES;
 
    typedef struct _ICC_STATE
    {
        UCHAR ICC_Presence;     
        UCHAR ICC_Interface_Status; 
        UCHAR ATR[MAX_ATR_SIZE];    
        UCHAR ICC_Type;         
    }
    ICC_STATE, *PICC_STATE;
 
    typedef struct _PROTOCOL_OPTIONS
    {
        DWORD Protocol_Type;    
        DWORD Current_Clock;    
        DWORD Current_F;        
        DWORD Current_D;        
        DWORD Current_N;        
        DWORD Current_W;        
        DWORD Current_IFSC;     
        DWORD Current_IFSD;     
        DWORD Current_BWT;      
        DWORD Current_CWT;      
        DWORD Current_EBC;      
    }
    PROTOCOL_OPTIONS, *PPROTOCOL_OPTIONS;
 
    typedef struct _SCARD_IO_HEADER
    {
        DWORD Protocol;
        DWORD Length;
    }
    SCARD_IO_HEADER, *PSCARD_IO_HEADER;
 
    /*
     * The list of tags should be a lot more but this is all I use in the
     * meantime
     */
#define TAG_IFD_ATR                     0x0303  
#define TAG_IFD_SLOTNUM                 0x0180  
#define TAG_IFD_SLOT_THREAD_SAFE        0x0FAC  
#define TAG_IFD_THREAD_SAFE             0x0FAD  
#define TAG_IFD_SLOTS_NUMBER            0x0FAE  
#define TAG_IFD_SIMULTANEOUS_ACCESS     0x0FAF  
#define TAG_IFD_POLLING_THREAD          0x0FB0  
#define TAG_IFD_POLLING_THREAD_KILLABLE 0x0FB1  
#define TAG_IFD_STOP_POLLING_THREAD     0x0FB2  
#define TAG_IFD_POLLING_THREAD_WITH_TIMEOUT 0x0FB3  
#define TAG_IFD_DEVICE_REMOVED          0x0FB4  
    /*
     * IFD Handler version number enummerations
     */
#define IFD_HVERSION_1_0               0x00010000
#define IFD_HVERSION_2_0               0x00020000
#define IFD_HVERSION_3_0               0x00030000
 
    /*
     * List of defines available to ifdhandler
     */
#define IFD_POWER_UP            500 
#define IFD_POWER_DOWN          501 
#define IFD_RESET           502 
#define IFD_NEGOTIATE_PTS1      1   
#define IFD_NEGOTIATE_PTS2      2   
#define IFD_NEGOTIATE_PTS3              4   
#define IFD_SUCCESS         0   
#define IFD_ERROR_TAG           600 
#define IFD_ERROR_SET_FAILURE       601 
#define IFD_ERROR_VALUE_READ_ONLY   602 
#define IFD_ERROR_PTS_FAILURE       605 
#define IFD_ERROR_NOT_SUPPORTED     606
#define IFD_PROTOCOL_NOT_SUPPORTED  607 
#define IFD_ERROR_POWER_ACTION      608 
#define IFD_ERROR_SWALLOW       609
#define IFD_ERROR_EJECT         610
#define IFD_ERROR_CONFISCATE        611
#define IFD_COMMUNICATION_ERROR     612 
#define IFD_RESPONSE_TIMEOUT        613 
#define IFD_NOT_SUPPORTED       614 
#define IFD_ICC_PRESENT         615 
#define IFD_ICC_NOT_PRESENT     616 
#define IFD_NO_SUCH_DEVICE      617
#define IFD_ERROR_INSUFFICIENT_BUFFER   618 
#ifndef RESPONSECODE_DEFINED_IN_WINTYPES_H
    typedef long RESPONSECODE;
#endif
 
    /*
     * If you want to compile a V2.0 IFDHandler, define IFDHANDLERv2
     * before you include this file.
     *
     * By default it is setup for for most recent version of the API (V3.0)
     */
 
#ifndef IFDHANDLERv2
 
    /*
     * List of Defined Functions Available to IFD_Handler 3.0
     *
     * All the functions of IFD_Handler 2.0 are available
     * IFDHCreateChannelByName() is new
     * IFDHControl() API changed
     */
 
RESPONSECODE IFDHCreateChannelByName(DWORD Lun, LPSTR DeviceName);
 
RESPONSECODE IFDHControl(DWORD Lun, DWORD dwControlCode, PUCHAR
    TxBuffer, DWORD TxLength, PUCHAR RxBuffer, DWORD RxLength,
    LPDWORD pdwBytesReturned);
 
#else
 
RESPONSECODE IFDHControl(DWORD Lun, PUCHAR TxBuffer, DWORD TxLength,
    PUCHAR RxBuffer, PDWORD RxLength);
 
#endif
 
    /*
     * common functions in IFD_Handler 2.0 and 3.0
     */
RESPONSECODE IFDHCreateChannel(DWORD Lun, DWORD Channel);
 
RESPONSECODE IFDHCloseChannel(DWORD Lun);
 
RESPONSECODE IFDHGetCapabilities(DWORD Lun, DWORD Tag, PDWORD Length,
    PUCHAR Value);
 
RESPONSECODE IFDHSetCapabilities(DWORD Lun, DWORD Tag, DWORD Length, PUCHAR Value);
 
RESPONSECODE IFDHSetProtocolParameters(DWORD Lun, DWORD Protocol, UCHAR Flags,
    UCHAR PTS1, UCHAR PTS2, UCHAR PTS3);
RESPONSECODE IFDHPowerICC(DWORD Lun, DWORD Action, PUCHAR Atr, PDWORD
    AtrLength);
 
RESPONSECODE IFDHTransmitToICC(DWORD Lun, SCARD_IO_HEADER SendPci,
    PUCHAR TxBuffer, DWORD TxLength, PUCHAR RxBuffer, PDWORD
    RxLength, PSCARD_IO_HEADER RecvPci);
 
RESPONSECODE IFDHICCPresence(DWORD Lun);
 
#endif