pcsc-lite  1.8.14
readerfactory.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
5  * David Corcoran <corcoran@musclecard.com>
6  * Copyright (C) 2002-2011
7  * Ludovic Rousseau <ludovic.rousseau@free.fr>
8  *
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions
11 are met:
12 
13 1. Redistributions of source code must retain the above copyright
14  notice, this list of conditions and the following disclaimer.
15 2. Redistributions in binary form must reproduce the above copyright
16  notice, this list of conditions and the following disclaimer in the
17  documentation and/or other materials provided with the distribution.
18 3. The name of the author may not be used to endorse or promote products
19  derived from this software without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * $Id$
33  */
34 
40 #ifndef __readerfactory_h__
41 #define __readerfactory_h__
42 
43 #include <inttypes.h>
44 #include <pthread.h>
45 
46 #include "ifdhandler.h"
47 #include "pcscd.h"
48 #include "simclist.h"
49 
50  typedef struct
51  {
53  char *pcDevicename;
54  char *pcLibpath;
55  int channelId;
56  } SerialReader;
57 
58  struct FctMap_V2
59  {
60  /* shared with API 3.0 */
61  RESPONSECODE (*pvfCreateChannel)(DWORD, DWORD);
62  RESPONSECODE (*pvfCloseChannel)(DWORD);
63  RESPONSECODE (*pvfGetCapabilities)(DWORD, DWORD, PDWORD, PUCHAR);
64  RESPONSECODE (*pvfSetCapabilities)(DWORD, DWORD, DWORD, PUCHAR);
65  RESPONSECODE (*pvfSetProtocolParameters)(DWORD, DWORD, UCHAR, UCHAR,
66  UCHAR, UCHAR);
67  RESPONSECODE (*pvfPowerICC)(DWORD, DWORD, PUCHAR, PDWORD);
68  RESPONSECODE (*pvfTransmitToICC)(DWORD, SCARD_IO_HEADER, PUCHAR,
69  DWORD, PUCHAR, PDWORD, PSCARD_IO_HEADER);
70  RESPONSECODE (*pvfICCPresence)(DWORD);
71 
72  /* API v2.0 only */
73  RESPONSECODE (*pvfControl)(DWORD, PUCHAR, DWORD, PUCHAR, PDWORD);
74  };
75 
76  typedef struct FctMap_V2 FCT_MAP_V2;
77 
78  struct FctMap_V3
79  {
80  /* the common fields SHALL be in the same order as in FctMap_V2 */
81  RESPONSECODE (*pvfCreateChannel)(DWORD, DWORD);
82  RESPONSECODE (*pvfCloseChannel)(DWORD);
83  RESPONSECODE (*pvfGetCapabilities)(DWORD, DWORD, PDWORD, PUCHAR);
84  RESPONSECODE (*pvfSetCapabilities)(DWORD, DWORD, DWORD, PUCHAR);
85  RESPONSECODE (*pvfSetProtocolParameters)(DWORD, DWORD, UCHAR, UCHAR,
86  UCHAR, UCHAR);
87  RESPONSECODE (*pvfPowerICC)(DWORD, DWORD, PUCHAR, PDWORD);
88  RESPONSECODE (*pvfTransmitToICC)(DWORD, SCARD_IO_HEADER, PUCHAR,
89  DWORD, PUCHAR, PDWORD, PSCARD_IO_HEADER);
90  RESPONSECODE (*pvfICCPresence)(DWORD);
91 
92  /* API V3.0 only */
93  RESPONSECODE (*pvfControl)(DWORD, DWORD, LPCVOID, DWORD, LPVOID,
94  DWORD, LPDWORD);
95  RESPONSECODE (*pvfCreateChannelByName)(DWORD, LPSTR);
96  };
97 
98  typedef struct FctMap_V3 FCT_MAP_V3;
99 
101  {
104  };
105 
106  typedef struct RdrCliHandles RDR_CLIHANDLES;
107 
109  {
110  char *library;
111  char *device;
112  pthread_t pthThread;
113  RESPONSECODE (*pthCardEvent)(DWORD, int);
114  pthread_mutex_t *mMutex;
115  list_t handlesList;
116  pthread_mutex_t handlesList_lock;
118  union
119  {
122  } psFunctions;
124  LPVOID vHandle;
125  int version;
126  int port;
127  int slot;
128  volatile SCARDHANDLE hLockId;
129  int LockCount;
130  int32_t contexts;
131  int * pFeeds;
132  int * pMutex;
134  pthread_mutex_t powerState_lock;
135  int reference;
136  pthread_mutex_t reference_lock;
139  /* we can't use READER_STATE * here since eventhandler.h can't be
140  * included because of circular dependencies */
141  };
142 
143  typedef struct ReaderContext READER_CONTEXT;
144 
145  LONG _RefReader(READER_CONTEXT * sReader);
146  LONG _UnrefReader(READER_CONTEXT * sReader);
147 
148 #define REF_READER(reader) { LONG rv; Log2(PCSC_LOG_DEBUG, "RefReader() count was: %d", reader->reference); rv = _RefReader(reader); if (rv != SCARD_S_SUCCESS) return rv; }
149 #define UNREF_READER(reader) {Log2(PCSC_LOG_DEBUG, "UnrefReader() count was: %d", reader->reference); _UnrefReader(reader);}
150 
151  LONG RFAllocateReaderSpace(unsigned int);
152  LONG RFAddReader(const char *, int, const char *, const char *);
153  LONG RFRemoveReader(const char *, int);
154  LONG RFSetReaderName(READER_CONTEXT *, const char *, const char *, int);
155  LONG RFReaderInfo(const char *, /*@out@*/ struct ReaderContext **);
156  LONG RFReaderInfoById(SCARDHANDLE, /*@out@*/ struct ReaderContext **);
157  LONG RFCheckSharing(SCARDHANDLE, READER_CONTEXT *);
158  LONG RFLockSharing(SCARDHANDLE, READER_CONTEXT *);
159  LONG RFUnlockSharing(SCARDHANDLE, READER_CONTEXT *);
160  LONG RFUnlockAllSharing(SCARDHANDLE, READER_CONTEXT *);
161  LONG RFLoadReader(READER_CONTEXT *);
162  LONG RFBindFunctions(READER_CONTEXT *);
163  LONG RFUnBindFunctions(READER_CONTEXT *);
164  LONG RFUnloadReader(READER_CONTEXT *);
165  LONG RFInitializeReader(READER_CONTEXT *);
166  LONG RFUnInitializeReader(READER_CONTEXT *);
167  SCARDHANDLE RFCreateReaderHandle(READER_CONTEXT *);
168  LONG RFDestroyReaderHandle(SCARDHANDLE hCard);
169  LONG RFAddReaderHandle(READER_CONTEXT *, SCARDHANDLE);
170  LONG RFRemoveReaderHandle(READER_CONTEXT *, SCARDHANDLE);
171  LONG RFSetReaderEventState(READER_CONTEXT *, DWORD);
172  LONG RFCheckReaderEventState(READER_CONTEXT *, SCARDHANDLE);
173  LONG RFClearReaderEventState(READER_CONTEXT *, SCARDHANDLE);
174  LONG RFCheckReaderStatus(READER_CONTEXT *);
175  void RFCleanupReaders(void);
176  void RFWaitForReaderInit(void);
177  int RFStartSerialReaders(const char *readerconf);
178  void RFReCheckReaderConf(void);
179 
180 #endif
struct pubReaderStatesList * readerState
link to the reader state
list object
Definition: simclist.h:181
int32_t contexts
Number of open contexts.
volatile SCARDHANDLE hLockId
Lock Id.
int port
Port ID.
pthread_t pthThread
Event polling thread.
FCT_MAP_V2 psFunctions_v2
API V2.0.
RESPONSECODE(* pthCardEvent)(DWORD, int)
Card Event sync.
DWORD dwEventStatus
Recent event that must be sent.
int slot
Current Reader Slot.
union ReaderContext::@3 psFunctions
driver functions
int * pMutex
Number of client to mutex.
pthread_mutex_t handlesList_lock
lock for the above list
struct _SCARD_IO_HEADER SCARD_IO_HEADER
Use by SCardTransmit()
char * library
Library Path.
char * pcLibpath
LIBPATH.
Definition: readerfactory.h:54
FCT_MAP_V3 psFunctions_v3
API V3.0.
int * pFeeds
Number of shared client to lib.
int version
IFD Handler version number.
pthread_mutex_t * mMutex
Mutex for this connection.
int powerState
auto power off state
LONG SCARDHANDLE
hCard returned by SCardConnect()
Definition: pcsclite.h:57
int LockCount
number of recursive locks
LPVOID vHandle
Dlopen handle.
This keeps a list of defines for pcsc-lite.
pthread_mutex_t reference_lock
reference mutex
Define an exported public reader state structure so each application gets instant notification of cha...
Definition: eventhandler.h:50
char * device
Device Name.
int channelId
CHANNELID.
Definition: readerfactory.h:55
char * pcDevicename
DEVICENAME.
Definition: readerfactory.h:53
int reference
number of users of the structure
pthread_mutex_t powerState_lock
powerState mutex
char * pcFriendlyname
FRIENDLYNAME.
Definition: readerfactory.h:52
Use by SCardTransmit()
Definition: ifdhandler.h:313
SCARDHANDLE hCard
hCard for this connection