开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > MacOS编程 > 查看源码
usbioctl.h
资源名称：USBView.rar　[点击查看]
上传用户：gzccxsp
上传日期：2015-07-14
资源大小：182k
文件大小：19k
源码类别：

MacOS编程

开发平台：

Visual C++

usbioctl.h：源码内容
  1. /*++
  3. Copyright (c) 1998-99      Microsoft Corporation
  5. Module Name:
  7.         USBIOCTL.H
  9. Abstract:
  11.    structures common to the USBD and USB device drivers.
  13. Environment:
  15.     Kernel & user mode
  17. Revision History:
  19.     09-29-95 : created
  20.     01-06-97 : added user mode hub ioctls
  22. --*/
  24. #ifndef   __USBIOCTL_H__
  25. #define   __USBIOCTL_H__
  27. #include "usb100.h"
  29. #ifndef FAR
  30. #define FAR
  31. #endif
  33. /* f18a0e88-c30c-11d0-8815-00a0c906bed8 */
  34. DEFINE_GUID( GUID_CLASS_USBHUB,    0xf18a0e88, 0xc30c, 0x11d0, 0x88, 0x15, 0x00, 
  35.              0xa0, 0xc9, 0x06, 0xbe, 0xd8);
  37. /* A5DCBF10-6530-11D2-901F-00C04FB951ED */
  38. DEFINE_GUID(GUID_CLASS_USB_DEVICE, 0xA5DCBF10L, 0x6530, 0x11D2, 0x90, 0x1F, 0x00, 
  39.              0xC0, 0x4F, 0xB9, 0x51, 0xED);
  41. /* 4E623B20-CB14-11D1-B331-00A0C959BBD2 */
  42. DEFINE_GUID(GUID_USB_WMI_STD_DATA, 0x4E623B20L, 0xCB14, 0x11D1, 0xB3, 0x31, 0x00,
  43.              0xA0, 0xC9, 0x59, 0xBB, 0xD2);
  45. /* 4E623B20-CB14-11D1-B331-00A0C959BBD2 */
  46. DEFINE_GUID(GUID_USB_WMI_STD_NOTIFICATION, 0x4E623B20L, 0xCB14, 0x11D1, 0xB3, 0x31, 0x00,
  47.              0xA0, 0xC9, 0x59, 0xBB, 0xD2);             
  50. #define FILE_DEVICE_USB         FILE_DEVICE_UNKNOWN
  52. /*
  53.    USB IOCTLS
  54. */
  56. #define USB_IOCTL_INTERNAL_INDEX       0x0000
  57. #define USB_IOCTL_INDEX                0x00ff
  59. /*
  60.    USB Internal IOCtls
  61. */
  63. /* IOCTL_INTERNAL_USB_SUBMIT_URB
  65.    This IOCTL is used by client drivers to submit URB (USB Request Blocks)
  67.    Parameters.Others.Argument1 = pointer to URB
  69. */
  71. #define IOCTL_INTERNAL_USB_SUBMIT_URB  CTL_CODE(FILE_DEVICE_USB,  
  72.                                                 USB_IOCTL_INTERNAL_INDEX,  
  73.                                                 METHOD_NEITHER,  
  74.                                                 FILE_ANY_ACCESS)
  77. /* IOCTL_INTERNAL_USB_RESET_PORT
  78. */
  80. #define IOCTL_INTERNAL_USB_RESET_PORT  CTL_CODE(FILE_DEVICE_USB,  
  81.                                                 USB_IOCTL_INTERNAL_INDEX+1, 
  82.                                                 METHOD_NEITHER,  
  83.                                                 FILE_ANY_ACCESS)
  86. /*  IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO
  88.     This IOCTL is used internally by the hub driver
  90.     Parameters.Others.Argument1 = pointer to be filled in with RootHubPdo;
  91.     Parameters.Others.Argument2 = pointer to be filled in with HcdDeviceObject;
  93. */
  95. #define IOCTL_INTERNAL_USB_GET_ROOTHUB_PDO  CTL_CODE(FILE_DEVICE_USB,  
  96.                                                 USB_IOCTL_INTERNAL_INDEX+3, 
  97.                                                 METHOD_NEITHER,  
  98.                                                 FILE_ANY_ACCESS)
  102. /* IOCTL_INTERNAL_USB_GET_PORT_STATUS
  104.     This IOCTL returns the current port status
  106.     Parameters.Others.Argument1 = pointer to port status register (ULONG)
  108.     status bits are:
  110.     USBD_PORT_ENABLED
  112. */
  114. #define  USBD_PORT_ENABLED      0x00000001
  115. #define  USBD_PORT_CONNECTED    0x00000002
  118. #define IOCTL_INTERNAL_USB_GET_PORT_STATUS  CTL_CODE(FILE_DEVICE_USB,  
  119.                                                 USB_IOCTL_INTERNAL_INDEX+4, 
  120.                                                 METHOD_NEITHER,  
  121.                                                 FILE_ANY_ACCESS)
  123. /* IOCTL_INTERNAL_USB_ENABLE_PORT
  125.     This IOCTL will request the hub to re-enable a disabled port
  126. */
  128. #define IOCTL_INTERNAL_USB_ENABLE_PORT      CTL_CODE(FILE_DEVICE_USB,  
  129.                                                 USB_IOCTL_INTERNAL_INDEX+5, 
  130.                                                 METHOD_NEITHER,  
  131.                                                 FILE_ANY_ACCESS)
  133. /* IOCTL_INTERNAL_USB_GET_HUB_COUNT
  135.     This IOCTL is used internally by the hub driver
  137.     Parameters.Others.Argument1 = pointer to be count of hubs in chain;
  139. */
  140. #define IOCTL_INTERNAL_USB_GET_HUB_COUNT      CTL_CODE(FILE_DEVICE_USB,  
  141.                                                 USB_IOCTL_INTERNAL_INDEX+6, 
  142.                                                 METHOD_NEITHER,  
  143.                                                 FILE_ANY_ACCESS)
  145. /* IOCTL_INTERNAL_USB_CYCLE_PORT
  147.     This will simulate a plug/unplug on the port
  148. */
  150. #define IOCTL_INTERNAL_USB_CYCLE_PORT  CTL_CODE(FILE_DEVICE_USB,  
  151.                                                 USB_IOCTL_INTERNAL_INDEX+7, 
  152.                                                 METHOD_NEITHER,  
  153.                                                 FILE_ANY_ACCESS)
  155. #define IOCTL_INTERNAL_USB_GET_HUB_NAME  CTL_CODE(FILE_DEVICE_USB,  
  156.                                                 USB_IOCTL_INTERNAL_INDEX+8,  
  157.                                                 METHOD_BUFFERED,  
  158.                                                 FILE_ANY_ACCESS)
  160. #define IOCTL_INTERNAL_USB_GET_BUS_INFO  CTL_CODE(FILE_DEVICE_USB,  
  161.                                                 USB_IOCTL_INDEX+9,  
  162.                                                 METHOD_BUFFERED,  
  163.                                                 FILE_ANY_ACCESS)   
  165. #define IOCTL_INTERNAL_USB_GET_CONTROLLER_NAME  CTL_CODE(FILE_DEVICE_USB,  
  166.                                                 USB_IOCTL_INDEX+10,  
  167.                                                 METHOD_BUFFERED,  
  168.                                                 FILE_ANY_ACCESS) 
  170. #define IOCTL_INTERNAL_USB_GET_BUSGUID_INFO   CTL_CODE(FILE_DEVICE_USB,  
  171.                                                 USB_IOCTL_INDEX+11,  
  172.                                                 METHOD_BUFFERED,  
  173.                                                 FILE_ANY_ACCESS)                                                  
  175. #define IOCTL_INTERNAL_USB_GET_PARENT_HUB_INFO   CTL_CODE(FILE_DEVICE_USB,  
  176.                                                 USB_IOCTL_INDEX+12,  
  177.                                                 METHOD_BUFFERED,  
  178.                                                 FILE_ANY_ACCESS)                                                    
  179. /*
  180.    USB Public IOCtls
  181. */
  183. /************************************************************
  184. The following IOCTLS are always sent to the HCD symbolic 
  185. name
  186. *************************************************************/
  189. /*
  190.    this ioctl is for adding debug hooks to HCDs
  191. */
  193. #define IOCTL_USB_HCD_GET_STATS_1          CTL_CODE(FILE_DEVICE_USB,  
  194.                                                 USB_IOCTL_INDEX,  
  195.                                                 METHOD_BUFFERED,  
  196.                                                 FILE_ANY_ACCESS)
  198. #define IOCTL_USB_HCD_GET_STATS_2          CTL_CODE(FILE_DEVICE_USB,  
  199.                                                 USB_IOCTL_INDEX+11,  
  200.                                                 METHOD_BUFFERED,  
  201.                                                 FILE_ANY_ACCESS)                                                
  203. /*
  204.    These ioctls are used for USB diagnostic and test applications
  205. */
  207. #define IOCTL_USB_DIAGNOSTIC_MODE_ON   CTL_CODE(FILE_DEVICE_USB,  
  208.                                                 USB_IOCTL_INDEX+1,  
  209.                                                 METHOD_BUFFERED,  
  210.                                                 FILE_ANY_ACCESS)
  212. #define IOCTL_USB_DIAGNOSTIC_MODE_OFF  CTL_CODE(FILE_DEVICE_USB,  
  213.                                                 USB_IOCTL_INDEX+2,  
  214.                                                 METHOD_BUFFERED,  
  215.                                                 FILE_ANY_ACCESS)
  217. #define IOCTL_USB_GET_ROOT_HUB_NAME  CTL_CODE(FILE_DEVICE_USB,  
  218.                                                 USB_IOCTL_INDEX+3,  
  219.                                                 METHOD_BUFFERED,  
  220.                                                 FILE_ANY_ACCESS)   
  222. #define IOCTL_GET_HCD_DRIVERKEY_NAME CTL_CODE(FILE_DEVICE_USB,  
  223.                                                 USB_IOCTL_INDEX+10,  
  224.                                                 METHOD_BUFFERED,  
  225.                                                 FILE_ANY_ACCESS)                                                
  228. /*********************************************************
  229. The following IOCTLS are always sent to symbolic names 
  230. created by usbhub
  231. **********************************************************/                                                
  233. /*
  234.     Utility IOCTLS supported by the hub device
  235. */
  237. /*
  238.    These ioctls are supported by the hub driver for
  239.    use by user mode USB utilities.
  240. */
  243. #define IOCTL_USB_GET_NODE_INFORMATION   CTL_CODE(FILE_DEVICE_USB,  
  244.                                                USB_IOCTL_INDEX+3,  
  245.                                                METHOD_BUFFERED,  
  246.                                                FILE_ANY_ACCESS)
  248. #define IOCTL_USB_GET_NODE_CONNECTION_INFORMATION       CTL_CODE(FILE_DEVICE_USB,  
  249.                                                 USB_IOCTL_INDEX+4,  
  250.                                                 METHOD_BUFFERED,  
  251.                                                 FILE_ANY_ACCESS)
  253. #define IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION   CTL_CODE(FILE_DEVICE_USB,  
  254.                                                 USB_IOCTL_INDEX+5,  
  255.                                                 METHOD_BUFFERED,  
  256.                                                 FILE_ANY_ACCESS)
  258. #define IOCTL_USB_GET_NODE_CONNECTION_NAME     CTL_CODE(FILE_DEVICE_USB,  
  259.                                                 USB_IOCTL_INDEX+6,  
  260.                                                 METHOD_BUFFERED,  
  261.                                                 FILE_ANY_ACCESS)
  263. #define IOCTL_USB_DIAG_IGNORE_HUBS_ON   CTL_CODE(FILE_DEVICE_USB,  
  264.                                                 USB_IOCTL_INDEX+7,  
  265.                                                 METHOD_BUFFERED,  
  266.                                                 FILE_ANY_ACCESS)
  268. #define IOCTL_USB_DIAG_IGNORE_HUBS_OFF  CTL_CODE(FILE_DEVICE_USB,  
  269.                                                 USB_IOCTL_INDEX+8,  
  270.                                                 METHOD_BUFFERED,  
  271.                                                 FILE_ANY_ACCESS)
  273. #define IOCTL_USB_GET_NODE_CONNECTION_DRIVERKEY_NAME  CTL_CODE(FILE_DEVICE_USB,  
  274.                                                 USB_IOCTL_INDEX+9,  
  275.                                                 METHOD_BUFFERED,  
  276.                                                 FILE_ANY_ACCESS)
  278. /*
  279.    structures for user mode ioctls
  280. */
  282. #include <pshpack1.h>
  284. typedef enum _USB_HUB_NODE {
  285.     UsbHub,
  286.     UsbMIParent
  287. } USB_HUB_NODE;
  289. typedef struct _USB_HUB_INFORMATION {
  290.     /*
  291.        copy of data from hub descriptor
  292.     */
  293.     USB_HUB_DESCRIPTOR HubDescriptor;
  295.     BOOLEAN HubIsBusPowered;
  297. } USB_HUB_INFORMATION, *PUSB_HUB_INFORMATION;
  299. typedef struct _USB_MI_PARENT_INFORMATION {
  300.     ULONG NumberOfInterfaces;
  301. } USB_MI_PARENT_INFORMATION, *PUSB_MI_PARENT_INFORMATION;
  303. typedef struct _USB_NODE_INFORMATION {
  304.     USB_HUB_NODE NodeType;        /* hub, mi parent */
  305.     union {
  306.         USB_HUB_INFORMATION HubInformation;
  307.         USB_MI_PARENT_INFORMATION MiParentInformation;
  308.     } u;
  309. } USB_NODE_INFORMATION, *PUSB_NODE_INFORMATION;
  311. typedef struct _USB_PIPE_INFO {
  312.     USB_ENDPOINT_DESCRIPTOR EndpointDescriptor;
  313.     ULONG ScheduleOffset;
  314. } USB_PIPE_INFO, *PUSB_PIPE_INFO;
  317. typedef enum _USB_CONNECTION_STATUS {
  318.     NoDeviceConnected,
  319.     DeviceConnected,
  321.     /* failure codes, these map to fail reasons */
  322.     DeviceFailedEnumeration,
  323.     DeviceGeneralFailure,
  324.     DeviceCausedOvercurrent,
  325.     DeviceNotEnoughPower,
  326.     
  327.     DeviceNotEnoughBandwidth        
  328. } USB_CONNECTION_STATUS, *PUSB_CONNECTION_STATUS;
  330. typedef struct _USB_NODE_CONNECTION_INFORMATION {
  331.     ULONG ConnectionIndex;
  332.     /* usb device descriptor returned by this device
  333.        during enumeration */
  334.     USB_DEVICE_DESCRIPTOR DeviceDescriptor;
  335.     UCHAR CurrentConfigurationValue;
  336.     BOOLEAN LowSpeed;
  338.     BOOLEAN DeviceIsHub;
  340.     USHORT DeviceAddress;
  342.     ULONG NumberOfOpenPipes;
  344.     USB_CONNECTION_STATUS ConnectionStatus;
  345.     USB_PIPE_INFO PipeList[0];
  346. } USB_NODE_CONNECTION_INFORMATION, *PUSB_NODE_CONNECTION_INFORMATION;
  348. typedef struct _USB_NODE_CONNECTION_DRIVERKEY_NAME {
  349.     ULONG ConnectionIndex;  /* INPUT */
  350.     ULONG ActualLength;     /* OUTPUT */
  351.     /* unicode name for the devnode. */
  352.     WCHAR DriverKeyName[1];      /* OUTPUT */
  353. } USB_NODE_CONNECTION_DRIVERKEY_NAME, *PUSB_NODE_CONNECTION_DRIVERKEY_NAME;
  355. typedef struct _USB_NODE_CONNECTION_NAME {
  356.     ULONG ConnectionIndex;  /* INPUT */
  357.     ULONG ActualLength;     /* OUTPUT */
  358.     /* unicode symbolic name for this node if it is a hub or parent driver
  359.        null if this node is a device. */
  360.     WCHAR NodeName[1];      /* OUTPUT */
  361. } USB_NODE_CONNECTION_NAME, *PUSB_NODE_CONNECTION_NAME;
  364. typedef struct _USB_HUB_NAME {
  365.     ULONG ActualLength;     /* OUTPUT */
  366.     /* NULL terminated unicode symbolic name for the root hub */
  367.     WCHAR HubName[1];       /* OUTPUT */
  368. } USB_HUB_NAME, *PUSB_HUB_NAME;
  370. typedef struct _USB_ROOT_HUB_NAME {
  371.     ULONG ActualLength;     /* OUTPUT */
  372.     /* NULL terminated unicode symbolic name for the root hub */
  373.     WCHAR RootHubName[1];   /* OUTPUT */
  374. } USB_ROOT_HUB_NAME, *PUSB_ROOT_HUB_NAME;
  376. typedef struct _USB_HCD_DRIVERKEY_NAME {
  377.     ULONG ActualLength;     /* OUTPUT */
  378.     /* NULL terminated unicode driverkeyname for hcd */
  379.     WCHAR DriverKeyName[1];   /* OUTPUT */
  380. } USB_HCD_DRIVERKEY_NAME, *PUSB_HCD_DRIVERKEY_NAME;
  382. typedef struct _USB_DESCRIPTOR_REQUEST {
  383.     ULONG ConnectionIndex;
  384.     struct {
  385.         UCHAR bmRequest;
  386.         UCHAR bRequest;
  387.         USHORT wValue;
  388.         USHORT wIndex;
  389.         USHORT wLength;
  390.     } SetupPacket;
  391.     UCHAR Data[0];
  392. } USB_DESCRIPTOR_REQUEST, *PUSB_DESCRIPTOR_REQUEST;
  395. /*
  396.    Structure for returning HCD debug and statistic information to
  397.    a user mode application.
  398. */
  400. typedef struct _HCD_STAT_COUNTERS {
  401.     ULONG BytesTransferred;
  403.     USHORT IsoMissedCount;
  404.     USHORT DataOverrunErrorCount;
  406.     USHORT CrcErrorCount;
  407.     USHORT ScheduleOverrunCount;
  409.     USHORT TimeoutErrorCount;
  410.     USHORT InternalHcErrorCount;
  412.     USHORT BufferOverrunErrorCount;
  413.     USHORT SWErrorCount;
  415.     USHORT StallPidCount;
  416.     USHORT PortDisableCount;
  418. } HCD_STAT_COUNTERS, *PHCD_STAT_COUNTERS;
  421. typedef struct _HCD_ISO_STAT_COUNTERS {
  423.     USHORT  LateUrbs;
  424.     USHORT  DoubleBufferedPackets;
  426.     USHORT  TransfersCF_5ms;
  427.     USHORT  TransfersCF_2ms;
  429.     USHORT  TransfersCF_1ms;
  430.     USHORT  MaxInterruptLatency;
  431.     
  432.     USHORT  BadStartFrame;
  433.     USHORT  StaleUrbs;
  435.     USHORT  IsoPacketNotAccesed;
  436.     USHORT  IsoPacketHWError;
  438.     USHORT  SmallestUrbPacketCount;
  439.     USHORT  LargestUrbPacketCount;
  441.     USHORT IsoCRC_Error;
  442.     USHORT IsoOVERRUN_Error;
  443.     USHORT IsoINTERNAL_Error;
  444.     USHORT IsoUNKNOWN_Error; 
  446.     ULONG  IsoBytesTransferred;
  448.     USHORT LateMissedCount;
  449.     USHORT HWIsoMissedCount;
  450.     
  451.     ULONG  Reserved7[8];
  452.     
  453. } HCD_ISO_STAT_COUNTERS, *PHCD_ISO_STAT_COUNTERS;
  457. typedef struct _HCD_STAT_INFORMATION_1 {
  458.     ULONG Reserved1;
  459.     ULONG Reserved2;
  460.     ULONG ResetCounters;
  461.     LARGE_INTEGER TimeRead;
  462.     /*
  463.        stat registers
  464.     */
  465.     HCD_STAT_COUNTERS Counters;
  467. } HCD_STAT_INFORMATION_1, *PHCD_STAT_INFORMATION_1;
  469. typedef struct _HCD_STAT_INFORMATION_2 {
  470.     ULONG Reserved1;
  471.     ULONG Reserved2;
  472.     ULONG ResetCounters;
  473.     LARGE_INTEGER TimeRead;
  475.     LONG LockedMemoryUsed;
  476.     /*
  477.        stat registers
  478.     */
  479.     HCD_STAT_COUNTERS Counters;
  480.     HCD_ISO_STAT_COUNTERS IsoCounters;
  482. } HCD_STAT_INFORMATION_2, *PHCD_STAT_INFORMATION_2;
  485. /*
  486.    WMI related structures
  487. */
  489. /* these index in to our array of guids */
  490. #define WMI_USB_DRIVER_INFORMATION      0
  491. #define WMI_USB_DRIVER_NOTIFICATION     1
  493. typedef enum _USB_NOTIFICATION_TYPE {
  495.     /*  the following return a 
  496.         USB_CONNECTION_NOTIFICATION structure: */
  497.     EnumerationFailure = 0,
  498.     InsufficentBandwidth,
  499.     InsufficentPower,
  500.     OverCurrent,
  501.     ResetOvercurrent,
  503.     /* the following return a 
  504.        USB_BUS_NOTIFICATION structure:*/
  505.     AcquireBusInfo,
  507.     /* the following return a 
  508.       USB_ACQUIRE_INFO structure: */
  509.     AcquireHubName,
  510.     AcquireControllerName,
  512.     /* the following return a 
  513.        USB_HUB_NOTIFICATION structure: */
  514.     HubOvercurrent,
  515.     HubPowerChange,
  516.     
  517. } USB_NOTIFICATION_TYPE;
  519. typedef struct _USB_NOTIFICATION {
  520.     /* indicates type of notification */
  521.     USB_NOTIFICATION_TYPE NotificationType;     
  522.     
  523. } USB_NOTIFICATION, *PUSB_NOTIFICATION;
  525. /* this structure is used for connection notification
  526.    codes */
  527.  
  528. typedef struct _USB_CONNECTION_NOTIFICATION {
  529.     /* indicates type of notification */
  530.     USB_NOTIFICATION_TYPE NotificationType;     
  532.     /* valid for all connection notifictaion codes,
  533.        0 indicates global condition for hub or parent 
  534.        this value will be a port number for devices
  535.        attached to a hub, otherwise a one based 
  536.        index if the device is a child of a composite 
  537.        parent */
  538.     ULONG ConnectionNumber;
  540.     /* valid for InsufficentBandwidth,
  541.        the amount of bandwidth the device 
  542.        tried to allocate and was denied. */
  543.     ULONG RequestedBandwidth;     
  545.     /* valid for EnumerationFailure, 
  546.        gives some indication why the device failed 
  547.        to enumerate */
  548.     ULONG EnumerationFailReason;
  550.     /* valid for InsufficentPower,
  551.        the amount of power requested to configure 
  552.        this device. */
  553.     ULONG PowerRequested;
  555.     /* length of the UNICODE symbolic name (in bytes) for the HUB 
  556.        that this device is attached to.
  557.        not including NULL */
  558.     ULONG HubNameLength;
  559.     
  560. } USB_CONNECTION_NOTIFICATION, *PUSB_CONNECTION_NOTIFICATION;
  562. /*
  563.    This structure is used for the bus notification code 'AcquireBusInfo'
  564. */
  566. typedef struct _USB_BUS_NOTIFICATION {
  567.     /* indicates type of notification */
  568.     USB_NOTIFICATION_TYPE NotificationType;     /* indicates type of 
  569.                                                    notification */
  570.     ULONG TotalBandwidth;
  571.     ULONG ConsumedBandwidth;
  573.     /* length of the UNICODE symbolic name (in bytes) for the controller 
  574.        that this device is attached to.
  575.        not including NULL */
  576.     ULONG ControllerNameLength; 
  578. } USB_BUS_NOTIFICATION, *PUSB_BUS_NOTIFICATION;
  580. /*
  581.    used to acquire user mode filenames to open respective objects
  582. */
  584. typedef struct _USB_ACQUIRE_INFO {
  585.     /* indicates type of notification */
  586.     USB_NOTIFICATION_TYPE NotificationType;     
  587.     /* TotalSize of this struct */
  588.     ULONG TotalSize;                            
  590.     WCHAR Buffer[1];
  591. } USB_ACQUIRE_INFO, *PUSB_ACQUIRE_INFO;
  594. #include <poppack.h>
  597. #endif /* __USBIOCTL_H__ */