lusbk_shared.h

Go to the documentation of this file.

#ifndef __LUSBK_SHARED_H_
#define __LUSBK_SHARED_H_

// fix C_ASSERT macro error notifications in VS2010+ code browser
#if defined(_MSC_VER) && _MSC_VER >= 1600
#define USBK_C_ASSERT(name,x) typedef char C_ASSERT_ ## name ## _COUNTER_ [(x) ? 1 : -1];
#else
#define USBK_C_ASSERT(name,x) C_ASSERT(x)
#endif

#ifndef __USB_H__

typedef enum _USBD_PIPE_TYPE
{
    UsbdPipeTypeControl,

    UsbdPipeTypeIsochronous,

    UsbdPipeTypeBulk,

    UsbdPipeTypeInterrupt,
} USBD_PIPE_TYPE;

#endif

#if !defined(__WINUSB_COMPAT_IO_H__) && !defined(__WUSBIO_H__)

// pipe policy types ///////////////
#define SHORT_PACKET_TERMINATE  0x01
#define AUTO_CLEAR_STALL        0x02
#define PIPE_TRANSFER_TIMEOUT   0x03
#define IGNORE_SHORT_PACKETS    0x04
#define ALLOW_PARTIAL_READS     0x05
#define AUTO_FLUSH              0x06
#define RAW_IO                  0x07
#define MAXIMUM_TRANSFER_SIZE   0x08
#define RESET_PIPE_ON_RESUME    0x09

// libusbK ISO pipe policy types ///
#define ISO_START_LATENCY       0x20
#define ISO_ALWAYS_START_ASAP   0x21
#define ISO_NUM_FIXED_PACKETS   0x22

// http://msdn.microsoft.com/en-us/library/windows/hardware/ff552359%28v=vs.85%29.aspx
// Settings.Parallel.NumberOfPresentedRequests
// Maximum number of transfers that can be asynchronously delivered at a
// time. Available in version 1.9 and later versions of KMDF.
#define SIMUL_PARALLEL_REQUESTS 0x30

// Power policy types //////////////
#define AUTO_SUSPEND            0x81
#define SUSPEND_DELAY           0x83

// Device Information types ////////
#define DEVICE_SPEED            0x01

// Device Speeds
#define LowSpeed                0x01
#define FullSpeed               0x02
#define HighSpeed               0x03

typedef struct _WINUSB_PIPE_INFORMATION
{
    USBD_PIPE_TYPE  PipeType;

    UCHAR PipeId;

    USHORT MaximumPacketSize;

    UCHAR Interval;

} WINUSB_PIPE_INFORMATION;
typedef WINUSB_PIPE_INFORMATION* PWINUSB_PIPE_INFORMATION;
USBK_C_ASSERT(WINUSB_PIPE_INFORMATION,sizeof(WINUSB_PIPE_INFORMATION) == 12);

typedef struct _WINUSB_PIPE_INFORMATION_EX
{
    USBD_PIPE_TYPE  PipeType;

    UCHAR PipeId;

    USHORT MaximumPacketSize;

    UCHAR Interval;


    ULONG MaximumBytesPerInterval;

} WINUSB_PIPE_INFORMATION_EX;
typedef WINUSB_PIPE_INFORMATION_EX* PWINUSB_PIPE_INFORMATION_EX;
USBK_C_ASSERT(WINUSB_PIPE_INFORMATION_EX, sizeof(WINUSB_PIPE_INFORMATION_EX) == 16);

#include <pshpack1.h>


typedef struct _WINUSB_SETUP_PACKET
{
    UCHAR   RequestType;

    UCHAR   Request;

    USHORT  Value;

    USHORT  Index;

    USHORT  Length;

} WINUSB_SETUP_PACKET;
typedef WINUSB_SETUP_PACKET* PWINUSB_SETUP_PACKET;
USBK_C_ASSERT(WINUSB_SETUP_PACKET,sizeof(WINUSB_SETUP_PACKET) == 8);

#include <poppack.h>

#endif // __WUSBIO_H__ __WINUSB_COMPAT_IO_H__

#include <pshpack1.h>

typedef struct _KISO_PACKET
{

    UINT Offset;


    USHORT Length;


    USHORT Status;

} KISO_PACKET;

typedef KISO_PACKET* PKISO_PACKET;

typedef struct _KISO_WUSB_PACKET
{

    UINT Offset;


    UINT Length;


    UINT Status;

} KISO_WUSB_PACKET;
typedef KISO_WUSB_PACKET* PKISO_WUSB_PACKET;

#pragma warning(disable:4200)

typedef enum _KISO_FLAG
{
    KISO_FLAG_NONE = 0,


    KISO_FLAG_SET_START_FRAME = 0x00000001,
} KISO_FLAG;


typedef struct _KISO_CONTEXT
{
    KISO_FLAG Flags;


    UINT StartFrame;


    SHORT ErrorCount;

    /*
    * \note This field is assigned by the user application only and used by the driver upon transfer submission
    * and completion.
    */
    SHORT NumberOfPackets;


    UINT UrbHdrStatus;

    /*
    * \note This field is assigned by the user application, used by the driver upon transfer submission, and
    * updated by the driver upon transfer completion.
    */
    KISO_PACKET IsoPackets[0];
} KISO_CONTEXT;
USBK_C_ASSERT(KISO_CONTEXT,sizeof(KISO_CONTEXT) == 16);

typedef KISO_CONTEXT* PKISO_CONTEXT;


typedef struct _KISOCH_PACKET_INFORMATION
{

    UINT PacketsPerFrame;
    

    UINT PollingPeriodMicroseconds;



    UINT BytesPerMillisecond;

}KISOCH_PACKET_INFORMATION;

typedef KISOCH_PACKET_INFORMATION* PKISOCH_PACKET_INFORMATION;

#pragma warning(default:4200)

#include <poppack.h>

#endif // __LUSBK_SHARED_H_