ホーム › Devices.Usb › WinUsb_ControlTransfer

WinUsb_ControlTransfer

関数

デフォルトエンドポイントを介して制御転送を行う。

DLLWINUSB.dll呼出規約winapiSetLastErrorあり

シグネチャ

// WINUSB.dll
#include <windows.h>

BOOL WinUsb_ControlTransfer(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    WINUSB_SETUP_PACKET SetupPacket,
    BYTE* Buffer,   // optional
    DWORD BufferLength,
    DWORD* LengthTransferred,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前	型	方向	説明
InterfaceHandle	WINUSB_INTERFACE_HANDLE	in	選択された構成内のインターフェイスを表す不透明なハンドル。コントロール要求の受信側としてデバイス全体または最初のインターフェイスを指定するには、WinUsb_Initialize が返したハンドルを使用します。それ以外のインターフェイスの場合は、WinUsb_GetAssociatedInterface を呼び出して対象インターフェイスのハンドルを取得し、取得したインターフェイスハンドルを指定して WinUsb_ControlTransfer を呼び出します。
SetupPacket	WINUSB_SETUP_PACKET	in	WINUSB_SETUP_PACKET 型の 8 バイトのセットアップパケット。
Buffer	BYTE*	outoptional	転送するデータを格納する、呼び出し元が割り当てたバッファー。このバッファーの長さは 4KB を超えてはなりません。
BufferLength	DWORD	in	転送するバイト数(セットアップパケットは含みません)。この値は Buffer のサイズ(バイト単位)以下でなければなりません。
LengthTransferred	DWORD*	outoptional	実際に転送されたバイト数を受け取る ULONG 変数へのポインター。データフェーズでデータが転送されないことをアプリケーションが想定している場合(BufferLength が 0 の場合)、LengthTransferred は NULL にできます。
Overlapped	OVERLAPPED*	inoptional	非同期操作に使用する OVERLAPPED 構造体への省略可能なポインター。このパラメーターを指定した場合、WinUsb_ControlTransfer は直ちに戻り、操作が完了した時点でイベントがシグナル状態になります。Overlapped を指定しない場合、WinUsb_ControlTransfer 関数はデータを同期的に転送します。

戻り値の型: BOOL

公式ドキュメント

WinUsb_ControlTransfer 関数は、既定のコントロールエンドポイントを介してコントロールデータを転送します。

戻り値

WinUsb_ControlTransfer は、操作が成功した場合に TRUE を返します。それ以外の場合、このルーチンは FALSE を返し、呼び出し元は GetLastError を呼び出すことで記録されたエラーを取得できます。

GetLastError は次のいずれかのエラーコードを返すことがあります。

戻り値	説明
ERROR_INVALID_HANDLE	呼び出し元が InterfaceHandle パラメーターに NULL を渡しました。
ERROR_NOT_ENOUGH_MEMORY	操作を実行するのに十分なメモリがないことを示します。

解説(Remarks)

コントロール要求は常にホストから USB デバイスの既定のエンドポイントへ送信されますが、要求の受信側はデバイス全体、インターフェイス、または選択された代替設定内のエンドポイントのいずれかになります。WinUsb_ControlTransfer の呼び出しでは、アプリケーションは InterfaceHandle と SetupPacket の 2 つのパラメーターによって受信側を示す必要があります。

コントロール要求の受信側がデバイス全体、最初のインターフェイス、またはそのインターフェイス内のいずれかのエンドポイントである場合、アプリケーションは WinUsb_Initialize が返したハンドルを使用する必要があります。受信側がそれ以外のインターフェイスまたはそのエンドポイントである場合は、WinUsb_GetAssociatedInterface を呼び出して対象インターフェイスに関連付けられた WinUSB ハンドルを取得し、取得したインターフェイスハンドルを指定して WinUsb_ControlTransfer を呼び出す必要があります。

公式の USB 仕様のセクション 9.3 に記載されているとおり、コントロール転送のセットアップトークンには要求に関する情報が含まれます。WinUSB アプリケーションでは、このセットアップトークンは WINUSB_SETUP_PACKET 構造体を使用して記述されます。

セットアップトークン内では、bmRequestType フィールドと wIndex フィールドが要求の受信側を示すために使用されます。これらのフィールドは、それぞれ WINUSB_SETUP_PACKET の RequestType メンバーと Index メンバーに対応します。

RequestType の下位 2 ビットは要求の受信側を示します。受信側は、デバイス、インターフェイス、エンドポイント、またはその他(ベンダー要求の場合)のいずれかです。受信側に応じて、Index の下位バイトは受信側のデバイス定義のインデックスを示します。Index の値は要求の種類によって異なります。たとえば、標準のコントロール要求では値は 0 か、インターフェイス番号またはエンドポイント番号を示します。文字列記述子を取得する GET_DESCRIPTOR 要求など、特定の種類の標準要求では、Index の値は言語 ID を示します。

受信側がデバイスの場合、アプリケーションは RequestType と Index の値を設定する必要があります。RequestType の値の下位 2 ビットは 0 でなければなりません。Index の値の下位バイトは要求の種類によって異なります。InterfaceHandle は WinUsb_Initialize が返した WinUSB ハンドルでなければなりません。

要求の受信側がインターフェイスの場合、アプリケーションは RequestType の下位 2 ビットを 0x01 に設定する必要があります。どの種類の要求であっても、アプリケーションが Index の下位バイトを設定する必要はありません。標準要求、クラス要求、およびベンダー要求では、Winusb.sys がその値を対象インターフェイスのインターフェイス番号に設定します。InterfaceHandle は対象インターフェイスに関連付けられている必要があります。アプリケーションは WinUsb_GetAssociatedInterface を呼び出すことでそのハンドルを取得できます。

受信側がエンドポイントの場合、アプリケーションは RequestType の下位 2 ビットを 0x02 に設定し、Index の下位バイトをエンドポイントアドレスに設定する必要があります。この場合、InterfaceHandle はそのエンドポイントを含むインターフェイスに関連付けられます。アプリケーションは WinUsb_GetAssociatedInterface を呼び出すことでそのハンドルを取得できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WINUSB.dll
#include <windows.h>

BOOL WinUsb_ControlTransfer(
    WINUSB_INTERFACE_HANDLE InterfaceHandle,
    WINUSB_SETUP_PACKET SetupPacket,
    BYTE* Buffer,   // optional
    DWORD BufferLength,
    DWORD* LengthTransferred,   // optional
    OVERLAPPED* Overlapped   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINUSB.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinUsb_ControlTransfer(
    IntPtr InterfaceHandle,   // WINUSB_INTERFACE_HANDLE
    WINUSB_SETUP_PACKET SetupPacket,   // WINUSB_SETUP_PACKET
    IntPtr Buffer,   // BYTE* optional, out
    uint BufferLength,   // DWORD
    IntPtr LengthTransferred,   // DWORD* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional
);

<DllImport("WINUSB.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinUsb_ControlTransfer(
    InterfaceHandle As IntPtr,   ' WINUSB_INTERFACE_HANDLE
    SetupPacket As WINUSB_SETUP_PACKET,   ' WINUSB_SETUP_PACKET
    Buffer As IntPtr,   ' BYTE* optional, out
    BufferLength As UInteger,   ' DWORD
    LengthTransferred As IntPtr,   ' DWORD* optional, out
    Overlapped As IntPtr   ' OVERLAPPED* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' InterfaceHandle : WINUSB_INTERFACE_HANDLE
' SetupPacket : WINUSB_SETUP_PACKET
' Buffer : BYTE* optional, out
' BufferLength : DWORD
' LengthTransferred : DWORD* optional, out
' Overlapped : OVERLAPPED* optional
Declare PtrSafe Function WinUsb_ControlTransfer Lib "winusb" ( _
    ByVal InterfaceHandle As LongPtr, _
    ByVal SetupPacket As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByVal BufferLength As Long, _
    ByVal LengthTransferred As LongPtr, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinUsb_ControlTransfer = ctypes.windll.winusb.WinUsb_ControlTransfer
WinUsb_ControlTransfer.restype = wintypes.BOOL
WinUsb_ControlTransfer.argtypes = [
    wintypes.HANDLE,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    WINUSB_SETUP_PACKET,  # SetupPacket : WINUSB_SETUP_PACKET
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* optional, out
    wintypes.DWORD,  # BufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # LengthTransferred : DWORD* optional, out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINUSB.dll')
WinUsb_ControlTransfer = Fiddle::Function.new(
  lib['WinUsb_ControlTransfer'],
  [
    Fiddle::TYPE_VOIDP,  # InterfaceHandle : WINUSB_INTERFACE_HANDLE
    Fiddle::TYPE_VOIDP,  # SetupPacket : WINUSB_SETUP_PACKET
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* optional, out
    -Fiddle::TYPE_INT,  # BufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # LengthTransferred : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "winusb")]
extern "system" {
    fn WinUsb_ControlTransfer(
        InterfaceHandle: *mut core::ffi::c_void,  // WINUSB_INTERFACE_HANDLE
        SetupPacket: WINUSB_SETUP_PACKET,  // WINUSB_SETUP_PACKET
        Buffer: *mut u8,  // BYTE* optional, out
        BufferLength: u32,  // DWORD
        LengthTransferred: *mut u32,  // DWORD* optional, out
        Overlapped: *mut OVERLAPPED  // OVERLAPPED* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINUSB.dll", SetLastError = true)]
public static extern bool WinUsb_ControlTransfer(IntPtr InterfaceHandle, WINUSB_SETUP_PACKET SetupPacket, IntPtr Buffer, uint BufferLength, IntPtr LengthTransferred, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINUSB_WinUsb_ControlTransfer' -Namespace Win32 -PassThru
# $api::WinUsb_ControlTransfer(InterfaceHandle, SetupPacket, Buffer, BufferLength, LengthTransferred, Overlapped)

#uselib "WINUSB.dll"
#func global WinUsb_ControlTransfer "WinUsb_ControlTransfer" sptr, sptr, sptr, sptr, sptr, sptr
; WinUsb_ControlTransfer InterfaceHandle, SetupPacket, varptr(Buffer), BufferLength, varptr(LengthTransferred), varptr(Overlapped)   ; 戻り値は stat
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; SetupPacket : WINUSB_SETUP_PACKET -> "sptr"
; Buffer : BYTE* optional, out -> "sptr"
; BufferLength : DWORD -> "sptr"
; LengthTransferred : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINUSB.dll"
#cfunc global WinUsb_ControlTransfer "WinUsb_ControlTransfer" sptr, int, var, int, var, var
; res = WinUsb_ControlTransfer(InterfaceHandle, SetupPacket, Buffer, BufferLength, LengthTransferred, Overlapped)
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; SetupPacket : WINUSB_SETUP_PACKET -> "int"
; Buffer : BYTE* optional, out -> "var"
; BufferLength : DWORD -> "int"
; LengthTransferred : DWORD* optional, out -> "var"
; Overlapped : OVERLAPPED* optional -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINUSB.dll"
#cfunc global WinUsb_ControlTransfer "WinUsb_ControlTransfer" sptr, int, sptr, int, sptr, sptr
; res = WinUsb_ControlTransfer(InterfaceHandle, SetupPacket, varptr(Buffer), BufferLength, varptr(LengthTransferred), varptr(Overlapped))
; InterfaceHandle : WINUSB_INTERFACE_HANDLE -> "sptr"
; SetupPacket : WINUSB_SETUP_PACKET -> "int"
; Buffer : BYTE* optional, out -> "sptr"
; BufferLength : DWORD -> "int"
; LengthTransferred : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。