reactos/w32api/include/ddk/usbscan.h

   1 /*
   2  * usbscan.h
   3  *
   4  * USB scanner definitions
   5  *
   6  * This file is part of the w32api package.
   7  *
   8  * Contributors:
   9  *   Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
  10  *
  11  * THIS SOFTWARE IS NOT COPYRIGHTED
  12  *
  13  * This source code is offered for use in the public domain. You may
  14  * use, modify or distribute it freely.
  15  *
  16  * This code is distributed in the hope that it will be useful but
  17  * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  18  * DISCLAIMED. This includes but is not limited to warranties of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20  *
  21  */
  22
  23 #ifndef __USBSCAN_H
  24 #define __USBSCAN_H
  25
  26 #if __GNUC__ >=3
  27 #pragma GCC system_header
  28 #endif
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #define FILE_DEVICE_USB_SCAN              0x8000
  35 #define IOCTL_INDEX                       0x0800
  36
  37 #define IOCTL_CANCEL_IO \
  38   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 1, METHOD_BUFFERED,FILE_ANY_ACCESS)
  39
  40 #define IOCTL_GET_VERSION \
  41   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 0, METHOD_BUFFERED,FILE_ANY_ACCESS)
  42
  43 #define IOCTL_GET_CHANNEL_ALIGN_RQST \
  44   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 5, METHOD_BUFFERED,FILE_ANY_ACCESS)
  45
  46 #define IOCTL_GET_DEVICE_DESCRIPTOR \
  47   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 6, METHOD_BUFFERED,FILE_ANY_ACCESS)
  48
  49 #define IOCTL_GET_PIPE_CONFIGURATION \
  50   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 10,METHOD_BUFFERED,FILE_ANY_ACCESS)
  51
  52 #define IOCTL_GET_USB_DESCRIPTOR \
  53   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 8, METHOD_BUFFERED,FILE_ANY_ACCESS)
  54
  55 #define IOCTL_READ_REGISTERS \
  56   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 3, METHOD_BUFFERED,FILE_ANY_ACCESS)
  57
  58 #define IOCTL_RESET_PIPE \
  59   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 7, METHOD_BUFFERED,FILE_ANY_ACCESS)
  60
  61 #define IOCTL_SEND_USB_REQUEST \
  62   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 9, METHOD_BUFFERED,FILE_ANY_ACCESS)
  63
  64 #define IOCTL_SET_TIMEOUT \
  65   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 11,METHOD_BUFFERED,FILE_ANY_ACCESS)
  66
  67 #define IOCTL_WAIT_ON_DEVICE_EVENT \
  68   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 2, METHOD_BUFFERED,FILE_ANY_ACCESS)
  69
  70 #define IOCTL_WRITE_REGISTERS \
  71   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 4, METHOD_BUFFERED, FILE_ANY_ACCESS)
  72
  73
  74 #define MAX_NUM_PIPES                     8
  75
  76 #define BULKIN_FLAG                       0x80
  77
  78 typedef struct _CHANNEL_INFO {
  79   OUT ULONG  EventChannelSize;
  80   OUT ULONG  uReadDataAlignment;
  81   OUT ULONG  uWriteDataAlignment;
  82 }CHANNEL_INFO, *PCHANNEL_INFO;
  83
  84 typedef struct _DEVICE_DESCRIPTOR {
  85   OUT USHORT  usVendorId;
  86   OUT USHORT  usProductId;
  87   OUT USHORT  usBcdDevice;
  88   OUT USHORT  usLanguageId;
  89 } DEVICE_DESCRIPTOR, *PDEVICE_DESCRIPTOR;
  90
  91 typedef struct _DRV_VERSION {
  92   OUT ULONG  major;
  93   OUT ULONG  minor;
  94   OUT ULONG  internal;
  95 } DRV_VERSION, *PDRV_VERSION;
  96
  97 typedef struct _IO_BLOCK {
  98   IN ULONG  uOffset;
  99   IN ULONG  uLength;
 100   IN OUT PUCHAR  pbyData;
 101   IN ULONG  uIndex;
 102 } IO_BLOCK, *PIO_BLOCK;
 103
 104 typedef struct _IO_BLOCK_EX {
 105   IN  ULONG  uOffset;
 106   IN  ULONG  uLength;
 107   IN OUT PUCHAR  pbyData;
 108   IN  ULONG  uIndex;
 109   IN  UCHAR  bRequest;
 110   IN  UCHAR  bmRequestType;
 111   IN  UCHAR  fTransferDirectionIn;
 112 } IO_BLOCK_EX, *PIO_BLOCK_EX;
 113
 114 typedef struct _USBSCAN_GET_DESCRIPTOR {
 115   IN UCHAR  DescriptorType;
 116   IN UCHAR  Index;
 117   IN USHORT  LanguageId;
 118 } USBSCAN_GET_DESCRIPTOR, *PUSBSCAN_GET_DESCRIPTOR;
 119
 120 typedef enum _RAW_PIPE_TYPE {
 121         USBSCAN_PIPE_CONTROL,
 122         USBSCAN_PIPE_ISOCHRONOUS,
 123         USBSCAN_PIPE_BULK,
 124         USBSCAN_PIPE_INTERRUPT
 125 } RAW_PIPE_TYPE;
 126
 127 typedef struct _USBSCAN_PIPE_INFORMATION {
 128   USHORT  MaximumPacketSize;
 129   UCHAR  EndpointAddress;
 130   UCHAR  Interval;
 131   RAW_PIPE_TYPE  PipeType;
 132 } USBSCAN_PIPE_INFORMATION, *PUSBSCAN_PIPE_INFORMATION;
 133
 134 typedef struct _USBSCAN_PIPE_CONFIGURATION {
 135   OUT ULONG  NumberOfPipes;
 136   OUT USBSCAN_PIPE_INFORMATION  PipeInfo[MAX_NUM_PIPES];
 137 } USBSCAN_PIPE_CONFIGURATION, *PUSBSCAN_PIPE_CONFIGURATION;
 138
 139 typedef struct _USBSCAN_TIMEOUT {
 140   IN ULONG  TimeoutRead;
 141   IN ULONG  TimeoutWrite;
 142   IN ULONG  TimeoutEvent;
 143 } USBSCAN_TIMEOUT, *PUSBSCAN_TIMEOUT;
 144
 145 typedef enum _PIPE_TYPE {
 146         EVENT_PIPE,
 147         READ_DATA_PIPE,
 148         WRITE_DATA_PIPE,
 149         ALL_PIPE
 150 } PIPE_TYPE;
 151
 152 #ifdef __cplusplus
 153 }
 154 #endif
 155
 156 #endif /* __USBSCAN_H */