wdu_lib.h

Go to the documentation of this file.

/* @JUNGO_COPYRIGHT@ */
 
#ifndef _WD_USB_H_
#define _WD_USB_H_
 
#include "windrvr.h"
 
#if defined(__cplusplus)
    extern "C" {
#endif
 
typedef PVOID WDU_DRIVER_HANDLE;
typedef PVOID WDU_DEVICE_HANDLE;
typedef PVOID WDU_STREAM_HANDLE;
 
typedef WORD WDU_LANGID;
 
/*
 * User Callbacks
 */
 
typedef BOOL (DLLCALLCONV *WDU_ATTACH_CALLBACK)(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ WDU_DEVICE *pDeviceInfo, _In_ PVOID pUserData);
 
typedef void (DLLCALLCONV *WDU_DETACH_CALLBACK)(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ PVOID pUserData);
 
typedef BOOL (DLLCALLCONV *WDU_POWER_CHANGE_CALLBACK)(
    _In_ WDU_DEVICE_HANDLE hDevice, _In_ DWORD dwPowerState,
    _In_ PVOID pUserData);
 
/*
 * struct definitions
 */
typedef struct
{
    WDU_ATTACH_CALLBACK pfDeviceAttach;
    WDU_DETACH_CALLBACK pfDeviceDetach;
    WDU_POWER_CHANGE_CALLBACK pfPowerChange;
    PVOID pUserData;  /* pointer to pass in each callback */
} WDU_EVENT_TABLE;
 
/*
 * API Functions
 */
 
DWORD DLLCALLCONV WDU_Init(_Outptr_ WDU_DRIVER_HANDLE *phDriver,
    _In_ WDU_MATCH_TABLE *pMatchTables, _In_ DWORD dwNumMatchTables,
    _In_ WDU_EVENT_TABLE *pEventTable, _In_ const char *pcLicense,
    _In_ DWORD dwOptions);
 
void DLLCALLCONV WDU_Uninit(_In_ WDU_DRIVER_HANDLE hDriver);
 
DWORD DLLCALLCONV WDU_GetDeviceAddr(_In_ WDU_DEVICE_HANDLE hDevice,
    _Out_ DWORD *pAddress);
 
DWORD DLLCALLCONV WDU_GetDeviceRegistryProperty(_In_ WDU_DEVICE_HANDLE hDevice,
    _Outptr_ PVOID pBuffer, _Inout_ PDWORD pdwSize,
    _In_ WD_DEVICE_REGISTRY_PROPERTY property);
 
DWORD DLLCALLCONV WDU_GetDeviceInfo(_In_ WDU_DEVICE_HANDLE hDevice,
    _Outptr_ WDU_DEVICE **ppDeviceInfo);
 
void DLLCALLCONV WDU_PutDeviceInfo(_In_ WDU_DEVICE *pDeviceInfo);
 
DWORD DLLCALLCONV WDU_SetInterface(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwInterfaceNum, _In_ DWORD dwAlternateSetting);
 
/* NOT IMPLEMENTED YET */
DWORD DLLCALLCONV WDU_SetConfig(WDU_DEVICE_HANDLE hDevice, DWORD dwConfigNum);
/* NOT IMPLEMENTED YET */
 
DWORD DLLCALLCONV WDU_ResetPipe(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwPipeNum);
 
DWORD DLLCALLCONV WDU_ResetDevice(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwOptions);
 
DWORD DLLCALLCONV WDU_Wakeup(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwOptions);
 
DWORD DLLCALLCONV WDU_SelectiveSuspend(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwOptions);
 
DWORD DLLCALLCONV WDU_Transfer(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwPipeNum, _In_ DWORD fRead, _In_ DWORD dwOptions,
    _In_ PVOID pBuffer, _In_ DWORD dwBufferSize,
    _Outptr_ PDWORD pdwBytesTransferred, _In_ PBYTE pSetupPacket,
    _In_ DWORD dwTimeout);
 
DWORD DLLCALLCONV WDU_HaltTransfer(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwPipeNum);
 
/*
 * Simplified transfers - for a specific pipe
 */
 
DWORD DLLCALLCONV WDU_TransferDefaultPipe(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD fRead, _In_ DWORD dwOptions,
    _In_ PVOID pBuffer, _In_ DWORD dwBufferSize,
    _Outptr_ PDWORD pdwBytesTransferred,
    _In_ PBYTE pSetupPacket, _In_ DWORD dwTimeout);
 
DWORD DLLCALLCONV WDU_TransferBulk(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwPipeNum, _In_ DWORD fRead, _In_ DWORD dwOptions,
    _In_ PVOID pBuffer, _In_ DWORD dwBufferSize,
    _Outptr_ PDWORD pdwBytesTransferred, _In_ DWORD dwTimeout);
 
DWORD DLLCALLCONV WDU_TransferIsoch(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwPipeNum, _In_ DWORD fRead, _In_ DWORD dwOptions,
    _In_ PVOID pBuffer, _In_ DWORD dwBufferSize,
    _Outptr_ PDWORD pdwBytesTransferred, _In_ DWORD dwTimeout);
 
DWORD DLLCALLCONV WDU_TransferInterrupt(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwPipeNum, _In_ DWORD fRead, _In_ DWORD dwOptions,
    _In_ PVOID pBuffer, _In_ DWORD dwBufferSize,
    _Outptr_ PDWORD pdwBytesTransferred, _In_ DWORD dwTimeout);
 
DWORD DLLCALLCONV WDU_GetLangIDs(_In_ WDU_DEVICE_HANDLE hDevice,
    _Outptr_ PBYTE pbNumSupportedLangIDs, _Outptr_ WDU_LANGID *pLangIDs,
    _In_ BYTE bNumLangIDs);
 
DWORD DLLCALLCONV WDU_GetStringDesc(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ BYTE bStrIndex, _Outptr_ PBYTE pbBuf, _In_ DWORD dwBufSize,
    _In_ WDU_LANGID langID, _Outptr_ PDWORD pdwDescSize);
 
/*
 * Streaming Functions
 */
 
DWORD DLLCALLCONV WDU_StreamOpen(_In_ WDU_DEVICE_HANDLE hDevice,
    _In_ DWORD dwPipeNum, _In_ DWORD dwBufferSize, _In_ DWORD dwRxSize,
    _In_ BOOL fBlocking, _In_ DWORD dwOptions, _In_ DWORD dwRxTxTimeout,
    _Outptr_ WDU_STREAM_HANDLE *phStream);
 
DWORD DLLCALLCONV WDU_StreamClose(_In_ WDU_STREAM_HANDLE hStream);
 
DWORD DLLCALLCONV WDU_StreamStart(_In_ WDU_STREAM_HANDLE hStream);
 
DWORD DLLCALLCONV WDU_StreamStop(_In_ WDU_STREAM_HANDLE hStream);
 
DWORD DLLCALLCONV WDU_StreamFlush(_In_ WDU_STREAM_HANDLE hStream);
 
DWORD DLLCALLCONV WDU_StreamRead(_In_ HANDLE hStream, _Outptr_ PVOID pBuffer,
    _In_ DWORD bytes, _Outptr_ DWORD *pdwBytesRead);
 
DWORD DLLCALLCONV WDU_StreamWrite(_In_ HANDLE hStream,
    _In_ const PVOID pBuffer, _In_ DWORD bytes,
    _Outptr_ DWORD *pdwBytesWritten);
 
DWORD DLLCALLCONV WDU_StreamGetStatus(_In_ WDU_STREAM_HANDLE hStream,
    _Outptr_ BOOL *pfIsRunning, _Outptr_ DWORD *pdwLastError,
    _Outptr_ DWORD *pdwBytesInBuffer);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _WD_USB_H_ */