Win32 API 日本語リファレンス
ホームSystem.Hypervisor › HdvRegisterDoorbell

HdvRegisterDoorbell

関数
PCI BARオフセットにドアベルイベントを登録する。
DLLvmdevicehost.dll呼出規約winapi

シグネチャ

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

HRESULT HdvRegisterDoorbell(
    void* requestor,
    HDV_PCI_BAR_SELECTOR BarIndex,
    ULONGLONG BarOffset,
    ULONGLONG TriggerValue,
    ULONGLONG Flags,
    HANDLE DoorbellEvent
);

パラメーター

名前方向説明
requestorvoid*in操作を要求するデバイス等を表すリクエスタコンテキストへのポインタ。
BarIndexHDV_PCI_BAR_SELECTORinドアベルを設定する対象PCI BARを選択する列挙値を指定する。
BarOffsetULONGLONGinBAR内でドアベルを設定するバイトオフセットを指定する。
TriggerValueULONGLONGinドアベルが発火する書き込み値の一致条件を指定する。
FlagsULONGLONGinドアベルの動作を制御するフラグビットを指定する。
DoorbellEventHANDLEinドアベル発火時にシグナルされるイベントオブジェクトのハンドルを指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT HdvRegisterDoorbell(
    void* requestor,
    HDV_PCI_BAR_SELECTOR BarIndex,
    ULONGLONG BarOffset,
    ULONGLONG TriggerValue,
    ULONGLONG Flags,
    HANDLE DoorbellEvent
);
[DllImport("vmdevicehost.dll", ExactSpelling = true)]
static extern int HdvRegisterDoorbell(
    IntPtr requestor,   // void*
    int BarIndex,   // HDV_PCI_BAR_SELECTOR
    ulong BarOffset,   // ULONGLONG
    ulong TriggerValue,   // ULONGLONG
    ulong Flags,   // ULONGLONG
    IntPtr DoorbellEvent   // HANDLE
);
<DllImport("vmdevicehost.dll", ExactSpelling:=True)>
Public Shared Function HdvRegisterDoorbell(
    requestor As IntPtr,   ' void*
    BarIndex As Integer,   ' HDV_PCI_BAR_SELECTOR
    BarOffset As ULong,   ' ULONGLONG
    TriggerValue As ULong,   ' ULONGLONG
    Flags As ULong,   ' ULONGLONG
    DoorbellEvent As IntPtr   ' HANDLE
) As Integer
End Function
' requestor : void*
' BarIndex : HDV_PCI_BAR_SELECTOR
' BarOffset : ULONGLONG
' TriggerValue : ULONGLONG
' Flags : ULONGLONG
' DoorbellEvent : HANDLE
Declare PtrSafe Function HdvRegisterDoorbell Lib "vmdevicehost" ( _
    ByVal requestor As LongPtr, _
    ByVal BarIndex As Long, _
    ByVal BarOffset As LongLong, _
    ByVal TriggerValue As LongLong, _
    ByVal Flags As LongLong, _
    ByVal DoorbellEvent As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HdvRegisterDoorbell = ctypes.windll.vmdevicehost.HdvRegisterDoorbell
HdvRegisterDoorbell.restype = ctypes.c_int
HdvRegisterDoorbell.argtypes = [
    ctypes.POINTER(None),  # requestor : void*
    ctypes.c_int,  # BarIndex : HDV_PCI_BAR_SELECTOR
    ctypes.c_ulonglong,  # BarOffset : ULONGLONG
    ctypes.c_ulonglong,  # TriggerValue : ULONGLONG
    ctypes.c_ulonglong,  # Flags : ULONGLONG
    wintypes.HANDLE,  # DoorbellEvent : HANDLE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('vmdevicehost.dll')
HdvRegisterDoorbell = Fiddle::Function.new(
  lib['HdvRegisterDoorbell'],
  [
    Fiddle::TYPE_VOIDP,  # requestor : void*
    Fiddle::TYPE_INT,  # BarIndex : HDV_PCI_BAR_SELECTOR
    -Fiddle::TYPE_LONG_LONG,  # BarOffset : ULONGLONG
    -Fiddle::TYPE_LONG_LONG,  # TriggerValue : ULONGLONG
    -Fiddle::TYPE_LONG_LONG,  # Flags : ULONGLONG
    Fiddle::TYPE_VOIDP,  # DoorbellEvent : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "vmdevicehost")]
extern "system" {
    fn HdvRegisterDoorbell(
        requestor: *mut (),  // void*
        BarIndex: i32,  // HDV_PCI_BAR_SELECTOR
        BarOffset: u64,  // ULONGLONG
        TriggerValue: u64,  // ULONGLONG
        Flags: u64,  // ULONGLONG
        DoorbellEvent: *mut core::ffi::c_void  // HANDLE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("vmdevicehost.dll")]
public static extern int HdvRegisterDoorbell(IntPtr requestor, int BarIndex, ulong BarOffset, ulong TriggerValue, ulong Flags, IntPtr DoorbellEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'vmdevicehost_HdvRegisterDoorbell' -Namespace Win32 -PassThru
# $api::HdvRegisterDoorbell(requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent)
#uselib "vmdevicehost.dll"
#func global HdvRegisterDoorbell "HdvRegisterDoorbell" sptr, sptr, sptr, sptr, sptr, sptr
; HdvRegisterDoorbell requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent   ; 戻り値は stat
; requestor : void* -> "sptr"
; BarIndex : HDV_PCI_BAR_SELECTOR -> "sptr"
; BarOffset : ULONGLONG -> "sptr"
; TriggerValue : ULONGLONG -> "sptr"
; Flags : ULONGLONG -> "sptr"
; DoorbellEvent : HANDLE -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "vmdevicehost.dll"
#cfunc global HdvRegisterDoorbell "HdvRegisterDoorbell" sptr, int, int64, int64, int64, sptr
; res = HdvRegisterDoorbell(requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent)
; requestor : void* -> "sptr"
; BarIndex : HDV_PCI_BAR_SELECTOR -> "int"
; BarOffset : ULONGLONG -> "int64"
; TriggerValue : ULONGLONG -> "int64"
; Flags : ULONGLONG -> "int64"
; DoorbellEvent : HANDLE -> "sptr"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; HRESULT HdvRegisterDoorbell(void* requestor, HDV_PCI_BAR_SELECTOR BarIndex, ULONGLONG BarOffset, ULONGLONG TriggerValue, ULONGLONG Flags, HANDLE DoorbellEvent)
#uselib "vmdevicehost.dll"
#cfunc global HdvRegisterDoorbell "HdvRegisterDoorbell" intptr, int, int64, int64, int64, intptr
; res = HdvRegisterDoorbell(requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent)
; requestor : void* -> "intptr"
; BarIndex : HDV_PCI_BAR_SELECTOR -> "int"
; BarOffset : ULONGLONG -> "int64"
; TriggerValue : ULONGLONG -> "int64"
; Flags : ULONGLONG -> "int64"
; DoorbellEvent : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	vmdevicehost = windows.NewLazySystemDLL("vmdevicehost.dll")
	procHdvRegisterDoorbell = vmdevicehost.NewProc("HdvRegisterDoorbell")
)

// requestor (void*), BarIndex (HDV_PCI_BAR_SELECTOR), BarOffset (ULONGLONG), TriggerValue (ULONGLONG), Flags (ULONGLONG), DoorbellEvent (HANDLE)
r1, _, err := procHdvRegisterDoorbell.Call(
	uintptr(requestor),
	uintptr(BarIndex),
	uintptr(BarOffset),
	uintptr(TriggerValue),
	uintptr(Flags),
	uintptr(DoorbellEvent),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function HdvRegisterDoorbell(
  requestor: Pointer;   // void*
  BarIndex: Integer;   // HDV_PCI_BAR_SELECTOR
  BarOffset: UInt64;   // ULONGLONG
  TriggerValue: UInt64;   // ULONGLONG
  Flags: UInt64;   // ULONGLONG
  DoorbellEvent: THandle   // HANDLE
): Integer; stdcall;
  external 'vmdevicehost.dll' name 'HdvRegisterDoorbell';
result := DllCall("vmdevicehost\HdvRegisterDoorbell"
    , "Ptr", requestor   ; void*
    , "Int", BarIndex   ; HDV_PCI_BAR_SELECTOR
    , "Int64", BarOffset   ; ULONGLONG
    , "Int64", TriggerValue   ; ULONGLONG
    , "Int64", Flags   ; ULONGLONG
    , "Ptr", DoorbellEvent   ; HANDLE
    , "Int")   ; return: HRESULT
●HdvRegisterDoorbell(requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent) = DLL("vmdevicehost.dll", "int HdvRegisterDoorbell(void*, int, qword, qword, qword, void*)")
# 呼び出し: HdvRegisterDoorbell(requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent)
# requestor : void* -> "void*"
# BarIndex : HDV_PCI_BAR_SELECTOR -> "int"
# BarOffset : ULONGLONG -> "qword"
# TriggerValue : ULONGLONG -> "qword"
# Flags : ULONGLONG -> "qword"
# DoorbellEvent : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "vmdevicehost" fn HdvRegisterDoorbell(
    requestor: ?*anyopaque, // void*
    BarIndex: i32, // HDV_PCI_BAR_SELECTOR
    BarOffset: u64, // ULONGLONG
    TriggerValue: u64, // ULONGLONG
    Flags: u64, // ULONGLONG
    DoorbellEvent: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;
proc HdvRegisterDoorbell(
    requestor: pointer,  # void*
    BarIndex: int32,  # HDV_PCI_BAR_SELECTOR
    BarOffset: uint64,  # ULONGLONG
    TriggerValue: uint64,  # ULONGLONG
    Flags: uint64,  # ULONGLONG
    DoorbellEvent: pointer  # HANDLE
): int32 {.importc: "HdvRegisterDoorbell", stdcall, dynlib: "vmdevicehost.dll".}
pragma(lib, "vmdevicehost");
extern(Windows)
int HdvRegisterDoorbell(
    void* requestor,   // void*
    int BarIndex,   // HDV_PCI_BAR_SELECTOR
    ulong BarOffset,   // ULONGLONG
    ulong TriggerValue,   // ULONGLONG
    ulong Flags,   // ULONGLONG
    void* DoorbellEvent   // HANDLE
);
ccall((:HdvRegisterDoorbell, "vmdevicehost.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, UInt64, UInt64, UInt64, Ptr{Cvoid}),
      requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent)
# requestor : void* -> Ptr{Cvoid}
# BarIndex : HDV_PCI_BAR_SELECTOR -> Int32
# BarOffset : ULONGLONG -> UInt64
# TriggerValue : ULONGLONG -> UInt64
# Flags : ULONGLONG -> UInt64
# DoorbellEvent : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t HdvRegisterDoorbell(
    void* requestor,
    int32_t BarIndex,
    uint64_t BarOffset,
    uint64_t TriggerValue,
    uint64_t Flags,
    void* DoorbellEvent);
]]
local vmdevicehost = ffi.load("vmdevicehost")
-- vmdevicehost.HdvRegisterDoorbell(requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent)
-- requestor : void*
-- BarIndex : HDV_PCI_BAR_SELECTOR
-- BarOffset : ULONGLONG
-- TriggerValue : ULONGLONG
-- Flags : ULONGLONG
-- DoorbellEvent : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('vmdevicehost.dll');
const HdvRegisterDoorbell = lib.func('__stdcall', 'HdvRegisterDoorbell', 'int32_t', ['void *', 'int32_t', 'uint64_t', 'uint64_t', 'uint64_t', 'void *']);
// HdvRegisterDoorbell(requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent)
// requestor : void* -> 'void *'
// BarIndex : HDV_PCI_BAR_SELECTOR -> 'int32_t'
// BarOffset : ULONGLONG -> 'uint64_t'
// TriggerValue : ULONGLONG -> 'uint64_t'
// Flags : ULONGLONG -> 'uint64_t'
// DoorbellEvent : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("vmdevicehost.dll", {
  HdvRegisterDoorbell: { parameters: ["pointer", "i32", "u64", "u64", "u64", "pointer"], result: "i32" },
});
// lib.symbols.HdvRegisterDoorbell(requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent)
// requestor : void* -> "pointer"
// BarIndex : HDV_PCI_BAR_SELECTOR -> "i32"
// BarOffset : ULONGLONG -> "u64"
// TriggerValue : ULONGLONG -> "u64"
// Flags : ULONGLONG -> "u64"
// DoorbellEvent : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t HdvRegisterDoorbell(
    void* requestor,
    int32_t BarIndex,
    uint64_t BarOffset,
    uint64_t TriggerValue,
    uint64_t Flags,
    void* DoorbellEvent);
C, "vmdevicehost.dll");
// $ffi->HdvRegisterDoorbell(requestor, BarIndex, BarOffset, TriggerValue, Flags, DoorbellEvent);
// requestor : void*
// BarIndex : HDV_PCI_BAR_SELECTOR
// BarOffset : ULONGLONG
// TriggerValue : ULONGLONG
// Flags : ULONGLONG
// DoorbellEvent : HANDLE
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Vmdevicehost extends StdCallLibrary {
    Vmdevicehost INSTANCE = Native.load("vmdevicehost", Vmdevicehost.class);
    int HdvRegisterDoorbell(
        Pointer requestor,   // void*
        int BarIndex,   // HDV_PCI_BAR_SELECTOR
        long BarOffset,   // ULONGLONG
        long TriggerValue,   // ULONGLONG
        long Flags,   // ULONGLONG
        Pointer DoorbellEvent   // HANDLE
    );
}
@[Link("vmdevicehost")]
lib Libvmdevicehost
  fun HdvRegisterDoorbell = HdvRegisterDoorbell(
    requestor : Void*,   # void*
    BarIndex : Int32,   # HDV_PCI_BAR_SELECTOR
    BarOffset : UInt64,   # ULONGLONG
    TriggerValue : UInt64,   # ULONGLONG
    Flags : UInt64,   # ULONGLONG
    DoorbellEvent : Void*   # HANDLE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef HdvRegisterDoorbellNative = Int32 Function(Pointer<Void>, Int32, Uint64, Uint64, Uint64, Pointer<Void>);
typedef HdvRegisterDoorbellDart = int Function(Pointer<Void>, int, int, int, int, Pointer<Void>);
final HdvRegisterDoorbell = DynamicLibrary.open('vmdevicehost.dll')
    .lookupFunction<HdvRegisterDoorbellNative, HdvRegisterDoorbellDart>('HdvRegisterDoorbell');
// requestor : void* -> Pointer<Void>
// BarIndex : HDV_PCI_BAR_SELECTOR -> Int32
// BarOffset : ULONGLONG -> Uint64
// TriggerValue : ULONGLONG -> Uint64
// Flags : ULONGLONG -> Uint64
// DoorbellEvent : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HdvRegisterDoorbell(
  requestor: Pointer;   // void*
  BarIndex: Integer;   // HDV_PCI_BAR_SELECTOR
  BarOffset: UInt64;   // ULONGLONG
  TriggerValue: UInt64;   // ULONGLONG
  Flags: UInt64;   // ULONGLONG
  DoorbellEvent: THandle   // HANDLE
): Integer; stdcall;
  external 'vmdevicehost.dll' name 'HdvRegisterDoorbell';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HdvRegisterDoorbell"
  c_HdvRegisterDoorbell :: Ptr () -> Int32 -> Word64 -> Word64 -> Word64 -> Ptr () -> IO Int32
-- requestor : void* -> Ptr ()
-- BarIndex : HDV_PCI_BAR_SELECTOR -> Int32
-- BarOffset : ULONGLONG -> Word64
-- TriggerValue : ULONGLONG -> Word64
-- Flags : ULONGLONG -> Word64
-- DoorbellEvent : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let hdvregisterdoorbell =
  foreign "HdvRegisterDoorbell"
    ((ptr void) @-> int32_t @-> uint64_t @-> uint64_t @-> uint64_t @-> (ptr void) @-> returning int32_t)
(* requestor : void* -> (ptr void) *)
(* BarIndex : HDV_PCI_BAR_SELECTOR -> int32_t *)
(* BarOffset : ULONGLONG -> uint64_t *)
(* TriggerValue : ULONGLONG -> uint64_t *)
(* Flags : ULONGLONG -> uint64_t *)
(* DoorbellEvent : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library vmdevicehost (t "vmdevicehost.dll"))
(cffi:use-foreign-library vmdevicehost)

(cffi:defcfun ("HdvRegisterDoorbell" hdv-register-doorbell :convention :stdcall) :int32
  (requestor :pointer)   ; void*
  (bar-index :int32)   ; HDV_PCI_BAR_SELECTOR
  (bar-offset :uint64)   ; ULONGLONG
  (trigger-value :uint64)   ; ULONGLONG
  (flags :uint64)   ; ULONGLONG
  (doorbell-event :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HdvRegisterDoorbell = Win32::API::More->new('vmdevicehost',
    'int HdvRegisterDoorbell(LPVOID requestor, int BarIndex, UINT64 BarOffset, UINT64 TriggerValue, UINT64 Flags, HANDLE DoorbellEvent)');
# my $ret = $HdvRegisterDoorbell->Call($requestor, $BarIndex, $BarOffset, $TriggerValue, $Flags, $DoorbellEvent);
# requestor : void* -> LPVOID
# BarIndex : HDV_PCI_BAR_SELECTOR -> int
# BarOffset : ULONGLONG -> UINT64
# TriggerValue : ULONGLONG -> UINT64
# Flags : ULONGLONG -> UINT64
# DoorbellEvent : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型