pcsc-lite  1.8.20
ifdhandler.h
Go to the documentation of this file.
1 /*
2  * MUSCLE SmartCard Development ( http://pcsclite.alioth.debian.org/pcsclite.html )
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  *
11 Redistribution and use in source and binary forms, with or without
12 modification, are permitted provided that the following conditions
13 are met:
14 
15 1. Redistributions of source code must retain the above copyright
16  notice, this list of conditions and the following disclaimer.
17 2. 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.
20 3. 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 
23 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
252 #ifndef _ifd_handler_h_
253 #define _ifd_handler_h_
254 
255 #include <pcsclite.h>
256 
257  /*
258  * List of data structures available to ifdhandler
259  */
260  typedef struct _DEVICE_CAPABILITIES
261  {
262  LPSTR Vendor_Name;
263  LPSTR IFD_Type;
264  DWORD IFD_Version;
265  LPSTR IFD_Serial;
270  DWORD Max_Clock;
273  DWORD Max_IFSD;
275  DWORD Power_Mgmt;
280  }
282 
283  typedef struct _ICC_STATE
284  {
285  UCHAR ICC_Presence;
287  UCHAR ATR[MAX_ATR_SIZE];
288  UCHAR ICC_Type;
289  }
291 
292  typedef struct _PROTOCOL_OPTIONS
293  {
296  DWORD Current_F;
297  DWORD Current_D;
298  DWORD Current_N;
299  DWORD Current_W;
300  DWORD Current_IFSC;
301  DWORD Current_IFSD;
302  DWORD Current_BWT;
303  DWORD Current_CWT;
304  DWORD Current_EBC;
305  }
307 
311  typedef struct _SCARD_IO_HEADER
312  {
313  DWORD Protocol;
314  DWORD Length;
315  }
317 
318  /*
319  * The list of tags should be alot more but this is all I use in the
320  * meantime
321  */
322 #define TAG_IFD_ATR 0x0303
323 #define TAG_IFD_SLOTNUM 0x0180
324 #define TAG_IFD_SLOT_THREAD_SAFE 0x0FAC
325 #define TAG_IFD_THREAD_SAFE 0x0FAD
326 #define TAG_IFD_SLOTS_NUMBER 0x0FAE
327 #define TAG_IFD_SIMULTANEOUS_ACCESS 0x0FAF
328 #define TAG_IFD_POLLING_THREAD 0x0FB0
329 #define TAG_IFD_POLLING_THREAD_KILLABLE 0x0FB1
330 #define TAG_IFD_STOP_POLLING_THREAD 0x0FB2
331 #define TAG_IFD_POLLING_THREAD_WITH_TIMEOUT 0x0FB3
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 
486 RESPONSECODE IFDHCreateChannelByName(DWORD Lun, LPSTR DeviceName);
487 
519 RESPONSECODE IFDHControl(DWORD Lun, DWORD dwControlCode, PUCHAR
520  TxBuffer, DWORD TxLength, PUCHAR RxBuffer, DWORD RxLength,
521  LPDWORD pdwBytesReturned);
522 
523 #else
524 
531 RESPONSECODE 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  */
580 RESPONSECODE IFDHCreateChannel(DWORD Lun, DWORD Channel);
581 
596 RESPONSECODE IFDHCloseChannel(DWORD Lun);
597 
662 RESPONSECODE IFDHGetCapabilities(DWORD Lun, DWORD Tag, PDWORD Length,
663  PUCHAR Value);
664 
686 RESPONSECODE IFDHSetCapabilities(DWORD Lun, DWORD Tag, DWORD Length, PUCHAR Value);
687 
717 RESPONSECODE IFDHSetProtocolParameters(DWORD Lun, DWORD Protocol, UCHAR Flags,
718  UCHAR PTS1, UCHAR PTS2, UCHAR PTS3);
751 RESPONSECODE IFDHPowerICC(DWORD Lun, DWORD Action, PUCHAR Atr, PDWORD
752  AtrLength);
753 
805 RESPONSECODE IFDHTransmitToICC(DWORD Lun, SCARD_IO_HEADER SendPci,
806  PUCHAR TxBuffer, DWORD TxLength, PUCHAR RxBuffer, PDWORD
807  RxLength, PSCARD_IO_HEADER RecvPci);
808 
825 RESPONSECODE IFDHICCPresence(DWORD Lun);
826 
827 #endif
DWORD Card_Auth_Devices
Tag 0x0140.
Definition: ifdhandler.h:276
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.
DWORD Default_Data_Rate
Tag 0x0123.
Definition: ifdhandler.h:271
DWORD Max_Data_Rate
Tag 0x0124.
Definition: ifdhandler.h:272
UCHAR ICC_Interface_Status
Tag 0x0301.
Definition: ifdhandler.h:286
DWORD Max_Clock
Tag 0x0122.
Definition: ifdhandler.h:270
DWORD Default_Clock
Tag 0x0121.
Definition: ifdhandler.h:269
DWORD Current_D
Tag 0x0204.
Definition: ifdhandler.h:297
DWORD Current_BWT
Tag 0x0209.
Definition: ifdhandler.h:302
RESPONSECODE IFDHCloseChannel(DWORD Lun)
This function should close the reader communication channel for the particular reader.
RESPONSECODE IFDHCreateChannel(DWORD Lun, DWORD Channel)
This function is required to open a communications channel to the port listed by Channel.
DWORD Current_CWT
Tag 0x020A.
Definition: ifdhandler.h:303
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 ...
DWORD Protocol_Type
Tag 0x0201.
Definition: ifdhandler.h:294
UCHAR ICC_Presence
Tag 0x0300.
Definition: ifdhandler.h:285
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()
DWORD Current_IFSC
Tag 0x0207.
Definition: ifdhandler.h:300
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...
DWORD Current_IFSD
Tag 0x0208.
Definition: ifdhandler.h:301
DWORD User_Auth_Device
Tag 0x0142.
Definition: ifdhandler.h:277
DWORD Mechanics_Supported
Tag 0x0150.
Definition: ifdhandler.h:278
RESPONSECODE IFDHCreateChannelByName(DWORD Lun, LPSTR DeviceName)
This function is required to open a communications channel to the port listed by DeviceName.
LPSTR IFD_Type
Tag 0x0101.
Definition: ifdhandler.h:263
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...
DWORD IFD_Version
Tag 0x0102.
Definition: ifdhandler.h:264
DWORD Power_Mgmt
Tag 0x0131.
Definition: ifdhandler.h:275
DWORD IFD_Channel_ID
Tag 0x0110.
Definition: ifdhandler.h:266
DWORD Synch_Supported
Tag 0x0126.
Definition: ifdhandler.h:274
This keeps a list of defines for pcsc-lite.
DWORD Max_IFSD
Tag 0x0125.
Definition: ifdhandler.h:273
DWORD Vendor_Features
Tag 0x0180 - 0x01F0 User Defined.
Definition: ifdhandler.h:279
LPSTR Vendor_Name
Tag 0x0100.
Definition: ifdhandler.h:262
DWORD Current_N
Tag 0x0205.
Definition: ifdhandler.h:298
DWORD Current_F
Tag 0x0203.
Definition: ifdhandler.h:296
DWORD Current_Clock
Tag 0x0202.
Definition: ifdhandler.h:295
RESPONSECODE IFDHICCPresence(DWORD Lun)
This function returns the status of the card inserted in the reader/slot specified by Lun...
#define MAX_ATR_SIZE
Maximum ATR size.
Definition: pcsclite.h:59
DWORD Current_W
Tag 0x0206.
Definition: ifdhandler.h:299
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...
Use by SCardTransmit()
Definition: ifdhandler.h:311
DWORD Current_EBC
Tag 0x020B.
Definition: ifdhandler.h:304
DWORD Asynch_Supported
Tag 0x0120.
Definition: ifdhandler.h:268
UCHAR ICC_Type
Tag 0x0304.
Definition: ifdhandler.h:288
LPSTR IFD_Serial
Tag 0x0103.
Definition: ifdhandler.h:265