[Pcsclite-cvs-commit] r2896 - in /trunk/PCSC/src: debuglog.c hotplug_libhal.c hotplug_linux.c ifdwrapper.c pcscdaemon.c powermgt_generic.h prothandler.c winscard_scf.c winscard_svc.c
rousseau at users.alioth.debian.org
rousseau at users.alioth.debian.org
Tue Apr 22 09:20:00 UTC 2008
Author: rousseau
Date: Tue Apr 22 09:20:00 2008
New Revision: 2896
URL: http://svn.debian.org/wsvn/pcsclite/?sc=1&rev=2896
Log:
doxygen: convert C comments in doxygen comments
Modified:
trunk/PCSC/src/debuglog.c
trunk/PCSC/src/hotplug_libhal.c
trunk/PCSC/src/hotplug_linux.c
trunk/PCSC/src/ifdwrapper.c
trunk/PCSC/src/pcscdaemon.c
trunk/PCSC/src/powermgt_generic.h
trunk/PCSC/src/prothandler.c
trunk/PCSC/src/winscard_scf.c
trunk/PCSC/src/winscard_svc.c
Modified: trunk/PCSC/src/debuglog.c
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/debuglog.c?rev=2896&op=diff
==============================================================================
--- trunk/PCSC/src/debuglog.c (original)
+++ trunk/PCSC/src/debuglog.c Tue Apr 22 09:20:00 2008
@@ -44,10 +44,10 @@
static char LogMsgType = DEBUGLOG_NO_DEBUG;
static char LogCategory = DEBUG_CATEGORY_NOTHING;
-/* default level is a bit verbose to be backward compatible */
+/** default level is a bit verbose to be backward compatible */
static char LogLevel = PCSC_LOG_INFO;
-static signed char LogDoColor = 0; /* no color by default */
+static signed char LogDoColor = 0; /**< no color by default */
static void log_line(const int priority, const char *DebugBuffer);
Modified: trunk/PCSC/src/hotplug_libhal.c
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/hotplug_libhal.c?rev=2896&op=diff
==============================================================================
--- trunk/PCSC/src/hotplug_libhal.c (original)
+++ trunk/PCSC/src/hotplug_libhal.c Tue Apr 22 09:20:00 2008
@@ -48,7 +48,7 @@
static DBusConnection *conn;
static LibHalContext *hal_ctx;
-/*
+/**
* keep track of drivers in a dynamically allocated array
*/
static struct _driverTracker
@@ -63,13 +63,13 @@
} *driverTracker = NULL;
#define DRIVER_TRACKER_SIZE_STEP 8
-/*
+/**
* keep track of PCSCLITE_MAX_READERS_CONTEXTS simultaneous readers
*/
static struct _readerTracker
{
- char *udi; /* device name seen by HAL */
- char *fullName; /* full reader name (including serial number) */
+ char *udi; /**< device name seen by HAL */
+ char *fullName; /**< full reader name (including serial number) */
} readerTracker[PCSCLITE_MAX_READERS_CONTEXTS];
static LONG HPReadBundleValues(void);
@@ -77,7 +77,8 @@
static void HPRemoveDevice(LibHalContext *ctx, const char *udi);
static void HPEstablishUSBNotifications(void);
-/** Generate a short name for a device
+/**
+ * Generate a short name for a device
*
* @param udi Universal Device Id
*/
@@ -240,7 +241,7 @@
} /* HPEstablishUSBNotifications */
-/**
+/***
* Start a thread waiting for hotplug events
*/
LONG HPSearchHotPluggables(void)
@@ -435,7 +436,7 @@
} /* HPRemoveDevice */
-/*
+/**
* Sets up callbacks for device hotplug events.
*/
ULONG HPRegisterForHotplugEvents(void)
Modified: trunk/PCSC/src/hotplug_linux.c
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/hotplug_linux.c?rev=2896&op=diff
==============================================================================
--- trunk/PCSC/src/hotplug_linux.c (original)
+++ trunk/PCSC/src/hotplug_linux.c Tue Apr 22 09:20:00 2008
@@ -74,7 +74,7 @@
static int AraKiriHotPlug = FALSE;
static int bundleSize = 0;
-/*
+/**
* A list to keep track of 20 simultaneous readers
*/
static struct _bundleTracker
@@ -418,7 +418,7 @@
return 1;
} /* End of function */
-/*
+/**
* Sets up callbacks for device hotplug events.
*/
ULONG HPRegisterForHotplugEvents(void)
Modified: trunk/PCSC/src/ifdwrapper.c
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/ifdwrapper.c?rev=2896&op=diff
==============================================================================
--- trunk/PCSC/src/ifdwrapper.c (original)
+++ trunk/PCSC/src/ifdwrapper.c Tue Apr 22 09:20:00 2008
@@ -28,11 +28,10 @@
#undef PCSCLITE_STATIC_DRIVER
-/*
- * Function: IFDSetPTS Purpose : To set the protocol type selection (PTS).
+/**
+ * Set the protocol type selection (PTS).
* This function sets the appropriate protocol to be used on the card.
*/
-
LONG IFDSetPTS(PREADER_CONTEXT rContext, DWORD dwProtocol, UCHAR ucFlags,
UCHAR ucPTS1, UCHAR ucPTS2, UCHAR ucPTS3)
{
@@ -109,11 +108,9 @@
return rv;
}
-/*
- * Function: IFDOpenIFD Purpose : This function opens a communication
- * channel to the IFD.
- */
-
+/**
+ * Open a communication channel to the IFD.
+ */
LONG IFDOpenIFD(PREADER_CONTEXT rContext)
{
RESPONSECODE rv = 0;
@@ -184,11 +181,9 @@
return rv;
}
-/*
- * Function: IFDCloseIFD Purpose : This function closes a communication
- * channel to the IFD.
- */
-
+/**
+ * Close a communication channel to the IFD.
+ */
LONG IFDCloseIFD(PREADER_CONTEXT rContext)
{
RESPONSECODE rv = IFD_SUCCESS;
@@ -229,11 +224,9 @@
return rv;
}
-/*
- * Function: IFDSetCapabilites Purpose : This function set's capabilities
- * in the reader.
- */
-
+/**
+ * Set capabilities in the reader.
+ */
LONG IFDSetCapabilities(PREADER_CONTEXT rContext, DWORD dwTag,
DWORD dwLength, PUCHAR pucValue)
{
@@ -271,12 +264,11 @@
return rv;
}
-/*
- * Function: IFDGetCapabilites Purpose : This function get's capabilities
- * in the reader. Other functions int this file will call the driver
- * directly to not cause a deadlock.
- */
-
+/**
+ * Get's capabilities in the reader.
+ * Other functions int this file will call
+ * the driver directly to not cause a deadlock.
+ */
LONG IFDGetCapabilities(PREADER_CONTEXT rContext, DWORD dwTag,
PDWORD pdwLength, PUCHAR pucValue)
{
@@ -323,11 +315,9 @@
return rv;
}
-/*
- * Function: IFDPowerICC Purpose : This function powers up/down or reset's
- * an ICC located in the IFD.
- */
-
+/**
+ * Power up/down or reset's an ICC located in the IFD.
+ */
LONG IFDPowerICC(PREADER_CONTEXT rContext, DWORD dwAction,
PUCHAR pucAtr, PDWORD pdwAtrLen)
{
@@ -423,12 +413,10 @@
return rv;
}
-/*
- * Function: IFDStatusICC Purpose : This function provides statistical
- * information about the IFD and ICC including insertions, atr, powering
- * status/etc.
- */
-
+/**
+ * Provide statistical information about the IFD and ICC including insertions,
+ * atr, powering status/etc.
+ */
LONG IFDStatusICC(PREADER_CONTEXT rContext, PDWORD pdwStatus,
PUCHAR pucAtr, PDWORD pdwAtrLen)
{
@@ -621,10 +609,9 @@
}
}
-/*
- * Function: IFDControl Purpose : This function provides a means for
- * toggling a specific action on the reader such as swallow, eject,
- * biometric.
+/**
+ * Provide a means for toggling a specific action on the reader such as
+ * swallow, eject, biometric.
*/
/*
@@ -683,11 +670,9 @@
}
}
-/*
- * Function: IFDTransmit Purpose : This function transmits an APDU to the
- * ICC.
- */
-
+/**
+ * Transmit an APDU to the ICC.
+ */
LONG IFDTransmit(PREADER_CONTEXT rContext, SCARD_IO_HEADER pioTxPci,
PUCHAR pucTxBuffer, DWORD dwTxLength, PUCHAR pucRxBuffer,
PDWORD pdwRxLength, PSCARD_IO_HEADER pioRxPci)
Modified: trunk/PCSC/src/pcscdaemon.c
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/pcscdaemon.c?rev=2896&op=diff
==============================================================================
--- trunk/PCSC/src/pcscdaemon.c (original)
+++ trunk/PCSC/src/pcscdaemon.c Tue Apr 22 09:20:00 2008
@@ -72,7 +72,7 @@
PCSCLITE_MUTEX usbNotifierMutex;
-/*
+/**
* Cleans up messages still on the queue when a client dies
*/
void SVCClientCleanup(psharedSegmentMsg msgStruct)
Modified: trunk/PCSC/src/powermgt_generic.h
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/powermgt_generic.h?rev=2896&op=diff
==============================================================================
--- trunk/PCSC/src/powermgt_generic.h (original)
+++ trunk/PCSC/src/powermgt_generic.h Tue Apr 22 09:20:00 2008
@@ -21,10 +21,9 @@
#endif
-/*
+/**
* Registers for Power Management callbacks
*/
-
ULONG PMRegisterForPowerEvents(void);
Modified: trunk/PCSC/src/prothandler.c
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/prothandler.c?rev=2896&op=diff
==============================================================================
--- trunk/PCSC/src/prothandler.c (original)
+++ trunk/PCSC/src/prothandler.c Tue Apr 22 09:20:00 2008
@@ -27,12 +27,11 @@
#include "ifdwrapper.h"
#include "eventhandler.h"
-/*
- * Function: PHGetDefaultProtocol Purpose : To get the default protocol
- * used immediately after reset. This protocol is returned from the
- * function.
+/**
+ * Get the default protocol used immediately after reset.
+ *
+ * This protocol is returned from the function.
*/
-
UCHAR PHGetDefaultProtocol(PUCHAR pucAtr, DWORD dwLength)
{
SMARTCARD_EXTENSION sSmartCard;
@@ -48,12 +47,11 @@
return 0x00;
}
-/*
- * Function: PHGetAvailableProtocols Purpose : To get the protocols
- * supported by the card. These protocols are returned from the function
- * as bit masks.
+/**
+ * Get the protocols supported by the card.
+ *
+ * These protocols are returned from the function as bit masks.
*/
-
UCHAR PHGetAvailableProtocols(PUCHAR pucAtr, DWORD dwLength)
{
SMARTCARD_EXTENSION sSmartCard;
@@ -69,8 +67,9 @@
return 0x00;
}
-/*
- * Function: PHSetProtocol Purpose : To determine which protocol to use.
+/**
+ * Determine which protocol to use.
+ *
* SCardConnect has a DWORD dwPreferredProtocols that is a bitmask of what
* protocols to use. Basically, if T=N where N is not zero will be used
* first if it is available in ucAvailable. Otherwise it will always
@@ -78,7 +77,6 @@
*
* IFDSetPTS() is _always_ called so that the driver can initialise its data
*/
-
DWORD PHSetProtocol(struct ReaderContext * rContext,
DWORD dwPreferred, UCHAR ucAvailable, UCHAR ucDefault)
{
Modified: trunk/PCSC/src/winscard_scf.c
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/winscard_scf.c?rev=2896&op=diff
==============================================================================
--- trunk/PCSC/src/winscard_scf.c (original)
+++ trunk/PCSC/src/winscard_scf.c Tue Apr 22 09:20:00 2008
@@ -41,10 +41,10 @@
#undef PCSCLITE_MAX_READERS_CONTEXTS
#define PCSCLITE_MAX_READERS_CONTEXTS 2
-/* Global session to manage Readers, Card events. */
+/** Global session to manage Readers, Card events. */
static SCF_Session_t g_hSession = NULL;
-/* Have to define this because they are defined in pcsclite.h as externs */
+/** Have to define this because they are defined in pcsclite.h as externs */
SCARD_IO_REQUEST g_rgSCardT0Pci, g_rgSCardT1Pci, g_rgSCardRawPci;
static struct _psTransmitMap
@@ -54,7 +54,7 @@
LONG bufferLength;
} psTransmitMap[PCSCLITE_MAX_APPLICATION_CONTEXTS];
-/* Channel Map to manage Card Connections. */
+/** Channel Map to manage Card Connections. */
static struct _psChannelMap
{
SCARDHANDLE PCSC_hCard;
@@ -67,7 +67,7 @@
int ReaderIndice;
} psChannelMap[PCSCLITE_MAX_APPLICATION_CONTEXTS];
-/* Context Map to manage contexts and sessions. */
+/** Context Map to manage contexts and sessions. */
static struct _psContextMap
{
SCARDCONTEXT hContext;
@@ -75,7 +75,7 @@
DWORD contextBlockStatus;
} psContextMap[PCSCLITE_MAX_APPLICATION_CONTEXTS];
-/* Reader Map to handle Status and GetStatusChange. */
+/** Reader Map to handle Status and GetStatusChange. */
static struct _psReaderMap
{
SCF_Terminal_t hTerminal;
@@ -89,7 +89,7 @@
static PCSCLITE_MUTEX clientMutex = PTHREAD_MUTEX_INITIALIZER;
-/*
+/**
* Mutex for the Smardcard Event Handling, different from client Mutex
* because event reporting from the ocfserver is done using a single thread,
* so to get lock on the clientMutex may affect the performance of the ocf server.
Modified: trunk/PCSC/src/winscard_svc.c
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/winscard_svc.c?rev=2896&op=diff
==============================================================================
--- trunk/PCSC/src/winscard_svc.c (original)
+++ trunk/PCSC/src/winscard_svc.c Tue Apr 22 09:20:00 2008
@@ -42,10 +42,10 @@
{
uint32_t hContext;
uint32_t hCard[PCSCLITE_MAX_APPLICATION_CONTEXT_CHANNELS];
- uint32_t dwClientID; /* Connection ID used to reference the Client. */
- PCSCLITE_THREAD_T pthThread; /* Event polling thread's ID */
- sharedSegmentMsg msgStruct; /* Msg sent by the Client */
- int protocol_major, protocol_minor; /* Protocol number agreed between client and server*/
+ uint32_t dwClientID; /**< Connection ID used to reference the Client. */
+ PCSCLITE_THREAD_T pthThread; /**< Event polling thread's ID */
+ sharedSegmentMsg msgStruct; /**< Msg sent by the Client */
+ int protocol_major, protocol_minor; /**< Protocol number agreed between client and server*/
} psContext[PCSCLITE_MAX_APPLICATIONS_CONTEXTS];
LONG MSGCheckHandleAssociation(SCARDHANDLE, DWORD);
More information about the Pcsclite-cvs-commit
mailing list