[Pcsclite-cvs-commit] r2125 - trunk/PCSC/src/PCSC
Ludovic Rousseau
rousseau at costa.debian.org
Mon Aug 7 14:32:56 UTC 2006
Author: rousseau
Date: 2006-08-07 14:32:55 +0000 (Mon, 07 Aug 2006)
New Revision: 2125
Modified:
trunk/PCSC/src/PCSC/reader.h.in
Log:
Transform C comments into Doxygen comments
Modified: trunk/PCSC/src/PCSC/reader.h.in
===================================================================
--- trunk/PCSC/src/PCSC/reader.h.in 2006-08-07 14:18:52 UTC (rev 2124)
+++ trunk/PCSC/src/PCSC/reader.h.in 2006-08-07 14:32:55 UTC (rev 2125)
@@ -22,16 +22,16 @@
#define SCARD_ATTR_VALUE(Class, Tag) ((((ULONG)(Class)) << 16) | ((ULONG)(Tag)))
-#define SCARD_CLASS_VENDOR_INFO 1 /* Vendor information definitions */
-#define SCARD_CLASS_COMMUNICATIONS 2 /* Communication definitions */
-#define SCARD_CLASS_PROTOCOL 3 /* Protocol definitions */
-#define SCARD_CLASS_POWER_MGMT 4 /* Power Management definitions */
-#define SCARD_CLASS_SECURITY 5 /* Security Assurance definitions */
-#define SCARD_CLASS_MECHANICAL 6 /* Mechanical characteristic definitions */
-#define SCARD_CLASS_VENDOR_DEFINED 7 /* Vendor specific definitions */
-#define SCARD_CLASS_IFD_PROTOCOL 8 /* Interface Device Protocol options */
-#define SCARD_CLASS_ICC_STATE 9 /* ICC State specific definitions */
-#define SCARD_CLASS_SYSTEM 0x7fff /* System-specific definitions */
+#define SCARD_CLASS_VENDOR_INFO 1 /**< Vendor information definitions */
+#define SCARD_CLASS_COMMUNICATIONS 2 /**< Communication definitions */
+#define SCARD_CLASS_PROTOCOL 3 /**< Protocol definitions */
+#define SCARD_CLASS_POWER_MGMT 4 /**< Power Management definitions */
+#define SCARD_CLASS_SECURITY 5 /**< Security Assurance definitions */
+#define SCARD_CLASS_MECHANICAL 6 /**< Mechanical characteristic definitions */
+#define SCARD_CLASS_VENDOR_DEFINED 7 /**< Vendor specific definitions */
+#define SCARD_CLASS_IFD_PROTOCOL 8 /**< Interface Device Protocol options */
+#define SCARD_CLASS_ICC_STATE 9 /**< ICC State specific definitions */
+#define SCARD_CLASS_SYSTEM 0x7fff /**< System-specific definitions */
#define SCARD_ATTR_VENDOR_NAME SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0100)
#define SCARD_ATTR_VENDOR_IFD_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0101)
@@ -90,27 +90,27 @@
#define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_A
#endif
-/*
+/**
* Provide source compatibility on different platforms
*/
#define SCARD_CTL_CODE(code) (0x42000000 + (code))
-/*
+/**
* TeleTrust Class 2 reader tags
*/
#define CM_IOCTL_GET_FEATURE_REQUEST SCARD_CTL_CODE(3400)
-#define FEATURE_VERIFY_PIN_START 0x01 /* OMNIKEY Proposal */
-#define FEATURE_VERIFY_PIN_FINISH 0x02 /* OMNIKEY Proposal */
-#define FEATURE_MODIFY_PIN_START 0x03 /* OMNIKEY Proposal */
-#define FEATURE_MODIFY_PIN_FINISH 0x04 /* OMNIKEY Proposal */
-#define FEATURE_GET_KEY_PRESSED 0x05 /* OMNIKEY Proposal */
-#define FEATURE_VERIFY_PIN_DIRECT 0x06 /* USB CCID PIN Verify */
-#define FEATURE_MODIFY_PIN_DIRECT 0x07 /* USB CCID PIN Modify */
-#define FEATURE_MCT_READERDIRECT 0x08 /* KOBIL Proposal */
-#define FEATURE_MCT_UNIVERSAL 0x09 /* KOBIL Proposal */
-#define FEATURE_IFD_PIN_PROP 0x0A /* Gemplus Proposal */
-#define FEATURE_ABORT 0x0B /* SCM Proposal */
+#define FEATURE_VERIFY_PIN_START 0x01 /**< OMNIKEY Proposal */
+#define FEATURE_VERIFY_PIN_FINISH 0x02 /**< OMNIKEY Proposal */
+#define FEATURE_MODIFY_PIN_START 0x03 /**< OMNIKEY Proposal */
+#define FEATURE_MODIFY_PIN_FINISH 0x04 /**< OMNIKEY Proposal */
+#define FEATURE_GET_KEY_PRESSED 0x05 /**< OMNIKEY Proposal */
+#define FEATURE_VERIFY_PIN_DIRECT 0x06 /**< USB CCID PIN Verify */
+#define FEATURE_MODIFY_PIN_DIRECT 0x07 /**< USB CCID PIN Modify */
+#define FEATURE_MCT_READERDIRECT 0x08 /**< KOBIL Proposal */
+#define FEATURE_MCT_UNIVERSAL 0x09 /**< KOBIL Proposal */
+#define FEATURE_IFD_PIN_PROP 0x0A /**< Gemplus Proposal */
+#define FEATURE_ABORT 0x0B /**< SCM Proposal */
/* structures used (but not defined) in PCSC Part 10 revision 2.01.02:
* "IFDs with Secure Pin Entry Capabilities" */
@@ -125,73 +125,75 @@
#pragma pack(push, 1)
#endif
-/* the structure must be 6-bytes long */
+/** the structure must be 6-bytes long */
typedef struct
{
uint8_t tag;
uint8_t length;
- uint32_t value; /* This value is always in BIG ENDIAN format as documented in PCSC v2 part 10 ch 2.2 page 2. You can use ntohl() for example */
+ uint32_t value; /**< This value is always in BIG ENDIAN format as documented in PCSC v2 part 10 ch 2.2 page 2. You can use ntohl() for example */
} PCSC_TLV_STRUCTURE;
-/* the wLangId and wPINMaxExtraDigit are 16-bits long so are subject to byte
+/** the wLangId and wPINMaxExtraDigit are 16-bits long so are subject to byte
* ordering */
#define HOST_TO_CCID_16(x) @host_to_ccid_16@
#define HOST_TO_CCID_32(x) @host_to_ccid_32@
+/** structure used with \ref FEATURE_VERIFY_PIN_DIRECT */
typedef struct
{
- uint8_t bTimerOut; /* timeout is seconds (00 means use default timeout) */
- uint8_t bTimerOut2; /* timeout in seconds after first key stroke */
- uint8_t bmFormatString; /* formatting options */
- uint8_t bmPINBlockString; /* bits 7-4 bit size of PIN length in APDU,
+ uint8_t bTimerOut; /**< timeout is seconds (00 means use default timeout) */
+ uint8_t bTimerOut2; /**< timeout in seconds after first key stroke */
+ uint8_t bmFormatString; /**< formatting options */
+ uint8_t bmPINBlockString; /**< bits 7-4 bit size of PIN length in APDU,
* bits 3-0 PIN block size in bytes after
* justification and formatting */
- uint8_t bmPINLengthFormat; /* bits 7-5 RFU,
+ uint8_t bmPINLengthFormat; /**< bits 7-5 RFU,
* bit 4 set if system units are bytes, clear if
* system units are bits,
* bits 3-0 PIN length position in system units */
- uint16_t wPINMaxExtraDigit; /* 0xXXYY where XX is minimum PIN size in digits,
+ uint16_t wPINMaxExtraDigit; /**< 0xXXYY where XX is minimum PIN size in digits,
and YY is maximum PIN size in digits */
- uint8_t bEntryValidationCondition; /* Conditions under which PIN entry should
+ uint8_t bEntryValidationCondition; /**< Conditions under which PIN entry should
* be considered complete */
- uint8_t bNumberMessage; /* Number of messages to display for PIN verification */
- uint16_t wLangId; /* Language for messages */
- uint8_t bMsgIndex; /* Message index (should be 00) */
- uint8_t bTeoPrologue[3]; /* T=1 block prologue field to use (fill with 00) */
- uint32_t ulDataLength; /* length of Data to be sent to the ICC */
- uint8_t abData[1]; /* Data to send to the ICC */
+ uint8_t bNumberMessage; /**< Number of messages to display for PIN verification */
+ uint16_t wLangId; /**< Language for messages */
+ uint8_t bMsgIndex; /**< Message index (should be 00) */
+ uint8_t bTeoPrologue[3]; /**< T=1 block prologue field to use (fill with 00) */
+ uint32_t ulDataLength; /**< length of Data to be sent to the ICC */
+ uint8_t abData[1]; /**< Data to send to the ICC */
} PIN_VERIFY_STRUCTURE;
+/** structure used with \ref FEATURE_MODIFY_PIN_DIRECT */
typedef struct
{
- uint8_t bTimerOut; /* timeout is seconds (00 means use default timeout) */
- uint8_t bTimerOut2; /* timeout in seconds after first key stroke */
- uint8_t bmFormatString; /* formatting options */
- uint8_t bmPINBlockString; /* bits 7-4 bit size of PIN length in APDU,
+ uint8_t bTimerOut; /**< timeout is seconds (00 means use default timeout) */
+ uint8_t bTimerOut2; /**< timeout in seconds after first key stroke */
+ uint8_t bmFormatString; /**< formatting options */
+ uint8_t bmPINBlockString; /**< bits 7-4 bit size of PIN length in APDU,
* bits 3-0 PIN block size in bytes after
* justification and formatting */
- uint8_t bmPINLengthFormat; /* bits 7-5 RFU,
+ uint8_t bmPINLengthFormat; /**< bits 7-5 RFU,
* bit 4 set if system units are bytes, clear if
* system units are bits,
* bits 3-0 PIN length position in system units */
- uint8_t bInsertionOffsetOld; /* Insertion position offset in bytes for
+ uint8_t bInsertionOffsetOld; /**< Insertion position offset in bytes for
the current PIN */
- uint8_t bInsertionOffsetNew; /* Insertion position offset in bytes for
+ uint8_t bInsertionOffsetNew; /**< Insertion position offset in bytes for
the new PIN */
uint16_t wPINMaxExtraDigit;
- /* 0xXXYY where XX is minimum PIN size in digits,
+ /**< 0xXXYY where XX is minimum PIN size in digits,
and YY is maximum PIN size in digits */
- uint8_t bConfirmPIN; /* Flags governing need for confirmation of new PIN */
- uint8_t bEntryValidationCondition; /* Conditions under which PIN entry should
+ uint8_t bConfirmPIN; /**< Flags governing need for confirmation of new PIN */
+ uint8_t bEntryValidationCondition; /**< Conditions under which PIN entry should
* be considered complete */
- uint8_t bNumberMessage; /* Number of messages to display for PIN verification*/
- uint16_t wLangId; /* Language for messages */
- uint8_t bMsgIndex1; /* index of 1st prompting message */
- uint8_t bMsgIndex2; /* index of 2d prompting message */
- uint8_t bMsgIndex3; /* index of 3d prompting message */
- uint8_t bTeoPrologue[3]; /* T=1 block prologue field to use (fill with 00) */
- uint32_t ulDataLength; /* length of Data to be sent to the ICC */
- uint8_t abData[1]; /* Data to send to the ICC */
+ uint8_t bNumberMessage; /**< Number of messages to display for PIN verification*/
+ uint16_t wLangId; /**< Language for messages */
+ uint8_t bMsgIndex1; /**< index of 1st prompting message */
+ uint8_t bMsgIndex2; /**< index of 2d prompting message */
+ uint8_t bMsgIndex3; /**< index of 3d prompting message */
+ uint8_t bTeoPrologue[3]; /**< T=1 block prologue field to use (fill with 00) */
+ uint32_t ulDataLength; /**< length of Data to be sent to the ICC */
+ uint8_t abData[1]; /**< Data to send to the ICC */
} PIN_MODIFY_STRUCTURE;
/* restore default structure elements alignment */
More information about the Pcsclite-cvs-commit
mailing list