Logo Search packages:      
Sourcecode: pcsc-lite version File versions  Download package

pcsclite.h

Go to the documentation of this file.
/*
 * MUSCLE SmartCard Development ( http://www.linuxnet.com )
 *
 * Copyright (C) 1999-2004
 *  David Corcoran <corcoran@linuxnet.com>
 *  Ludovic Rousseau <ludovic.rousseau@free.fr>
 *
 * $Id: pcsclite.h,v 1.1.1.6 2006-08-11 18:49:10 rousseau Exp $
 */

/**
 * @file
 * @brief This keeps a list of defines for pcsc-lite.
 */

#ifndef __pcsclite_h__
#define __pcsclite_h__

#include <wintypes.h>

#ifdef __cplusplus
extern "C"
{
#endif

#ifdef WIN32
#include <winscard.h>
#else
typedef long SCARDCONTEXT;
typedef SCARDCONTEXT *PSCARDCONTEXT;
typedef SCARDCONTEXT *LPSCARDCONTEXT;
typedef long SCARDHANDLE;
typedef SCARDHANDLE *PSCARDHANDLE;
typedef SCARDHANDLE *LPSCARDHANDLE;

00036 #define MAX_ATR_SIZE                33    /**< Maximum ATR size */

typedef struct
{
      const char *szReader;
      void *pvUserData;
      unsigned long dwCurrentState;
      unsigned long dwEventState;
      unsigned long cbAtr;
      unsigned char rgbAtr[MAX_ATR_SIZE];
}
SCARD_READERSTATE_A;

typedef SCARD_READERSTATE_A SCARD_READERSTATE, *PSCARD_READERSTATE_A,
      *LPSCARD_READERSTATE_A;

typedef struct _SCARD_IO_REQUEST
{
      unsigned long dwProtocol;     /* Protocol identifier */
      unsigned long cbPciLength;    /* Protocol Control Inf Length */
}
SCARD_IO_REQUEST, *PSCARD_IO_REQUEST, *LPSCARD_IO_REQUEST;

typedef const SCARD_IO_REQUEST *LPCSCARD_IO_REQUEST;

extern SCARD_IO_REQUEST g_rgSCardT0Pci, g_rgSCardT1Pci,
      g_rgSCardRawPci;

#define SCARD_PCI_T0    (&g_rgSCardT0Pci)
#define SCARD_PCI_T1    (&g_rgSCardT1Pci)
#define SCARD_PCI_RAW   (&g_rgSCardRawPci)

#define SCARD_S_SUCCESS             0x00000000
#define SCARD_E_CANCELLED           0x80100002
#define SCARD_E_CANT_DISPOSE        0x8010000E
#define SCARD_E_INSUFFICIENT_BUFFER 0x80100008
#define SCARD_E_INVALID_ATR         0x80100015
#define SCARD_E_INVALID_HANDLE            0x80100003
#define SCARD_E_INVALID_PARAMETER   0x80100004
#define SCARD_E_INVALID_TARGET            0x80100005
#define SCARD_E_INVALID_VALUE       0x80100011
#define SCARD_E_NO_MEMORY           0x80100006
#define SCARD_F_COMM_ERROR          0x80100013
#define SCARD_F_INTERNAL_ERROR            0x80100001
#define SCARD_F_UNKNOWN_ERROR       0x80100014
#define SCARD_F_WAITED_TOO_LONG           0x80100007
#define SCARD_E_UNKNOWN_READER            0x80100009
#define SCARD_E_TIMEOUT             0x8010000A
#define SCARD_E_SHARING_VIOLATION   0x8010000B
#define SCARD_E_NO_SMARTCARD        0x8010000C
#define SCARD_E_UNKNOWN_CARD        0x8010000D
#define SCARD_E_PROTO_MISMATCH            0x8010000F
#define SCARD_E_NOT_READY           0x80100010
#define SCARD_E_SYSTEM_CANCELLED    0x80100012
#define SCARD_E_NOT_TRANSACTED            0x80100016
#define SCARD_E_READER_UNAVAILABLE  0x80100017

#define SCARD_W_UNSUPPORTED_CARD    0x80100065
#define SCARD_W_UNRESPONSIVE_CARD   0x80100066
#define SCARD_W_UNPOWERED_CARD            0x80100067
#define SCARD_W_RESET_CARD          0x80100068
#define SCARD_W_REMOVED_CARD        0x80100069

#define SCARD_E_PCI_TOO_SMALL       0x80100019
#define SCARD_E_READER_UNSUPPORTED  0x8010001A
#define SCARD_E_DUPLICATE_READER    0x8010001B
#define SCARD_E_CARD_UNSUPPORTED    0x8010001C
#define SCARD_E_NO_SERVICE          0x8010001D
#define SCARD_E_SERVICE_STOPPED           0x8010001E

00106 #define SCARD_SCOPE_USER            0x0000      /**< Scope in user space */
00107 #define SCARD_SCOPE_TERMINAL        0x0001      /**< Scope in terminal */
00108 #define SCARD_SCOPE_SYSTEM          0x0002      /**< Scope in system */

00110 #define SCARD_PROTOCOL_UNSET        0x0000      /**< protocol not set */
00111 #define SCARD_PROTOCOL_T0           0x0001      /**< T=0 active protocol. */
00112 #define SCARD_PROTOCOL_T1           0x0002      /**< T=1 active protocol. */
00113 #define SCARD_PROTOCOL_RAW          0x0004      /**< Raw active protocol. */
00114 #define SCARD_PROTOCOL_T15          0x0008      /**< T=15 protocol. */

00116 #define SCARD_PROTOCOL_ANY          (SCARD_PROTOCOL_T0|SCARD_PROTOCOL_T1)     /**< IFD determines prot. */

00118 #define SCARD_SHARE_EXCLUSIVE       0x0001      /**< Exclusive mode only */
00119 #define SCARD_SHARE_SHARED          0x0002      /**< Shared mode only */
00120 #define SCARD_SHARE_DIRECT          0x0003      /**< Raw mode only */

00122 #define SCARD_LEAVE_CARD            0x0000      /**< Do nothing on close */
00123 #define SCARD_RESET_CARD            0x0001      /**< Reset on close */
00124 #define SCARD_UNPOWER_CARD          0x0002      /**< Power down on close */
00125 #define SCARD_EJECT_CARD            0x0003      /**< Eject on close */

00127 #define SCARD_UNKNOWN               0x0001      /**< Unknown state */
00128 #define SCARD_ABSENT                0x0002      /**< Card is absent */
00129 #define SCARD_PRESENT               0x0004      /**< Card is present */
00130 #define SCARD_SWALLOWED             0x0008      /**< Card not powered */
00131 #define SCARD_POWERED               0x0010      /**< Card is powered */
00132 #define SCARD_NEGOTIABLE            0x0020      /**< Ready for PTS */
00133 #define SCARD_SPECIFIC              0x0040      /**< PTS has been set */

00135 #define SCARD_STATE_UNAWARE         0x0000      /**< App wants status */
00136 #define SCARD_STATE_IGNORE          0x0001      /**< Ignore this reader */
00137 #define SCARD_STATE_CHANGED         0x0002      /**< State has changed */
00138 #define SCARD_STATE_UNKNOWN         0x0004      /**< Reader unknown */
00139 #define SCARD_STATE_UNAVAILABLE           0x0008      /**< Status unavailable */
00140 #define SCARD_STATE_EMPTY           0x0010      /**< Card removed */
00141 #define SCARD_STATE_PRESENT         0x0020      /**< Card inserted */
00142 #define SCARD_STATE_ATRMATCH        0x0040      /**< ATR matches card */
00143 #define SCARD_STATE_EXCLUSIVE       0x0080      /**< Exclusive Mode */
00144 #define SCARD_STATE_INUSE           0x0100      /**< Shared Mode */
00145 #define SCARD_STATE_MUTE            0x0200      /**< Unresponsive card */
00146 #define SCARD_STATE_UNPOWERED       0x0400      /**< Unpowered card */

#endif

/** PC/SC Lite specific extensions */
00151 #define SCARD_W_INSERTED_CARD       0x8010006A
#define SCARD_E_UNSUPPORTED_FEATURE 0x8010001F

00154 #define SCARD_SCOPE_GLOBAL          0x0003      /**< Scope is global */

00156 #define SCARD_RESET                 0x0001      /**< Card was reset */
00157 #define SCARD_INSERTED              0x0002      /**< Card was inserted */
00158 #define SCARD_REMOVED               0x0004      /**< Card was removed */

00160 #define BLOCK_STATUS_RESUME         0x00FF      /**< Normal resume */
00161 #define BLOCK_STATUS_BLOCKING       0x00FA      /**< Function is blocking */

#define PCSCLITE_CONFIG_DIR         "/etc"

#ifndef USE_IPCDIR
#define PCSCLITE_IPC_DIR            "/var/run"
#else
#define PCSCLITE_IPC_DIR            USE_IPCDIR
#endif

#define PCSCLITE_READER_CONFIG            PCSCLITE_CONFIG_DIR "/reader.conf"
#define PCSCLITE_PUBSHM_FILE        PCSCLITE_IPC_DIR "/pcscd.pub"
#define PCSCLITE_CSOCK_NAME         PCSCLITE_IPC_DIR "/pcscd.comm"

00175 #define PCSCLITE_SVC_IDENTITY       0x01030000  /**< Service ID */

#ifndef INFINITE
00178 #define INFINITE              0xFFFFFFFF  /**< Infinite timeout */
#endif
00180 #define PCSCLITE_INFINITE_TIMEOUT   4320000           /**< 50 day infinite t/o */

00182 #define PCSCLITE_VERSION_NUMBER           "1.3.2"     /**< Current version */
00183 #define PCSCLITE_CLIENT_ATTEMPTS    120         /**< Attempts to reach sv */
00184 #define PCSCLITE_MCLIENT_ATTEMPTS   20          /**< Attempts to reach sv */
00185 #define PCSCLITE_STATUS_POLL_RATE   400000            /**< Status polling rate */
00186 #define PCSCLITE_MSG_KEY_LEN        16          /**< App ID key length */
00187 #define PCSCLITE_RW_ATTEMPTS        100         /**< Attempts to rd/wrt */

/** Maximum applications */
00190 #define PCSCLITE_MAX_APPLICATIONS               16
/** Maximum contexts by application */
00192 #define PCSCLITE_MAX_APPLICATION_CONTEXTS       16
/** Maximum of applications contexts that pcscd can accept */
00194 #define PCSCLITE_MAX_APPLICATIONS_CONTEXTS \
      PCSCLITE_MAX_APPLICATIONS * PCSCLITE_MAX_APPLICATION_CONTEXTS
/** Maximum channels on a reader context */
00197 #define PCSCLITE_MAX_READER_CONTEXT_CHANNELS          16
/** Maximum channels on an application context */
00199 #define PCSCLITE_MAX_APPLICATION_CONTEXT_CHANNELS     16
/** Maximum readers context (a slot is count as a reader) */
00201 #define PCSCLITE_MAX_READERS_CONTEXTS                 16

/* PCSCLITE_MAX_READERS is deprecated
 * use PCSCLITE_MAX_READERS_CONTEXTS instead */
/* extern int PCSCLITE_MAX_READERS __attribute__ ((deprecated)); */

00207 #define PCSCLITE_MAX_THREADS        16    /**< Stat change threads */
00208 #define PCSCLITE_STATUS_WAIT        200000      /**< Status Change Sleep */
00209 #define PCSCLITE_TRANSACTION_TIMEOUT      40    /**< Transaction timeout */
#define MAX_READERNAME              52
#define MAX_LIBNAME                 100
#define MAX_DEVICENAME        255

#ifndef SCARD_ATR_LENGTH
00215 #define SCARD_ATR_LENGTH            MAX_ATR_SIZE      /**< Maximum ATR size */
#endif

/*
 * The message and buffer sizes must be multiples of 16.
 * The max message size must be at least large enough
 * to accomodate the transmit_struct
 */
00223 #define PCSCLITE_MAX_MESSAGE_SIZE   2048  /**< Transport msg len */
00224 #define MAX_BUFFER_SIZE             264   /**< Maximum Tx/Rx Buffer for short APDU */
00225 #define MAX_BUFFER_SIZE_EXTENDED    (4 + 3 + (1<<16) + 3)   /**< enhanced (64K + APDU + Lc + Le) Tx/Rx Buffer */
00226 #define PCSCLITE_SERVER_ATTEMPTS    5     /**< Attempts to reach cl */

/*
 * Gets a stringified error response
 */
char *pcsc_stringify_error(long);

#ifdef __cplusplus
}
#endif

#endif

Generated by  Doxygen 1.6.0   Back to index