[SmartcardServices-Changes] [36] trunk/SmartCardServices/src/PCSC/pcsclite.h
source_changes at macosforge.org
source_changes at macosforge.org
Thu Jul 30 03:56:49 PDT 2009
Revision: 36
http://trac.macosforge.org/projects/smartcardservices/changeset/36
Author: ludovic.rousseau at gmail.com
Date: 2009-07-30 03:56:49 -0700 (Thu, 30 Jul 2009)
Log Message:
-----------
add #define and Doxygen comments from pcsc-lite
Modified Paths:
--------------
trunk/SmartCardServices/src/PCSC/pcsclite.h
Modified: trunk/SmartCardServices/src/PCSC/pcsclite.h
===================================================================
--- trunk/SmartCardServices/src/PCSC/pcsclite.h 2009-07-30 09:39:18 UTC (rev 35)
+++ trunk/SmartCardServices/src/PCSC/pcsclite.h 2009-07-30 10:56:49 UTC (rev 36)
@@ -33,6 +33,8 @@
/**
* @file
* @brief This keeps a list of defines for pcsc-lite.
+ *
+ * Error codes from http://msdn.microsoft.com/en-us/library/aa924526.aspx
*/
#ifndef __pcsclite_h__
@@ -45,10 +47,10 @@
{
#endif
-typedef int32_t SCARDCONTEXT;
+typedef int32_t SCARDCONTEXT; /**< \p hContext returned by SCardEstablishContext() */
typedef SCARDCONTEXT *PSCARDCONTEXT;
typedef SCARDCONTEXT *LPSCARDCONTEXT;
-typedef int32_t SCARDHANDLE;
+typedef int32_t SCARDHANDLE; /**< \p hCard returned by SCardConnect() */
typedef SCARDHANDLE *PSCARDHANDLE;
typedef SCARDHANDLE *LPSCARDHANDLE;
@@ -76,10 +78,11 @@
typedef SCARD_READERSTATE_A SCARD_READERSTATE, *PSCARD_READERSTATE_A,
*LPSCARD_READERSTATE_A;
+/** Protocol Control Information (PCI) */
typedef struct _SCARD_IO_REQUEST
{
- uint32_t dwProtocol; /* Protocol identifier */
- uint32_t cbPciLength; /* Protocol Control Inf Length */
+ uint32_t dwProtocol; /**< Protocol identifier */
+ uint32_t cbPciLength; /**< Protocol Control Inf Length */
}
SCARD_IO_REQUEST, *PSCARD_IO_REQUEST, *LPSCARD_IO_REQUEST;
@@ -95,47 +98,75 @@
#pragma pack(pop)
#endif
-#define SCARD_PCI_T0 (&g_rgSCardT0Pci)
-#define SCARD_PCI_T1 (&g_rgSCardT1Pci)
-#define SCARD_PCI_RAW (&g_rgSCardRawPci)
+#define SCARD_PCI_T0 (&g_rgSCardT0Pci) /**< protocol control information (PCI) for T=0 */
+#define SCARD_PCI_T1 (&g_rgSCardT1Pci) /**< protocol control information (PCI) for T=1 */
+#define SCARD_PCI_RAW (&g_rgSCardRawPci) /**< protocol control information (PCI) for RAW protocol */
-#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
+/** error codes from http://msdn.microsoft.com/en-us/library/aa924526.aspx
+ */
+#define SCARD_S_SUCCESS 0x00000000 /**< No error was encountered. */
+#define SCARD_F_INTERNAL_ERROR 0x80100001 /**< An internal consistency check failed. */
+#define SCARD_E_CANCELLED 0x80100002 /**< The action was cancelled by an SCardCancel request. */
+#define SCARD_E_INVALID_HANDLE 0x80100003 /**< The supplied handle was invalid. */
+#define SCARD_E_INVALID_PARAMETER 0x80100004 /**< One or more of the supplied parameters could not be properly interpreted. */
+#define SCARD_E_INVALID_TARGET 0x80100005 /**< Registry startup information is missing or invalid. */
+#define SCARD_E_NO_MEMORY 0x80100006 /**< Not enough memory available to complete this command. */
+#define SCARD_F_WAITED_TOO_LONG 0x80100007 /**< An internal consistency timer has expired. */
+#define SCARD_E_INSUFFICIENT_BUFFER 0x80100008 /**< The data buffer to receive returned data is too small for the returned data. */
+#define SCARD_E_UNKNOWN_READER 0x80100009 /**< The specified reader name is not recognized. */
+#define SCARD_E_TIMEOUT 0x8010000A /**< The user-specified timeout value has expired. */
+#define SCARD_E_SHARING_VIOLATION 0x8010000B /**< The smart card cannot be accessed because of other connections outstanding. */
+#define SCARD_E_NO_SMARTCARD 0x8010000C /**< The operation requires a Smart Card, but no Smart Card is currently in the device. */
+#define SCARD_E_UNKNOWN_CARD 0x8010000D /**< The specified smart card name is not recognized. */
+#define SCARD_E_CANT_DISPOSE 0x8010000E /**< The system could not dispose of the media in the requested manner. */
+#define SCARD_E_PROTO_MISMATCH 0x8010000F /**< The requested protocols are incompatible with the protocol currently in use with the smart card. */
+#define SCARD_E_NOT_READY 0x80100010 /**< The reader or smart card is not ready to accept commands. */
+#define SCARD_E_INVALID_VALUE 0x80100011 /**< One or more of the supplied parameters values could not be properly interpreted. */
+#define SCARD_E_SYSTEM_CANCELLED 0x80100012 /**< The action was cancelled by the system, presumably to log off or shut down. */
+#define SCARD_F_COMM_ERROR 0x80100013 /**< An internal communications error has been detected. */
+#define SCARD_F_UNKNOWN_ERROR 0x80100014 /**< An internal error has been detected, but the source is unknown. */
+#define SCARD_E_INVALID_ATR 0x80100015 /**< An ATR obtained from the registry is not a valid ATR string. */
+#define SCARD_E_NOT_TRANSACTED 0x80100016 /**< An attempt was made to end a non-existent transaction. */
+#define SCARD_E_READER_UNAVAILABLE 0x80100017 /**< The specified reader is not currently available for use. */
+#define SCARD_P_SHUTDOWN 0x80100018 /**< The operation has been aborted to allow the server application to exit. */
+#define SCARD_E_PCI_TOO_SMALL 0x80100019 /**< The PCI Receive buffer was too small. */
+#define SCARD_E_READER_UNSUPPORTED 0x8010001A /**< The reader driver does not meet minimal requirements for support. */
+#define SCARD_E_DUPLICATE_READER 0x8010001B /**< The reader driver did not produce a unique reader name. */
+#define SCARD_E_CARD_UNSUPPORTED 0x8010001C /**< The smart card does not meet minimal requirements for support. */
+#define SCARD_E_NO_SERVICE 0x8010001D /**< The Smart card resource manager is not running. */
+#define SCARD_E_SERVICE_STOPPED 0x8010001E /**< The Smart card resource manager has shut down. */
+#define SCARD_E_UNEXPECTED 0x8010001F /**< An unexpected card error has occurred. */
+#define SCARD_E_ICC_INSTALLATION 0x80100020 /**< No primary provider can be found for the smart card. */
+#define SCARD_E_ICC_CREATEORDER 0x80100021 /**< The requested order of object creation is not supported. */
+/* #define SCARD_E_UNSUPPORTED_FEATURE 0x80100022 / **< This smart card does not support the requested feature. */
+#define SCARD_E_DIR_NOT_FOUND 0x80100023 /**< The identified directory does not exist in the smart card. */
+#define SCARD_E_FILE_NOT_FOUND 0x80100024 /**< The identified file does not exist in the smart card. */
+#define SCARD_E_NO_DIR 0x80100025 /**< The supplied path does not represent a smart card directory. */
+#define SCARD_E_NO_FILE 0x80100026 /**< The supplied path does not represent a smart card file. */
+#define SCARD_E_NO_ACCESS 0x80100027 /**< Access is denied to this file. */
+#define SCARD_E_WRITE_TOO_MANY 0x80100028 /**< The smart card does not have enough memory to store the information. */
+#define SCARD_E_BAD_SEEK 0x80100029 /**< There was an error trying to set the smart card file object pointer. */
+#define SCARD_E_INVALID_CHV 0x8010002A /**< The supplied PIN is incorrect. */
+#define SCARD_E_UNKNOWN_RES_MNG 0x8010002B /**< An unrecognized error code was returned from a layered component. */
+#define SCARD_E_NO_SUCH_CERTIFICATE 0x8010002C /**< The requested certificate does not exist. */
+#define SCARD_E_CERTIFICATE_UNAVAILABLE 0x8010002D /**< The requested certificate could not be obtained. */
+#define SCARD_E_NO_READERS_AVAILABLE 0x8010002E /**< Cannot find a smart card reader. */
+#define SCARD_E_COMM_DATA_LOST 0x8010002F /**< A communications error with the smart card has been detected. Retry the operation. */
+#define SCARD_E_NO_KEY_CONTAINER 0x80100030 /**< The requested key container does not exist on the smart card. */
+#define SCARD_E_SERVER_TOO_BUSY 0x80100031 /**< The Smart Card Resource Manager is too busy to complete this operation. */
-#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_W_UNSUPPORTED_CARD 0x80100065 /**< The reader cannot communicate with the card, due to ATR string configuration conflicts. */
+#define SCARD_W_UNRESPONSIVE_CARD 0x80100066 /**< The smart card is not responding to a reset. */
+#define SCARD_W_UNPOWERED_CARD 0x80100067 /**< Power has been removed from the smart card, so that further communication is not possible. */
+#define SCARD_W_RESET_CARD 0x80100068 /**< The smart card has been reset, so any shared state information is invalid. */
+#define SCARD_W_REMOVED_CARD 0x80100069 /**< The smart card has been removed, so further communication is not possible. */
-#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
+#define SCARD_W_SECURITY_VIOLATION 0x8010006A /**< Access was denied because of a security violation. */
+#define SCARD_W_WRONG_CHV 0x8010006B /**< The card cannot be accessed because the wrong PIN was presented. */
+#define SCARD_W_CHV_BLOCKED 0x8010006C /**< The card cannot be accessed because the maximum number of PIN entry attempts has been reached. */
+#define SCARD_W_EOF 0x8010006D /**< The end of the smart card file has been reached. */
+#define SCARD_W_CANCELLED_BY_USER 0x8010006E /**< The user pressed "Cancel" on a Smart Card Selection Dialog. */
+#define SCARD_W_CARD_NOT_AUTHENTICATED 0x8010006F /**< No PIN was presented to the smart card. */
#define SCARD_SCOPE_USER 0x0000 /**< Scope in user space */
#define SCARD_SCOPE_TERMINAL 0x0001 /**< Scope in terminal */
@@ -280,7 +311,7 @@
#define MAX_BUFFER_SIZE_EXTENDED (4 + 3 + (1<<16) + 3) /**< enhanced (64K + APDU + Lc + Le) Tx/Rx Buffer */
/*
- * Gets a stringified error response
+ * Gets a stringified error response
*/
char *pcsc_stringify_error(int32_t err);
@@ -289,4 +320,3 @@
#endif
#endif
-
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/smartcardservices-changes/attachments/20090730/1e9eb6ed/attachment.html>
More information about the SmartcardServices-Changes
mailing list