include/windows.devices.usb.idl

   1 /*
   2  * Copyright (C) 2023 Mohamad Al-Jaf
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifdef __WIDL__
  20 #pragma winrt ns_prefix
  21 #endif
  22
  23 import "inspectable.idl";
  24 import "asyncinfo.idl";
  25 import "eventtoken.idl";
  26 import "windowscontracts.idl";
  27 import "windows.foundation.idl";
  28 import "windows.storage.streams.idl";
  29
  30 namespace Windows.Devices.Usb {
  31     interface IUsbDevice;
  32     interface IUsbDeviceClass;
  33     interface IUsbConfiguration;
  34     interface IUsbDeviceDescriptor;
  35     interface IUsbDeviceStatics;
  36     interface IUsbInterface;
  37     interface IUsbSetupPacket;
  38     interface IUsbSetupPacketFactory;
  39
  40     runtimeclass UsbConfiguration;
  41     runtimeclass UsbDevice;
  42     runtimeclass UsbDeviceClass;
  43     runtimeclass UsbDeviceDescriptor;
  44     runtimeclass UsbInterface;
  45     runtimeclass UsbSetupPacket;
  46
  47     declare {
  48         interface Windows.Foundation.AsyncOperationCompletedHandler<Windows.Devices.Usb.UsbDevice *>;
  49         interface Windows.Foundation.IAsyncOperation<Windows.Devices.Usb.UsbDevice *>;
  50     }
  51
  52     [
  53         contract(Windows.Foundation.UniversalApiContract, 1.0),
  54         exclusiveto(Windows.Devices.Usb.UsbDevice),
  55         uuid(5249b992-c456-44d5-ad5e-24f5a089f63b)
  56     ]
  57     interface IUsbDevice : IInspectable
  58         requires Windows.Foundation.IClosable
  59     {
  60         [overload("SendControlOutTransferAsync")]
  61         HRESULT SendControlOutTransferAsync(
  62             [in] Windows.Devices.Usb.UsbSetupPacket *packet,
  63             [in] Windows.Storage.Streams.IBuffer *buffer,
  64             [out, retval] Windows.Foundation.IAsyncOperation<UINT32> **operation
  65         );
  66         [overload("SendControlOutTransferAsync")]
  67         HRESULT SendControlOutTransferAsyncNoBuffer(
  68             [in] Windows.Devices.Usb.UsbSetupPacket *packet,
  69             [out, retval] Windows.Foundation.IAsyncOperation<UINT32> **operation
  70         );
  71         [overload("SendControlInTransferAsync")]
  72         HRESULT SendControlInTransferAsync(
  73             [in] Windows.Devices.Usb.UsbSetupPacket *packet,
  74             [in] Windows.Storage.Streams.IBuffer *buffer,
  75             [out, retval] Windows.Foundation.IAsyncOperation<Windows.Storage.Streams.IBuffer *> **operation
  76         );
  77         [overload("SendControlInTransferAsync")]
  78         HRESULT SendControlInTransferAsyncNoBuffer(
  79             [in] Windows.Devices.Usb.UsbSetupPacket *packet,
  80             [out, retval] Windows.Foundation.IAsyncOperation<Windows.Storage.Streams.IBuffer *> **operation
  81         );
  82         [propget] HRESULT DefaultInterface([out, retval] Windows.Devices.Usb.UsbInterface **value);
  83         [propget] HRESULT DeviceDescriptor([out, retval] Windows.Devices.Usb.UsbDeviceDescriptor **value);
  84         [propget] HRESULT Configuration([out, retval] Windows.Devices.Usb.UsbConfiguration **value);
  85     }
  86
  87     [
  88         contract(Windows.Foundation.UniversalApiContract, 1.0),
  89         exclusiveto(Windows.Devices.Usb.UsbDeviceClass),
  90         uuid(051942f9-845e-47eb-b12a-38f2f617afe7)
  91     ]
  92     interface IUsbDeviceClass : IInspectable
  93     {
  94         [propget] HRESULT ClassCode([out, retval] BYTE *value);
  95         [propput] HRESULT ClassCode([in] BYTE value);
  96         [propget] HRESULT SubclassCode([out, retval] Windows.Foundation.IReference<BYTE> **value);
  97         [propput] HRESULT SubclassCode([in] Windows.Foundation.IReference<BYTE> *value);
  98         [propget] HRESULT ProtocolCode([out, retval] Windows.Foundation.IReference<BYTE> **value);
  99         [propput] HRESULT ProtocolCode([in] Windows.Foundation.IReference<BYTE> *value);
 100     }
 101
 102     [
 103         contract(Windows.Foundation.UniversalApiContract, 1.0),
 104         exclusiveto(Windows.Devices.Usb.UsbDevice),
 105         uuid(066b85a2-09b7-4446-8502-6fe6dcaa7309)
 106     ]
 107     interface IUsbDeviceStatics : IInspectable
 108     {
 109         [overload("GetDeviceSelector")]
 110         HRESULT GetDeviceSelector([in] UINT32 vendor, [in] UINT32 product, [in] GUID class, [out, retval] HSTRING *value);
 111         [overload("GetDeviceSelector")]
 112         HRESULT GetDeviceSelectorGuidOnly([in] GUID class, [out, retval] HSTRING *value);
 113         [overload("GetDeviceSelector")]
 114         HRESULT GetDeviceSelectorVidPidOnly([in] UINT32 vendor, [in] UINT32 product, [out, retval] HSTRING *value);
 115         HRESULT GetDeviceClassSelector([in] Windows.Devices.Usb.UsbDeviceClass *class, [out, retval] HSTRING *value);
 116         HRESULT FromIdAsync([in] HSTRING id, [out, retval] Windows.Foundation.IAsyncOperation<Windows.Devices.Usb.UsbDevice *> **operation);
 117     }
 118
 119     [
 120         contract(Windows.Foundation.UniversalApiContract, 1.0),
 121         marshaling_behavior(agile)
 122     ]
 123     runtimeclass UsbConfiguration
 124     {
 125         [default] interface Windows.Devices.Usb.IUsbConfiguration;
 126     }
 127
 128     [
 129         contract(Windows.Foundation.UniversalApiContract, 1.0),
 130         marshaling_behavior(agile),
 131         static(Windows.Devices.Usb.IUsbDeviceStatics, Windows.Foundation.UniversalApiContract, 1.0)
 132     ]
 133     runtimeclass UsbDevice
 134     {
 135         [default] interface Windows.Devices.Usb.IUsbDevice;
 136         interface Windows.Foundation.IClosable;
 137     }
 138
 139     [
 140         activatable(Windows.Foundation.UniversalApiContract, 1.0),
 141         contract(Windows.Foundation.UniversalApiContract, 1.0),
 142         marshaling_behavior(agile)
 143     ]
 144     runtimeclass UsbDeviceClass
 145     {
 146         [default] interface Windows.Devices.Usb.IUsbDeviceClass;
 147     }
 148
 149     [
 150         contract(Windows.Foundation.UniversalApiContract, 1.0),
 151         marshaling_behavior(agile)
 152     ]
 153     runtimeclass UsbDeviceDescriptor
 154     {
 155         [default] interface Windows.Devices.Usb.IUsbDeviceDescriptor;
 156     }
 157
 158     [
 159         contract(Windows.Foundation.UniversalApiContract, 1.0),
 160         marshaling_behavior(agile)
 161     ]
 162     runtimeclass UsbInterface
 163     {
 164         [default] interface Windows.Devices.Usb.IUsbInterface;
 165     }
 166
 167     [
 168         activatable(Windows.Devices.Usb.IUsbSetupPacketFactory, Windows.Foundation.UniversalApiContract, 1.0),
 169         activatable(Windows.Foundation.UniversalApiContract, 1.0),
 170         contract(Windows.Foundation.UniversalApiContract, 1.0),
 171         marshaling_behavior(agile)
 172     ]
 173     runtimeclass UsbSetupPacket
 174     {
 175         [default] interface Windows.Devices.Usb.IUsbSetupPacket;
 176     }
 177 }