pcsc-lite 1.9.9
ifdhandler.h
Go to the documentation of this file.
1/*
2 * MUSCLE SmartCard Development ( https://pcsclite.apdu.fr/ )
3 *
4 * Copyright (C) 1999-2004
5 * David Corcoran <corcoran@musclecard.com>
6 * Copyright (C) 2003-2004
7 * Damien Sauveron <damien.sauveron@labri.fr>
8 * Copyright (C) 2002-2011
9 * Ludovic Rousseau <ludovic.rousseau@free.fr>
10 *
11Redistribution and use in source and binary forms, with or without
12modification, are permitted provided that the following conditions
13are met:
14
151. Redistributions of source code must retain the above copyright
16 notice, this list of conditions and the following disclaimer.
172. Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
203. The name of the author may not be used to endorse or promote products
21 derived from this software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
251#ifndef _ifd_handler_h_
252#define _ifd_handler_h_
253
254#include <pcsclite.h>
255
256 /*
257 * List of data structures available to ifdhandler
258 */
281
282 typedef struct _ICC_STATE
283 {
287 UCHAR ICC_Type;
288 }
290
306
310 typedef struct _SCARD_IO_HEADER
311 {
312 DWORD Protocol;
313 DWORD Length;
314 }
316
317 /*
318 * The list of tags should be a lot more but this is all I use in the
319 * meantime
320 */
321#define TAG_IFD_ATR 0x0303
322#define TAG_IFD_SLOTNUM 0x0180
323#define TAG_IFD_SLOT_THREAD_SAFE 0x0FAC
324#define TAG_IFD_THREAD_SAFE 0x0FAD
325#define TAG_IFD_SLOTS_NUMBER 0x0FAE
326#define TAG_IFD_SIMULTANEOUS_ACCESS 0x0FAF
327#define TAG_IFD_POLLING_THREAD 0x0FB0
328#define TAG_IFD_POLLING_THREAD_KILLABLE 0x0FB1
329#define TAG_IFD_STOP_POLLING_THREAD 0x0FB2
330#define TAG_IFD_POLLING_THREAD_WITH_TIMEOUT 0x0FB3
331#define TAG_IFD_DEVICE_REMOVED 0x0FB4
333 /*
334 * IFD Handler version number enummerations
335 */
336#define IFD_HVERSION_1_0 0x00010000
337#define IFD_HVERSION_2_0 0x00020000
338#define IFD_HVERSION_3_0 0x00030000
339
340 /*
341 * List of defines available to ifdhandler
342 */
343#define IFD_POWER_UP 500
344#define IFD_POWER_DOWN 501
345#define IFD_RESET 502
347#define IFD_NEGOTIATE_PTS1 1
348#define IFD_NEGOTIATE_PTS2 2
349#define IFD_NEGOTIATE_PTS3 4
351#define IFD_SUCCESS 0
352#define IFD_ERROR_TAG 600
353#define IFD_ERROR_SET_FAILURE 601
354#define IFD_ERROR_VALUE_READ_ONLY 602
355#define IFD_ERROR_PTS_FAILURE 605
356#define IFD_ERROR_NOT_SUPPORTED 606
357#define IFD_PROTOCOL_NOT_SUPPORTED 607
358#define IFD_ERROR_POWER_ACTION 608
359#define IFD_ERROR_SWALLOW 609
360#define IFD_ERROR_EJECT 610
361#define IFD_ERROR_CONFISCATE 611
362#define IFD_COMMUNICATION_ERROR 612
363#define IFD_RESPONSE_TIMEOUT 613
364#define IFD_NOT_SUPPORTED 614
365#define IFD_ICC_PRESENT 615
366#define IFD_ICC_NOT_PRESENT 616
372#define IFD_NO_SUCH_DEVICE 617
373#define IFD_ERROR_INSUFFICIENT_BUFFER 618
375#ifndef RESPONSECODE_DEFINED_IN_WINTYPES_H
376 typedef long RESPONSECODE;
377#endif
378
379 /*
380 * If you want to compile a V2.0 IFDHandler, define IFDHANDLERv2
381 * before you include this file.
382 *
383 * By default it is setup for for most recent version of the API (V3.0)
384 */
385
386#ifndef IFDHANDLERv2
387
388 /*
389 * List of Defined Functions Available to IFD_Handler 3.0
390 *
391 * All the functions of IFD_Handler 2.0 are available
392 * IFDHCreateChannelByName() is new
393 * IFDHControl() API changed
394 */
395
486RESPONSECODE IFDHCreateChannelByName(DWORD Lun, LPSTR DeviceName);
487
519RESPONSECODE IFDHControl(DWORD Lun, DWORD dwControlCode, PUCHAR
520 TxBuffer, DWORD TxLength, PUCHAR RxBuffer, DWORD RxLength,
521 LPDWORD pdwBytesReturned);
522
523#else
524
531RESPONSECODE IFDHControl(DWORD Lun, PUCHAR TxBuffer, DWORD TxLength,
532 PUCHAR RxBuffer, PDWORD RxLength);
533
534#endif
535
536 /*
537 * common functions in IFD_Handler 2.0 and 3.0
538 */
580RESPONSECODE IFDHCreateChannel(DWORD Lun, DWORD Channel);
581
596RESPONSECODE IFDHCloseChannel(DWORD Lun);
597
662RESPONSECODE IFDHGetCapabilities(DWORD Lun, DWORD Tag, PDWORD Length,
663 PUCHAR Value);
664
686RESPONSECODE IFDHSetCapabilities(DWORD Lun, DWORD Tag, DWORD Length, PUCHAR Value);
687
717RESPONSECODE IFDHSetProtocolParameters(DWORD Lun, DWORD Protocol, UCHAR Flags,
718 UCHAR PTS1, UCHAR PTS2, UCHAR PTS3);
751RESPONSECODE IFDHPowerICC(DWORD Lun, DWORD Action, PUCHAR Atr, PDWORD
752 AtrLength);
753
805RESPONSECODE IFDHTransmitToICC(DWORD Lun, SCARD_IO_HEADER SendPci,
806 PUCHAR TxBuffer, DWORD TxLength, PUCHAR RxBuffer, PDWORD
807 RxLength, PSCARD_IO_HEADER RecvPci);
808
825RESPONSECODE IFDHICCPresence(DWORD Lun);
826
827#endif
RESPONSECODE IFDHCloseChannel(DWORD Lun)
This function should close the reader communication channel for the particular reader.
RESPONSECODE IFDHGetCapabilities(DWORD Lun, DWORD Tag, PDWORD Length, PUCHAR Value)
This function should get the slot/card capabilities for a particular slot/card specified by Lun.
RESPONSECODE IFDHSetProtocolParameters(DWORD Lun, DWORD Protocol, UCHAR Flags, UCHAR PTS1, UCHAR PTS2, UCHAR PTS3)
This function should set the Protocol Type Selection (PTS) of a particular card/slot using the three ...
RESPONSECODE IFDHSetCapabilities(DWORD Lun, DWORD Tag, DWORD Length, PUCHAR Value)
This function should set the slot/card capabilities for a particular slot/card specified by Lun.
RESPONSECODE IFDHCreateChannelByName(DWORD Lun, LPSTR DeviceName)
This function is required to open a communications channel to the port listed by DeviceName.
RESPONSECODE IFDHControl(DWORD Lun, DWORD dwControlCode, PUCHAR TxBuffer, DWORD TxLength, PUCHAR RxBuffer, DWORD RxLength, LPDWORD pdwBytesReturned)
This function performs a data exchange with the reader (not the card) specified by Lun.
RESPONSECODE IFDHICCPresence(DWORD Lun)
This function returns the status of the card inserted in the reader/slot specified by Lun.
RESPONSECODE IFDHTransmitToICC(DWORD Lun, SCARD_IO_HEADER SendPci, PUCHAR TxBuffer, DWORD TxLength, PUCHAR RxBuffer, PDWORD RxLength, PSCARD_IO_HEADER RecvPci)
This function performs an APDU exchange with the card/slot specified by Lun.
RESPONSECODE IFDHCreateChannel(DWORD Lun, DWORD Channel)
This function is required to open a communications channel to the port listed by Channel.
RESPONSECODE IFDHPowerICC(DWORD Lun, DWORD Action, PUCHAR Atr, PDWORD AtrLength)
This function controls the power and reset signals of the smart card reader at the particular reader/...
struct _SCARD_IO_HEADER SCARD_IO_HEADER
Use by SCardTransmit()
This keeps a list of defines for pcsc-lite.
#define MAX_ATR_SIZE
Maximum ATR size.
Definition pcsclite.h:59
DWORD User_Auth_Device
Tag 0x0142.
Definition ifdhandler.h:276
LPSTR Vendor_Name
Tag 0x0100.
Definition ifdhandler.h:261
DWORD IFD_Version
Tag 0x0102.
Definition ifdhandler.h:263
DWORD Default_Data_Rate
Tag 0x0123.
Definition ifdhandler.h:270
DWORD Power_Mgmt
Tag 0x0131.
Definition ifdhandler.h:274
DWORD Max_Data_Rate
Tag 0x0124.
Definition ifdhandler.h:271
DWORD Synch_Supported
Tag 0x0126.
Definition ifdhandler.h:273
DWORD Card_Auth_Devices
Tag 0x0140.
Definition ifdhandler.h:275
DWORD IFD_Channel_ID
Tag 0x0110.
Definition ifdhandler.h:265
DWORD Default_Clock
Tag 0x0121.
Definition ifdhandler.h:268
DWORD Vendor_Features
Tag 0x0180 - 0x01F0 User Defined.
Definition ifdhandler.h:278
DWORD Mechanics_Supported
Tag 0x0150.
Definition ifdhandler.h:277
LPSTR IFD_Type
Tag 0x0101.
Definition ifdhandler.h:262
DWORD Max_IFSD
Tag 0x0125.
Definition ifdhandler.h:272
DWORD Asynch_Supported
Tag 0x0120.
Definition ifdhandler.h:267
LPSTR IFD_Serial
Tag 0x0103.
Definition ifdhandler.h:264
DWORD Max_Clock
Tag 0x0122.
Definition ifdhandler.h:269
UCHAR ICC_Interface_Status
Tag 0x0301.
Definition ifdhandler.h:285
UCHAR ICC_Presence
Tag 0x0300.
Definition ifdhandler.h:284
UCHAR ATR[MAX_ATR_SIZE]
Tag 0x0303.
Definition ifdhandler.h:286
UCHAR ICC_Type
Tag 0x0304.
Definition ifdhandler.h:287
DWORD Current_Clock
Tag 0x0202.
Definition ifdhandler.h:294
DWORD Current_F
Tag 0x0203.
Definition ifdhandler.h:295
DWORD Current_D
Tag 0x0204.
Definition ifdhandler.h:296
DWORD Current_BWT
Tag 0x0209.
Definition ifdhandler.h:301
DWORD Current_EBC
Tag 0x020B.
Definition ifdhandler.h:303
DWORD Current_CWT
Tag 0x020A.
Definition ifdhandler.h:302
DWORD Current_IFSC
Tag 0x0207.
Definition ifdhandler.h:299
DWORD Current_N
Tag 0x0205.
Definition ifdhandler.h:297
DWORD Current_W
Tag 0x0206.
Definition ifdhandler.h:298
DWORD Protocol_Type
Tag 0x0201.
Definition ifdhandler.h:293
DWORD Current_IFSD
Tag 0x0208.
Definition ifdhandler.h:300
Use by SCardTransmit()
Definition ifdhandler.h:311