reactos/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 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 #define FILE_DEVICE_USB_SCAN              0x8000
  31 #define IOCTL_INDEX                       0x0800
  32
  33 #define IOCTL_CANCEL_IO \
  34   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 1, METHOD_BUFFERED,FILE_ANY_ACCESS)
  35
  36 #define IOCTL_GET_VERSION \
  37   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 0, METHOD_BUFFERED,FILE_ANY_ACCESS)
  38
  39 #define IOCTL_GET_CHANNEL_ALIGN_RQST \
  40   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 5, METHOD_BUFFERED,FILE_ANY_ACCESS)
  41
  42 #define IOCTL_GET_DEVICE_DESCRIPTOR \
  43   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 6, METHOD_BUFFERED,FILE_ANY_ACCESS)
  44
  45 #define IOCTL_GET_PIPE_CONFIGURATION \
  46   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 10,METHOD_BUFFERED,FILE_ANY_ACCESS)
  47
  48 #define IOCTL_GET_USB_DESCRIPTOR \
  49   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 8, METHOD_BUFFERED,FILE_ANY_ACCESS)
  50
  51 #define IOCTL_READ_REGISTERS \
  52   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 3, METHOD_BUFFERED,FILE_ANY_ACCESS)
  53
  54 #define IOCTL_RESET_PIPE \
  55   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 7, METHOD_BUFFERED,FILE_ANY_ACCESS)
  56
  57 #define IOCTL_SEND_USB_REQUEST \
  58   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 9, METHOD_BUFFERED,FILE_ANY_ACCESS)
  59
  60 #define IOCTL_SET_TIMEOUT \
  61   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 11,METHOD_BUFFERED,FILE_ANY_ACCESS)
  62
  63 #define IOCTL_WAIT_ON_DEVICE_EVENT \
  64   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 2, METHOD_BUFFERED,FILE_ANY_ACCESS)
  65
  66 #define IOCTL_WRITE_REGISTERS \
  67   CTL_CODE(FILE_DEVICE_USB_SCAN, IOCTL_INDEX + 4, METHOD_BUFFERED, FILE_ANY_ACCESS)
  68
  69
  70 #define MAX_NUM_PIPES                     8
  71
  72 #define BULKIN_FLAG                       0x80
  73
  74 typedef struct _CHANNEL_INFO {
  75   OUT ULONG  EventChannelSize;
  76   OUT ULONG  uReadDataAlignment;
  77   OUT ULONG  uWriteDataAlignment;
  78 }CHANNEL_INFO, *PCHANNEL_INFO;
  79
  80 typedef struct _DEVICE_DESCRIPTOR {
  81   OUT USHORT  usVendorId;
  82   OUT USHORT  usProductId;
  83   OUT USHORT  usBcdDevice;
  84   OUT USHORT  usLanguageId;
  85 } DEVICE_DESCRIPTOR, *PDEVICE_DESCRIPTOR;
  86
  87 typedef struct _DRV_VERSION {
  88   OUT ULONG  major;
  89   OUT ULONG  minor;
  90   OUT ULONG  internal;
  91 } DRV_VERSION, *PDRV_VERSION;
  92
  93 typedef struct _IO_BLOCK {
  94   IN ULONG  uOffset;
  95   IN ULONG  uLength;
  96   IN OUT PUCHAR  pbyData;
  97   IN ULONG  uIndex;
  98 } IO_BLOCK, *PIO_BLOCK;
  99
 100 typedef struct _IO_BLOCK_EX {
 101   IN  ULONG  uOffset;
 102   IN  ULONG  uLength;
 103   IN OUT PUCHAR  pbyData;
 104   IN  ULONG  uIndex;
 105   IN  UCHAR  bRequest;
 106   IN  UCHAR  bmRequestType;
 107   IN  UCHAR  fTransferDirectionIn;
 108 } IO_BLOCK_EX, *PIO_BLOCK_EX;
 109
 110 typedef struct _USBSCAN_GET_DESCRIPTOR {
 111   IN UCHAR  DescriptorType;
 112   IN UCHAR  Index;
 113   IN USHORT  LanguageId;
 114 } USBSCAN_GET_DESCRIPTOR, *PUSBSCAN_GET_DESCRIPTOR;
 115
 116 typedef enum _RAW_PIPE_TYPE {
 117         USBSCAN_PIPE_CONTROL,
 118         USBSCAN_PIPE_ISOCHRONOUS,
 119         USBSCAN_PIPE_BULK,
 120         USBSCAN_PIPE_INTERRUPT
 121 } RAW_PIPE_TYPE;
 122
 123 typedef struct _USBSCAN_PIPE_INFORMATION {
 124   USHORT  MaximumPacketSize;
 125   UCHAR  EndpointAddress;
 126   UCHAR  Interval;
 127   RAW_PIPE_TYPE  PipeType;
 128 } USBSCAN_PIPE_INFORMATION, *PUSBSCAN_PIPE_INFORMATION;
 129
 130 typedef struct _USBSCAN_PIPE_CONFIGURATION {
 131   OUT ULONG  NumberOfPipes;
 132   OUT USBSCAN_PIPE_INFORMATION  PipeInfo[MAX_NUM_PIPES];
 133 } USBSCAN_PIPE_CONFIGURATION, *PUSBSCAN_PIPE_CONFIGURATION;
 134
 135 typedef struct _USBSCAN_TIMEOUT {
 136   IN ULONG  TimeoutRead;
 137   IN ULONG  TimeoutWrite;
 138   IN ULONG  TimeoutEvent;
 139 } USBSCAN_TIMEOUT, *PUSBSCAN_TIMEOUT;
 140
 141 typedef enum _PIPE_TYPE {
 142         EVENT_PIPE,
 143         READ_DATA_PIPE,
 144         WRITE_DATA_PIPE,
 145         ALL_PIPE
 146 } PIPE_TYPE;
 147
 148 #ifdef __cplusplus
 149 }
 150 #endif
 151
 152 #endif /* __USBSCAN_H */